Setting the target for a UCA message event

Draft comment:
This topic is shared by BAW, CP4BA, CP4BASaaS. Last updated on 2025-01-20 10:38

Draft comment:
This topic was viewed 58 times since its publication

While you are configuring a message end event or intermediate message send event in a process or configuring a message event in a service flow, you can control which snapshots receive the event. You can override the default target behavior by selecting a Target current snapshot check box in the implementation settings for the message event.

You can include an intermediate message event in your process or BPD when you want to model a message event that is sent or received while a process is running, or you can use a start event to receive a message event or use an end event to send a message event.

In workflow server, the default behavior for intermediate incoming message events is that they are received by all snapshots in all process applications that refer to the undercover agent and that have event message properties that match the correlation values. However, in Workflow Center, the default behaviour for incoming message events is that they are only received by the current (TIP) snapshot.

Important:

In environments with multiple active snapshots, if Target current snapshot is not selected, message events can be received by any snapshot that references the undercover agent and matches the correlation values. If a customer-defined business object used in the message event is modified between snapshots (for example, properties are added, removed, or renamed), earlier snapshots might not be able to process payloads created by later snapshots.

This mismatch can cause deserialization errors at run time, such as CWLLG2229E: Attempt to deserialize element of complex type '<BO-name>' failed because the property '<property-name>' does not exist. To avoid this issue, select Target current snapshot when business objects might change, or ensure that changes are backward compatible across snapshots.

For start message events, the default behavior is that they are used on the tip in Workflow Center and in the default snapshot on the workflow server.

In workflow server, you can change the default behavior when you are configuring the undercover agent for a message event in your process or service flow, by clicking the Target current snapshot check box in the Event Properties section. If you select the check box, at run time start message events are targeted in the same snapshot of the process application that contains the process, BPD, or service that sends the message event. If the process, BPD, or service of the sending message event is in a toolkit, the snapshot of the process application (which is the root container) is used.

When the check box is selected, you are limiting the responding listener to the start message event and to the intermediate incoming message events in that specific process application snapshot.