MessageStep workflow step

A MessageStep is a special-purpose step designed to support messaging-based integrations. It automatically generates and sends a single integration message and then stops the workflow until the message completes. (Typically, this is through receipt of an ack return message.) After the message completes, the workflow resumes automatically.

The Workflows editor indicates an message step with a mail icon in the box the represents that step.


Mail icon.

Just before running the Enter block, the workflow creates a new message and assigns it to Workflow.Message. Use the Enter block to set the payload for the message. After the Enter block finishes, the workflow commits its bundle and stops. This commits the message. At this point, the messaging subsystem picks up the message and dispatches it.

If something acknowledges the message (either internal or external), PolicyCenter stores an optional response string (supplied with the ack) on the message in the Response field. PolicyCenter then does the following:

  • It copies the message into the MessageHistory table
  • It updates the workflow to null out the foreign key to the original message and establishes a foreign key to the new MessageHistory entity.

It then resumes the workflow (by creating a new work item).

There can be any number of GO branches that leave a message step (but only GO branches). As with AutoStep Workflow Step, the workflow evaluates each GO condition, and chooses the first one that evaluates to true. If none evaluate to true, the workflow takes the branch with no condition attached to it.

Create a message workflow step

Procedure

  1. Right-click in the workflow workspace, and select New MessageStep.
  2. Enter the following fields:

    Field

    Description

    Step ID

    ID of the step to create.

    Destination ID

    ID of the destination for the message. This must be a valid message destination ID as defined through the Studio Messaging editor.

    EventName

    Event name on the message.

    ID

    ID of a branch leaving this step. It defaults to the To value if you do not supply a value.

    To

    ID of the step to which the workflow goes if the condition specified for this branch evaluates to true.

    For example:

    Step ID

    Step4

    Dest ID

    89

    Event Name

    EventName

    ID

    To

    DefaultOutcome

  3. Click on your newly created step. It is possible that there are additional tabs to fill out in the properties area at the bottom of the screen.

What to do next

See also