VA FileMan V. 22.2 Programmer Manual Banner

 

Contents: Main Chapter See Also: Getting Started Manual Advanced User Manual

Global File Structure

Attribute Dictionary: Other Field Definition Nodes

Every field must have a Zero node. All other nodes describing a field are presented in Table 116, but none are mandatory. Each subscript listed is at least the third level. The global reference appears in the following format:

    ^DD(File#,Field#,Subscript)

Table 116: Attribute Dictionary—Other Field Definition Nodes

Subscript Definition
22.2.007 VA FileMan uses several nodes to handle multiple languages for translations. The language # is the internal entry number to the LANGUAGE (#.85) file, where ENGLISH=1. The .007 node sets the translation: 
    ^DD(file, field, .007, language #, 0)=Set Translation
22.2.008 VA FileMan uses several nodes to handle multiple languages for translations. The language # is the internal entry number to the LANGUAGE (#.85) file, where ENGLISH=1. The .008 node sets the field label: 
    ^DD(file, field, .008, language #, 0)=Field Label
22.2.009 VA FileMan uses several nodes to handle multiple languages for translations. The language # is the internal entry number to the LANGUAGE (#.85) file, where ENGLISH=1. The .009 node sets the help prompt: 
    ^DD(file, field, .009, language #, 0)=Help-Prompt
.1 Contains the full-length title of the field.
1 Contains, at lower subscript levels, executable M code to SET and KILL cross-references based on the value of the field (in the variable X).
2 Contains the OUTPUT transform: M code to display the field value in a format that differs from the format in which it is stored.

REF: See the Advanced File Definition section.
3 Contains the help prompt message that is displayed when the user types a question mark.
4 Contains M code that is executed when the user types one or two question marks. (Other help messages are also displayed.)
5 Contains, at lower subscript levels, POINTERs to trigger cross-references to this field.
7.5 It is valid only on .01 fields. It contains M code that is executed to check the user input (in the variable X). This code is executed at the start of the ^DIC routine before the lookup on X has begun. If X is KILLed, the lookup terminates. Special lookup programs naturally have a way to look at X.
8 READ access for the field.
8.5 DELETE access for the field.
9 WRITE access for the field.
9.01 The fields used if the field is a COMPUTED field.
9.1 The expression entered by the user to create the COMPUTED field.
9.2 to 9.9 The overflow executable M code that can be part of the specification of a field definition, INPUT transform, or cross-reference.
10 Contains the source of the data.
11 Contains the destination of the data.
12 Contains the explanation of the screen on node 12.1.
12.1 Contains the code that sets DIC("S") if a screen has been written for a POINTER or a SET OF CODES.
20 A Multiple that lists the fields that belong to certain groups.
21 A WORD-PROCESSING field that holds the field description.
22 The name of a help frame presented to a user who entered two question marks.

NOTE: This subscript is being phased out.
23 A WORD-PROCESSING field that holds a technical description of the field.
AUDIT Contains a code defining the status of an audit trail for changes to the data in the field. Possible codes are:
  • y—Always audited
  • e—Changes and deletions only audited
  • n—No audit recorded
AX Contains the executable code that determines if a field should be audited.
DEL In this example, a string of executable M code that determines if the field can be deleted. This code must contain an M IF statement to set the value of $T. If $T is set to 1, the field cannot be deleted. Normally, the ^DD format is: 
    ^DD(File#,Field#,"DEL",#,0)="executable MUMPS code"
Where # is an arbitrary number to distinguish each condition. If the condition was based on a particular field, then the field number was traditionally used. If "DEL" nodes are on the .01 field of a file, deletion of the entire entry can be blocked.

If an entry is being deleted by a direct call to ^DIK, the "DEL" nodes are not checked.
DT Contains the date the field was last edited.
LAYGO A string of executable M code that determines if an entry can be added. This code must contain an M IF statement to set the value of $T. If $T is set to 0, the entry cannot be added. Normally, the ^DD format is: 
    ^DD(File#,.01,"LAYGO",#,0)="executable MUMPS code"
Where # is an arbitrary number to distinguish each condition. LAYGO nodes only apply to .01 fields.
V Descendent from these nodes is information regarding VARIABLE POINTERs including:
  • Pointed-to file
  • Message
  • Order
  • Prefix
  • Screen
  • LAYGO status
    ^DD(File#,Field#,"V",n,0)

Where "n" is a sequential number representing a different pointed-to file. The pieces within this 0 node are:

Table 117: Field Definition 0-Node—Pieces

^-Piece Contents
Piece 1 File number of the pointed-to file.
Piece 2 Message defined for the pointed-to file.
Piece 3 Order defined for the pointed-to file.
Piece 4 Prefix defined for the pointed-to file.
Piece 5 y/n indicating if a screen is set up for the pointed-to file.
Piece 6 y/n indicating if the user can add new entries to the pointed to file.
  • ^DD(File#,Field#,"V",n,1)

    Contains the M code defined as a screen on the POINTER to the file defined in the 0 node above.

  • ^DD(File#,Field#,"V",n,2)

    Contains a description of the screen.

 

Reviewed/Updated: May 2026