Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Work Tasks

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.

  • Prefix with @ to use the value of the control as an attribute with the immediate parent node. For example, @FirstName.

  • Use / for a parent-child node configuration to uniquely identify a control in a form with multiple containers. For example, Employee/FirstName.

Note:
- If you use / to denote a parent which is not a container and the parent is at the same level as that of the child, then the XML node for the control is not generated.
- If you edit this value later, then it might affect the mapping between forms, lists, and workflows.

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

  1. Click the Workflow Details icon. The Workflow Details Configuration page appears.

  2. In the Workflow Name box, click a workflow name.

  3. In the Workflow Version list, click a workflow version.

  4. Click Save & Continue. The selected workflow details is set for the control and the Workflow Details Configuration page is closed.

    Note:
    - Workflow details are displayed in <Workflow Name> ~ <Workflow Version> format.
    - When the selected version of the workflow is in published state, and all or any one of the following properties are modified:
    -Workflow Details
    -XML Variable Name
    - XML Schema
    then, the workflow must be unpublished, or a different version of the workflow must be selected, or a new version of the workflow must be created.
    - For more information, see Overwriting Workflows.

XML Variable Name

XML variable name to store the form XML Schema in workflow.

To add an XML Variable Name for the control

  1. Click the XML Variable Name icon. The XML Variable Configuration page appears.

  2. Select the existing XML variable name or create a new XML variable.

    • To select the existing variable name, click Select XML Variable drop-down list and select the name.

    • To create a new variable,

    1. Select Create New... option from the Select XML Variable drop-down list.

    2. Enter the name for the XML Variable in the Specify Name text box.

      The specified name gets saved to the XML Variable list.

  3. Click Save & Continue. The selected XML variable name is set for the control and the XML Variable Configuration page is closed.

    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.
    For more information, see About XML Variables.

    XML Schema

    Form XML schema to create the XML variable for workflow.

    To add an XML Schema for the control

    1. Click the XML Schema icon. The XML Schema Configuration page appears.

    2. Click Form for a form or click Grid for a grid in the Schema.

    3. If you select Grid in the schema, then select a grid in the Grid box. The Grid box lists all the grid controls in the form including the ones present in the Embed form controls.

    4. Click Save & Continue. The selected XML schema is set for the control and the XML Schema Configuration page is closed.

      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.
      - For more information, see Overwriting XML Variables.

      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

      1. Configure the XML Schema. Refer steps 1 to 4 of XML Schema in the above row.

      2. Click the Mapping Schema icon to map the Workflow XML schema with the control XML schema.

        Note: Clear the existing mapping definition (if exists), in case:
        - a new XML Variable is selected
        - a Form XML schema is changed to a Grid XML schema or vice-versa
        Click the Remove icon to clear the existing mapping definition.

        The XML Variable Overwrite Configuration page appears.

      3. Select the Create a mapping schema option and then click Save & Continue.

        The Invoke Workflow XML Mapping page appears.

      4. Select the elements or attributes from the Workflow XML column to be mapped with the elements or attributes of the Invoke Workflow XML.

      5. Click Save. The selected XML schema is mapped with the control and the Invoke Workflow XML Mapping page is closed.

        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.

        • Select Yes to enable the control.

        • Select No to disable the control.

          The default value is Yes.

        Visible

        Show or hide the control.

        • Select Yes to show the control.

        • Select No to hide the control.

          The default value is Yes.

        Label Position

        Position of the label for the control.

        • Select Default to allow the system to align the label. The system aligns the label to the left of the control or as specified by the container control.

        • Select Left to align the label to the left of the control.

        • Select Top to align the label to the top of the control.

        • Select Right to align the label to the right of the control.

        • Select Bottom to align the label to the bottom of the control.

        • Select Suppress to hide the label for the control.

          The default value is Default.

        Note:
        - If the value is Default and the control is placed on a container control, then the value of the Label Position property of the container control determines the position of the label for the control.
        - For example, if the value is Default and the control is placed on a Base Form with Label Position property set to Top, then the label is aligned to the top of the control.

        Label-Control Area

        Area occupied by the label and the control in percentage.

        • Select Default to allow the system to set the label and the control areas.

        • Select Custom to specify the label area. The control area is automatically set based on the label area.

          The default value is Default.

        Note:
        - If the value is Default and the control is placed on a container control, then the value of the Label-Control Area property of the container control determines the area of the label for the control.
        - This is applicable only when the Label Position is set to Left or Right.

        Alignment

        Alignment of the button with respect to the form.

        • Select Default to allow the system to align the button. The system aligns the button to the left of the form or as specified by the control.

        • Select Left to align the button to the left of the form.

        • Select Right to align the button to the right of the form.

        • Select Center to align the button to the center of the form.

        Retain Space

        Reserve or remove space when the control is hidden.

        • Select Yes to keep space when the control is hidden.

        • Select No to remove space when the control is hidden.

          The default value is No.

        Display Mode

        Show text and/or image for the button.

        • Select Text Only to show only text for the button.

        • Select Image Only to show only image  for the button.

        • Select Text and Image to show both text and image for the button.

          The default value is Text Only.

        Button Size

        Size of the button for the control.

        • Select Standard to set the size of the control to 120 x 32 pixels.

        • Select Small to set the size of the control to 30 x 30 pixels.

        • Select Medium to set the size of the control to 180 x 86 pixels.

        • Select Large to set the size of the control to 280 x 130 pixels.

          The default value is Standard.

        Image Path

        Path to the image for the control.

        The image path is specified as:

        • xxx.

          We recommend the following image sizes when the Display Mode property is set to Image.

        • Small – 30 x 30 pixels.

        • Medium – 180 x 86 pixels.

        • Large – 280 x 130 pixels.

          We recommend the following image sizes when the Display Mode property is set to Text and Image.

        • Small – 30 x 30 pixels.

        • Medium – 40 x 40 pixels.

        • Large – 50 x 50 pixels.

          Note:
          - This property is applicable only when the Display Mode property is set to Image or Text and Image, and the Button Size property is set to SmallMedium or Large.
          - If the Display Mode property is set to Text and Image and the Button Size property is set to Small, then only the image is displayed.

        Image Position

        Position of the image with respect to the text for the control.

        • Select Left to align the image to the left of the text for the control.

        • Select Right to align the image to the right of the text for the control.

        • Select Top to align the image to the top of the text for the control.

        • Select Bottom to align the image to the bottom of the text for the control.

          The default value is Left.

        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.

        • Select Yes to enable the control to show as link.

        • Select No to disable the control to show as link.

          The default value is No.

        Validation

        Property

        Description

        Show Confirmation Message

        Show or hide the confirmation message for the control.

        • Select Yes to show the confirmation message for the control.

        • Select No to hide the confirmation message for the control.

          The default value is No.

        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.

        • Select Yes to show the success message for the control.

        • Select No to hide the success message for the control.

          The default value is No.

        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.

        • Select Asynchronous to deny a user to act on consecutive tasks immediately without navigating to the Inbox.

        • Select Synchronous to allow a user to act on consecutive tasks immediately without navigating to the Inbox.

          The default value is Asynchronous.

        Note:
        - The default timeout for synchronous execution is 20 seconds to ensure optimal performance.

        - When Invoke workflow control is configured to initiate a Quickflow, the Execution Mode is set to Synchronous and is read-only.

        - When the Execution Mode is set to Synchronous, ensure that none of the activities initiated through the Invoke Workflow control have a sleep behavior. For instance, activities like Human or Scheduler activities that enter sleep mode should not be included.

        Close Form

        Allow or deny the system to close the form when the workflow is invoked.

        • Select Yes to allow the system to close the form when the workflow is invoked.

        • Select No to deny the system to close the form when the workflow is invoked.

          The default value is No.

        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.

        • Select Yes to enable the control to act as form button.

        • Select No to disable the control to act as form button.

          The default value is No.

        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.

        TitleResults for “How to create a CRG?”Also Available in