Develop > Wizards > Using the Wizard Tool > Actions tab field definitions

Actions tab field definitions

Use this tab to set wizard actions, including defining which Process or Format Control will be executed and on which file variable or record they will be performed.

Field Description

Initial Process

initial.process

This option lets you specify a process definition to be executed prior to the actions to be performed. For information on process definitions, see the Document Engine documentation.

Perform Actions On

section

You must select one of the three options to specify which record(s) will be affected by the action you are going to perform. The file is either the current file, the whole list selected, or an action to be performed on every single record selected. Actions are defined in the wizard, and define what will happen when a user clicks Next on a wizard.

Note Depending on what you selected in the File Selection tab, you can choose whether the actions performed when a user clicks Next will be performed on the current file or a record selection. Record selection ($L.selection) must only be chosen if the $L.selection file variable was filled when you chose Select Records on the File Selection tab, and if you chose either "select one" or "select multiple records" from the list on the Usage tab.

Current File ($L.file)

perform.action.on

The actions will be performed on the single record represented by the $L.file file variable. The current file may have been passed in, created, or selected with a query returning only a single record.

Note The actions defined in the Actions to Perform section apply to the current file selected in the File Selection tab and/or Usage tab.

Selection ($L.selection)

perform.action.on

The actions defined in the Actions to Perform section apply to the group of records selected in the File Selection tab.

Each record in selection ($L.selection)

perform.action.on

The actions defined in the Actions to Perform block apply to each record selected.

Actions to
Perform

section

Use the three subtabs in this section to indicate the actions to perform on the selected file.

Expressions subtab

expressions

Enter any expressions that should be run as part of the wizard after the initial process, before the JavaScript and Format Control (or process). These expressions use Service Manager system language syntax, such as:
name in $L.file="Test"

These expressions are evaluated before the Reset Current File to Selection action is performed. Therefore, actions performed here should use $L.selection rather than $L.file if they are intended to manipulate the user selected record.

Note These expressions can use the record(s) selected, such as storing information in a field.

JavaScript subtab

javascript.actions

The JavaScript expressions will run as part of the wizard and are executed after the initial process and expressions, but before the Format Control or process entered on the next subtab. These JavaScript language expressions can be used to manipulate the current file variable or initialize variables.

Format Control/Process Name subtab  

Format Control

format.control

The Format Control record to use. You can enter a Format Control record to execute queries, calculations, validations, or subroutines after running through the expressions and JavaScript, and before calling the process.

of type

format.control.type

The Format Control type to use for this wizard to evaluate the applicable conditions, so that Format Control can be executed on the action (Add, Update, or Delete) that is evaluated in the Format Control record.

on bad validation

bad.validation.action

When data validation in Format Control fails, choose to return the user to the current wizard panel to enter the correct information, or choose to let the wizard continue to the next panel, ignoring the failed validation.

*Return sends the user back to the panel. Should only be used if the user has the opportunity to fix the failed validation. If the wizard does not request information from the user by displaying a subformat to enter information, selecting Return will end up in an infinite loop.

*Continue lets the user continue.

Process Name

process.name

Enter the name of a process to execute on this wizard panel. For more information, refer to the Document Engine documentation.

Reset Current File to Selections?

reset.to.selections

If selected (set to true), replaces the current file variable ($L.file) with the value selected by the user ($L.selection).

Note This field depends on the selections in the Usage tab. If "Select one record fromlist" or "Select multiple records from list" are chosen, those options generate $L.selection.

Restart Panel if

restart.condition

Under some circumstances it may be necessary to run the wizard panel again. For example, an expected field may not have been filled in correctly, or an error code may have been returned from Format Control or the process. Enter a condition that evaluates to true or false to determine if this panel needs to be rerun.

Display Record(s) when complete?

display.when.complete

Determines whether to display the record to the user when the wizard completes. If the condition is true, Micro Focus Service Manager displays the record to the user when complete. If the condition is false, no record is displayed.

Mode

display.mode

This field determines how a record will be displayed to the user.

*Browse: (This is the default.) Browse mode does not have any buttons to store a modified record.

*Add: The Add button becomes avai lable.

*Update: The Save button becomes available.

Return Current File to calling application?

reset.current.file

This option returns the current record to the application that called the wizard for further processing.