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

About the Workflow User Event Service Business Service


The Workflow User Event Service business service is used for one-way communication from the Siebel client to the Workflow Process Manager server component to send notification that a user event has occurred.

A User event can be generated anywhere in the Siebel enterprise, wherever a Siebel business service is used, by calling the Workflow User Event Service business service.

To trigger a long-running flow to be run in WFProcMgr, you must send a notification.

For usage information, see About the User Event.

This service has one method, GenerateEvent. Table 84 describes GenerateEvent method arguments.

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

UserEventName

The name of a user event is an agreement between the creator, an external entity, and the recipient, the workflow definition.

It has no special significance, except that the incoming event name and the workflow instance definition must specify exactly the same user event name to successfully communicate with each other. A user event name must be unique.

It is recommended to logically name user the event to reflect the business purpose it serves. For example, Event Transferring Send Order Confirmation from Vitira To Siebel-V2.

CorrelationValue

Used to match an incoming message with a workflow instance using business data such as an order number.

Correlation is the process of matching an incoming message with a workflow instance using business data such as an order ID. When a workflow process communicates with an external entity the external entity many not be aware it is communicating with a workflow process. In such cases, it is difficult for the external entity to use a Siebel identifier, such as the workflow process instance Id, to identify the recipient. It is more convenient to use business data, such as an order number, to identify the recipient. The correlator serves this purpose. Correlation applies to user events reaching a long-running workflow, which can specify a process property as a correlator.

NOTE:  Only one process property can be used as a correlator.

<Value> (Payload)

When the user event is created, the user can specify data as payload. This data is delivered to the workflow instance that receives the event. When the workflow is defined to wait for a user event, the definition can specify a process property to receive this payload data. The payload is a single value. Only one payload can be passed.

NOTE:  If your situation calls for sending complex or structured data, it is recommended you use the XML converter to convert the data into an XML document, then pass the resulting XML string as the payload of the event. The receiving workflow can then call the XML converter again to recover the original data structure.

Siebel Business Process Framework: Workflow Guide Copyright © 2008, Oracle. All rights reserved.