Child pages
  • IFD Command Reference

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Panel
Table of Contents

This part contains the IFD file format and command syntax.

TITLE-Sets screen title

Sets the text that appears in the first line of the screen.

Format

TITLE title

Parameters

title

String for the title line of each screen. screen.

restrictions

May appear only once in an IFD file.

Description

The TITLE command specifies the text to be displayed on the first line
of each screen. The string is centered and displayed in reverse video.

SUBTITLE-Sets screen subtitle

Sets the text to be displayed in the status line of each screen.

Format

SUBTITLE subtitle

Parameters

title

String to be displayed as the subtitle of each screen.

restrictions

May appear only once in an IFD file.

Description

The SUBTITLE command specifies the text to be displayed on the status
line of each screen. This is the reverse video line that is displayed
above the user function keys.

SET OUTPUT-Sets output list filename

Sets the output filename for the list data file containing the user's
responses.

Format

SET OUTPUT file

Parameters

file

File specification for output list data file. Defaults to OECN$OUT:.DAT
with the same name as the IFD file.

restrictions

May appear only once in an IFD file.

Description

This command is used to specify the name of the output data file for
the users responses. The output file is a standard list data file with
a single record. Each question on the screen generates a token in the
file.

Info

When creating an IFD file for use as a program parameter file, you should specify a file with a .PARMS extension.

SET PRINT-Sets print filename

Sets the output filename for the print file.

Format

SET PRINT file

Parameters

file

File specification for output print file. Defaults to OECN$OUT:.TXT
with the same name as the output file.

restrictions

May appear only once in an IFD file.

Description

This command is used to specify the name of the output file when the
user uses the "Print" function key. The print function generates a text
file which is formatted similarly containing the responses.

The default for this file is OECN$OUT:.TXT with the same name as the output file. In general, you should not specify this command and use the default.

SET FORM-Sets print form file

Sets the print form file filename used to generate the print file.

Format

SET FORM file

Parameters

file

File specification for form file.

restrictions

May appear only once in an IFD file.

Description

This command is used to specify the name of the LSTPRC form file used
when the user uses the "Print" function key. The print function
generates a text file which is formatted similarly containing the
responses.

By default, DYNFORM generates a temporary LSTPRC form file which is formatted similarly to the screen. Therefore, most IFD files do not need a form file. However, in some cases, DYNFORM will not generate a valid or properly formatted file. Therefore, you may write your own form file and use the SET FORM command. In this case, the print function will use the specified form file when creating the text file.

SET TOKEN-Define hard-coded token

Defines hard-coded tokens and values to be written to the list data
file.

Format

SET TOKEN token value

Parameters

token

Name of token to be defined. Must include <> and be less than 32
characters.

value

Value of token to be defined. If the value contains spaces, commas or
lowercase characters then it must be enclosed in quotes. May also
contain an optional description which is not considered part of the
data by placing an exclamation point (warning) prior to the description.

restrictions

May appear up to ten times in an IFD file.

Description

SET TOKEN allows an IFD file to include up to 10 extra tokens in the
output list data file created by DYNFORM. This is useful in cases when
multiple IFD files may be used for a single program. The IFD files may
specify a hard-coded token to indicate to the program being executed
which IFD file has invoked it.

The value of the token may include an optional description similar to the /DESCRIPTION on QUESTION items. To include a description, place an exclamation point (warning) after the tokens value. Any characters placed after the exclamation point will be considered description and not be part of the data.

Info

Tokens which are created with SET TOKEN will always be written to the output file before tokens created by the QUESTION command regardless of where they appear in the IFD file. Programs which use these tokens can assume that hard coded tokens will appear before other tokens.

SET COMMAND-Defines command to be executed

Defines the command to be executed when the user presses "Execute".

Format

SET COMMAND command

HTML Table
border1
width75%
Table Row (tr)
Table Head (th)
Command Qualifiers
Table Head (th)
Defaults
Table Row (tr)
Table Cell (td)

/TYPE={READ_ONLY|UPDATE}

Table Cell (td)

/TYPE=READ_ONLY

Parameters

command

Command to be executed when users uses the "Execute" function. May
contain a DCL command, a DCL command procedure or the name of an
executable image. If it is a DCL command, then the first character of
the command must be a dollar sign ($), otherwise, the file name must
contain the file extension (i.e. .EXE or .COM).

restrictions

May exist only once in an IFD file.

Description

The SET COMMAND command defines the command to be executed when the
user presses the "Execute" function. The command is executed by
invoking OECN$:OECN$EXECUTE.COM and passing the command and parameter
file to the procedure. OECN$EXECUTE.COM is responsible for determining
the type of command, invoking it and passing the name of the parameter
file.

The parameter file passed to OECN$EXECUTE is actually a temporary copy of the parameter file with unique name. This permits the user to execute multiple copies of the command simultaneously (or in batch). OECN$EXECUTE will automatically delete the temporary parameter file after the command has been executed.

Qualifiers

/TYPE={READ_ONLY|UPDATE}

Specifies whether the specified command is an "read-only" or "update"
function/program. This determines which of the OECN batch queues the
command is submitted to if the user select batch execution. Read-only
commands are submitted to OECN$BATCH and update commands are submitted
to OECN$BATCH_UPDATE.

SET LINE -Sets the current line to a specific line

Sets the current line to a specific screen line.

Format

SET LINE line

Parameters

line

The line number to set as the current line.

Description

SET LINE is used to set/reset the current line pointer to a specific
screen line. The lines on the screen are numbered from 1 beginning on
the line after the title line. That is, line two on the physical screen
is the first line for text and data items. TEXT and QUESTION commands
which follow a SET LINE will begin on the specified line.

SCREEN-Starts a new screen

Starts a a new screen.

Format

SCREEN

Description

This command forces the start of a new screen. By default, DYNFORM
automatically determines how many text and data items can fit on a
screen. When SCREEN is specified a new screen is started immediately
and following questions and text items appear on the next screen.

TEXT-Defines background text

Defines background text to appear on the screen.

Format

TEXT text

HTML Table
border3
width75%
Table Row (tr)
Table Head (th)
Command Qualifiers
Table Head (th)
Defaults
Table Row (tr)
Table Cell (td)

/ATTRIBUTES=(

Unordered List (ul)
List Item (li)
BOLD
List Item (li)
REVERSE
List Item (li)
UNDERLINE
List Item (li)
FLASH
List Item (li)
CENTER
,...)

Table Cell (td)

None

Table Row (tr)
Table Cell (td)

/COLUMN={n|EOL}

Table Cell (td)

/COLUMN=1

Table Row (tr)
Table Cell (td)

/KEEP

Table Cell (td)

Table Row (tr)
Table Cell (td)

/SKIP=n

Table Cell (td)

/SKIP=0

restrictions

/SKIP and /KEEP are mutually exclusive.

Parameters

text

String containing text to be displayed as background text. String must
be contained in quotes if it contains spaces, commas or lowercase
characters.

Description

The TEXT command specifies text to be displayed as background text. By
default, the text is displayed on the next available line in column one.

Qualifiers

/ATTRIBUTES=(keyword[,...])

Specifies the attributes to apply to the text parameter. Specify one or
more of the following keywords:

HTML Table
border3
width75%
Table Row (tr)
Table Cell (td)

BOLD

Table Cell (td)

Bold

Table Row (tr)
Table Cell (td)

REVERSE

Table Cell (td)

Reverse video

Table Row (tr)
Table Cell (td)

UNDERLINE

Table Cell (td)

Underlined

Table Row (tr)
Table Cell (td)

FLASH

Table Cell (td)

Flashing

Table Row (tr)
Table Cell (td)

CENTER

Table Cell (td)

Centers text assuming text begins in column 1

/COLUMN=

Unordered List (ul)
List Item (li)
n
List Item (li)
EOL

Specifies the column position for the text. If EOL is specified then the text is placed at the end of the current line.

/KEEP

Keeps the text on the previous line. By default, DYNFORM places the
text on the next available screen line. Using /KEEP places the text on
the previous line allowing the text to be combined on the same line
with other text items or questions. /KEEP is the same as /SKIP=-1.

/SKIP=n

Causes the current line to be moved forward or backwards from the
current line position. By default, each item is placed on the next
available line from the current position. Using /SKIP you can cause the
current line to moved forward (positive value) or backward (negative
value). Note that /SKIP modifies the current line pointer, therefore,
the placement of subsequent items is also affected.

QUESTION-Defines a question

Defines a question (data item) on the screen.

Format

QUESTION token_name

HTML Table
border1
width75%
Table Row (tr)
Table Head (th)
Command Qualifiers
Table Head (th)
Defaults
Table Row (tr)
Table Cell (td)

/LABEL=text

Table Cell (td)

None

Table Row (tr)
Table Cell (td)

/DESCRIPTION=text

Table Cell (td)

Value of /LABEL

Table Row (tr)
Table Cell (td)

/TYPE=

Unordered List (ul)
List Item (li)
TEXT
List Item (li)
MONEY
List Item (li)
INTEGER
List Item (li)
PERCENT
List Item (li)
NUMBER
List Item (li)
DATE
List Item (li)
CENTURY_DATE
List Item (li)
LIST
List Item (li)
CASH
List Item (li)
APPROP
List Item (li)
BUDGET
List Item (li)
REVENUE
List Item (li)
BUDREV
List Item (li)
FILE

Table Cell (td)

/TYPE=TEXT

Table Row (tr)
Table Cell (td)

/LENGTH[=(n,...)

Table Cell (td)

/LENGTH=1

Table Row (tr)
Table Cell (td)

/LOWERCASE

Table Cell (td)

Table Row (tr)
Table Cell (td)

/[NO]TRIM

Table Cell (td)

/TRIM

Table Row (tr)
Table Cell (td)

/SEPARATOR=string

Table Cell (td)

/SEPARATOR=" "

Table Row (tr)
Table Cell (td)

/LOV=(string,...)

Table Cell (td)

Table Row (tr)
Table Cell (td)

/RANGE=([low],[high])

Table Cell (td)

Table Row (tr)
Table Cell (td)

/REQUIRED

Table Cell (td)

Table Row (tr)
Table Cell (td)

/DEFAULT=string

Table Cell (td)

Table Row (tr)
Table Cell (td)

/PIC=edit_string

Table Cell (td)

Table Row (tr)
Table Cell (td)

/COLUMNS=(

Unordered List (ul)
List Item (li)
LABEL={n|EOL}
List Item (li)
DATA={n|EOL}
, ...)

Table Cell (td)

Table Row (tr)
Table Cell (td)

/KEEP

Table Cell (td)

Table Row (tr)
Table Cell (td)

/SKIP=n

Table Cell (td)

/SKIP=0

Table Row (tr)
Table Cell (td)

/CALLBACKS=(

Unordered List (ul)
List Item (li)
HELP=routine
List Item (li)
VALIDATION=routine
List Item (li)
DEFAULT=routine
,...)

Table Cell (td)

Table Row (tr)
Table Cell (td)

/PARAMETERS=(parameter1[, parameter2])

Table Cell (td)

Parameters

token_name

Token name which will be written to the list data file. If a token
occurs multiple times in a single file, they must be defined
consecutively in order for LSTPRC to process them correctly.

restrictions

Unordered List (ul)
List Item (li)
/LOV and /RANGE are mutually exclusive.
List Item (li)
/KEEP and /SKIP are mutually exclusive.
List Item (li)
/PARAMETERS can only be specified if /CALLBACKS is also specified.

Description

The QUESTION command defines a data field on the screen. Data fields
can be placed nearly anywhere on the screen.

Info

In general, tokens will be written to the output file in the order that the QUESTION commands appear in the IFD file. However, programs which parse output files from DYNFORM should not depend on this order. Future versions of DYNFORM may write tokens in a different order.

Qualifiers

/LABEL=text

Defines text label to be displayed on same line as data item.

/DESCRIPTION=text

Defines optional text to use as a description in the output data file.
The output data file will be written with the description following the
data. The full description consists of this text followed by the edited
data enetered the the user. Report programs can use this text to create
an "options" page. If /DESCRIPTION is not specified, then the default
is the value of /LABEL.

/TYPE[=keyword[=edit_string]]

Defines the data type for the data item. Optionally, an edit string may
be specified for some data items. The data type, length and edit string
together determine the data type and how it will be processed.
Validations are automatically applied to some data types. The following
table lists the data types, default edit string and validation if
applicable.

HTML Table
border3
width75%
Table Row (tr)
Table Head (th)
Type
Table Head (th)
Default Edit
Table Head (th)
Validation
Table Head (th)
Description
Table Row (tr)
Table Cell (td)

TEXT

Table Cell (td)

none

Table Cell (td)

none

Table Cell (td)

Data is a text string. Uppercase characters only are allowed unless /LOWERCASE is specified.

Table Row (tr)
Table Cell (td)

MONEY

Table Cell (td)

----------9.99

Table Cell (td)

none

Table Cell (td)

Money field

Table Row (tr)
Table Cell (td)

INTEGER

Table Cell (td)

--------9

Table Cell (td)

none

Table Cell (td)

Integer field

Table Row (tr)
Table Cell (td)

PERCENT

Table Cell (td)

---9.999

Table Cell (td)

none

Table Cell (td)

Percentage

Table Row (tr)
Table Cell (td)

NUMBER

Table Cell (td)

--------9.9999

Table Cell (td)

none

Table Cell (td)

Numeric item

Table Row (tr)
Table Cell (td)

DATE

Table Cell (td)

n/a

Table Cell (td)

Must be a valid date or blank.

Table Cell (td)

A data data item. The type of date is determined by the /LENGTH
qualifier as follows:

Length

Format

4

MM/YY

6

MM/DD/YY

8

MM/DD/YYYY

The date is validated based on this format. If the user fills in part of the date then remainder of the date is completed using the current system date.

Table Row (tr)
Table Cell (td)

CENTURY_DATE

Table Cell (td)

n/a

Table Cell (td)

Must be a valid date or blank.

Table Cell (td)

A data data item. The type of date is determined by the /LENGTH
qualifier as follows:

Length

Format

6

MM/YYYY

8

MM/DD/YYYY

The date is validated based on this format. If the user fills in part of the date then remainder of the date is completed using the current system date.

Table Row (tr)
Table Cell (td)

LIST

Table Cell (td)

n/a

Table Cell (td)

none

Table Cell (td)

A series of text items separated by commas. Each element separated by commas is validated by /LOV and /RANGE as a separate value.

Table Row (tr)
Table Cell (td)

CASH

Table Cell (td)

n/a

Table Cell (td)

none

Table Cell (td)

USAS Cash account code

Table Row (tr)
Table Cell (td)

APPROP

Table Cell (td)

n/a

Table Cell (td)

none

Table Cell (td)

USAS Appropriation account code

Table Row (tr)
Table Cell (td)

BUDGET

Table Cell (td)

n/a

Table Cell (td)

none

Table Cell (td)

USAS Budget account code

Table Row (tr)
Table Cell (td)

REVENUE

Table Cell (td)

n/a

Table Cell (td)

none

Table Cell (td)

USAS Revenue account code

Table Row (tr)
Table Cell (td)

BUDREV

Table Cell (td)

n/a

Table Cell (td)

none

Table Cell (td)

USAS Budget/Revenue account code combination. Contains both a function and revenue code.

Table Row (tr)
Table Cell (td)

FILE[="file"]

Table Cell (td)

"=.TXT"

Table Cell (td)

Must be valid filename and extension

Table Cell (td)

Filename and extension. Value will be parsed and reduced to a filename and extension. If "=file" is specified then the "file" will be used as the primary filespec during the parse. This means that components from "=file" will override the users entry. This may be used for force the file to have a particular extension. The default is .TXT so by default a FILE data type is required to have a .TXT extension.

/LENGTH=(length[,...])

Determines the length of the data item as it appears on the screen. If /LENGTH is not specified then the length defaults appropriately depending on the data type.

If multiple lengths are specified, then the field is segmented into multiple fields on the screen with a single space in between each part. Generally, only TEXT data item should be segmented. DATE and USAS account data types are automatically segmented appropriately. The data when written to the output list data file will not be segmented.

/LOWERCASE

Indicates that the item may contain lowercase characters. By default,
all items are required to contain uppercase only.

/[NO]TRIM

Determines if TEXT or LIST fields are trimmed of leading spaces. /TRIM
is the default.

/SEPARATOR=string

Determines the separator between fields when the field is segmented by
/LENGTH. By default the separator is a space, except for DATE data
fields in which case, default is /SEPARATOR="/".

/LOV=(string[,...])

Defines a list of valid values for the field. /LOV should contain two
or more strings which indicate allowed values. /LOV is only valid for
items with /TYPE=TEXT or /TYPE=LIST.

/RANGE=([low],[high])

Defines an inclusive range of values which are allowed for the item.
Either low or high may be omitted indicating that the low or high limit
is unbounded. /RANGE is valid for both text and numeric data items.

/REQUIRED

Indicates that a value must be entered for the item and cannot be left
blank. If /REQUIRED is not specified then blank values are permitted
regardless of other validation qualifiers.

/DEFAULT=string

Sets the default value for the item. The default placed in the field
whenever an existing list data file for the IFD file is not found, or
if a item is required and the item's token does not exist in the list
data file.

/PIC=edit_string

Specifies the edit string for the field in the output list data file.
This qualifier affects only the list data file and not the appearance
of the data on the screen.

/COLUMNS=([LABEL={n|EOL}][,][DATA={n|EOL}])

Specifies the column position for the label and/or the data field.
Either the label or the data may be placed at a specific column. If EOL
is specified then the item is placed at the end of the current line.
/COLUMNS interacts with /KEEP, /SKIP and /COLUMN on both TEXT and
QUESTION items allowing multiple text, labels and data items to appear
on a single line. If /COLUMNS is not specified, by default the label
starts in column one and column position for the data is calculated. If
the data field is less than 30 characters then it starts in column 50,
otherwise, the data starts in column 80 minus the length of the field
(including separators).

/KEEP

Causes the question to be kept on the previous line. By default,
questions start at the next available line. Using /KEEP allows you to
place multiple TEXT and QUESTION items on a single line. /KEEP is the
same as /SKIP=-1.

/SKIP=n

Causes the current line to be moved forward or backwards from the
current line position. By default, each item is placed on the next
available line from the current position. Using /SKIP you can cause the
current line to moved forward (positive value) or backward (negative
value). Note that /SKIP modifies the current line pointer, therefore,
the placement of subsequent items is also affected.

/CALLBACKS=([HELP=routine][,][VALIDATION=routine])[,][DEFAULT=routine]

) Specifies the callback routines for help, validation or defaults
routines. Callback routines allow IFD files to implement complex
validations or help messages using a high-level language. See
Chapter 3 for more information about writing and linking with
callback routines.

/PARAMETERS=(string[,][string])

Specifies up to two parameters which will be passed to the callback
routines. /PARAMETERS is only valid when /CALLBACK is specified. If the
parameter strings contain the name of a token, then the current value
of the token will be passed to the callback routine.

HELP-Specifies static help text

Specifies static help text for the previous QUESTION item.

Format

HELP help_text[,...]

Parameters

help_text

Quoted string containing the help line.

restrictions

The HELP command must follow a QUESTION item or another HELP command.

Description

One or more HELP commands may be specified after a QUESTION command to
supply help messages. If a single help line is specified for a question
then the help will be displayed on the screen. If more than one help
line is included, then the help will be displayed in a pop-up help
window. As many help lines may be specified as necessary, however, the
maximum total help lines in a single IFD file is 500.