Version 6.1 (In Development)
Overview
This is an action trigger intended for use with the Govern Workflow. This action trigger will allow a user to display a form in a modal window, or in a tab item within Govern. The form that can be displayed by this action is either an existing form, or one that has been created in the OpenForm Designer (OFD).
Action form parameters
The following parameters appear in the Add a new action form:
Trigger – This is the status point at which the action is triggered, e.g. At Initialization, All Status, and so on; this field is not modifiable at this point.
Action – This is the list of available actions that are available to be configured; select Display a Form.
Label – This appearance of this parameter is conditional. It will only appear if the trigger point that the action is being configured in is On Request.
Action form – Options group
When the Display a Form action is selected, the following option(s) are displayed:
NOTE: Ensure that the form that is being configured is, both present in the profile that is being referenced, and is accessible to the user, i.e. security access has been given. |
Form – Click to select the form that will be displayed from the combo box.
Display the form in a Modal Window – Select this option to display the form in a modal window. See When to use a Modal Window below.
NOTE: Ensure that the user has access to the form or they will be presented with the Security Lock screen. |
Configuration
NOTE: Users will note that actions that are added to the ‘On Request’ section in the Options group will have a Label parameter to name the link that will invoke the action. Any actions that are executed On Request require a link. |
As this is a standard action that is used in the context of a Workflow, it is configured through the Govern New Administration (GNA).
Prior to configuring the action in the GNA, you will need to create a new form in the OFD, or verify that you have access to an existing form that is to be displayed. Configure a workflow to display a form. Refer to current documentation for details about setting up a Workflow in the GNA.
To configure the action in the GNA…
- From the GNA ribbon select Application Configurations > Workflow (group) > Workflow Management > Departments.
- In the pane on the left hand side (LHS), select a department, e.g. W1-Permitting.
- Click the Types tab.
- Select a Type from the list.
- Click the Steps button.
Steps form – Options group
At Initialization – All actions that are configured in this section are automatically executed at the initialization of this step. When there are two or more actions, the order of initialization may be changed with a click and drag action.
Changing the order of initialization
- Click the vertical ellipsis symbol that appears in front of the step number.
- Drag to reposition above or below another action within the group.
All Status – The actions that are configured in this section are automatically executed after the completion of any available statuses, e.g. Initialization, Completion, and so on.
On Request – See On Request Actions below.
On Request Actions
(Available in release 6.1.1702)
Typically an action is called automatically on Initiation or on Completion, actions may also be added to the On Request section. The actions in this section are executed manually; i.e. users will have to click on the button link that will trigger the action.
Adding the Action
To add the Action in the Steps form…
- On the Steps form select a step on the LHS and select a step.
- On the Right Hand Side (RHS), add an action.
- On the Add a new action form, add an action through the Action combo box; select the Display a form option.
- In the Options group, select the form that is to be displayed from the combo box.
- Indicate whether the form is to be displayed in a modal window. See When to use a Modal Window below.
Add a new action Form parameters (On Request trigger)
Label – On the Add a new action form there is a mandatory 25 character alphanumeric label that is used for the action link. Completion of the Label parameter is mandatory; this will be the name of the link that will invoke the action.
User Interface
Presentation in Govern
When correctly configured, the actions will be executed based upon their configuration in the GNA.
The Display a Form action will display the form in Govern as a new tab. If the modal window option is configured, the form will be presented in a modal; closing the window will close the form.
On Request triggers
Triggers that were configured to be executed as “On Request” will be presented as links on the right hand side (RHS) Available Actions group under the Activity tab. These links will be presented in the Available Actions group, in the order that the actions were entered. Available Actions that correspond to each step can be viewed with a click on the step; they will be presented in the group. With the group, to change the order, they will need to be rearranged in the options group, saved, and refreshed in the GNA.
When to use a Modal Window in Govern
A modal window is a graphical control element that disables the main window and keeps whatever window that is displayed visible. The users must complete the actions required by the modal window before they are allowed to return to main application. Use this option when you want the user to address the requirements of the window before moving on. |
NOTE: Always ensure that the user will have security access to the form that is to be displayed. |
Tables
The following table(s) were implicated in the implementation of this feature:
Other Action Options
To view available Workflow Actions, click here for the complete Workflow Actions list.
See Also