20Product Data Service and Import Export API Reference
Product Data Service and Import Export API Reference
This chapter covers the Product Data Service API and the ISS Authoring Import Export Business Service. It includes the following topics:
About the Product Data Service API
The Product Data Service API allows you to use the catalog, product selection, and product search capabilities of the Siebel Business Application without using the Siebel Business Application user interface.
These APIs give you complete flexibility to build the user interface. You can use your own tool to design the user interface. Your user interface is completely independent of the Siebel Business Application user interface, but you can use these APIs to call all the functionality that the Siebel Business Application uses to work with products, including eligibility and catalog search.
Product Data Services API Architecture
The Product Data Service API is provided as Siebel business services and workflows inside the Siebel Business Application. The Siebel Web Services Framework can consume a WSDL document and create a proxy business service to publish Siebel business services and workflows as Web Services. Once published as Web Services, all the external applications are able to access these product selection APIs through supported protocols (HTTP, MQ, and so on) by exchanging XML messages.
In the Siebel Business Application, the Data Services API includes:
Data Services API Methods. These methods allow you to access Siebel Data, such as Catalog, Categories, Products, Product Details, Favorites, Quote, and Order. They are based on the core Data Sync service (CSSEAIDataSyncService).
Workflows. Workflows use these methods to add an asset to a quote or order, modify or disconnect asset from quote or order, and get projected assets without any use of the user interface.
This architecture is shown in the following figure.
Product Data Services API Methods Reference
The Product Data Service APIs include the following methods:
Catalog API:
Product Details API
Search API
Add Favorite API
Quote / Order API
GetCatalogs Method
Gets a list of catalogs for a given user name and context information. External.
Syntax
Product Data Service.InvokeMethod(“GetCatalogs", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
Hierarchy: SiebelMessage (Integration object PDS Catalog Interface) |
Output Arguments |
Out |
Hierarchy: SiebelMessage (Integration object PDS Catalog Interface) |
Properties of Input Arguments
| Property | Type | Value | Description |
|---|---|---|---|
SiebelMessage |
Integration Object |
PDS Catalog Interface |
None. |
Example of Input Arguments
PropertySet@0012C868 p#0 c#1 type="" vt=0 value=""
{
c[0] PropertySet@0AA6D8F0 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "";
p["IntObjectName"] = "PDS Catalog Interface";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0A9D00C0 p#0 c#1 type="ListOfPDS Catalog Interface" vt=0 value=""
{
c[0] PropertySet@0A9CF930 p#1 c#0 type="Catalog" vt=0 value=""
{
p["Name"] = "PDSCatalog";
}
}
}
}
PropertySet@0012CCB8 p#0 c#1 type="" vt=0 value=""
{
c[0] PropertySet@0AAA9240 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "42-1JIU";
p["IntObjectName"] = "PDS Catalog Interface";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0A76FAC8 p#0 c#1 type="ListOfPDS Catalog Interface" vt=0 value=""
{
c[0] PropertySet@0A76AFC0 p#11 c#0 type="Catalog" vt=0 value=""
{
p["Effective End Date"] = "";
p["Id"] = "42-54R7R";
p["Sequence Number"] = "";
p["ThumbnImageFileName"] = "";
p["Private Flag"] = "N";
p["Version"] = "1";
p["Effective Start Date"] = "07/21/2006 17:11:21";
p["Catalog Type"] = "Buying";
p["Active"] = "Y";
p["Name"] = "PDSCatalog";
p["Description"] = "";
}
}
}
}
None
GetCatalogCategories Method
Gets catalog categories for a given catalog. External
Syntax
Product Data Service.InvokeMethod(“GetCatalogCategories", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
Hierarchy: SiebelMessage (Integration object PDS Catalog Category Interface") |
Output Arguments |
Out |
Hierarchy: SiebelMessage (Integration object PDS Catalog Category Interface) |
Example of Input Arguments
PropertySet@0012C868 p#0 c#1 type="" vt=0 value=""
{
c[0] PropertySet@0A782558 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "";
p["IntObjectName"] = "PDS Catalog Category Interface";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0AA70F08 p#0 c#1 type="ListOfPDS Catalog Category Interface"
vt=0 value=""
{
c[0] PropertySet@0AA73710 p#1 c#0 type="Catalog" vt=0 value=""
{
p["Name"] = "PDSCatalog";
}
}
}
}
PropertySet@0012CCB8 p#0 c#1 type="" vt=0 value=""
{
c[0] PropertySet@0AAC66C0 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "42-1JIV";
p["IntObjectName"] = "PDS Catalog Category Interface";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0AB22E28 p#0 c#1 type="ListOfPDS Catalog Category Interface"
vt=0 value=""
{
c[0] PropertySet@0AAD8E68 p#11 c#1 type="Catalog" vt=0 value=""
{
p["Effective End Date"] = "";
p["Id"] = "42-54R7R";
p["Sequence Number"] = "";
p["ThumbnImageFileName"] = "";
p["Private Flag"] = "N";
p["Version"] = "1";
p["Effective Start Date"] = "07/21/2006 17:11:21";
p["Catalog Type"] = "Buying";
p["Active"] = "Y";
p["Name"] = "PDSCatalog";
p["Description"] = "";
c[0] PropertySet@0AAC66F0 p#0 c#2 type="ListOfCategory" vt=0 value=""
{
c[0] PropertySet@0AACFF00 p#20 c#0 type="Category" vt=0 value=""
{
p["Effective End Date"] = "";
p["Active Flag"] = "Y";
p["Id"] = "42-54R7S";
p["No Training Flag"] = "N";
p["Sequence Number"] = "";
p["ThumbnImageFileName"] = "";
p["Private Flag"] = "N";
p["Catalog Id"] = "42-54R7R";
p["Parent Category Id"] = "";
p["Effective Start Date"] = "07/21/2006 17:12:35";
p["Response Threshold"] = "";
p["Display Name"] = "PDSCatalogCategory1.1";
p["Usage"] = "";
p["Parent Category Name"] = "";
p["Count"] = "3";
p["Root Category Flag"] = "Y";
p["Root Category Id"] = "";
p["Name"] = "PDSCatalogCategory1.1";
p["Display Template"] = "";
p["Description"] = "";
}
c[1] PropertySet@0AACAF30 p#20 c#0 type="Category" vt=0 value=""
{
p["Effective End Date"] = "";
p["Active Flag"] = "Y";
p["Id"] = "42-54R7T";
p["No Training Flag"] = "N";
p["Sequence Number"] = "";
p["ThumbnImageFileName"] = "";
p["Private Flag"] = "N";
p["Catalog Id"] = "42-54R7R";
p["Parent Category Id"] = "";
p["Effective Start Date"] = "07/21/2006 17:13:28";
p["Response Threshold"] = "";
p["Display Name"] = "PDSCatalogCategory1.2";
p["Usage"] = "";
p["Parent Category Name"] = "";
p["Count"] = "5";
p["Root Category Flag"] = "Y";
p["Root Category Id"] = "";
p["Name"] = "PDSCatalogCategory1.2";
p["Display Template"] = "";
p["Description"] = "";
}
}
}
}
}
}
| Error ID | Error Message Text | User Action/Resolution |
|---|---|---|
IDS_ERR_ANIESALES_MISSING_SERVICE_NAME |
The '%1' user property is not defined in business service '%2'. |
Define user prop Data Sync Service (GetCatalogCategories) in Product Selection Service. |
SSAOMErrCannotCreateService |
Unable to create the Business Service '%1 |
Check to see if the business service defined in user prop Data Sync Service (GetCatalogCategories) in Product Selection Service is defined correctly. |
GetCategoryProducts Method
Gets a list of products for given catalog, category and context. External
Syntax
Product Data Service.InvokeMethod(“GetCategoryProducts", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
Hierarchy: SiebelMessage (Integration object PDS Category Product Interface) String: EligibilityMode String: PricingMode String: ContextMode (Optional) Hierarchy: SiebelMessage (Integration object PDS Catalog Context) |
Output Arguments |
Out |
Hierarchy: SiebelMessage (Integration object PDS Category Product Interface) |
Example of Input Arguments
PropertySet@0012CCC4 p#3 c#2 type="" vt=0 value=""
{
p["EligibilityMode"] = "1";
p["ContextMode"] = "SiebelContext";
p["PricingMode"] = "Y";
c[0] PropertySet@0AA66E90 p#4 c#1 type="Context" vt=0 value=""
{
p["MessageId"] = "";
p["MessageType"] = "Integration Object";
p["IntObjectName"] = "PDS Catalog Context";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0A7A84C0 p#0 c#1 type="ListOfPDS Catalog Context" vt=0 value=""
{
c[0] PropertySet@0AB68BA8 p#0 c#1 type="Context" vt=0 value=""
{
c[0] PropertySet@0A9DA050 p#0 c#1 type="ListOfSiebel Context" vt=0 value=""
{
c[0] PropertySet@0AB23A70 p#4 c#0 type="Siebel Context" vt=0 value=""
{
p["BusObjName"] = "Quote";
p["ContextRowId"] = "1-10MLH";
p["SignalMode"] = "Quote";
p["BusCompName"] = "Quote";
}
}
}
}
}
c[1] PropertySet@0AA997F0 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "";
p["MessageType"] = "Integration Object";
p["IntObjectName"] = "PDS Category Product Interface";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0A77C290 p#0 c#2 type="ListOfPDS Category Product Interface"
vt=0 value=""
{
c[0] PropertySet@0A993EE0 p#1 c#0 type="Catalog Category" vt=0 value=""
{
p["Name"] = "PDSCatalogCategory1.2";
}
c[1] PropertySet@0AA89B50 p#1 c#0 type="Catalog Category" vt=0 value=""
{
p["Name"] = "PDSCatalogCategory1.1";
}
}
}
}
PropertySet@0012CC58 p#0 c#1 type="" vt=0 value=""
{
c[0] PropertySet@1078D580 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "42-WAQ";
p["MessageType"] = "Integration Object";
p["IntObjectName"] = " PSS Category Product Interface ";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0BD55380 p#0 c#1 type="ListOfPSS Category Product Interface"
vt=0 value=""
{
c[0] PropertySet@0BD82770 p#4 c#1 type="Catalog Category" vt=0 value=""
{
p["Catalog Name"] = "ERM Catalog";
p["Version"] = "1";
p["Description"] = "ERM Category";
p["Name"] = "ERM Category";
p["Description - Translation"] = "ERM Category";
p["[Field]"] = "[Value]";
c[0] PropertySet@0BF21F30 p#0 c#1 type="ListOfInternal Product" vt=0
value=""
{
c[0] PropertySet@0BD2D7A0 p#85 c#2 type="Internal Product" vt=0 value=""
{
p["Name"] = "xxx";
p["[Field]"] = "[Value]";
}
c[…] PropertySet@0BD2D7A0 p#85 c#2 type="Internal Product" vt=0 value=""
{
p["Name"] = "xxx";
p["[Field]"] = "[Value]";
}
}
}
}
}
}
| Error ID | Error Message Text | User Action/Resolution |
|---|---|---|
IDS_ERR_ANIESALES_MISSING_SERVICE_NAME |
The '%1' user property is not defined in business service '%2'. |
Need to define user prop Data Sync Service (GetCategoryProducts) in Product Selection Service. |
SSAOMErrCannotCreateService |
Unable to create the Business Service '%1 |
Check to see if the business service defined in user prop Data Sync Service (GetCategoryProducts) in Product Selection Service is defined correctly. |
GetProductDetails Method
Gets a list of product details for given context. External.
Syntax
Product Data Service.InvokeMethod(“GetProductDetails", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
Hierarchy: SiebelMessage (Integration object PDS Product Details Interface) String: ContextMode (Optional) String: EligibilityMode String: PricingMode Hierarchy: SiebelMessage (Integration object PDS Catalog Context) |
Output Arguments |
Out |
Hierarchy: SiebelMessage (Integration object PDS Product Details Interface) |
Example of Input Arguments
PropertySet@0012C6BC p#3 c#2 type="" vt=0 value=""
{
p["EligibilityMode"] = "";
p["ContextMode"] = "SiebelContext";
p["PricingMode"] = "Y";
c[0] PropertySet@0A9DB3E0 p#4 c#1 type="Context" vt=0 value=""
{
p["MessageId"] = "";
p["IntObjectName"] = "PDS Catalog Context";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0A775E38 p#0 c#1 type="ListOfPDS Catalog Context" vt=0 value=""
{
c[0] PropertySet@0B23B2C8 p#0 c#1 type="Context" vt=0 value=""
{
c[0] PropertySet@0AAAC308 p#0 c#1 type="ListOfSiebel Context" vt=0 value=""
{
c[0] PropertySet@0AC022C8 p#4 c#0 type="Siebel Context" vt=0 value=""
{
p["BusObjName"] = "Quote";
p["ContextRowId"] = "1-10MLH";
p["SignalMode"] = "Quote";
p["BusCompName"] = "Quote";
}
}
}
}
}
c[1] PropertySet@0ABC6868 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "";
p["IntObjectName"] = "PDS Product Details Interface";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0AAB6410 p#0 c#1 type="ListOfPDS Product Details Interface"
vt=0 value=""
{
c[0] PropertySet@0B639560 p#1 c#0 type="Product" vt=0 value=""
{
p["Id"] = "99-28W7U";
}
}
}
}
PropertySet@0012CCB8 p#0 c#1 type="" vt=0 value=""
{
c[0] PropertySet@0AD67060 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "42-1JLM";
p["IntObjectName"] = "PDS Product Details Interface";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0A9A1C88 p#0 c#1 type="ListOfPDS Product Details Interface"
vt=0 value=""
{
c[0] PropertySet@0AD72870 p#23 c#1 type="Product" vt=3 value="99-28W7U"
{
p["Class Id"] = "99-28VEN";
p["Vendor Integration Id"] = "";
p["Reference Price"] = "";
p["Product Def Type Code"] = "Customizable";
p["Eligibility Reason"] = "";
p["Id"] = "99-28W7U";
p["Product Id"] = "99-28W7U";
p["Pre Pick"] = "N";
p["Part #"] = "GPAP";
p["Eligibility Status"] = "";
p["Integration Id"] = "";
p["Inclusive Eligibility Flag"] = "N";
p["Parent Item Id"] = "";
p["Net Price"] = "0";
p["List Price"] = "0";
p["Effective To"] = "";
p["Product Line Id"] = "No Match Row Id";
p["Product Configuration Model Id"] = "99-28W7U";
p["Effective From"] = "";
p["List Price Type Code"] = "STANDARD";
p["Name"] = "CDA_gp_Audio Package";
p["Quantity"] = "1";
p["Price List Id"] = "1-31C5";
c[0] PropertySet@0AD5A848 p#0 c#1 type="ListOfProduct Attribute" vt=0
value=""
{
c[0] PropertySet@0AD58DA8 p#5 c#0 type="Product Attribute" vt=0 value=""
{
p["Data Type"] = "Text";
p["Value"] = "Alpine";
p["Default Value"] = "";
p["Display Name"] = "Brand";
p["Name"] = "Brand";
}
}
}
}
}
}
| Error ID | Error Message Text | User Action/Resolution |
|---|---|---|
IDS_ERR_ANIESALES_MISSING_SERVICE_NAME |
The '%1' user property is not defined in business service '%2'. |
Define user prop Data Sync Service (GetProductDetails) in Product Selection Service. |
SSAOMErrCannotCreateService |
Unable to create the Business Service '%1 |
Check to see if the business service defined in user prop Data Sync Service (GetProductDetails) in Product Selection Service is defined correctly. |
PublishCatalog Method
Gets a list of catalogs details including all Categories, all available products under each of them and product details for a given catalog and context. External
Syntax
Product Data Service.InvokeMethod(“PublishCatalog", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
String: EligibilityMode String: ContextMode String: PricingMode String: IncludePriceWaterfall: Y/N (includes price waterfall or not) Hierarchy: SiebelMessage (Integration object PDS Catalog Context) Hierarchy: SiebelMessage (Integration object PDS Publish Catalog) |
Output Arguments |
Out |
Hierarchy: SiebelMessage |
Properties of Input Arguments
| Property | Type | Value | Description |
|---|---|---|---|
EligibilityMode |
String |
0,1,2 |
0:No EligibilityCheck 1:Check Eligibility without Filtering non-eligible Products 2:Check Eligbility by filtering non-eligible products |
ContextMode |
String |
SiebelContext, ExternalContext |
SiebelContext: Using existing Quote/Order Information in Siebel Database. In this case, the API will construct the Context. ExternalContext: External Call will provide the context information, API will pass them directly to the Pricing and Eligibility Process. |
PricingMode |
String |
Y/N |
None |
Context |
Hierarchy |
See the following examples. |
None |
SiebelMessage |
Integration Object |
PDS Publish Catalog Interface |
None |
Example of Input Arguments
PropertySet@0012C73C p#4 c#2 type="" vt=0 value=""
{
p["EligibilityMode"] = "";
p["ContextMode"] = "SiebelContext";
p["PricingMode"] = "Y";
p["IncludePriceWaterfall"] = "Y";
c[0] PropertySet@0A7ADFF8 p#4 c#1 type="Context" vt=0 value=""
{
p["MessageId"] = "";
p["IntObjectName"] = "PDS Catalog Context";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0A93C710 p#0 c#1 type="ListOfPDS Catalog Context" vt=0 value=""
{
c[0] PropertySet@0A7DBE20 p#0 c#1 type="Context" vt=0 value=""
{
c[0] PropertySet@0A711D30 p#0 c#1 type="ListOfSiebel Context" vt=0 value=""
{
c[0] PropertySet@0AB2C880 p#4 c#0 type="Siebel Context" vt=0 value=""
{
p["BusObjName"] = "Quote";
p["ContextRowId"] = "1-10MLH";
p["SignalMode"] = "Quote";
p["BusCompName"] = "Quote";
}
}
}
}
}
c[1] PropertySet@0A92AB50 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "";
p["IntObjectName"] = "PDS Publish Catalog Interface";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0AB32600 p#0 c#1 type="ListOfPDS Publish Catalog Interface"
vt=0 value=""
{
c[0] PropertySet@0A7E4F60 p#1 c#0 type="Catalog" vt=0 value=""
{
p["Name"] = "PDSCatalog";
}
}
}
}
PropertySet@0012CCB8 p#0 c#1 type="" vt=0 value=""
{
c[0] PropertySet@0B58ECD8 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "42-1NM2";
p["MessageType"] = "Integration Object";
p["IntObjectName"] = "PDS Publish Catalog Interface";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0B86A9C8 p#0 c#1 type="ListOfPDS Publish Catalog Interface"
vt=0 value=""
{
c[0] PropertySet@0AA33768 p#11 c#1 type="Catalog" vt=0 value=""
{
p["Effective End Date"] = "";
p["Id"] = "42-54R7R";
p["Sequence Number"] = "";
p["Private Flag"] = "N";
p["ThumbnImageFileName"] = "";
p["Effective Start Date"] = "07/21/2006 17:11:21";
p["Version"] = "1";
p["Catalog Type"] = "Buying";
p["Active"] = "Y";
p["Description"] = "";
p["Name"] = "PDSCatalog";
c[0] PropertySet@0B7B8348 p#0 c#2 type="ListOfCategory" vt=0 value=""
{
c[0] PropertySet@0C18AFF8 p#20 c#1 type="Category" vt=0 value=""
{
p["Effective End Date"] = "";
p["Id"] = "42-54R7S";
p["Active Flag"] = "Y";
p["No Training Flag"] = "N";
p["Sequence Number"] = "";
p["Catalog Id"] = "42-54R7R";
p["Private Flag"] = "N";
p["ThumbnImageFileName"] = "";
p["Effective Start Date"] = "07/21/2006 17:12:35";
p["Parent Category Id"] = "";
p["Display Name"] = "PDSCatalogCategory1.1";
p["Response Threshold"] = "";
p["Usage"] = "";
p["Count"] = "3";
p["Parent Category Name"] = "";
p["Root Category Flag"] = "Y";
p["Description"] = "";
p["Display Template"] = "";
p["Name"] = "PDSCatalogCategory1.1";
p["Root Category Id"] = "";
c[0] PropertySet@0B7ADAE0 p#0 c#3 type="ListOfProduct" vt=0 value=""
{
c[0] PropertySet@0A785780 p#19 c#2 type="Product" vt=3
value="99-28W7U"
{
p["Class Id"] = "99-28VEN";
p["Product Def Type Code"] = "Customizable";
p["Id"] = "99-28W7U";
p["Eligibility Reason"] = "";
p["Pre Pick"] = "N";
p["Defective Product State"] = "";
p["Product Id"] = "99-28W7U";
p["Cost List Item Currency Code"] = "";
p["Eligibility Status"] = "";
p["Inclusive Eligibility Flag"] = "N";
p["Parent Item Id"] = "";
p["Net Price"] = "0";
p["Effective To"] = "";
p["List Price"] = "0";
p["Product Configuration Model Id"] = "99-28W7U";
p["Product Line Id"] = "No Match Row Id";
p["Effective From"] = "";
p["Quantity"] = "";
p["Name"] = "CDA_gp_Audio Package";
c[0] PropertySet@0B817CF8 p#0 c#1 type="ListOfISS Product
Attribute VBC" vt=0
value=""
{
c[0] PropertySet@0B7F9FD8 p#5 c#0 type="ISS Product
Attribute VBC" vt=0
value=""
{
p["Data Type"] = "Text";
p["Default Value"] = "Alpine";
p["Attribute Name"] = "CDA_gp_BrandText";
p["Display Name"] = "Alpine";
p["Name"] = "Brand";
}
}
c[1] PropertySet@0B7FF410 p#0 c#0 type="ListOfNet Price
Waterfall" vt=0 value=""
}
}
c[1] PropertySet@0B79A670 p#20 c#1 type="Category" vt=0 value=""
{
p["Effective End Date"] = "";
p["Id"] = "42-54R7T";
p["Active Flag"] = "Y";
p["No Training Flag"] = "N";
p["Sequence Number"] = "";
p["Catalog Id"] = "42-54R7R";
p["Private Flag"] = "N";
p["ThumbnImageFileName"] = "";
p["Effective Start Date"] = "07/21/2006 17:13:28";
p["Parent Category Id"] = "";
p["Display Name"] = "PDSCatalogCategory1.2";
p["Response Threshold"] = "";
p["Usage"] = "";
p["Count"] = "5";
p["Parent Category Name"] = "";
p["Root Category Flag"] = "Y";
p["Description"] = "";
p["Display Template"] = "";
p["Name"] = "PDSCatalogCategory1.2";
p["Root Category Id"] = "";
c[0] PropertySet@09464A70 p#0 c#5 type="ListOfProduct" vt=0 value=""
{
c[0] PropertySet@0B7946E8 p#19 c#2 type="Product" vt=3
value="99-28W7F"
{
p["Class Id"] = "";
p["Product Def Type Code"] = "None";
p["Id"] = "99-28W7F";
p["Eligibility Reason"] = "";
p["Pre Pick"] = "N";
p["Defective Product State"] = "";
p["Product Id"] = "99-28W7F";
p["Cost List Item Currency Code"] = "";
p["Eligibility Status"] = "";
p["Inclusive Eligibility Flag"] = "N";
p["Parent Item Id"] = "";
p["Net Price"] = "1";
p["Effective To"] = "";
p["List Price"] = "1";
p["Product Configuration Model Id"] = "99-28W7F";
p["Product Line Id"] = "No Match Row Id";
p["Effective From"] = "";
p["Quantity"] = "";
p["Name"] = "CDA_gp_Key";
c[0] PropertySet@0AEBB400 p#0 c#0 type="ListOfISS Product
Attribute VBC" vt=0
value=""
c[1] PropertySet@0554B198 p#0 c#0 type="ListOfNet Price
Waterfall" vt=0 value=""
}
}
}
}
}
}
}
}
None.
GetFavorites Method
Get a list quote or order favorites using search specification. External
Syntax
Product Data Service.InvokeMethod(“GetFavorites", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
Hierarchy: SiebelMessage (Integration object PDS Template Interface) |
Output Arguments |
Out |
Hierarchy: SiebelMessage (Integration object PDS Template Interface) |
Error Conditions
| Error ID | Error Message Text | User Action/Resolution |
|---|---|---|
IDS_ERR_ANIESALES_MISSING_SERVICE_NAME |
The '%1' user property is not defined in business service '%2'. |
Define user prop Data Sync Service (GetFavorites) in Product Selection Service. |
SSAOMErrCannotCreateService |
Unable to create the Business Service '%1 |
Check to see if the business service defined in user prop Data Sync Service (GetFavorites) in Product Selection Service is defined correctly. |
GetFavoriteItems Method
Get a list of favorite items for a given favorite. External
Syntax
Product Data Service.InvokeMethod(“GetFavoriteItems", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
Hierarchy: SiebelMessage (Integration object PDS Template Item Interface) |
Output Arguments |
Out |
Hierarchy: SiebelMessage (Integration object PDS Template Item Interface) |
Error Conditions
| Error ID | Error Message Text | User Action/Resolution |
|---|---|---|
IDS_ERR_ANIESALES_MISSING_SERVICE_NAME |
The '%1' user property is not defined in business service '%2'. |
Define user prop Data Sync Service (GetFavoriteItems) in Product Selection Service. |
SSAOMErrCannotCreateService |
Unable to create the Business Service '%1 |
Check to see if the business service defined in user prop Data Sync Service (GetFavoriteItems) in Product Selection Service is defined correctly. |
GetRelatedProducts Method
Gets related products. External.
Syntax
Product Data Service.InvokeMethod(“GetRelatedProducts", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
Hierarchy: SiebelMessage (Integration object PDS Related Products Interface) |
Output Arguments |
Out |
Hierarchy: SiebelMessage (Integration object PDS Related Products Interface) |
Example of Input Arguments
PropertySet@0012C5B0 p#0 c#1 type="" vt=0 value=""
{
c[0] PropertySet@1088CCE8 p#4 c#1 type="SearchSpec" vt=0 value=""
{
p["SearchSpc"] = "xxx"
}
}
PropertySet@0012C5B0 p#0 c#1 type="" vt=0 value=""
{
c[1] PropertySet@1088CCE8 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "";
p["MessageType"] = "Integration Object";
p["IntObjectName"] = " PSS Related Products";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@1088CCE8 p#4 c#1 type="Internal Product" vt=0 value=""
{
c[0] PropertySet@108797E8 p#0 c#1 type="ListOfPDS Related Products" vt=0 value=""
{
c[0] PropertySet@1088CCE8 p#4 c#1 type=" Component Product" vt=0 value=""
{
}
c[1] PropertySet@1088CCE8 p#4 c#1 type=" Component Product" vt=0 value=""
{
}
}
}
}
}
None.
GetRelatedPromotions Method
Gets related promotions. External.
Syntax
Product Data Service.InvokeMethod(“GetRelatedPromotions", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
Hierarchy: SiebelMessage (Integration object PDS Product Details Interface) String: ContextMode (Optional) String: EligibilityMode String: PricingMode Hierarchy: SiebelMessage (Integration object PDS Catalog Context) |
Output Arguments |
Out |
Hierarchy: SiebelMessage (Integration object PDS Related Promotions Interface) |
Example of Input Arguments
PropertySet@0012CCC4 p#3 c#2 type="" vt=0 value=""
{
p["EligibilityMode"] = "";
p["ContextMode"] = "SiebelContext";
p["PricingMode"] = "Y";
c[0] PropertySet@0AA62270 p#4 c#1 type="Context" vt=0 value=""
{
p["MessageId"] = "";
p["MessageType"] = "Integration Object";
p["IntObjectName"] = "PDS Catalog Context";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0A7BE0A8 p#0 c#1 type="ListOfPDS Catalog Context" vt=0 value=""
{
c[0] PropertySet@0AB2D9E0 p#0 c#1 type="Context" vt=0 value=""
{
c[0] PropertySet@0A9AD8D0 p#0 c#1 type="ListOfSiebel Context" vt=0 value=""
{
c[0] PropertySet@0A995050 p#4 c#0 type="Siebel Context" vt=0 value=""
{
p["BusObjName"] = "Quote";
p["ContextRowId"] = "1-10MLH";
p["SignalMode"] = "Quote";
p["BusCompName"] = "Quote";
}
}
}
}
}
c[1] PropertySet@0A7C6A88 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "";
p["MessageType"] = "Integration Object";
p["IntObjectName"] = "PDS Related Promotions Interface";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0AAFB870 p#0 c#1 type="ListOfPDS Related Promotions Interface"
vt=0 value=""
{
c[0] PropertySet@0B747730 p#1 c#1 type="Product" vt=0 value=""
{
p["Name"] = "InMotion 130XL";
c[0] PropertySet@0AA473D0 p#0 c#1 type="ListOfRelated Promotion" vt=0
value=""
{
c[0] PropertySet@0AA29BF8 p#1 c#0 type="Related Promotion" vt=0 value=""
{
p["Name"] = "*";
}
}
}
}
}
}
PropertySet@0012CCB8 p#0 c#1 type="" vt=0 value=""
{
c[0] PropertySet@0AAEBC20 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "42-1NRM";
p["IntObjectName"] = "PDS Related Promotions Interface";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0ABAEE98 p#0 c#1 type="ListOfPDS Related Promotions Interface"
vt=0 value=""
{
c[0] PropertySet@0AC41580 p#23 c#1 type="Product" vt=0 value=""
{
p["Class Id"] = "1-PJLX";
p["Vendor Integration Id"] = "";
p["Reference Price"] = "";
p["Product Def Type Code"] = "None";
p["Eligibility Reason"] = "";
p["Id"] = "1-ZMH";
p["Product Id"] = "1-ZMH";
p["Pre Pick"] = "N";
p["Part #"] = "IM-130";
p["Eligibility Status"] = "";
p["Integration Id"] = "";
p["Inclusive Eligibility Flag"] = "N";
p["Parent Item Id"] = "";
p["Net Price"] = "";
p["List Price"] = "";
p["Effective To"] = "";
p["Product Line Id"] = "1-3HZA";
p["Product Configuration Model Id"] = "1-ZMH";
p["Effective From"] = "01/01/1999";
p["List Price Type Code"] = "STANDARD";
p["Name"] = "InMotion 130XL";
p["Quantity"] = "1";
p["Price List Id"] = "1-1D79";
c[0] PropertySet@0AC02DC8 p#0 c#2 type="ListOfRelated Promotion" vt=0
value=""
{
c[0] PropertySet@0AC68EB0 p#5 c#0 type="Related Promotion" vt=0 value=""
{
p["Eligibility Reason"] = "";
p["Eligibility Status"] = "";
p["Promotion Id"] = "42-519PJ";
p["Name"] = "Test Promotion1";
p["Description"] = "";
}
c[1] PropertySet@0AC4DD68 p#5 c#0 type="Related Promotion" vt=0 value=""
{
p["Eligibility Reason"] = "";
p["Eligibility Status"] = "";
p["Promotion Id"] = "42-53MU1";
p["Name"] = "Z PROM1";
p["Description"] = "";
}
}
}
}
}
}
None.
GetProductAttributeDomain Method
Gets all the attribute types and domain details for a given product. External.
Syntax
Product Data Service.InvokeMethod(“GetProductAttributeDomain", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
String: Attribute Id String: Product Configuration Model Id Hierarchy: SiebelMessage (Integration object PDS Product Attribute Domain Interface) |
Output Arguments |
Out |
Hierarchy: SiebelMessage (Integration object PDS Product Attribute Domain Interface) |
Example of Input Arguments
PropertySet@0012CCC4 p#2 c#0 type="" vt=0 value=""
{
p["Product Configuration Model Id"] = "99-27KMW";
p["Attribute Id"] = "OM_Edition";
}
Example of Output Arguments:
PropertySet@0012CCB8 p#0 c#1 type="" vt=0 value=""
{
c[0] PropertySet@0A767970 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "";
p["MessageType"] = "Integration Object";
p["IntObjectName"] = "PDS Product Attribute Domain Interface";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0AA19870 p#0 c#1 type="ListOfPDS Product Attribute Domain
Interface" vt=0 value=""
{
c[0] PropertySet@0AB28978 p#26 c#1 type="Product Attribute" vt=0 value=""
{
p["Unit of Measure"] = "";
p["Id"] = "OM_Edition";
p["Attribute Definition Id"] = "99-27KFN";
p["Default Value"] = "";
p["Eligibility Procedure Name"] = "";
p["Vector Flag"] = "Y";
p["Minimum Value"] = "";
p["Attribute Name"] = "OM_Edition";
p["Increment Value"] = "";
p["None Value"] = "";
p["Parametric Search Falg"] = "Y";
p["Read Only Flag"] = "N";
p["Sequence Number"] = "-1";
p["Inherited Flag"] = "Y";
p["Overwritten Flag"] = "N";
p["Required Flag"] = "N";
p["Validation Spec"] = "";
p["Display Name"] = "Edition";
p["Maximum Value"] = "";
p["Domain Type"] = "Text";
p["Hidden Flag"] = "N";
p["Enumerated Flag"] = "Y";
p["Orig Id"] = "42@777ar";
p["Pre Pick CD"] = "";
p["Description"] = "";
p["Asset Flag"] = "N";
c[0] PropertySet@0AB284C8 p#0 c#3 type="ListOfAttribute LOV Value" vt=0
value=""
{
c[0] PropertySet@0AB271B0 p#1 c#0 type="Attribute LOV Value" vt=0
value=""
{
p["Value"] = "Enterprise";
}
c[1] PropertySet@0AB2AB70 p#1 c#0 type="Attribute LOV Value" vt=0
value=""
{
p["Value"] = "Home";
}
c[2] PropertySet@0AB2A7D8 p#1 c#0 type="Attribute LOV Value" vt=0
value=""
{
p["Value"] = "Professional";
}
}
}
}
}
}
Error Conditions
None.
GetProductChildren Method
Gets a list of child business component details for a given product, the child business component name, and the required fields to return.
Syntax
Product Data Service.InvokeMethod(“GetProductChildren", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
String: ContextMode String: EligibilityMode String: PricingMode Hierarchy: SiebelMessage (Integration object PDS Catalog Context) Hierarchy: SiebelMessage (Integration object PDS Product Children Interface) |
Output Arguments |
Out |
Hierarchy: SiebelMessage (Integration object PDS Product Children Interface) |
Example of Input Arguments
PropertySet@0012C6BC p#3 c#2 type="" vt=0 value=""
{
p["EligibilityMode"] = "";
p["ContextMode"] = "SiebelContext";
p["PricingMode"] = "Y";
c[0] PropertySet@0B89E3F0 p#4 c#1 type="Context" vt=0 value=""
{
p["MessageId"] = "";
p["IntObjectName"] = "PDS Catalog Context";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0A959098 p#0 c#1 type="ListOfPDS Catalog Context" vt=0 value=""
{
c[0] PropertySet@0AB4A228 p#0 c#1 type="Context" vt=0 value=""
{
c[0] PropertySet@0A5D78B8 p#0 c#1 type="ListOfSiebel Context" vt=0 value=""
{
c[0] PropertySet@0B6396E0 p#4 c#0 type="Siebel Context" vt=0 value=""
{
p["BusObjName"] = "Quote";
p["ContextRowId"] = "1-10MLH";
p["SignalMode"] = "Quote";
p["BusCompName"] = "Quote";
}
}
}
}
}
c[1] PropertySet@0BAFF048 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "";
p["IntObjectName"] = "PDS Product Children Interface";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@08BDC3C8 p#0 c#1 type="ListOfPDS Product Children Interface"
vt=0 value=""
{
c[0] PropertySet@0A73E4B0 p#1 c#0 type="Product" vt=0 value=""
{
p["Id"] = "99-28W7U";
}
}
}
}
PropertySet@0012CCB8 p#0 c#1 type="" vt=0 value=""
{
c[0] PropertySet@0B96EAA8 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "42-1JLN";
p["IntObjectName"] = "PDS Product Children Interface";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0B9DFB90 p#0 c#1 type="ListOfPDS Product Children Interface"
vt=0 value=""
{
c[0] PropertySet@0BBDEA68 p#23 c#2 type="Product" vt=3 value="99-28W7U"
{
p["Class Id"] = "99-28VEN";
p["Vendor Integration Id"] = "";
p["Reference Price"] = "";
p["Product Def Type Code"] = "Customizable";
p["Eligibility Reason"] = "";
p["Id"] = "99-28W7U";
p["Product Id"] = "99-28W7U";
p["Pre Pick"] = "N";
p["Part #"] = "GPAP";
p["Eligibility Status"] = "";
p["Integration Id"] = "";
p["Inclusive Eligibility Flag"] = "N";
p["Parent Item Id"] = "";
p["Net Price"] = "0";
p["List Price"] = "0";
p["Effective To"] = "";
p["Product Line Id"] = "No Match Row Id";
p["Product Configuration Model Id"] = "99-28W7U";
p["Effective From"] = "";
p["List Price Type Code"] = "STANDARD";
p["Name"] = "CDA_gp_Audio Package";
p["Quantity"] = "1";
p["Price List Id"] = "1-31C5";
c[0] PropertySet@0BABA878 p#0 c#2 type="ListOfKey Feature" vt=0 value=""
{
c[0] PropertySet@0BAB17E8 p#4 c#0 type="Key Feature" vt=0 value=""
{
p["Vendor Location"] = "";
p["Vendor"] = "";
p["Product Id"] = "99-28W7U";
p["Feature"] = "24 x 7 Phone Support";
}
c[1] PropertySet@0BD94500 p#4 c#0 type="Key Feature" vt=0 value=""
{
p["Vendor Location"] = "";
p["Vendor"] = "";
p["Product Id"] = "99-28W7U";
p["Feature"] = "Access Time";
}
}
c[1] PropertySet@0BC8DD28 p#0 c#1 type="ListOfLiterature" vt=0 value=""
{
c[0] PropertySet@0B9A0688 p#10 c#0 type="Literature" vt=0 value=""
{
p["Internal"] = "Y";
p["Sales Tool Type"] = "Sales Tool: Brochure";
p["File Type"] = "pdf";
p["Auto Update Flag"] = "Y";
p["Integration Id"] = "";
p["Size"] = "161754";
p["LitFileDate"] = "03/02/2001 17:46:10";
p["Name"] = " Brochure: Ernst & Young's The Centric Group";
p["File Name"] = "ds_EndUser_S_LIT_12-GSYZV_12-1INJ";
p["Description"] = "";
}
}
}
}
}
}
None.
GetSearchOptions Method
Displays product classes, such as Computer, Printer, and so on. It can also use All to refer to all products. External.
Syntax
Product Data Service.InvokeMethod(“GetSearchOptions", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
Hierarchy: SiebelMessage (Integration object PDS Searchable Product Class Interface) |
Output Arguments |
Out |
Hierarchy: SiebelMessage (Integration object PDS Searchable Product Class Interface) |
Example of Input Arguments
PropertySet@0012CCC4 p#0 c#1 type="" vt=0 value=""
{
c[0] PropertySet@0A69DB90 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "";
p["MessageType"] = "Integration Object";
p["IntObjectName"] = "PDS Searchable Product Class Interface";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0A910EB8 p#0 c#1 type="ListOfPDS Searchable Product Class
Interface" vt=0 value=""
{
c[0] PropertySet@0A9F5FF8 p#1 c#0 type="ISS PS Direct Subclass" vt=0 value=""
{
p["Name"] = "OM*";
}
}
}
}
PropertySet@0012CCB8 p#0 c#1 type="" vt=0 value=""
{
c[0] PropertySet@0AC49B70 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "42-1NGI";
p["IntObjectName"] = "PDS Searchable Product Class Interface";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0A9F3FC8 p#0 c#1 type="ListOfPDS Searchable Product Class
Interface" vt=0 value=""
{
c[0] PropertySet@0AC31BD8 p#3 c#0 type="ISS PS Direct Subclass" vt=0 value=""
{
p["Class Id"] = "99-27K1T";
p["Display Name"] = "OM_Operating System";
p["Name"] = "OM_Operating System";
}
}
}
}
None.
GetSearchParameters Method
Gets the list of attributes available for the class(es) using the input search specification in the SiebelMessage. External
This method only retrieves product attributes that are flagged as searchable. If the example is followed, then data is generated only if the attributes for the product are flagged as searchable in the database.
Syntax
Product Data Service.InvokeMethod(“GetSearchParameters", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
String: FieldNameClassId String: LookupFromCache (To be Obsolete) String: MaximumAttributes Hierarchy: SiebelMessage (Integration object PDS Searchable Product Class Interface) |
Output Arguments |
Out |
Hierarchy: SiebelMessage (Integration object PDS Product Class Attributes Interface) |
Example of Input Arguments
PropertySet@0012CCC4 p#3 c#1 type="" vt=0 value=""
{
p["LookupFromCache"] = "";
p["MaximumAttributes"] = "";
p["FieldNameClassId"] = "";
c[0] PropertySet@0AAEBFC8 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "";
p["MessageType"] = "Integration Object";
p["IntObjectName"] = "PDS Searchable Product Class Interface";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0AAD45B0 p#0 c#1 type="ListOfPDS Searchable Product Class
Interface" vt=0 value=""
{
c[0] PropertySet@02C42F08 p#1 c#0 type="ISS PS Direct Subclass" vt=0 value=""
{
p["Class Id"] = "99-27K1T";
}
}
}
}
PropertySet@0012CCB8 p#0 c#1 type="" vt=0 value=""
{
c[0] PropertySet@0B918DE8 p#5 c#1 type="SiebelMessageOut" vt=0 value=""
{
p["MessageId"] = "42-1NJB";
p["ID_ALL"] = "All";
p["IntObjectName"] = "PDS Product Class Attributes Interface";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@055458C0 p#0 c#1 type="ListOfPDS Product Class Attributes
Interface" vt=0 value=""
{
c[0] PropertySet@0B94F868 p#3 c#1 type="ISS PS Direct Subclass" vt=0 value=""
{
p["Class Id"] = "99-27K1T";
p["Display Name"] = "OM_Operating System";
p["Name"] = "OM_Operating System";
c[0] PropertySet@0A0B55E0 p#0 c#9 type="ListOfISS Class Attribute" vt=0
value=""
{
c[0] PropertySet@0542CC18 p#2 c#1 type="ISS Class Attribute" vt=0
value=""
{
p["Display Name"] = "Edition";
p["Attribute Id"] = "OM_Edition";
c[0] PropertySet@0A6D7BB0 p#0 c#4 type="ListOfAttribute LOV
Value" vt=0 value=""
{
c[0] PropertySet@0543F558 p#1 c#0 type="Attribute LOV Value"
vt=0 value=""
{
p["Value"] = "Professional";
}
c[1] PropertySet@0538FA40 p#1 c#0 type="Attribute LOV Value"
vt=0 value=""
{
p["Value"] = "Home";
}
c[2] PropertySet@0A7F7FA8 p#1 c#0 type="Attribute LOV Value"
vt=0 value=""
{
p["Value"] = "Enterprise";
}
c[3] PropertySet@0A8A2B08 p#1 c#0 type="Attribute LOV Value"
vt=0 value=""
{
p["Value"] = "ALL";
}
}
}
c[1] PropertySet@0A9324D8 p#2 c#1 type="ISS Class Attribute" vt=0
value=""
{
p["Display Name"] = "Language";
p["Attribute Id"] = "OM_Language";
c[0] PropertySet@02C43A00 p#0 c#6 type="ListOfAttribute LOV
Value" vt=0 value=""
{
c[0] PropertySet@0A9F3D30 p#1 c#0 type="Attribute LOV Value"
vt=0 value=""
{
p["Value"] = "ESN";
}
c[1] PropertySet@053D6FD8 p#1 c#0 type="Attribute LOV Value"
vt=0 value=""
{
p["Value"] = "ENU";
}
c[2] PropertySet@0A893AE0 p#1 c#0 type="Attribute LOV Value"
vt=0 value=""
{
p["Value"] = "FRA";
}
c[3] PropertySet@0BCF40E8 p#1 c#0 type="Attribute LOV Value"
vt=0 value=""
{
p["Value"] = "DEU";
}
c[4] PropertySet@0536BA78 p#1 c#0 type="Attribute LOV Value"
vt=0 value=""
{
p["Value"] = "ALL";
}
c[5] PropertySet@02B9F1B8 p#1 c#0 type="Attribute LOV Value"
vt=0 value=""
{
p["Value"] = "JPN";
}
}
}
c[2] PropertySet@0A982878 p#2 c#1 type="ISS Class Attribute" vt=0
value=""
{
p["Display Name"] = "Service Pack";
p["Attribute Id"] = "OM_Service Pack";
c[0] PropertySet@0AB4E3E0 p#0 c#4 type="ListOfAttribute LOV
Value" vt=0 value=""
{
c[0] PropertySet@0AC70068 p#1 c#0 type="Attribute LOV Value"
vt=0 value=""
{
p["Value"] = "3";
}
c[1] PropertySet@093FB308 p#1 c#0 type="Attribute LOV Value"
vt=0 value=""
{
p["Value"] = "2";
}
c[2] PropertySet@0AB032E8 p#1 c#0 type="Attribute LOV Value"
vt=0 value=""
{
p["Value"] = "1";
}
c[3] PropertySet@09642C40 p#1 c#0 type="Attribute LOV Value"
vt=0 value=""
{
p["Value"] = "ALL";
}
}
}
c[3] PropertySet@09617088 p#2 c#1 type="ISS Class Attribute" vt=0
value=""
{
p["Display Name"] = "Version";
p["Attribute Id"] = "OM_Version";
c[0] PropertySet@09403568 p#0 c#4 type="ListOfAttribute LOV
Value" vt=0 value=""
{
c[0] PropertySet@096264A0 p#1 c#0 type="Attribute LOV Value"
vt=0 value=""
{
p["Value"] = "Upgrade";
}
c[1] PropertySet@093FC308 p#1 c#0 type="Attribute LOV Value"
vt=0 value=""
{
p["Value"] = "OEM";
}
c[2] PropertySet@09611680 p#1 c#0 type="Attribute LOV Value"
vt=0 value=""
{
p["Value"] = "Full";
}
c[3] PropertySet@09641B40 p#1 c#0 type="Attribute LOV Value"
vt=0 value=""
{
p["Value"] = "ALL";
}
}
}
c[4] PropertySet@0964C768 p#2 c#1 type="ISS Class Attribute" vt=0
value=""
{
p["Display Name"] = "Build";
p["Attribute Id"] = "OM_Build";
c[0] PropertySet@0AAB1C50 p#0 c#0 type="ListOfAttribute LOV
Value" vt=0 value=""
}
c[5] PropertySet@09616D00 p#2 c#1 type="ISS Class Attribute" vt=0
value=""
{
p["Display Name"] = "Default Browser";
p["Attribute Id"] = "OM_Default Browser";
c[0] PropertySet@09400380 p#0 c#0 type="ListOfAttribute LOV
Value" vt=0 value=""
}
c[6] PropertySet@09614D30 p#2 c#1 type="ISS Class Attribute" vt=0
value=""
{
p["Display Name"] = "Publish";
p["Attribute Id"] = "OM_Publish";
c[0] PropertySet@0940C548 p#0 c#0 type="ListOfAttribute LOV
Value" vt=0 value=""
}
c[7] PropertySet@094060B0 p#2 c#1 type="ISS Class Attribute" vt=0
value=""
{
p["Display Name"] = "Brand";
p["Attribute Id"] = "OM_Brand";
c[0] PropertySet@0BC91558 p#0 c#0 type="ListOfAttribute LOV
Value" vt=0 value=""
}
c[8] PropertySet@09642538 p#2 c#1 type="ISS Class Attribute" vt=0
value=""
{
p["Display Name"] = "Extended Warranty";
p["Attribute Id"] = "OM_Extended Warranty";
c[0] PropertySet@09611A00 p#0 c#0 type="ListOfAttribute LOV
Value" vt=0 value=""
}
}
}
}
}
}
| Error Message | Description |
|---|---|
The 'Data Sync Service: GetSearchParameters' user property is not defined in business service 'PDS Product Data Service |
The specified user property can not be found on the business service, which must have value PDS Product Attributes by default. |
Unable to create the Business Service 'PDS Product Attributes |
Can not initiate the business service. |
ExecuteSearch Method
Executes the search on products using the input search option, such as product class, class attributes, attribute constraints, pricing criteria, and so on. External.
Syntax
Product Data Service.InvokeMethod(“ExceuteSearch", Input Arguments,Output Arguments);
Arguments
There are two types of search supported: SearchByProduct or SearchByClass. SearchOption is a required input to indicate the type of search performed.
| Arguments for SearchByProduct | Type | Description |
|---|---|---|
Input Arguments |
In |
SearchOption: SearchByProduct. This input argument is required. IO: an instance of Integration Object PDS Product Interface. This input argument is required. PricingMode: Y/N (calculates price or not). Optional. Default value: Y. EligibilityMode: 0,1,2 (eligibility display mode. 0 do not run; 1 run; 2 run but only return eligible ones). Optional. Default value: 1. ContextMode: SiebelContext or ExternalConext. Optional, but if not provided, will not run pricing and eligibility. Context: an instance of Integration Object PDS Catalog Context. It either contains SiebelContext or ExternalContext. Optional only if ContextMode is not provided; otherwise, required. PriceSearchExpression: price field search expression. For example: is greater than 100 and is less than 1000. Optional. ProductSearchSpec: product business component search specification. For example: [Name] like "IBM*". Optional. ResultSize: number of products returned. Optional. Default Value 30. |
Output Arguments |
Out |
Hierarchy: SiebelMessage (Integration object PDS Product Interface) |
| Arguments for SearchByClass | Type | Description |
|---|---|---|
Input Arguments |
In |
SearchOption: SearchByClass. This input argument is required. IO: an instance of Integration Object PDS Product Class Attributes Interface. This input argument is required. The user must specify class id, attribute id, and attribute value in attribute LOV value structure (array with 1 element for either freeform or LOV type attribute). PricingMode: Y/N (calculates price or not). Optional. Default value: Y. EligibilityMode: 0,1,2 (eligibility display mode. 0 do not run; 1 run; 2 run but only return eligible products). Optional. Default value is 1. ContextMode: SiebelContext or ExternalConext. Optional, but if it is not provided, it will not run pricing and eligibility. Context: an instance of Integration Object PDS Catalog Context. It either contains SiebelContext or ExternalContext. Optional only if ContextMode is not provided; otherwise, required. PriceSearchExpression: price field search expression. For example: is greater than 100 and is less than 1000. Optional. ProductSearchSpec: product business component search specification. For example: [Name] like "IBM*". Optional. ResultSize: number of products returned. Optional. Default Value 30. |
Output Arguments |
Out |
Hierarchy: SiebelMessage (Integration object PDS Product Interface) |
Properties of Input Arguments
| Property | Type | Value | Description |
|---|---|---|---|
ContextMode |
String |
SiebelContext, ExternalContext |
SiebelContext: Using existing Quote/Order Information in Siebel Database. In this case, the API constructs the Context using the provided row_id ExternalContext: External Call will provide the context information, API will pass them directly to the Pricing and Eligibility Process. |
ResultSize |
Number |
For example, 30 |
The number of products that would be retrieved from the query result |
Context |
Hierarchy: SiebelMessage (Integration object PDS Catalog Context) |
See the following examples. |
None |
Integration Object |
SiebelMessage |
PDS Product Interface |
None |
Example of Input Arguments
PropertySet@0012C82C p#7 c#3 type="" vt=0 value=""
{
p["EligibilityMode"] = "1";
p["ProductSearchSpec"] = "";
p["PriceSearchExpression"] = "";
p["ContextMode"] = "SiebelContext";
p["ResultSize"] = "";
p["PricingMode"] = "Y";
p["SearchOption"] = "SearchByClass";
c[0] PropertySet@0A7AEFC0 p#4 c#1 type="Context" vt=0 value=""
{
p["MessageId"] = "";
p["IntObjectName"] = "PDS Catalog Context";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0A778688 p#0 c#1 type="ListOfPDS Catalog Context" vt=0 value=""
{
c[0] PropertySet@0A7F7CE0 p#0 c#1 type="Context" vt=0 value=""
{
c[0] PropertySet@0AAD12D8 p#0 c#1 type="ListOfSiebel Context" vt=0 value=""
{
c[0] PropertySet@0AA29A88 p#4 c#0 type="Siebel Context" vt=0 value=""
{
p["BusObjName"] = "Quote";
p["ContextRowId"] = "1-10MLH";
p["SignalMode"] = "Quote";
p["BusCompName"] = "Quote";
}
}
}
}
}
c[1] PropertySet@0AA524A0 p#4 c#1 type="ClassAttributes" vt=0 value=""
{
p["MessageId"] = "";
p["IntObjectName"] = "PDS Product Class Attributes Interface";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0AACF400 p#0 c#1 type="ListOfPDS Product Class Attributes
Interface" vt=0 value=""
{
c[0] PropertySet@0AA92A18 p#1 c#1 type="ISS PS Direct Subclass" vt=0 value=""
{
p["Class Id"] = "99-27K1T";
c[0] PropertySet@0AA53858 p#0 c#1 type="ListOfISS Class Attribute" vt=0
value=""
{
c[0] PropertySet@0A9B38B8 p#2 c#0 type="ISS Class Attribute" vt=0
value=""
{
p["Value"] = "Professional";
p["Attribute Id"] = "OM_Edition";
}
}
}
}
}
c[2] PropertySet@054B87F0 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "";
p["IntObjectName"] = "PDS Product Interface";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@00C8E8F8 p#0 c#1 type="ListOfPDS Product Interface" vt=0 value=""
{
c[0] PropertySet@0A798FF8 p#0 c#0 type="Product" vt=0 value=""
}
}
}
PropertySet@0012CCB8 p#0 c#1 type="" vt=0 value=""
{
c[0] PropertySet@02C806E0 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "";
p["MessageType"] = "Integration Object";
p["IntObjectName"] = "PDS Product Interface";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@02B9FF00 p#0 c#2 type="ListOfPDS Product Interface" vt=0 value=""
{
c[0] PropertySet@0B97D3F8 p#24 c#0 type="Product" vt=3 value="99-27KMW"
{
p["Class Id"] = "99-27K1T";
p["Product Def Type Code"] = "Customizable";
p["Reference Price"] = "";
p["Vendor Integration Id"] = "";
p["Id"] = "99-27KMW";
p["Eligibility Reason"] = "";
p["Pre Pick"] = "N";
p["Product Id"] = "99-27KMW";
p["Part #"] = "";
p["Eligibility Status"] = "";
p["Parent Item Id"] = "";
p["Inclusive Eligibility Flag"] = "N";
p["Integration Id"] = "";
p["Net Price"] = "";
p["Effective To"] = "";
p["List Price"] = "";
p["Product Configuration Model Id"] = "99-27KMW";
p["Product Line Id"] = "No Match Row Id";
p["Effective From"] = "";
p["List Price Type Code"] = "STANDARD";
p["Product Type Code"] = "Product";
p["Quantity"] = "1";
p["Name"] = "OM_Windows NT";
p["Price List Id"] = "99-27LE5";
}
c[1] PropertySet@0B824EB8 p#24 c#0 type="Product" vt=3 value="99-27KN1"
{
p["Class Id"] = "99-27K1T";
p["Product Def Type Code"] = "None";
p["Reference Price"] = "";
p["Vendor Integration Id"] = "";
p["Id"] = "99-27KN1";
p["Eligibility Reason"] = "";
p["Pre Pick"] = "N";
p["Product Id"] = "99-27KN1";
p["Part #"] = "";
p["Eligibility Status"] = "";
p["Parent Item Id"] = "";
p["Inclusive Eligibility Flag"] = "N";
p["Integration Id"] = "";
p["Net Price"] = "";
p["Effective To"] = "";
p["List Price"] = "";
p["Product Configuration Model Id"] = "99-27KN1";
p["Product Line Id"] = "No Match Row Id";
p["Effective From"] = "";
p["List Price Type Code"] = "STANDARD";
p["Product Type Code"] = "Product";
p["Quantity"] = "1";
p["Name"] = "OM_Windows XP";
p["Price List Id"] = "99-27LE5";
}
}
}
}
| Error Message | Description |
|---|---|
The 'Data Sync Service: ExecuteSearch' user property is not defined in business service 'PDS Product Data Service |
The specified user property can not be found on the business service, which must have value PDS Product by default. |
Cannot get property set 1%. |
The required property set input 1% is not provided. |
Unable to locate record with row id as '%1' in '%2 |
The specified row_id 1% in BC 2% could not be found. |
Unable to create the Business Service PDS Product |
Can not initiate the business service. |
AddFavoriteToQuote, AddFavoriteToOrder, AddFavoriteItemtoQuote, AddFavoriteItemtoOrder, SaveQuoteAsFavorite, and SaveOrderAsFavorite Methods
Add a favorite to the active quote. External.
Syntax
Product Data Service.InvokeMethod(“AddFavoriteToQuote", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
String: Favorite Name String: Quote Number |
Output Arguments |
Out |
Hierarchy: SiebelMessage (Integration object PDS Quote Interface) |
Error Conditions
None.
DeleteQuote Method
Deletes a quote that matches the input.
Syntax
Product Data Service.InvokeMethod(“DeleteQuote", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
Hierarchy :SiebelMessage(Integration object PDS Quote) |
Output Arguments |
Out |
Hierarchy :SiebelMessage |
Example of Input Arguments
PropertySet@0012D384 p#0 c#1 type="" vt=0 value=""
{
c[0] PropertySet@0BAEB900 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "2-3ZGU";
p["MessageType"] = "Integration Object";
p["IntObjectName"] = "PDS Quote";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0BACBEF0 p#0 c#1 type="ListOfPDS Quote" vt=0 value=""
{
c[0] PropertySet@0BE2F288 p#23 c#1 type="Header" vt=0 value=""
{
p["Account Location"] = "";
p["Opportunity Id"] = "";
p["Id"] = "2-47Q9P";
p["Revision"] = "1";
p["Account Id"] = "";
p["Status"] = "In Progress";
p["Conflict Id"] = "0";
p["Account"] = "";
p["Contact Id"] = "";
p["Currency Code"] = "USD";
p["Discount"] = "";
p["Updated"] = "02/11/2005 12:34:46";
p["Primary Organization Id"] = "0-R9NH";
p["Integration Id"] = "";
p["End Date"] = "03/13/2005 00:00:00";
p["Created"] = "02/11/2005 12:34:46";
p["Active"] = "Y";
p["Due Date"] = "02/12/2005 00:00:00";
p["Quote Type"] = "Quotation";
p["Name"] = "PDS Quote Test";
p["Start Date"] = "02/11/2005 00:00:00";
p["Quote Number"] = "2-47Q9P";
p["Price List Id"] = "";
c[0] PropertySet@0BDDC2E8 p#0 c#1 type="ListOfLine Item" vt=0 value=""
{
c[0] PropertySet@0BBD5478 p#63 c#1 type="Line Item" vt=0 value=""
{
p["NRC CxTotal"] = "0";
p["Parent Id"] = "";
p["Cfg State Code"] = "New Item";
p["Unit of Measure"] = "";
p["Volume Discount Item Id"] = "";
p["Id"] = "2-47Q9S";
p["Cfg Type"] = "";
p["Eligibility Reason"] = "";
p["Exclude Pricing Flag"] = "N";
p["Extended Quantity Requested"] = "1";
p["Asset Integration Id"] = "2-47Q9S";
p["Root Id"] = "2-47Q9S";
p["Conflict Id"] = "0";
p["Need Refresh"] = "Y";
p["Prod Prom Name"] = "";
p["Volume Discount Item"] = "";
p["Line Number"] = "1";
p["Product Id"] = "2-47Q6J";
p["Currency Code"] = "USD";
p["Smart Part Number"] = "";
p["Discount"] = "";
p["Prod Item Id"] = "";
p["Discount Percent"] = "";
p["Original List Price"] = "";
p["Updated"] = "02/11/2005 12:37:02";
p["Current Price"] = "";
p["Eligibility Status"] = "";
p["Port Item Id"] = "";
p["Prod Prom Id"] = "";
p["Has Generics Flag"] = "";
p["Inclusive Eligibility Flag"] = "N";
p["Post Pick CD"] = "";
p["Rollup Amount"] = "0";
p["Integration Id"] = "2-47Q9S";
p["Prod Prom Instance Id"] = "";
p["Forcastable Flag"] = "Y";
p["Prod Prom Rule Id"] = "";
p["Discount Source"] = "Manual";
p["Effective To"] = "";
p["List Price"] = "";
p["Pricing Comments"] = "";
p["Volume Upsell Item"] = "";
p["Product Line Id"] = "No Match Row Id";
p["Rollup Item Price"] = "0";
p["Unit Price"] = "";
p["Price Type"] = "One-Time";
p["Volume Discount Id"] = "";
p["Created"] = "02/11/2005 12:34:52";
p["Effective From"] = "";
p["Prod Prom Source Id"] = "";
p["Discount Amount"] = "";
p["Pre Pick CD"] = "";
p["Exchange Date"] = "03/13/2005 00:00:00";
p["Item Price List Id"] = "";
p["Volume Upsell Message"] = "";
p["Configuration Model Id"] = "2-47Q6J";
p["Name"] = "PDS Product";
p["Quantity"] = "1";
p["Action Code"] = "Add";
p["Description"] = "";
p["Price List Id"] = "";
p["MRC CxTotal"] = "0";
p["Volume Upsell Item Id"] = "";
c[0] PropertySet@070A6B30 p#0 c#0 type="ListOfXA" vt=0 value=""
}
}
}
}
}
}
PropertySet@0012DA78 p#0 c#1 type="" vt=0 value=""
{
c[0] PropertySet@086490D0 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "2-3ZGU";
p["IntObjectName"] = "PDS Quote";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0BAB2950 p#0 c#1 type="ListOfPDS Quote" vt=0 value=""
{
c[0] PropertySet@0BF41DF8 p#0 c#0 type="Header" vt=0 value=""
}
}
}
None
InsertQuote Method
Insert a quote that is defined in input. If that quote already exists, then the method updates the existing quote.
Syntax
Product Data Service.InvokeMethod(“InsertQuote", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
Hierarchy :SiebelMessage(Integration object PDS Quote) |
Output Arguments |
Out |
Hierarchy :SiebelMessage |
Error Conditions
None.
This method calls the help method described in DeleteQuote Method.
UpdateQuote Method
Update Quote a quote that matches the input by user key.
Syntax
Product Data Service.InvokeMethod(“UpdateQuote", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
Hierarchy :SiebelMessage(Integration object PDS Quote) |
Output Arguments |
Out |
Hierarchy :SiebelMessage |
Error Conditions
None.
This method calls the help method described in DeleteQuote Method.
DeleteQuoteItem Method
Deletes the quote line item that is defined in the input.
Syntax
Product Data Service.InvokeMethod(“DeleteQuoteItem", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
Hierarchy :SiebelMessage(Integration object PDS Quote) |
Output Arguments |
Out |
Hierarchy :SiebelMessage |
Error Conditions
None.
This method calls the help method described in DeleteQuote Method.
InsertQuoteItem Method
Inserts a quote line item that is defined in the input. If the quote line item already exists, then the method updates the existing quote line item.
Syntax
Product Data Service.InvokeMethod(“InsertQuoteItem", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
Hierarchy :SiebelMessage(Integration object PDS Quote) |
Output Arguments |
Out |
Hierarchy :SiebelMessage |
Error Conditions
None.
This method calls the help method described in DeleteQuote Method.
UpdateQuoteItem Method
Updates an existing quote line item that is matched by user key and updated with value in the input.
Syntax
Product Data Service.InvokeMethod(“UpdateQuoteItem", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
Hierarchy :SiebelMessage(Integration object PDS Quote) |
Output Arguments |
Out |
Hierarchy :SiebelMessage |
Error Conditions
None.
This method calls the help method described in DeleteQuote Method.
DeleteOrder Method
Deletes the order that matches the input.
Syntax
Product Data Service.InvokeMethod(“DeleteOrder", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
Hierarchy :SiebelMessage(Integration object PDS Order) |
Output Arguments |
Out |
Hierarchy :SiebelMessage |
Example of Input Arguments
PropertySet@0012D384 p#0 c#1 type="" vt=0 value=""
{
c[0] PropertySet@0A6E4FE8 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "42-1D9U";
p["MessageType"] = "Integration Object";
p["IntObjectName"] = "PDS Order";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0ACADCC0 p#0 c#1 type="ListOfPDS Order" vt=0 value=""
{
c[0] PropertySet@0A903FE8 p#17 c#1 type="Header" vt=0 value=""
{
p["Account Location"] = "";
p["Id"] = "42-50SHP";
p["Revision"] = "1";
p["Account Id"] = "";
p["Status"] = "Pending";
p["Conflict Id"] = "0";
p["Order Type"] = "Service Order";
p["Account"] = "";
p["Contact Id"] = "";
p["Currency Code"] = "USD";
p["Discount"] = "";
p["Updated"] = "02/11/2005 13:54:39";
p["Integration Id"] = "";
p["Opty Id"] = "";
p["Order Number"] = "PDS Order Item Test";
p["Created"] = "02/11/2005 13:54:39";
p["Price List Id"] = "";
c[0] PropertySet@0A900550 p#0 c#1 type="ListOfLine Item" vt=0 value=""
{
c[0] PropertySet@0AB61530 p#62 c#1 type="Line Item" vt=0 value=""
{
p["NRC CxTotal"] = "0";
p["Parent Id"] = "";
p["Cfg State Code"] = "New Item";
p["Volume Discount Item Id"] = "";
p["Id"] = "42-50SHW";
p["Cfg Type"] = "";
p["Eligibility Reason"] = "";
p["Exclude Pricing Flag"] = "N";
p["Extended Quantity Requested"] = "1";
p["Asset Integration Id"] = "42-50SHW";
p["Root Id"] = "42-50SHW";
p["Conflict Id"] = "0";
p["Need Refresh"] = "Y";
p["Prod Prom Name"] = "";
p["Volume Discount Item"] = "";
p["Line Number"] = "1";
p["Product Id"] = "42-50S1M";
p["Currency Code"] = "USD";
p["Smart Part Number"] = "";
p["Discount"] = "";
p["Prod Item Id"] = "";
p["Discount Percent"] = "";
p["Original List Price"] = "";
p["Updated"] = "02/11/2005 13:56:09";
p["Current Price"] = "";
p["Eligibility Status"] = "";
p["Port Item Id"] = "";
p["Prod Prom Id"] = "";
p["Has Generics Flag"] = "";
p["Inclusive Eligibility Flag"] = "N";
p["Integration Id"] = "42-50SHW";
p["Post Pick CD"] = "";
p["Prod Prom Instance Id"] = "";
p["Rollup Amount"] = "0";
p["Forcastable Flag"] = "";
p["Prod Prom Rule Id"] = "";
p["Discount Source"] = "Manual";
p["List Price"] = "";
p["Pricing Comments"] = "";
p["Volume Upsell Item"] = "";
p["Effective To"] = "";
p["Unit Price"] = "";
p["Price Type"] = "One-Time";
p["Product Line Id"] = "No Match Row Id";
p["Rollup Item Price"] = "0";
p["Volume Discount Id"] = "";
p["Created"] = "02/11/2005 13:54:50";
p["Due Date"] = "02/12/2005 00:00:00";
p["Effective From"] = "";
p["Prod Prom Source Id"] = "";
p["Discount Amount"] = "";
p["Exchange Date"] = "";
p["Item Price List Id"] = "";
p["Pre Pick CD"] = "";
p["Volume Upsell Message"] = "";
p["Configuration Model Id"] = "42-50S1M";
p["Name"] = "PDS Product";
p["Quantity"] = "1";
p["Action Code"] = "Add";
p["Price List Id"] = "";
p["MRC CxTotal"] = "0";
p["Volume Upsell Item Id"] = "";
c[0] PropertySet@0A92EE38 p#0 c#0 type="ListOfXA" vt=0 value=""
}
}
}
}
}
}
PropertySet@0012DA78 p#0 c#1 type="" vt=0 value=""
{
c[0] PropertySet@0AB9F028 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "42-1D9U";
p["IntObjectName"] = "PDS Order";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0AC32B10 p#0 c#1 type="ListOfPDS Order" vt=0 value=""
{
c[0] PropertySet@0A63EB20 p#0 c#0 type="Header" vt=0 value=""
}
}
}
None.
This method calls the help method described in DeleteQuote Method.
InsertOrder Method
Insert an order that is defined in the input. If the order already exists, then the method updates the existing order.
Syntax
Product Data Service.InvokeMethod(“InsertOrder", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
Hierarchy :SiebelMessage(Integration object PDS Order) |
Output Arguments |
Out |
Hierarchy :SiebelMessage |
Error Conditions
None.
This method calls the help method described in DeleteQuote Method.
UpdateOrder Method
Updates an order that is matched with the input by user key.
Syntax
Product Data Service.InvokeMethod(“UpdateOrder", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
Hierarchy :SiebelMessage(Integration object PDS Order) |
Output Arguments |
Out |
Hierarchy :SiebelMessage |
Error Conditions
None.
This method calls the help method described in DeleteQuote Method.
DeleteOrderItem Method
Delete the order line item that is defined in the input.
Syntax
Product Data Service.InvokeMethod(“DeleteOrderItem", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
Hierarchy :SiebelMessage(Integration object PDS Order) |
Output Arguments |
Out |
Hierarchy :SiebelMessage |
Error Conditions
None.
This method calls the help method described in DeleteQuote Method.
InsertOrderItem Method
Inserts an order line item that is defined in the input. If the order line item already exists, then the method updates the existing order line item.
Syntax
Product Data Service.InvokeMethod(“InsertOrderItem", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
Hierarchy :SiebelMessage(Integration object PDS Order) |
Output Arguments |
Out |
Hierarchy :SiebelMessage |
Error Conditions
None.
This method calls the help method described in DeleteQuote Method.
UpdateOrderItem Method
Updates the existing order item that is matched by user key and updated with the value in the input.
Syntax
Product Data Service.InvokeMethod(“UpdateOrderItem", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
Hierarchy :SiebelMessage(Integration object PDS Order) |
Output Arguments |
Out |
Hierarchy :SiebelMessage |
Error Conditions
None.
This method calls the help method described in DeleteQuote Method.
GetActiveQuote Method
Finds the current active quote with input account Id, compound Product Number and Price List Id and returns this Quote. If it cannot find the quote, then the method creates and returns a new quote.
Syntax
Product Data Service.InvokeMethod(“GetActiveQuote", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
String: Account Id (optional) String: Compound Product Number (Optional) String: Price List Id (Optional) |
Output Arguments |
Out |
Hierarchy :SiebelMessage(Integration object PDS Quote) |
Example of Input Arguments
PropertySet@0012D370 p#4 c#0 type="" vt=0 value=""
{
p["Account Id"] = "";
p["ProcessName"] = "SIS OM Active Quote Sub-process";
p["Compound Product Number"] = "1-R234";
p["Price List Id"] = "1-D0D8";
}
PropertySet@0012DA78 p#0 c#1 type="" vt=0 value=""
{
c[0] PropertySet@0AD2BB48 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "2-3ZJM";
p["IntObjectName"] = "PDS Quote";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0AD85DA0 p#0 c#1 type="ListOfPDS Quote" vt=0 value=""
{
c[0] PropertySet@0AAFC110 p#23 c#1 type="Header" vt=0 value=""
{
p["Account Location"] = "";
p["Opportunity Id"] = "";
p["Revision"] = "1";
p["Id"] = "2-47QI3";
p["Status"] = "In Progress";
p["Account Id"] = "";
p["Conflict Id"] = "0";
p["Currency Code"] = "USD";
p["Contact Id"] = "";
p["Account"] = "";
p["Discount"] = "";
p["Primary Organization Id"] = "0-R9NH";
p["Updated"] = "02/11/2005 13:16:32";
p["Integration Id"] = "";
p["End Date"] = "03/13/2005 00:00:00";
p["Due Date"] = "02/12/2005 00:00:00";
p["Active"] = "Y";
p["Created"] = "02/11/2005 13:15:11";
p["Quote Type"] = "Quotation";
p["Quote Number"] = "2-47QI3";
p["Start Date"] = "02/11/2005 00:00:00";
p["Name"] = "2-47QI3";
p["Price List Id"] = "1-D0D8";
c[0] PropertySet@0A98D8E8 p#0 c#0 type="ListOfLine Item" vt=0 value=""
}
}
}
}
None.
Help Method Syntax
ErrCode ActiveDOCOperator(Input Arguments,Output Arguments, const SSstring strMode)
Help Method Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
String: Account Id (optional) String: Compound Product Number (Optional) String: Price List Id (Optional) |
Output Arguments |
Out |
Hierarchy :SiebelMessage(Integration object PDS Quote) |
const SSstring& strMode |
In |
String: Name help to get corresponding workflow, available value could be GetActiveQuote, GetActiveOrder, SetActiveQuote, SetActiveOrder, |
Help Method Error Conditions
IDS_ERR_ANIESALES_MISSING_SERVICE_NAME: The '%1' user property is not defined in business service '%2'
SSAOMErrCannotCreateService: Unable to create the Business Service '%1'
SetActiveQuote Method
Finds the current active quote with input account Id, compound Product Number and Price List Id. If it can find a match, then it returns this quote. If it cannot find a match, then it creates a new quote, sets it as active quote, and returns this quote.
Syntax
Product Data Service.InvokeMethod(“SetActiveQuote", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
String: Account Id (optional) String: Compound Product Number (Optional) String: Price List Id (Optional) |
Output Arguments |
Out |
Hierarchy :SiebelMessage(Integration object PDS Quote) |
This method calls the help method described in GetActiveQuote Method.
GetActiveOrder Method
Finds the current active order with input account Id, compound Product Number and Price List Id. If it can find a match, then it returns this order. If cannot find a match, then it creates new order, sets it as the active order, and returns this order.
Syntax
Product Data Service.InvokeMethod(“GetActiveOrder", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
String: Account Id (optional) String: Compound Product Number (Optional) String: Price List Id (Optional) |
Output Arguments |
Out |
Hierarchy :SiebelMessage(Integration object PDS Quote) |
Example of Input Arguments
PropertySet@0012D370 p#4 c#0 type="" vt=0 value=""
{
p["Account Id"] = "";
p["ProcessName"] = "SIS OM Active Order Sub-Process";
p["Compound Product Number"] = "";
p["Price List Id"] = "";
}
PropertySet@0012DA78 p#0 c#1 type="" vt=0 value=""
{
c[0] PropertySet@0A98A6A8 p#4 c#1 type="SiebelMessage" vt=0 value=""
{
p["MessageId"] = "42-1DFE";
p["IntObjectName"] = "PDS Order";
p["MessageType"] = "Integration Object";
p["IntObjectFormat"] = "Siebel Hierarchical";
c[0] PropertySet@0A9CD9C0 p#0 c#1 type="ListOfPDS Order" vt=0 value=""
{
c[0] PropertySet@0A97E488 p#17 c#1 type="Header" vt=0 value=""
{
p["Account Location"] = "";
p["Revision"] = "1";
p["Id"] = "42-50SNB";
p["Status"] = "Pending";
p["Account Id"] = "";
p["Order Type"] = "Sales Order";
p["Conflict Id"] = "0";
p["Currency Code"] = "USD";
p["Contact Id"] = "";
p["Account"] = "";
p["Discount"] = "";
p["Updated"] = "02/11/2005 14:06:32";
p["Integration Id"] = "";
p["Order Number"] = "146-8435207";
p["Opty Id"] = "";
p["Created"] = "02/11/2005 14:06:32";
p["Price List Id"] = "";
c[0] PropertySet@0A9F7E98 p#0 c#0 type="ListOfLine Item" vt=0 value=""
}
}
}
}
None.
This method calls the help method described in GetActiveQuote Method.
SetActiveOrder Method
Finds current active order with input account Id, compound Product Number and Price List Id, and returns this order. If it cannot find a matching order, then it creates and returns a new one.
Syntax
Product Data Service.InvokeMethod(“SetActiveOrder", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
Input Arguments |
In |
String: Account Id (optional) String: Compound Product Number (Optional) String: Price List Id (Optional) |
Output Arguments |
Out |
Hierarchy :SiebelMessage(Integration object PDS Order) |
Error Conditions
None.
This method calls the help method described in GetActiveQuote Method.
PDS PublishCatalog Test Sample Workflow
This sample workflow illustrates how to create your own workflows that use the Product Data Service API. This workflow is not meant to be used directly.
The inputs and outputs of the Product Data Service API methods are all in the format of the Siebel property set, which can be converted to and from xml files using Siebel EAI. The hierarchy in the output property set is controlled by the Integration Object specified in the input Siebel message.
This workflow is shown in the following figure.
Workflow Description
This workflow does the following:
Query Read From File. Reads the contents from the xml file and converts to SiebelMessage propertyset, which may include integration object for EAI, searchspec that would be applied on the following query and so on. A sample input file is the following:
<?xml version="1.0" encoding="UTF-8" ?> <?Siebel-Property-Set EscapeNames="false"?> - <SiebelMessage MessageId="" IntObjectName="PDS Publish Catalog Interface" MessageType="Integration Object" IntObjectFormat="Siebel Hierarchical"> - <ListOfPublishCatalog> <ProductCatalog searchspec="EXISTS ([Channel Partner] like 'UANPartner1')" /> </ListOfPublishCatalog> </SiebelMessage>
Context Read From File. Reads the contents from the context xml file and converts to context propertyset. A sample context file is the following:
<?xml version="1.0" encoding="UTF-8" ?> <?Siebel-Property-Set EscapeNames="false"?> <Context BusObjName="Quote" BusCompName="Quote" SignalMode="Quote" ContextRowId="2-47J4V" />
Product Selection Service API. Calls the PublishCatalog method of the PDS Product Data Service. The input arguments SiebelMessage and Context are from the output of the previous two steps.
WriteXMLtoFile. Converts the output PropertySet of the previous step into xml format and writes to the result file.
ISS Authoring Import Export Business Service Reference
The main purpose of this business service is to let you move versioned object definitions (VODs) between databases. It supports the following VODs:
ISS_ATTR_DEF - Product attribute Definition. Uses the Integration Object ISS Attr Def ImpExp.
ISS_CLASS_DEF - Product Class Definition. Uses the Integration Object ISS Class Def ImpExp.
ISS_PROD_DEF - Product Definition. Uses the Integration Object ISS Prod Def ImpExp.
ISS_SIGNAL - Signal Definition. Uses the Integration Object ISS Signal ImpExp IntObj.
ISS_VAR_MAP - Variable Map Definition. Uses the Integration Object ISS Variable ImpExp IntObj.
In addition, this business service allows you to fix S_PROD_INT records created with the EIM process so they are usable by the ISS framework. In the case of versioned objects, it creates the minimum set of necessary records that is needed.
Modeling Data Before Using ISS Import Export Authoring Service
To be able to use the standard approach successfully, users must take some precautions during modeling. VODs manually created on two databases are be treated as different objects even if their VOD Names match.
After import, you can freely modify replicated objects in any database and move them around.
Observe the following guidelines to make objects compatible when multiple development environments are required:
Use only one development database to create new VODs.
If a customer is upgrading from release earlier than Siebel CRM version 7.8:
Do not use upgraded development databases. Instead of using those databases, create a new one from single production master.
If you cannot possibly avoid using upgraded development databases, then do not use the VODs that were created during the upgrade of the development databases. Discard those definitions, and change the names of all VODs and products to show clearly that they have been discarded. Then, import necessary definitions from your production database.
Use ADM or the Export/Import process to populate other development databases with existing VOD definitions.
If you must create a new VOD in some database other than the master development database, then first check the master database to see if such object already exists, and move the existing object to your development database. If it does not exist, then create it in your development database and immediately move it to the master development database, so other modelers do not create a duplicate.
Methods of the ISS Import Export Authoring Service
This business service includes the following methods:
Data Export Methods:
Data Import Method:
Application Deployment Manager (ADM) specific Methods:
Helper Methods:
Export VOD Method
Exports stand-alone objects from a Workspace or Joint WorkSpace (JWS) project or a single VOD Definition, based on supplied parameter values. Based on the input, the method determines a set of objects to be exported and produces a list of EAI property sets, corresponding to each of them. The resulting set of PropSets is wrapped in a single PropSet and returned in the output argument.
Syntax
ISS Import Export Authoring Service.InvokeMethod(“ExportVOD", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
MethodName |
In |
ExportVOD |
Input Arguments |
In |
Hierarchical property set which supplies the starting information about export content |
Output Arguments |
Out |
Hierarchical property set which contains the resulting content |
Properties of Input Arguments: combination 1
| Property | Value | Description |
|---|---|---|
RootObjectType |
ISS_JWS |
Indicates that the data is exported from a Joint Workspace Project |
RootObjectId |
Row Id of JWS project |
None |
If this combination of values is passed to the method, then it considers each entry in the content of the JWS project as a Root object. The resulting combined property set will include all of them.
Properties of Input Arguments: combination 2
| Property | Value | Description |
|---|---|---|
RootObjectType |
ISS_ATTR_DEF or ISS_CLASS_DEF or ISS_PROD_DEF or ISS_SIGNAL or ISS_VAR_MAP |
Indicates that the data is exported from a single root object. |
VODObjectNum |
Root's S_VOD.OBJECT_NUM |
Points to the VOD to be exported |
VODVersion |
version number |
Points to the version number to be used in export |
If this combination of values is passed to the method, then it considers a single entry as a Root object. The resulting property set will include only this object (as a child property set).
Error Conditions
Might return generic error codes from Object Manager, From EAI or from service. These codes are mainly about the input format, for example, that a parameter is missing.
ExportFullVOD Method
Similar to the ExportVOD Method. In addition, for ISS_PROD_DEF and ISS_CLASS_DEF structures, for each root object, runs a recursive algorithm to collect a list of dependencies, a set of self-contained objects.
This set includes: parent class definition, attribute definitions used to create local attributes; relationship base class definition; product definitions referred in relationship domain as sub-products.
Resulting combined list of objects is used as a set of objects to be exported in a same way as in ExportVOD.
Syntax
ISS Import Export Authoring Service.InvokeMethod(“ExportFullVOD", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
MethodName |
In |
ExportFullVOD |
Input Arguments |
In |
Depending on the set of properties, supplies the starting information about export content |
Output Arguments |
Out |
Contains Resulting Property Set |
Properties of Input Arguments: combination 1
| Property | Value | Description |
|---|---|---|
RootObjectType |
ISS_JWS |
Indicates that the data is exported from a Joint Workspace Project |
RootObjectId |
Row Id of JWS project |
None |
If this combination of values is passed to the method, then it considers each entry in the content of the JWS project as a Root object. The resulting combined property set will include all of them.
Properties of Input Arguments: combination 2
| Property | Value | Description |
|---|---|---|
RootObjectType |
ISS_ATTR_DEF or ISS_CLASS_DEF or ISS_PROD_DEF or ISS_SIGNAL or ISS_VAR_MAP |
Indicates that the data is exported from a single root object. |
VODObjectNum |
Root's S_VOD.OBJECT_NUM |
Points to VOD to be exported |
VODVersion |
version number |
Points to the version number to be used in export |
If this combination of values is passed to the method, then it considers a single entry as a Root object. The resulting property set includes only this object (as a child property set).
Elements and their Properties in Output Arguments:
The output argument property set is a wrapper around multiple elements. The type of the first element is TableOfContent, and it contains a summary of exported VOD structures.
| Property | Value | Description |
|---|---|---|
FullStructure |
Y or N |
Indicates whether PropSet is self-contained |
NumOutputObjects |
number |
Counter of VOD objects included in PropSet |
Child elements are typed according to VOD Types of each exported Object and represent a short description.
| Property | Value | Description |
|---|---|---|
VOD Type |
object type |
LIC values from MLOV ISS_VOD_TYPE |
VOD Name |
object name |
None |
VOD Object Num |
object integration id |
OBJECT_NUM value |
IntObjectName |
EAI object name |
Specifies the integration object to be used for importing |
Other elements are:
PropSets, containing the results of EAI Query operation for a particular VOD object. The standard format, conforming to Integration Object definition (depending on VOD type).
PropSets, containing the results of the EAI Query operation for additional structures, related to Product Promotions, in case one of the listed VODs was a header of a promotion object. The standard format, conforming to Integration Object definition (ISS Promotion).
Error Conditions
Might return generic error codes from Object Manager, From EAI or from service. These codes are mainly about input format, for example, that a parameter is missing parameter.
ImportVOD Method
This method:
Decomposes the content of the input argument’s PropSet into individual objects that are used as source Sub-Propsets.
Locates appropriate VOD in the target database.
Adjusts some values in source Sub-Propsets.
Locks the object and overwrites Workspace version content with data supplied in the Sub-Propsets.
Adds successfully imported object references to the JWS project content specified in the input arguments, which is locked for further editing by the user who initiated this import operation.
In the default mode, object resolution is performed by S_VOD.OBJECT_NUM (object identifier) matching (for example, field VOD Object Num of VOD ImpExp BC element), representing a stable Integration ID, persistent across different databases.
In rare cases, when a one-time import is required, importing the full structure might be performed in a special mode where objects and their references are resolved by names, instead of IDs. This name-based import can be used for objects created in versions earlier than Siebel CRM 7.8. In this mode, the input property-set must contain a full structure. All VODs referenced any VOD in the property set must be present. For VODs, already present in the target database, the source OBJECT_NUMs and their references are replaced with target values. For new objects, the source OBJECT_NUMs are preserved. If two VODs have the same OBJECT_NUMs, then the application treats this conflict as an unresolvable conflict. The resulting imported objects are different objects and will not map to each other in the standard scenario.
Syntax
ISS Import Export Authoring Service.InvokeMethod(“ImportVOD", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
MethodName |
In |
ImportVOD |
Input Arguments |
In |
Property set with the input parameters containing VOD structures |
Output Arguments |
Out |
Contains a description of the performed actions. In case of conflicts, it contains a report string in the Warning property. |
Property set input arguments must have the same structure as the property set output arguments described in Export VOD Method.
Properties of Input Arguments
| Property | Value | Description |
|---|---|---|
RootObjectType |
ISS_JWS |
Indicates that the data is imported from a Joint Workspace Project. |
RootObjectName |
JWS project Name |
Name of JWS Project to be used for import.
Note: A new JWS project of this name must have been created in Administration - Products, Workspace Projects view.
|
NoTargNameChange |
Y or N |
Forbid VOD and Product name change in target database. Optional Default = N
Note: If you need to change the product name, as part of the product import, then this parameter must be set to Y.
|
NoSrcNameChange |
Y or N |
Forces strict preservation of source VOD and Product names. Optional Default = N |
ReportOnly |
Y or N |
Forces the process to end immediately after the initial analysis of input property set is done to examine the potential problems of VOD mapping. Optional Default = N
Note: If ReportOnly = Y is one of the input arguments, then the data is not committed to the database. Only an analysis of the export file is done for possible conflicts. The log file in this case will always have Import Status = Aborted. This input argument is used to validate the file being imported and reports the possible conflicts without doing an import.
|
UseNamesAsKeys |
Y or N |
Triggers 7.7 style import Optional Default = N
Note: In order to trigger Name-Based Import, you must set the input argument UseNameAsKeys = Y.
|
AutoProceed |
Y or N |
Allows automatic conflict resolution if possible. Optional Default = N
Note: If you are doing a Name-Based Import (UseNamesAsKeys=Y), then you must also set input argument AutoProceed=Y.
|
Modifying Defaults
The following default settings can be modified through repository changes:
NoTargNameChange. The default is set to Y if the business service ISS Authoring Import Export Service has a User Property VOD_NO_TRG_NAME_CHANGE = TRUE, or if Applet ISS VOD Import Popup Applet has User Property NoTargNameChange = Y or N. The applet user property overrides the business service user property.
NoSrcNameChange. The default is set to Y if the business service ISS Authoring Import Export Service has a User Property VOD_NO_SRC_NAME_CHANGE = TRUE, or if Applet ISS VOD Import Popup Applet has User Property NoSrcNameChange = Y or N. The applet user property overrides the business service user property.
AutoProceed. The default is set to Y or N if the Applet ISS VOD Import Popup Applet has a User Property AutoProceed = Y or N.
ReportOnly. The default is set to Y or N if the Applet ISS VOD Import Popup Applet has a User Property ReportOnly = Y or N.
Conflict Resolutions
By default, conflicting records are not imported. If you want to resolve conflicts automatically, you must set one of the following parameters:
Set the property AutoProceed of the input arguments to the ImportVOD method to Y.
Set User Property AutoProceed of the Applet ISS VOD Import Popup Applet to Y.
By default, both of these parameters are set to N. You must set one or the other to Y to enable automatic conflict resolution.
Automatic conflict resolution is done in the following way:
For same Object Num, the target or source VOD’s Name wins depending on the parameters, if possible.
For different Object Num, and same Name (VOD name or Product Name), the target name remains unchanged. A new object name is appended with Object Num in parenthesis, if possible.
Problems are reported, in string format, in the output parameter of the PropSet Warning.
Properties of Output Argument
| Property | Value | Description |
|---|---|---|
Warning |
string |
Success or all encountered problems. (List of problems might be incomplete if the method exited with fatal error.) |
One child element of type Object.
| Property | Value | Description |
|---|---|---|
RootObjectType |
ISS_JWS |
Used by Application Deployment Manager (ADM). For more information, see Siebel Application Deployment Manager Guide. |
RootObjectName |
name of JWS |
Used by Application Deployment Manager (ADM). For more information, see Siebel Application Deployment Manager Guide. |
Import Status |
Success, Aborted, Partial, or Failed |
Overall status of JWS import. |
ErrorMessage |
ErrorMessage |
This error message is present only in case of catastrophic error (if Imp.Status == Failed) |
The set of elements of the type determined by MLOV ISS_VOD_TYPE, with each element corresponding to each individual VOD from the input arguments.
| Property | Value | Description |
|---|---|---|
VOD Type |
ISS_ATTR_DEF,ISS_CLASS_DEF, ISS_PROD_DEF |
The type of the object |
Src VOD Object Num |
Persistent id |
Source integration ID |
Src VOD Name |
VOD name |
Source VOD Name |
Src Product Name |
Product name |
Source product name (only for products) |
Src Org Name |
Organization name |
Source organization name (only for products) |
Src Vendor Name |
Vvendor name |
Source vendor name (only for products) |
Trg VOD Object Num |
Persistent id |
Target integration ID |
Trg VOD Name |
VOD name |
Target VOD Name |
Trg Product Name |
Product name |
Target product name (only for products) |
Trg Org Name |
Organization name |
Target organization name (only for products) |
Trg Vendor Name |
Vendor name |
Target vendor name (only for products) |
Res VOD Object Num |
Persistent id |
Resulting integration ID |
Res VOD Name |
VOD name |
Target VOD Name |
Res Product Name |
Product name |
Resulting product name (only for products) |
Res Org Name |
Organization name |
Resulting organization name (only for products) |
Res Vendor Name |
Vendor name |
Resulting vendor name (only for products) |
UK Conflict Status |
0, 1, 2, 3, 4, 5, or 6 |
Internal conflict code used in UK conflict |
Conflict Type |
Resolvable or Unesolvable |
Specifies whether the conflict can be resolved using automatic conflict resolution |
Warning |
Part of a global warning string related to this object |
Warning message for this object (if a one exists) |
Import Status |
Failed or Success |
The import status of this object |
Error Conditions
Might return generic error codes from Object Manager, from EAI, or from service. These codes are mainly about the input format, for example, that a parameter is missing.
ADMValidate Method
Given an ADM project item’s deployment filter, determines if it is valid. Performs the following validation checks:
Checks that the deployment filter has a joint workspace name specified.
Checks that the given joint workspace exists.
Checks that if the [Full] export method is given, that it is Y or N.
Syntax
ISS Import Export Authoring Service.InvokeMethod(“ADMValidate", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
MethodName |
In |
ADMValidate |
Input Arguments |
In |
Hierarchical property set containing VOD structures |
Output Arguments |
Out |
none |
Properties of Input Arguments
| Property | Value | Description |
|---|---|---|
EAI Search Spec |
ADM deployment filter |
ADM deployment filter |
ADMPreview Method
Given an ADM session's deployment filter (such as an EAI Search Specification), returns a valid search specification for ISS Joint Workspace View. Basically, this function parses out the [Full] parameter in the deployment filter.
Syntax
ISS Import Export Authoring Service.InvokeMethod(“ADMPreview", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
MethodName |
In |
ADMPreview |
Input Arguments |
In |
Unparsed filter |
Output Arguments |
Out |
Search specification |
Properties of Input Arguments
| Property | Value | Description |
|---|---|---|
EAI Search Spec |
ADM deployment filter |
ADM deployment filter |
Properties of Output Arguments
| Property | Value | Description |
|---|---|---|
EAI Search Spec |
Search Specification |
Search Specification for ISS Joint Workspace View |
ADMExport Method
Given an input argument property set with a valid SessionId, which represents the Row_Id of the deployed ADM session, exports the joint workspace specified in the deployment filter of the ADM session. Export is done through a call to ExportAlgorithm. The deployment filter also specifies whether to do a full structure export. Returns an output argument property set with the exported VOD property set, along with additional bookkeeping information (JSW name, Status, Reason)
Syntax
ISS Import Export Authoring Service.InvokeMethod(“ADMExport", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
MethodName |
In |
ADMExport |
Input Arguments |
In |
ADM Information |
Output Arguments |
Out |
Same as ExportVOD with additional properties |
Properties of Input Arguments
| Property | Value | Description |
|---|---|---|
SessionId |
Row_Id |
Row_Id of the deployed ADM session |
Properties of Output Arguments
| Property | Value | Description |
|---|---|---|
JWSName |
Name of JWS Project |
Name of JWS project to be used when importing prop set on other side |
Status |
Processed or Failed |
Result of operation |
Reason |
String |
In case of failure contains the cause of failure |
ADMImport Method
Given an input argument property set, which contains the exported joint workspace data as a single child property set, import the data using ImportAlgorithm.
Syntax
ISS Import Export Authoring Service.InvokeMethod(“ADMImport", Input Arguments,Output Arguments);
Arguments
Same as ImportVOD Method.
ReleaseSingleObject Method
This helper method releases a particular object. If the object is locked by another user, then the method generates an error.
Syntax
ISS Import Export Authoring Service.InvokeMethod(“ReleaseSingleObject", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
MethodName |
In |
ADMExport |
Input Arguments |
In |
Information for releasing an object |
Output Arguments |
Out |
None |
Properties of Input Arguments
| Property | Value | Description |
|---|---|---|
ReleaseDT |
Release date in canonical format (user time) |
Release date in canonical format (user time) |
RootObjectType |
ISS_ATTR_DEF or ISS_CLASS_DEF or ISS_PROD_DEF or ISS_SIGNAL or ISS_VAR_MAP |
Type of the object (LIC value from ISS_VOD_TYPE mlov) |
RootObjectId |
Id of the object |
S_VOD.OBJECT_NUM or S_PROD_INT.CFG_MODEL_ID |
ReleaseJwsObjects Method
This method releases all objects contained in a particular Joint Workspace. The Release date of all objects is determined using the value of S_ISS_JWS.EFF_RELLEASE_DT field; if this field is empty, then the objects are released as of the current moment.
If one of the objects is locked by another user, then the method generates an error.
Syntax
ISS Import Export Authoring Service.InvokeMethod(“ReleaseJwsObject", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
MethodName |
In |
ReleaseJwsObjects |
Input Arguments |
In |
Information for releasing JWS content |
Output Arguments |
Out |
None |
Properties of Input Arguments
| Property | Value | Description |
|---|---|---|
RootObjectType |
ISS_JWS |
Keyword |
RootObjectName |
Name of the JWS record |
Name of the JWS record |
Post_EIM_Upgrade Method
This method locates all records in S_PROD_INT with missing or broken association with the S_VOD record and creates the necessary supporting structure for versioning.
Depending on the input property set parameters, the method can operate in two different modes: standard or staging mode.
For each identified entry in S_PROD_INT, it does the following:
Creates an appropriate header record (S_VOD)
Creates an appropriate non-released definition record (S_ISS_OBJ_DEF)
Creates an appropriate non-released version record (S_VOD_VER)
In Staging mode, it continues by doing the following:
Registers the newly created header record in the supplied Joint Workspace
In Standard behavior mode, it continues by doing the following:
Creates appropriate released definition record (S_ISS_OBJ_DEF)
Creates appropriate released version record (S_VOD_VER), with the current time as the Start Time of the version
In both modes, if you set the property ReportOnly = TRUE, then the upgrade does not occur and the method only generates a report of orphan records. In this case, the output property set's property Warning contains a report of errors or list of orphans.
Syntax
ISS Import Export Authoring Service.InvokeMethod(“Post_EIM_Upgrade", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
MethodName |
In |
Post_EIM_Upgrade |
Input Arguments |
In |
Information for releasing JWS content |
Output Arguments |
Out |
Reporting problems |
Properties of Input Arguments (standard mode)
| Property | Value | Description |
|---|---|---|
ReportOnly |
TRUE or FALSE |
Optional parameter triggering output that is only a report, with no upgrade. |
Properties of Input Arguments (staging mode)
| Property | Value | Description |
|---|---|---|
RootObjectType |
ISS_JWS |
Keyword triggering staging mode |
RootObjectName |
Name of JWS project |
Name of existing JWS project |
ReportOnly |
TRUE or FALSE |
Optional parameter triggering output that is only a report, with no upgrade. |
Properties of Output Arguments
| Property | Value | Description |
|---|---|---|
Warning |
String |
Report of errors or list of orphans records if ReportOnly is on. |
Example
After using EIM to import data into S_PROD_INT, you must execute the method Post_EIM_Upgrade with the Input Argument ReportOnly = False to release the products. If ReportOnly = TRUE, then no changes are made to the database.
There are two modes for using this method:
Staging mode. The resulting upgraded products are not published (released) automatically. Use staging mode if you are not testing the result prior to releasing the products. Instead, you test them from the interface before releasing them.
Standard mode. Use the parameter ReportOnly = FALSE for the official run. Use ReportOnly = TRUE for testing purposes so that the database is not changed and the report specifies what data might be generated.
After EIM imports, you can use the business service simulator to execute with ReportOnly = FALSE to release the imported products. Execute using the business service simulator as follows:
Name: ISS Authoring Import Export Service:
Method: Post_EIM_Upgrade
Test#: 1
Properties: create 1 records:
Name: ReportOnly:
Value: FALSE
CleanupSingleObject Method
This helper method performs deep delete on all published versions of an object. It resets version numbering to 1. The workspace version remains intact.
This method works even if the object is not locked.
Syntax
ISS Import Export Authoring Service.InvokeMethod(“CleanupSingleObject", Input Arguments,Output Arguments);
Arguments
| Argument | Type | Description |
|---|---|---|
MethodName |
In |
CleanupSingleObject |
Input Arguments |
In |
Information for cleaning an object |
Output Arguments |
Out |
None |
Properties of Input Arguments
| Property | Value | Description |
|---|---|---|
RootObjectType |
Possible values are:
|
Type of the object, which is the LIC value from the ISS_VOD_TYPE list of values. |
VODObjectNum |
Id of the object |
S_VOD.OBJECT_NUM or S_PROD_INT.CFG_MODEL_ID |