Siebel CRM Web Services Reference > Primary Web Services for Siebel CRM 8.0 >
ProductConfigurator
The Web service enables queries on information contained within the product model, such as relationships, attributes, linked items, resources, UI groups. The service also allows you to configure a product, and perform multiple batch requests. ProductConfigurator Operations
For a list of operations associated with this Web service, see Table 121.
Table 121. ProductConfigurator operations
|
|
GetCfgObjectStructure |
Retrieves Product Relationships, Attributes, Linked Items and Resources. |
GetCfgObjectGroupItems |
Retrieves the Product UI definition, UI Group and Group items. |
GetCfgObjectDefaultGroupItems |
Retrieves Default Product Group items (group items will be based off all relationships, attributes, linked items and resources). |
BeginConfiguration |
Enables customization of products stored in the Siebel database. Initializes the configurator session with a Quote instance and product model. |
UpdateConfiguration |
Executes operations on the Quote instance initialized in the BeginConfiguration operation. |
EndConfiguration |
Releases server resources used during Begin and Update Configuration operations. |
Request Message Description: GetCfgObjectStructure
GetCfgObjectStructure has the same request and response message. GetCfgObjectGroupItems has the same request and response message. GetCfgObjectDefaultGroupItems request and response message is the same as GetCfgObjectGroupItems. The object's direct child properties are ignored as well those of UIOption, Responsibilities, and Group. Only the GroupItem child is looked at and returned (others are copied to the response message). GroupItem behavior is similar to that of GetCfgObjectGroupItems. For a description of this request message, see Table 122.
Table 122. Request Message Description: GetCfgObjectStructure
|
|
WebChannelObjStructure |
Required. This structure identified the objects that will be queries as well the data that will be returned about the objects. |
Object |
Required. One or more must be specified. |
Name |
Required. Name of Object (product or class). Either Name or Id is required. |
Id |
Required. Id of Object (product or class). Either Name or Id is required. |
ObjectType |
Required. Product or Class. |
ParentClassId |
Class Id of the parent. |
DisplayName |
Display Name. |
Description |
Description. |
Attribute |
Zero or more (only those child objects that are specified will be queried for). |
Name |
Name of attribute. If empty, all attributes are returned. |
LocalType |
Local type. |
InternalType |
Internal type. |
OrigId |
Internal Id. |
DisplayName |
Display name. |
Hidden |
Hidden flag. |
Required |
Required flag. |
ReadOnly |
Read only flag. |
ValidationSpec |
Validation specification. |
UnitOfMeasure |
Unit of measure. |
Description |
Description. |
AttributeDomain |
Zero or more. |
LocalValue |
Local value. |
InternalValue |
Internal value. |
AttributeDomainDecoration |
Zero or more. Attribute domain specific properties name value pairs. |
Name |
Name of object (product or class). Either Name or Id is required. |
Value |
Unique value. |
AttributeDefaultValue |
Default value of the attribute. Only one of the value types will be populated depending on the type of the value. |
DisplayValue |
Display value. |
String |
String value. |
Number |
Number value. |
Integer |
Integer value. |
Date |
Date value. |
Boolean |
Boolean value. |
AttributeRejectedValue |
Rejected value of the attribute. Only one of the value types will be populated depending on the type of the value. |
DisplayValue |
Display value. |
String |
String value. |
Number |
Number value. |
Integer |
Integer value. |
Date |
Date value. |
Boolean |
Boolean value. |
AttributeDecoration |
Zero or more. Attribute properties name value pairs. |
Name |
Name of Object (product or class). Either Name or Id is required. |
Value |
Unique value. |
Relationship |
Zero or more (only those child objects that are specified will be queried for). |
Name |
Name of relationship. If Name and, or Id are specified, only that particular relationship will be returned. If both are empty, all relationships will be returned. |
Id |
Id of relationship. If Name and, or Id is specified, only that particular relationship will be returned. If both are empty, all relationships will be returned. |
DisplayName |
Display name. |
ClassName |
Class name. |
ClassId |
Class Id. |
DefaultProductId |
Default product Id. |
DefaultCardinality |
Default cardinality. |
MinimumCardinality |
Minimum cardinality. |
MaximumCardinality |
Maximum cardinality. |
RelationshipDomain |
Zero or more. |
Name |
Name of product. If Name and, or Id is specified, only that particular relationship domain will be returned. If both are empty, all relationship domain products will be returned. |
Id |
Id of product. If Name and, or Id is specified, only that particular relationship domain will be returned. If both are empty, all relationship domain products will be returned. |
DisplayName |
Display name. |
OrigId |
Original Id. |
Description |
Description. |
RelationshipDomainDecoration |
Zero or more. Relationship domain specific properties name value pairs. |
Name |
Name of Object (product, or class). Either Name or Id is required. |
Value |
Unique value. |
Relationship Decoration |
Zero or more. Relationship properties name value pairs. |
Name |
Name of Object (product, or class). Either Name or Id is required. |
Value |
Unique value. |
LinkedItem |
Zero or more (only those child objects that are specified will be queried for). |
Name |
Name of Object (product, or class). Either Name or Id is required. |
Id |
Id of linked item. If Name and, or Id is specified only that particular linked item will be returned. If both are empty, all linked items will be returned. |
DisplayName |
Display name. |
VariableName |
Variable Name. |
SortSpec |
Sort specification. |
SearchSpec |
Search specification. |
NeedsExecution |
Required for business component based queries. |
Expression |
Expression. |
DefaultValue |
Default Value. |
BusinessObject |
Business object for business component based query. |
BusinessComponent |
Business component for business component based query. |
FieldName |
Field name in business component. |
Active |
Active flag. |
LinkedItemDecoration |
Linked Item Properties name value pairs. |
Name |
Name of the object (Product, or Class). Either Name, or Id is required. |
Value |
Unique value. |
Resource |
Zero or more (only those child objects that are specified will be queried for). |
Name |
Name of resource. If Name and, or Id is specified, only that particular resource will be returned. If both are empty, all resources will be returned. |
Id |
Id of resource. If Name and, or Id is specified, only that particular resource will be returned. If both are empty, all resources will be returned. |
DisplayName |
Display name. |
ResourceDecoration |
Resource properties name value pairs. |
Name |
Name of Object (product, or class). Either Name or Id is required. |
Value |
Unique value. |
ObjectDecoration |
Object properties name value pairs. |
Name |
Name of Object (product, or class). Either Name or Id is required. |
Value |
Unique value. |
Request Message Description: GetCfgObjectGroupItems/ GetCfgObjectDefaultGroupItems
For a description of this request message, see Table 123.
Table 123. Request Message Description:GetCfgObjectGroupItems/GetCfgObjectDefaultGroupItems
|
|
WebChannelObjGroupItems |
Required. This structure identified the objects that will be queries as well the data that will be returned about the objects. |
Object |
Required. One or more must be specified. |
Name |
Required. Name of Object (product, or class). Either Name or Id is required. |
Id |
Required. Id of Object (product, or class). Either Name or Id is required. |
ObjectType |
Required. Product or Class. |
ParentClassId |
ClassId of the parent. |
DisplayName |
Display name. |
Description |
Description. |
UIOption |
Zero or more. |
Name |
Name of the UI option. If Name and, or Id is specified, only that particular UI option will be returned. If both are empty, all UI options will be returned. |
Id |
Id of the UI Option. If Name and, or Id is specified, only that particular UI option will be returned. If both are empty, all UI options will be returned. |
Type |
Type. |
DisplayName |
Display name. |
Sequence |
Sequence. |
BaseTheme |
Base theme. |
ProductTheme |
Product theme. |
Responsibility |
Zero or more. |
Name |
Name of responsibility. If Name and, or Id is specified, only that particular responsibility will be returned. If both are empty, all responsibilities will be returned. |
Id |
Id of responsibility. If Name and, or Id is specified, only that particular responsibility will be returned. If both are empty, all responsibilities will be returned. |
Group |
Zero or more. |
Name |
Name of the group. If Name and, or Id is specified, only that particular group will be returned. If both are empty, all groups will be returned. |
Id |
Id of the group. If Name and, or Id is specified, only that particular group will be returned. If both are empty, all groups will be returned. |
DisplayName |
Display name. |
Sequence |
Sequence. |
GroupTheme |
Group theme. |
Description |
Description. |
GroupItem |
Zero or more. |
Id |
Id of the group item. If Id and, or Type is specified, only that particular group item will be returned. If both are empty, all group items will be returned. |
Type |
Type of the group item (Relationship, Attribute, LinkedItem, or Resource). If Id and, or Type is specified, only that particular group item will be returned. If both are empty, all group items will be returned. |
Sequence |
Sequence. |
GroupItemTheme |
Group item theme. |
Attribute |
Refer to attribute child object in Table 122. |
Relationship |
Refer to Relationship child object in Table 122. |
LinkedItem |
Refer to LinkedItem child object in Table 122. |
Resource |
Refer to Resource child object in Table 122. |
GroupDecoration |
Group properties name value pairs. |
Name |
Name of UI Option. If Name and, or Id is specified, only that particular UI option will be returned. If both are empty, all UI options will be returned. |
Value |
Unique value. |
Object Decoration |
Object properties name value pairs. |
Name |
Name of UI Option. If Name and, or Id is specified, only that particular UI option will be returned. If both are empty, all UI options will be returned. |
Value |
Unique value. |
Request Message Description: BeginConfiguration
For a description of this request message, see Table 124.
Table 124. Request Message Description: BeginConfiguration
|
|
|
BeginConfiguration_Input |
|
Required. |
InitInstanceOperation |
Required. The operation type for BeginConfiguration session. |
LOAD |
This will load the hierarchy object from the Siebel database. HeaderId and RootId are required. IntegrationObjectName is needed to determine which table to query and what the structure of the hierarchy is. |
DEFAULT |
This will load the hierarchy object from the Siebel database and create a new line item for a product with its default instance. HeaderId and ProductId are required. IntegrationObjectName is needed to determine which table to query and what the structure of the hierarchy is. |
SET |
This will load the hierarchy object from the ListOfQuote parameter from the PDS Quote integration object. RootId is required to determine the root line item to use in this session. |
ADD |
This will add a new line item to the hierarchy object from the ListOfQuote parameter from the PDS Quote integration object. ProductId is required. |
HeaderId |
Required for InitInstanceOperation of LOAD / DEFAULT. Row Id of the Header. |
RootId |
Required for InitInstanceOperation of LOAD / SET. Row Id for the root line item. |
ProductId |
Required for InitInstanceOperation of DEFAULT / ADD. Product Id for the root line item. |
ListOfQuote |
Required for InitInstanceOperation of SET / ADD. Hierarchy object in PDS Quote integration object format. See General C/OM Web services for details on its structure. |
ListOfData |
List of products / attributes / relationships on which user requires domain information (with exclusions) in CfgInteractData integration object format. |
ProductData |
Product data. |
Item |
Zero or more. Same recursive structure as that defined in this topic. |
IntegrationId |
Integration Id of the line item. If Ithe ntegration Id specified, only this line item and its sub line items are looked at. ProductId is optional. If the Product Id is also specified, it should match the Integration Id. If Integration Id and Product Id are not specified, the root line item is looked at. |
ProductId |
Product Id of the line item. If the Integration Id is specified, only this line item and its sub line items are looked at. ProductId is optional. If the Product Id is also specified, it should match the Integration Id. If Integration Id and Product Id are not specified, the root line item is looked at. |
Name |
Name of the product. |
Quantity |
Quantity. |
RelationshipName |
Relationship Name. For sub line items, RelationshipName can be specified to limit the search to a particular relationship. |
RootIntegrationId |
Integration Id of the Root line item. |
PortId |
Relationship Id. |
ParentProductId |
Parent product Id. |
ParentIntegrationId |
Parent integration Id. |
CanDrilldown |
Can Drilldown flag. Used to indicate whether the line item is a customizable product. |
ListPrice |
List price. |
HasGenericsFlag |
Has Generics flag. Used to indicate whether the line item is incomplete. |
EligibilityStatus |
Eligibility Status. |
EligibilityReason |
Eligibility Reason. |
Explanation |
Explanation. |
ExplanationText |
Text of explanation. |
Relationship |
Zero or more. List of relationships on which information is required. |
Name |
Name of relationship to query for. If empty, all relationships are returned. |
Id |
Id. Always returned whether specified in the request or not. |
DomainItem |
Zero or more. Domain items of the relationship. Always returned whether specified in the request or not. |
Name |
Name of the domain item. |
Id |
Id of the domain item. |
Excluded |
Excluded flag indicates whether this domain item is excluded by a Constraint, Eligibility & Compatibility rule or Promotion. |
Attribute |
Zero or more. List of Attributes on which information is required. |
Name |
Name of attribute to query for. If empty, all attributes are returned. |
ValueType |
Type of attribute. Always returned whether specified in the request or not. |
AttributeValue |
Zero or more. List of attribute values. Always returned whether specified in the request or not. |
DisplayValue |
Display Value. |
StringValue |
Value displayed in a string. |
IntegerValue |
Value displayed as integer |
NumberValue |
Value displayed as number |
BooleanValue |
Value displayed in Boolean format. |
DateTimeValue |
Date and time value. |
Selected |
Selected Flag indicates whether this value is selected. |
Excluded |
Excluded Flag indicates whether this value is excluded by a Constraint, Eligibility & Compatibility rule or Promotion. |
Item |
Zero or more. Same recursive structure as that defined in this topic. |
ListOfLinkedItems |
List of linked items. |
LinkedItems |
Linked items. |
LinkedItemValue |
One or more. |
Name |
Name of linked item. |
ValueType |
Type of value. |
Response Message Description: Begin Configuration
GetCfgObjectStructure has the same request and response message. See the preceding table for details. GetCfgObjectGroupItems and GetCfgObjectDefaultGroupItems have the same request and response messages. See request message description for details. For a description of this response message, see Table 125.
Table 125. Response Message Description: Begin Configuration
|
|
BeginConfiguration_Output |
Required. |
Error_spcCode |
Error code if an error occurred. |
Error_spcMessage |
Error message if an error occurred. |
RootId |
Root Id of new item. |
RootIntegrationId |
Integration Id of a new root item. |
ListOfQuote |
Quote instance if the ReturnFullInstance input parameter was set to Y. For more details, see Table 124. |
ListOfData |
The domain information about products, attributes, relationships as well as current selections for the attributes, and relationships that were requested in the request message. For more details, see see Table 124. |
ListOfStatus |
This indicates whether the request was successful or not and contains messages to be displayed. |
Status |
Required. |
StatusCode |
Values are: Success, Warning, or Error. The StatusCode of Success indicates a successful configuration. The status code of Warning indicates conflict messages present in the ListOfMessage node, which were automatically resolved. If the status code was Error, then the conflict messages present in the ListOfMessage could not be resolved and further requests to the session will not be honored. |
StatusText |
Details on the error if any. |
ConflictResolution |
Values are Proceed, or Undo. Indicates whether a Proceed or Undo operation was done on the conflicts and also whether there were any other violations that resulted in an Undo (such as Promotion or Cardinality). |
Messages |
Zero or one. List of messages. |
MessageType |
Zero or more. |
MessageSource |
Source of the messages (Eligibility, Promotion, Cardinality, Proceed Actions, and so on). |
Message |
Message text. |
Request Message Description: UpdateConfiguration
For a description of this request message, see Table 126.
Table 126. Request Message Description: UpdateConfiguration
|
|
UpdateConfiguration_Input |
Required. |
ConflictAutoResolve |
Proceed or Undo. If set to Proceed, all conflicts are auto resolved. If set to Undo, any conflict will result in an Undo of the entire batch. |
FinishInstanceInFlag |
If set Y, FinishIt is called. |
SaveInstanceInFlag |
If set Y, Instance is saved to the Siebel database. |
RepriceInstanceInFlag |
If set Y, Reprice is called. |
VerifyInstanceInFlag |
If set Y, the Verify instance is called. |
ListOfData |
See the ListOfData description in Table 124. |
ListOfRequest |
List of requests that will be executed on the product instance. |
Requests |
|
Request |
Zero or more. |
Type |
Type of request (AddItem, RemoveItem, SetItemQuantitty, SetAttribute, ReplaceItem). |
Item |
Zero or more requests. |
AddProductId |
Add product Id for AddItem, ReplaceItem. |
Quantity |
Quantity. |
RelationshipId |
Relationship Id which contains the new product for AddItem, ReplaceItem. |
IntegrationId |
Integration Id on which the operation will be performed. |
Attribute |
Zero or more SetAttribute request details. |
Name |
Name or attribute. |
ValueType |
Value type: string, integer or number. |
AttributeValue |
Zero or more. |
DisplayValue |
New display value of attribute. |
String |
Value displayed in a string. |
Number |
Value displayed as number. |
Integer |
Value displayed as integer. |
Date |
Date and time value. |
Boolean |
Value displayed in Boolean format. |
Response Message Description: UpdateConfiguration
For a description of this response message, see Table 127.
Table 127. Response Message Description: UpdateConfiguration
|
|
UpdateConfiguration_Output |
Required. |
Error_spcCode |
Error Code if an error occurred. |
Error_spcMessage |
Error Message if an error occurred. |
FinishConfigurationOutFlag |
Y / N. Indicates whether Finish Configuration was performed. |
RepriceOutFlag |
Y / N. Indicates whether Reprice was done. |
SaveInstanceOutFlag |
Y / N. Indicates whether Save Instance was done. |
VerifyOutFlag |
Y / N. Indicates whether Verify was done. |
ListOfData |
The domain information about products, attributes, and relationships as well current selections for the attributes / relationships that was requested in the Request Message. For more information, see Table 126. |
ListOfStatus |
This indicates whether the request was successful or not and contains messages to be displayed. For more information, see Table 125. |
Request Message Description: EndConfiguration
For a description of this request message, see Table 128.
Table 128. Request Message Description: EndConfiguration
|
|
EndConfiguration_Input |
Required |
SaveInstanceFlag |
Save Instance flag |
Response Message Description: EndConfiguration
For a description of this response message, see Table 129.
Table 129. Response Message Description: EndConfiguration
|
|
EndConfiguration_Output |
Required. |
Error_spcCode |
Error Code if an error occurred. |
Error_spcMessage |
Error Message if an error occurred. |
ListOfQuote |
Quote instance. For more information, see Table 124. |
ProductConfigurator Application Interface
This topic describes the application objects called by the this Web service. For more information on application implementation, refer to your application development documentation on Oracle Technology Network. Service Object (Business Service or Workflow)
For a description of the service objects for this Web service, see Table 130.
Table 130. ProductConfigurator Service Object
|
|
|
Cfg Object Broker |
Business Service |
CSSCfgObjBrokerService |
ConfiguratorWebChannelBeginConfig |
Workflow |
Not applicable |
ConfiguratorWebChannelUpdateConfig |
Workflow |
Not applicable |
ConfiguratorWebChannelEndConfig |
Workflow |
Not applicable |
Data Object (Integration Object)
For a description of data objects for this Web service, see Table 131.
Table 131. ProductConfigurator Data Object
|
|
CfgInteractData |
ListOfData |
CfgInteractRequest |
ListOfRequest |
CfgInteractStatus |
ListOfStatus |
CfgLinkedItems |
ListOfLinkedItems |
PDS Quote |
ListOfQuote |
Methods
For a description of methods for this Web service, see Table 132.
Table 132. ProductConfigurator Methods
|
|
GetCfgObjectStructure |
GetObjStructure |
GetCfgObjectGroupItems |
GetObjGroupItems |
GetCfgObjectDefaultGroupItems |
GetObjDefaultGroupItems |
Example Package for ProductConfigurator
To view an example of messages for this Web service, navigate to the documentation library for Siebel applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file. Request (GetObjDefaultGroupItems)
See the following file to view the sample code: ...\ProductConfigurator\GetObjDefaultGroupItems_request.xml
Response (GetObjDefaultGroupItems)
See the following file to view the sample code: ...\ProductConfigurator\GetObjDefaultGroupItems_response.xml
Request (GetObjGroupItems)
See the following file to view the sample code: ...\ProductConfigurator\GetObjGroupItems_request.xml
Response (GetObjGroupItems)
See the following file to view the sample code: ...\ProductConfigurator\GetObjGroupItems_response.xml
Request (GetObjStructure)
See the following file to view the sample code: ...\ProductConfigurator\GetObjStructure_request.xml
Response (GetObjStructure)
See the following file to view the sample code: ...\ProductConfigurator\GetObjStructure_response.xml
Message Schema (WSDL) for ProductConfigurator
To view the message schema for this Web service, navigate to the documentation library for Siebel applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file. ...\ProductConfigurator\ProductConfigurator.wsdl
|