6 Downloading and Deploying the Reference Solution

This chapter provides information about downloading and deploying the Digital Business Experience Reference Solution (the reference solution).

Before you start to download and deploy the reference solution:

  • Learn about the reference solution. See About the Reference Solution in Oracle Communications Digital Business Experience Concepts for more details.

  • Learn about the reference product models and seed data available in the reference solution. See Reference Product Models and Seed Data in Oracle Communications Digital Business Experience Concept to Market Guide for more details.

  • Learn about the order to cash reference library, which consists of a few sample preconfigured order-to-cash end-to-end features. See Using the Order to Cash Reference Library in Oracle Communications Digital Business Experience Order to Cash Implementation Guide for more details.

  • Download and install Oracle Communications Solution Test Automation Platform (STAP) in your Digital Business Experience environment. See Installing STAP for more details.

    Note:

    The reference solution is packaged with STAP. Hence, you must install STAP first so that you can deploy the reference solution package.

  • After installing STAP, set up STAP Design Experience (STAP DE). See Setting Up The STAP Design Experience for more information.

Prerequisites

Following are the prerequisites for installing the reference solution:
  • Verify all the REST API end points for various applications and SSH keys, ensuring proper connectivity before running the automation.
  • Ensure that you enabled the REST calls for BCWS and TMF. See Configuring REST Services in Oracle Communications Billing and Revenue Management Cloud Native Deployment Guide for detailed instructions about configuring the rest services in BRM and PDC.
  • Ensure to edit the config files for pre-automation. See Editing the config files for more information.
  • Run the following command to update the scenario files:
    sh replace_paths.sh
  • Run the following command to perform pre-automation. See Running the script for more information.
    sh run_publish.sh -w Pre-Automation
  • Verify that the seed data has been created correctly in Launch, PDC, and BRM. See About the Seed Data in Oracle Communications Digital Business Experience Concept to Market Implementation Guide for more information.
  • Check if the destinations for PDC and Siebel are created in Launch.
  • Verify if the pdc-test destination has destination exclusion rule to avoid publishing bundles to PDC as it is not supported by Digital Business Experience.
  • Ensure that the Lifecycle Status for the destinations on the Launch UI is Ready to Publish.

Deploying the Reference Solution Package

Note:

You must download the packages in the following order:
  • Reference Solution package, which contains scripts for:
    • Prerequisite and Seed data: Preconfigured Launch, Siebel, BRM, and PDC data.
    • STAP helper scripts: These scripts help you to publish various scenarios to STAP.
    • Design-time product models: Includes all the business-to-business and business-to-customer product models.
    • Custom extensions: These are Siebel custom extensions available under the Extensions folder of the oc-dbe-rs-<version>.zip file. To apply these extensions to your Digital Business Experience environment, follow the Standard Operating Procedures (SOPs) documented under the Extensions folder.
  • Order-to-cash test library (hosted with STAP), which consists of the end-to-end run-time test catalog.

To deploy the reference solution package:

  1. Download the reference solution pack from the Oracle software downloads website, located at:
    https://www.oracle.com/downloads/
  2. Run the following commands from the STAP environment to unzip the reference solution pack: 
    unzip oc-dbe-rs-<version>.zip
    cd oc-dbe-rs-<version>/Core
cp <absolute-path-to-otc-testlib-zip-file-download-folder>/oc-stap-otc-testlib-<version>.zip
unzip oc-stap-otc-testlib-<version>.zip

    Note:

    You can delete the zip file after unzipping it.
  3. Run the following command to edit the run_publish.sh file: 
    cd oc-dbe-rs-<version>/Core/
vi stap.properties
Replace:
export JAVA_HOME="/home/java/jdk-xx.x.x" with the correct path to JDK
export STAP_HOME="/home/STAP-DE"  with the correct path to STAP-DE jar
For example:
export JAVA_HOME="/home/user/java/jdk-21.0.6"
export STAP_HOME="/home/user/STAP-DE"
  4. Edit the config files for Publish-Automation.

    Set up the Tdaas and TES environment files to point them to the STAP deployment to which you want to publish them: 

    /oc-dbe-rs-<version>/Core/Publish-Automation/config/environments/TdaasEnvironment.properties
/oc-dbe-rs-<version>/Core/Publish-Automation/config/environments/TaaS-TES-environment.properties
  5. Run the following commands in stages to deploy and publish the reference solution pack to the Digital Business Experience environment: 
    sh run_publish.sh
      Usage: sh publish.sh -w <STAP_WORKSPACE_NAME>
      Step 1 - Edit the run_publish.sh files to point to your JAVA_HOME and STAP DE location.
      Step 2 - Edit the TaaS-TES-environment.properties and TdaasEnvironment.properties files to
      point to your STAP target deployment location.
      Step 3 - Edit the config.properties and environment files in your workspace.
      Step 4 - Run the run_publish.sh script with the workspace you want to publish and run on your
      STAP deployment.
      For example:
      oc-dbe-rs-<version>/Core/Pre-Automation/config/publish/tdaasEnvironment.properties
      oc-dbe-rs-<version>/Core/Pre-Automation/config/publish/environment.properties
      oc-dbe-rs-<version>/Core/Pre-Automation/config/publish/persistence-volume-environment.properties
      oc-dbe-rs-<version>/Core/Pre-Automation/config/publish/publish-automation.properties
      oc-dbe-rs-<version>/Core/Pre-Automation/config/environments/* --> all files
      oc-dbe-rs-<version>/Core/path.properties

    Note:

    • In the sh publish.sh -w <STAP_WORKSPACE_NAME> command, you can replace STAP_WORKSPACE_NAME with Pre-Automation, SD-Automation, DT-Automation, or RT-Automation based on the workspace you want to publish.
    • You must publish the workspaces in the following order:
      1. Edit the config files for Pre-Automation workspace, run the sh replace_token_paths.sh command to update the scenario files, and then publish the Pre-Automation workspace.
      2. Edit the config files for SD-Automation workspace, and then publish the SD-Automation workspace.
      3. Edit the config files for DT-Automation workspace, and then publish the DT-Automation workspace.
      4. Edit the config files for RT-Automation workspace, and then publish the RT-Automation workspace.
  6. To implement all the run-time scenarios, run the following command:
    sh run_rt_automation.sh --all

    or

  7. To implement a specific run-time scenario, run the following command:
    sh run_rt_automation.sh --scenario_name
For example: sh run_rt_automation.sh --BroadbandProductModels

    or

  8. To implement bundled sample orders, run the following command:
    sh run_rt_automation.sh --scenario_name/subfolder_name
For example: sh run_rt_automation.sh --MobileProductModels/Supremo5GUnlimited/SampleOrder

Troubleshooting the Reference Solution

This section provides troubleshooting information for problems while deploying the reference solution.

Problem: BRM Seed Data Fails to Load

If BRM data fails to load:

  • Load the following files from the BRM scenario data folder in the cm pod:
    • customservices_proximity.podl
    • customservices_OTT_VOIP_dtv_dmusic.podl

    See BRM PDC Seed Data in Oracle Communications Digital Business Experience Concept to Market Implementation Guide for a list of supported BRM Services, Events, and ServiceEvent maps.

  • Sync the new events and services by restarting the cm, dm, and syncpdc pods.

Problem: PDC Seed Data Fails to Import

If PDC data fails to import, create the ServiceEvent map manually from the PDC UI. See BRM PDC Seed Data in Oracle Communications Digital Business Experience Concept to Market Implementation Guide for a list of supported PDC Services, Events, and ServiceEvent maps.

Problem: Reimporting Service Event Map Files for PDC

This section provides a solution for running and reimporting Service Event Map files (attributeSpecMap.xml) multiple times in Oracle Communications Pricing Design Center (PDC) environments.

Issue: You need to import the Service Event Map file (attributeSpecMap.xml) multiple times during configuration, either in a new or an existing PDC environment.

Scenario 1: New PDC Environment

You have a newly installed PDC environment and need to import the attributeSpecMap.xml file multiple times.

Resolution

  • Import the Automated ASM file (attributeSpecMap.xml) as needed.
  • Use the -ow (Overwrite) and -ignoreID command-line options to avoid import conflicts:
    • -ow: Overwrites matching components in the PDC database.
    • -ignoreID: Ignores internal IDs to prevent ID conflicts.

Import Command Example

To reimport the same ASM file, use the following Helm upgrade command configuration:

ocpdc:
  configEnv:
    importExport:
      IE_Operation: "import"
      IE_Component: "config"
      IE_File_OR_Dir_Name: attributeSpecMap.xml
      extraCmdLineArgs: "-ow -ignoreID"
      IE_LogLevel: WARNING
      IE_PersistLog: failed
      persistIELogs: "enabled/all"

Note:

No additional steps are required in a fresh installation; multiple imports will not cause issues when using these options.
Scenario 2: Existing PDC Environment

You are working with an existing PDC environment where the Service Event Map has already been loaded, and you need to load additional or updated events for the same service.

Workaround

  1. Export the already loaded map.
    • Export the current Service Event Map from the existing PDC system (for example, E_ASM.xml).
  2. Compare with the new map.
    1. Obtain the new attribute specification map file to be imported (for example, N_ASM.xml).
    2. Manually compare E_ASM.xml and N_ASM.xml to identify differences or new entries.
  3. Create a merged map.
    • Merge the required changes (new or updated entries) from N_ASM.xml into E_ASM.xml to create a combined file (for example, E_ASM_merged.xml).
  4. Reimport the merged file.
    • Use -ow -ignoreID options while importing to overwrite existing entries and ignore internal IDs.

Import Command Example

  • E_ASM.xml: Contains the existing event map (for example, for service TelcoGsmTelephony). The following is a sample E_ASM.xml file:
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?><cim:ConfigObjects xmlns:cim="http://xmlns.oracle.com/communications/platform/model/Config"><attributeSpecMaps xmlns:cim="http://xmlns.oracle.com/communications/platform/model/Config">
<name>ConvergentVoice_ASM</name>
<internalId>4fe9a625-839e-4135-a6cd-9818feb75ce6</internalId>
<priceListName>Default</priceListName>
<obsolete>false</obsolete>
<eventRUMSpec>
<name>EventBillingCycleRolloverMonthly_ERS</name>
<internalId>df0080b0-7e52-4bb7-a533-df60b02040dd</internalId>
<priceListName>Default</priceListName>
<obsolete>false</obsolete>
<eventSpecName>EventBillingCycleRolloverMonthly</eventSpecName>
<rumSpec>
<rumExpression>
<numericRumExpression>
<value>1.0</value>
</numericRumExpression>
</rumExpression>
<rumName>Occurrence</rumName>
</rumSpec>
</eventRUMSpec>
<eventRUMSpec>
<name>EventBillingProductFeeCycleCycle_forward_monthly_ERS</name>
<internalId>43f53235-57db-455e-9033-a8ec33e15a58</internalId>
<priceListName>Default</priceListName>
<obsolete>false</obsolete>
<eventSpecName>EventBillingProductFeeCycleCycle_forward_monthly</eventSpecName>
<rumSpec>
<rumExpression>
<numericRumExpression>
<value>1.0</value>
</numericRumExpression>
</rumExpression>
<rumName>Occurrence</rumName>
</rumSpec>
</eventRUMSpec>
<eventRUMSpec>
<name>EventDelayedSessionTelcoGsm_ERS</name>
<internalId>ccdf11ed-aac6-45eb-9487-ee77043a3643</internalId>
<priceListName>Default</priceListName>
<obsolete>false</obsolete>
<eventSpecName>EventDelayedSessionTelcoGsm</eventSpecName>
<rumSpec>
<rumExpression>
<binaryRUMExpression>
<leftOperand>
<eventFieldExpression>
<fieldName>EventDelayedSessionTelcoGsm.END_T</fieldName>
</eventFieldExpression>
</leftOperand>
<rightOperand>
<eventFieldExpression>
<fieldName>EventDelayedSessionTelcoGsm.START_T</fieldName>
</eventFieldExpression>
</rightOperand>
<operation>SUBTRACT</operation>
</binaryRUMExpression>
</rumExpression>
<rumName>Duration</rumName>
</rumSpec>
</eventRUMSpec>
<productSpecName>TelcoGsmTelephony</productSpecName>
</attributeSpecMaps></cim:ConfigObjects>
  • N_ASM.xml: Contains new or modified events (for example, added Purchase Fee event, updated RUM for "Event delayed session telco GSM"). The following is a sample N_ASM.xml file:
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?><cim:ConfigObjects xmlns:cim="http://xmlns.oracle.com/communications/platform/model/Config">             <attributeSpecMaps xmlns:cim="http://xmlns.oracle.com/communications/platform/model/Config">
   <name>ConvergentVoice_ASM</name>
   <internalId>4fe9a625-839e-4135-a6cd-9818feb75ce6</internalId>
   <priceListName>Default</priceListName>
   <obsolete>false</obsolete>
   <eventRUMSpec>
      <name>EventDelayedSessionTelcoGsm_ERS</name>
      <internalId>ccdf11ed-aac6-45eb-9487-ee77043a3643</internalId>
      <priceListName>Default</priceListName>
      <obsolete>false</obsolete>
      <eventSpecName>EventDelayedSessionTelcoGsm</eventSpecName>
      <rumSpec>
         <rumExpression>
            <binaryRUMExpression>
               <leftOperand>
                  <eventFieldExpression>
                     <fieldName>EventDelayedSessionTelcoGsm.END_T</fieldName>
                  </eventFieldExpression>
               </leftOperand>
               <rightOperand>
                  <eventFieldExpression>
                     <fieldName>EventDelayedSessionTelcoGsm.START_T</fieldName>
                  </eventFieldExpression>
               </rightOperand>
               <operation>SUBTRACT</operation>
            </binaryRUMExpression>
         </rumExpression>
         <rumName>Duration_M</rumName>
      </rumSpec>
   </eventRUMSpec>
   <eventRUMSpec>
      <name>EventBillingProductFeePurchase_ERS</name>
      <internalId>d090943b-1287-48db-a3e3-5f971a1753cf</internalId>
      <priceListName>Default</priceListName>
      <obsolete>false</obsolete>
      <eventSpecName>EventBillingProductFeePurchase</eventSpecName>
      <rumSpec>
         <rumExpression>
            <numericRumExpression>
               <value>1.0</value>
            </numericRumExpression>
         </rumExpression>
         <rumName>Occurrence</rumName>
      </rumSpec>
   </eventRUMSpec>
<productSpecName>TelcoGsmTelephony</productSpecName>
</attributeSpecMaps></cim:ConfigObjects>
  • E_ASM_merged.xml: Manually merged file containing all required events and updates. The following is a sample E_ASM_merged.xml file:
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?><cim:ConfigObjects xmlns:cim="http://xmlns.oracle.com/communications/platform/model/Config"><attributeSpecMaps xmlns:cim="http://xmlns.oracle.com/communications/platform/model/Config">
<name>ConvergentVoice_ASM</name>
<internalId>4fe9a625-839e-4135-a6cd-9818feb75ce6</internalId>
<priceListName>Default</priceListName>
<obsolete>false</obsolete>
<eventRUMSpec>
<name>EventBillingCycleRolloverMonthly_ERS</name>
<internalId>df0080b0-7e52-4bb7-a533-df60b02040dd</internalId>
<priceListName>Default</priceListName>
<obsolete>false</obsolete>
<eventSpecName>EventBillingCycleRolloverMonthly</eventSpecName>
<rumSpec>
<rumExpression>
<numericRumExpression>
<value>1.0</value>
</numericRumExpression>
</rumExpression>
<rumName>Occurrence</rumName>
</rumSpec>
</eventRUMSpec>
<eventRUMSpec>
<name>EventBillingProductFeeCycleCycle_forward_monthly_ERS</name>
<internalId>43f53235-57db-455e-9033-a8ec33e15a58</internalId>
<priceListName>Default</priceListName>
<obsolete>false</obsolete>
<eventSpecName>EventBillingProductFeeCycleCycle_forward_monthly</eventSpecName>
<rumSpec>
<rumExpression>
<numericRumExpression>
<value>1.0</value>
</numericRumExpression>
</rumExpression>
<rumName>Occurrence</rumName>
</rumSpec>
</eventRUMSpec>
<eventRUMSpec>
<name>EventDelayedSessionTelcoGsm_ERS</name>
<internalId>ccdf11ed-aac6-45eb-9487-ee77043a3643</internalId>
<priceListName>Default</priceListName>
<obsolete>false</obsolete>
<eventSpecName>EventDelayedSessionTelcoGsm</eventSpecName>
<rumSpec>
<rumExpression>
<binaryRUMExpression>
<leftOperand>
<eventFieldExpression>
<fieldName>EventDelayedSessionTelcoGsm.END_T</fieldName>
</eventFieldExpression>
</leftOperand>
<rightOperand>
<eventFieldExpression>
<fieldName>EventDelayedSessionTelcoGsm.START_T</fieldName>
</eventFieldExpression>
</rightOperand>
<operation>SUBTRACT</operation>
</binaryRUMExpression>
</rumExpression>
<rumName>Duration</rumName>
</rumSpec>
<rumSpec>
<rumExpression>
<binaryRUMExpression>
<leftOperand>
<eventFieldExpression>
<fieldName>EventDelayedSessionTelcoGsm.END_T</fieldName>
</eventFieldExpression>
</leftOperand>
<rightOperand>
<eventFieldExpression>
<fieldName>EventDelayedSessionTelcoGsm.START_T</fieldName>
</eventFieldExpression>
</rightOperand>
<operation>SUBTRACT</operation>
</binaryRUMExpression>
</rumExpression>
<rumName>Duration_M</rumName>
</rumSpec>
</eventRUMSpec>
<eventRUMSpec>
<name>EventBillingProductFeePurchase_ERS</name>
<internalId>d090943b-1287-48db-a3e3-5f971a1753cf</internalId>
<priceListName>Default</priceListName>
<obsolete>false</obsolete>
<eventSpecName>EventBillingProductFeePurchase</eventSpecName>
<rumSpec>
<rumExpression>
<numericRumExpression>
<value>1.0</value>
</numericRumExpression>
</rumExpression>
<rumName>Occurrence</rumName>
</rumSpec>
</eventRUMSpec>
<productSpecName>TelcoGsmTelephony</productSpecName>
</attributeSpecMaps></cim:ConfigObjects>

To reimport the merged file, configure the Helm upgrade as follows:

ocpdc:
  configEnv:
    importExport:
      IE_Operation: "import"
      IE_Component: "config"
      IE_File_OR_Dir_Name: E_ASM_merged.xml
      extraCmdLineArgs: "-ow -ignoreID"
      IE_LogLevel: WARNING
      IE_PersistLog: failed
      persistIELogs: "enabled/all"

Note:

  • Always create backups of configuration files before performing merges or imports.
  • Manual merging is required to ensure that the Reference Solution test cases run without issues, as well as retain any current service event maps that are already available.