2 Installing Application Management Pack for Oracle Communications

This chapter describes Oracle Application Management Pack for Oracle Communications system requirements, and how to install, deploy, upgrade, and uninstall Application Management Pack for Oracle Communications.

System Requirements

You install Application Management Pack for Oracle Communications as a plug-in on an existing Oracle Enterprise Manager Cloud Control instance. The plug-in is supported on Enterprise Manager Cloud Control version 12c Release 4.

See the Enterprise Manager Cloud Control documentation library for information about Enterprise Manager Cloud Control system requirements and installation procedures.

Enterprise Manager Cloud Control requires an Oracle Enterprise Database. See the Oracle Enterprise Database documentation for information about installing and configuring Oracle Enterprise Database.

For more information about system requirements and certified versions for Enterprise Manager, see the Enterprise Manager Base Platform certification matrix available on My Oracle Support.

Caution:

The Oracle Management Repository for Enterprise Manager is not certified on Oracle Database 12c. For the full functionality described in this guide, the Management Repository must be configured in an Oracle Database version listed in the Enterprise Manager certification matrix.

This guide assumes a properly configured Enterprise Manager Cloud Control and Enterprise Database environment.

Supported Oracle Communications Applications

Managed application targets must meet the system requirements listed in the application's documentation. For more information, see the Oracle Communications application documentation available on the Oracle Software Delivery Cloud and Oracle Technology Network at:

See "Supported Applications" for a list of supported Oracle Communications applications and versions.

Installing the Application Management Pack for Oracle Communications Plug-in

Install the plug-in using one of the following methods:

Installing the Plug-in using Enterprise Manager Self Update

You install the Application Management Pack for Oracle Communications plug-in using Self Update in the Enterprise Manager Cloud Control administration console.

To install the plug-in using Self Update:

  1. Log in to the Enterprise Manager Cloud Control administration console.

  2. From the Setup menu, select Extensibility, and then Self Update.

  3. Select the Plug-in row and click Open.

  4. Select the row for the Oracle Communications plug-in.

  5. Click Download.

The plug-in becomes deployable after the download completes. See "Deploying the Application Management Pack for Oracle Communications Plug-In" for information about deploying the plug-in.

Installing the Plug-in Using an OPAR File

You can download the Oracle Plug-in Archive (OPAR) version of the plug-in from the Oracle Software Delivery Cloud and install the OPAR using the Enterprise Manager Command-Line Utility (EMCLI).

For information about OPAR files and EMCLI, see the Enterprise Manager Cloud Control documentation.

To install the plug-in using the OPAR file and EMCLI:

  1. Download the Application Management Suite for Communications plug-in from the Oracle Software Delivery Cloud:

    https://edelivery.oracle.com

  2. Copy the 12.1.0.2.0_oracle.cgbu.ocom_2000_0.opar file to the Enterprise Manager Cloud Control host.

  3. In a terminal session, navigate to the oms/bin directory of your Enterprise Manager Cloud Control installation.

  4. Configure the EMCLI connection to the Enterprise Manager Cloud Control host using the following command:

    ./emcli setup -url=https://host:port/em -username=sysman -password=password -trustall
    

    where host and port are the connection values for the Enterprise Manager Cloud Control server and password is the password for the sysman user.

  5. Import the Application Management Suite for Communications OPAR file using the following command:

    ./emcli import_update -file=filepath/12.1.0.2.0_oracle.cgbu.ocom_2000_0.opar -omslocal
    

    where filepath is the absolute path to the location where the 12.1.0.2.0_ oracle.cgbu.ocom_2000_0.opar file is located.

  6. Verify the successful plug-in import:

    1. Log in to the Enterprise Manager Cloud Control administration console.

    2. From the Setup menu, select Extensibility, and then Plug-ins.

    3. In the Applications folder, verify that there is an Oracle Communications row.

See "Deploying the Application Management Pack for Oracle Communications Plug-In" for information about deploying the plug-in.

Deploying the Application Management Pack for Oracle Communications Plug-In

After installing the plug-in, deploy it on the Enterprise Manager Cloud Control Management Server and target host agents.

Deploying the Plug-In on the Management Server

To deploy the plug-in on the Management Server:

  1. Log in to the Enterprise Manager Cloud Control administration console.

  2. Set up preferred credentials for the target hosts. See "Setting Up Host Preferred Credentials" for more information.

  3. From the Setup menu, select Extensibility, and then Plug-ins.

  4. From the Applications folder, select the Oracle Communications.

  5. From the Deploy On menu, select Management Servers.

    The Deploy Plugin on Management Servers dialog appears.

  6. In the Password field, enter the password for the sys user and click Continue.

  7. Complete the remaining steps in the dialog box.

  8. Click Deploy.

  9. Monitor the status to ensure successful deployment.

  10. Install the default configuration template files. See "Installing the Default Configuration Template Files" for more information.

Deploying the Plug-In on Management Agents

The plug-in must be deployed to each Management Agent on host targets running Oracle Communications applications. Before deploying the plug-in to a Management Agent you must add the host target to your Enterprise Manager Cloud Control instance. See "Adding Host Targets Manually and Installing the Management Agent" for information on adding host targets.

To deploy the plug-in to an Oracle Communications host target Management Agent:

  1. Log in to the Enterprise Manager Cloud Control administration console.

  2. From the Setup menu, select Extensibility, and then Plug-ins.

  3. Expand Applications.

  4. Right-click Oracle Communications.

  5. Select Deploy On, and then Management Agent.

    The Deploy Plug-in on Management Agent window appears.

  6. Click Continue.

  7. Select the targets on which to deploy the plug-in.

  8. Click Continue.

  9. Confirm there are no errors indicated by the pre-requisite check.

  10. Click Next.

  11. Click Deploy.

  12. Confirm that the Application Management Pack for Oracle Communication plug-in deploys successfully.

  13. Repeat steps 1 through 12 for all Oracle Communications host targets.

For more information about the Plug-In Manager, see Oracle Enterprise Manager Cloud Control Administrator's Guide.

Upgrading the Application Management Pack for Oracle Communications Plug-In

You can upgrade the plug-in using the Self Update feature in Enterprise Manager Cloud Control. You must deploy the updated plug-in to the Management Server and Management Agents.

Upgrading and deploying the plug-in involves the following tasks:

  1. Check whether a new version of the plug-in is available. See the discussion of checking the availability of plug-ins in Oracle Enterprise Manager Cloud Control Administrator's Guide for details.

  2. Download the newest version of the plug-in. See "Installing the Plug-in using Enterprise Manager Self Update" for details.

  3. Deploy the newest version of the plug-in to Oracle Management Service. See "Deploying the Plug-In on the Management Server" for details.

  4. Deploy the newest version of the plug-in on each Management Agent. See "Deploying the Plug-In on Management Agents" for details.

  5. Confirm that the newest version of the plug-in was successfully deployed as follows:

    1. Log in to the Enterprise Manager Cloud Control administration console.

    2. From the Setup menu, select Extensibility, and then Plug-ins.

      The Plug-ins page appears.

    3. Select the Oracle Communications row.

    4. From the Actions menu, select Information.

      The Plug-in Information page appears.

    5. On the General tab, confirm that the values for Latest Available Version, Version Downloaded, Version are all the same.

    6. In the Certified Targets table, confirm that the values for Plug-in Version and Plug-in Version on Management Server are the same.

  6. Install the default configuration template files. See "Installing the Default Configuration Template Files" for details.

For more information about upgrading plug-ins, see the chapter about managing plug-ins in Oracle Enterprise Manager Cloud Control Administrator's Guide.

For more information about Self Update, see the chapter about updating Cloud Control in Oracle Enterprise Manager Cloud Control Administrator's Guide.

Uninstalling the Application Management Pack for Oracle Communications Plug-In

To remove Application Management Pack for Oracle Communications:

  1. Log in to the Enterprise Manager Cloud Control administration console.

  2. From the Setup menu, select Extensibility, and then Plug-ins.

  3. In the Applications folder, select Oracle Communications.

  4. Click Undeploy From and undeploy the plug-in from all Management Agents.

  5. Click Undeploy From and undeploy the plug-in from all Management Servers.

For more information, see the discussion of undeploying plug-ins in Oracle Enterprise Manager Cloud Control Administrator's Guide.

Installing the Default Configuration Template Files

Application Management Pack for Oracle Communications provides parameter template files used by Enterprise Manager Cloud Control to install and configure supported Oracle Communications applications. You must install the default configuration template files provided to the Enterprise Manager Cloud Control domain.

To install the configuration templates:

  1. Log in to the Enterprise Manager Cloud Control host on which you have installed and deployed the Application Management Pack for Oracle Communications plug-in.

  2. Create the following directory structure in your Enterprise Manager Cloud Control instance:

    EM_home/../gc_inst/user_projects/domains/GCDomain/default_xml/platform

  3. Copy the EM_home/plugins/oracle.cgbu.ocom.oms.plugin_12.1.0.2.0/metadata/swlib/platform/components/default_xml.zip to EM_home/../gc_inst/user_projects/domains/GCDomain/default_xml/platform.

  4. Unzip default_xml.zip into the platform directory.

About Provisioning Variables

The default_xml.zip archive includes the platform_suite_default.xml file. This file contains the parameters used by the Communications Suite Installation Procedure for each supported application. See the supported application installation guides for specific information on these values and their role in application installation.

Editing platform_suite_default.xml allows the definition of commonly used or static environmental values, such as user names and port values, in your environment. The provisioning procedure pre-populates the values used in this configuration file.

The following example shows the configurable db_name value parameter for a Billing and Revenue Management database SID in the platform_suite_default.xml file:

<parameter mandatory="true" name="DATABASE_SID" value="db_name" category="orclocom_brm" basic="true" type="DBRegister">
      <label locale="en" value="Database SID"/>
</parameter>

Make a copy of the edited platform_suite_default.xml file and save it in a secure location.

Creating the Oracle Communications Folders for BRM Installers

If you are provisioning Billing and Revenue Management, you must create the CommSuiteProvisioning and BRMComponents folders in the Enterprise Manager Cloud Control Software Library to store installers used during the provisioning procedure.

To create the folders:

  1. Log in to the Enterprise Manager Cloud Control administration console.

  2. From the Enterprise menu, select Provisioning and Patching, and then Software Library.

  3. From the Actions menu, select Create Folder.

  4. In the Name field, enter CommsSuiteProvisioning.

  5. Click OK.

  6. Select the CommsSuiteProvisioning folder.

  7. From the Actions menu, select Create Folder.

  8. In the Name field, enter BRMComponents.

  9. Click OK.

Enabling Application Management Pack for Oracle Communications Logging

Enable java logging for Application Management Pack for Oracle Communications in Enterprise Manager Cloud Control by updating the logging.xml file located in the following directory on your Enterprise Manager Cloud Control Management Server host:

EM_home/gc_inst/user_projects/domains/GCDomain/config/fmwconfig/servers/EMGC_OMS1

To enable logging:

  1. Log in to the Management Server host as a user with permissions to modify the Enterprise Manager Cloud Control configuration.

  2. Change directory to EM_home/gc_inst/user_projects/domains/GCDomain/config/fmwconfig/servers/EMGC_OMS1.

  3. Open the logging.xml file with a text editor.

  4. Add a new entry for the Application Management Pack for Oracle Communications log handler. Use the following example as a guide:

     <log_handler name='comms-ams-handler' class='oracle.core.ojdl.logging.ODLHandlerFactory' filter='oracle.dfw.incident.IncidentDetectionLogFilter'>
       <property name='path' value='${domain.home}/servers/${weblogic.Name}/sysman/log/comms-ams.log'/>
       <property name='maxFileSize' value='10485760'/>
       <property name='maxLogSize' value='104857600'/>
       <property name='encoding' value='UTF-8'/>
       <property name='useThreadName' value='true'/>
       <property name='supplementalAttributes' value='J2EE_APP.name,J2EE_MODULE.name,WEBSERVICE.name,WEBSERVICE_PORT.name,composite_instance_id,component_instance_id,composite_name,component_name'/>
      </log_handler>
    
  5. Add a new entry for a logger referring to the log handler created in step 4. Use the following example as a guide:

    <logger name='oracle.communications.platform.em' level='NOTIFICATION' useParentHandlers='false'>
       <handler name='comms-ams-handler'/>
      </logger>
    

    Set the logging level by editing the level value in the logger entry. For example, the following logger entry provides trace logging of all messages:

    <logger name='oracle.communications.platform.em' level='TRACE:32' useParentHandlers='false'>
       <handler name='comms-ams-handler'/>
      </logger>
    

    Setting the logging level to TRACE:32 produces large amounts of logging data and should only be used for resolving issues with your Application Management Pack for Oracle Communications environment. See the chapter about logging in Oracle Enterprise Manager System Administrator's Guide for more information on setting logging levels.

  6. Save the changes made to logging.xml and exit the editor.

You are not required to restart the Enterprise Manager Cloud Control Management Server to activate changes to logging configuration.