STANDARD DATA DICTIONARY #19 -- OPTION FILE 3/24/25 PAGE 1
STORED IN ^DIC(19, (10406 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 8.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
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.
DD ACCESS: #
WR ACCESS: #
DEL ACCESS: #
LAYGO ACCESS: #
APPLICATION GROUP(S): XU, XQ
IDENTIFIED BY: MENU TEXT (#1)[R]
POINTED TO BY: MENU OPTION USED field (#4.1) of the AUDIT File (#1.1)
PROTOCOL or OPTION USED field (#4.2) of the AUDIT File (#1.1)
OPTION USED field (#12) of the ERROR EVENTS sub-field (#3.07701) of the ERROR TRAP SUMMARY File (#3.077)
PRIMARY MENU OPTION field (#201) of the DEVICE File (#3.5)
OPTION field (#.02) of the *MENU sub-field (#9.495) of the PACKAGE File (#9.4)
ITEM field (#.01) of the MENU sub-field (#19.01) of the OPTION File (#19)
OPTION field (#.01) of the AUDIT LOG FOR OPTIONS File (#19.081)
NAME field (#.01) of the OPTION SCHEDULING File (#19.2)
DHCP OPTION field (#.05) of the ADT/HL7 TRANSMISSION File (#39.4)
MENU OPT field (#.06) of the DG VAS QUEUE File (#46.3)
MENU OPTIONS field (#.01) of the MENU OPTIONS sub-field (#57.2331) of the PPS-N UPDATE CONTROL File (#57.23)
DIALOG field (#2) of the ORDER File (#100)
ITEM ORDERED field (#7) of the ORDER File (#100)
NAME field (#.01) of the ORDER STATISTICS File (#100.1)
NON-MENU TYPE OPTION ACTION field (#1) of the OE/RR NOTIFICATIONS File (#100.9)
ADD MENU DEFAULT field (#4) of the ORDER PARAMETERS File (#100.99)
FILE LINK field (#6) of the PROTOCOL File (#101)
SERVICE UPDATE OPTION field (#123.011) of the REQUEST SERVICES File (#123.5)
PRIMARY MENU OPTION field (#201) of the NEW PERSON File (#200)
PRIMARY WINDOW field (#201.1) of the NEW PERSON File (#200)
LAST OPTION ACCESSED field (#202.1) of the NEW PERSON File (#200)
SECONDARY MENU OPTIONS field (#.01) of the SECONDARY MENU OPTIONS sub-field (#200.03) of the NEW PERSON File (#200)
DELEGATED OPTIONS field (#.01) of the DELEGATED OPTIONS sub-field (#200.19) of the NEW PERSON File (#200)
DHCP OPTION field (#.07) of the IVM FINANCIAL QUERY LOG File (#301.62)
ALPHA,BETA TEST OPTION field (#.01) of the ALPHA,BETA TEST OPTION sub-field (#8989.333) of the KERNEL SYSTEM
PARAMETERS File (#8989.3)
OPTION TO AUDIT field (#.01) of the OPTION TO AUDIT sub-field (#8989.36) of the KERNEL SYSTEM PARAMETERS File
(#8989.3)
CONTEXTOPTION field (#.02) of the REMOTE APPLICATION File (#8994.5)
OPTION FILE MENU field (#.03) of the ROES MENU File (#791810.5)
OPTION USED TO CREATE field (#.24) of the VISIT File (#9000010)
CROSS
REFERENCED BY: HELP FRAME(AC), ITEM(AD), MENU TEXT(AE), E ACTION PRESENT(AF), X ACTION PRESENT(AG), MENU TEXT(AOA),
OUT OF ORDER MESSAGE(AOB), LOCK(AOC), PROHIBITED TIMES(AOD), ITEM(AOE), SYNONYM(AOF), HELP FRAME(AOG), TYPE(AOH),
PRIORITY(AOI), RESTRICT DEVICES?(AOJ), TYPE(AOR), MENU TEXT(AORK), REVERSE/NEGATIVE LOCK(AREDO),
*SPECIAL QUEUEING(ASTARTUP), *QUEUED TO RUN AT WHAT TIME(AZT), *DEVICE FOR QUEUED JOB OUTPUT(AZTIO),
*QUEUED TO RUN ON VOLUME SET(AZTVOL), NAME(B), UPPERCASE MENU TEXT(C)
LAST MODIFIED: AUG 15,2019@16:23:40
19,.01 NAME 0;1 FREE TEXT (Required)
A unique name, which is preceded by the package abbreviation
INPUT TRANSFORM: D CHKNAME^XQ5 K:$L(X)>30!(+X=X)!($L(X)<3)!'(X'?1P.E)!(X'?.ANP) X
LAST EDITED: JUL 21, 2012
HELP-PROMPT: NAME MUST BE 3-30 CHARACTERS, NOT NUMERIC OR STARTING WITH PUNCTUATION
DESCRIPTION: 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".
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 19^B
1)= S ^DIC(19,"B",$E(X,1,30),DA)=""
2)= K ^DIC(19,"B",$E(X,1,30),DA)
CROSS-REFERENCE: ^^TRIGGER^19^3.6
1)= X ^DD(19,.01,1,2,1.3) I X S X=DIV S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$P(Y(1),U,5),X=X S
DIU=X K Y S X=DIV S X=DUZ X ^DD(19,.01,1,2,1.4)
1.3)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(0)=X S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$S('$D(^VA(
200,+$P(Y(1),U,5),0)):"",1:$P(^(0),U,1))=""
1.4)= S DIH=$S($D(^DIC(19,DIV(0),0)):^(0),1:""),DIV=X X "F %=0:0 Q:$L($P(DIH,U,4,99)) S DIH=DIH_U"
S %=$P(DIH,U,6,999),DIU=$P(DIH,U,5),^(0)=$P(DIH,U,1,4)_U_DIV_$S(%]"":U_%,1:""),DIH=19,DIG=3.6 D ^D
ICR:$O(^DD(DIH,DIG,1,0))>0
2)= Q
3)= This trigger is used to record the user who created this option.
CREATE CONDITION)= CREATOR=""
CREATE VALUE)= S X=DUZ
DELETE VALUE)= NO EFFECT
FIELD)= CREATOR
This trigger is used to record the user who created this option at the time that the name was
created.
19,.15 X ACTION PRESENT 0;15 SET
'1' FOR YES;
LAST EDITED: FEB 13, 1991
HELP-PROMPT: This flag indicates if there is an exit action for this option
DESCRIPTION:
This field will be set to '1' if the option has an entry action.
WRITE AUTHORITY: ^
NOTES: TRIGGERED by the EXIT ACTION field of the OPTION File
CROSS-REFERENCE: 19^AG^MUMPS
1)= D REDO^XQ7
2)= D REDO^XQ7
This cross-reference causes the option to be flagged for updating in the menu trees so that the
changes effecting display and/or access to the option are correctly updated.
19,.16 REV KEY PRESENT 0;16 SET
'1' FOR YES;
LAST EDITED: JAN 25, 1990
HELP-PROMPT: This flag indicates whether a reverse or negative lock has been defined for this option
DESCRIPTION:
This field will be set to '1' if this option has a reverse key assigned to it.
WRITE AUTHORITY: ^
NOTES: TRIGGERED by the REVERSE/NEGATIVE LOCK field of the OPTION File
19,.26 HEADER PRESENT? 0;17 SET
'1' FOR YES;
LAST EDITED: DEC 03, 1990
DESCRIPTION:
This field is set to 1 by a trigger on field #26 when MUMPS code is entered into it.
WRITE AUTHORITY: ^
NOTES: TRIGGERED by the HEADER field of the OPTION File
19,1 MENU TEXT 0;2 FREE TEXT (Required)
The option's text, as it appears on the menu
INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>50!($L(X)<3) X
LAST EDITED: JUL 21, 1994
HELP-PROMPT: ANSWER MUST BE 3-50 CHARACTERS IN LENGTH
DESCRIPTION: 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. **
CROSS-REFERENCE: 19^AE^MUMPS
1)= Q ;The C X-ref has been moved to field 1.1
2)= Q
3)= This is a null cross-reference used to overwrite the previous x-ref which set the uppercase tex
t.
This is a null cross-reference used to over-write the previous x-ref.
CROSS-REFERENCE: 19^AORK^MUMPS
1)= I $P(^DIC(19,DA,0),U,4)="O"!($P(^(0),U,4)="Q") S ^DIC(19,"AOR",X,DA)=""
2)= K ^DIC(19,"AOR",X,DA)
This sets the "AORK" cross-reference on the file if the option type is either a protocol or a
protocol menu.
CROSS-REFERENCE: 19^AOA^MUMPS
1)= D REDO^XQ7
2)= D REDO^XQ7
This cross-reference causes the option to be flagged for updating in the menu trees so that the
changes effecting display and/or access to the option are correctly updated.
CROSS-REFERENCE: ^^TRIGGER^19^1.1
1)= K DIV S DIV=X,D0=DA,DIV(0)=D0,DIU=$P($G(^DIC(19,D0,"U")),U) K Y X ^DD(19,1,1,4,1.1) X ^DD(19,1,
1,4,1.4)
1.1)= S X=$E(DIV,1,30),X=$TR(X,"abcdefghijklmnopqrstuvwxyz","ABCDEFGHIJKLMNOPQRSTUVWXYZ"),Y(1)=X
1.4)= S DIH=$S($D(^DIC(19,DIV(0),"U")):^("U"),1:""),DIV=X S $P(^("U"),U,1)=DIV,DIH=19,DIG=1.1 D ^DI
CR:$O(^DD(DIH,DIG,1,0))>0
2)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^DIC(19,D0,"U")):^("U"),1:"") S X=$P(Y(1),U,1),X=X S
DIU=X K Y S X="" X ^DD(19,1,1,4,2.4)
2.4)= S DIH=$S($D(^DIC(19,DIV(0),"U")):^("U"),1:""),DIV=X S $P(^("U"),U,1)=DIV,DIH=19,DIG=1.1 D ^DI
CR:$O(^DD(DIH,DIG,1,0))>0
3)= This X-ref Triggers the UPPERCASE MENU TEXT field.
CREATE VALUE)= $E(UPPERCASE(MENU TEXT),1,30)
DELETE VALUE)= @
FIELD)= UPPERCASE
This X-ref triggers the UPPERCASE MENU TEXT field that builds the C cross-reference. It is also
used by the menu system to build the compiled menus.
19,1.1 UPPERCASE MENU TEXT U;1 FREE TEXT
INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>30!($L(X)<3) X
LAST EDITED: JUL 21, 1994
HELP-PROMPT: Answer must be 3-30 characters in length.
WRITE AUTHORITY: ^
NOTES: TRIGGERED by the MENU TEXT field of the OPTION File
CROSS-REFERENCE: 19^C
1)= S ^DIC(19,"C",$E(X,1,30),DA)=""
2)= K ^DIC(19,"C",$E(X,1,30),DA)
3)= Used by the Menu system
This field builds the UPPERCASE menu text C X-ref.
19,2 OUT OF ORDER MESSAGE 0;3 FREE TEXT
If there is a message here, the option is out of order
INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>50!($L(X)<0) X
LAST EDITED: DEC 03, 1990
HELP-PROMPT: Answer must be 0-50 characters in length.
DESCRIPTION: 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.
CROSS-REFERENCE: 19^AOB^MUMPS
1)= D REDO^XQ7
2)= D REDO^XQ7
This cross-reference causes the option to be flagged for updating in the menu trees so that the
changes effecting display and/or access to the option are correctly updated.
19,3 LOCK 0;6 FREE TEXT
The name of the key required of the user to access this option
INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>30!($L(X)<1) X I $D(X) Q:$D(^DIC(19.1,"B",X)) W !,*7,"Key na
me must match exactly with a key in SECURITY KEY file." K X
LAST EDITED: SEP 12, 1985
HELP-PROMPT: Enter the exact name of the key required to access this option.
DESCRIPTION: 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.
EXECUTABLE HELP: S X="??",DIC=19.1,DIC(0)="E" I $D(^DIC(19.1,0)),$P(^(0),U,3) W "CURRENT LOCKS:" D ^DIC W !
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 19^AOC^MUMPS
1)= D REDO^XQ7
2)= D REDO^XQ7
This cross-reference causes the option to be flagged for updating in the menu trees so that the
changes effecting display and/or access to the option are correctly updated.
19,3.01 REVERSE/NEGATIVE LOCK 3;1 FREE TEXT
INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>27!($L(X)<3) X I $D(X) Q:$D(^DIC(19.1,"B",X)) W !!,"Must mat
ch exactly an entry in the KEY file.",! K X
LAST EDITED: AUG 07, 1991
HELP-PROMPT: Answer must match EXACTLY a name which has been entered in the KEY file.
DESCRIPTION: 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.
EXECUTABLE HELP: S X="??",DIC(0)="E",DIC=19.1 I $D(^DIC(19.1,0)),$P(^(0),U,3) D ^DIC W !
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: ^^TRIGGER^19^.16
1)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$P(Y(1),U,16),X=X S DI
U=X K Y S X=DIV S X="1" X ^DD(19,3.01,1,1,1.4)
1.4)= S DIH=$S($D(^DIC(19,DIV(0),0)):^(0),1:""),DIV=X S $P(^(0),U,16)=DIV,DIH=19,DIG=.16 D ^DICR:$O
(^DD(DIH,DIG,1,0))>0
2)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$P(Y(1),U,16),X=X S DI
U=X K Y S X="" S DIH=$S($D(^DIC(19,DIV(0),0)):^(0),1:""),DIV=X S $P(^(0),U,16)=DIV,DIH=19,DIG=.16 D
^DICR:$O(^DD(DIH,DIG,1,0))>0
CREATE VALUE)= "1"
DELETE VALUE)= @
FIELD)= REV KEY PRESENT
Trigger to set a value of 1 into field .16 if a reverse key is present on this option.
CROSS-REFERENCE: 19^AREDO^MUMPS
1)= D REDO^XQ7
2)= D REDO^XQ7
This cross-reference causes the option to be flagged for updating in the menu trees so that the
changes effecting display and/or access to the option are correctly updated.
19,3.5 DESCRIPTION 1;0 WORD-PROCESSING #19.06
DESCRIPTION: 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.
LAST EDITED: DEC 14, 1983
19,3.6 CREATOR 0;5 POINTER TO NEW PERSON FILE (#200)
The user who created this option
LAST EDITED: OCT 28, 1992
DESCRIPTION:
This field defaults to the DUZ of the user who originally set up this option.
NOTES: TRIGGERED by the NAME field of the OPTION File
19,3.7 HELP FRAME 0;7 POINTER TO HELP FRAME FILE (#9.2)
LAST EDITED: SEP 24, 1985
HELP-PROMPT: Enter the name of a help frame to be displayed when the user types ?
DESCRIPTION: This field contains a pointer to the help text which describes this option. The help text is
displayed to the user on entering '?OPTION'.
CROSS-REFERENCE: 19^AC
1)= S ^DIC(19,"AC",$E(X,1,30),DA)=""
2)= K ^DIC(19,"AC",$E(X,1,30),DA)
This regular cross-reference provides a look-up by Help Frame internal entry number for those
options referencing the desired help frame.
CROSS-REFERENCE: 19^AOG^MUMPS
1)= D REDO^XQ7
2)= D REDO^XQ7
This cross-reference causes the option to be flagged for updating in the menu trees so that the
changes effecting display and/or access to the option are correctly updated.
19,3.8 PRIORITY 0;8 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>10)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: JAN 27, 1986
HELP-PROMPT: TYPE A WHOLE NUMBER BETWEEN 1 AND 10
DESCRIPTION: 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.
CROSS-REFERENCE: 19^AOI^MUMPS
1)= D REDO^XQ7
2)= D REDO^XQ7
This cross-reference causes the option to be flagged for updating in the menu trees so that the
changes effecting display and/or access to the option are correctly updated.
19,3.9 PROHIBITED TIMES 0;9 FREE TEXT
INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>9!($L(X)<9)!'(X?4N1"-"4N) X
LAST EDITED: OCT 13, 1985
HELP-PROMPT: ANSWER MUST BE 9 CHARACTERS IN LENGTH
DESCRIPTION: 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.
CROSS-REFERENCE: 19^AOD^MUMPS
1)= D REDO^XQ7
2)= D REDO^XQ7
This cross-reference causes the option to be flagged for updating in the menu trees so that the
changes effecting display and/or access to the option are correctly updated.
19,3.91 TIMES/DAYS PROHIBITED 3.91;0 Multiple #19.391
DESCRIPTION: 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.
19.391,.01 TIMES PROHIBITED 0;1 FREE TEXT (Multiply asked)
PROHIBITED TIME RANGE ON DAYS OF WEEK
INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>14!($L(X)<9)!'(X?4N1"-"4N) X
LAST EDITED: MAR 14, 1989
HELP-PROMPT: Enter Time Range in format NNNN-NNNN, e.g., 0800-1630 for 8:00 am to 4:30 pm.
DESCRIPTION: 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.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 19.391^B
1)= S ^DIC(19,DA(1),3.91,"B",$E(X,1,30),DA)=""
2)= K ^DIC(19,DA(1),3.91,"B",$E(X,1,30),DA)
CROSS-REFERENCE: 19.391^AOD1^MUMPS
1)= S %XQDA=DA,DA=DA(1) D REDO^XQ7 S DA=%XQDA K %XQDA
2)= S %XQDA=DA,DA=DA(1) D REDO^XQ7 S DA=%XQDA K %XQDA
This cross-reference causes the option to be flagged for updating in the menu trees so that the
changes effecting display and/or access to the option are correctly updated.
19.391,.02 DAYS PROHIBITED 0;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>20!($L(X)<2) X
LAST EDITED: JUL 06, 1988
HELP-PROMPT: Enter Days as first two letters, e.g., FR or MO,WE,FR or MO-FR
DESCRIPTION:
This field may be used to prohibit use of the option on particular days of the week.
19,3.92 QUEUING REQUIRED 3.92;0 Multiple #19.392 (Add New Entry without Asking)
LAST EDITED: APR 23, 1992
DESCRIPTION: 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.
19.392,.01 TIME PERIOD 0;1 FREE TEXT (Multiply asked)
INPUT TRANSFORM: K:$L(X)>9!($L(X)<9)!'(X?4N1"-"4N) X
LAST EDITED: DEC 03, 1990
HELP-PROMPT: Enter time period as NNNN-NNNN (e.g., 0800-1630)
DESCRIPTION: 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.
CROSS-REFERENCE: 19.392^B
1)= S ^DIC(19,DA(1),3.92,"B",$E(X,1,30),DA)=""
2)= K ^DIC(19,DA(1),3.92,"B",$E(X,1,30),DA)
CROSS-REFERENCE: ^^TRIGGER^19^3.93
1)= K DIV S DIV=X,D0=DA(1),DIV(0)=D0,D1=DA S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$P(Y(1),U,18)
,X=X S DIU=X K Y S X=DIV S X="1" X ^DD(19.392,.01,1,2,1.4)
1.4)= S DIH=$S($D(^DIC(19,DIV(0),0)):^(0),1:""),DIV=X S $P(^(0),U,18)=DIV,DIH=19,DIG=3.93 D ^DICR:$
O(^DD(DIH,DIG,1,0))>0
2)= K DIV S DIV=X,D0=DA(1),DIV(0)=D0,D1=DA S Y(0)=X I $O(^DIC(19,DA(1),3.92,0))=DA,$O(^(DA))'>0 I X
S X=DIV S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$P(Y(1),U,18),X=X S DIU=X K Y S X="" X ^DD(19.3
92,.01,1,2,2.4)
2.4)= S DIH=$S($D(^DIC(19,DIV(0),0)):^(0),1:""),DIV=X S $P(^(0),U,18)=DIV,DIH=19,DIG=3.93 D ^DICR:$
O(^DD(DIH,DIG,1,0))>0
3)= Output restrictions won't work if deleted.
CREATE VALUE)= "1"
DELETE CONDITION)= I $O(^DIC(19,DA(1),3.92,0))=DA,$O(^(DA))'>0
DELETE VALUE)= ""
DIC)=
FIELD)= OUTPUT
This cross-reference sets a flag in the 0th node of the option when output restrictions are in
effect. $P(XQY0,U,18) will be 1 if there are restrictions, and null if there are not. This flag
is used by TaskMan to see if queueing is required in ^%ZTLOAD.
19.392,.02 DAY(S) FOR TIME PERIOD 0;2 FREE TEXT
INPUT TRANSFORM:K:$L(X)>20!($L(X)<2) X
LAST EDITED: JAN 25, 1990
HELP-PROMPT: No Entry indicates all days, or enter 2 letter day, MO, or days separated by commas MO,WE,FR or
range of days MO-FR for inclusive range (Monday through Friday)
DESCRIPTION: 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.
19,3.93 OUTPUT RESTRICTED? 0;18 SET
'1' FOR YES;
LAST EDITED: DEC 03, 1990
DESCRIPTION:
This field will contain a '1' if output from this option is restricted to certain days and times.
WRITE AUTHORITY: ^
NOTES: TRIGGERED by the TIME PERIOD field of the QUEUING REQUIRED sub-field of the OPTION File
19,3.95 RESTRICT DEVICES? 0;10 SET
'y' FOR YES;
'n' FOR NO;
LAST EDITED: DEC 05, 1986
DESCRIPTION: 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.'
CROSS-REFERENCE: 19^AOJ^MUMPS
1)= D REDO^XQ7
2)= D REDO^XQ7
This cross-reference causes the option to be flagged for updating in the menu trees so that the
changes effecting display and/or access to the option are correctly updated.
19,3.96 PERMITTED DEVICE 3.96;0 POINTER Multiple #19.396
DESCRIPTION:
This subfile may contain a list of devices upon which this option is permitted to run.
19.396,.01 PERMITTED DEVICE 0;1 POINTER TO DEVICE FILE (#3.5) (Multiply asked)
LAST EDITED: OCT 22, 1987
DESCRIPTION:
This field should contain a pointer to the Device File.
CROSS-REFERENCE: 19.396^B
1)= S ^DIC(19,DA(1),3.96,"B",$E(X,1,30),DA)=""
2)= K ^DIC(19,DA(1),3.96,"B",$E(X,1,30),DA)
19,4 TYPE 0;4 SET (Required)
THE TYPE OF OPTION
'A' FOR action;
'E' FOR edit;
'I' FOR inquire;
'M' FOR menu;
'P' FOR print;
'R' FOR run routine;
'O' FOR protocol;
'Q' FOR protocol menu;
'X' FOR extended action;
'S' FOR server;
'L' FOR limited;
'C' FOR ScreenMan;
'W' FOR Window;
'Z' FOR Window Suite;
'B' FOR Broker (Client/Server);
LAST EDITED: DEC 12, 1995
DESCRIPTION: 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.
CROSS-REFERENCE: 19^AOR^MUMPS
1)= I X="O"!(X="Q") S ^DIC(19,"AOR",$P(^DIC(19,DA,0),U,2),DA)=""
2)= K ^DIC(19,"AOR",$P(^DIC(19,DA,0),U,2),DA)
This sets the "AOR" cross-reference on the file if the option type is either a protocol or a
protocol menu.
CROSS-REFERENCE: 19^AOH^MUMPS
1)= D REDO^XQ7
2)= D REDO^XQ7
This cross-reference causes the option to be flagged for updating in the menu trees so that the
changes effecting display and/or access to the option are correctly updated.
19,10 MENU 10;0 POINTER Multiple #19.01
DESCRIPTION:
This field points to the descendent options of this menu.
IDENTIFIED BY: SYNONYM(#2)
19.01,.01 ITEM 0;1 POINTER TO OPTION FILE (#19) (Multiply asked)
The items which will appear on this menu
INPUT TRANSFORM: S DIC("S")="D CK^XQ7" D ^DIC K DIC S DIC=DIE,X=+Y K:Y<0 X
LAST EDITED: AUG 10, 1987
DESCRIPTION:
The name of an Option which will appear on this menu.
SCREEN: S DIC("S")="D CK^XQ7"
EXPLANATION: A USER CAN ASSIGN A 'LOCKED' MENU ONLY IF HE HAS THAT LOCK
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 19.01^B
1)= S ^DIC(19,DA(1),10,"B",$E(X,1,30),DA)=""
2)= K ^DIC(19,DA(1),10,"B",$E(X,1,30),DA)
CROSS-REFERENCE: 19^AD
1)= S ^DIC(19,"AD",$E(X,1,30),DA(1),DA)=""
2)= K ^DIC(19,"AD",$E(X,1,30),DA(1),DA)
CROSS-REFERENCE: 19^AOE^MUMPS
1)= D REDOXI^XQ7
2)= D REDOXD^XQ7
This cross-reference causes the option to be flagged for updating in the menu trees so that the
changes effecting display and/or access to the option are correctly updated.
19.01,2 SYNONYM 0;2 FREE TEXT
INPUT TRANSFORM: K:X[""""!($A(X)=45)!(X="0") X I $D(X) K:$L(X)>4!($L(X)<1) X
LAST EDITED: DEC 19, 1986
HELP-PROMPT: ANSWER MUST BE 1-4 CHARACTERS IN LENGTH
DESCRIPTION: 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.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 19.01^C
1)= S ^DIC(19,DA(1),10,"C",$E(X,1,30),DA)=""
2)= K ^DIC(19,DA(1),10,"C",$E(X,1,30),DA)
CROSS-REFERENCE: 19^AOF^MUMPS
1)= D REDOXS^XQ7
2)= D REDOXS^XQ7
This cross-reference causes the option to be flagged for updating in the menu trees so that the
changes effecting display and/or access to the option are correctly updated.
19.01,3 DISPLAY ORDER 0;3 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>99)!(X<1)!(X?.E1"."3N.N) X
LAST EDITED: JAN 31, 1986
HELP-PROMPT: TYPE A NUMBER BETWEEN 1 AND 99
DESCRIPTION: 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.
CROSS-REFERENCE: 19.01^AOK^MUMPS
1)= D REDOXZ^XQ7
2)= D REDOXZ^XQ7
This cross-reference causes the option to be flagged for updating in the menu trees so that the
changes effecting display and/or access to the option are correctly updated.
19,10.1 Short Menu Text 10.1;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<3) X
LAST EDITED: OCT 22, 1992
HELP-PROMPT: Enter a short (less than 30 characters) of the Menu Text field.
DESCRIPTION: This field contains a short version of the Menu Text field (field # 1) for use with multi-column
displays. It is a mandatory field.
19,11 DISPLAY OPTION? 0;11 SET
'y' FOR YES;
'n' FOR NO;
LAST EDITED: OCT 13, 1987
DESCRIPTION: 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.
19,12 PACKAGE 0;12 POINTER TO PACKAGE FILE (#9.4)
LAST EDITED: DEC 04, 1987
DESCRIPTION:
This field indicates the package with which this option is associated.
19,13 DELEGABLE 0;13 SET
'n' FOR NO;
'y' FOR YES;
LAST EDITED: JAN 25, 1988
DESCRIPTION: If this field is marked 'no' in the option file then the XQSMD software will not delegate this
option to a user.
19,14 E ACTION PRESENT 0;14 SET
'1' FOR YES;
LAST EDITED: FEB 13, 1991
HELP-PROMPT: THIS FLAG INDICATES IF AN ENTRY ACTION IS PRESENT FOR THIS OPTION
DESCRIPTION:
This field will contain a '1' if the option has an entry action in field #20.
WRITE AUTHORITY: ^
NOTES: TRIGGERED by the ENTRY ACTION field of the OPTION File
CROSS-REFERENCE: 19^AF^MUMPS
1)= D REDO^XQ7
2)= D REDO^XQ7
This cross-reference causes the option to be flagged for updating in the menu trees so that the
changes effecting display and/or access to the option are correctly updated.
19,15 EXIT ACTION 15;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: JAN 09, 1991
HELP-PROMPT: ENTER STANDARD MUMPS CODE
DESCRIPTION: This field contains mumps code which will be executed on leaving this option. It is applicable to
all option types.
WRITE AUTHORITY: @
CROSS-REFERENCE: ^^TRIGGER^19^.15
1)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$P(Y(1),U,15),X=X S DI
U=X K Y S X=DIV S X="1" X ^DD(19,15,1,1,1.4)
1.4)= S DIH=$S($D(^DIC(19,DIV(0),0)):^(0),1:""),DIV=X S $P(^(0),U,15)=DIV,DIH=19,DIG=.15 D ^DICR:$O
(^DD(DIH,DIG,1,0))>0
2)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$P(Y(1),U,15),X=X S DI
U=X K Y S X="" S DIH=$S($D(^DIC(19,DIV(0),0)):^(0),1:""),DIV=X S $P(^(0),U,15)=DIV,DIH=19,DIG=.15 D
^DICR:$O(^DD(DIH,DIG,1,0))>0
CREATE VALUE)= "1"
DELETE VALUE)= @
FIELD)= X AC
This trigger sets the value 1 into field .15 when a value is entered on the current field. This
permits identification of the presence of an exit action without having to determine whether a node
15 exists or not.
19,20 ENTRY ACTION 20;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: JAN 09, 1991
HELP-PROMPT: ENTER STANDARD MUMPS CODE
DESCRIPTION: 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).
WRITE AUTHORITY: @
CROSS-REFERENCE: ^^TRIGGER^19^14
1)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$P(Y(1),U,14),X=X S DI
U=X K Y S X=DIV S X="1" X ^DD(19,20,1,1,1.4)
1.4)= S DIH=$S($D(^DIC(19,DIV(0),0)):^(0),1:""),DIV=X S $P(^(0),U,14)=DIV,DIH=19,DIG=14 D ^DICR:$O(
^DD(DIH,DIG,1,0))>0
2)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$P(Y(1),U,14),X=X S DI
U=X K Y S X="" S DIH=$S($D(^DIC(19,DIV(0),0)):^(0),1:""),DIV=X S $P(^(0),U,14)=DIV,DIH=19,DIG=14 D
^DICR:$O(^DD(DIH,DIG,1,0))>0
CREATE VALUE)= "1"
DELETE VALUE)= @
FIELD)= E ACT
This trigger sets the value 1 into field 14 when a value is entered on the current field. This
permits identification of the presence of an entry action without having to determine whether a
node 20 exists or not.
19,21 XQUIT MESSAGE 21;0 WORD-PROCESSING #19.021
LAST EDITED: OCT 07, 1997
HELP-PROMPT: Enter the message to be given when XQUIT stops the user.
DESCRIPTION: This word processing field should contain the message that the developer wants the menu
system to display on the user's screen when normal progress to a target options is halted because
the variable XQUIT has been encountered after the execution of the Entry Action (field 20).
19,22 XQUIT EXECUTABLE 22;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: OCT 14, 1997
HELP-PROMPT: M code executed when XQUIT is encountered
DESCRIPTION: 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.
WRITE AUTHORITY: @
19,25 ROUTINE 25;E1,245 FREE TEXT
INPUT TRANSFORM: K:$L(X)>53!(X'?.1ANP.15AN.1"^"1ANP.15AN.1"[".1"(".E) X I $D(X),X["[",'$D(^XUSEC("XUMGR",DUZ)) K X
MAXIMUM LENGTH: 53
LAST EDITED: MAR 30, 2016
HELP-PROMPT: Answer must be [TAG^]ROUTINE[(parameters)] to run, 1-53 characters.
DESCRIPTION: Indicate the name of the tag, routine, and parameters. e.g. ROUTINE, or TAG^ROUTINE(parameters).
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
19,26 HEADER 26;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: JAN 08, 1991
HELP-PROMPT: This is Standard MUMPS code executed upon entry of the option.
DESCRIPTION: 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.
CROSS-REFERENCE: ^^TRIGGER^19^.26
1)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$P(Y(1),U,17),X=X S DI
U=X K Y S X=DIV S X="1" X ^DD(19,26,1,1,1.4)
1.4)= S DIH=$S($D(^DIC(19,DIV(0),0)):^(0),1:""),DIV=X S $P(^(0),U,17)=DIV,DIH=19,DIG=.26 D ^DICR:$O
(^DD(DIH,DIG,1,0))>0
2)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$P(Y(1),U,17),X=X S DI
U=X K Y S X="" S DIH=$S($D(^DIC(19,DIV(0),0)):^(0),1:""),DIV=X S $P(^(0),U,17)=DIV,DIH=19,DIG=.26 D
^DICR:$O(^DD(DIH,DIG,1,0))>0
CREATE VALUE)= "1"
DELETE VALUE)= @
FIELD)= #.26
This trigger sets the field HEADER PRESENT to '1' when there is mumps code in the field HEADER.
HEADER PRESENT is carried as a flag in the 0th node of each option.
19,30 DIC {DIC} 30;E1,64 FREE TEXT
SELECT FILE IN DIC
INPUT TRANSFORM: K:$L(X)>30!(X'?.1"%"1A.6AN1"(".ANP) X
LAST EDITED: MAR 19, 1991
HELP-PROMPT: Enter the global reference for DIC, WITHOUT the "^".
DESCRIPTION: 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(
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
19,31 DIC(0) 31;E1,9 FREE TEXT
INPUT TRANSFORM: K:$L(X)>9!($L(X)<1) X
HELP-PROMPT: ANSWER MUST BE 1-9 CHARACTERS IN LENGTH
DESCRIPTION: 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)
19,32 DIC(A) 32;E1,245 FREE TEXT
INPUT TRANSFORM: K:$L(X)>245!($L(X)<1) X
LAST EDITED: DEC 14, 1987
HELP-PROMPT: ANSWER MUST BE 1-245 CHARACTERS IN LENGTH
DESCRIPTION: 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:
19,33 DIC(B) 33;E1,245 FREE TEXT
INPUT TRANSFORM: K:$L(X)>245!($L(X)<1) X
LAST EDITED: DEC 14, 1987
HELP-PROMPT: ANSWER MUST BE 1-245 CHARACTERS IN LENGTH
DESCRIPTION: 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:
19,34 DIC(S) 34;E1,245 MUMPS
INPUT TRANSFORM: D ^DIM
LAST EDITED: DEC 10, 1987
HELP-PROMPT: ENTER STANDARD MUMPS CODE
DESCRIPTION: 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.
WRITE AUTHORITY: @
19,35 DIC(W) 35;E1,245 MUMPS
INPUT TRANSFORM: D ^DIM
LAST EDITED: DEC 10, 1987
HELP-PROMPT: ENTER STANDARD MUMPS CODE
DESCRIPTION: 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.
WRITE AUTHORITY: @
19,36 D. 36;E1,245 FREE TEXT
INPUT TRANSFORM: K:$L(X)>245!($L(X)<1) X
LAST EDITED: DEC 14, 1987
HELP-PROMPT: ANSWER MUST BE 1-245 CHARACTERS IN LENGTH
DESCRIPTION: 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".
19,40 DR{DDS} 40;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>245!($L(X)<1) X
LAST EDITED: OCT 20, 1993
HELP-PROMPT: Enter the name of a form from the Form File enclosed in square brackets, e.g."[MYFORM]".
DESCRIPTION: This field contains the name of the form from the Form File enclosed in square brackets, e.g.,
"[MYFORM]".
19,41 DDSFILE 41;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>64!($L(X)<1) X
LAST EDITED: OCT 20, 1993
HELP-PROMPT: Enter the file number or the global root of the file being displayed or edited.
DESCRIPTION: This is the root of the file being edited or displayed entered without the up-arrow, e.g.,
"DIC(19,".
19,42 DDSFILE(1) 42;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>64!($L(X)<1) X
LAST EDITED: OCT 20, 1993
HELP-PROMPT: Enter the subfile number or the global root of the subfile.
DESCRIPTION:
This is the global root of the subfile being edited or displayed.
19,43 DDSPAGE 43;1 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999.9)!(X<1)!(X?.E1"."2N.N) X
LAST EDITED: OCT 21, 1993
HELP-PROMPT: Enter a Page Number between 1 and 999.9, 1 Decimal Digit
DESCRIPTION: 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.
19,44 DDSPARM 43;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>9!($L(X)<1) X
LAST EDITED: OCT 21, 1993
HELP-PROMPT: Answer must be 1-9 characters in length.
DESCRIPTION: 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.
19,50 DIE 50;E1,64 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30 X
LAST EDITED: JAN 23, 1984
HELP-PROMPT: Enter the File number, or the global reference for DIE, WITHOUT the "^".
DESCRIPTION: Used in the EDIT type option. The global reference of the file to be used in the edit.
example: DPT(
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
19,51 DR {DIE} 51;E1,245 FREE TEXT
INPUT TRANSFORM: K:$L(X)>245!($L(X)<1) X
LAST EDITED: FEB 17, 1988
HELP-PROMPT: ANSWER MUST BE 1-245 CHARACTERS IN LENGTH, CODE FOR DR.
DESCRIPTION: 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]
19,52 *DR() 52;E1,245 FREE TEXT
INPUT TRANSFORM: K:$L(X)>245!($L(X)<1) X
LAST EDITED: FEB 17, 1988
HELP-PROMPT: ANSWER MUST BE 1-245 CHARACTERS IN LENGTH
19,53 NO UP-ARROW 53;1 SET
'N' FOR NO UP-ARROWING ALLOWED;
'OUTOK' FOR UP-ARROW OUT OK, NO BRANCHING;
'BACK' FOR BACK JUMPING OK, NO EXIT;
'BACKOUTOK' FOR EXIT AND BACK JUMPING OK;
LAST EDITED: APR 10, 1990
DESCRIPTION: 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.
19,54 *DIE(W) 54;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: MAR 21, 1991
HELP-PROMPT: ENTER STANDARD MUMPS CODE
DESCRIPTION: 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.
WRITE AUTHORITY: @
19,60 DIC {DIP} 60;E1,64 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!(X'["(") X
LAST EDITED: AUG 17, 1987
HELP-PROMPT: ENTER THE GLOBAL REFERENCE FOR 'DIP', WITHOUT THE "^".
DESCRIPTION: The global reference of the file to be used in PRINT type option.
example: DPT(
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
19,61 PG 61;1 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>9999)!(X<0)!(X?.E1"."1N.N) X
HELP-PROMPT: TYPE A WHOLE NUMBER BETWEEN 0 AND 9999
DESCRIPTION: 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.
19,62 L. 62;E1,245 FREE TEXT
INPUT TRANSFORM: K:$L(X)>245!($L(X)<1) X
LAST EDITED: DEC 14, 1987
HELP-PROMPT: ANSWER MUST BE 1-245 CHARACTERS IN LENGTH
DESCRIPTION: 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.
EXECUTABLE HELP: W !?4,"SHOULD ALWAYS CONTAIN '0'. IF A '1' IS ENTERED",!?4,"THE USER WILL BE ASKED FOR FLDS,FR,TO
AND DHD"
19,63 FLDS 63;E1,245 FREE TEXT
INPUT TRANSFORM: K:$L(X)>245!($L(X)<1) X
LAST EDITED: DEC 14, 1987
HELP-PROMPT: ANSWER MUST BE 1-245 CHARACTERS IN LENGTH
DESCRIPTION: 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]
EXECUTABLE HELP: W !?4,"FIELD FORMAT '.01;"_""""_"PATIENT NAME"_""""_";C1,.02,.1'",!?4,"OR A '[PRINT TEMPLATE NAME]'
"
19,64 BY 64;E1,245 FREE TEXT
INPUT TRANSFORM: K:$L(X)>245!($L(X)<1) X
LAST EDITED: DEC 14, 1987
HELP-PROMPT: ANSWER MUST BE 1-245 CHARACTERS IN LENGTH
DESCRIPTION: 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]
EXECUTABLE HELP: W !?4,"SORT BY FORMAT '.1,.01' OR A [SORT TEMPLATE NAME]"
19,65 FR 65;E1,245 FREE TEXT
INPUT TRANSFORM: K:$L(X)>245!($L(X)<1) X
LAST EDITED: DEC 15, 1987
HELP-PROMPT: ANSWER MUST BE IN 'START WITH' VALUES SEPARATED BY COMMAS
DESCRIPTION: 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)
EXECUTABLE HELP: W !?4,"START WITH '2NE,SMITH' (WARD AND NAME)"
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
19,66 TO 66;E1,245 FREE TEXT
INPUT TRANSFORM: K:$L(X)>245!($L(X)<1) X
LAST EDITED: DEC 15, 1987
HELP-PROMPT: ANSWER MUST BE IN 'GO TO' VALUES SEPARATED BY COMMAS
DESCRIPTION: 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)
EXECUTABLE HELP: W !?4,"GO TO '2NE,SMITH' (WARD AND NAME)"
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
19,67 DHD 67;E1,245 FREE TEXT
INPUT TRANSFORM: D:X?1"W ".ANP ^DIM I $D(X) K:X[""""&(X'?1"W ".ANP) X I $D(X),X?1"W ".ANP S Q="""" F %=1:2 Q:'$D(X)
Q:$P(X,Q,%,999)="" K:$P($E(3,999),Q,%)[" " X
LAST EDITED: JAN 24, 1984
HELP-PROMPT: ANSWER MUST BE 1-245 CHARACTERS OR A MUMPS STATEMENT STARTING WITH 'W '.
DESCRIPTION: 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)
EXECUTABLE HELP: W !?5,"Quotes are valid only within a MUMPS write statement",!
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
19,68 DCOPIES 68;1 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>99999)!(X<0)!(X?.E1"."1N.N) X
HELP-PROMPT: TYPE A WHOLE NUMBER BETWEEN 0 AND 99999
DESCRIPTION: Used in the PRINT type option. The number of copies desired. SDP space must be available on your
system for this option.
19,69 DIS(0) 69;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: MAR 21, 1991
HELP-PROMPT: Enter standard M code which sets $T.
DESCRIPTION: 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).
WRITE AUTHORITY: @
19,69.1 DIS(1) 69.1;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: MAR 21, 1991
HELP-PROMPT: Enter standard M code which sets $T.
DESCRIPTION: 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.
WRITE AUTHORITY: @
19,69.2 DIS(2) 69.2;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: MAR 21, 1991
HELP-PROMPT: Enter standard M code which sets $T.
DESCRIPTION: 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.
WRITE AUTHORITY: @
19,69.3 DIS(3) 69.3;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: MAR 21, 1991
HELP-PROMPT: Enter standard M code which sets $T.
DESCRIPTION: 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.
WRITE AUTHORITY: @
19,70 IOP 70;1 FREE TEXT
INPUT TRANSFORM: Q:X="HOME" S DIC="^%ZIS(1,",DIC(0)="EMQ" D ^DIC K DIC S X=$P(Y,U,2),DIC=DIE K:Y<0 X
LAST EDITED: DEC 13, 1990
HELP-PROMPT: THIS IS THE DEFAULT OUTPUT DEVICE
DESCRIPTION: The default output device. Enter a valid Device Name or "HOME" to mean output will always go to
the home device.
EXECUTABLE HELP: S DIC="^%ZIS(1,",DIC(0)="M",D="B" D DQ^DICQ K DIC S DIC=DIE
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
19,71 DHIT 71;E1,245 MUMPS
INPUT TRANSFORM: D ^DIM
LAST EDITED: AUG 13, 1987
HELP-PROMPT: ENTER STANDARD MUMPS CODE
DESCRIPTION: 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.
WRITE AUTHORITY: @
19,72 DIOBEG 72;E1,245 MUMPS
INPUT TRANSFORM: D ^DIM
LAST EDITED: AUG 13, 1987
HELP-PROMPT: ENTER STANDARD MUMPS CODE
DESCRIPTION: Used in the PRINT type option. Enter a string of MUMPS code that will be executed before the
printout starts.
WRITE AUTHORITY: @
19,73 DIOEND 73;E1,245 MUMPS
INPUT TRANSFORM: D ^DIM
LAST EDITED: AUG 13, 1987
HELP-PROMPT: ENTER STANDARD MUMPS CODE
DESCRIPTION: 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.
WRITE AUTHORITY: @
19,76 BY(0) 76;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>200!($L(X)<1) X
LAST EDITED: OCT 20, 1993
HELP-PROMPT: Enter the 'static' part of a cross-reference or an open global reference, or the name of a search
template enclosed in square brackets. Answer must be 1-200 characters in length.
DESCRIPTION: 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]
TECHNICAL DESCR: If this field is not null, set BY(0) equal to its contents before calling EN1^DIP. If it is not
null, field L(0) should also be set.
WRITE AUTHORITY: ^
GROUP: V21X
19,76.1 L(0) 79;5 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>7)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: OCT 19, 1993
HELP-PROMPT: Enter the total number of subscripts that must be sorted through to get to the record number, PLUS
1 for the record number. Type a Number between 1 and 7, 0 Decimal Digits
DESCRIPTION: 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).
TECHNICAL DESCR: This field is checked ONLY if BY(0) is set, and is REQUIRED if BY(0) is set. If this field is not
null, set L(0) equal to the contents before calling EN1^DIP.
WRITE AUTHORITY: ^
GROUP: V21
19,76.2 FR(0,N) FROM;0 Multiple #19.02
DESCRIPTION:
Sort FROM criteria associated with the subscripts defined by the BY(0) input variable.
WRITE AUTHORITY: ^
GROUP: V21
19.02,.01 SUBSCRIPT LEVEL NUMBER 0;1 NUMBER (Multiply asked)
INPUT TRANSFORM: K:+X'=X!(X>6)!(X<1)!(X?.E1"."1N.N) X S:$G(X) DINUM=X
LAST EDITED: OCT 20, 1993
HELP-PROMPT: Enter the subscript level number 'N', associated with the 'Nth' subscript in the BY(0)
cross-reference or global. Used to set up FR(0,N) input variable to the print routine EN1^DIP
DESCRIPTION: 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).
TECHNICAL DESCR: This field should only be filled out if BY(0) exists, but is not required.
If the field is filled in, then it should be used as the second subscript, "N", when setting up
the FR(0,N) variable before a call to EN1^DIP. FR(0,N) will be set to the second piece of this
node (the FROM VALUE). Since the .01 field of this multiple is DINUMED, the record number will
be equal to this .01 field.
GROUP: V21
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 19.02^B
1)= S ^DIC(19,DA(1),"FROM","B",$E(X,1,30),DA)=""
2)= K ^DIC(19,DA(1),"FROM","B",$E(X,1,30),DA)
19.02,1 FROM VALUE 0;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>62!($L(X)<1) X
LAST EDITED: OCT 13, 1993
HELP-PROMPT: Enter the value that you want to START WITH when sorting through this subscript. Answer must be
1-62 characters in length.
DESCRIPTION: 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.
TECHNICAL DESCR: This field should only be filled out if BY(0) exists, but is not required. If a record exists,
for example, in record 1 of this multiple, then FR(0,1) should be set to the contents of this
field before calling EN1^DIP.
GROUP: V21
19,76.3 TO(0,N) TO;0 Multiple #19.03
DESCRIPTION:
Sort TO criteria associated with the subscripts defined by the BY(0) input variable.
WRITE AUTHORITY: ^
GROUP: V21
19.03,.01 SUBSCRIPT LEVEL NUMBER 0;1 NUMBER (Multiply asked)
INPUT TRANSFORM: K:+X'=X!(X>6)!(X<1)!(X?.E1"."1N.N) X S:$G(X) DINUM=X
LAST EDITED: OCT 20, 1993
HELP-PROMPT: Enter the subscript level number 'N', associated with the 'Nth' subscript in the BY(0)
cross-reference or global. Used to set up TO(0,N) input variable to the print routine EN1^DIP
DESCRIPTION: 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).
TECHNICAL DESCR: This field should only be filled out if BY(0) exists, but is not required.
If the field is filled in, then it should be used as the second subscript, "N", when setting up
the TO(0,N) variable before a call to EN1^DIP. TO(0,N) will be set to the second piece of this
node (the TO VALUE). Since the .01 field of this multiple is DINUMED, the record number will be
equal to this .01 field.
GROUP: V21
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 19.03^B
1)= S ^DIC(19,DA(1),"TO","B",$E(X,1,30),DA)=""
2)= K ^DIC(19,DA(1),"TO","B",$E(X,1,30),DA)
19.03,1 TO VALUE 0;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>62!($L(X)<1) X
LAST EDITED: OCT 13, 1993
HELP-PROMPT: Enter the value that you want to GO TO when sorting through this subscript. Answer must be 1-62
characters in length.
DESCRIPTION: 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.
TECHNICAL DESCR: This field should only be filled out if BY(0) exists, but is not required. If a record exists,
for example, in record 1 of this multiple, then TO(0,1) should be set to the contents of this
field before calling EN1^DIP.
GROUP: V21
19,76.4 DISPAR(0,N) SUB;0 Multiple #19.04
LAST EDITED: OCT 15, 1993
WRITE AUTHORITY: ^
GROUP: V21
19.04,.01 SUBSCRIPT LEVEL NUMBER 0;1 NUMBER (Multiply asked)
INPUT TRANSFORM: K:+X'=X!(X>6)!(X<1)!(X?.E1"."1N.N) X S:$G(X) DINUM=X
LAST EDITED: OCT 20, 1993
HELP-PROMPT: Enter the subscript level number 'N', associated with the 'Nth' subscript in the BY(0)
cross-reference or global. Used to set up DISPAR(0,N) input variables to the print routine
EN1^DIP
DESCRIPTION: 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).
TECHNICAL DESCR: This field should only be filled out if BY(0) exists, but is not required.
If the field is filled in, then it should be used as the second subscript, "N", when setting up
the DISPAR(0,N) variables before a call to EN1^DIP. DISPAR(0,N) will be set to the second and
third pieces of this node (STATICTICAL CONTROL CHARACTERS and SUBHEADER FORMAT CHARACTERS
fields), DISPAR(0,N,"OUT") will be set to the SUBHEADER OUTPUT TRANSFORM field. Since the .01
field of this multiple is DINUMED, the record number will be equal to this .01 field.
GROUP: V21
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 19.04^B
1)= S ^DIC(19,DA(1),"SUB","B",$E(X,1,30),DA)=""
2)= K ^DIC(19,DA(1),"SUB","B",$E(X,1,30),DA)
19.04,1 STATISTICAL CONTROL CHARACTERS 0;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>10!($L(X)<1) X
LAST EDITED: OCT 13, 1993
HELP-PROMPT: Enter control characters normally entered BEFORE a sort field when doing a FileMan print. NOTE:
only !, #, + or @ are allowed.
DESCRIPTION: 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.
TECHNICAL DESCR: This field should only be filled out if BY(0) exists, but is not required. If a record exists,
for example, in record 1 of this multiple, then the first piece of DISPAR(0,1) should be set to
the contents of this field before calling EN1^DIP.
GROUP: V21
19.04,2 SUBHEADER FORMAT CHARACTERS 0;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>120!($L(X)<1) X
LAST EDITED: OCT 20, 1993
HELP-PROMPT: Enter control fields normally entered AFTER a sort field when doing a FileMan print. These
control fields control printing of the subheader. Answer must be 1-120 characters in length.
DESCRIPTION: 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.)
TECHNICAL DESCR: This field should only be filled out if BY(0) exists, but is not required.
If a record exists, for example, in record 1 of this multiple, then the second piece of
DISPAR(0,1) should be set to the contents of this field before calling EN1^DIP.
GROUP: V21
19.04,3 SUBHEADER OUTPUT TRANSFORM 1;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: OCT 13, 1993
HELP-PROMPT: Enter Standard MUMPS code that takes untransformed subscript Y from the BY(0) cross-reference,
and puts the printable value into Y.
DESCRIPTION: 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".
TECHNICAL DESCR: This field should only be filled out if BY(0) exists, but is not required.
If a record exists, for example, in record 1 of this multiple, then DISPAR(0,1,"OUT") should be
set to the contents of this field before calling EN1^DIP.
WRITE AUTHORITY: @
GROUP: V21
19,77 DISUPNO 79;2 SET
'1' FOR SUPPRESS HEADER IF NO RECORDS;
LAST EDITED: OCT 13, 1993
HELP-PROMPT: Enter 1 to suppress printing the HEADER and the 'NO MATCHES' or 'No Records to Print' message, when
no entries meet SEARCH or SORT criteria.
DESCRIPTION: 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.
TECHNICAL DESCR: Set DISUPNO to the contents of this field before calling either EN1^DIP or ENS^DIS. It is OK to set
DISUPNO to this field even if it is null.
GROUP: V21
19,78 DIPCRIT 79;3 SET
'1' FOR PRINT SEARCH/SORT CRITERIA;
LAST EDITED: OCT 13, 1993
HELP-PROMPT: Print SEARCH and/or SORT criteria in the heading of the first page when using the standard FileMan
header on a SEARCH or PRINT.
DESCRIPTION: 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.
TECHNICAL DESCR: Set DIPCRIT to the contents of this field before calling EN1^DIP. It is OK to set DIPCRIT to this
field, even if it is null.
GROUP: V21
19,79 DIASKHD 79;1 SET
'0' FOR Do not ask user for a header;
'1' FOR Ask user for a header;
LAST EDITED: MAR 20, 1991
HELP-PROMPT: Entering a 1 will cause a user to be prompted for a print header.
DESCRIPTION: 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.
19,79.5 DISTEMP 79;4 FREE TEXT
INPUT TRANSFORM: K:$L(X)>32!($L(X)<1) X
LAST EDITED: OCT 13, 1993
HELP-PROMPT: Enter the name of a SEARCH template with criteria, to RE-DO the search. Can be enclosed in
brackets. Answer must be 1-32 characters in length.
DESCRIPTION: 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.
TECHNICAL DESCR: This field is only used, and is REQUIRED, for a call to ENS^DIS, the option to re-do a search. If
the field is defined, set DISTEMP equal to the contents of the field before the call. You then
must set up the other variables that would be set up if doing a normal FileMan PRINT.
GROUP: V21
19,80 DIC {DIQ} 80;E1,64 FREE TEXT
INPUT TRANSFORM: K:$L(X)>64!($L(X)<1) X
HELP-PROMPT: Enter the global reference for DIQ, WITHOUT the "^".
DESCRIPTION: Used in the INQUIRY type option. The global reference of the file to be used in the inquiry.
example: DPT(
19,81 DR {DIQ} 81;E1,245 FREE TEXT
INPUT TRANSFORM: K:$L(X)>250!($L(X)<1) X
HELP-PROMPT: ANSWER MUST BE 1-250 CHARACTERS IN LENGTH
DESCRIPTION: 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
19,82 DIQ(0) 82;E1,245 SET
'C' FOR Computed Fields;
'R' FOR Record Number (IEN);
'B' FOR Both Computed Fields and Record Number (IEN);
LAST EDITED: JUL 27, 2017
HELP-PROMPT: Select the code to handle displaying Computed Fields and Record Number (IEN).
DESCRIPTION: This field determines if you want Computed Fields and Record Number (IEN) displayed with each
record. Leave this field blank if you don't want Record Number or Computed Fields displayed.
19,83 SUPRESS DEVICE PROMPT 83;1 SET
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: AUG 25, 1992
HELP-PROMPT: Enter Yes or No. With [CAPTIONED] template Yes forces output to the screen.
19,99 TIMESTAMP 99;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>15!($L(X)<1) X
LAST EDITED: OCT 13, 1985
HELP-PROMPT: ANSWER MUST BE 1-15 CHARACTERS IN LENGTH
DESCRIPTION:
This field contains the timestamp for when the option was created.
WRITE AUTHORITY: ^
19,99.1 TIMESTAMP OF PRIMARY MENU 99.1;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>15!($L(X)<1) X
HELP-PROMPT: ANSWER MUST BE 1-15 CHARACTERS IN LENGTH
DESCRIPTION:
This field contains the timestamp of when this primary menu tree was rebuilt.
WRITE AUTHORITY: ^
19,100 *ORDER PRINT ACTION 100;E1,245 MUMPS
INPUT TRANSFORM: D ^DIM
LAST EDITED: JUN 03, 1987
HELP-PROMPT: ENTER STANDARD MUMPS CODE
WRITE AUTHORITY: @
19,100.1 *ORDER CANCEL ACTION 100.1;E1,245 MUMPS
INPUT TRANSFORM: D ^DIM
LAST EDITED: JUN 03, 1987
HELP-PROMPT: ENTER STANDARD MUMPS CODE
WRITE AUTHORITY: @
19,100.2 *ORDER PURGE ACTION 100.2;E1,245 MUMPS
INPUT TRANSFORM: D ^DIM
LAST EDITED: JUN 03, 1987
HELP-PROMPT: ENTER STANDARD MUMPS CODE
WRITE AUTHORITY: @
19,110 INDEPENDENTLY INVOCABLE 2;1 SET
Independently Invocable
'n' FOR NO;
'y' FOR YES;
LAST EDITED: FEB 10, 1989
HELP-PROMPT: Enter NO if this option requires the action of another option first
DESCRIPTION: 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.
19,200 *QUEUED TO RUN AT WHAT TIME 200;1 DATE
TIME AT WHICH TASKMAN WILL AUTOMATICALLY START UP THIS OPTION
INPUT TRANSFORM: K X
LAST EDITED: JUL 14, 1994
HELP-PROMPT: Time must be at least 2 minutes in the future and type run, action, print
DESCRIPTION:
This field is OBSOLETE, Please use the new Option scheduling File.
EXECUTABLE HELP: N % S %(1)="Changing or deleting this date/time field will re-queue",%(2)="or un-queue the Option."
D EN^DDIOL(.%)
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 19^AZT^MUMPS
1)= Q
2)= Q
This field and X-ref are beening replaced part of a package install) to set or remove the option as
a task queued for the specified time.
19,201 *DEVICE FOR QUEUED JOB OUTPUT 200;2 FREE TEXT
INPUT TRANSFORM: K X
LAST EDITED: JUL 14, 1994
HELP-PROMPT: MUST BE NAME OF DEVICE ON WHICH THE QUEUED OPTION WILL PRINT
DESCRIPTION:
This field is OBSOLETE, Please use the new Option scheduling File.
EXECUTABLE HELP: N % S %(1)="If TASKMAN cannot identify a DEVICE by this name",%(2)="at the time of dequeueing, job
will not run, " D EN^DDIOL(.%)
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 19^AZTIO^MUMPS
1)= Q
2)= Q
19,202 *RESCHEDULING FREQUENCY 200;3 FREE TEXT
FREQUENCY WITH WHICH THIS OPTION WILL BE AUTOMATICALLY RESCHEDULED TO RUN
INPUT TRANSFORM: K X
LAST EDITED: MAR 09, 1994
HELP-PROMPT: FOR AUTOMATIC RE-QUEUING, ANSWER WITH INCREMENT OF HOURS, DAYS, OR MONTHS
DESCRIPTION:
This field is OBSOLETE, Please use the new Option scheduling File.
EXECUTABLE HELP: N % S %(1)="Examples:",%(2)=" 120S = job will be re-run every two minutes",%(3)=" 1H = job will b
e rerun every hour",%(4)=" 7D = job will be re-run every week",%(5)=" 3M = job will be run once
a quarter" D EN^DDIOL(.%)
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
19,203 *QUEUED TO RUN ON VOLUME SET 200;4 FREE TEXT
INPUT TRANSFORM: K X
LAST EDITED: JUL 14, 1994
HELP-PROMPT: Answer must be the (2-15 char) volume set (CPU) name that the option should run on.
DESCRIPTION:
This field is OBSOLETE, Please use the new Option scheduling File.
EXECUTABLE HELP: D EN^DDIOL("The volume set name must also be in the Kernel site parameters as a volume set.")
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 19^AZTVOL^MUMPS
1)= Q
2)= Q
This field and X-ref beening replaced. part of a package install) for the option as a queued task.
19,209 SCHEDULING RECOMMENDED 200.9;1 SET
'y' FOR YES;
'n' FOR NO;
's' FOR STARTUP;
LAST EDITED: AUG 09, 1994
DESCRIPTION: This field should be filled in by developers to allow reports of options that a site should
consider seting up for background scheduling.
19,209.2 KEEP FROM DELETING 200.9;2 SET
'y' FOR Yes;
LAST EDITED: JAN 17, 1997
HELP-PROMPT: Set if this is option shouldn't be purged.
DESCRIPTION: 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.
19,220 SERVER BULLETIN 220;1 POINTER TO BULLETIN FILE (#3.6)
LAST EDITED: JUL 07, 1989
HELP-PROMPT: Enter the bulletin you would like sent to notify users of a server request
DESCRIPTION: 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.
19,221 SERVER ACTION 220;2 SET
'R' FOR RUN IMMEDIATELY;
'Q' FOR QUEUE SERVER ROUTINE;
'N' FOR NOTIFY MAIL GROUP (DO NOT RUN);
'I' FOR IGNORE REQUESTS;
LAST EDITED: JUL 07, 1989
HELP-PROMPT: What do you want the menu system to do when a request for this server option is received from the
mail system.
DESCRIPTION: 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.
19,222 SERVER MAIL GROUP 220;3 POINTER TO MAIL GROUP FILE (#3.8)
LAST EDITED: JUL 07, 1989
HELP-PROMPT: Who should be notified in the event of a server request if 'N' is specified in Server Action codes
(field #221).
DESCRIPTION: 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.
19,223 SERVER AUDIT 220;4 SET
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: JUL 07, 1989
HELP-PROMPT: Do you want all requests for this server, and results of those requests logged?
DESCRIPTION: 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.
19,224 SUPRESS BULLETIN 220;5 SET
SUPRESS SERVER REQUEST BULLETIN
'Y' FOR YES, SUPRESS IT;
'N' FOR NO (DEFAULT) SEND A BULLETIN;
LAST EDITED: NOV 30, 1989
HELP-PROMPT: ENTER 'Y' TO SUPRESS THE SENDING OF A BULLETIN
DESCRIPTION: 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.
19,225 SERVER REPLY 220;6 SET
'N' FOR NO REPLY (DEFAULT);
'E' FOR REPLY ON ERROR ONLY;
'R' FOR SEND REPLY IN ALL CASES;
LAST EDITED: NOV 30, 1989
HELP-PROMPT: N=NO REPLY, E=REPLY ON ERROR ONLY, R=SEND REPLY
DESCRIPTION: 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.
19,226 SAVE REQUEST 220;7 SET
'0' FOR Do not save request;
'1' FOR Save request in Postmaster basket;
LAST EDITED: FEB 04, 1992
HELP-PROMPT: A '1' in this field will cause the message to be entered in mail basket for long-term storage.
DESCRIPTION: 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.
19,227 SERVER DEVICE 220;8 POINTER TO DEVICE FILE (#3.5)
LAST EDITED: NOV 16, 1993
HELP-PROMPT: Enter the name of a resource in the Device File
19,228 ZTSK RETENTION DAYS 220;9 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>365)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: OCT 15, 1996
HELP-PROMPT: Number of days (1 to 365) task will be retained in ^ZTSK (default = 14 days).
DESCRIPTION: 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.
19,300 ICON W;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<3) X
LAST EDITED: JUL 13, 1994
HELP-PROMPT: Enter the name of a file containing the icon for this window option.
19,301 TITLE W;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>25!($L(X)<3) X
LAST EDITED: AUG 05, 1994
HELP-PROMPT: Answer must be 3-25 characters in length.
19,320 RPC RPC;0 POINTER Multiple #19.05
TECHNICAL DESCR:
This field contains a pointer to the Remote Procedure file for an RPC registered to this option.
19.05,.01 RPC 0;1 POINTER TO REMOTE PROCEDURE FILE (#8994) (Multiply asked)
LAST EDITED: DEC 12, 1995
HELP-PROMPT: Enter a Remote Procedure registered to this option.
DESCRIPTION: 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.
CROSS-REFERENCE: 19.05^B
1)= S ^DIC(19,DA(1),"RPC","B",$E(X,1,30),DA)=""
2)= K ^DIC(19,DA(1),"RPC","B",$E(X,1,30),DA)
19.05,1 RPCKEY 0;2 FREE TEXT
INPUT TRANSFORM:K:$L(X)>30!($L(X)<1) X I $D(X) Q:$D(^DIC(19.1,"B",X)) W !,*7,"Key name must match exactly with a k
ey in the Security Key File." K X
LAST EDITED: JAN 08, 1996
HELP-PROMPT: Answer must be the name of an existing key 1-30 characters in length.
DESCRIPTION: 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.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
19.05,2 RULES 1;E1,245 MUMPS
INPUT TRANSFORM:K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: DEC 12, 1995
HELP-PROMPT: This is Standard MUMPS code.
DESCRIPTION: 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.
WRITE AUTHORITY:@
19,1613 PRIMARY MENU 1613;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>77!($L(X)<3)!($P(^DIC(19,DA,0),U,4)'="M") X
LAST EDITED: FEB 25, 1985
HELP-PROMPT: Answer with a User description, if this menu could be assigned as a 'Primary Menu Option'
DESCRIPTION: 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"
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
19,1840 PROTECTED VARIABLES NOKILL;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>245!($L(X)<1)!(X[" ") X S X="N "_X D ^DIM S:$D(X) X=$E(X,3,999)
LAST EDITED: FEB 15, 1995
HELP-PROMPT: Answer must be a list of variables. Limit 245 char.
DESCRIPTION: 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
TECHNICAL DESCR:
This list is used as the indirect argument to a NEW command.
EXECUTABLE HELP: W !,"Like:",!,"DUZ,DTIME,DT"
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
19,1916 *SPECIAL QUEUEING 1916;1 SET
'S' FOR STARTUP;
INPUT TRANSFORM: D IT1916^XUTMG19
LAST EDITED: JUL 14, 1994
HELP-PROMPT: SHOULD NOT BE ANSWERED UNLESS THIS IS A STARTUP (BOOT-TIME) ROUTINE!!
DESCRIPTION:
This field is OBSOLETE, Please use the new Option scheduling File.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 19^ASTARTUP^MUMPS
1)= Q
2)= Q
This cross-reference causes the updating of the option as a startup option to be started when the
system is started.
FILES POINTED TO FIELDS
BULLETIN (#3.6) SERVER BULLETIN (#220)
DEVICE (#3.5) SERVER DEVICE (#227)
PERMITTED DEVICE:PERMITTED DEVICE (#.01)
HELP FRAME (#9.2) HELP FRAME (#3.7)
MAIL GROUP (#3.8) SERVER MAIL GROUP (#222)
NEW PERSON (#200) CREATOR (#3.6)
OPTION (#19) MENU:ITEM (#.01)
QUEUING REQUIRED:TIME PERIOD (#.01)
PACKAGE (#9.4) PACKAGE (#12)
REMOTE PROCEDURE (#8994) RPC:RPC (#.01)
INPUT TEMPLATE(S):
XU-ZTMSCHEDULE FEB 18, 1988 USER #0
XUEDITOPT FEB 15, 2000@11:02 USER #0
PRINT TEMPLATE(S):
BPS TECH - OPTIONS FEB 05, 2001@07:36 USER #0 BPS OPTIONS
CAPTIONED USER #0
ONCOLOGY OPTION LIST MAY 28, 1992@18:49 USER #0 ONCOLOGY OPTION LIST
XQ-BACKGROUND RECOMMENDED APR 22, 1994@16:04 USER #0 Recommended Background Options
XUMENULIST JUL 01, 1984 USER #0 Menu list by display terms [MENULIST]
SORT TEMPLATE(S):
ONCOLOGY OPTION LIST MAY 28, 1992@18:50 USER #0 'ONCOLOGY OPTION LIST' Print Template always used
SORT BY: TYPE// (User is asked range)
WITHIN TYPE, SORT BY: NAME// From 'ONCO' To 'ONCOZ^ONCOZ'
XQ-BACKGROUND RECOMMENDED MAR 24, 1994@07:58 USER #0
SORT BY: SCHEDULING RECOMMENDED// (SCHEDULING RECOMMENDED not null)
XQTYPEERRORS FEB 04, 1994@09:31 USER #0
FORM(S)/BLOCK(S):
XQEDTOPT NOV 04, 1997@12:03 USER #0
MAIN DD #19
MAIN TITLE DD #19
Restrictions DD #19
Executable 1 DD #19
EXECUTABLES header DD #19
Menu Multiple DD #19.01
XQEDTOPT DISP1 DD #19
EDIT header DD #19
EDIT edit block DD #19
PRINT header DD #19
PRINT edit DD #19
PRINT2 header DD #19
PRINT2 edit DD #19
INQUIRE header DD #19
INQUIRE edit DD #19
ROUTINE header DD #19
ROUTINE edit DD #19
SERVER header DD #19
SERVER edit DD #19
SCREEN header DD #19
SCREEN edit DD #19
BROKER header DD #19
BROKER edit DD #19.05
WINDOW header DD #19
WINDOW edit DD #19
SUITE header DD #19
SUITE menu DD #19.01
DAYS/TIMES header DD #19
DAYS/TIMES edit DD #19.391
DEVICE header DD #19
DEVICES edit DD #19.396
QUEUING header DD #19
QUEUING edit DD #19.392
ACTION header DD #19
ACTION edit DD #19
PRINT3 edit 2 DD #19.02
PRINT3 header 1 DD #19
PRINT3 edit 1 DD #19.02
PRINT3 header 2 DD #19
PRINT3 header 3 DD #19
SELECTION edit DD #19
DIC Edit DD #19
DIC Header DD #19
choice DD #19
choice2 DD #19
BROKER OPTIONS DD #19
CONTEXT DD #19.01
The form XQEDTOPT is the screen-based Option Editor.