A Appendix

Setting Default Entities

This appendix provides details and sample payloads for the default entities that must be configured in Launch to ensure smooth integration and migration from Siebel CRM.

Service Specification

Entity Name: Siebel-Default-SS

Description: It is mandatory to have a Service Specification in Launch to create Service offers.

Sample Payload:

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

Note:

• When creating a Service Specification, ensure the API request includes the query parameter skipFeatureProfile=true in the endpoint URL.
  Sample API Call:

  • Method: PUT
  • Endpoint: {{FA_APIGW}}/api/serviceCatalogManagement/v3/serviceSpecification/Siebel-Default-SS?skipFeatureProfile=true

Product Specification

Entity Name: Siebel-Default-PS

Description: 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.

Sample Payload:

 {
    "id": "Siebel-Default-PS",
    "name": "Siebel Default PS",
    "description": "Default Product Spec for Siebel 
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",
            "version": "1.0",
            "@type": "ServiceSpecificationOracle",
            "@referredType": 
"ServiceSpecificationOracle",
            "role": "PRIMARY"
        }
    ]
 }

Price List

Entity Name: Siebel-Default-PL

 {
    "id": "Siebel-Default-PL",
    "name": "Siebel Default PL",
    "version": "1.0",
    "lifecycleStatus": "Active",
    "@type": "PricelistOracle",
    "validFor": {
        "startDateTime": "2021-09-09T17:16:49.496Z"
    },
    "balanceElement": {
        "id": "USACurrency",
        "name": "USA Currency",
        "@type": "BalanceElementRef",
        "@referredType": "BalanceElementOracle"
    },
    "pricelistType": "RESIDENTIAL",
    "currency": "USD"
 }

Custom Profile Specification (Aggregate Discount)

Entity Name: Siebel Default Aggregate Discount CPS

Description: 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.

Sample Payload:

 {
    "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",
            "@type": "CustomProfileSpecChar",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": 
"2022-02-22T00:00:00.000Z"
            }
        }
    ]
 }

Custom Profile Specification (Discount Matrix)

Entity Name: Siebel Discount Matrix CPS

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

Sample Payload:

{
    "id": "Siebel-Default-DiscMat-CPS",
    "name": "Siebel Default Discount Matrice CPS",
    "description": "Default Custom Profile Spec",
    "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",
            "@type": "CustomProfileSpecChar",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": 
"2022-02-22T00:00:00.000Z"
            },
            "customProfileSpecCharValue": [
                {
                    "value": "Clinic",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Commercial",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Company",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Competing Dealer",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Competing OEM",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Competitor",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Consultant",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Contact Us",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Contract Manufacturer",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Convention Center",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Corporate Training Center",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Corporate/Transient",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Corporation",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Dealer",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Department",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Department Group",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Military",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "QSR",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Ship To",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Convenience Store",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Manufacturer Rep",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "ODM",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Design House",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "3rd Party Training Center",
                    "valueType": "STRING",
                    "@type":
 "StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "All Suite",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Auto/Home Supply Store",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Banking",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Body Shop",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Branch",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Broker",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Business",
                    "valueType": "STRING",
                    "@type":
 "StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Business Customer",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Advertiser",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Central Bank",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Chain Drug",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Chain Food",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Department Store",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Residential",
                    "valueType": "STRING",
                    "@type": 
 "StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Customer",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Agency",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Vendor",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Committee",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Contract Research 
Organization",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Surgery",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Chemist",
                    "valueType": "STRING",
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Clinical Directorate",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "District Health 
Authority",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Drug Committee",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Hospital Unit",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Practice",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "PBM",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                },
                {
                    "value": "Pharmaceutical Company",
                    "valueType": "STRING",
                    "@type": 
"StringCharacteristicValueSpecification",
                    "isDefault": false
                }
            ]
        },
        {
            "name": "Product Offering",
            "valueType": "PRODUCT_OFFER",
            "@type": "ProductOfferingOracle",
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": 
"2022-02-22T00:00:00.000Z"
            }
        }
    ]
 }

Note:

The lifecycle Status for these default objects must be set to Active. To do this, send a PATCH request to 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.