Form Commands tab

Use this tab to maintain the form commands for the session.
All Form Commands
List of all form commands of the current session. The tree structure of the list mirrors the menu hierarchy of the commands.

A form command can have activation types Function, Session, Business Method, or Menu. Therefore, the command can invoke these types of activation objects. LN Studio uses the following icons to denote these activation types:

Function
Session
Business Method
Menu

In the All Form Commands field, you can add and remove form commands:

  • To add a form command to a session, click Add. The Create a New Form Command wizard starts. Specify the properties for the new form command and click Finish.

    See the online help of the Create a New Form Command wizard.

  • To remove a form command from a session, right-click the form command and, on the shortcut menu, select Remove.

The tree structure of the displayed form commands mirrors the menu hierarchy of the form commands in the runtime session. Form commands of type menu can have child nodes, which must be commands of another activation type. Menu commands cannot contain child items of type menu command. A command that does not activate a menu cannot have child nodes. The Session editor only supports one level of submenus. Therefore, a menu command can only have child nodes and cannot have grandchild nodes.

To change the menu structure, drag and drop a form command from one location to a menu command or to the root of the tree structure. In the latter case, the command appears, at runtime, directly under the session's appropriate menu.

To change the sequence of the form commands in a menu, move the commands up or down the command list of a specific menu.

Form Command Properties
Activation
Activation Type
Activation Type specifies what your form command activates. You can select the activation types from the drop-down list. The used type names are self explanatory.
Allowed values:
  • Function
  • Session
  • Business Method
  • Menu
Function/Session/Business Method/Menu
The name of the function, session, business method, or menu that the form command activates.
Allowed values:
  • A session or menu available in the development repository of the connected LN server. To select a session or a menu, click Browse.

    To open the selected menu or session in the corresponding editor, click the Menu or Session hyperlink.

  • An external function in the session's UI script. You can select a function from the drop-down list.

    To view or edit the selected function in the script editor, click the Function hyperlink.

  • A business method in the session's UI script, or DAL script. You must type in the code of the business method.
Command Type
Command Type specifies where the form command appears on the session's form. You can select the following command types from the drop-down list:
Allowed values:
Group The form command only appears on the session's appropriate menu when a user selects the tab that includes the group you define in the Group/Field Number field. Field The form command appears as a button on the form, behind the field whose Sequence Number you enter in the Group/Field Number field. Print The form command appears as an option in the session's print menu.
Form For all of the session's form tabs, the form command appears on the form's appropriate menu, and/or as a button on the form.
Group Number / Field Number
This field specifies the group to which the form command belongs, or the sequence number of the field linked to the form command. Whether this field specifies a group or a sequence number depends on the value you entered as the Command Type: Group or Field.

This field only applies to form commands of type 'Group' or 'Field'. The field is disabled for the other form command types ('Form' and 'Print').

The field has a dynamic name derived from the command type: Group Number or Field Number.

For form commands of Command Type Group, select the group to which the form command belongs. The form command only appears in the session's appropriate menu when the user selects the group's tab.

For form commands of Command Type Field, select the field behind which the form command appears as a field button.

The pull down list shows the numbers and label codes of the available groups or fields.

Allowed values:

To specify this field, select a value from the drop-down list.

Category
The form command category used by Infor LN UI. The category determines the pull-down menu in which the command is displayed.
Allowed values:
Action The command is displayed in the session's Action menu.
Reference The command is displayed in the session's Reference menu.
View The command is displayed in the session's Views menu.
Special 1 The command is displayed in an additional pull-down menu, which is specific to the session.

Use the Special 1 and Special 2 categories to group frequently used commands. Per special category, you must select one default command. The description of this default command is displayed on the special category's menu button.

Specify a short description in the Short Description field. If you leave the Short Description field empty, the Long description is displayed on the menu button, so the button becomes too large.

Special 2
Note: The category is only used by LN UI. If the session runs in another UI, the category is ignored.

Form commands in a menu must have the same category as the menu.

Default Command
Use this check box to define the form command as the default command for the session, or for a command category in the session.

You can select this check box in these situations:

  • If the command has Command Type Print.
  • If the command belongs to the Special 1 or Special 2 category.

    If this check box is selected, the command is the default command of its category. If the session runs in LN UI, the description of the default command is displayed on the category's menu button. See the example.

Example - default command for a category

This table shows an example:

Session/Function/Business Method Long description Category Default Command
exec.user.1 Activate Job Special 1 Yes
exec.user.2 Queue Job Special 1 No
exec.user.3 Block Job Special 1 No
exec.user.4 Cancel Job Special 1 No

The commands of the Special 1 category are displayed in the Activate Job pull-down menu.

Note: You can specify one default command per special category.

The default command is only used by LN UI. If the session runs in another UI, the default command is ignored.

Display
Label Code
The code of the form command's label.

To edit or view the label in the label editor, click the Label Name hyperlink.

Allowed values:

To specify this field, click Browse and select a label name from select dialog box.

Description
The description of the form command's label, as specified in Label Name.
Allowed values:

This field is read-only. LN Studio automatically fills in the label description after you specified the Label Name.

Shortcut Key
The form command's shortcut key. This property does not apply to form commands that invoke a menu.

Select the form command's shortcut key from the drop-down list.

Allowed values:

The value for Shortcut Key is one of the following:

  • "Not applicable"
  • A key combination that conforms to the following syntax: CTRL+F1- CTRL+F12, or CTRL+SHIFT+A- CTRL+SHIFT+Z
Add Ellipses to Label
If this check box is selected, an ellipsis (...) follows the form command's label. Use ellipses to indicate the form command opens a dialog box.
Suppression of Dialog Allowed
If this check box is selected, users can suppress the dialog box, which is started by the form command, at runtime. The dialog box is suppressed if user defaults are defined and quick flow is activated. If the dialog box is suppressed, the corresponding default command is executed.

This check box is only available if the Add Ellipses to Label check box is selected.

Separator
If this check box is selected, Enterprise Server inserts a line in the menu under the form command. Use these lines to create separate groups of form commands in the menu.
Availability
Authorization Group
The authorization level users need to carry out the form command. All commands with an authorization group higher than the user’s authorization for the session are removed from the appropriate menu.
Note: For form commands of type Menu, you must specify Authorization Group Display.

Example:

A user is authorized to view and print records in a session. The authorization group for that session is 'Print/Display'. All form commands with authorization groups 'Full Authorization' (Delete/Insert/Modify/Print/Display), 'Insert/Modify/Print/Display' and 'Modify/Print/Display' are removed from the appropriate menu.

Allowed values:
  • Display
  • Print/Display
  • Modify/Print/Display
  • Modify/Print/Display
  • Insert/Modify/Print/Display
  • Full Authorization

Choose the authorization group of a form command according to the following guidelines:

Command Type If this form command… Authorization Group
Form, Field or Group gives access to functionality, where a delete action should be possible. Full Authorization
Form, Field or Group gives access to functionality, where an insert action should be possible, but no delete action is needed. Insert/Modify/Print/Display
Form, Field or Group gives access to functionality, where a modify action should be possible, but no insert or delete action is needed. Modify/Print/Display
Form, Field or Group gives access to functionality, where data is displayed, but no print, modify, insert, or delete actions are needed. Display
Print gives access to report functionality, which also provides an option for the end-user to delete data (or executes a delete action in the script). Full Authorization
Print gives access to report functionality, which also provides an option for the end-user to insert data, but not to delete (or executes an insert action in the script). Insert/Modify/Print/Display
Print gives access to report functionality, which also provides an option for the end-user to modify data, but not to insert or delete (or executes a modify action in the script). Modify/Print/Display
Print gives access to report functionality, which prints data, but does not provide an option to modify, insert or delete data. Print/Display
Note: Define authorizations in the Authorization Management System module, and link these to a user on the Authorizations tab of the User Data (ttaad2500m000) details session.
Command Availability
The availability of the form command.
Note: This field does not apply to form commands of type menu.
Allowed values:
Always Authorized users can activate the form command. The programming function disable.command overrules this option.
One Record Selected Authorized users can only activate the form command when they have selected one record in the overview session's grid. The programming function disable.command overrules this option. This option overrules the enable.command programming function.
Records Selected Authorized users can only activate the form command when they have selected one or more records in the overview session's grid. The programming function disable.command overrules this option. This option overrules the enable.command programming function.
Never Users cannot execute the form command. The programming function enable.command overrules this option.
Show as Button in Dialog or Browse Session
If this check box is selected, the form command displays as a field button on the session's form.
Show in Menu bar of Details window
If this check box is selected, the form command is shown on the details session's appropriate menu.
Note: Programming functions are available to create an application toolbar that includes a session's form commands.
Initial hidden
If this check box is selected, the form command is initially not displayed in the session. At runtime, you can make the form command visible through the Personalize Session Menus or Personalize Toolbar option. The initially hidden commands are displayed as a menu option in the Hidden panel of the Personalize Session Menus dialog box, just like the other hidden menu options.
Initial hidden when added to Toolbar
If this check box is selected, the session does not display the form command if the form command appears as an icon on the toolbar.
Execution
Before Execution
Question
When the user tries to execute the form command, Enterprise Server prompts the user with the question whose name you enter in this field. This field does not apply to form commands of type menu. If the field is left empty, no question is asked.
Allowed values:

To specify this field, click Browse and select a question from the select dialog box.

Answer
To carry out form commands, a user must give the answer you enter in this field when prompted by Enterprise Server with the question in the Question field. This restriction only applies if the Question field has been specified. This field does not apply to form commands that invoke a menu.
Allowed values:

To specify this field, select a answer from the drop-down list. This list contains all answers available for the selected question.

Multi Session execute
For an overview session, when a user executes a form command with multiple records selected in the grid, if in this field you select:

Once, LN only carries out the form command for the first record selected in the grid.

For every occurrence, LN carries out the form command for every record selected in the grid.

Allowed values:
Once Form command is only carried out for the first record selected in the grid.
For every occurrence Form command is carried out for every record selected.
Save data
If this check box is selected, when a user activates the form command, LN saves the session's data before carrying out the form command. This option does not apply to form commands of type menu.

If this check box is cleared, when a user activates the form command, LN carries out the form command without saving the session's data.

Execution
Start mode Session
Select the mode of the session the form command starts.
Note: This field only applies to form commands of type Session.
Allowed values:
  • Modal
  • Modeless
  • Synchronized Child
  • Modal Overview
  • Not applicable
Kind of Session
Select the type of session the form command starts from the options.
Note: This field only applies to form commands of type Session.
Allowed values:
  • Overview Window
  • Details Window
  • Not applicable
After Execution
Refresh Parent
If this check box is selected, when users execute the form command in a session, the data affected by the form command automatically updates in any related sessions.

If this check box is cleared, users must manually save the changes after they execute the form command for the changes to update in any related sessions.