VA FileMan V. 22.2 Programmer Manual Banner


 

Main Getting Started Manual Advanced User Manual

Glossary


.001 Field
A field containing the internal entry number of the record.
.01 Field
The one field that must be present for every file and file entry. It is also called the NAME field. At a file's creation the .01 field is given the label NAME. This label can be changed.
Access Codes
In VA FileMan, an Access Code is a string of codes that determines your security access to files, fields, and templates. In Kernel, you enter an Access Code to identify yourself during signon.
Alternate Editor
One of the text editors that is available for use from VA FileMan. Editors available vary from site to site. They are entries in the ALTERNATE EDITOR (#1.2) file.
At-sign (@)
A VA FileMan Security Access Code that gives the user Programmer-level access to files and to VA FileMan's developer features. Also, the at-sign character (@) is used at VA FileMan field prompts to delete data.

REF: See "Programmer Access."

Attribute Dictionary
REF: See "Data Dictionary."
Audit
A VA FileMan feature that provides an ongoing chronological listing of who made what changes to data values.
Audit Trail
The record or log of an ongoing audit.
Auditing
The monitoring and recording of computer use.
Backward Pointer
A POINTER to your current file from another file; used in the extended POINTER syntax.
Boolean Expression
A logical comparison between values yielding a true or false result. In M:
Canonic Number
A number with no leading Zeroes and no trailing Zeroes after a decimal point.
Canonic Template
A Template of any of the three types that has been chosen as the "default", "most often used" Template for a particular File.
Caption
In ScreenMan, a label displayed on the screen. Captions often identify fields that are to be edited.
CARET (^)
The caret character (^), also sometimes referred to in VistA legacy documentation as the "Up-Arrow" key, is used in VA FileMan for exiting an option or canceling a response. Also, it is used in combination with a field name or prompt to jump to the specified field or prompt.
Command Area
In ScreenMan, the bottom portion of the screen that is used to display help information and to accept user commands.
Compound Index
An index that has more than one data-valued subscript.

REF: See "Index."

Compound Key
A key that is composed of more than one field. Keys are stored in the KEY (#.31) file.

REF: See "Key" and "Simple Key."

Computed Field
The definition of an algorithm pertaining to a certain Entry in a certain File, combining values from other Fields in that Entry. The algorithm is stored in the Data Dictionary. Its value is not stored, but recalculated whenever used.
Cross-Reference
An attribute of a field or a file that identifies an action that should take place when the value of a field is changed. Often, the action is the placement of the field's value into an index:
Cursor
On your display terminal, the line or rectangle identifying where your next input is placed on the screen.
Database
An organized collection of data spanning many files. Often, all the files on a system constitute that system's database.
Database Management System
A collection of software that handles the storage, retrieval and updating of records in a database.
Data Dictionary
This is a file that defines a file's structure, its elements (fields and their attributes), and relationships to other files. This is sometimes called schema. Often abbreviated as DD.
Data Dictionary Listing
The printable report that shows the data dictionary.
DATA TYPE
The kind of data stored in a field. For example:
Default
A computer-provided response to a question or prompt. The default might be a value pre-existing in a file. Often, you can change a default.
Delimiter
A special character that is used to separate a field, record, or string. VA FileMan usually uses the ^ character as the delimiter within strings.
Device Prompt
A Kernel prompt at which you identify where to send your output.
DIC
VA FileMan routine that searches a file and finds an entry, adds an entry, or returns a condition indicating that the lookup was unsuccessful.
DIE
VA FileMan routine that edits data elements for a given file entry.
DIFROM
(Obsolete) VA FileMan routines that transfer software packages from one VA FileMan environment to another. DIFROM is used to install new packages as well as update versions of current packages. DIFROM can also be used as a simple archiving tool.
DIK
VA FileMan routine that re-indexes or deletes file entries.
DIP
VA FileMan routine that prints data.
DIQ
VA FileMan routine that displays a range of data elements.
DIR
VA FileMan's general purpose reader routine that can be used to issue a prompt, interactively read input, do syntax checking on input, issue error messages or help text, and return input in a processed form.
DIWF
VA FileMan routine that uses the contents of a WORD-PROCESSING field as a target into which data is inserted at print time. The data can come from another file or can be provided by the user interactively at the time of print.
DIWP
VA FileMan routine that formats and (optionally) outputs any group of text lines.
Edit Window
In ScreenMan, the area in which you enter or edit data. It is highlighted with either reverse video or an underline. In Screen Editor, the area in which you enter and edit text; the area between the status bar and the ruler.
Entry
A record in a file. "Entry" and "Record" are used interchangeably.
Extended Pointers
A means to reference fields in files other than your current file.
FDA
FileMan Data Array.
Field
In an entry, a specified area used to hold values. The specifications of each VA FileMan field are documented in the file's data dictionary.
Field Number
The unique number used to identify a field in a file. A field can be referenced by # followed by the field number.
File
A set of related records (or entries) treated as a unit.
Form
In ScreenMan, a group of one or more pages that comprise a complete transaction. Comparable to an INPUT template.
FREE TEXT
A DATA TYPE field value that can contain any printable characters.
Full-screen Editing
The ability to enter data in various locations on the two-dimensional computer display. Compare to scrolling mode.
Global Variable
A variable that is stored on disk.
Histogram
A type of bar graph that indicates frequency of occurrence of values.
Hook
A documented data dictionary attribute, input variable, or parameter in which an application developer can place M code that is executed during a VA FileMan call. Also called a "Programmer Hook."
Identifier
In VA FileMan, a field that is defined to aid in identifying an entry in conjunction with the NAME (#.01) field.
Index
An ordered list used to speed retrieval of entries from a file based on a value in some field or fields:

Indexes are created and maintained via cross-references.

REF: See also "Uniqueness Index."

Initialization
The process of setting variables in a program to their starting value.
INPUT Template
A pre-defined list of fields that together comprise an editing session.
INPUT Transform
An executable string of M code which is used to check the validity of input and to convert it into an internal form for storage.
Internal Entry Number (IEN)
The number used to identify an entry within a file. Every record has a unique internal entry number. Often abbreviated as IEN.
Kernel
A VistA software package that functions as an intermediary between the host operating system and VistA application packages. Kernel includes installation, menu, security, and device services.
Key
A group of fields that, taken collectively, uniquely identifies a record in a file or subfile (Multiple). All fields in a key must have values:

Keys are stored in the KEY (#.31) file.

REF: See also "Primary Key" and "Secondary Key."

Key Integrity
When a KEY is defined for a file, VA FileMan enforces key integrity. All fields in a key must have values (must not be NULL) and those values, taken together, must be unique across all records in the file; that is, no two records in the file can have the same key. VA FileMan enforces key integrity whenever records are added or edited.
LAYGO
A user's authorization to create a new entry when editing a computer file. An acronym for Learn As You Go.
Line Editor
The VA FileMan editor that lets you input and change text on a line-by-line basis. The Line Editor works in scrolling mode.

REF: See Screen Editor.

Local Variable
A variable that is stored in a local partition.
Lookup
To find an entry in a file using a value for one of its fields.
MailMan
An electronic mail system (email) that allows you to send messages to and receive them from other users via the computer. It is part of VistA.
Menu
A list that includes the names of options from which you can select an activity.
Multiple
A VA FileMan DATA TYPE field value that allows more than one value for a single entry. See Subfile.
MUMPS
Abbreviated as M. The American National Standards Institute (ANSI) computer language used by VA FileMan and throughout VistA. The acronym MUMPS stands for Massachusetts General Hospital Utility Multi Programming System.
NAME Field
The one field that must be present for every file and file entry. It is also called the .01 field. At a file's creation the .01 field is given the label NAME. This label can be changed.
Navigation
  1. Navigation can mean switching your reference point from one file to another.
  2. Navigation can also mean moving your cursor around a terminal display or a document using cursor keys and other commands.
New-Style Cross-Reference
A cross-reference that is stored in the INDEX (#.11) file. New-Style cross-references can be more complex than traditional cross-references. They can create an index with:

They can be defined so that subscripts are displayed in inverse collation sequence during question-mark help or when using a Lister call (LIST^DIC). Firing of SET and KILL logic for the index can happen at the record level, rather than each time individual fields that make up the index are edited.

REF: See "Cross-Reference."

Non-Canonic Number
A number with either leading Zeroes, or trailing Zeroes after a decimal point. M treats non-canonic numbers as text instead of as numbers.
Non-NULL
A value other than NULL. A space and Zero are non-NULL values.
NULL
Empty. A field or variable that has no value associated with it is NULL.
NULL Response
When replying to a prompt, pressing only the Enter key, abbreviated as <Enter>, to enter nothing.
Numeric Expression
An expression whose value is a number. Compare to string expression.
Operator
One of the processes that is done to the elements in an expression to create a value.
Option
A computing activity that you can select, usually a choice from a menu.
OUTPUT Transform
An executable string of M code that converts internally stored data into a readable display.
Paste
Insert text or other data as input into one computer program that has been copied into a clipboard by the same or by another computer program.
Pattern Match
In M, an operator that compares the contents of a variable or literal to a specified pattern of characters or kinds of characters.
PF Keys
Keys on a terminal keyboard labeled PF1, PF2, etc. that are used to perform special functions instead of displaying visible characters.
POINTER TO A FILE
A DATA TYPE field value that contains an explicit reference to an entry in a file. POINTER TO A FILE-type fields are used to relate files to each other.
Popup Page
In ScreenMan, a page that overlays the regular ScreenMan screen to present the contents of a selected Multiple.
Preferred Editor
The editor always entered when you access a WORD-PROCESSING-type field, your default editor. Kernel must be present to establish a Preferred Editor.
Primary Key
The key chosen by the database designer to be VA FileMan's principal means of identifying records in the file. VA FileMan automatically displays the Primary Key during classic interactive lookup (^DIC) and uses the Primary Key to identify records brought in during a KIDS installation. Exactly one Key in a file or subfile must be designated the Primary Key.

REF: See "Key."

PRINT Template
The stored specifications of a printed report, including fields to be printed and formatting instructions.
Programmer Access
The ability to use VA FileMan features that are reserved for application developers. Referred to as "having the at-sign (@)", because the at-sign is the DUZ(0) value that grants Programmer access.
Programmer Hook
A documented data dictionary attribute, input variable, or parameter in which an application developer can place M code that is executed during a VA FileMan call. Also called "Hook."
Prompt
A question or message from the computer that requires a user's response.
Record
A set of data pertaining to a single entity in a file; an entry in a file.
Record Number
REF: See Internal Entry Number (IEN).
Relational Navigation
Changing your current (or primary) file reference to another file. Relational navigation is accomplished by using the extended POINTER syntax without specifying a field in the referenced file.
Required Field
A field that cannot be left NULL for an entry.
Routine
A set of M code that performs a process.
Scattergram
A graph in which occurrences of two fields are displayed on an X-Y coordinate grid to aid data analysis.
Screen Editor
VA FileMan's screen-oriented text editor. It can be used to enter data into any WORD-PROCESSING field using full-screen editing instead of line-by-line editing.

REF: See "Line Editor."

Screen-Oriented
A computer interface in which you see many lines of data at a time and in which you can move your cursor around the display screen using screen navigation commands. Compare to Scrolling Mode.
ScreenMan
The set of routines that supports screen-oriented data editing and data display.
Scrolling Mode
The presentation of the interactive dialog one line at a time. Compare to Screen-Oriented.
SDP
An area on disk set aside for temporary, sequential storage of data; an abbreviation for Sequential Disk Processor. It is available on some M implementations (e.g., DSM-11).
SEARCH Template
The saved results of a search operation. Usually, the actual entries found are stored in addition to the criteria used to select those entries.
Secondary Key
Like a Primary Key, fields that make up a Secondary Key must uniquely identify a single record on the file. Key integrity is enforced by VA FileMan for a Secondary Key, the same as for a Primary Key. Secondary Key values, however, are not automatically displayed by VA FileMan during interactive lookup ^DIC. A file or subfile can have more than one Secondary Key.

REF: See "Key" and "Primary Key."

Security
The strategies and procedures used to ensure that user access to data and data structures is controlled and appropriate.
SET OF CODES
A DATA TYPE field value where a short character string is defined to represent a longer value.
Simple Extended Pointers
An extended POINTER that uses a pre-existing POINTER relationship to access entries in another file.
Simple Index
An index that stores the data for a single field.

REF: See "Index."

Simple Key
A key that is composed of only one field.

REF: See "Compound Key."

Sort
To place items in order, often in alphabetical or numeric sequence.
SORT Template
The stored record of sort specifications. It contains sorting order as well as restrictions on the selection of entries. Used to prepare entries for printing.
Spooling
Procedure by which programs and output can be temporarily stored until their turn to execute or print.
Stuff
To place values directly into a field, usually with no user interaction.
Subentry
An entry in a Multiple; also called a Subrecord.
Subfield
A field in a Multiple.
Subfile
The data structure of a Multiple. In many respects, a Subfile has the same characteristics as a file.
Sub-routine
A sequence of M code that performs a specific task, usually used more than once.
Template
A stored pattern of fields, used for editing ("Input Template"), sorting ("Sort Template"), or listing ("Print Template").
Terminal Emulation
Using one kind of terminal or computer display to mimic another kind. Often used with PC remote communication applications.
Terminal Type
The designation of the kind of computer peripheral being used (e.g., the kind of video display or printer). Full terminal type functionality is supplied by Kernel.
Truth Test
An evaluation of an expression yielding a true or false result. In M, usually one of the following is returned from a truth test:
Uniqueness Index
An index associated with every key and used to enforce uniqueness of the key. Every field in the key must be a subscript on the Uniqueness Index and must have no transforms.
Up-Arrow
The caret character (^), also sometimes referred to in VistA legacy documentation as the "up-arrow" key, is used in VA FileMan for exiting an option or canceling a response. Also, it is used in combination with a field name or prompt to jump to the specified field or prompt.
Upload
Send a file from one computer system to another (usually using communications software).
Utility Routine
A routine that performs a task that many developers use.
Variable
A symbol representing a value that changes during the execution of a routine.
VistA
The Veterans Health Information Systems and Technology Architecture (VistA), within the Department of Veterans Affairs (VA), is the component of the Veterans Health Administration (VHA) that develops software and installs, maintains, and updates compatible computer systems in VA medical facilities. (Previously known as the Decentralized Hospital Computer Program [DHCP].)

REF: For a list of commonly used acronyms, terms, and definitions, see the VA OIT Glossary app on the VA Intranet website.

 


Reviewed/Updated: June 2026