Product Administration Guide > Siebel Configurator Workflow and Method Reference > Siebel Configurator Methods Reference >
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 should not be confused with LoadInstance Method, which is part of Complex Object Instance business service. NOTE: The LoadInstance method cannot be used without first calling the LoadEAI method, which is described in the Copy Service reference in Siebel Order Management Infrastructure Guide.
Syntax
LoadInstance <inputArgs>, <outputArgs> Input Arguments
|
|
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 |
CDA Pageset Id |
Used when Cfg Type is eAdvisor |
Cfg Type |
eConfigurator / eAdvisor |
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 should be displayed 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 |
View Name of the Siebel Configurator UI standard interactivity view |
ViewName (JS) |
View Name of the Siebel Configurator UI high interactivity view |
XABusCompName |
XA BC Name |
Output Arguments
|
|
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, CORBA Object Manager, Java Data Bean, Mobile/Dedicated Web Client Automation Server
|