Siebel Business Process Framework: Workflow Guide > Reference Materials for Siebel Workflow > Reference of Workflow Process Object Properties >

Reference of Workflow Step and Connector Properties


This topic provides property descriptions of the various step types used in Siebel Workflow.

Table 102 describes properties of a workflow process step.

Table 102. Description of Properties of a Workflow Step
Property
Type of Step
Description
Possible Value

Name

All

The name of the step.

A descriptive name that is:

  • Consistent with your overall naming strategy
  • Meaningful to the designer of the process
  • Unique

When you create a new step, the step is automatically assigned a name, based on the step's type, and a sequence number. You can change this name or leave it as is. For more information, see About Naming a Process Step or Process Property.

Type

All

The type of step.

This value is automatically entered when you create the step in the Process Designer view. This is a read-only property.

Business Component

Siebel Operation

Required. The business component that performs the action you specify.

Choose from a list of business components that have been defined for the chosen business object.

Business Service Name

Business Service

The name of the service to invoke.

The picklist displays business services existing in Siebel Tools with the Hidden flag set to FALSE.

For more information, see Making a Business Service Visible to a Workflow Process.

Business Service Method

Business Service

The name of the method to invoke on the service.

The picklist displays methods defined for the chosen business service.

Subprocess Name

Sub Process

The name of the Sub Process step.

A descriptive name that is:

  • Consistent with your overall naming strategy
  • Meaningful to the designer of the process

Error Code

Stop

A number associated with a string in the database that comprises the error message.

Numeric value.

Error Message

Stop

A string in the database that comprises the error message.

Text string.

User Interact View

User Interact

The name of the view for the user interact step.

Choose from a picklist containing predefined view names.

Operation

Siebel Operation

The type of operation.

The possible values are:

  • Delete
  • Insert
  • NextRecord
  • PrevRecord
  • Query
  • QueryBiDirectional
  • Update
  • Upsert

Maximum Iterations

Wait

The maximum number of times you can execute this step within a process instance.

When the maximum number of iterations is reached, an Object Manager error is generated and the workflow process returns an In Error status. If you need the process to run to completion, you must use a Workflow exception mechanism, such as an error process or exception branch, to catch and handle the error. For more information, see Using an Error Exception to Handle Errors.

Description

All

A text narrative describing the purpose of the step.

Free form text.

Comments

All

A text narrative describing the purpose of the step.

Free form text.

Update Snapshot

All

This parameter is used for recovery. Update Snapshot indicates that when the process reaches this step, Workflow takes a snapshot of the process state, so that if there is a system failure, you can recover the state.

Check mark.

Processing Mode

Wait

The mode in which the process is run when triggered by a run-time event. For more information, see About the Wait Step Processing Mode Property.

(Optional)

Local Synchronous. Executes the process in the application object manager. This is the default.

Remote Synchronous. Submits a synchronous request to the Workflow Process Manager server component to execute the process.

Remote Asynchronous. Submits an asynchronous request to the Workflow Process Manager server component to execute the process.

Table 103 describes properties for the Start step.

Table 103. Description of Properties of the Start Step
Start Properties
Expected Value

Comments

(Descriptive text.)

Description

(Descriptive text.)

Inactive

FALSE

Name

Start

Parent Name

Workflow name:version

Processing Mode

Local Synchronous (or can be empty)

Table 104 describes properties for the Business Service step.

Table 104. Description of Properties of the Business Service Step
Business Service Property
Expected Value

Allow Retry Flag

FALSE

Business Service Name

(Choose the business service name from the picklist.)

Business Service Method

(Choose the business service method from the picklist.)

Comments

(Descriptive text.)

Description

(Descriptive text.)

Inactive

FALSE

Name

Business service 0 (You can modify this value, as necessary.)

Parent Name

Workflow name:version

Table 105 describes properties for the Decision Point step.

Table 105. Description of Properties of the Decision Point
Decision Point Properties
Expected Value

Comments

(Descriptive text.)

Description

(Descriptive text.)

Inactive

FALSE

Name

Decision Point 0 (You can modify this value, as necessary.)

Parent Name

Workflow name:version

Table 106 describes properties for the Sub Process step.

Table 106. Description of Properties of the Sub Process Step
Subprocess Properties
Expected Value

Comments

(Descriptive text.)

Description

(Descriptive text.)

Inactive

FALSE

Name

Sub Process 0 (You can modify this value, as necessary.)

Sub Process Name

(Choose the subprocess name from the picklist.)

For a subprocess to appear in this picklist of defined workflow processes, the subprocess must have a status of Complete.

Table 107 describes properties for the Siebel Operation step.

Table 107. Description of Properties of the Siebel Operation Step
Siebel Operation Properties
Expected Value

Allow Retry Flag

FALSE

Business Component

(Choose the business component name from the picklist.)

Comments

(Descriptive text.)

Description

(Descriptive text.)

Inactive

FALSE

Name

Siebel Operation 0 (You can modify this value, as necessary.)

Operation

(Choose the operation from the list.)

Parent Name

Workflow name:version

Table 108 describes properties for the Task step.

Table 108. Description of Properties of the Task Step
Task Properties
Expected Value

Comments

(Descriptive text.)

Description

(Descriptive text.)

Inactive

FALSE

Name

Task 0 (You can modify this value, as necessary.)

Task Name

(Choose the task name from the picklist.)

Table 109 describes properties for the User Interact step.

Table 109. Description of Properties of the User Interact Step
User Interact Properties
Expected Value

Comments

(Descriptive text.)

Description

(Descriptive text.)

Inactive

FALSE

Name

User Interact 0 (You can modify this value, as necessary.)

Parent Name

Workflow name:version

User Interact View

(Choose the view name from the picklist.)

Table 110 describes properties for the Wait step.

Table 110. Description of Properties of the Wait Step
Wait Properties
Expected Value

Business Service Method

Sleep

Business Service Name

Workflow Utilities

Comments

(Descriptive text.)

Description

(Descriptive text.)

Inactive

FALSE

Maximum Iterations

 

Name

Wait 0 (You can modify this value, as necessary.)

Parent Name

Workflow name:version

Table 111 describes properties for the Stop step.

Table 111. Description of Properties of the Stop Step
Stop Properties
Expected Value

Comments

(Descriptive text.)

Description

(Descriptive text.)

Error Code

(Choose the error code from the picklist.)

Error Message

(Once the Error code is chosen the Error message is automatically populated.)

Name

Stop 0 (You can modify this value, as necessary.)

Parent Name

Workflow name:version

Table 112 describes properties for the End step.

Table 112. Description of Properties of the End Step
Stop Properties
Expected Value

Comments

(Descriptive text.)

Description

(Descriptive text.)

Inactive

FALSE

Name

End 0 (You can modify this value, as necessary.)

Parent Name

Workflow name:version

Table 113 describes properties for the workflow Connector.

Table 113. Description of Properties of the Workflow Connector
Property
Description
Possible Value

Name

The name of the connector.

The connector name must be unique to the workflow process. If it is not unique, you cannot commit the record.

Type

The type of connector.

Type can have one of the following values:

Default. Indicates that if no other conditions are satisfied, this connector is followed. Also, if Default is used, conditions defined for the connector are ignored.

Condition. Indicates that a condition is defined for the connector.

Connector. Indicates there is no condition branching involved.

Error Exception. Indicates there is error exception handling. Error Exception captures system errors, such as an error noting that the Assignment Manager server component is not available. For more information, see Using an Error Exception to Handle Errors.

User Defined Exception. Indicates there is user-defined exception handling. User Defined Exception captures user-defined errors, such as an error noting that an order being submitted is incomplete. For more information, see Using an Error Exception to Handle Errors.

Event Object Type

Describes the type of object on which a run-time event occurs.

NOTE:  Event Object must be chosen if Event Object Type is defined.

(Optional)

Application.

Applet.

BusComp.

Event Object

The name of the object to which the event occurs.

Required if Event Object Type is specified. This is the name as defined in Tools.

Event Object is context-sensitive, depending on the value in Event Object Type. For example, if Event Object Type is set to BusComp, then Event Object specifies the business component, such as Account.

Event

The specific event that happens to the object.

Required if Event Object Type is specified. The set of available events is context-sensitive, depending on the value in Event Object Type.

Subevent

The name of the method or business component field to be monitored.

(Optional)

Used when the object type is BusComp or Applet and the event is InvokeMethod or SetFieldValue.

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 following error results when the workflow process is run: The specialized method [Method Name] is not supported on this business component.

(Optional)

This flag only applies to events that can be canceled. This flag works similar to CancelOperation in scripting.

Expression

User friendly text for the condition defined for the connector.

Read-only

Event Visibility

Controls whether the workflow process waits for a run-time event generated within the current session, or by other sessions.

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

NOTE:  If the workflow process is not persistent, it is recommended that visibility be set to Local.

In most cases where a workflow needs to wait for an event, the workflow must be persistent, and you set the value to Enterprise. However, setting Event Visibility to Enterprise can have a negative performance impact, because a run-time event searches for a matching instance. Therefore, it is recommended that if your workflows do not have to be persistent, that you set Event Visibility to Local.

User Event Name

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

This can be a string but it must be unique within the Siebel enterprise.

Make sure you define a unique name on the User Event Name field. Also, make sure the name is sufficiently long so that it remains unique across the Siebel enterprise. For 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 a process property. The process property must be marked as the correlator.

User Event Timeout (Days)

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

Numeric value.

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

Comments

More statements relative to the connector.

Free form text.

Table 114 describes properties for the Error Exception.

Table 114. Description of Properties of the Error Exception
Error Exception Properties
Expected Value

Comments

(Descriptive text.)

Inactive

FALSE

Name

Error Exception 0 (You can modify this value, as necessary.)

Parent Name

(From step name)

Type

Error Exception

User Event Name

(Leave this field empty.)

User Event Storage

(Leave this field empty.)

User Event Timeout

0

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