Open topic with navigation

TIBCO Business Studio™ - BPM Edition 5.4.0

# Creating Payload Data for Global Signals

You can define either normal or correlation payload data for global signals.

Normal payload data is simply process data that is passed from the throw signal event to the catch signal event.

Correlation payload data is used to match waiting catch signal event process instances to specified process instances.

For example, a catch global signal might have a correlation payload parameter of 'Invoice Number'. When the catch is initiated, the current value of 'Invoice Number' for that process instance becomes the 'key' on which the signals are matched. The throw global signal maps a value to the 'Invoice Number' correlation payload parameter, and the system finds the corresponding process instance for the catch global signal that was initiated with that same value.

After defining the payload data in your global signal definition project using the procedure below, the global signal throw and catch events in your process map to this payload data. On the throw signal event, use Map To Signal to map process data to the defined payload data. On the catch signal event, use Map From Signal to map from the defined payload data to process data. For more information, see Throw and Catch Signal Events.

Note: Correlation data payload changes are not permitted on global signal definition project upgrade. Therefore, signal correlation parameters cannot be changed unless the major version is changed. You must take care to ensure that only valid changes are made. If you upgrade a global signal definition project, any changes you have made to a BOM class referenced by a payload data parameter are not validated against.

Procedure
1. On the Global Signals panel, select the global signal you want to add payload data for.
2. On the Payload Data panel, select PayloadData.
3. On the Properties pane General tab, use the Use for Signal Correlation selection to specify whether you are defining normal or correlation payload data, as follows:
   Select Use for Signal Correlation to define correlation payload data.
   Deselect Use for Signal Correlation to define normal payload data.
4. If you are defining normal payload data, specify whether the payload data is mandatory or optional by selecting or deselecting the Mandatory check box. (The Mandatory check box is not visible if you are defining correlation payload data, as it is always mandatory.)
5. In the Type section, specify the appropriate type information for the payload data, depending on the process data it is mapped to.

Did you find this helpful?

Yes No
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO Business Studio™ - BPM Edition

Copyright © 2015-2023. Cloud Software Group, Inc. All Rights Reserved.