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

AVEVA™ Work Tasks

TABLE OF CONTENTS

Set Workflow Output Variable

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedJun 21, 2024
  • 5 minute read

Activity description

The Set Workflow Output Variable activity can be used to set the output of the parent workflow from the child workflow.

Note: Alphanumeric, space, and dot are the only supported characters for workflow output variable.

Activity Properties

The Set Workflow Output Variable activity has to be configured by specifying appropriate values for the different properties in the Activity Properties area. The Activity Properties can be accessed by clicking on the Activity Properties tool in the tool bar or by selecting the appropriate option from the right-click menu for the Set Workflow output variable activity. The Activity Properties are organized under the following groups of related properties. The properties under each group are described in this topic.

Name & Description

You can use these properties to specify the name and description for the activity.

Name - This property can be used to specify a name for the activity.

Property Type: Optional (This property needs to be set only if necessary.)

Description - This property specifies a brief description to be displayed for the activity.

Property Type: Optional (This property needs to be set only if necessary.)

Configuration

You can use this property to configure the functionality of the activity.

Set Workflow Output - This property specifies the output of the workflow. You can specify the output value directly here or click the icon to open the Expression Builder and build an expression for the output.

Property Type: Mandatory (This property must be set if the activity is to be executed.)

Looping Behavior

The property in the Looping Behavior group has been described below. You can use this property to specify the looping behavior of the activity.

Loop through this action if output is - This property is used to specify the condition for looping the activity by selecting an activity output from the drop down.

Property Type: Optional (This property needs to be set only if necessary.)

Activity outputs

The Set Workflow output variable Activity returns the output value set in the Set Workflow Output property.

Example for setting Workflow Output Variable

  1. Design a workflow as shown in the below figure and name it as ChildWF.

  2. Perform the following actions:

    1. In the Start Activity, declare two variables Value and ParentWorkflowOutput as String.

    Note: The user must declare a same variable name in the child workflow which was declared for the Parent workflow. In the above example, user must declare by the name "ParentWorkflowOutput" of type "String" in the child workflow.

    1. In the Set Variable property of Update Variable set the value of variable Value as 1 as shown in the figure.

    2. On the link connecting Update Variable and Rule activity set the output as Updated.

    3. In the Configuration property of Rule, set the condition [Variable.Value]>["5"] as shown in the below figure.

    4. On the link connecting Rule and SetWorkflowOutputVariable2 Activity set TRUE.

    5. In the Set workflow output property of SetWorkflowOutputVariable2 Activity set it as Greater as shown in the following figure.

    6. On the link connecting Rule and SetWorkflowOutputVariable1 Activity set FALSE.

    7. In the Set workflow output property of SetWorkflowOutputVariable1 Activity set it as Lesser as shown in the following figure.

  3. Design a workflow as shown in the below figure and name it as ParentWorkflow.

  4. Perform the following actions:

  1. In the Repository property of Workflow Activity, enter Repository Name. For Example: SamRep.

  2. In the Workflow property of Workflow Activity, select Previously created Workflow Name. For Example: ChildWorkflow.

  3. In the Wait for the Child Workflow property, select "YES".

  4. In the Execution Mode property, select "Asynchronous".

  5. In the Return Values property of Workflow Activity:

    • Click Add Row and enter as "Greater"

    • Click Add Row and enter as "Lesser"

    • Click Update to save and click Close to close the window.

  6. In the property LogType of Logger1, select Information.

  7. In the Log Message of Logger1, enter as the following:

    '################ Lesser'

  8. In the link connecting Logger1 and Workflow Activity1 set Lesser as output.

  9. In the property LogType of Logger2, select Information.

  10. In the Log Message of Logger2, enter as the following:

    '################ Greater'

  11. In the link connecting Logger2 and Workflow Activity1, set Greater as output.

Summary : When you publish the parent workflow, the child workflow is also triggered and the path selected after the Rule activity is stored in the variable "ParentWorklfowOutput". The output of child workflow can be traced in the parent workflow.

Output: The ParentWF is published, and the workflow1 Activity invokes the ChildWF. Value of the variable Value is set to 1 in Update Variable Activity.

Since the value of Variable value is less then five, the rule activity output is False. so the Set Workflow Output Variable2 is executed and the control is passed to the ParentWF. The value updated in Parent Workflow variable is Lesser and hence the output of the Workflow Activity is Lesser and the Logger1 is executed.

Start Activity in BAM

Parent Workflow in BAM:

Child Workflow in BAM

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in