The Master Data Model for Veteran Care

Developer Documentation » VDM » Option-19

Option (19)

Information in this file is used to drive the menu system. Options are created, associated with others on menus, locked, set out-of-order, assigned prohibited times or devices, or given entry/exit actions. The Edit Options of Menu Management should be used (instead of VA FileMan) so that the global root (DIC) and other such fields are given the correct values. Options may be tailored by setting FileMan variables via this file. The Order Enter/Results Reporting package is accessed by using the appropriate option type. It is cross-referenced by name, menu text, uppercase menu text, type, item, synonym, help frame, out-of-order message, lock, prohibited times, restricted devices, and priority.

Global: ^DIC(19,

Domain: Non-Clinical

Properties

Label/Field Name Field # Description Datatype Attributes Range
Name
  name
.01 The formal name of an option, prefaced with the package name.

Each option must be preceded by its package prefix (a 2-4 character)
code specified in the PACKAGE file, or the letter “Z” or “A”.
STRING INDEXED
REQUIRED
 
X Action Present
  x_action_present
.15
This field will be set to ‘1’ if the option has an entry action.
BOOLEAN   true: 1
Rev Key Present
  rev_key_present
.16
This field will be set to ‘1’ if this option has a reverse key assigned to it.
BOOLEAN   true: 1
Header Present?
  header_present
.26 This field is set to 1 by a trigger on field #26 when MUMPS code is
entered into it.
BOOLEAN   true: 1
Menu Text
  menu_text
1 The name as the option as it will be displayed to the user within
the menu system.
** The ‘C’ X-ref has been moved to the uppercase field. **
STRING REQUIRED  
Uppercase Menu Text
  uppercase_menu_text
1.1   STRING INDEXED  
Out Of Order Message
  out_of_order_message
2 This field is used to temporarily disable an option. If it is
filled in, the message here will be displayed whenever the user attempts
to select the option.
STRING    
Lock
  lock
3 This field is used to deny access to users which have this option
as part of their menu. If an option has a lock, then only users
which hold the matching key can access it.
STRING    
Reverse/negative Lock
  reverse_negative_lock
3.01
This field may contain a pointer to the Key File. If it does, the user may
not access this option if he or she holds that key.
STRING    
Description
  description
3.5 This field contains a brief explanation of the particular option.
It will be displayed in the menu system to the user when ‘???’
are entered to the selection choice of the parent menu.
STRING    
Creator
  creator
3.6 This field defaults to the DUZ of the user who originally
set up this option.
POINTER   New_Person-200
Help Frame
  help_frame
3.7 This field contains a pointer to the help text which describes
this option. The help text is displayed to the user on entering ‘?OPTION’.
POINTER INDEXED Help_Frame-9_2
Priority
  priority
3.8 If this field is null, the option will run at the current priority,
otherwise, priorities range from 1-10, a low number indicating lower
priority. The priority is in effect while the current option
is being executed.
NUMERIC    
Prohibited Times
  prohibited_times
3.9 This specifies a time range during which this option cannot be accessed.
The time should be entered in military format. For example, to
prohibit an option from running between 9 AM and 2 PM, enter 0900-1400.
STRING    
Times/days Prohibited
  times_days_prohibited
3.91
This subfile may contain dasy and time during which this option may not be
envoked. This subfile replaces field 3.9, Prohibited Times, in the 0th node
of the Option File.
OBJECT   Times_days_Prohibited-19_391
Queuing Required
  queuing_required
3.92 By entering days and times in the subfile the option’s output
can be restricted to days and times not included in this file.
The Menu System passes a flag to the Device Handler causing it
to force queuing during the days and times included in this
file.
OBJECT   Queuing_Required-19_392
Output Restricted?
  output_restricted
3.93
This field will contain a ‘1’ if output from this option is restricted to
certain days and times.
BOOLEAN   true: 1
Restrict Devices?
  restrict_devices
3.95 This indicates whether the option is allowed to run on selected devices
only. If this field contains a ‘y’, the option will be enabled only
for the devices entered in the field ‘PERMITTED DEVICE.’
BOOLEAN   false: n
true: y
Permitted Device
  permitted_device
3.96
This subfile may contain a list of devices upon which this option is permitted
to run.
POINTER   Device-3_5
Type
  type-4
4 This field indicates the ‘category’ or type of option. A print-type
option, for instance, will call FileMan to print something. Menu-type
options point to other options in the tree-structured menu system. The
other fields in the options file are filled in depending on the type.
There are several fields that will tell a print-type option what to print
and how to print it, for example. These same fields may be meaningless to
another options type.
ENUMERATION REQUIRED limited: L
protocol: O
edit: E
menu: M
Window Suite: Z
print: P
protocol menu: Q
server: S
inquire: I
Window: W
run routine: R
ScreenMan: C
action: A
extended action: X
Broker (Client/Server): B
Menu
  menu
10 This field points to the descendent options of this menu. OBJECT   Menu-19_01
Short Menu Text
  short_menu_text
10.1
This field contains a short version of the Menu Text field (field # 1) for
use with multi-column displays. It is a mandatory field.
STRING    
Display Option?
  display_option
11 This field controls the action of the Menu system if the user has
automenu turned on. If this field is set then the menu system will stop
and
ask
‘Press
return to continue’. before showing the menu again.
BOOLEAN   false: n
true: y
Package
  package
12 This field indicates the package with which this option is associated. POINTER   Package-9_4
Delegable
  delegable
13 If this field is marked ‘no’ in the option file then the XQSMD
software will not delegate this option to a user.
BOOLEAN   false: y
true: n
E Action Present
  e_action_present
14
This field will contain a ‘1’ if the option has an entry action in field #20.
BOOLEAN   true: 1
Exit Action
  exit_action
15 This field contains mumps code which will be executed on
leaving this option. It is applicable to all option types.
STRING    
Entry Action
  entry_action
20 MUMPS code that is executed upon entry to this option for all option
types. When an option is first envoked this code is executed,
but if you drop back into the option from a higher-level option
(with a simple [RETURN]), for instance, it is NOT executed. See Header
field (field # 26).
STRING    
Xquit Message
  xquit_message
21   STRING    
Xquit Executable
  xquit_executable
22 This field contains code which is executed by the menu system when an
XQUIT variable is detected after the execution of this option’s ENTRY
ACTION. If the execution of this field produces the variable XQNOBACK the
Menu System will not attempt to return the user to their previous option,
but leave the user at the present stack location. In the case of jumps,
the user may be returned to an option that is quite far away if XQNOBACK
is not defined. Obviously, the problem that resulted in an XQUIT should
first be solved before XQNOBACK is set.
If there is no code in this field the default is to return the user
to their previous option.
STRING    
Routine
  routine
25 Indicate the name of the routine, e.g. ROUTINE, or TAG^ROUTINE. STRING    
Header
  header
26 This field of MUMPS code is executed each time the option is envoked,
whether the user is moving down through the tree of options, or backing
up through the options already envoked; unlike the entry action which
is only executed when envoking an option from above, and not when
backing up into it.
STRING    
Dic {dic}
  dic_dic
30 Used in conjunction with EDIT and INQUIRE type options to lookup an entry.
for use.
The global reference of the file to be used in lookup (without the ‘^’).
For example: DPT(
STRING    
Dic(0)
  dic0
31 Used in conjunction with the EDIT and INQUIRE type options for finding
an entry.
Enter the parameters used in file-lookups.
A = Ask and reask entry
C = Cross reference suppression is turned off
E = Echo back the entry
F = Forget storing the lookup value (for space bar recall)
I = Ignore any special lookup program
L = Learning (LAYGO - adding a new entry) allowed
M = Look up entry using all available indexes
N = Allow internal entry number as input
O = Look up an entry in the old way
Q = Question input if match not found
X = Exact match of input required
Z = Zero entry node returned in variable Y(0) and
the external value of the .01 field in Y(0,0)
STRING    
Dic(a)
  dica
32 Used in conjunction with the EDIT and INQUIRE type option for finding
an entry.
Enter the prompt to be displayed instead of the usual ‘Select FILENAME NAME’
format.
Example: DIC(A)=”Please enter patient name: “
Would display to user - Please enter patient name:
Rather than the usual - Select PATIENT NAME:
STRING    
Dic(b)
  dicb
33 Used in conjunction with the EDIT and INQUIRE type options for finding
an entry.
Enter the default value you want displayed to user when selecting the
entry to use.
Example: DIC(B)=”JONES,JOHN”
Would produce the display - Select PATIENT NAME: JONES,JOHN//
Rather than the usual display - Select PATIENT NAME:
STRING    
Dic(s)
  dics
34 Used in conjunction with INQUIRE and EDIT type options for screening
entry selection. Enter executable MUMPS code that will screen out entries
that should NOT be selected. An entry is only selectable when the
executable code produces a truth value of 1. For example:

DIC(S)=I $P(^(0),U,2)=”M”
allows only males to be selected if the second piece of the entry’s zero
node contained an ‘M’ for Male or ‘F’ for Female.
STRING    
Dic(w)
  dicw
35 Used in conjunction with the EDIT and INQUIRE type options for matching
user input. Enter MUMPS code that will be executed each time a match
(matches) is found for user input.

Example: DIC(W)=W:$D(^(.1)) “Patient is currently on ward “,^(.1)
produces the display - JONES,JOHN Patient is currently on ward 2SE

NOTE: This will override identifier displays.
STRING    
D.
  d
36 Used in conjunction with the INQUIRE and EDIT type options for
selecting an entry. Enter the subscript of the cross reference
to be used for entry look-up.
example: D.=C
Would only check for user input against the “C” cross-reference.
If DIC(0) contains an “M” meaning multi-index look-up, then this
value will be used as a starting point for the multi-index look-up.
To restrict the look-up only to a single index then DIC(0) must
NOT contain an “M”.
STRING    
Dr{dds}
  drdds
40 This field contains the name of the form from the Form File
enclosed in square brackets, e.g., “[MYFORM]”.
STRING    
Ddsfile
  ddsfile
41 This is the root of the file being edited or displayed
entered without the up-arrow, e.g., “DIC(19,”.
STRING    
Ddsfile(1)
  ddsfile1
42 This is the global root of the subfile being edited or displayed. STRING    
Ddspage
  ddspage
43 This optional variable contains the page number of the first page to
display to the user when the ScreenMan form is invoked. If this variable
is not defined, then by default the first page the user sees is Page 1.
NUMERIC    
Ddsparm
  ddsparm
44 This optional variable contains a string of alphabetic characters that
controls ScreenMan’s behavior. The acceptable characters are:

C Return the variable DDSCHANG=1 if ScreenMan detects that the user
saved a Change to the database.

E Return Error messages in ^TMP(“DIERR”,$J) and return DIERR if
ScreenMan encounters problems when initially trying to load the form.
If DDSPARM does not contain an “E”, ScreenMan prints messages
directly on the screen, and returns the variable DIMSG equal to null.

S Return the variable DDSSAVE=1 if the user pressed S or E,
or entered an "Exit" or "Save" command from the Command Line, whether
or not any changes were actually made on the form.
STRING    
Die
  die
50 Used in the EDIT type option. The global reference of the file to be used
in the edit.
example: DPT(
STRING    
Dr {die}
  dr_die
51 Used in the EDIT type option. Enter the string of field numbers (delimited
by semi-colons) to be edited or a bracketed input template name.
example:
.01;.03;3;.351
or
[INPUT TEMPLATE NAME]
STRING    
*dr()
  dr
52   STRING DEPRECATED  
No Up-arrow
  no_uparrow
53 Used in the EDIT type option.
If an ‘N’ is entered, no up-arrowing (^) is allowed while editing either
for exiting the edit entirely or branching to other fields.
If an ‘OUTOK’ is entered, you may up-arrow (^) entirely out of the edit
but not be allowed to jump to other fields.
If an ‘BACK’ is entered, you may jump to a previously edited field
but not entirely out.
If an ‘BACKOUTOK’ is entered, you may jump back to previously edited
fields and up-arrow (^) to exit.
If no entry is in this field, you may jump to other fields or
up-arrow (^) out of the entire edit process.
ENUMERATION   BACK JUMPING OK, NO EXIT: BACK
NO UP-ARROWING ALLOWED: N
UP-ARROW OUT OK, NO BRANCHING: OUTOK
EXIT AND BACK JUMPING OK: BACKOUTOK
*die(w)
  diew
54 Enter a WRITE statement in this field and the WRITE statement will be used
instead of VA FileMan’s regular prompt for the field being edited.
STRING DEPRECATED  
Dic {dip}
  dic_dip
60 The global reference of the file to be used in PRINT type option.
example: DPT(
STRING    
Pg
  pg
61 Used in the PRINT type option. The page number that should appear on first
page of report. (This number ONLY effects page numbering, NOT at which entry
the report should begin printing). If this field is left blank,
then page 1 is assumed.
NUMERIC    
L.
  l
62 Used in the PRINT type option. This entry should always contain a 0.
If a 1 is entered for this field, all predetermined ranges of sorts
(fields TO and FR), print fields (field FLDS) and header (DHD) are overriden
and the user will be asked for sort ranges, print fields and header.
STRING    
Flds
  flds
63 Used in the PRINT type option. Enter the fields to be printed (delimited
by commas) or the bracketed print template name.
Fileman formatting criteria can also be entered.
example:
.01;”PATIENT NAME”;C1,.02,.1
or
[PRINT TEMPLATE NAME]
STRING    
By
  by
64 Used in the PRINT type option. Enter the fields to be sorted by (delimited
by commas) or a bracketed sort template name.
Example:
‘.1,.01
or
[SORT TEMPLATE NAME]
STRING    
Fr
  fr
65 Used in the PRINT type option. Enter the ‘start with’ values (delimited by
commas) used in sorting.
Example:
2NE,SMITH
(if sort fields were ward & name, start with ward 2NE and patient SMITH)
STRING    
To
  to
66 Used in the PRINT type option. The ‘go to’ values (delimited by commas) used
in sorting.
example:
2NE,SMITH
(If sort fields were ward & name, end sort after ward 2NE and patient
SMITH)
STRING    
Dhd
  dhd
67 Used in the PRINT type option. Enter the free text heading you want
printed as the header of your output.
(Do not include quotes in your header)
STRING    
Dcopies
  dcopies
68 Used in the PRINT type option. The number of copies desired.
SDP space must be available on your system for this option.
NUMERIC    
Dis(0)
  dis0
69 Used in the PRINT type option. This is executable M code which sets $T
to select desired entries for the sort process. If the code produces a
truth value of 1, the entry will be printed. (A truth value of 0 will not
allow the entry to be printed.) At the time the code is executed, the
internal entry number (IEN) of the entry is stored in the variable D0.

For example, the following would print patients who were NOT born in the
1970’s:

DIS(0)=I $P(^DPT(D0,0),U,3)<2700101!($P(^(0),U,3)>2791231)

If used in conjunction with fields DIS(1), DIS(2), and DIS(3), the entry
will print if DIS(0) and DIS(1) are true, OR if DIS(0) and DIS(2) are true,
OR if DIS(0) and DIS(3) are true.

Note: You may have DIS(0) only, or DIS(0) in combination with DIS(1) only,
or DIS(1) and DIS(2), or DIS(1), DIS(2), and DIS(3).
STRING    
Dis(1)
  dis1
69.1 This field may be used in PRINT options along with DIS(0) and the other DIS(n)
fields. Each DIS field is examined in order (beginning with 0) for M code that
will produce a $T value to determine whether or not the data pointed to by D0
should be printed. See the description of D(0) (field #69) for more information.
STRING    
Dis(2)
  dis2
69.2 This field may be used in PRINT options along with DIS(0) and the other DIS(n)
fields. Each DIS field is examined in order (beginning with 0) for M code that
will produce a $T value to determine whether or not the data pointed to by D0
should be printed. See the description of D(0) (field #69) for more information.
STRING    
Dis(3)
  dis3
69.3 This field may be used in PRINT options along with DIS(0) and the other DIS(n)
fields. Each DIS field is examined in order (beginning with 0) for M code that
will produce a $T value to determine whether or not the data pointed to by D0
should be printed. See the description of D(0) (field #69) for more information.
STRING    
Iop
  iop
70 The default output device. Enter a valid Device Name or “HOME”
to mean output will always go to the home device.
STRING    
Dhit
  dhit
71 Used in the PRINT type option. Enter a string of MUMPS code that
will be executed for every entry after all the fields specified
in FLDS have been printed.
STRING    
Diobeg
  diobeg
72 Used in the PRINT type option. Enter a string of MUMPS code that
will be executed before the printout starts.
STRING    
Dioend
  dioend
73 Used in the PRINT type option. Enter a string of MUMPS code that
will be executed after the printout has finished but before
returning to the calling program.
STRING    
By(0)
  by0
76 This variable can be set when you want to sort using a specified
cross-reference (even MUMPS), or a list of record numbers in any global,
or a list of results on a search template. The only criteria
is that the last subscript to sort through is an internal entry number
(record number) for the file being printed. This variable should contain
the static part of a cross-reference or an open global reference, without
the leading up-arrow. Or, if printing from a list of search results, the
variable should contain the name of a search template surrounded by square
brackets. Ex.:
BY(0) = TMP(“ZZTEST”,$J,
BY(0) = DIZ(662001,”AC”,
BY(0) = [ZZSEARCH]
STRING    
L(0)
  l0
76.1 This variable should ONLY be set if BY(0) is set, and is REQUIRED if BY(0)
is set. It should be equal to the total number of variable subscripts
that FileMan needs to sort through in order to reach the record number,
PLUS 1 for the record number itself. For example, if BY(0) defines a
regular cross-reference, L(0)=2 (1 for the cross-referenced field value,
and 1 for the record number, D0). If sorting through a list of record
numbers in ^TMP($J,D0), L(0)=1 (1 for the record number, D0).
NUMERIC    
Fr(0,n)
  fr0n
76.2 Sort FROM criteria associated with the subscripts defined by the BY(0)
input variable.
OBJECT   Fr0n-19_02
To(0,n)
  to0n
76.3 Sort TO criteria associated with the subscripts defined by the BY(0) input
variable.
OBJECT   To0n-19_03
Dispar(0,n)
  dispar0n
76.4   OBJECT   Dispar0n-19_04
Disupno
  disupno
77 If there are no matches found in a SEARCH, or if there are no records
to print in a PRINT, VA FileMan still prints a header and a message
informing the user that there were 0 matches, or no records to print.
If this input variable is set to 1, that print of the header will be
suppressed and nothing will print.
ENUMERATION   SUPPRESS HEADER IF NO RECORDS: 1
Dipcrit
  dipcrit
78 When set to 1, causes SEARCH or SORT criteria to print in the heading of
the first page of a report, along with the standard header. If called
from SEARCH option, both SEARCH and SORT criteria print.
ENUMERATION   PRINT SEARCH/SORT CRITERIA: 1
Diaskhd
  diaskhd
79
If this field is set to ‘1’ then the variable DIASKHDR will be defined when
FileMan is called to print. The user will then be prompted for a header for
the report.
ENUMERATION   Do not ask user for a header: 0
Ask user for a header: 1
Distemp
  distemp
79.5 This field MUST be defined in order to call the FileMan routine to RE-DO a
search using the search criteria from an existing SEARCH TEMPLATE (routine
ENS^DIS). The field must contain the name of a SEARCH TEMPLATE. This
template name can be enclosed in square brackets but the brackets are not
required. Note that if there are already search results on the template,
they will be replaced by a new list of search results when this option is
run.
STRING    
Dic {diq}
  dic_diq
80 Used in the INQUIRY type option. The global reference of the file to be
used in the inquiry.
example: DPT(
STRING    
Dr {diq}
  dr_diq
81 Used in the INQUIRY type option. Enter the GLOBAL SUBSCRIPTS that you
want displayed on the inquiry. Any fields residing in these global nodes
will be displayed in standard captioned output format.
Multiple subscripts can be delimited by a semi-colon or a range of subscripts
may be used delimiting the starting subscript and ending subscript with a
colon.
NOTE: Field security is not matched against user access for this option.
Data will be displayed regardless of user READ access to those fields.
example: DR {DIQ}=0;.1
Would display any fields whose global location was in either
global node 0 or global node .1
STRING    
Diq(0)
  diq0
82 If this field is set to “C”, computed fields will be displayed. STRING    
Supress Device Prompt
  supress_device_prompt
83   BOOLEAN   false: N
true: Y
Timestamp
  timestamp
99
This field contains the timestamp for when the option was created.
STRING    
Timestamp Of Primary Menu
  timestamp_of_primary_menu
99.1
This field contains the timestamp of when this primary menu tree was rebuilt.
STRING    
*order Print Action
  order_print_action
100   STRING DEPRECATED  
*order Cancel Action
  order_cancel_action
100.1   STRING DEPRECATED  
*order Purge Action
  order_purge_action
100.2   STRING DEPRECATED  
Independently Invocable
  independently_invocable
110 This field is only to document those options that the site can’t
randomly add to other options.

If this field is NO then this option requires that some option or
action has been done before it can be called.
If this field is YES then this option can be invoked at any time.
It is up to the developer to set this field.

The MENU system doesn’t look at this at any time.
BOOLEAN   false: y
true: n
*queued To Run At What Time
  queued_to_run_at_what_time
200 This field is OBSOLETE, Please use the new Option scheduling File. DATE-TIME DEPRECATED  
*device For Queued Job Output
  device_for_queued_job_output
201 This field is OBSOLETE, Please use the new Option scheduling File. STRING DEPRECATED  
*rescheduling Frequency
  rescheduling_frequency
202 This field is OBSOLETE, Please use the new Option scheduling File. STRING DEPRECATED  
*queued To Run On Volume Set
  queued_to_run_on_volume_set
203 This field is OBSOLETE, Please use the new Option scheduling File. STRING DEPRECATED  
Scheduling Recommended
  scheduling_recommended
209 This field should be filled in by developers to allow reports of
options that a site should consider seting up for background scheduling.
ENUMERATION   YES: y
STARTUP: s
NO: n
Keep From Deleting
  keep_from_deleting
209.2 This field is to keep the DELETE UNREFERENCED OPTIONS routine from
selecting this option for deletion even if it isn’t referenced in the
normal ways. Like “Parent of Queuable Options” (ZTMQUEUABLE OPTIONS) or
XUCOMMAD. Normal options don’t need to set this field.
BOOLEAN   true: y
Server Bulletin
  server_bulletin
220
This field may contain a pointer to the bulletin which will override the
default bulletin XQSERVER for a server-type option. This bulletin will be
usedto notify the users in the event of a security breach, etc.
POINTER   Bulletin-3_6
Server Action
  server_action
221 A set of codes which tell the menu system what to do when a request
for this server option is received from the mail system.
ENUMERATION   NOTIFY MAIL GROUP (DO NOT RUN): N
RUN IMMEDIATELY: R
QUEUE SERVER ROUTINE: Q
IGNORE REQUESTS: I
Server Mail Group
  server_mail_group
222
This field amy contain a pointer to the Mail Group file. This mail group will
be notified in the even of a security breach etc. when a server-type option is
envoked.
POINTER   Mail_Group-3_8
Server Audit
  server_audit
223 This set of codes will determine whethere or not auditing will take place.
If auditing is turned on with a ‘Y’ (YES) response the menu system will
record: 1. The server option requested, 2. Date/time of the request, 3.
User (Postmaster), 4. Device (none), 5. Job #, 6. Date/time of exit from
the option, 7. CPU, 8. Request result (error message, “task completed
normally”, etc.
BOOLEAN   false: N
true: Y
Supress Bulletin
  supress_bulletin
224 If this field contains a ‘Y’ no bulletin will be fired when a server
request is recieved. The default is to send a bulletin. If there is
no bulletin in field #220 (SERVER BULLETIN) then the default bulletin
XQSERVER is fired off.
ENUMERATION   NO (DEFAULT) SEND A BULLETIN: N
YES, SUPRESS IT: Y
Server Reply
  server_reply
225 This field controls the transmission of replies to server requests via
network mail. If the field contains ‘R’ a reply will be transmitted to
the sender of the server request. If the field contains an ‘E’ a network
reply will be transmitted only in the event that an error was trapped
during the attemp to run a server option, Entry or Exit Actions, or the
routine associated with a server option.
ENUMERATION   NO REPLY (DEFAULT): N
SEND REPLY IN ALL CASES: R
REPLY ON ERROR ONLY: E
Save Request
  save_request
226 If there is a 1 in this field or if this field is null, then the server
request message is saved in a mailbox for the Postmaster that is named
“S.”option_name.
ENUMERATION   Save request in Postmaster basket: 1
Do not save request: 0
Server Device
  server_device
227   POINTER   Device-3_5
Ztsk Retention Days
  ztsk_retention_days
228 This is a number between 1 and 365 to incicate the number of days that a
server task should be retained by Task Manager in ^ZTSK. The default
is 14 days if nothing is entered in this field. For long-term retention
see field 226 which allows you to save the server message in a Postmaster
mailbox.
NUMERIC    
Icon
  icon
300   STRING    
Title
  title
301   STRING    
Rpc
  rpc
320   OBJECT   Rpc-19_05
Primary Menu
  primary_menu
1613 This field will have a value only if the Option is a ‘high-level’ menu
Option, which could be assigned to a typical user. For example, the
value of this field might be “PHARMACIST”, or “ADMISSIONS CLERK”
STRING    
Protected Variables
  protected_variables
1840 This field holds a list of variables that need to be protected
when another package call KILL^XUSCLEAN. These should all be
documented package wide variables.
The format is that of a list of variable names separated by commas.
i.e. DUZ,DTIME,DT
STRING    
*special Queueing
  special_queueing
1916 This field is OBSOLETE, Please use the new Option scheduling File. ENUMERATION DEPRECATED  

↑ Return to top

Sub-Files

Times/days Prohibited (19.391)

ID
Times_days_Prohibited-19_391

Properties

Label/Field Name Field # Description Datatype Attributes Range
Times Prohibited
  times_prohibited
.01 This field may be used to set prohibited times for specific days of the
week. The PROHIBITED TIME RANGE may be specified alone to apply to all
days as 0800-1630 to prohibit use between 8:00 am and 4:30 pm.

The time range specified may be prohibited on one or more specific days
of the week by entry of the desired prohibited days in the next field of
this subfield.
STRING INDEXED
REQUIRED
 
Days Prohibited
  days_prohibited
.02 This field may be used to prohibit use of the option on particular
days of the week.
STRING    

↑ Return to top

Queuing Required (19.392)

ID
Queuing_Required-19_392

Properties

Label/Field Name Field # Description Datatype Attributes Range
Time Period
  time_period
.01 This field is used to specify a time period for the days of the week
specified in field .02 during which the option may be run, but output must
be queued to a time outside the dates and times specified.
STRING INDEXED
REQUIRED
 
Day(s) For Time Period
  days_for_time_period
.02 This field is used to specify one or more specific days of the week
when the option must be queued to a time outside those specified in the
.01 field.
STRING    

↑ Return to top

ID
Menu-19_01

Properties

Label/Field Name Field # Description Datatype Attributes Range
Item
  item
.01 The name of an Option which will appear on this menu. POINTER REQUIRED Option-19
Synonym
  synonym
2 An abbreviation which will appear to the left of the menu text
on the display of a menu. Options are selectable by synonyms
as well as menu text.
STRING    
Display Order
  display_order
3 The field determines the order in which the items of a menu appear
when displayed. If this field is entered, it takes precedence over
the order determined by the synonyms.
NUMERIC    

↑ Return to top

Fr(0,n) (19.02)

ID
Fr0n-19_02

Properties

Label/Field Name Field # Description Datatype Attributes Range
Subscript Level Number
  subscript_level_number
.01 Number equal to one of the “N” subscripts that FileMan must sort through
on the global or cross-reference defined by the BY(0) input variable to
the FileMan print routine, EN1^DIP. Used to set an entry into the FR(0,N)
input array (sort FROM value for the Nth subscript).
NUMERIC INDEXED
REQUIRED
 
From Value
  from_value
1 This optional field can be filled out for any of the “N” subscripts that
FileMan must sort through on the global defined in BY(0). This field only
has meaning when something has been defined in BY(0), and it indicates the
“START WITH” value for subscript “N”. For example, when FileMan builds
the code for sorting through a cross-reference defined in BY(0), if an
entry exists in the first multiple for this field, the value of this field
will be used as the starting point for sorting on the first variable
subscript in the cross-reference.
STRING    

↑ Return to top

To(0,n) (19.03)

ID
To0n-19_03

Properties

Label/Field Name Field # Description Datatype Attributes Range
Subscript Level Number
  subscript_level_number
.01 Number equal to one of the “N” subscripts that FileMan must sort through
on the global or cross-reference defined by the BY(0) input variable to
the FileMan print routine, EN1^DIP. Used to set an entry into the TO(0,N)
input array (sort TO value for the Nth subscript).
NUMERIC INDEXED
REQUIRED
 
To Value
  to_value
1 This optional field can be filled out for any of the “N” subscripts that
FileMan must sort through on the global defined in BY(0). This field only
has meaning when something has been defined in BY(0), and it indicates the
“GO TO” value for subscript “N”. For example, when FileMan builds the
code for sorting through a cross-reference defined in BY(0), if an entry
exists in the first multiple for this field, the value of this field
will be used as the ending point for sorting on the first variable
subscript in the cross-reference.
STRING    

↑ Return to top

Dispar(0,n) (19.04)

ID
Dispar0n-19_04

Properties

Label/Field Name Field # Description Datatype Attributes Range
Subscript Level Number
  subscript_level_number
.01 Number equal to one of the “N” subscripts that FileMan must sort through
on the global or cross-reference defined by the BY(0) input variable to
the FileMan print routine, EN1^DIP. Used to set entries into the
DIAPAR(0,N) and DIAPAR(0,N,”OUT”) input arrays (subheader control for the
Nth subscript).
NUMERIC INDEXED
REQUIRED
 
Statistical Control Characters
  statistical_control_characters
1 Statistical control characters for printing the “Nth” subscript from the
BY(0) global/cross-reference. Used to set first piece of DISPAR(0,N)
input variable to the FileMan print, EN1^DIP. If defined, it should
contain any of the three statistical control characters !, #, or + that
are normally entered BEFORE a sort field in the FileMan interactive mode
for printing data. See the FileMan User’s manual section on How to
Display and Print File Data for more information.
STRING    
Subheader Format Characters
  subheader_format_characters
2 Subheader formatting characters for printing the “Nth” subscript from the
BY(0) global/cross-reference. Used to set second piece of DISPAR(0,N)
input variable to the FileMan print, EN1^DIP. If defined, it should
contain any subheader formatting characters that are normally entered
AFTER a sort field in the FileMan interactive mode for printing data. See
the FileMan User’s manual section on How to Display and Print File Data
for more information. (ex. ;C3;”SUBHEADER TITLE:” to begin printing
subheader in column 3, with a literal caption.)
STRING    
Subheader Output Transform
  subheader_output_transform
3 Output transform code for printing the “Nth” subscript subheader from the
BY(0) global/cross-reference. Used to set DISPAR(0,N,”OUT”) input
variable to the FileMan print, EN1^DIP. For instance, it could transform
an inverse date into a printable date. If defined, it should contain
MUMPS code that transforms the internal value of the subscript “Y”, into
it’s external form, also in variable “Y”.
STRING    

↑ Return to top

Rpc (19.05)

ID
Rpc-19_05

Properties

Label/Field Name Field # Description Datatype Attributes Range
Rpc
  rpc
.01 This subfile is used to register the Remote Procedures registered
to a particular Broker-type option. It is a pointer to the
Remote Procedure File.
POINTER INDEXED
REQUIRED
Remote_Procedure-8994
Rpckey
  rpckey
1 This field is the free-text name from the Security Key File that will be
checked when this remote procedure call is requested to the broker.
If the user does not hold this key then the request will be denied.
STRING    
Rules
  rules
2 This field contains standard M code that will be executed when this
remote procedure call is requested from the broker. The variable
XQRPCOK is set to 1 and the code is executed. If the value of that
variable is reset to 0 by the RULES code, then the request is denied.
STRING    

↑ Return to top


Document generated on August 31st 2017, 2:55:41 pm