STANDARD DATA DICTIONARY #409.61 -- LIST TEMPLATE FILE 3/24/25 PAGE 1
STORED IN ^SD(409.61, (754 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 1)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file contains entries defining list attributes that are used by the Scheduling List Manager utility. The application developer
adds entries in this file for each list of items to be displayed using the List Manager.
DD ACCESS: @
RD ACCESS: d
WR ACCESS: @
DEL ACCESS: @
LAYGO ACCESS: @
CROSS
REFERENCED BY: NAME(B)
409.61,.01 NAME 0;1 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>30!(X?.N)!($L(X)<3)!'(X'?1P.E) X I $D(X),$D(^SD(409.61,"B",X)) K X W !,"Template name alrea
dy exists."
LAST EDITED: FEB 24, 1992
HELP-PROMPT: NAME MUST BE 3-30 CHARACTERS, NOT NUMERIC OR STARTING WITH PUNCTUATION
DESCRIPTION: This field contains the name of the list.
The list name should be namespaced and unique.
TECHNICAL DESCR: The "B" cross reference of this field is used by the List Manager when it is called by the
application. For example, the application would call the List Manager as follows:
D EN^VALM("SDAM APPOINTMENT MANAGEMENT")
The value passed in the actual list is used to find the LIST TEMPLATE entry.
SOURCE OF DATA: APPLICATION DEVELOPER
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 409.61^B
1)= S ^SD(409.61,"B",$E(X,1,30),DA)=""
2)= K ^SD(409.61,"B",$E(X,1,30),DA)
409.61,.02 TYPE OF LIST 0;2 SET
'1' FOR PROTOCOL;
'2' FOR DISPLAY;
'3' FOR SELECT (NOT AVAILABLE);
LAST EDITED: JAN 31, 1992
DESCRIPTION: This field indicates the type of list.
A 'protocol' list will cause the List Manager to
use the PROTOCOL entered in the 'PROTOCOL MENU'
field.
A 'display' list will use the standard VALM DISPLAY protocol
supplied by the List Manager. This protocol allows
user to view or scroll though the list. The user
will be able to use the standard 'next screen',
'previous screen',etc. actions.
A 'select' list is similar to the 'display' list but
will also allow the user to 'select' entries. The
application will then use the selected entries in its
processing This type of list is not currently available.
SOURCE OF DATA: APPLICATION DEVELOPER
409.61,.03 LEFT MARGIN 0;3 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>132)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: NOV 25, 1991
HELP-PROMPT: Enter a column number from 1 to 132.
DESCRIPTION: This field contains the left column of the scrolling region where the list will be displayed.
Currently(11/91), this parameter is not used.
TECHNICAL DESCR:
This attribute is not currently used by the List Manager utility.
SOURCE OF DATA: APPLICATION DEVELOPER
409.61,.04 RIGHT MARGIN 0;4 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>240)!(X<80)!(X?.E1"."1N.N) X
LAST EDITED: NOV 18, 1992
HELP-PROMPT: Type a Number between 80 and 240, 0 Decimal Digits
DESCRIPTION:
This field indicates the maximum number of characters a row can contain.
TECHNICAL DESCR:
This attribute is not currently used by the List Manager utility.
SOURCE OF DATA: APPLICATION DEVELOPER
409.61,.05 TOP MARGIN 0;5 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>99)!(X<2)!(X?.E1"."1N.N) X
LAST EDITED: MAR 09, 1992
HELP-PROMPT: Type a Number between 2 and 99, 0 Decimal Digits
DESCRIPTION: This field contains the number of the top row of the scrolling region where the list will be
displayed.
TECHNICAL DESCR: The List Manager will store this field's data in the following local variable:
VALM("TM")
SOURCE OF DATA: APPLICATION DEVELOPER
409.61,.06 BOTTOM MARGIN 0;6 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>99)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: NOV 25, 1991
HELP-PROMPT: Enter a row number from 1 to 99.
DESCRIPTION: This field contains the number of the bottom row of the scrolling region where the list will be
displayed.
TECHNICAL DESCR: The List Manager will store this field's data in the following local variable:
VALM("BM")
SOURCE OF DATA: APPLICATION DEVELOPER
409.61,.07 OK TO TRANSPORT? 0;7 SET
'0' FOR NOT OK;
'1' FOR OK;
LAST EDITED: FEB 25, 1992
DESCRIPTION:
This field indicates to the transport utility if this list template should be distributed.
409.61,.08 USE CURSOR CONTROL 0;8 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: OCT 17, 1991
DESCRIPTION: This field indicates whether the cursor positioning and character enhancements capabilities of the
device should be used.
If set to 'NO', then lists will be presented in scrolling mode. For some actions, like 'up one
entry', this would increase use of system resources.
If set to 'YES', then list will be presented using the terminal type's capabilities.
However, if the user signs on to a device that is not adequately defined in the TERMINAL TYPE file,
then the list will automatically display in scrolling mode.
TECHNICAL DESCR: The List Manager will store this field's data in the following local variable:
VALMCC
The terminal type attributes that must be defined for a 'yes' indication to take affect are the
following:
o INSERT LINE
o SET TOP & BOTTOM MARGINS
o SAVE CURSOR
o RESTORE CURSOR
o ERASE TO END OF PAGE
o HIGH INTENSITY (BOLD)
o NORMAL INTENSITY (RESET)
o UNDERLINE ON
o UNDERLINE OFF
o REVERSE VIDEO ON
o REVERSE VIDEO OFF
If any of these attributes are not defined then the List Manager will automatically enter into
scrolling mode.
SOURCE OF DATA: APPLICATION DEVELOPER OR SITE IRM STAFF
409.61,.09 ENTITY NAME 0;9 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<1) X
LAST EDITED: NOV 05, 1991
HELP-PROMPT: Answer must be 1-30 characters in length.
DESCRIPTION: This field contains the term that will be displayed to the user that best describes the items in
the list. The term will be used if the developer wishes to use the generic 'select' action. For
example, "Select Appointment(s):" could be displayed and the entity is 'Appointment'.
The term will be used in other displays as well.
TECHNICAL DESCR: The List Manager will store this field's data in the following local variable:
VALM("ENTITY")
SOURCE OF DATA: APPLICATION DEVELOPER
409.61,.1 PROTOCOL MENU 0;10 FREE TEXT
INPUT TRANSFORM: K:$L(X)>63!($L(X)<3) X I $D(X) S DIC(0)="EQM",DIC="^ORD(101," D ^DIC K DIC K:Y<0 X I $D(X) S X=$P(Y
,U,2)
LAST EDITED: DEC 05, 1992
DESCRIPTION: This field contains the name of the PROTOCOL that will be used by the List Manager if the the TYPE
OF LIST is 'protocol'.
This field is not used for 'display' or 'select' types.
TECHNICAL DESCR:
Note: This protocol is stored as a free-text pointer value.
SOURCE OF DATA: APPLICATION DEVELOPER
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
409.61,.11 SCREEN TITLE 0;11 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<2) X
LAST EDITED: JAN 13, 1992
HELP-PROMPT: Answer must be 2-30 characters in length.
DESCRIPTION: This field contains the text that will be display/printed in the upper left corner of the screen
display.
TECHNICAL DESCR: The List Manager will store this field's data in the following local variable:
VALM("TITLE")
409.61,.12 ALLOWABLE NUMBER OF ACTIONS 0;12 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>4)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: MAY 29, 1992
HELP-PROMPT: Type a Number between 1 and 4, 0 Decimal Digits
DESCRIPTION: This field indicates the number of actions a user can select at one time.
For example, if this parameter is set to 1 then the user can only enter one action...
Select Action: NX
...and the following would not be allowed:
Select Action: NX,EP
If this parameter is not entered then the system defaults to 1.
TECHNICAL DESCR: This field could be very important to an application. If an action causes a change in the list's
entries then following actions could be affected. The user may think that an entry number
corresponds to a certain entry, when in fact the list and the numbering may have been changed.
Setting the parameter to 1 is the safest and is the default if the field is blank.
409.61,.13 DATE RANGE LIMIT 0;13 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: NOV 01, 1991
HELP-PROMPT: Select the number between 1 and 999.
DESCRIPTION: This field contains the maximum number of days that can be specified by the user while entering a
date range.
This parameter is only used if the application calls the List Manager's date range selection
utility.
TECHNICAL DESCR: The List Manager will store this field's data in the following global variable:
^TMP("VALM DATA",$J,VALMEVL,"DAYS")
SOURCE OF DATA: APPLICATION DEVELOPER
409.61,.14 AUTOMATIC DEFAULTS 0;14 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: MAR 31, 1993
DESCRIPTION: This field indicates whether List Manager should always supply a default action at the 'Select'
prompt for 'Protocol' type List Templates.
If set to 'NO', a default will not be provided automatically. It will be the developer's
responsibility to indicate a default, if desired. This default can be indicated by setting
XQORM("B") as part of the protocol menu's HEADER code. (i.e. D SHOW^VALM S XQORM("B")="Your
action")
This parameter only is valid for 'Protocol' type List Templates.
If the parameter is set to 'YES' or is blank, a default will be provided by List Manager. If the
current screen contains the last line in the list, then the default will be 'Quit'. Otherwise, it
will be "Next Screen". However, as discussed above, the developer can override this default by
setting XQORM("B").
409.61,1.01 PRINT LIST PROTOCOL 1;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>63!($L(X)<3) X I $D(X) S DIC(0)="EQM",DIC="^ORD(101," D ^DIC K DIC K:Y<0 X I $D(X) S X=$P(Y
,U,2)
LAST EDITED: DEC 05, 1992
HELP-PROMPT: Answer must be 3-63 characters in length.
DESCRIPTION: This field contains the name of the protocol that will be called when the user selects the generic
'Print List' action.
Normally, this field is blank and the generic printing action is sufficient.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
409.61,1.02 HIDDEN ACTION MENU 1;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>63!($L(X)<3) X I $D(X) S DIC(0)="EQM",DIC="^ORD(101," D ^DIC K DIC K:Y<0 X I $D(X) S X=$P(Y
,U,2)
LAST EDITED: DEC 05, 1992
HELP-PROMPT: Answer must be 3-63 characters in length.
DESCRIPTION: This field contains the name of the protocol menu that will be used by the List Manager for the
'hidden' actions available to the user.
Normally, the application enters the 'VALM HIDDEN ACTIONS' menu in this field. However, there maybe
applications that would require a different set of 'hidden' actions.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
409.61,100 HEADER CODE HDR;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: OCT 15, 1991
HELP-PROMPT: This is Standard MUMPS code.
DESCRIPTION: This MUMPS field contains the code that the List Manager will execute to print the application
specific screen header.
TECHNICAL DESCR: The List Manager will store this field's data in the following local variable:
VALM("HDR")
WRITE AUTHORITY: @
SOURCE OF DATA: APPLICATION DEVELOPER
409.61,102 EXPAND CODE EXP;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: OCT 16, 1991
HELP-PROMPT: This is Standard MUMPS code.
DESCRIPTION: This field contains the MUMPS code that displays a detail inquiry-type report/screen for a specific
entry in the list.
TECHNICAL DESCR: The List Manager will store this field's data in the following global variable:
^TMP("VALM DATA",$J,VALMEVL,"EXP")
WRITE AUTHORITY: @
SOURCE OF DATA: APPLICATION DEVELOPER
409.61,103 HELP CODE HLP;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: OCT 16, 1991
HELP-PROMPT: This is Standard MUMPS code.
DESCRIPTION: This field contains the MUMPS code for the help that will appear when the user types '?' at the
'Select Action:' prompt.
This field is optional. If not defined, the normal help given by the XQOR* driver will take
affect.
TECHNICAL DESCR: The List Manager will store this field's data in the following global variable:
^TMP("VALM DATA",$J,VALMEVL,"HLP")
WRITE AUTHORITY: @
SOURCE OF DATA: APPLICATION DEVELOPER
409.61,105 EXIT CODE FNL;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: NOV 25, 1991
HELP-PROMPT: This is Standard MUMPS code.
DESCRIPTION: This field contains MUMPS logic that will be executed by the List Manager when the user exits the
list.
The code is usually used to clean up the partiton and kill any temporary globals used during the
List Manager call.
After this code is executed, the List Manager will clean up the variables and temporary globals it
set.
This field is optional.
TECHNICAL DESCR: The List Manager will store this field's data in the following global variable:
^TMP("VALM DATA",$J,VALMEVL,"FNL")
WRITE AUTHORITY: @
SOURCE OF DATA: APPLICATION DEVELOPER
409.61,106 ENTRY CODE INIT;E1,245 MUMPS
INITIALIZATION CODE
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: NOV 25, 1991
HELP-PROMPT: This is Standard MUMPS code.
DESCRIPTION: This field contains MUMPS code that is executed when then List Manager is called.
This code is usually used by the application to initialize variables.
This field is optional.
TECHNICAL DESCR: The List Manager will store this field's data in the following global variable:
^TMP("VALM DATA",$J,VALMEVL,"INIT")
SOURCE OF DATA: APPLICATION DEVELOPER
409.61,107 ARRAY NAME ARRAY;E1,50 FREE TEXT
INPUT TRANSFORM: K:$L(X)>50!($L(X)<1)!'(X?1" ".E) X
LAST EDITED: NOV 25, 1991
HELP-PROMPT: Enter the name of the array that will contain the list of items for display.
DESCRIPTION: This field contains the name of the array that holds the list of items to be displayed.
The array name must be preceded by a space character. This is needed to allow global
specifications. (File Manager will not allow '^' as the first character.)
The array can be either a local or global variable.
TECHNICAL DESCR: The List Manager will store is field's data in the following local variable:
VALMAR
SOURCE OF DATA: APPLICATION DEVELOPER
409.61,200 CAPTION LINE COLUMNS COL;0 Multiple #409.621
LAST EDITED: NOV 25, 1991
DESCRIPTION: This multiple field contains column definitions for the data displayed in the list. Adding entries
to this multiple is optional.
The column parameters are used when the List Manager writes the line indicating the top of the
list's scrolling region.
If no entries are added then only a line is written with no captions.
The parameters are also used by special function calls that an application is allowed to used. For
example, there is a function at FLDUPD^VALM1 that can be used to update the screen. The function
will change the value of a column for a particular entry.
[$$FLDUPD^VALM1(,,)]
TECHNICAL DESCR: The List Manager will store is field's data in the following local variable:
VALMDDF()= col name ^ col position ^ col width ^ caption
SOURCE OF DATA: APPLICATION DEVELOPERS
409.621,.01 ITEM NAME 0;1 FREE TEXT (Multiply asked)
INPUT TRANSFORM: K:$L(X)>20!($L(X)<1) X
LAST EDITED: MAR 02, 1992
HELP-PROMPT: Answer must be 1-20 characters in length.
DESCRIPTION: This field contains the reference name of the column. The DISPLAY TEXT field contains the text
that will be used when the caption line is written.
The text in this field is used when the application refers to this column during programming.
For example, the reference in function call $$FLDUPD^VALM1(,,
) would contain this text.
SOURCE OF DATA: APPLICATION DEVELOPER
CROSS-REFERENCE: 409.621^B
1)= S ^SD(409.61,DA(1),"COL","B",$E(X,1,30),DA)=""
2)= K ^SD(409.61,DA(1),"COL","B",$E(X,1,30),DA)
409.621,.02 COLUMN 0;2 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>240)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: NOV 18, 1992
HELP-PROMPT: Type a Number between 1 and 240, 0 Decimal Digits
DESCRIPTION:
The field contains the column number where the data/caption starts.
SOURCE OF DATA: APPLICATION DEVELOPER
409.621,.03 WIDTH 0;3 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>80)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: MAR 10, 1993
HELP-PROMPT: Type a Number between 1 and 80, 0 Decimal Digits
DESCRIPTION:
This field contains the number of characters this field will use.
SOURCE OF DATA: APPLICATION DEVELOPER
409.621,.04 DISPLAY TEXT 0;4 FREE TEXT
INPUT TRANSFORM: K:$L(X)>80!($L(X)<1) X
LAST EDITED: MAR 02, 1992
HELP-PROMPT: Enter the text for the caption line. (1-80 characters)
DESCRIPTION: This field contains the text that will appear on the caption line for this column/field.
If the text is longer than the WIDTH parameter, it will be truncated to the WIDTH specification
when written as part of the caption line.
This field is optional and can be left blank.
SOURCE OF DATA: APPLICATION DEVELOPER
409.621,.05 DEFAULT VIDEO ATTRIBUTES 0;5 FREE TEXT
INPUT TRANSFORM: K:$L(X)>4!($L(X)<1) X I $D(X) N I F I=1:1:$L(X) I "HRUB"'[$E(X,I) K X Q
LAST EDITED: JAN 21, 1993
HELP-PROMPT: Indicate the video attributes that are the defaults for this field.
DESCRIPTION: This parameter allows the developer to indicate the default video attributes that should be
applied when program calls are made to the FLDCTRL^VALM10 video control utility.
The following is the list of attributes and abbreviations used for this parameter:
H - for highlight
R - for reverse video
U - for underline
B - for blinking
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
409.621,.06 SCROLL LOCK 0;6 SET
'0' FOR NO;
'1' FOR YES;
INPUT TRANSFORM: I $D(X),$O(^SD(409.61,DA(1),"COL","AIDENT",1,0)),$O(^(0))'=DA K X
LAST EDITED: NOV 29, 1992
DESCRIPTION: If you want to lock one for more columns into place as the user scrolls horizontally through the
list, you can place a 'scroll lock' on the right most column field that should be locked. Only
one column can have this 'scroll lock' parameter set to 'yes'. If you attempt to set more than
one, the system will not allow it and will issue a warning.
If this parameter is set to 'YES', this caption field and any other caption field, with a COLUMN
parameter set to less than this current caption field's, will always be displayed by the List
Manager.
This parameter does not need to be filled in for List Templates with a RIGHT MARGIN of 80. For
those templates with a RIGHT MARGIN of over 80, this field also does not need to be entered.
However, the use of this field allows the developer to indicate the list's identification fields
for user readability.
TECHNICAL DESCR:
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 409.621^AIDENT
1)= S ^SD(409.61,DA(1),"COL","AIDENT",$E(X,1,30),DA)=""
2)= K ^SD(409.61,DA(1),"COL","AIDENT",$E(X,1,30),DA)
INPUT TEMPLATE(S):
VALM ADD/EDIT LIST TEMPLATE NOV 22, 1992@21:24 USER #0
VALM CAPTION EDIT DEC 14, 1992@10:47 USER #0
VALM DEMOGRAPHICS EDIT DEC 14, 1992@10:44 USER #0
VALM LIST REGION EDIT DEC 14, 1992@11:38 USER #0
VALM MUMPS CODE EDIT JAN 07, 1993@09:32 USER #0
VALM NEW ENTRY DEFAULTS APR 01, 1993@08:23 USER #0
VALM OTHER FIELDS MAR 31, 1993@21:12 USER #0
VALM PROTOCOL INFORMATION DEC 14, 1992@10:45 USER #0
PRINT TEMPLATE(S):
VALM LIST TEMPLATE NOV 19, 1992@12:21 USER #0 ^VALMXP @
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):