Siebel Business Process Framework: Workflow Guide > Reference Materials for Siebel Workflow > Predefined Business Services >

Workflow User Event Service Business Service


Siebel CRM uses the Workflow User Event Service business service for one way communication from the Siebel client to the server component for the Workflow Process Manager. It sends notification that a user event occurred. Siebel CRM can call the Workflow User Event Service business service to create a user event in the Siebel Enterprise. This business service includes the GenerateEvent method. For more information, see Configuring a User Event.

Table 80 describes arguments for the GenerateEvent method.

Table 80. Arguments of the GenerateEvent Method of the Workflow User Event Service Business Service
Argument
Description

UserEventName

The name of a user event is an agreement between the creator, which is an external entity, and the recipient, which is the workflow process. It includes no special significance. To successfully communicate with each other, the incoming event name and the workflow instance definition must use exactly the same user event name. The user event name must be unique.

It is recommended that you name the event so that it reflects the business purpose that it serves. For example:

Event Transferring Send Order Confirmation from Vitira To Siebel V2

CorrelationValue

Uses business data, such as an order number, to match an incoming message with a workflow process instance. If a workflow process communicates with an external entity, then the external entity might not be aware it is communicating with a workflow process. In this situation, it is difficult for the external entity to use a Siebel identifier to identify the recipient, such as the instance Id of the workflow process. It is more convenient to use business data to identify the recipient, such as an order number. The correlator serves this purpose. Correlation applies to a user event that reaches a long-running workflow process, which can define a process property as a correlator.

Siebel CRM can use only one process property as a correlator.

Value (Payload)

If Siebel CRM creates the user event, then it can use data as payload. It delivers this data to the workflow process instance that receives the event. If you configure this workflow process to wait for a user event, then a process property can receive this payload data. The payload is a single value. Siebel CRM can pass only one payload.

If you must configure Siebel CRM to send complex or structured data, then it is recommended that you use the XML converter to convert the data into an XML document, and then pass the resulting XML string as the payload of the event. The receiving workflow process can then call the XML converter again to recover the original data structure.

Siebel Business Process Framework: Workflow Guide Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.