Docupace Start supports the following Action Types (grouped by their function):
Navigation Functionality: | |
Next page | Opens the next wizard page, based on the configured order of pages. Does not work if placed on the last page of the wizard. |
Previous Page | Opens the previous wizard page, from which the user has navigated to this page with Navigation buttons. Does not change the page if Navigation Panel was used to arrive at this page. Does not work if placed on the first page of the wizard. |
Perform Transition Action | Opens the next wizard page, based on the conditions defined in Page Settings in section Transitions. |
Restart Wizard | Opens the first page of the wizard and resets any values that have been filled out to their initial state (empty or as specified in Initial value setting for each field). Usually is placed on the last page of the wizard. |
Open URL | Opens a URL that can be any Web address or a dynamically concatenated URL within the Docupace System. Use a hash symbol (#) in front of the URL, to concatenate the string to the end of the Docupace site URL. |
Work Item Functionality: | |
Save Work Item | If a Work Item has already been created, saves all currently entered field values to the respective Work Item fields. |
Open Created Work Item | If a Work Item has already been created, opens it in the same window. |
Upload Documents for Created Work Item | If a Work Item has already been created, opens a File Upload dialog and allows to attach files to the Work Item. |
Open Work Item Document | If a Work Item has already been created, opens a PDF form that is included in the Work Item. The PDF form must already be attached to the Work Item. This can be achieved in several ways – by configuring the Forms Matrix (338) domain to add a form automatically or by hard-coding a form's GUID into the wizard. |
Workflow Transition Action | Moves a Work Item from one Task Node to the next through the Workflow, as configured in the Transition Validations (443) domain. The button is hidden if transition is not available for the User or the current Task Node. |
Other Functionality: | |
Java Script Action | Allows you to define any action, by writing JavaScript code for it. |
Setting | Description |
|---|---|
Action Type | Determines what kind of Action will be performed when the button is clicked. |
Navigate only if form is valid | If turned on, the Action will only be performed if:
This setting is usually turned on, unless you are testing the wizard and wish to step around the validations. |
Action Types | If used for the Open URL action type, enter the URL that must be opened by this button. Use a hash symbol (#) in front of the URL, to concatenate the string to the end of the Docupace site URL. Examples:
To open an external URL, type the full URL including the protocol. Examples:
|
Action Value | If used for the Perform Transition Action action type, type the name of the action that defines the conditions of this transition, as it is called and configured in the Page Settings tab for this particular page. |
Open Target | Used for the Open URL action type. This will allow you to determine whether the action will open in the current tab or if a new tab should be opened. Select one of the supported targets:
|
Document Type | Used for the Open Work Item Document action type. Enter the name of the form from Forms domain (222), Form Name attribute (109801). Attention: For this action to work, a Work Item must have already been created and the corresponding PDF form must be attached to it. |
Transition Name | Used for the Workflow Transition Action action type. Moves a Work Item from one Task Node to the next through the Workflow, as configured in the Transition Validations (443) domain. The button is hidden if transition is not available for the User or the current Task Node. |
Java Script Content | Used for the Java Script Action action type. Any valid JavaScript code may be used here. |
Namespace | Used for the Save Work Item action type. Namespace defines the source of field data. If data is created within Docupace, workItemNamespace = BASE. But if imported from other systems, could be something else, e.g. REDTAIL, ESIGN, etc. List of namespaces are defined in the "FM Namespaces (247)" domain. Attention: For this action to work, a Work Item must have already been created. |
Style | Used on the Action field type. The following button styles are pre-defined:
|
Horizontal Alignment | Used on the Action field type. If the field spans 1 column, then the alignment is within that column. If it spans 2 columns, then it's aligned on the entire width of the screen. The Action button can be aligned:
|
Disabled Condition | Boolean JavaScript expression. If the result evaluates to FALSE or if this setting is left empty, the button will be visible and enabled. If the result evaluates to TRUE, it will be disabled (grayed out) and the user will not be able to click it. |