9 Installing Pipeline Manager

Learn how to install the Oracle Communications Billing and Revenue Management (BRM) Pipeline Manager.

Pipeline Manager Installation Overview

To install and configure Pipeline Manager, follow the steps in these sections:

  1. Pipeline Manager System Requirements
  2. Pipeline Manager Preinstallation Tasks
  3. Installing Pipeline Manager
  4. Increasing Heap Size to Avoid “Out of Memory" Error Messages
  5. Configuring an Oracle Pipeline Manager Database

Pipeline Manager System Requirements

Before you install and run Pipeline Manager, ensure that you have installed and configured the required hardware and software.

Pipeline Manager requires the following software:

  • Oracle Database server
  • Oracle Database client
  • Java Runtime Environment (JRE)

See BRM Compatibility Matrix for the supported software versions.

The number and configuration of the computers that you employ for your Pipeline Manager installation depend on the scale and the kind of deployment you have planned.

Note:

The more pipelines you configure and the more CPUs you use, the more important it is to put input and output on systems that are managed by different Controllers.

Pipeline Manager Preinstallation Tasks

Perform the following tasks before installing Pipeline Manager:

  1. Install and configure BRM. See "Installing and Configuring BRM" for more information.

  2. Install the Pipeline Manager database. See "Configuring an Oracle Pipeline Manager Database".

  3. Configure the OS environment. See "Creating a User and Configuring Environment Variables" for more information.

  4. Update the OS kernel. See "Setting the Maximum Allowed Number of Open Files" for more information.

Creating a User and Configuring Environment Variables

Follow these steps to create a Pipeline Manager user and set up system environment variables on a system:

  1. Create a user that owns the Pipeline Manager software. The examples in this document use the default user integrate with the bash shell as the default shell.

    Note:

    You must create a Pipeline Manager user and set the user's environment before installing Pipeline Manager.

  2. Log in as user integrate.

  3. Go to the Pipeline_home directory.

  4. Open the source.me.sh file for your shell in a text editor.

    Note:

    The source.me file is for a bash shell. If you use a C shell, open the source.me.csh file.

  5. Set the environment variables for Pipeline Manager that are listed in Table 9-1:

    Table 9-1 Pipeline Manager Environment Variables

    Environment Variable Description

    IFW_HOME

    The directory where the Pipeline Manager software is installed.

    Note: This documentation refers to this directory as Pipeline_home.

    LD_LIBRARY_PATH

    The library path.

    Set this to include Pipeline_home/lib at the end of the variable. For example, in bash set the following: 

    export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:Pipeline_home/lib

    Important: After your first upgrade reset the LD_LIBRARY_PATH environment variable to the following: 

    setenv LD_LIBRARY_PATH ${LD_LIBRARY_PATH};BRM_home/lib:Pipeline_home/lib

    where BRM_home/lib is before Pipeline_home/lib.

    MALLOC_TRIM_THRESHOLD_

    MALLOC_MMAP_MAX_

    MALLOC_TOP_PAD_

    On Linux Pipeline Manager platforms, modify the MALLOC_TRIM_THRESHOLD_, MALLOC_MMAP_MAX_ and MALLOC_TOP_PAD_ environment variables with these values:

    • MALLOC_TRIM_THRESHOLD_ = -1

    • MALLOC_MMAP_MAX_ = 0

    • MALLOC_TOP_PAD_ = 268435456

    MAX28DIGIT_DECIMAL_SUPPORT

    By default, Pipeline Manager supports 15-digit decimal. To configure Pipeline Manager to support up to 28-digit decimal, set this to Y.

    NLS_LANG

    Set this to LANG American_America.AL32UTF8.

    Important: You must use American_America as the language and territory regardless of your locale and the UTF8 or AL32UTF8 character set.

    BRM 15.1 supports AL32UTF8 as its default character set. It also continues to support the UTF8 character set for BRM installations that are being upgraded to BRM 15.1 from previous versions. The unicode character set AL32UTF8 is recommended for all new BRM 15.1 deployments.

    PATH

    The Pipeline Manager executable path.

    Set this to include Pipeline_home/bin.

    IFW_EVENTHANDLER_PORT

    The port number on which the event handler daemon listens for events.

    Important:

    • If you are starting more than one framework process, change the value of this parameter before starting each process. Each process must have a unique event handler port for all users on a host. A framework process will not start if it cannot start the event handler daemon, and the event handler daemon will not start if it cannot listen on the specified port.

    • Set this variable to a port number that is not in use. Do not set it to a well-known port number, such as port 11960 which is used by BRM.

  6. Save and close the updated file.

  7. Update the environment for the current shell session:

    For bash shell:

    source source.me.sh

    C shell:

    source source.me.csh

Setting the Maximum Allowed Number of Open Files

To avoid causing a failure of Pipeline Manager, you must configure the maximum number of pipeline files allowed in the kernel.

To set the maximum open files on Linux:

  1. Log on as root.

  2. Open the system file (/etc/sysctl.conf).

  3. Add the following lines to the end of the file, or modify the values if these lines are already present. For example:

    # sets the hard limit on file descriptors:
fs.file-max = 2605192

  4. Run sysctl -p to reload all the settings from the system file.

Configuring an Oracle Pipeline Manager Database

This section describes how to configure the Pipeline Manager database on Oracle.

Before proceeding, you should be familiar with executing database scripts.

Before setting up the Oracle database for Pipeline Manager, ensure the following:

  • An Oracle database instance is mounted and open.

  • You have administrator access to the database instance.

To install and configure the Pipeline Manager database, follow the steps in these sections:

  1. Setting the Environment for the Pipeline Manager Database
  2. Setting Up the Oracle JSA Database Schema
  3. Setting Up the Oracle Pipeline Manager Framework Database Schema
  4. Changing Public Synonyms to Private for Users in Multiuser Environments
  5. Loading Procedures for FCT_DuplicateCheck

Setting the Environment for the Pipeline Manager Database

Before setting up the database schemas for your Oracle Pipeline Manager database, you must configure database environment variables.

  1. Open the configuration file for the login shell. This is the file in which your user profile is stored; for example, .profile or .bashrc. By default it is stored in your home directory.

  2. Change the variables in Table 9-2 to match your Pipeline Manager environment:

    Table 9-2 Environment Variables of Pipeline Manager Database

    Environment Variable Description

    ORACLE_HOME

    Set this variable to point to the Oracle database installation path.

    LD_LIBRARY_PATH

    Set this to point to the database /lib directories, for example: 

    LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$ORACLE_HOME/lib:$ORACLE_HOME/rdbms/lib

    LD_LIBRARY_PATH_64

    Set this to point to the database /lib directories, for example: 

    LD_LIBRARY_PATH_64=$IFW_HOME/lib:$ORACLE_HOME/lib:$ORACLE_HOME/rdbms/lib

    PATH

    Set this to the database /bin directory, for example: 

    PATH=$PATH:$ORACLE_HOME/bin

  3. Save and close the file.

Setting Up the Oracle JSA Database Schema

This section describes how to run scripts to set up the Oracle JSA database schema.

Run the scripts described in the following steps to set up the database schema for the JSA tables and tablespaces:

Note:

All scripts are located in the Pipeline_home/database/Oracle/Scripts directory.

  1. Open the JSA_Tablespaces.sql file with a text editor.

  2. Replace all occurrences of the string *** with the path to the Oracle tablespace data file.

  3. Save the file.

  4. Log in as user database administration (DBA).

  5. Run the JSA_Tablespaces.sql script.

    This script creates the tablespaces for the JSA server.

  6. Run the JSA_Roles.sql script.

    This script creates roles and the default JSA user.

  7. Log out and log in as user JSA.

  8. Run the JSA_Create.sql script.

    This script creates the JSA tables.

  9. Run the JSA_Synonyms.sql script.

    This script creates the JSA public synonyms.

  10. Run the JSA_Prepare.sql script.

    This script inserts some default values into the tables.

The Oracle JSA database schema is now set up.

Setting Up the Oracle Pipeline Manager Framework Database Schema

To set up the database schema for the Pipeline Manager framework work tables and tablespaces:

Note:

All scripts are located in the Pipeline_home/database/Oracle/Scripts directory.

  1. Open the ifw_Tablespaces.sql file with a text editor.

  2. Replace the occurrences of the string ORA_DAT_PATH and ORA_IDX_PATH with the path that leads to the *.dbf files shown in the script file.

  3. Save the file.

  4. Log in as user DBA.

  5. Run the ifw_Tablespaces.sql script.

    This script creates the tablespaces for the Pipeline Manager framework.

  6. (Optional) Change the default Pipeline Manager user name (pipeline_user) from integrate to another name:

    1. Open the ifw_Roles.sql file by using a text editor.

    2. In the User: INTEGRATE section, replace the two occurrences of INTEGRATE in the following string with the new default user name:

      INTEGRATE identified by INTEGRATE

    3. In the GRANT commands that follows the QUOTA commands in the User: INTEGRATE section, replace all occurrences of INTEGRATE with the new default user name.

    4. Save the file.

  7. Run the ifw_Roles.sql script.

    This script creates the appropriate roles and the default user.

  8. Log out and log in as pipeline_user.

  9. Run the ifw_Create.sql script.

    This script creates the Pipeline Manager framework tables.

  10. Run the ifw_Synonyms.sql script.

    This script creates the public synonyms.

The Oracle Pipeline Manager framework database schema is now set up.

You can create only one instance of the pipeline schema in a particular database. You can create multiple users and give permission to access the same tables. Creating multiple instances lead to public synonym conflict.

To avoid public synonym conflicts in a multiuser environment, change the public synonyms to private synonyms for specific users. See "Changing Public Synonyms to Private for Users in Multiuser Environments" for more information.

For example, if you create table1 for user1, you can create user2 and assign permissions to access table1. Typically, you access the table as user1.table1. However, using synonyms, you can directly access the table as table1. No prefix (user1) is required.

Changing Public Synonyms to Private for Users in Multiuser Environments

Changing public synonyms to private synonyms for a user is required for avoiding public synonym conflict in a multiuser environment.

Note:

All scripts are located in the Pipeline_home/database/Oracle/Scripts directory

To change public synonyms to private synonyms for a user:

  1. Connect to the Oracle database with SQL*Plus:

    % sqlplus system@databaseAlias
Enter password: password

    where databaseAlias is the database alias of the Oracle database.

  2. Retrieve the list of public synonyms to drop by running the following command:

    select synonym_name from all_synonyms where
      owner = 'PUBLIC' and table_name like '%IFW%';

  3. Drop the public synonyms returned in the previous step for the user using commands like the following:

    drop public synonym IC_DAILY;
drop public synonym IC_DAILY_ALTERNATE;
drop public synonym IFW_AGGREGATION;
. . .

  4. Grant CREATE ANY synonym access to the user you created for the Pipeline Manager tables. For example:

    SQL> CREATE ROLE synonym_role;
SQL> GRANT CREATE ANY SYNONYM TO synonym_role;
SQL> GRANT synonym_role TO pin_user;

    where pin_user is the BRM user.

  5. Open the ifw_Synonyms.sql file with a text editor.

  6. Remove the occurrences of the string public and add the Pipeline Manager database user. For example, for ifw_SEQ_AGGREGATION table, change the string to:

    create synonym ifw_SEQ_AGGREGATION for ifw_user.ifw_SEQ_AGGREGATION;

    where ifw_user is the is the Pipeline Manager database user.

  7. Save the file.

  8. Run the ifw_Synonyms.sql script.

    This script creates the private synonyms for the user.

  9. Exit SQL*Plus.

The public synonyms are now changed to private synonyms for the user.

Loading Procedures for FCT_DuplicateCheck

Before using the FCT_DuplicateCheck module, you must load the duplicate check stored procedures in the Pipeline Manager database:

  1. Load the DuplicateCheck_Oracle.plb file from Pipeline_home/database/Oracle/Scripts/DuplicateCheck.

  2. Verify that there is an unique index BIDX_DUPCHK_DATA on the DATA column of the IFW_DUPLICATECHECK table. If not, then create it before starting Pipeline Manager.

The duplicate check stored procedures are now loaded.

Installing Pipeline Manager

This section describes how to install Pipeline Manager.

Note:

If you are installing Pipeline Manager to replace an identical release (for example, to restore a clean version of the package), you must first uninstall the existing installation. See "Uninstalling Pipeline Manager and Optional Components".

To install Pipeline Manager, see "Installing Individual BRM Components".

Note:

Ensure that SSL/TLS is enabled in real-time and batch pipelines. See Enabling SSL/TLS in Real-Time Pipeline and Enabling SSL/TLS in Batch Pipeline in BRM System Administrator's Guide.

To upgrade Pipeline Manager, see "Upgrading BRM and Pipeline Manager from BRM 12.0 to BRM 15.1".

Pipeline Manager Directory Structure

Installation creates the following directory structure shown in Table 9-3:

Note:

Pipeline_home is the default Pipeline Manager installation directory.

Table 9-3 Directory Structure Created by Pipeline Manager Installation

Directory Description

Pipeline_home/bin/

Server binaries, such as the main Pipeline Manager binary ifw.

Pipeline_home/conf/

Contains registry files.

Pipeline_home/data/

Contains source and directory files for EDRs.

Pipeline_home/database/

Database creation scripts and database documentation.

Pipeline_home/discount/

Balance Data Module transaction and data.

Pipeline_home/etc/

Error messages.

Note: You can copy the error messages to another directory and customize them; for example, as preparation for translation into other languages.

Pipeline_home/formatDesc/

External file format definitions and internal container definitions.

Pipeline_home/info/

Info registry, which shows the current system status.

Pipeline_home/instrumentation/

Performance Data collection.

Pipeline_home/iScriptLib/

iScript libraries.

Pipeline_home/lib/

Shared libraries.

Pipeline_home/lib64/

Shared libraries (64-bit)

Pipeline_home/log/

Process log.

Pipeline_home/releaseNotes/

Release notes.

Pipeline_home/samples/

Sample registries that you can use for testing your Pipeline Manager setup.

Pipeline_home/semaphore/

Directory that is checked regularly for semaphores.

Pipeline_home/tools/

The tools such as binaries and Perl scripts.

Installing Pipeline Manager Optional Components

This section describes how to install the following Pipeline Manager optional components:

  • Pipeline Configuration Manager

  • Pipeline PDK Manager

  • Interconnect Manager

  • CIBER Roaming Manager (requires Interconnect Manager)

  • TAP Roaming Manager (requires Interconnect Manager)

For more information on configuring roaming in Pipeline Manager, see "Setting Up Pipeline Manager for Roaming Incollect Processing" and "Setting Up Pipeline Manager for Roaming Outcollect Processing" in BRM Implementing Roaming.

Before installing Pipeline Manager optional components, you must install Pipeline Manager.

Note:

If you are installing the optional components to replace an identical release (for example, to restore a clean version of the package), you must first uninstall the existing installation. See "Uninstalling Optional Components".

To install Pipeline Manager optional components, see "Installing Individual BRM Components".

Note:

If you install Pipeline PDK Manager, after installing it consult the PDK_home/README.PDK file, where PDK_home is the directory in which the PDK is installed, for additional steps to follow before using the PDK.

Increasing Heap Size to Avoid “Out of Memory" Error Messages

To avoid "Out of Memory" error messages in the log file after installation, increase the maximum heap size used by the Java Virtual Machine (JVM). The exact amount varies greatly with your needs and system resources. By default, the JVM used has a maximum heap size of 60 MB. Increase the maximum heap size to 120 MB by entering the following sample code in a text editor:

%IF_EXISTS%("INIT_JAVA_HEAP", "@INIT_JAVA_HEAP@20m") %IF_EXISTS%("MAX_JAVA_HEAP", "@MAX_JAVA_HEAP@120m")

where 20m and 120m indicate the minimum and maximum heap sizes respectively.

Save the file as Packagename.ja in the temporary directory (temp_dir) to which you downloaded the installation software.

Packagename indicates the name of the installation software.

Uninstalling Pipeline Manager and Optional Components

To uninstall Pipeline Manager and its optional components, see "Uninstalling Optional Components".