Invoke Workflow
- Last UpdatedMar 11, 2025
- 9 minute read
Use Invoke Workflow control to invoke a workflow from your form.
Properties
The properties for the control are grouped under the following tabs:
Basic
|
Property |
Description |
|---|---|
|
Name |
Name that identifies the control. This value is also used for the label of the control. |
|
XML Node |
XML node mapped to the control. Use this value to map a list to a form and a form to a workflow.
Note: |
|
Description |
Description for the control. |
|
Tooltip |
Message that appears when the pointer hovers over the control. |
|
Button Text |
Text for the Invoke Workflow button. |
|
Workflow Details |
Details of the workflow that is to be invoked. To add Workflow Details for the control
|
|
XML Variable Name |
XML variable name to store the form XML Schema in workflow. To add an XML Variable Name for the control
Note: The Selected XML Variable drop-down lists all the existing XML variables. You can either select the existing
variable or create a new variable. |
|
XML Schema |
Form XML schema to create the XML variable for workflow. To add an XML Schema for the control
Note: |
|
Mapping Schema |
Mapping Schema to create mapping definition for workflow. You can map the schema only when the XML schema set for the Form or Grid does not
match with the XML schema set for the XML Variable of the selected workflow. To map the schema for the control
Note: When the XML schema set for the Form or Grid does not match with the XML schema set for the XML Variable of the selected workflow, the XML Variable must be overwritten or mapped. For more information, see Overwriting XML Variables. |
Appearance
|
Property |
Description |
|---|---|
|
Enable |
Enable or disable the control.
|
|
Visible |
Show or hide the control.
|
|
Label Position |
Position of the label for the control.
Note: |
|
Label-Control Area |
Area occupied by the label and the control in percentage.
Note: |
|
Alignment |
Alignment of the button with respect to the form.
|
|
Retain Space |
Reserve or remove space when the control is hidden.
|
|
Display Mode |
Show text and/or image for the button.
|
|
Button Size |
Size of the button for the control.
|
|
Image Path |
Path to the image for the control. The image path is specified as:
|
|
Image Position |
Position of the image with respect to the text for the control.
Note: This property is applicable only when the Display Mode property is set to Text and Image. |
|
Show as Link |
Enable or disable the control to show as link.
|
Validation
|
Property |
Description |
|---|---|
|
Show Confirmation Message |
Show or hide the confirmation message for the control.
|
|
Confirmation Message Text |
Confirmation message for the control. Note: This property is applicable only when the Show Confirmation Message property is set to Yes. |
|
Show Success Message |
Show or hide the success message for the control.
|
|
Success Message Text |
Success message for the control. Note: This property is applicable only when the Show Success Message property is set to Yes. |
Advanced
|
Property |
Description |
|---|---|
|
ID |
Reference identification code for the control. This value is automatically generated and cannot be changed. |
|
Execution Mode |
Allow or deny a user to act on consecutive tasks immediately without navigating to the Inbox.
Note: |
|
Close Form |
Allow or deny the system to close the form when the workflow is invoked.
Note: When a form is loaded in a separate window, the system closes the form when the workflow is invoked. When a form is loaded within an existing window (inline), the system reloads the form when the workflow is invoked. |
|
Form Button |
Enable or disable the control to act as form button. When this property is enabled, the control is displayed at the bottom-right corner of the form.
Note: If the value is Yes, and the form is viewed on a mobile device, then the control appears in the Action Bar of the mobile device. |
Scripts
For information about using scripts, see scripting guidelines for Invoke Workflow control.