25Configurator Workflow and Method Reference
Configurator Workflow and Method Reference
This chapter covers the Siebel workflows used by Siebel Product Configurator, and the methods called by these workflows. It includes the following topics:
Siebel Product Configurator Workflow Reference
Some features of the order management interface are based on Siebel workflows. You can modify these workflows to suit your own business model using Siebel Business Process Designer. For more information, see Siebel Business Process Framework: Workflow Guide.
The following topics cover Siebel Product Configurator workflow:
Configurator Cleanup Workflow
Configurator Cleanup Workflow, shown in the following, releases the memory that was used by complex product data structures when the product was being customized. It is called when the user is done with a configuration session.
Workflow Description.
This workflow does the following:CleanupEAI. Frees the memory used by the EAI data structure. This step calls CleanupEAI Method, which is described in the Copy Service reference in Siebel Order Management Infrastructure Guide.
CleanupInstance. Frees the memory used by the CxObj data structure. This step calls CleanupInstance Method, which is described in the Copy Service reference in Siebel Order Management Infrastructure Guide.
Configurator Load Workflow
Configurator Load Workflow, shown in the following loads the complex product model into memory and displays the Siebel Product Configurator user interface.
Workflow Description.
This workflow does the following:Load Instance. Loads the Product line item data structure through EAI and creates the CxObj memory structure for it. This step calls LoadEAI Method, which is described in the Copy Service reference in Siebel Order Management Infrastructure Guide.
Go to UI. Loads the Siebel Product Configurator user interface for the product.
Configurator Save Workflow
Configurator Save workflow, shown in the following, saves the updated selections for the product that was customized to the line items (database).
Workflow Description.
This workflow does the following:SetupLineNumbers. Sets up the line numbers for the Line Item being customized corresponding to the CxObj. This step calls SetupLineNumbers Method, which is described in the Copy Service reference in Siebel Order Management Infrastructure Guide.
SetupSyncUpsert. Updates EAI operation for performance. This step calls SetupSyncUpsert Method, which is described in the Copy Service reference in Siebel Order Management Infrastructure Guide.
Save Instance. Stores the CxObj to the database using EAI. This step calls StoreEAI Method, which is described in the Copy Service reference in Siebel Order Management Infrastructure Guide.
Configurator Validate Workflow
Configurator Validate Workflow, shown in the following, is used to validate a product model during product administration.
Workflow Description.
This workflow does the following:Go to UI. Loads the Customize UI for the product. This step calls LoadInstance Method.
Configurator External Validate Workflow
Configurator External Validate Workflow, shown in the following, is responsible for releasing the memory used by complex product data structures when the product was being customized. It is called when the user is done with a Customize session.
Workflow Description.
This workflow does the following:CPVE. Frees the memory used by the EAI data structure. This step calls Validate Complex Product From Property Set Method.
Append Messages. Frees the memory used by the CxObj data structure. This step calls AppendMessages Method.
Siebel Product Configurator Methods Reference
The following topics cover the methods that are called by the Siebel Product Configurator Workflows:
Siebel Product Configurator workflows also use many methods that are described in the Copy Service reference in Siebel Order Management Infrastructure Guide.
LoadInstance Method
LoadInstance method is invoked on the Cfg UI Service to display Customize UI. It calls LoadInstance on Complex Object Instance Service to initialize the instance service with CxObj created in the LoadEAI step. The instance service also validates the CxObj against the product definition from Cfg Broker. It also does Promotion validation and Eligibility & Compatibility violation checks. The session with the Rule engine evaluator (ILOG) is also initialized if needed. The UI Service gets the updated CxObj representation from Instance Service and displays the UI based on the product model definition.
This method is part of the Cfg Web UI Service Loader business service. It must not be confused with LoadInstance Method, which is part of Complex Object Instance business service.
Syntax
Load Instance <inputArgs>, <outputArgs>
Input Arguments
| Input Argument | Description |
|---|---|
AutoSync |
Sync the changes to the CxObj to the DB made during LoadInstance (due to product model definition changes and so on) |
Business Component Name |
Item BC Name |
BusObjName |
Business Object name |
Cfg Type |
eConfigurator |
ChangeView |
If set to Y, the Customize UI view will be displayed |
ComplexProdutId |
Root Product Id |
Currency Code |
Currency Code |
DISABLEPRICER |
If set to Y, pricing workflows are not called |
DonotStartNewSession |
If set to Y, StartNewSession is not called on Instance Service |
Exchange Date |
Exchange Date |
HeaderBusCompName |
Header BC Name |
InstanceName |
A string indicating the name of the instance |
IntegrationObjName |
Integration Object for loading the Line Items |
Mode |
Quote / Order / Agreement / Asset |
NewRecord |
If set to Y, default instance will be created |
Notify List |
The list of business components that need to be notified when the Customize session is finished |
ParentObjId |
Quote Id / Order Id / Agreement Id / Asset Id |
PriceListId |
Price List associated with this line item or Quote |
Refresh List |
The list of business components that need to re-executed when the Customize session is finished |
ReturnViewName |
View that displays when the Customize session is finished |
RowId |
Root Line Item Id |
SearchSpec |
Set this parameter to filter out all other hierarchical instances in the child buscomp |
SkipCfgEligibilityCheck |
If set to Y, the eligibility check will be skipped |
SkipLoadingDefaultInstance |
If set to Y, the default instance will not be loaded during New Record |
Start Date |
Date to use for Broker StartNewSession |
Sub Line Item Integration Id |
Needed when customizing sub line items |
Sub Line Item Product Id |
Needed when customizing sub line items |
TriggerEvent |
If set to Y, trigger the Initialize script event after LoadInstance is done |
Type |
CxInstService |
UIOption [optional] |
UI option name |
ValidateMode |
If set to Y, it indicates that a validation is being performed (no sync when done) |
ViewName (JS) |
View Name of the Siebel Product Configurator Open UI view |
XABusCompName |
XA BC Name |
Output Arguments
| Input Argument | Description |
|---|---|
CxObj |
The property set corresponding to the CxObj data structure in Instance service. |
Usage
LoadInstance method is invoked on the Cfg UI Service to display the Customize UI. It calls LoadInstance on Complex Object Instance Service to initialize the instance service with CxObj created in the LoadEAI step.
Invoked From
Browser Script, COM Data Control, COM Data Server, Server Script, Java Data Bean, Mobile/Developer Web Client Automation Server
Validate Complex Product From Property Set Method
Validate Complex Product From Property Set method runs validations against a given record set captured in the form of a property set.
This method is part of the VORD CPVE Validation business service.
Syntax
Validate Complex Product From Property Set <input Args>, <output Args>
Input Arguments
| Input Argument | Description |
|---|---|
IdFieldName |
Identifier Field Name. For example, Asset Integration Id |
RecordSet |
Property Set |
RootProductId |
Id of the Root Complex Product |
Output Arguments
| Output Argument | Description |
|---|---|
Messages |
A property set containing the list of messages to display |
Integration Object |
This integration object name is SIS OM Quote, SIS OM Order, or SIS OM Asset. |
Usage
Validate Complex Product From Property Set method runs validations against a given record set captured in the form of a property set.
Invoked From
Browser Script, COM Data Control, COM Data Server, Server Script, Java Data Bean, Mobile/Developer Web Client Automation Server
AppendMessages Method
AppendMessages displays the messages on the Customize UI.
This method is part of the Siebel Product Configurator business service.
Syntax
Append Messages <inputArgs>, <outputArgs>
Input Arguments
| Input Argument | Description |
|---|---|
Messages |
A property set containing the list of messages to display |
Usage
AppendMessages displays the messages on the Customize UI.
Invoked From
Browser Script, COM Data Control, COM Data Server, Server Script, Java Data Bean, Mobile/Developer Web Client Automation Server