1. Integration Guide
  2. Appendix

A Appendix

Setting Default Entities

Table A-1 Setting Default Entities

Entity Sample Payload Description

Service Specification

Siebel-Default-SS

{
"id": "Siebel-Default-SS", "name": "Siebel Default SS",
"description": "Default Service Spec for Sibel Product Spec", "version": "1.0", "lifecycleStatus": "Active", "isBundle":
false,
"@type": "ServiceSpecificationOracle", "validFor": { "startDateTime": "2010-06-19T16:42:23.000Z"
}
}

It is mandatory to have a Service Specifocation in Launch to create Service offers.

Product Specification

Siebel-Default-PS

{
"id": "Siebel-Default-PS", "name": "Siebel Default PS",
"description": "Default Product Spec for Sibel Migration", "version": "1.0", "lifecycleStatus": "Active", "isBundle":
false,
"@type": "ProductSpecificationOracle", "validFor": { "startDateTime": "2010-06-19T16:42:23.000Z"
},
"serviceSpecification": [
{
"id": "Siebel-Default-SS", "name": "Siebel Default SS", "href": "https://
{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf- api/serviceCatalogManagement/v3/serviceSpecification/Siebel- ServiceSpec",
"version": "1.0",
"@referredType": "ServiceSpecificationOracle", "role": "PRIMARY"
}
]
}
Siebel CRM allows to create simple products without association with classes. However, it is mandatory to specify a product specification in Launch for device and service offers.

Custom Profile Specification

Siebel Default Aggregate Discount CPS

{
"id": "Siebel-Default-AggDisc-CPS",
"name": "Siebel Default Aggregate Discount CPS", "description": "Default Custom Profile Spec",  "version": "1.0", "lifecycleStatus": "Active", "profileType":
"DEVICE_SPEC",
"@type": "CustomProfileSpecificationOracle", "validFor": { "startDateTime": "2022-02-19T16:42:23.000Z"
},
"customProfileSpecChar": [
{
"name": "Product Offering", "valueType": "PRODUCT_OFFER", "@type":
"ProductOfferingOracle", "configurable": true, "minCardinality": 0,
"maxCardinality": 1,  "validFor":  { "startDateTime": "2022-02-22T00:00:00.000Z"
}
},
{
"name": "Quantity", "valueType": "NUMBER", "configurable": true, "minCardinality": 0, "maxCardinality": 1, "validFor": {
"startDateTime": "2022-02-22T00:00:00.000Z"
    }
   }
  ]
 }

The migration process is expected to have a custom profile specification with quantity and product offer to be available for a successful formation of aggregate discounts.

Custom Profile Specification

Siebel Discount Matrix CPS

Siebel Discount Matrix CPS

{
"id": "Siebel-Default-DiscMat-CPS",
"name": "Siebel Default Discount Matrice CPS", "description": "Default Custom Profile Spec", "href": "https://fa-wrpt-pintlabfadev.fa.ocs.oc-
test.com/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenc eManagement/v1/customProfileSpecification/Siebel-Default-DiscMat-CPS",
"version": "1.0", "lifecycleStatus": "Active",
"created": "2022-07-05T11:07:36.000Z",
"createdBy": "booth",
"lastUpdate": "2022-07-19T09:33:13.499Z",
"lastUpdatedBy": "booth",
"@type": "CustomProfileSpecificationOracle", "validFor": {
"startDateTime": "2022-02-19T16:42:23.000Z"
},
"profileType": "DEVICE_SPEC", "customProfileSpecChar": [
{
"name": "Account Type", "valueType": "STRING", "configurable": true, "minCardinality": 0,
"maxCardinality": 1, "validFor": {
"startDateTime": "2022-02-22T00:00:00.000Z"
},
"customProfileSpecCharValue": [
{
"value": "Clinic", "valueType": "STRING", "isDefault": false
},
{
"value": "Commercial", "valueType": "STRING", "isDefault": false
},
{
"value": "Company", "valueType": "STRING", "isDefault": false
},
{

"value": "Competing Dealer", "valueType": "STRING", "isDefault": false
},
{
"value": "Competing OEM", "valueType": "STRING", "isDefault": false
},
{
"value": "Competitor", "valueType": "STRING", "isDefault": false
},
{
"value": "Consultant", "valueType": "STRING", "isDefault": false
},
{
"value": "Contact Us", "valueType": "STRING", "isDefault": false
},
{
"value": "Contact Manufacturer", "valueType": "STRING", "isDefault": false
},
{
"value": "Convention Center", "valueType": "STRING", "isDefault": false
},
{
"value": "Corporate Training Center", "valueType": "STRING", "isDefault": false
},
{
"value": "Corporate/Transient", "valueType": "STRING", "isDefault": false
},
{
"value": "Corporation", "valueType": "STRING", "isDefault": false
},
{
"value": "Dealer", "valueType": "STRING", "isDefault": false
},
{
"value": "Department", "valueType": "STRING", "isDefault": false
},
{
"value": "Department Group", "valueType": "STRING", "isDefault": false
},
{
"value": "Military", "valueType": "STRING", "isDefault": false
},
{
"value": "QSR", "valueType": "STRING", "isDefault": false
},
{
"value": "Ship To", "valueType": "STRING", "isDefault": false
},
{
"value": "Convenience Store", "valueType": "STRING", "isDefault": false
},
{
"value": "Manufacturer Rep", "valueType": "STRING", "isDefault": false
},
{
"value": "ODM", "valueType": "STRING", "isDefault": false
},
{
"value": "Design House","valueType": "STRING", "isDefault": false
},
{
"value": "3rd Part Training Center", "valueType": "STRING", "isDefault": false
},
{
"value": "All Suite", "valueType": "STRING", "isDefault": false
},
{
"value": "Auto/Home Supply Store", "valueType": "STRING", "isDefault": false
},
{
"value": "Banking", "valueType": "STRING", "isDefault": false
},
{
"value": "Body Shop", "valueType": "STRING", "isDefault": false
},
{
"value": "Branch", "valueType": "STRING", "isDefault": false
},
{
"value": "Broker", "valueType": "STRING", "isDefault": false
},
{
"value": "Business", "valueType": "STRING", "isDefault": false
},
{
"value": "Business Customer", "valueType": "STRING", "isDefault": false
},
{
"value": "Advertiser", "valueType": "STRING", "isDefault": false
},
{
"value": "Central Bank", "valueType": "STRING", "isDefault": false
},
{
"value": "Chain Drug", "valueType": "STRING", "isDefault": false
},
{
"value": "Chain Food", "valueType": "STRING", "isDefault": false
},
{
"value": "Department Store", "valueType": "STRING", "isDefault": false
},
{
"value": "Residential", "valueType": "STRING", "isDefault": false
},
{
"value": "Customer", "valueType": "STRING", "isDefault": false
},
{
"value": "Agency", "valueType": "STRING", "isDefault": false
},
{
"value": "Vendor", "valueType": "STRING", "isDefault": false
},
{
"value": "Committee", "valueType": "STRING", "isDefault": false
},
{
"value": "Contract Research Organization","valueType": "STRING", "isDefault": false
},
{
"value": "Surgery", "valueType": "STRING", "isDefault": false
},
{
"value": "Chemist", "valueType": "STRING", "isDefault": false
},
{
"value": "Clinical Directorate", "valueType": "STRING", "isDefault": false
},
{
"value": "District Health Authority", "valueType": "STRING", "isDefault": false
},
{
"value": "Drug Committee", "valueType": "STRING", "isDefault": false
},
{
"value": "Hospital Unit", "valueType": "STRING", "isDefault": false
},
{
"value": "Practice", "valueType": "STRING", "isDefault": false
},
{
"value": "PBM", "valueType": "STRING", "isDefault": false
},
{
"value": "Pharmaceutical Company", "valueType": "STRING", "isDefault": false
}
]
		},
		{
	"name": "Product Offering", "valueType": "PRODUCT_OFFER", "@type": "ProductOfferingOracle", "configurable": true, "minCardinality": 0,
	"maxCardinality": 1, "validFor": {
	"startDateTime": "2022-02-22T00:00:00.000Z"
		}
	   }
	  ]
     }

The migration process is expected to have a custom profile specification with values present in Siebel.

Note:

The lifecycle Status for these default objects must be set to Active. To do this, run PATCH method call on the respective rest APIs.

Downloading Third Party CMS Swagger

Use this GET request to download the Third Party CMS Swagger.

GET - https://{FAHOST}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/swagger/ThirdPartyCMSSwagger

This comprehensive API reference will provide in-depth information on all available operations and data structures and different sample requests and responses for the CMS integration.

Downloading Third Party Function Service Swagger

Use this GET request to download the Third-Party Function Service Swagger:

GET - https://{FAHOST}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/swagger/PreTransformExternalFunction

This comprehensive API reference will provide in-depth information on all available operations and data structures and different sample requests and responses for the Third-Party Function service integration for both Transform and PreTransform API’s.