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

AVEVA™ Work Tasks

Associate workflow with Message Queue

  • Last UpdatedDec 17, 2025
  • 2 minute read

Use the Associate option to associate a workflow with Message Queue.

To associate a workflow with Message Queue for a specific connection:

  1. Select the workflow, and then click Associate from the ribbon.

    Alternatively, select and right-click the workflow, and then select Create Associations.

  2. Click Message Queue to associate the workflow with the Message Queue.

  3. Select the name of the Message Queue connection from the Connection list.

    The following fields appear based on the Binding Type selected for the Connection:

    Binding Type for Connection

    Field Name

    Description

    WM Object

    Message Type

    Enter the message type that needs to be listened from Message Queue.

    XML

    XPath

    Enter the XPath for the XML Message. For example,
    /CATALOG/PLANT[1]/PRICE/text()

    XPath Value

    Enter the XPath Value for the XML Message. For example, $2.44

    XML Schema

    Enter the XML Schema for the XML Message.

    For example, see XML Schema Example.

    JSON

    JSON Path

    Enter the JSON Path for the JSON Message. For example, topping[3].type

    JSON Path Value

    Enter the JSON Path Value for the JSON Message. For example, Powdered Sugar

    JSON Sample

    Enter the sample for the JSON Message. For example, see JSON Sample Example.

  4. Click Save to associate the workflow with Message Queue for that specific connection.

The Workflow is triggered based on only message type, irrespective of the queue or connection to which it is associated. Hence, the message type must be unique through out the repositories configured.

Example:

  1. Create Message Queue Connection in machine1 with queue name as Q1 and machine2 with queue name Q2.

  2. Associate the workflow to the connection created in the above step and message type M1.

  3. Publish the message in Message Queue queue Q2 with message type M1.

    The Workflow will be triggered, even if it is not from the queue or machine configured in the Message Queue Connection.

    Notes:
    - JSON of array type without a root node is not supported for Associating Workflow with Message Queue. To support this, the JSON should be embedded inside a root node.

    For example:

    The following JSON of array type without a root note is not supported:
    [{
    "Data1": false,
    "Data2": 12,
    "Data3": 54657.66
    }, {
    " Data1": true,
    " Data2": 45,
    " Data3": 4576
    }]


    The above JSON sample can be modified as below to be supported:
    {
    "DataParent":
    [{
    "Data1": false,
    "Data2": 12,
    "Data3": 54657.66
    }, {
    " Data1": true,
    " Data2": 45,
    " Data3": 4576
    }]
    }


    - The associated Workflow may get executed even though the JSON or XML schema of the message received by the queue does not match the schema specified in the association. In such scenario, the Xml Variable may not be in the correct format.

    - RMQEventData is the XML variable that gets created on associating to Message Queue Association.

    - Associating multiple versions of same workflow to different Message Queue associations is not recommended.

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