| # | Name | Location | Type | Details | Index | Description |
|---|---|---|---|---|---|---|
| .01 | name(+) | 0;1 | FREE TEXT | B | This is the name of the parameter. It should be namespaced according to the package from which the parameter originated. | |
| .02 | display text | 0;2 | FREE TEXT | This is the displayable name for the parameter (allows mixed case, non-namespaced names). | ||
| .03 | multiple valued | 0;3 | BOOLEAN | 1:Yes 0:No | 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'. | |
| .04 | instance term | 0;4 | FREE TEXT | 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. | ||
| .05 | value term | 0;5 | FREE TEXT | This contains text that is issued as a prompt for the value. If nothing is here, the prompt will be the word 'Value:'. | ||
| .06 | prohibit editing | 0;6 | BOOLEAN | 1:Yes 0:No | This field prevents the parameter value from being edited with Fileman or any Parameters tools. | |
| 1.1 | value data type | 1;1 | SET OF CODES | D:date/time F:free text N:numeric S:set of codes Y:yes/no P:pointer W:word processing M:M code C:constant | 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. | |
| 1.2 | value domain | 1;2 | FREE TEXT | 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. | ||
| 1.3 | value help | 1;3 | FREE TEXT | 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. | ||
| 2 | value validation code | 2;E1,245 | FREE TEXT | This field contains the M code that is placed in the third piece of DIR(0) when validating a value in the PARAMETERS file. | ||
| 3 | value screen code | 3;E1,245 | FREE TEXT | 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. | ||
| 4 | keyword | 4;0 | MULTIPLE | 8989.514 | ||
| 6.1 | instance data type | 6;1 | SET OF CODES | D:date/time F:free text N:numeric S:set of codes Y:yes/no P:pointer | 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. | |
| 6.2 | instance domain | 6;2 | FREE TEXT | 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. | ||
| 6.3 | instance help | 6;3 | FREE TEXT | 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. | ||
| 7 | instance validation code | 7;E1,245 | FREE TEXT | This field contains M code that is placed in the third piece of DIR(0) when validating the INSTANCE field in the PARAMETERS file. | ||
| 8 | instance screen code | 8;E1,245 | FREE TEXT | 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. | ||
| 20 | description | 20;0 | WORD-PROCESSING | A description of the parameter may be entered here. | ||
| 30 | allowable entities | 30;0 | MULTIPLE | 8989.513 | This multiple contains a list of entities (pointers to files) for which the parameter may be validly set. |