17 Publish Catalog Entities

Integrate with Siebel CRM

You can migrate and publish catalog definitions along with their extensions between Siebel and Launch application.

Overview

Migration enables Launch to be the primary source of migrated entities. Launch serves as the primary source for catalog definitions, with Siebel CRM consuming these definitions. By using the prebuilt integration between the two applications, you can perform a one-time migration of catalog definitions from Siebel to establish them as the authoritative source in Launch. Further updates to the migrated entities or creation of new entities will be carried out in Launch and published to Siebel via the CX Industries framework. You must have Catalog Administrator privilege to migrate entities.

Note:

For detailed information on setting up the sync, see Launch Cloud Service Integration Guide.

What you can Migrate or Publish

Here’s the list of entities that you can migrate along with the details about the seeded mappings available to you in the JSON file.

Table 17-1 List of Entities to Migrate and Publish

Entity name in Siebel CRM Entity Name in Launch What you can migrate

Catalog

Catalog

  • Definition
  • Category Association

Category

Category

  • Definition
  • Sub-categories
  • Product Association

Product Class

Product Specification

  • Definition
  • Parent-Child Relationships
  • Attributes
  • Smart Part Number (user defined)

Products

Simple Offer

  • Definitions
  • Category/Class/Product Line association
  • Prices and Adjustments
  • Compatibility and Eligibility Rules
  • Recommendation and Migration Rules (Publish only)

Product Line

Product Line

  • Definition
  • Product association
  • Compatibility and Eligibility Rules

Price list

Price list

  • Definition and its associations

Promotion

Package

  • Definitions
  • Category/Class/Product Line association
  • Components along with Aggregates and Option Class
  • Compatibility and Eligibility Rules
  • Recommendation and Migration Rules (Publish only)

External Job (Migration Job)

To migrate entities, you must create a migration job.

As a pre-requisite, it is mandatory to complete the post provision process detailed in Launch Cloud Service Implementation Guide. See Integrate Launch with Siebel CRM.

Here’s a summary of the steps to create a migration job:

  1. Go to AdministrationJob Management and click Manage.
  2. On the Job Management page, click Migration Jobs, and then click Create Migration Job.
  3. Select a source application from which the entities will be migrated.
  4. Select the appropriate API for the entity that you want to migrate and complete the query parameters along with the value as described in the following table.

    Table 17-2 Available APIs with Query Parameters

    Available APIs Query parameters Sample Query parameters Value What's migrated using the APIs

    /migration/class

    1.$.SiebelMessage['ListOfSWIAdminISSClass DefinitionIO'] ['SWI ISS Class VOD BusComp'].searchspec

    2.$.SiebelMessage.ListOfSWIAdminISSClass DefinitionIO. ['SWI ISS Class VOD BusComp'].['VOD Name']

    3.$.SiebelMessage.ListOfSWIAdminISSClass DefinitionIO. ['SWI ISS Class VOD BusComp'].['VOD Id']

    The searchspec can be used across the API by following the syntax as follows '[<fieldName>] <= or LIKE> <fieldValue>' as shown in sample 1.

    1. "queryValue": "([VOD Name] like 'Supremo*')".
    2. queryValue": "Supremo 5G Dual"
    3. queryValue": "88X3281"

    Product class with its attributes.

    /migration/pricelists

    No query parameter.

    No query_param/ query_value in request

    All the pricelists available at the source.

    /migration/package_ref

    $.SiebelMessage['ListOfSWI Admin ISS Product Definition'].['SWI Internal Product VOD'].Name

    N/A

    N/A

    /migration/pricelists_by_id

    @pathParam(id)

    "queryValue": "88-290-3"

    Pricelist based on the specific ID.

    /migration/catalog

    $.SiebelMessage['ListOfBase Catalog Admin'].['Product Catalog'].Name

    "queryValue": "Mob*"

    Catalog and its associated categories.

    /migration/device

    $.SiebelMessage['ListOfSWI Admin ISS Product Definition'].['SWI Internal Product VOD'].Name

    "queryValue": "Supremo 5G Dual"

    Product is migrated as an atomic product offer of type Device.

    /migration/service

    $.SiebelMessage['ListOfSWI Admin ISS Product Definition'].['SWI Internal Product VOD'].Name

    "queryValue": "Supremo Wireless Service"

    Product is migrated as atomic product offer of type Service.

    /migration/device_ref

    $.SiebelMessage['ListOfSWI Admin ISS Product Definition'].['SWI Internal Product VOD'].Name

    "queryValue": "Supremo Mustang 4G"

    Product is migrated as atomic product offer of type Device along with its referenced entities.

    /migration/service_ref

    $.SiebelMessage['ListOfSWI Admin ISS Product Definition'].['SWI Internal Product VOD'].Name

    "queryValue": "Supremo GPRS"

    Product is migrated as atomic product offer of type Service along with its referenced entities.

    /migration/productCompatiblity

    $.SiebelMessage['ListOfSWI Admin ISS Product Definition'].['SWI Internal Product VOD'].Name

    "queryValue": "Supremo Dual Wireless Bundle"

    Rules associated with the product.

    /migration/productLine

    $.SiebelMessage.['ListOfSWI Admin Product Line'].['Admin Product Line'].Name

    "queryValue": "Supremo Handsets"

    Product line

  5. The Migration API header parameters section contains the default header parameters to invoke the API job.

    Table 17-3 Migration API Header Parameters

    Key Required or Optional Description

    X-Source-PreSelection

    Required

    The source application instance name defined in TTD/TIC as TargetPreselection. Used for routing.

    X-Target-PreSelection

    Optional

    Target application instance name defined in TTD/TIC as TargetPreselection. Used for routing.

    X-Version

    Optional

    Version of the mapping

    X-Destination-System

    Required

    Destination name defined in mapping

    X-Source-System

    Required

    Source name defined in mapping

    Test-Mode

    Optional

    true/false to toggle test/api mode

    Mode-Type

    Required for TEST Mode

    WITH_SUB_QUERY/TRANSFORMED_RESPONSE

    Source-Response-Index

    Required for Test Mode

    Used for multiple objects returned by source query

    Target-Api-Path

    Optional for Test mode

    Path for target API defined in mapping

    Use-Sample-Response

    Optional for Test Mode

    true/false to toggle sample data/real data

    X-Target-Bulk-Api-Batch-Size

    Optional

    Numeric value which helps in processing the targetApi path

    User-<Key>

    Optional

    This user key is as defined in the mapping schema. For example, using siebel_launch.json schema user can pass User-Project-Name, User-Project-Id and User-Project-Create to pass project name, project id and whether to create a project or use an existing one.

  6. In case you expect a high number of migration records in a job, use the batch parameters fields like Page Size, Start Offset, and Batches to specify the number of records to be processed per batch along with the offset.
  7. Click Submit.

    You have now submitted your migration job.

After you submit your catalog migration job, you can monitor the summary of the job. To view the summary, from the Launch home go to Administration > Job Management > Migration Jobs.

The job details include the job ID, source application, and details about the number of records fetched, processed, failed or skipped. You can also download from the UI the log file containing details about the migration job. If there’s an error in migration, the job details include an error message showing the possible cause.

Publish Job

The publication of updates to migrated entities or new entities created in Launch to Siebel continues to follow the existing CX Industries Framework.

Things to consider during Migration and Publish:
  • Prior to migration simple products from Siebel, the same should be segregated as service or device type and the respective APIs is to be invoked for migration into Launch.
  • All the customizable bundles will be migrated as commercial bundles into Launch.
  • The migration will always pick the latest released version into Launch.
  • Any product which does not hold the mandatory association like the product specification or service specification entities will be migrated with default ‘Dummy Product Spec’ and ‘Dummy Service Specification’ into Launch.
  • The entities published from Launch will be created under a default workspace.
  • The published entities will be in released state in Siebel.
  • The products with more than one POP of same price type or multiple price type will be published as a customizable bundle (CP) with simple product (SP) for every independent POP.
  • The commercial bundle or service bundle will be published with structure type = customizable.
  • Any commitment terms at promotional level are to be created in Siebel post publish.

Known limitations between Launch and Siebel CRM

Launch does not support the following:
  • Alteration types like Price Override, Multiplicative Amount, Round, and Power.
  • Effective period at overall volume discount level.
  • Multiple Active versions for a product.
  • Independent Pricing at package offer/commercial bundle level.