Siebel Business Process Designer Administration Guide > For Developers: Workflow Process Steps > Field Descriptions for Defining Workflow Process Steps >

Field Descriptions: WF Step Branch Applet


NOTE:  A branch can wait for multiple run-time events or a single user event. A branch cannot wait for a mixture of run-time events and user events. Specify only one event for a branch. Only long-running workflows can wait for user events. Never use run-time events in long-running workflows.

Table 7 describes the fields in the WF Step Branch applet.

Table 7.  WF Step Branch Applet Fields
Field
Description
Possible Value

Name

The name of the branch.

The name of the branch must be unique or you will not be able to commit the record.

Type

The type of branch.

The value can be one of the following choices:

Default. This value indicates that if nothing else is satisfied, this branch will be followed. Additionally, if this value is used, any conditions defined for the branch are ignored.

Condition. This value indicates that a condition is defined for the branch.

Connector. Use this value when there is no condition branching involved.

Error Exception. Use this value to define exception handling. This connector type captures system errors, such as an error noting that the Assignment Manager server component is not available. For more information, see Using Exceptions to Handle Errors.

User Defined Exception. Use this value to define exception handling. This connector type captures user-defined errors, such as an error noting that an order being submitted is incomplete. For more information, see Using Exceptions to Handle Errors.

Event Object Type

This field is used when defining a run-time event. The type of object to which the event occurs: an application, an applet, or a business component.

NOTE:  Event Object must be selected if Event Object Type exists.

(Optional)

Application.

Applet.

BusComp.

Event Object

The name of the object (the application, applet, or business component) to which the event occurs.

Required if Event Object Type is specified. This is the name as defined in Tools. The set of objects is different for different object types.

Event

The specific event that happens to the object.

Required if Event Object Type is specified. The set of available events is different for different object types.

Sub Event

An options parameter for the event, used when the object type is BusComp or Applet and the event is InvokeMethod or SetFieldValue. The subevent is the name of the method or business component field to be monitored.

(Optional)

For InvokeMethod, the name of the method being invoked. For SetFieldValue, the name of the field being set.

Event Cancel Flag

Aborts the run-time event after executing the process.

NOTE:  If this flag is not checked, the error "The specialized method <Method Name> is not supported on this business component" will result when running the workflow process.

(Optional)

This flag only applies to events that are cancelable. This flag functions like CancelOperation in scripting.

Expression

User-friendly text for the condition defined for the branch

Read-only

Event Visibility

Controls whether the workflow process waits for run-time events generated locally (that is, within the current session) or by any session.

If the workflow process is persistent, the visibility can be set to Local or Enterprise.

If the workflow process is not persistent, visibility should be set to Local.

NOTE:  Setting Event Visibility to Enterprise means the run-time event occurring anywhere will search for any matching instance. This can cause a negative performance impact, so the Enterprise setting should be used sparingly.

User Event Name

An arbitrary string that denotes the name of a user event.

This can be any string and must be unique within the Siebel enterprise.

NOTE:  Make sure to give the User Event Name field a name that is unique and that is long enough to remain unique across the Siebel enterprise. Example: "Order Placed - Begin Processing Event for Service Request Automation - Version 2"

User Event Storage

The process property that serves as the destination for the payload on the incoming user event.

This value can be any process property except the process property marked as the correlator.

User Event Timeout (Days)

The amount of time, in days, before the event times out.

Numeric value

NOTE:  If the user event is on a wait step, use this parameter. Do not specify a wait duration on the wait step.

Comments

Additional statements relative to the branch.

Free-form text.

Siebel Business Process Designer Administration Guide