Form Processing Commands - Alphabetical Listing

$ADDFCS

$ADDFCS FormActionCodes

This command defines the form actions that the program treats as an Add action. If you do not include this command, the program treats only the A action as an add. Do not separate actions with a comma. If you include this command, the A action is not assumed.

Note: On forms with form tabs, you can control whether all form tabs' data is transmitted. For codes defined as ADDFCS but not COPYFCS, transmission of data with an Add action does not include fields on form tabs that have not been viewed since the last successful operation. These fields are initialized before the transaction is sent to the application program. ADDFCS actions that are not COPYFCS codes must be listed as DATAFCS codes.

$CHGFCS

$CHGFCS FormActionCodes

This command defines the form actions that the program treats as a Change action. If you do not include this command, the program treats only the C action as a change. Do not separate actions with a comma. If you include this command, the C action is not assumed.

$COPYFCS

$COPYFCS FormActionCodes

This command defines the form actions that the program treats as a form tab only Add action.

Any form tabs the user displays are tracked by the user interface. When the user transmits data, the user interface checks the actions. An ADDFCS that is not a COPYFCS (or any LADDFCS that is not LCOPYFCS) causes fields on unviewed tabs to be initialized before the transaction is sent to the application program. An ADDFCS that is also listed as a COPYFCS (or an LADDFCS that is also listed as LCOPYFCS) causes all data on all form tabs in the form to be transmitted, whether the form tab was viewed or not.

When the transaction returns to the user interface, all form tabs are again reset to unviewed status, unless the E@ERRORNBR is not zero and the action is a DATAFCS. This preserves the form tab viewed status if an Add attempt resulted in an error.

Note: To preserve the viewed or unviewed status, any ADDFCS actions that are not COPYFCS actions must be listed as DATAFCS actions, and CHGFCS that are paired with LADDFCS must be listed as DATAFCS.

Any action listed as a COPYFCS must also be listed as an ADDFCS. Defining a COPYFCS action that is not an ADDFCS action results in an error.

The LADDFCS and LCOPYFCS Add actions on forms that include form tabs with detail areas perform similar actions.

$COLM

$COLM Number,CENTERED|MAX|MIN

This command is only valid for window definitions ($WINDOW). If you enter a Number, the left side of the window starts on that position number. MAX places the window on the right of the terminal screen; MIN places the window on the left of the screen. CENTERED (the default) centers the window horizontally on the screen. You do not have to include this command if you want the window centered horizontally.

$COMMENTKN

$COMMENTKN KN1, KN2, … KNn

This command enables the Attachment button and the Attachments option on the Desktop Client Field menu for the form fields listed by key number.

For more information on enabling attachments, see Enabling Attachments in Form and Object Rules.

$DATAFCS

$DATAFCS FormActionCodes

This command defines the form actions that have required input fields. Before passing control to the application program, the user must enter all required fields on the form. In the Transaction Data section, you must code the fields for which you want to require data entry as SR. Do not separate the actions with commas.

$DBLXMTFCS

$DBLXMTFCS FormActionCodes

This command defines the form actions that require a double transmit. For example, if the Delete action is defined as a double transmit, users must perform a two-step operation to delete a record. First, they must choose the Delete option and then they must confirm that they want to delete the data.

Do not separate actions with a comma.

$DELFCS

$DELFCS FormActionCodes

This command defines the form actions that the form treats as a Delete action. If you do not include this command, the program treats only the D action as a delete. Do not separate actions with a comma. If you include this command, the D action is not assumed. That is, if you enter this command and do not explicitly specify which form actions should be treated as a Delete action, users will not be able to delete anything.

$FCPAIRS

$FCPAIRS FormActionCode Pairs

This command defines valid pairs of form and line actions. In the Transaction Data section, you must enter SF as the editing code for the form action field and LF as the editing code for the line action field. In each action pair, type the form action first and follow it with the line action. Separate the action code pairs with commas.

$FORM

$FORM FormName FormType

This command marks the beginning of a form definition and defines the form name and form type. It is the only required entry in this section.

FormName is five characters. The fifth character must be a number. This number indicates the sequence of a set of forms processed by the same program. You must enter the number even if a program has only one form.

FormType is one character. S or blank indicates a standard online form; R indicates a report parameter form. The form type is in position 21.

$INQFCS

$INQFCS FormActionCodes

This command defines the form actions that the form treats as an Inquire action. If you do not include this command, the form treats only the I action as an inquire. Do not separate actions with a comma. If you include this command, the I action is not assumed.

$KEYFCS

$KEYFCS FormActionCodes

This command defines the actions that require the user to inquire on data before updating or deleting it. Key field values must be unchanged since the last transmit. Do not separate the actions with commas.

In the Transaction Data section, you must enter an editing code of SP for the fields or group you want this edit to check. Application forms define a data group with field type GP and editing code SP before any key fields are defined. The user interface moves a copy of each of the key fields, as it finds them on the form, into this area. After all form data is processed, this area is checked to verify that you have done an inquiry transaction before any updating transaction.

$LADDFCS

$LADDFCS FormActionCodes

This command defines the line actions that the form treats as an Add action. If you do not include this command, the form uses only the A line action as an add. Do not separate actions with a comma. If you include this command, the A action is not assumed.

Note: On forms with form tabs, you can control whether all form tabs' data is transmitted. For codes defined as LADDFCS but not LCOPYFCS, transmission of data with an Add action does not include fields on form tabs that have not been viewed since the last successful operation. These fields are initialized before the transaction is sent to the application program. LADDFCS actions that are not LCOPYFCS codes must be listed as LDATAFCS codes.

$LCHGFCS

$LCHGFCS FormActionCodes

This command defines the line actions that the form treats as a Change action. If you do not include this command, the form uses only the C line action as a change. Do not separate actions with a comma. If you include this command, the C action is not assumed.

$LCOPYFCS

$LCOPYFCS FormActionCodes

This command defines the form actions that the program treats as a form tab detail only line Add action.

Any form tabs the user displays are tracked by the user interface. When the user transmits data, the user interface checks the actions. Any LADDFCS that is not a LCOPYFCS causes fields on unviewed tabs to be initialized before the transaction is sent to the application program.

For detailed information on how the user interface processes actions for forms that include form tabs, see $COPYFCS.

Note: To preserve the viewed/unviewed status, any LADDFCS actions that are not LCOPYFCS actions must be listed as LDATAFCS actions, and CHGFCS that are paired with LADDFCS must be listed as DATAFCS.

Any action listed as a LCOPYFCS must also be listed as an LADDFCS. Defining a LCOPYFCS action that is not an LADDFCS action results in an error.

$LDATAFCS

$LDATAFCS FormActionCodes

This command defines the line actions that have required input fields on a detail line. Before passing control to the application program, the user must enter all required fields on the lines that have these actions. In the Transaction Data section, you must enter an editing code of LR for the detail fields for which you want to require data entry. Do not separate the actions with commas.

$LINEDUPS

$LINEDUPS

This command defines whether the form allows duplicate detail lines. If you include this command, the form allows duplicate detail lines. Otherwise, key fields on the detail lines, coded as LK or LL in the Transaction Data section, are checked to ensure there are no duplicate lines. This command does not have any parameters.

$LINEKN

$LINEKN KeyNumber

When the cursor is on a detail line, this command allows Drill Around access to the object the detail line represents. It is most useful when you are on an inquiry form because all the fields on a line, except the action, are protected.

KeyNumber is the key number of the object a detail line on the form represents. For more information, see Key Number.

$LREQFCS

$LREQFCS FormActionCodes

This command defines the form actions that require the user to process at least one detail line on a form. Do not separate the actions with commas.

$LSELECT

$LSELECT FormActionCodes

This command defines the line selection action. When a user enters the line selection action on a detail line and transfers to another form, data passes from that detail line to the new form.

You can process only one detail line at a time with the line selection action. If you enter the line selection action on more than one line, the form processes only the last line that you entered the action on.

If you do not include this command, the default line selection action is X. If you include this command, you must specify a value for the line selection action.

$NEXTFCS

$NEXTFCS FormActionCodes

This command defines the form actions that let you scroll through a series of records without entering all key fields. When you use one of these actions, you do not have to enter fields coded as SN in the Transaction Data section. Do not separate the actions with commas.

If you do not include the $NEXTFCS command in the form definition, the valid scrolling actions are Next and Previous. Include this command if you do not want either, or both, of the default actions.

$NOLFCOK

$NOLFCOK

This command stands for NO Line Function (action) OK. If you include this command in the form definition, you can add or change a header record without adding or changing detail records. This command does not have any parameters.

$NOTKXFER

$NOTKXFER

Inclusion of this command means that you cannot transfer to this form from other windows or forms using form ID or menu transfer. This command does not have any parameters.

If you include this command, you can transfer to this form using a program transfer (as opposed to a user transfer). This command is useful for forms because the program, rather than the user, fills in hidden fields.

$ROW

$ROW Number, CENTERED, MAX, or MIN

This command is only valid in window definitions ($WINDOW). If you enter a Number, the top of the window starts on that row number. MAX places the window at the bottom of the form. MIN places the window at the top of the form. CENTERED centers the window vertically on the form.

The default is CENTERED. You do not have to include this command if you want the window centered vertically.

$SCRKN

$SCRKN KeyNumber

This command allows Drill Around access to the object that the form represents from any field on the form.

KeyNumber is the key number of the object the form represents. For more information, see Key Number.

$TITLE

$TITLE

This command is only valid in window definitions ($WINDOW). If you include this command, the form ID title becomes the window title. If you do not include this command, no title displays. This command does not have any parameters.

Once a title is defined in the Form ID Definition utility (tokendef), that title is used instead of any defined with the $TITLE command. For more information on see Form ID Definition utility, see the Lawson Administration: Server Setup and Maintenance guide.

$URLKN

$URLKN KN1, KN2, … KNn

This command enables the Attachment button and the Field, Attachments menu choice for the form fields listed by key number.

For more information on enabling attachments, see Enabling Attachments in Form and Object Rules.

$USERXFER

$USERXFER

This command activates the Next Form and Previous Form options. When you press the Next Form (F9) function key, the current transaction executes as if you had pressed the OK key. The value N is placed in the standard field E@USERXFER, which instructs the program to determine the next form in the process and transfer to that form. When you press the Previous Form (Shift+F9) function key, the value P is placed in the standard field E@USERXFER, which tells the program to determine the previous form and transfer to that form.

If you do not include this command in the form definition, the Next Form and Previous Form options are not available. This command does not have any parameters.

$WINDOW

$WINDOW

Inclusion of this command defines a window. When you define a window, the system draws it with a border, without clearing the background. This command does not have any parameters.

You paint a window exactly as you would a form. The border around the window and position on the terminal screen are created using the $ROW and $COLM command parameters.