Files > OPTION

name
OPTION
number
19
location
^DIC(19,
description
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.
applicationGroups
XU;XQ
Fields
#NameLocationTypeDetailsIndexDescription
.01name(+)0;1FREE TEXTBThe 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".
.15x action present0;15BOOLEAN1:YES
This field will be set to '1' if the option has an entry action.
.16rev key present0;16BOOLEAN1:YES
This field will be set to '1' if this option has a reverse key assigned to it.
.26header present?0;17BOOLEAN1:YES
This field is set to 1 by a trigger on field #26 when MUMPS code is entered into it.
1menu text(+)0;2FREE TEXTThe 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. **
1.1uppercase menu textU;1FREE TEXTC
2out of order message0;3FREE TEXTThis 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.
3lock0;6FREE TEXTThis 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.
3.01reverse/negative lock3;1FREE TEXT 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.
3.5description1;0WORD-PROCESSINGThis 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.
3.6creator0;5POINTER200This field defaults to the DUZ of the user who originally set up this option.
3.7help frame0;7POINTER9.2ACThis field contains a pointer to the help text which describes this option. The help text is displayed to the user on entering '?OPTION'.
3.8priority0;8NUMERICIf 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.
3.9prohibited times0;9FREE TEXTThis 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.
3.91times/days prohibited3.91;0MULTIPLE19.391 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.
3.92queuing required3.92;0MULTIPLE19.392By 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.
3.93output restricted?0;18BOOLEAN1:YES
This field will contain a '1' if output from this option is restricted to certain days and times.
3.95restrict devices?0;10BOOLEANy:YES
n:NO
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.'
3.96permitted device3.96;0MULTIPLE19.396 This subfile may contain a list of devices upon which this option is permitted to run.
4type(+)0;4SET OF CODESA:action
E:edit
I:inquire
M:menu
P:print
R:run routine
O:protocol
Q:protocol menu
X:extended action
S:server
L:limited
C:ScreenMan
W:Window
Z:Window Suite
B:Broker (Client/Server)
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.
10menu10;0MULTIPLE19.01This field points to the descendent options of this menu.
10.1short menu text10.1;1FREE TEXT This field contains a short version of the Menu Text field (field # 1) for use with multi-column displays. It is a mandatory field.
11display option?0;11BOOLEANy:YES
n:NO
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.
12package0;12POINTER9.4This field indicates the package with which this option is associated.
13delegable0;13BOOLEANn:NO
y:YES
If this field is marked 'no' in the option file then the XQSMD software will not delegate this option to a user.
14e action present0;14BOOLEAN1:YES
This field will contain a '1' if the option has an entry action in field #20.
15exit action15;E1,245FREE TEXTThis field contains mumps code which will be executed on leaving this option. It is applicable to all option types.
20entry action20;E1,245FREE TEXTMUMPS 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).
21xquit message21;0WORD-PROCESSING
22xquit executable22;E1,245FREE TEXT 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.
25routine25;E1,245FREE TEXTIndicate the name of the routine, e.g. ROUTINE, or TAG^ROUTINE.
26header26;E1,245FREE TEXTThis 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.
30dic {dic}30;E1,64FREE TEXTUsed 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(
31dic(0)31;E1,9FREE TEXTUsed 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)
32dic(a)32;E1,245FREE TEXTUsed 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:
33dic(b)33;E1,245FREE TEXTUsed 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:
34dic(s)34;E1,245FREE TEXTUsed 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.
35dic(w)35;E1,245FREE TEXTUsed 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.
36d.36;E1,245FREE TEXTUsed 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".
40dr{dds}40;1FREE TEXTThis field contains the name of the form from the Form File enclosed in square brackets, e.g., "[MYFORM]".
41ddsfile41;1FREE TEXTThis is the root of the file being edited or displayed entered without the up-arrow, e.g., "DIC(19,".
42ddsfile(1)42;1FREE TEXTThis is the global root of the subfile being edited or displayed.
43ddspage43;1NUMERICThis 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.
44ddsparm43;2FREE TEXTThis 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.
50die50;E1,64FREE TEXTUsed in the EDIT type option. The global reference of the file to be used in the edit. example: DPT(
51dr {die}51;E1,245FREE TEXTUsed 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]
52*dr()52;E1,245FREE TEXT
53no up-arrow53;1SET OF CODESN:NO UP-ARROWING ALLOWED
OUTOK:UP-ARROW OUT OK, NO BRANCHING
BACK:BACK JUMPING OK, NO EXIT
BACKOUTOK:EXIT AND BACK JUMPING OK
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.
54*die(w)54;E1,245FREE TEXTEnter 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.
60dic {dip}60;E1,64FREE TEXTThe global reference of the file to be used in PRINT type option. example: DPT(
61pg61;1NUMERICUsed 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.
62l.62;E1,245FREE TEXTUsed 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.
63flds63;E1,245FREE TEXTUsed 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]
64by64;E1,245FREE TEXTUsed 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]
65fr65;E1,245FREE TEXTUsed 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)
66to66;E1,245FREE TEXTUsed 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)
67dhd67;E1,245FREE TEXTUsed 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)
68dcopies68;1NUMERICUsed in the PRINT type option. The number of copies desired. SDP space must be available on your system for this option.
69dis(0)69;E1,245FREE TEXTUsed 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).
69.1dis(1)69.1;E1,245FREE TEXTThis 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.
69.2dis(2)69.2;E1,245FREE TEXTThis 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.
69.3dis(3)69.3;E1,245FREE TEXTThis 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.
70iop70;1FREE TEXTThe default output device. Enter a valid Device Name or "HOME" to mean output will always go to the home device.
71dhit71;E1,245FREE TEXTUsed 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.
72diobeg72;E1,245FREE TEXTUsed in the PRINT type option. Enter a string of MUMPS code that will be executed before the printout starts.
73dioend73;E1,245FREE TEXTUsed 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.
76by(0)76;1FREE TEXTThis 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]
76.1l(0)79;5NUMERICThis 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).
76.2fr(0,n)FROM;0MULTIPLE19.02Sort FROM criteria associated with the subscripts defined by the BY(0) input variable.
76.3to(0,n)TO;0MULTIPLE19.03Sort TO criteria associated with the subscripts defined by the BY(0) input variable.
76.4dispar(0,n)SUB;0MULTIPLE19.04
77disupno79;2SET OF CODES1:SUPPRESS HEADER IF NO RECORDS
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.
78dipcrit79;3SET OF CODES1:PRINT SEARCH/SORT CRITERIA
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.
79diaskhd79;1SET OF CODES0:Do not ask user for a header
1:Ask user for a header
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.
79.5distemp79;4FREE TEXTThis 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.
80dic {diq}80;E1,64FREE TEXTUsed in the INQUIRY type option. The global reference of the file to be used in the inquiry. example: DPT(
81dr {diq}81;E1,245FREE TEXTUsed 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
82diq(0)82;E1,245FREE TEXTIf this field is set to "C", computed fields will be displayed.
83supress device prompt83;1BOOLEANY:YES
N:NO
99timestamp99;1FREE TEXT This field contains the timestamp for when the option was created.
99.1timestamp of primary menu99.1;1FREE TEXT This field contains the timestamp of when this primary menu tree was rebuilt.
100*order print action100;E1,245FREE TEXT
100.1*order cancel action100.1;E1,245FREE TEXT
100.2*order purge action100.2;E1,245FREE TEXT
110independently invocable2;1BOOLEANn:NO
y:YES
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.
200*queued to run at what time200;1DATE-TIMEThis field is OBSOLETE, Please use the new Option scheduling File.
201*device for queued job output200;2FREE TEXTThis field is OBSOLETE, Please use the new Option scheduling File.
202*rescheduling frequency200;3FREE TEXTThis field is OBSOLETE, Please use the new Option scheduling File.
203*queued to run on volume set200;4FREE TEXTThis field is OBSOLETE, Please use the new Option scheduling File.
209scheduling recommended200.9;1SET OF CODESy:YES
n:NO
s:STARTUP
This field should be filled in by developers to allow reports of options that a site should consider seting up for background scheduling.
209.2keep from deleting200.9;2BOOLEANy:Yes
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.
220server bulletin220;1POINTER3.6 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.
221server action220;2SET OF CODESR:RUN IMMEDIATELY
Q:QUEUE SERVER ROUTINE
N:NOTIFY MAIL GROUP (DO NOT RUN)
I:IGNORE REQUESTS
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.
222server mail group220;3POINTER3.8 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.
223server audit220;4BOOLEANY:YES
N:NO
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.
224supress bulletin220;5SET OF CODESY:YES, SUPRESS IT
N:NO (DEFAULT) SEND A BULLETIN
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.
225server reply220;6SET OF CODESN:NO REPLY (DEFAULT)
E:REPLY ON ERROR ONLY
R:SEND REPLY IN ALL CASES
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.
226save request220;7SET OF CODES0:Do not save request
1:Save request in Postmaster basket
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.
227server device220;8POINTER3.5
228ztsk retention days220;9NUMERICThis 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.
300iconW;1FREE TEXT
301titleW;2FREE TEXT
320rpcRPC;0MULTIPLE19.05
1613primary menu1613;1FREE TEXTThis 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"
1840protected variablesNOKILL;1FREE TEXTThis 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
1916*special queueing1916;1SET OF CODESS:STARTUP
This field is OBSOLETE, Please use the new Option scheduling File.

Referenced by 16 types

  1. AUDIT (1.1) -- menu option used, protocol or option used
  2. DEVICE (3.5) -- primary menu option
  3. AUDIT LOG FOR OPTIONS (19.081) -- option
  4. OPTION SCHEDULING (19.2) -- name
  5. ADT/HL7 TRANSMISSION (39.4) -- dhcp option
  6. ORDER (100) -- dialog, item ordered
  7. ORDER STATISTICS (100.1) -- name
  8. OE/RR NOTIFICATIONS (100.9) -- non-menu type option action
  9. ORDER PARAMETERS (100.99) -- add menu default
  10. PROTOCOL (101) -- file link
  11. REQUEST SERVICES (123.5) -- service update option
  12. NEW PERSON (200) -- primary menu option, primary window, last option accessed
  13. IVM FINANCIAL QUERY LOG (301.62) -- dhcp option
  14. REMOTE APPLICATION (8994.5) -- contextoption
  15. ROES MENU (791810.5) -- option file menu
  16. VISIT (9000010) -- option used to create