|
Siebel Business Process Framework: Workflow Guide > Reference Materials for Siebel Workflow > Reference of Workflow Process Object Properties >
Reference of Workflow Process Object Definition Properties
Table 100 describes properties for the overall workflow process object definition.
Table 100. Description of Properties for a Workflow Process Object Definition
|
|
|
Auto Persist |
Sets workflow persistence. |
(Optional) YES or NO |
Business Object |
The name of the associated business object. |
(Optional) This value is chosen from a picklist of business objects. Only business objects with a defined primary component appear in this picklist. For more information on defining the primary business component for a business object, see Defining a Primary Business Component for a Business Object . |
Error Process Name |
The name of the workflow process to call as the error process. |
(Optional) Choose from the picklist of predefined workflow processes. |
Group |
This property applies to workflows defined prior to version 7.7. |
(Optional) NOTE: Do not use this property for new workflows you create. Use the Project property instead.
|
Pass By Ref Hierarchy |
Applicable for hierarchal data passed between a sub process and the parent workflow process. If "pass by reference" is checked, then changes made in the child workflow process propagate back to the parent workflow process. When implemented, this feature reduces memory footprint required for a workflow process as data is passed by reference instead of by value. |
(Optional) TRUE or FALSE |
Process Name |
The name of the process. |
(Required) A descriptive name that is:
- Consistent with your overall naming strategy
- Meaningful to the designer of the process
- Unique
|
Project |
The name of the project to which the workflow process belongs. |
(Required) |
Replication Level |
How workflows synchronize to Mobile Web Clients. The All value synchronizes to the server's regional nodes as well as mobile users, whereas the Regional value synchronizes just to the server's regional nodes. |
None, All, or Regional |
State Management Type |
The workflow process state management type. Describes the type of business service requests made while the workflow process is being executed. NOTE: If every service invoked by this workflow process is a stateless business service, then it is recommended the state management type be set to Stateless. Otherwise, it is recommended the state management type be set to Stateful.
The default setting is Stateful. For more information, see State Management Type and Workflow Processes. |
(Required). Possible values include:
- Stateless. Business service method(s) invoked by this workflow process have no dependency on a service-specific state. Choose this setting if the stateful/cached services invoked by this workflow can be released when the workflow pauses or finishes.
- Stateful. Business service method(s) invoked by this workflow process depend on a service-specific state. Choose this setting if the stateful/cached services invoked by this workflow must not be released during and after the execution of the workflow.
|
Status |
The current status of the process. |
(Required). Possible values include:
- Not In Use
- In Progress
- Completed
|
Version |
The version number of the process definition. |
Read-only. The default version is 0. The version number increments by one when you use the Revise button to modify an existing process definition. |
Web Service Enabled |
This property indicates that a business service or workflow is exposable as a Web service and can be called independently. NOTE: Setting this property to TRUE does not automatically implement the workflow Web service, nor does configuring the workflow process for Web service cause the flag to be checked.
|
(Optional) TRUE or FALSE |
Workflow Mode |
The workflow process type. |
(Required). Possible values include:
- 7.0 Flow
- Long Running Flow
- Interactive Flow
- Service Flow
For more information, see About the Workflow Mode Property. |
Note that some of these properties, but not all of them, can be defined by using the Workflow Processes OBLE, or the Properties window in the Process Designer. The Properties window in the Process Designer displays properties based on context. To display properties for the workflow process, right-click in the design canvas, make sure no step or connector is chosen, then choose View > Windows > Properties Window from the Tools application-level menu: State Management Type and Workflow Processes
The OM-session state management framework requires business services to have a defined state management type. A business service must be defined as Stateless or Stateful, or as a Server managed business service. The stateless Workflow Process Manager business service is the workflow engine. The State Management Type property in the Workflow Process Properties window of a workflow process defines whether a workflow process is designed to be stateless or stateful. The Workflow engine can execute a stateful workflow process or a stateless workflow process:
- When a workflow process is defined as Stateless, the OM-session state management framework can release stateful or cached business services invoked by this workflow process when the workflow instance is paused or finished.
- When a workflow process is defined as Stateful, the OM-session state management framework does not release stateful or cached business services invoked by this workflow instance even after the instance is finished. Instead, the framework waits for the caller of the Workflow engine to decide when the cached services must be released. The caller of the Workflow engine can release stateful or cached business services by calling methods from Web Channel Dedicated Block Service.
Defining the Workflow Process State Management Type
By default, the workflow process State Management Type is set to Stateful to preserve the pre-8.1 behavior. However, if a workflow process is designed to be executed through Web Channel, it might be necessary to change the workflow's State Management Type to Stateless to take advantage of the session pooling feature in the OM-session state management framework. Table 101 describes how the Workflow Mode property for a workflow process determines the workflow's State Management Type.
Table 101. Description of How to Set the State Manage Type Property
|
|
|
Service Flow |
Stateless |
Since a service workflow cannot have a User Interact step or Wait step, it is always executed in the workflow's entirety before the object manager session state management framework is given a chance to release the session back to the pool. |
Interactive Flow |
Stateless |
Similar to a long-running workflow, an interactive workflow instance can move between sessions through the Universal Inbox. However, since the State Management Type setting is only relevant when the workflow process is executed through Web Channel, and since an interactive workflow always executes in a user-interactive session, the State Management Type has no effect on the behavior of an interactive workflow. |
Long Running Flow |
Stateless |
The Workflow engine is already designed to allow a long-running workflow to deploy between sessions when a long-running workflow is being paused. NOTE: It is recommended you not configure a long-running workflow to invoke a stateful business service since the service state is lost when a long-running workflow instance moves from one user session to another.
|
7.0 Flow |
Stateful |
Do not change this setting unless you are sure none of the business services the workflow invokes directly or indirectly is a stateful business service. |
For more information on the Web Channel OM-session state management framework, see Siebel Web UI Dynamic Developer Kit Guide.
|
