5 Configuring and Deploying Pre-built Integrations

This chapter provides instructions for configuring and deploying the AIA pre-built integrations.

Configuring AIA PIP Credentials

Deployment of AIA PIPs requires Kubernetes secrets for OSM, BRM, Siebel, ODI, Xref, and SOA. Do not create a Kubernetes secret if you are not configuring OSM, Siebel, ODI or BRM with AIA.

To configure AIA PIP credentials, navigate to the $AIA_DIR/oc-cn-aia-comms/scripts folder and then run the create-aiapip-credentials.sh script with updated values for each component. See "Parameters for AIA PIPs Credentials" for details about the parameters.
  • (Optional) For OSM, run the script with the following parameters:
    $ cd $AIA_DIR/oc-cn-aia-comms/scripts/
    $ sh create-aiapip-credentials.sh \
        -c osm \
        -n namespace \
        -d domain_name \
        -OSM_CFS_WL_JMS_QUEUE_ACCESS_USER username \
        -OSM_CFS_WL_JMS_QUEUE_ACCESS_PSWD password \
        -OSM_PROV_WL_JMS_QUEUE_ACCESS_USER username \
        -OSM_PROV_WL_JMS_QUEUE_ACCESS_PSWD  password \
        -OSM_CFS_ADMIN_USER username \
        -OSM_CFS_ADMIN_PSWD password \
        -OSM_PROV_ADMIN_USER username \
        -OSM_PROV_ADMIN_PSWD password 
  • (Optional) For BRM, run the script with the following parameters:
    $ cd $AIA_DIR/oc-cn-aia-comms/scripts/
    $ sh create-aiapip-credentials.sh \
        -c brm \
        -n namespace \
        -d domain_name \
        -BRM_AQ_USER username \
        -BRM_AQ_PSWD password
  • (Optional) For Siebel, run the script with the following parameters:
    $ cd $AIA_DIR/oc-cn-aia-comms/scripts/
    $ sh create-aiapip-credentials.sh \
        -c siebel \
        -n namespace \
        -d domain_name \
        -SBL_EAI_USER username \
        -SBL_EAI_PSWD password \
        -SBL_DB_USER username \
        -SBL_DB_PSWD password
  • (Optional) For ODI, run the script with the following parameters:
    $ cd $AIA_DIR/oc-cn-aia-comms/scripts/
    $ sh create-aiapip-credentials.sh \
        -c odi \
        -n namespace \
        -d domain_name \
        -ODI_USER username \
        -ODI_PASSWORD password \
        -ODI_DB_USER username \
        -ODI_DB_PSWD password
  • For Xref, run the script with the following parameters:

    Note:

    Ensure that you specify a working DB SYS username and password for the Xref scripts.
    $ cd $AIA_DIR/oc-cn-aia-comms/scripts/
    $ sh create-aiapip-credentials.sh \
        -c xref \
        -n namespace \
        -d domain_name \
        -XREF_SCHEMA_NAME schema_name \
        -XREF_SCHEMA_PASSWORD schema_password \
        -XREF_SCHEMA_SYS_USER sys_user \
        -XREF_SCHEMA_SYS_PASSWORD sys_password
  • For SOA, run the script with the following parameters:

    Note:

    Ensure that you specify a working DB SYS username and password for the SOA scripts.
    $ cd $AIA_DIR/oc-cn-aia-comms/scripts/
    $ sh create-aiapip-credentials.sh \
        -c soa \
        -n namespace \
        -d domain_name \
        -SOA_WL_ADMIN_USER username \
        -SOA_WL_ADMIN_PASSWORD password \
        -SOA_DB_USER username \
        -SOA_DB_PASSWORD password \
        -SOA_DB_SYS_USER username \
        -SOA_DB_SYS_PASSWORD password

Deploying the BRM JCA Adapter

You can install BRM JCA Adapter using either WebLogic Administration Console or AIA Helm charts.

Deploying BRM JCA Adapter using WebLogic Administration Console

To deploy BRM JCA Adapter using WebLogic Admin Console:

  1. Log in to WebLogic Admin Console.
  2. Click Lock and Edit.
  3. Go to Deployments and then to Install.
  4. Select the archive file.
    • If the archive file is present on the host machine, select Upload your files.
    • If the archive file is present on pod or on PV, select Path from the menu.
  5. In the Choose installation type and scope screen, do the following:
    • Choose Install this deployment as an application.
    • Choose Scope and then choose Global.
    • Click Next.
  6. In the Select Deployment targets screen, do the following:
    • In the Servers section, select AdminServer.
    • In the Clusters section, select All servers in the cluster.
    • Click Next.
  7. In the Optional Settings screen, do the following:
    • Update the name in the General field to OracleBRMJCA15Adpater.
    • In the source accessibility section, use the defaults defined by the deployment's targets.
    • In the plan source accessibility section, use the same accessibility plan as the application.
    • Click Next.
  8. In the Review your choices and click Finish screen, do the following:
    • In the additional configuration section, select Yes, take me to the deployment's configuration screen.
    • Click Finish.
  9. Click Activate Changes.
  10. Go to Deployments, select OracleBRMJCA15Adapter, and then select control and do the following:
    • If State is prepared and not active, select the checkbox for OracleBRMJCA15Adpater and then go to Start and select Servicing all requests.
    • Confirm state is active.

Deploying BRM JCA Adapter Using AIA Helm Charts

The AIA Helm chart for deploying BRM JCA Adapter requires the following:
  • AIA PV
  • OracleBRMJCA15Adapter.rar. Download this file from patch 36043192 zip file "p36043192_150000_Generic.zip" from My Oracle Support and extract it. You will find the "OracleBRMJCA15Adapter.rar" file in the path: ./36043192/files/JCA_Adapter/15.0.0.0.0/brm.symbol/apps/brm_integrations/jca_adapter
  • plan.xml
To deploy BRM JCA Adapter:
  1. Update the following values.yaml files as per your requirement:
    • $AIA_DIR/oc-cn-aia-comms/helm-charts/aia-comms-chart/values.yaml. See "Global Parameters" for details about the parameters.
    • $AIA_DIR/oc-cn-aia-comms/helm-charts/aia-comms-chart/charts/aia-comms-install-brm-adapter/values.yaml.

      The following table lists the parameters in the values.yaml file.

      Table 5-1 Parameters in the values.yaml file

      Parameter Description Default
      undeployExistingAdapter To undeploy existing BRM JCA Adapter with name OracleBRMJCA15Adapter, set this to true. If set to false, jobs will exit after checking if any OracleBRMJCA15Adapter deployment exists. true
      deploymentPath Path where BRM JCA Adapter archive file is present under the BRM directory,/u01/shared/brm/brm_adapter. OracleBRMJCA15Adapter.rar
      deployUsingPlan To deploy using plan.xml, set this to true. false
      planPath If deployUsingPlan is set to true, uncomment this parameter and provide the path where plan.xml exists under the BRM directory,/u01/shared/brm/brm_adapter. Not applicable
  2. Upload the files to AIA PV:
    • Upload the OracleBRMJCA15Adapter.rar archive file:
      kubectl cp OracleBRMJCA15Adapter.rar SOA_Admin_Pod:/u01/shared/brm/brm_adapter/ -n SOA_Namespace
    • (Optional) Upload the plan.xml file:
      # kubectl cp plan.xml SOA_Admin_Pod:/u01/shared/brm/brm_adapter/ -n SOA_Namespace
  3. Deploy BRM JCA Adapter by using the values.yaml file:
    cd $AIA_DIR/oc-cn-aia-comms/helm-charts/
     
    helm install aia-comms-install-brm-adapter \
         aia-comms-chart/charts/aia-comms-install-brm-adapter/ \
         --namespace namespace \
         --values ./aia-comms-chart/values.yaml \
         --values ./aia-comms-chart/charts/aia-comms-install-brm-adapter/values.yaml

    This chart restarts the managed servers as required during the installation.

  4. Wait till aia-comms-install-brm-adapter-job completes before proceeding to the next step.

Configuring Pre-built Integrations

You can configure the following Oracle Communications pre-built integration options:
  • Order to Cash
  • Agent-Assisted Billing Care

Run the aia-comms-config helm chart to configure pre-build integrations.

This chart requires the following:
  • aia-comms-pv-pvc helm chart
  • BRM JCA adapter deployed
  • All secret credentials
  • ODI installed (For AABC, ODI Agent URL should be accessible inside the Kubernetes pods)

Note:

This chart requires a minimum Java heap size of 4 GB, upto a maximum of 8 GB on the Kubernetes node.

If this configuration is not available in the Kubernetes cluster, update the templates YAML file as follows:

$ vi $AIA_DIR/oc-cn-aia-comms/helm-charts/aia-comms-chart/charts/aia-comms-deploy-aiapip/charts/aia-comms-config/templates/aia-comms-execute-runconfig-job.yaml
  
# Update the value for USER_MEM_ARGS environment variable
# "-Djava.security.egd=file:/dev/./urandom -Xmsinitial_heap_size -Xmxmax_heap_size "
# -Xmsinitial_heap_size is the initial size of the heap.
# -Xmxmax_heap_size is the maximum size of the heap.
To configure pre-built integrations:
  1. Update the following values.yaml files as per your requirement:
    • $AIA_DIR/oc-cn-aia-comms/helm-charts/aia-comms-chart/values.yaml. See "Global Parameters" for details about the parameters.
    • $AIA_DIR/oc-cn-aia-comms/helm-charts/aia-comms-chart/charts/aia-comms-deploy-aiapip/values.yaml. See "Parameters for AIA PIPs" for details about the parameters.
  2. Run the following command to install the Helm chart:

    Note:

    This chart requires all of the configured managed servers up and running.
    $ cd $AIA_DIR/oc-cn-aia-comms/helm-charts/
    $ helm install aia-comms-config \
         aia-comms-chart/charts/aia-comms-deploy-aiapip/charts/aia-comms-config/ \
         --namespace namespace \
         --values ./aia-comms-chart/values.yaml \
         --values ./aia-comms-chart/charts/aia-comms-deploy-aiapip/values.yaml
    This chart restarts the managed servers as required during the installation.
  3. Wait till aia-comms-execute-runconfig-job completes before proceeding to the next step.

    Depending on the configuration, this job may take hour(s) for completion.

If you encounter any errors during the deployment, refer to the "Redeploying Pre-built Integrations Configurations Helm Chart" section in "Troubleshooting Issues".

Deploying Pre-built Integrations

After configuring the pre-built integrations, you must deploy them to the SOA server by using the deployment helm chart aia-comms-pips:

This chart requires the following:
  • aia-comms-pv-pvc helm chart
  • BRM JCA adapter deployed
  • All secret credentials
  • ODI installed (For AABC, the ODI Agent URL should be accessible inside the Kubernetes pods.)
  • aia-comms-config chart

Note:

This chart requires a minimum Java heap size of 4 GB, up to a maximum of 8 GB on the Kubernetes node.

If this configuration is not available in Kubernetes cluster, update the templates YAML file as follows:

$ vi $AIA_DIR/oc-cn-aia-comms/helm-charts/aia-comms-chart/charts/aia-comms-deploy-aiapip/charts/aia-comms-pip/templates/aia-comms-deploy-aiapip-job.yaml
  
# Update the value for USER_MEM_ARGS environment variable
# "-Djava.security.egd=file:/dev/./urandom -Xmsinitial_heap_size -Xmxmax_heap_size "
# -Xmsinitial_heap_size is the initial size of the heap.
# -Xmxmax_heap_size is the max size of the heap.
To deploy pre-built integrations:
  1. Update the following values.yaml files as per your requirement:
    • $AIA_DIR/oc-cn-aia-comms/helm-charts/aia-comms-chart/values.yaml. See "Global Parameters" for details about the parameters.
    • $AIA_DIR/oc-cn-aia-comms/helm-charts/aia-comms-chart/charts/aia-comms-deploy-aiapip/values.yaml. See "Parameters for AIA PIPs" for details about the parameters.
  2. Run the following command to install the Helm chart:

    Note:

    This chart requires all of the configured managed servers up and running.
    $ cd $AIA_DIR/oc-cn-aia-comms/helm-charts/
    $ helm install aia-comms-deploy-pip \
         aia-comms-chart/charts/aia-comms-deploy-aiapip/charts/aia-comms-pip/ \
         --namespace namespace \
         --values ./aia-comms-chart/values.yaml \
         --values ./aia-comms-chart/charts/aia-comms-deploy-aiapip/values.yaml
    This chart restarts the managed servers as required during the installation.
  3. Wait till aia-comms-deploy-aiapip-job completes before proceeding to the next step.

    Depending on the configuration, this job may take hour(s) for completion.

To validate PIPs deployment, see "Validating the AIA Cloud Native Deployment".

If you encounter any errors during the deployment, refer to the "Redeploying Pre-built Integrations Helm Chart" section in "Troubleshooting Issues".