STANDARD DATA DICTIONARY #8989.51 -- PARAMETER DEFINITION FILE 3/24/25 PAGE 1
STORED IN ^XTV(8989.51, (1226 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 7.3)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file contains the characteristics of parameters. Entries in this file must be namespaced and they are exported by the package
which owns them.
DD ACCESS: @
RD ACCESS: @
WR ACCESS: @
DEL ACCESS: @
LAYGO ACCESS: @
AUDIT ACCESS: @
IDENTIFIED BY:
"WRITE": N X S X=^(0) D EN^DDIOL($P(X,U,2),"","?36")
POINTED TO BY: PARAMETER DEFINITION field (#.02) of the PARAMETERS sub-field (#8935.912) of the XHD PARAMETER CATEGORY File
(#8935.91)
PARAMETER field (#.02) of the PARAMETERS File (#8989.5)
USE INSTANCE FROM field (#.04) of the PARAMETER TEMPLATE File (#8989.52)
PARAMETER field (#.02) of the PARAMETERS sub-field (#8989.521) of the PARAMETER TEMPLATE File (#8989.52)
CROSS
REFERENCED BY: ENTITY FILE(AG), NAME(B), DISPLAY TEXT(C), KEYWORD(D)
8989.51,.01 NAME 0;1 FREE TEXT (Required)
INPUT TRANSFORM: D VALID01^XPARDD1
LAST EDITED: FEB 07, 1996
HELP-PROMPT: Answer must be 3-30 characters in length. Name must be unique.
DESCRIPTION: This is the name of the parameter. It should be namespaced according to the package from which the
parameter originated.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 8989.51^B
1)= S ^XTV(8989.51,"B",$E(X,1,30),DA)=""
2)= K ^XTV(8989.51,"B",$E(X,1,30),DA)
8989.51,.02 DISPLAY TEXT 0;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>40!($L(X)<1) X
LAST EDITED: APR 09, 1996
HELP-PROMPT: Answer must be 1-40 characters in length.
DESCRIPTION:
This is the displayable name for the parameter (allows mixed case, non-namespaced names).
CROSS-REFERENCE: 8989.51^C^MUMPS
1)= S ^XTV(8989.51,"C",$$UPPER^XPARDD1(X),DA)=""
2)= K ^XTV(8989.51,"C",$$UPPER^XPARDD1(X),DA)
Cross references display text for lookup. Display text is put in upper case so lookup will be case
insensitive.
8989.51,.03 MULTIPLE VALUED 0;3 SET
'1' FOR Yes;
'0' FOR No;
LAST EDITED: FEB 07, 1996
HELP-PROMPT: Enter 'Yes' if multiple instances of the parameter are allowed for any single entity.
DESCRIPTION: If this field is set to 'Yes', multiple instances of the parameter will be allowed for a single
entity. Otherwise, the value of the instance field for a given Entity-Parameter combination will
always be '1'.
8989.51,.04 INSTANCE TERM 0;4 FREE TEXT
INPUT TRANSFORM: K:$L(X)>40!($L(X)<1) X
LAST EDITED: FEB 07, 1996
HELP-PROMPT: Answer must be 1-40 characters in length.
DESCRIPTION: This is a free text term that can be used when prompting for a new instance of the parameter (in
the case where the parameter in multiple valued). If not entered, the word "Instance" will be
used.
8989.51,.05 VALUE TERM 0;5 FREE TEXT
INPUT TRANSFORM: K:$L(X)>40!($L(X)<1) X
LAST EDITED: JUN 12, 1996
HELP-PROMPT: Answer must be 1-40 characters in length.
DESCRIPTION: This contains text that is issued as a prompt for the value. If nothing is here, the prompt will
be the word 'Value:'.
8989.51,.06 PROHIBIT EDITING 0;6 SET
'1' FOR Yes;
'0' FOR No;
LAST EDITED: MAR 17, 1997
HELP-PROMPT: Choose 'Disallow Editing' if editing of this field should not be allowed.
DESCRIPTION:
This field prevents the parameter value from being edited with Fileman or any Parameters tools.
8989.51,1.1 VALUE DATA TYPE 1;1 SET
'D' FOR date/time;
'F' FOR free text;
'N' FOR numeric;
'S' FOR set of codes;
'Y' FOR yes/no;
'P' FOR pointer;
'W' FOR word processing;
'M' FOR M code;
'C' FOR constant;
LAST EDITED: MAY 28, 1996
HELP-PROMPT: Enter the type of data this parameter will contain.
DESCRIPTION: This is the type of data this parameter will contain. This field is used to define a call to the
reader (^DIR) in most cases.
8989.51,1.2 VALUE DOMAIN 1;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>100!($L(X)<1) X
LAST EDITED: FEB 07, 1996
HELP-PROMPT: Enter up to 100 characters to further define the data type (used by ^DIR).
DESCRIPTION: This is a string that may be used to further specify the data type. The string stored here should
be appropriate for the second ^-piece of DIR(0) when used with the data type field.
8989.51,1.3 VALUE HELP 1;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>80!($L(X)<1) X
LAST EDITED: FEB 07, 1996
HELP-PROMPT: Enter a line of help text to be displayed when entering a parameter value.
DESCRIPTION: This field contains a line of help text that is displayed when the user requests help or encounters
an error while entering the VALUE field in the PARAMETERS file.
8989.51,2 VALUE VALIDATION CODE 2;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: FEB 07, 1996
HELP-PROMPT: This is M code used by DIR (3rd piece of DIR(0)).
DESCRIPTION: This field contains the M code that is placed in the third piece of DIR(0) when validating a value
in the PARAMETERS file.
WRITE AUTHORITY: @
8989.51,3 VALUE SCREEN CODE 3;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: FEB 07, 1996
HELP-PROMPT: This is M code placed in DIR("S").
DESCRIPTION: This field contains M code that is used to screen allowable entries for the VALUE field in the
PARAMETERS file. The code is placed in DIR("S") when validating the entry.
WRITE AUTHORITY: @
8989.51,4 KEYWORD 4;0 Multiple #8989.514
8989.514,.01 KEYWORD 0;1 FREE TEXT (Multiply asked)
INPUT TRANSFORM:K:$L(X)>30!($L(X)<3) X I $D(^XTV(8989.51,"D",X)) D EN^DDIOL($C(7)_" "_$$EZBLD^DIALOG(89895140),"",
"?0")
LAST EDITED: OCT 10, 2002
HELP-PROMPT: Answer must be 3-30 characters in length
DESCRIPTION: This field provides a list of KEYWORDS that can be used for lookup of Parameter definitions. It is
suggested that each entry only have one word.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE:8989.514^B
1)= S ^XTV(8989.51,DA(1),4,"B",$E(X,1,30),DA)=""
2)= K ^XTV(8989.51,DA(1),4,"B",$E(X,1,30),DA)
CROSS-REFERENCE:8989.51^D
1)= S ^XTV(8989.51,"D",$E(X,1,30),DA(1),DA)=""
2)= K ^XTV(8989.51,"D",$E(X,1,30),DA(1),DA)
3)= KeyWord Lookup
This cross reference allows the use of the keyword for look up of parameters.
8989.51,6.1 INSTANCE DATA TYPE 6;1 SET
'D' FOR date/time;
'F' FOR free text;
'N' FOR numeric;
'S' FOR set of codes;
'Y' FOR yes/no;
'P' FOR pointer;
LAST EDITED: FEB 07, 1996
HELP-PROMPT: Enter the type of data allowed for the INSTANCE field of the parameter.
DESCRIPTION: This is the type of data that is contained in the INSTANCE field of the PARAMETERS file, if
multiple parameter instances per entity are allowed. This field is used to define a call to the
reader.
8989.51,6.2 INSTANCE DOMAIN 6;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>100!($L(X)<1) X
LAST EDITED: FEB 07, 1996
HELP-PROMPT: Enter up to 100 characters to further define the data type (used by ^DIR).
DESCRIPTION: This may be used to further define the data type for the INSTANCE field of the parameter. The
string stored here should be appropriate for the second ^-piece of DIR(0) when used with the data
type field.
8989.51,6.3 INSTANCE HELP 6;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>80!($L(X)<1) X
LAST EDITED: FEB 07, 1996
HELP-PROMPT: Enter a line of help text to be displayed when entering the parameter instance.
DESCRIPTION: This field contains a line of help text that is displayed when the user requests help or encounters
an error while entering the INSTANCE field of the PARAMETERS file.
8989.51,7 INSTANCE VALIDATION CODE 7;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: FEB 07, 1996
HELP-PROMPT: This is M code used by DIR (3rd piece of DIR(0)).
DESCRIPTION: This field contains M code that is placed in the third piece of DIR(0) when validating the INSTANCE
field in the PARAMETERS file.
WRITE AUTHORITY: @
8989.51,8 INSTANCE SCREEN CODE 8;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: FEB 07, 1996
HELP-PROMPT: This is M code placed in DIR("S").
DESCRIPTION: This field contains M code that is used to screen allowable entries for the INSTANCE field in the
PARAMETERS file. The code is placed in DIR("S") when validating the entry.
WRITE AUTHORITY: @
8989.51,20 DESCRIPTION 20;0 WORD-PROCESSING #8989.512 (NOWRAP)
DESCRIPTION:
A description of the parameter may be entered here.
LAST EDITED: FEB 07, 1996
HELP-PROMPT: Enter a description of the parameter and how it is used.
DESCRIPTION:
This is text that describes the purpose and use of the parameter.
8989.51,30 ALLOWABLE ENTITIES 30;0 Multiple #8989.513
DESCRIPTION: This multiple contains a list of entities (pointers to files) for which the parameter may be
validly set.
IDENTIFIED BY: ENTITY FILE(#.02)[R]
8989.513,.01 PRECEDENCE 0;1 NUMBER (Required) (Multiply asked)
INPUT TRANSFORM: K:+X'=X!(X>999.99)!(X<0)!(X?.E1"."3N.N) X
LAST EDITED: FEB 13, 1996
HELP-PROMPT: Type a Number between 0 and 999.99, 2 Decimal Digits
DESCRIPTION: A single parameter may be set for several different types of entities. This lists the order in
which entities are searched for a defined value. For example, if a parameter may be set for a
package, a location, and a user, and the respective precedents are 3, 2, 1, the value of the user
parameter would be returned. If it did not exist, the value of the location parameter. If that
did not exist, then the value of the package parameter.
CROSS-REFERENCE: 8989.513^B
1)= S ^XTV(8989.51,DA(1),30,"B",$E(X,1,30),DA)=""
2)= K ^XTV(8989.51,DA(1),30,"B",$E(X,1,30),DA)
8989.513,.02 ENTITY FILE 0;2 POINTER TO PARAMETER ENTITY FILE (#8989.518) (Required)
LAST EDITED: JUN 21, 1997
HELP-PROMPT: Choose a file from which entities for this parameter are identified.
DESCRIPTION: This identifies an entity for which the parameter can be legally entered. Entities are simply
variable pointers. The files which are eligible to be entities are listed in the PARAMETER
ENTITY file.
CROSS-REFERENCE: 8989.51^AG^MUMPS
1)= D AGS^XPARDD1
2)= D AGK^XPARDD1
The AG x-ref has the format ^XTV(8989.51,PARAM,30,"AG",GLOBAL REF,DA)="".
It is used to screen the parameters that may be selected for a given entity in the PARAMETERS
file. The global root is used because the entity is a variable pointer.
FILES POINTED TO FIELDS
PARAMETER ENTITY (#8989.518) ALLOWABLE ENTITIES:ENTITY FILE (#.02)
INPUT TEMPLATE(S):
XPAR MULTI VALUED CREATE FEB 12, 1996@14:18 USER #0
XPAR SINGLE VALUED CREATE NOV 18, 1997@14:53 USER #0
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):