2 Integration with PDC (BRM)

This chapter outlines the configuration steps required to integrate Launch with Pricing Design Center (PDC) or Billing Revenue Management (BRM). The integration helps customers who want to take advantage of the latest capabilities of the Oracle Launch Cloud Service while leveraging their existing investment in BRM.

Related Guides

Table 2-1 contains information about other useful sources of information for the integration process.

Table 2-1 Related Guides

Reference Description
Launch Cloud Service User's Guide Describes how you can create, publish, and manage product offers.
REST API Reference for Launch Cloud Service Provides the REST API reference document for Launch Cloud Service.
PDC REST Services Manager Overview PDC documentation to create client credentials and security requirements for PDC/RSM deployment.

Supported Versions

The minimum required application for this feature is:
  • Launch release version 26.04 or later
  • Oracle PDC/BRM 12 PS8 plus Patch 35361657

Supported Integration and Mapping

Launch-PDC Integration uses the mapping service which enables you to create a proxy API that can push the data into PDC/BRM. The mapping service currently works for the following entities in Launch. All other entities are ignored. Table 2-2 lists the entities that can currently be mapped.

Table 2-2 Supported Integration and Mapping

Launch Entity PDC Entity What can you synchronize?

Simple product offering

Charge offer of Subscription type

Definition, pricing, charging terms

Simple product offering with fees and alterations

Charge offer of Subscription type / Item / Account type (based on Launch definition).

Definition

Pricing and Adjustments

N/A

Discount offer of Subscription type. The name of the discount offer will be post fixed with _DISCOUNT.

For Digital Business Experience (DBE) customers, the _DISCOUNT post fix won't be there. Discount offers will be post fixed with _DISCOUNT only for NON-DBE customers.

Charging terms

Simple offering of device/accessory type

Charge offering of Account type

Definition

Pricing

Attribute based pricing

Charge Selector

Definition

Pricing

Package

Package

Definition

Components

Commitment terms

Service Bundle

Bundle

Definition

Components

Commitment terms

Attribute based adjustment

Discount Selector

Definition

Pricing

Attribute Based Pricing with Custom Analyzer Rule

Generic Selector

Definition

Pricing

Simple Product Offering with Trigger Conditions (except Impact Category, Price Plan Name, Currency) are configured

Trigger Spec

Definition

Pricing

Simple Product Offering with Trigger Conditions such as Impact Category, Price Plan Name, and Currency are configured

Charge Selector Spec

Definition

Pricing

Simple Product Offering with Roll Over Configuration

Rollover Rate Plan

Definition

Pricing

Simple Product Offering with Charge Share

Charge Share Offer (Distribution Rate Plan and Distribution Offering)

Definition

Pricing

Setting up Launch PDC/BRM Integration

There are a few setups required to be done in Launch, Industry Framework and BRM for Publish from Launch-to-PDC.

Prerequisites

Table 2-3 Prerequisites

No. Application Task Mandatory? Description

1.

Industry Framework

Create Integration User

Yes

This is required to facilitate the integration between the two applications.

2.

Industry Framework

Configure the downstream systems

Yes

This is required to ensure to configure the downstream system instance for receiving publishing events.

3.

Launch

Register destinations

Yes

This is required to configure the right downstream system instance to receive the publishing events.

4.

Launch

Configure Entity Profile

Yes

This is required to ensure that Launch can model catalog definitions based on PDC/BRM.

5.

PDC REST Services Manager

Create client credentials and security requirements

Yes

N/A

6.

Launch and PDC/BRM

Set up Configuration entities

Yes

Configures the set up entities between Launch and PDC.

Setup Task Details

  1. Create a new resource user with the user name FABRIC_SYSTEM_USER and the role Communications Catalog Administrator using the Security Console. If you have already created this as a part of the Launch setup, no additional setup is required.

  2. Configure your external application in the Industry Framework for each instance. For more information, refer to the topic Integrate External Applications to add a Spoke End Point in the article Implement CX Industries Framework, on My Oracle Support, Doc ID 2720527.1.

  3. Register Destination in Launch for publishing to PDC/BRM instance. Usually, you would have many PDC/BRM instances such as (Development, SIT, UAT and Production). Each instance of BRM is a destination that needs to be setup for Launch to publish to the correct PDC instance.

  4. Configure the Entity Profile to ensure that PDC/BRM supported product modeling is followed by Launch using the Entity Profile tile in Administration space.

    No two applications are the same when it comes to modeling capabilities and so is the case between PDC/BRM and Launch. Though the result might be the same, the constructs might be different between the applications, and while integrating the applications, you need to factor in any restrictions of the target(spoke) application to ensure an error-free publishing of catalog definitions. Some of the common patterns between PDC and Launch can be classified as:

  5. Create client credentials and security requirements for PDC/BRM. See PDC/BRM documentation for information about creating client credentials and security requirements for PDC/RSM deployment.

  6. Ensure that the services, events and service-event maps, general ledger IDs (GLID), tax codes, balance elements, custom analyzer rules, value maps, standard zones, price tags, impact categories, Policy Specifications, and Time Model required for charge or discount offers. Use the PDC Documentation for setting up the entities in PDC and use the Launch API documentation for setting up the same in Launch.

    Before setting up integration, complete the following conditional tasks in PDC/BRM and Launch.

    1. The Time Model and the respective time periods configured using Custom Profile Specification in Launch and Time Model on PDC side should be same.
      1. In Launch, use the REST API to create Time Model (Time Model is created using Custom Profile Specification with profile type 'TIME_MODEL') -
        https://<HOST>/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification.
        The Time Model name and the respective time period names should match with PDC.

        Example: Time Model with name TIME-MODEL-01 and the time periods PEAK and OFF_PEAK.

      2. In PDC, configure Time Model using Pricing tab in PDC dashboard.
    2. The Service Specification Attributes configured using Service Specification in Launch and Service Class Attributes in BRM side should be same.
      1. In Launch, use the REST API to create Service Specification with the Service Class Attributes configured as Service Spec Characteristics -
        https://<HOST>//crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3/serviceSpecification
        . The Service Class attribute names should match with PDC.

        Example: Service Specification with Service Spec Characteristic 'STATUS_FLAG'.

      2. In PDC, ensure the Service Class attributes are configured in BRM.
      3. Ensure the service class attributes (Service attributes used for Charge Selectors) configured in PDC matches the attributes added in Launch through Service Specification. These attributes will be used for Attribute Based Pricing.
    3. The Customer Profile Specification Attributes configured using Customer Profile Specification in Launch and Customer Attributes in BRM side should be the same.
      1. In Launch, use the REST API to create Customer Profile Specification with the Customer Attributes configured as Customer Profile Spec Characteristics-
        https://<HOST>//crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customerProfileSpecification.
        The Customer attribute names should match with PDC.

        Example: Customer Profile Specification with Customer Profile Specification Characteristics 'NAME' and 'CURRENCY'.

      2. In PDC, ensure the Customer attributes are configured in BRM.
      3. Ensure the Customer attributes (used for Charge Selectors) configured in PDC matches the attributes added in Launch via Customer Profile Specification. These attributes will be used for Attribute Based Pricing.
    4. Usage Specification name, metering rule name, and Usage Event Attribute names in Launch needs to be the same as the configured Usage Event Name, RUM name, and the Usage Event attribute names in PDC side.
      1. In Launch, use the REST API to create the usage specification.
        https://<HOST>/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/usageManagement/v2/usageSpecification. The fields name, meteringRule.name should match with PDC.
        The fields name, meteringRule.name and usageSpecCharacteristic.name should match with PDC.

        Example: EventDelayedSessionTelcoGsm, meteringRule.name – Duration, usageSpecCharacteristic.name - CALLED_TO

      2. In PDC, configure the serviceEventMap with the same event name, RUM and Usage Event Attributes.
      3. Ensure the Usage Event attributes (Used in Charge Selectors) configured in PDC matches the attributes added in Launch via Usage Specification. These attributes will be used for Attribute Based Pricing.
    5. The Service specification code in service specification in Launch and Service Event Map Name on BRM side should be same.

      1. Launch Service Specification service code needs to be configured.

        Example: The service code /service/telco/gsm/telephony needs to be same on both systems.

      2. In PDC, configure the ServiceEventMap.

    6. The Custom Analyzer Rule configured using Custom Profile Specification in Launch and Custom Analyzer Rule on the BRM side should be same.
      1. In Launch, use the REST API to create Custom Analyzer Rule (Custom Analyzer Rule is created using Custom Profile Specification with profile type 'CUSTOM_ANALYZER_RULE').
        https://<HOST>/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification
        The Custom Analyzer Rule name should match with PDC.

        Example: Name: FAMILY_RULE

      2. In PDC, configure Custom Analyzer Rules using Setup tab in PDC dashboard.
    7. The Price Tag in Launch and Price Tag on the BRM side should be same.
      1. In Launch, use the REST API to create Price Tags.
        https://<HOST>/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/priceTag
        The Price Tag name should match with PDC.

        Example: Name: PRICETAG_01

      2. In PDC, configure Price Tags using Setup tab in PDC dashboard.
    8. The Impact Category in Launch and Impact Category on the BRM side should be same.
      1. In Launch, use the Business Configurations section in Administration tab to configure the Impact Categories. The Impact Category name should match with PDC.

        Example: Name: IC_INTERNATIONAL

      2. In PDC, configure Impact Categories using Setup tab in PDC dashboard.
    9. The Standard Zone configured using Custom Profile Specification in Launch and Standard Zone on the BRM side should be same.
      1. In Launch, use the REST API to create Standard Zone (Standard Zone is created using Custom Profile Specification with profile type 'STANDARD_ZONE')
        https://<HOST>/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification
        The Standard Zone name should match with PDC.

        Example: Name: EUROPE_ZONE

      2. In PDC, configure Standard Zone using Setup tab in PDC dashboard.
    10. The Value Maps configured using Custom Profile Specification in Launch and Value Maps on BRM side should be same.
      1. In Launch, use the REST API to create Value Map (Value Map is created using Custom Profile Specification with profile type 'ZONE_VALUE_MAP')
        https://<HOST>/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification
        The Value Map name should match with PDC.

        Example: Name: US_VALUE_MAP

      2. In PDC, configure Value Map in PDC instance.
    11. The Policy Specification Terms configured using Custom Profile Specification in Launch and Policy Specifications on BRM side should be same.
      1. In Launch, use the REST API to create Policy Specification Term(Policy Specification Term is created using Custom Profile Specification with profile type 'POLICY_SPEC_TERM') -
        https://<HOST>/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification

        The policy specification name should match with PDC. Example: Name: PCRF-1.

      2. In PDC, configure Policy Specifications using Setup tab in PDC dashboard.
Sample Mapping

Table 2-4 shows a sample mapping between Launch and PDC entities.

Table 2-4 Sample Mapping

Entity Launch PDC Mandatory

Time Model

Create Custom Profile Specification with profile Type = 'TIME_MODEL'. Use it along with Product Offering.

Time Model Name : TIME-MODEL-01

Time Periods : PEAK, OFF_PEAK

Time Model Name : TIME-MODEL-01

Time Periods : PEAK, OFF_PEAK

No

Service Specification

Create Service Specification with Service Specification Characteristics. Use it in Attribute Based pricing. serviceSpecCharacteristic.name : STATUS_FLAG

Service Attribute : STATUS_FLAG.

This is used along with Charge Selectors

No

Customer Profile Specification

Create Customer Profile Specification with Customer Profile Specification Characteristics. Use it in Attribute Based pricing. custProfSpecCharacteristic.name : NAME

Customer Attributes: NAME This is used along with Charge Selectors

No

Usage Specification

EventDelayedSessionTelcoGsm

Metering Rule: Duration

Usage Spec Characteristic: CALLED_TO

Use Usage Spec Characteristics along with Attribute Based Pricing.

EventDelayedSessionTelcoGsm (Event)

RUM: Duration

Usage Event Attribute: CALLED_TO

Yes

UOM (Unit of Measure)

ORA_ATC_UOM

UOM

Yes

Tax Code

TAX001

TAX001

No

Product Offering Billing Service Type

Populate the Service code - /service/telco/gsm/telephony in ORA_ATC_BILLING_SERVICE_TYPE and then use it on product offering billing service type

Service - /service/telco/gsm/telephony (BRM)

serviceTelcoGSMTelephony(PDC)

Configure the service-event maps.

Yes

Product Specification

Wireless PS
  • Populate the Usage Specification -EventDelayedTelcoGSMTelephony

Populate the Service Specification - Wireless CFS

N/A

No

GLID

101

101

No

Balance Element

Name: US Dollars

Code: USD

Numeric code: 840

Name: US Dollars

Code: USD

Numeric code: 840

Yes

Price Tag

CT01

CT01

No

Impact Category

Common business configuration impact category IC_INTERNATIONAL

IC_INTERNATIONAL

No

Custom Analyzer Rule

Create Custom Profile Specification with profile Type = 'CUSTOM_ANALYZER_RULE'. Use it along with product offering. Name: FAMILY_RULE

Name: FAMILY_RULE No

Standard Zone

Create Custom Profile Specification with profile Type = 'STANDARD_ZONE'. Use it along with product offering. Name: EUROPE_ZONE

Name:EUROPE_ZONE No

Value Map

Create Custom Profile Specification with profile Type = 'ZONE_VALUE_MAP'. Use it along with product offering.Name: US_VALUE_MAP

Name:US_VALUE_MAP No

Policy Specification

Create Custom Profile Specification with profile Type = 'POLICY_SPEC_TERM'. Use it along with Product Offering. Name: PCRF-1

PCRF-1

No

Supported Scenarios

Table 2-5 lists the supported integration scenarios.

Table 2-5 Supported Scenarios

What you can publish? Launch Entity PDC Entity

Simple Offer with one time price

Simple product offering of service type

Supported fee types are Purchase and Cancel

Charge offering of service type

( EventBillingProductFeePurchase EventBillingProductFeeCancel )

Simple Offer with recurring price

Simple product offering of service type

Supported recurring frequency - Monthly, Bi-Monthly, Semi Annual, Annual, Quarterly, Arrear and Forward Arrear

Charge offering of service type with the event of the below recurring frequency with the scaled fee.

(

EventBillingProductFeeCycleCycle_forward_annual - Occurrence

EventBillingProductFeeCycleCycle_forward_semiannual - Occurrence

EventBillingProductFeeCycleCycle_forward_quarterly - Occurrence

EventBillingProductFeeCycleCycle_forward_bimonthly - Occurrence

EventBillingProductFeeCycleCycle_forward_monthly - Occurrence)

EventBillingProductFeeCycleCycle_arrear - Occurrence

EventBillingProductFeeCycleCycle_forward_arrear - Occurrence

)

Simple Offer with one time, recurring and usage fee (any metering rule)

Simple product offering of service type

Charge offering of service type with the one time, recurring, and usage fee

Simple Offer with a one- time, recurring price along with one time, recurring fixed/% discount

Simple offering with fees and adjustments of type fixed discount or percentage discount

Charge offering of service type with the one time, recurring, and usage fee. Discount offering with a fixed or percentage discount for the one-time fee

Simple Offer with a usage fee and usage discount

Simple offering with usage fees, metering rule, UOM with usage percentage or fixed discount

Charge offering of service type with the usage fee. Discount offering with a fixed or percentage discount for the usage fee

Simple Offer - Tiered pricing

Simple offer with one time/recurring tiered pricing

Charge offer of service type with one time/recurring tiered pricing

Simple offer - Usage tiered pricing

Simple offer with usage tiered pricing

Charge offer with usage tiered pricing

Re-use of price plans in Simple offer

Simple offer with reused price plans

Charge offer with reused rate plans

Simple offer with Time Limited Discounts sync from Launch to BRM (Only absolute validity)

Simple offer with one time/recurring/usage limited time discount

Charge offer/Discount offer with rate plan validity

Launch - PDC - Scenarios involving revision, cloning, and retirement.

Clone

Simple offer revision

Simple offer Retire

Simple offer Obsolete

Charge offer revise

Charge offer obsolete

Charge offer obsolete

Launch - PDC - Simple offering with allowances

Simple offering with single allowance

Charge offering of service type with the non- currency resource granted part of one time, recurring, and usage fee for consumption. Discount offering for non-currency resource consumption

Launch - PDC - Simple offering with Allowance and Overage

Simple offering with single allowance and overage

Charge offering of service type with the non- currency resource granted part of one time, recurring, and usage fee for consumption. Discount offering for non-currency resource consumption

Launch - PDC - Simple offering with Attribute based pricing (one time, recurring and usage)

Simple offer with attribute-based pricing for usage with service specification and usage specification characteristics.

Simple offer with attribute-based pricing for one time and recurring with service specification and customer specification characteristics.

Charge offer with charge selector

Launch PDC - Simple offering with one-time, recurring fees and discounts along with Charging terms

Simple offer with charging terms

Charge offer/Discount offer with rate plan configuration or charging details like proration and increments

Launch - PDC - Simple offering with one-time, recurring fees and usage fees (reuse of price plan alteration)

Simple offer with reused discount price plan

Discount offer with reused discount rate plan

Simple Offer with a one time, recurring, usage volume discount (tiered, volume)

Simple offer with one time/recurring/usage tiered and volume discount

Charge offer and Discount offer with one time/recurring/usage tiered and volume discount

Service Bundle (No nesting of bundles)

Service bundle

Bundle

Package with commitment terms (no nested bundles or commercial bundles, aggregate groups)

Package

Package with commitment terms

Service Bundle with commitment terms (No nesting of bundles)

Service bundle

Bundle with commitment terms

Package (no nested bundles or commercial bundles, aggregate groups)

Package

Package

Simple Offer with attribute-based adjustments for usage

Simple offer with attribute-based adjustment for usage (customer specification, service specification, usage specification)

Charge offer and Discount offer with Discount Selector

Publish other type of product offering (like discounts)

Simple offering with other type of product offering + discount

Discount offers

Simple Offer with multiple allowances and consumption model

Simple offer With multiple allowances and consumption model

Charge offer and Discount offer (consumption model)

Simple Offer with usage prices based on zoning

Simple offer with Value Map zoning

Charge offer using charge selector with value map zoning

Simple Offers with adjustments based on triggers

Simple offer, triggers on adjustments (Total Charge, Total Quantity, Price Tag, Expression, Price Plan Name, Currency as trigger conditions)

Discount offer with Discount Trigger (Charge Selector Spec and Trigger Spec are used to configure these properties)

Simple offers with multiple price lists

Simple offers with multiple price lists. (Fees are created with different price lists within the same simple offers.)

Charge offers with Charge selectors. The charge selectors are used to configure charge rate plans based on price lists.

Simple offers with adjustments and user/share balance

Simple offers with adjustments and user/sharer balance

Discount offers with different types of discounts which applies to user/sharer balance.

Simple offers with Balance Consumption Model

Simple offers with Balance Consumption Model without Allowance configured in usage fee (Consumption Discount Model).

Discount offers with Balance Consumption Model

Simple offers with standard zone

Simple offer with attribute based pricing for usage based on standard zone.

Charge offer using charge rate plan with standard zone

Simple offers with price tags for run time price overrides

Simple offer with price tags on product offering prices.

Charge and discount offers with rates having price tags

Simple offers with multiple usage prices

Simple offers with multiple usage prices. Attach appropriate usage specification for each usage fee.

Charge and discount offers with multiple usage events

Simple offers with Allowance Grant

Simple offers with provision to grant allowance as adjustments. This can be done either as a new adjustment or along with an existing adjustment where the product type is DISCOUNT.

Alteration Rate Plans with Allowance Grant

Simple Offers with Custom Analyzer Rule for Pricing

Simple Offers with provision to configure pricing based on Custom Analyzer Rule. This is done by adding Custom Analyzer Rules along with Attribute-based Pricing.

Charge Offers with Charge Rate Plan along with Generic Selector configured inside the Charge Rate Plan

Simple Offers with Discount Priority

Simple Offers of product type Discount/Time Based Discount with discount priority.

Discount Offers with Alteration Rate Plan

Simple Offers with Adjustments and Discount Mode - Parallel/Sequential

Simple Offers with Adjustments and Discount Mode - Parallel (Original Charge)/Sequential (Remaining Charge)

Discount Offers with Alteration Rate Plan

Simple Offers with Counters

Simple Product Offerings with provision to configure Counters with Pricing, Adjustments.

Charge Offers with Charge Rate Plan and Discount Offers with Alteration Rate Plans

Simple Offers with Start Validity Mode for Allowances and Counters

Simple Product Offerings with provision to configure start validity mode for Allowances (including allowance grants) and counters.

Charge Offers with Charge Rate Plan and Discount Offers with Alteration Rate Plans

Simple Offers with Policy Specification

Simple Product Offerings with provision to configure Policy Specification.

Charge Offers and Discount Offers

Simple Offers with Roll Over Configurations

Simple Product Offerings with provision to configure Rollover Configurations.

Charge Offers with Alteration Rate Plan

Simple Offers with Charge Share

Simple Product Offerings with provision to add Charge Share

Charge Share Offers (Distribution Offerings with Distribution Rate Plan)

Simple Offer with Time Model

Simple Product Offering with Time Model tagged to the price plans

Charge Offering with Time Model tagged to the Charge Rate Plans

Simple Offer with Formula Based Discount

Simple Product Offering with Formula Based Discounts

Discounts Offers with expressions added to the Alteration Rate Plans