10 Adding a Communication Service Application

This chapter describes how to add communication service applications to your existing Oracle Communications Services Gatekeeper (OCSG) cloud domain.

Add Communication Service Applications

You can add communication service applications to your existing Services Gatekeeper cloud domain.

Note:

The feature applies to a single-tier configuration only. All communication services are installed automatically in a multi-tier configuration.

The tool supports the Linux platform and performs the following operations:

  • Gets the necessary application package files from the installer

  • Configures the domain to deploy the applications

  • Updates the domain to add communication service related services

  • Updates the startup script to adjust related settings

The following packages are used by communication services:

Table 10-1 Packages Used By Communication Services

Communication Service Functionality Packages Delivered Optional Feature Set

SMS

Messaging

wlng_at_sms_parlay_rest.ear (For one API interface)

wlng_at_sms_px21_soap.ear (For SOAP interface)

wlng_nt_sms_px21.ear (MUST be deployed)

Application - SMS

(ocsg_app_sms)

MMS

Messaging

wlng_at_multimedia_messaging_parlay_rest.ear (For one API interface)

wlng_at_multimedia_messaging_px21_soap.ear (For SOAP interface)

wlng_nt_multimedia_messaging_px21.ear (MUST be deployed)

wlng_at_multimedia_messaging_mm7.ear (For SOAP interface, MM7)

wlng_nt_multimedia_messaging_mm7.ear (MUST be deployed for MM7)

 

Payment

Payment

wlng_at_payment_parlay_rest.ear (For one API interface)

wlng_at_payment_px30_soap.ear (For SOAP interface)

wlng_nt_payment_px30.ear (MUST be deployed)

Application - Payment

(ocsg_app_payment)

Terminal Location

Location

wlng_at_terminallocation_parlay_rest.ear (For REST interface)

wlng_at_terminal_location_px21_soap.ear (For SOAP interface)

wlng_nt_terminal_location_px21.ear (MUST be deployed)

Application - Terminal Location

(ocsg_app_termloc)

QoS

Quality of Service

wlng_at_qos_px40.ear (For SOAP interface)

wlng_nt_qos.ear (MUST be deployed)

Application - QoS

(ocsg_app_qos)

Application Subscription

Subscription

wlng_at_app_subscription_rest.ear (For REST interface)

wlng_nt_app_subscription.ear (MUST be deployed)

Application - Subscription

(ocsg_app_subscription)


Application Installation

The utility first runs a script, addCommsPack.sh, that first checks package availability in the current installation and, if necessary, launches a silent installation to a temporary folder to get required files and copy them to the specified OCSG installation location. Only needed files are copied.

Next, a WebLogic Scripting Tool script called addCommsPack.py checks the domain configuration to discover missing applications and add them into the deployment. The script works in offline mode only and requires you to shut down OCSG in advance because changing a service requires a shutdown anyway.

Next, addCommsPack.sh changes the server setting by manipulating the custom configuration file, ${DOMAIN}/config/custom/nt.xml. If not presented, the service oracle.ocsg.protocol.smpp.SMPPServerService needs to be added.

The script changes the blockUnknownAPIsflag in setDomainEnv.sh (or setDomainEnv.cmd) from true to false.

At this point the domain is ready to use with correctly deployed telecom applications.

Updating Newly Added Packages

The addCommsPack tool updates the installation inventory to add information about the newly added applications as if they are selected in the initial installation, allowing OPatch to update them normally.

After application installation, addCommsPack reads the configuration file featuresetList to get information about the feature sets to be added. The tool checks whether a specified feature set is inside the inventory and, if not, updates the following items for each feature set:

  • $ORACLE_HOME/inventory/registry.xml

    Indicates whether a feature set is selected or not.

  • $ORACLE_HOME/inventory/Components

    Contains metadata for each component, one folder for one component

  • $ORACLE_HOME/inventory/ContentsXML/comps.xml

    Contains the information about the installed components

  • $ORACLE_HOME/inventory/refconts/components

    Contains the reference count for each installed components

  • $ORACLE_HOME/inventory/refconts/feature sets

    Contains the reference count for each selected feature set

When these items are updated, OPatch can update new applications normally.

The tool updates the following optional feature sets: ocsg_app_mm, ocsg_app_payment, ocsg_app_qos, ocsg_app_sms, ocsg_app_subscription, ocsg_app_termloc.

Additional resource files, including the list of required applications, feature sets, server services, silent installation/deinstallation response files and several template files under the folder inventory_template are used for updating the inventory for each optional feature set. All of these files are packed into the installer and copied to ${ORACLE_HOME}/wlserver/common/templates/scripts/addCommsPack/ after installation.

Usage

Follow these steps to use the tool:

  1. Prepare a valid single-tier installer file.

  2. Set the environment variable JAVA_HOME to the JDK location. Otherwise the tool will prompt the user to enter the location.

  3. Shut down OCSG.

  4. Run the following script and specify the domain location:

    ${ORACLE_HOME}/wlserver/common/templates/scripts/addCommsPack/addCommsPack.sh ${DOMAIN_HOME} ${SINGLETIER_INSTALLER_FILE}
    
  5. When the script finishes, restart OCSG.

The tool can add any application server service as long as the required information is present in the list files.

You can customize the tool by editing the following files:

  • pkgList

    Contains the required application package names, for example wlng_nt_sms_px21.ear. One line per package. Each line that starts with # is treated as a comment and ignored during processing.

  • serviceList

    Contains the required service's full class name, for example oracle.ocsg.protocol.smpp.SMPPServerService. One line per server service. Each line that starts with # is treated as a comment and ignored during processing.

  • featuresetList

    Contains the list of optional feature set names to be added to the installation inventory, for example ocsg_app_sms. One line per feature set. Each line that starts with # is treated as a comment and ignored during processing.