1. Installation Guide
  2. Installing BRM
  3. Installing BRM

5 Installing BRM

You can install the Oracle Communications Billing and Revenue Management (BRM) software on Linux and Solaris.

Note:

If you are upgrading from an earlier BRM release to BRM 12.0, see "About Upgrading BRM Releases" in BRM Upgrade Guide.

Topics in this document:

This chapter is for network administrators, database administrators, and engineers who install and configure the BRM software. The person installing the software should be familiar with the following topics:

  • UNIX administration commands and the UNIX operating system

  • Database configuration

  • Network system management

Preparing for BRM Installation

To install BRM, you need the following:

  • A directory with sufficient space for the BRM software (at least 440 MB).

  • A user ID, such as pin, with the privileges to access the files under your BRM home directory and to run BRM and third-party applications.

  • The BRM-related information that you noted when installing your database.

    See "About Capturing Information When Installing the Oracle Database Software".

You also need to perform the following tasks before installing BRM:

Installing Java

Install Java Platform, Standard Edition (Java SE), containing Java Development Kit (JDK) and Java Runtime Environment (JRE). JRE is required for the BRM installation. It is not included in the BRM 12.0 software pack.

See "BRM Software Compatibility" in BRM Compatibility Matrix for the compatible version of Java.

For instructions on installing Java, see Oracle Java documentation.

Installing Perl

Perl is required for the BRM installation. It is not included in the BRM 12.0 software pack. To install Perl:

Installing Perl on Linux

Before installing Perl (32 bit) on Linux, do the following:

  1. Install the required 32-bit libraries by doing the following:

    1. Go to the command prompt on the Linux server on which you want to install BRM.

    2. Run the following commands:

      yum -y install gdbm-devel.i686
yum -y install libdb-devel.i686

      Note:

      If you use a proxy server as an intermediary for Internet access, configure a proxy server to access the yum repository. See https://docs.oracle.com/cd/E37670_01/E37355/html/ol_yum_config.html#ol_proxy_config.

  2. Set the environment variable for installing Perl by running the following command:

    • For Bash shell:

      export -n PATH
export -n LD_LIBRARY_PATH
export PATH=/usr/bin:/usr/local/bin:/bin

    • For C shell:

      unsetenv PATH
unsetenv LD_LIBRARY_PATH
setenv PATH /usr/bin:/usr/local/bin:/bin

To install Perl on Linux:

  1. Download the source code for the compatible version of Perl to a temporary directory (temp_dir).

    See BRM Compatibility Matrix for the compatible version of Perl.

  2. Go to the temp_dir directory and unzip the source code by running the following command: 

    gunzip perl-version.tar.gz
tar xf perl-version.tar

    where version is the compatible version of Perl.

  3. Run the following command:

    cd perl-version
sh Configure -des -Dcc="gcc -m32" -Dusethreads -Duserelocatableinc -Dprefix='perl_path'

    where perl_path is the path to the directory in which you want to install Perl.

    Note:

    If you receive errors, use this command instead, which unsets the LD_LIBRARY_PATH variable:

    sh Configure -des -Dcc="gcc -m32 -D_FILE_OFFSET_BITS=64-D_LARGE_FILE_SOURCE=1" -Dusethreads -Dusemorebits -Uuselargefiles -Duserelocatableinc -Dprefix='perl_path'

  4. Run make.

  5. Run make test.

  6. Run make install.

  7. Verify the Perl version by running the following command:

    Perl -v

    The Perl version is displayed.

    If the latest version of Perl certified with BRM is not displayed, the latest Perl is not installed.

Installing Perl on Solaris

Before installing Perl (32 bit) on Solaris, do the following:

  1. Install Oracle Developer Studio. See Oracle Developer Studio Installation Guide for instructions.

  2. Comment the following entries in the util.c file: 

    if(UNLIKELY(got != need)) {
 bad_handshake:/* recycle branch and string from above */ 
         /* if(got != (void *)HSf_NOCHK) 
            noperl_die("%s: loadable library and perl binaries are mismatched"
 " (got handshake key %p, needed %p)\n", 
                file, got, need); */ 
    }

  3. Set the environment variable for installing Perl by running the following command:

    • For Bash shell:

      export -n PATH
export -n LD_LIBRARY_PATH
export PATH=/usr/bin:/usr/local/bin:/bin

    • For C shell:

      unsetenv PATH
unsetenv LD_LIBRARY_PATH
unsetenv PERL5LIB
unsetenv PERL_HOME
setenv PATH /usr/bin:/usr/local/bin:/bin:/usr/ccs/bin:Oracle_dev_path

To install Perl on Solaris:

  1. Download the source code for the compatible version of Perl to a temporary directory (temp_dir).

    See BRM Compatibility Matrix for the compatible version of Perl.

  2. Go to the temp_dir directory and unzip the source code by running the following command: 

    gunzip perl-version.tar.gz
tar xf perl-version.tar

    where version is the compatible version of Perl.

  3. Run the following command:

    cd perl-version
sh Configure -des -Dcc="Oracle_dev_path" -Dusethreads -Dusemorebits -Dprefix='perl_path'

    where:

    • Oracle_dev_path is the path to the directory in which the Oracle Developer Studio is installed.

    • perl_path is the path to the directory in which you want to install Perl.

  4. Run make.

  5. Run make test.

  6. Run make install.

  7. Verify the Perl version by running the following command:

    Perl -v

    The Perl version is displayed.

    If the latest version of Perl certified with BRM is not displayed, the latest Perl is not installed.

Installing Apache Kafka

Install the latest version of Apache Kafka, which is required for the BRM installation. It is not included in the BRM 12.0 software pack.

For the latest compatible version, see "BRM Software Compatibility" in BRM Compatibility Matrix.

For instructions on downloading and installing Kafka, see "Apache Kafka Quickstart" on the Apache Kafka website.

Obtaining ojdbc JAR File

Obtain the ojdbc8.jar file and save it in a directory on the machine on which you want to install BRM. Note the path to this directory; you are required to specify this path in the Specify Prerequisite Libraries Location screen during the BRM installation.

You can download ojdbc8.jar from the following location:

https://www.oracle.com/database/technologies/appdev/jdbc.html

Granting Execute Permission to pin_user

You can create pin_user before installing BRM or during the BRM installation process. If you create pin_user before you install BRM, you must grant execute permission to pin_user.

To grant execute permission to pin_user:

  1. Log in to your database as user sysdba: 

    % sqlplus system@databaseAlias AS SYSDBA
Enter password: password

    where:

    • password is the Oracle system database user password.

    • databaseAlias is the Oracle system database alias.

  2. Grant execute privileges to pin_user: 

    grant unlimited tablespaces to pin_user;
grant alter session to pin_user;
grant execute on dbms_lock to pin_user;
grant execute on dbms_aq to pin_user;
grant execute on dbms_aqadm to pin_user;
grant select on sys.gv_$aq to pin_user;
grant create public synonym , create synonym , drop public synonym , create view , create sequence , create table , create any index , create procedure , resource, connect to pin_user;

Setting the BRM User's Environment

Create a BRM user and set the user's environment before installing BRM.

  1. In the .cshrc file, set the NLS_LANG environment variable to American_America.AL32UTF8.

    Note:

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

    The other environment variables are set during BRM installation.

  2. Update the environment for the current shell session:

    % source .cshrc
Referencing Environment Variables in pin.conf Files
To prepare for migrating pin.conf files to other systems or platforms at a future time, you can reference certain environment variables from within the pin.conf files, as in this example:
- cm fm_module ${PIN_HOME}/lib/fm_utils/${LIBRARYEXTENSION} fm_utils_config fm_utils_init pin

For more information, see "Preparing for Platform Migration by Using Variables in pin.conf Files" in BRM System Administrator's Guide.

Setting the Environment Variables

Before installing BRM, you must set the environment variables for the following third-party software:

  • Java
  • Perl
  • Apache Kafka

    Note:

    Apache Kafka is required for the Kafka Data Manager, which was added to BRM 12.0 in the Patch Set 4 release.

See "Additional BRM Software Requirements" in BRM Compatibility Matrix for the list of compatible software versions.

To set the environment variables, perform the following on the machine on which you want to install the BRM server:

  1. Set the JAVA_HOME environment variable:
    setenv JAVA_HOME java_path

    where java_path is the path to the directory in which the latest version of Java certified with BRM is installed; for example, /Linux/x86_64/packages/jdk/jdk1.8.0_144.

  2. Verify the Java version by running the following command:
    java -version

    The Java version is displayed.

    If the latest version of Java certified with BRM is not displayed, the latest Java version is not installed.

  3. Set the PERL_HOME environment variable:
    setenv PERL_HOME Perl_path

    where Perl_path is the path to the directory in which the latest version of Perl certified with BRM is installed; for example, /perl_5_24.0/linux.

  4. Set the PATH environment variable:
    setenv PATH $JAVA_HOME/bin:$PERL_HOME/bin:${PATH}
  5. Set the HOSTNAME environment variable:
    setenv HOSTNAME hostName

    where hostName is the fully qualified domain name of the machine on which you want to install the BRM server.

  6. Set the Kafka environment variables:
    setenv KAFKA_HOME Kafka_path
setenv KAFKA_BOOTSTRAP_SERVER_LIST KafkaHost1:port1,KafkaHost2:port2

    where:

    • Kafka_path is the path to the directory in which the Kafka library JARs are installed.
    • KafkaHost1:port1,KafkaHost2:port2 are the hosts and ports that the Kafka client will connect to in a bootstrap Kafka cluster the first time it starts. You can specify any number of hosts and ports in this list.

      You can alternatively set this list in the dm_kafka_config.xml. See "Mapping Business Events to Kafka Topics" in BRM Developer's Guide.

Setting BRM Wallet Location in sqlnet.ora

To set the BRM wallet location in the sqlnet.ora file:

  1. Open the $ORACLE_HOME/network/admin/sqlnet.ora file on the machine on which you want to install the BRM server.

  2. Add the following entries:

    SQLNET.WALLET_OVERRIDE = TRUE
WALLET_LOCATION=(
   SOURCE=(METHOD=FILE)
   (METHOD_DATA=(DIRECTORY= $PIN_HOME/wallet/client))
)

  3. Save and close the file.

About the BRM Installation Package

The BRM installation package includes the BRM server and BRM client packages. The BRM server package includes all the required and optional BRM server components and applications. You can use the Installer to install one or more of the following individual BRM server components:

  • Typical BRM server components. The following are the most commonly used BRM server components:

    • Connection Manager (CM)

    • Oracle Data Manager (DM)

    • Batch Controller

    • Billing and Invoicing utilities

  • Connection Manager (CM) Proxy

  • Connection Manager (CM) Master Process (CMMP)

  • Invoice Data Manager

    The Invoice Data Manager is supported only on Oracle databases. Before you install the Invoice Data Manager, make sure you have a separate database schema installed and available to use for storing invoices.

  • Kafka Data Manager

    Note:

    The Kafka Data Manager is supported by BRM 12.0 Patch Set 4 and later releases.

  • Provisioning Data Manager

  • Synchronization Queue Data Manager (AQ Data Manager)

  • Email Data Manager

  • BRM Optional Managers

    You can install BRM with the following optional managers:

    Note:

    You must install the CM and DM before installing the optional managers. Also, make sure that you install the optional managers on the same machine where the CM is installed.

    • Account Migration Manager (AMM)

    • Account Synchronization Manager

      See "Installing and Configuring Account Synchronization" for more information.

    • BRM Services Framework Manager

    • BRM SDK

      You can install BRM SDK independent of the BRM server, making it possible to isolate development activities from production servers. For example, you can install BRM SDK on each of the computers used by BRM developers at your site. These developers can share access to test and production BRM servers. However, there are some advantages of installing the BRM SDK on BRM servers. For example, installing the SDK on your BRM server gives you access to sample applications that are not included in the server installation.

    • Conversion Manager

    • Collections Manager

      The BRM Collections Manager server components include opcodes, utilities, and storable classes.

    • Content Manager

    • EAI Manager

      To ensure proper load balancing on your BRM system, you can install EAI Manager on a different machine. However, you must install this on the same machine where the CM is installed.

    • Event Extraction Manager

    • GPRS Manager

    • GSM Manager

    • Inventory Manager

    • IP Address Manager

    • JCA Resource Adapter

    • LDAP Manager

    • MultiDB manager

    • Number Manager

    • Paymentech Manager

    • Partition Upgrade Manager

    • Performance Manager

    • Revenue Assurance Manager

    • Rated Event Loader

    • SIM Manager

    • Roaming Settlement Package

    • Suspense Manager

    • Vertex Manager

    • Voucher Manager

    • Web Services Manager

      Oracle recommends that you install Web Services Manager on the machine on which the typical BRM server components are installed. You must also increase the heap size used by the Java Virtual Machine (JVM) before installing Web Services Manager to avoid "Out of Memory" error messages in the log file.

  • BRM Reports

  • BRM Reports Optional Managers

    You can install BRM Reports with the following optional managers:

    • MultiDB Reports

    • Collections Reports

    • Content Manager Reports

    • GPRS Reports

    • Number Manager Reports

    • Revenue Assurance Reports

    • Roaming Reports

    • SIM Card Manager Reports

    • SMS Reports

    • Suspense Reports

    • Voucher Reports

  • BRM Invoices

  • Pipeline Manager

  • Pipeline Manager Optional Managers

    You can install Pipeline Manager with the following optional managers:

    • CIBER Roaming Manager

    • Interconnect Manager

    • Pipeline Configuration Manager

    • Pipeline PDK Manager

    • TAP Roaming Manager

For information on the BRM client application package, see "Installing BRM Thick Clients".

Installing BRM: Task List

BRM installation must be performed by a user who has permissions to write to the oraInventory directory.

To install the BRM software:

  1. Ensure that you can connect to your database using SQL*Plus without the user name and password. For example, if your database alias is pindb: 

    sqlplus /@pindb

    The BRM installer requires the ability to connect to the database without a user name and password.

  2. Download the BRM package and extract its contents. You can download a full version of BRM 12.0 or a full version of a BRM 12.0 Patch Set. See "Downloading the BRM Software".

  3. Install the BRM software in either GUI mode or silent mode. Installing BRM in silent mode lets you perform a non-interactive installation of BRM. You can use silent mode to install BRM quickly.

  4. Check your configuration entries and Oracle wallet. See "Completing the Installation".

Downloading the BRM Software

You can download the BRM software from the following locations:

Search for and download the Oracle Communications Billing and Revenue Management 12.0.0.x.0 software, where x is 0 for the 12.0 release, 1 for Patch Set 1, 2 for Patch Set 2, and so on. The Zip archive includes one of these installers:

  • brmserver_12.0.0.0.0_platform_generic.jar for performing a full installation of the BRM 12.0 software.

  • brmserver_12.0.0.x.0_platform_generic_full.jar for performing a full installation of a BRM 12.0 Patch Set.

Note:

If you are performing a full installation of BRM 12.0 Patch Set 4 or later and your existing BRM system contains BRM 12.0, 12.0 Patch Set 1, 12.0 Patch Set 2, or 12.0 Patch Set 3, you must perform some additional steps before you start the BRM installer. See "Installing the BRM Kafka DM" in BRM Developer's Guide.

Installing BRM in GUI Mode

To start the BRM GUI installer, go to the temp_dir directory and run one of these commands:

  • To start the GUI installer:

    Java_home/bin/java -jar jar_file

    where:

    • Java_home is the directory in which you installed the latest compatible Java version.

    • jar_file is the BRM installer file. For example:

      For BRM 12.0, enter:

      brmserver_12.0.0.0.0_platform_generic.jar

      For a BRM 12.0 Patch Set, enter:

      brmserver_12.0.0.x.0_platform_generic_full.jar

      where x is the patch set number, and platform is linux or solaris.

  • To start the GUI installer and install BRM using the oraInventory directory in a different location: 

    Java_home/bin/java -jar jar_file -invPtrLoc FilePath/oraInst.loc

    where FilePath is the path to the directory in which the oraInst.loc file is located.

  • To start the GUI installer and create a silent installer response file during the installation:

    Java_home/bin/java -jar jar_file -record -destinationFile path

    where path is the absolute path to the response file.

After the GUI installer starts, the steps for installing BRM depend on the BRM server components you choose to install:

  • To install only the default BRM server components, select the Typical installation option.

    This option installs the most common BRM server components that are required by default. Recommended for most users. Use this option for evaluation, demonstration, and functional testing.

    See "Installing a Typical BRM System" for more information.

  • To install all BRM server components, select the Complete installation option.

    See "Installing All BRM Components" for more information.

    This option installs all the BRM server components. Use this option for development and production systems.

  • To choose one or more BRM server components to install each time you run the installer, select the Custom installation option.

    This option installs a subset of BRM server components that you select. Recommended for advanced users. Use this option for production systems.

    See "Installing Individual BRM Components" for more information.

    For an overview of the different ways to set up a production system, see "Types of BRM Systems".

Installing a Typical BRM System

The instructions in this section assume that you are installing all of the required BRM server components, including the database, on a single computer.

Note:

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

A typical BRM system is a self-contained version of BRM that contains only the most typically used BRM components. Use this option for evaluation and demonstration systems.

To install a typical BRM system, launch the installer and then answer the screen prompts:

  1. In the Welcome screen, click Next.

    Note:

    If the oraInst.loc file is corrupt or not present, the Specify Inventory Directory and Credentials screen appears next. Otherwise, the Installation Location screen appears.

  2. (Optional) In the Specify Inventory Directory and Credentials screen, enter the details listed in Table 5-1 and then click Next.

    Table 5-1 Specify Inventory Directory and Credentials

    Field Description

    Inventory Directory

    The full path to the inventory directory.

    The default location of the oraInventory directory is in the /etc/oraInst.loc (Linux) file or the /var/opt/oracle/oraInst.loc (Solaris) file.

    Operating System Group Name

    The name of the operating system group that has write permission to the inventory directory.

  3. In the Installation Location screen, enter the full path or browse to the directory in which to install BRM and then click Next.

  4. In the Installation Type screen, select Typical and then click Next.

  5. In the Specify Prerequisite Libraries Location screen, enter the details listed in Table 5-2 and then click Next.

    Table 5-2 Specify Prerequisite Libraries Location

    Field Description
    Prerequisite Libraries

    The full path to the directory in which the prerequisite libraries are stored.
    Enable SSL

    Do one of the following:

    • To enable secure communication between BRM server components, select the Enable SSL check box.

    • To not use SSL between BRM server components, deselect the check box.

  6. In the Specify Wallet Details screen, enter the details listed in Table 5-3 and then click Next.

    Table 5-3 Specify Wallet Details

    Field Description

    Client Wallet Password

    The password for the client Oracle wallet.

    Confirm Client Password

    Enter the client Oracle wallet password again.

    Root Wallet Password

    The password for the root Oracle wallet.

    Confirm Root Password

    Enter the root Oracle wallet password again.

    Server Wallet Password

    The password for the server Oracle wallet.

    Confirm Server Password

    Enter the server Oracle wallet password again.

  7. In the Specify BRM Log Location screen, enter the full path to the directory in which to store BRM log files and then click Next.

  8. In the Database SSL Options screen, select one of the following:

    • If your database does not use SSL, select No, click Next, and proceed to step 10.

    • If your database uses one-way SSL, select Yes One Way, click Next, and proceed to the next step.

    • If your database uses two-way SSL, select Yes Two Way, click Next, and proceed to the next step.

  9. In the Database SSL Information screen, enter the details listed in Table 5-4 and then click Next.

    Table 5-4 Database SSL Information

    Field Description

    Truststore Type

    The type of TrustStore file for the SSL connection: SSO, PKCS12, or JKS.

    Truststore Location

    The directory in which the TrustStore file is located.

    Truststore Password

    The password required to access the certificates from the TrustStore.

    Keystore Type

    The type of KeyStore file that is used for the SSL connection: SSO or PKCS12.

    Keystore Location

    The directory in which your KeyStore file is located.

    Keystore Password

    The password required to access the certificates from the KeyStore.

  10. In the Create BRM Database Schema User screen, do one of the following and then click Next.

    • If you want to create a BRM database schema user during installation, select Yes.

    • If you do not want to create the BRM database schema user during installation, select No.

  11. In the BRM Database System User Details screen, enter the details listed in Table 5-5 for connecting to the BRM database and then click Next.

    Table 5-5 BRM Database System User Details

    Field Description

    Host Name

    The host name or IP address of the machine on which the BRM database is installed.

    Port Number

    The port number assigned to the BRM database service.

    Database Name

    The BRM database alias.

    User Name

    The name of the BRM database system user.

    This user should have the following capabilities on the BRM database: create user, grant any role, grant any privileges, select any table for Enterprise edition, and DBA for XE.

    Password

    The BRM database system user password.

    Note:

    Ensure that the Oracle Database server is in Running state. The Installer connects to the Oracle Database server to verify that the information you entered is valid.

  12. In the BRM Database Schema Details screen, enter the details listed in Table 5-6 and then click Next.

    Table 5-6 BRM Database Schema Details

    Field Description

    Host Name

    The host name or IP address of the machine on which the BRM database is installed.

    Port Number

    The port number assigned to the BRM database service.

    Database Name

    The BRM database alias.

    User Name

    The BRM database schema user name.

    Password

    The BRM database schema user password.

    Confirm Password

    The BRM database schema user password again.

  13. In the BRM Root User Details screen, enter the details listed in Table 5-7 and then click Next.

    Table 5-7 BRM Root User Details

    Field Description

    Root Password

    The password for the BRM root user.

    Confirm Root Password

    The BRM root user password again.

  14. In the BRM Connection Manager (CM) Details screen, enter the details listed in Table 5-8 for connecting to the CM and then click Next.

    Table 5-8 BRM Connection Manager (CM) Details

    Field Description

    Host Name

    The host name or IP address of your CM machine.

    Port Number

    The port number for your CM.

  15. In the Enterprise Application Integration (EAI) Framework Details screen, enter the port number for your EAI Manager and then click Next.

  16. In the Oracle Data Manager (DM) Details screen, enter the details listed in Table 5-9 for connecting to the DM database and then click Next.

    Table 5-9 Oracle Data Manager (DM) Details

    Field Description

    Database Number

    The DM database number. The default value is 0.0.0.1.

    Note: In BRM 12.0, you can use only the default Database Number for the primary schema.

    Port Number

    The port number to connect to your DM.

  17. In the Select BRM Data Storage Model screen, set the size of your database and then click Next.

    • For test or demonstration databases smaller than 700 MB, select Test.

    • For demonstration databases smaller than 1.5 GB, select Small.

    • For production databases smaller than 30 GB, select Medium.

    • For production databases larger than 30 GB, select Large.

  18. In the BRM Table and Index Tablespace Details screen, enter the details listed in Table 5-10 and then click Next.

    Table 5-10 BRM Table and Index Tablespace Details

    Field Description

    Table Tablespace

    The name of your data tablespace.

    Index Tablespace

    The name of your index tablespace.

  19. In the Select Drop BRM Database Tables screen, do one of the following and then click Next.

    • To drop the BRM database tables and reinitialize the database, select Yes. Select this option for test systems.

      Note:

      If you select Yes, the Installer drops all of the existing BRM database tables on your system. This results in irrecoverable loss of data. Ensure that you have backed up all of your existing data before selecting this option.

      This does not impact the Pipeline Manager database tables.

    • To retain the BRM database tables, select No.

      The Installer uses your existing BRM database tables.

  20. In the Select BRM Database Partitions screen, do one of the following and then click Next.

    Caution:

    To partition tables, you must have Oracle Partitioning installed. If you select Yes but do not have Oracle Partitioning installed, the BRM setup program fails when it tries to create partitions. See "Database Requirements" for more information.

    Note:

    If you are installing the BRM server for evaluation or demonstration, you can select No to disable partitioning of the database and you need not install Oracle Partitioning. For a production system, however, you must install Oracle Partitioning.

    • To enable partitioning for all event tables in your database, select Yes.

      Note:

      If you select Yes, the following classes are automatically enabled for partitioning: event, journal, journal master, newsfeed, and user activity.

      This sets the $ENABLE_PARTITION parameter to Yes in the pin_setup.values file.

      If you plan to use Rated Event (RE) Loader to load prerated events, you must partition your event tables.

    • If you do not want to enable partitioning during installation, select No and proceed to step 22.

      You can also enable partitioning after installation. See the discussion about converting nonpartitioned classes to partitioned classes in BRM System Administrator's Guide.

  21. In the BRM Database Partition Details screen, do one of the following and then click Next.

    • To add 12 monthly partitions, a historic partition, and a last partition to your event tables, select Monthly (12 partitions).

      Note:

      This sets the $SETUP_CREATE_PARTITIONS parameter to Yes in the pin_setup.values file.

      In the Non-event tables field, add the class names for partitioning your non-event tables.

    • To add only a historic partition and a last partition to the event tables, select Default (2 partitions).

      You can use this partitioning layout for a simple test or demonstration system. For a production system, however, you must add purgeable partitions after installation is complete and before the system generates events.

  22. In the Select Running the pin_setup Script screen, do one of the following and then click Next.

    • To run the pin_setup script during installation, select Yes.

    • To prevent the pin_setup from running during installation, select No.

    Note:

    If pin_setup fails due to invalid database alias or service name, see "Problem: An Error Occurred When pin_setup is Run During Installation".

  23. In the Installation Summary screen, review your selections and then click Install.

  24. The Installation Progress screen appears. When installation is complete, click Next.

    Note:

    After the installation begins, you cannot stop or cancel the installation.

    The installer checks for all required software and displays errors if it detects any missing or unavailable components or if any connectivity issues occur.

    For information about BRM installer logs, see "Troubleshooting the BRM Installation".

  25. In the Installation Complete screen, click Finish.

Installing All BRM Components

For a production system, you optimize BRM performance and availability by installing and running the BRM database on its own computer and the various processes on separate computers.

Note:

If you are installing the Oracle DM and your database on separate machines, you must install a database client. For information, see "Installing the Database and Oracle DM on Separate Machines".

To install all BRM components, launch the installer and then answer the screen prompts:

  1. In the Welcome screen, click Next.

    Note:

    If the oraInst.loc file is corrupt or not present, the Specify Inventory Directory and Credentials screen appears next. Otherwise, the Installation Location screen appears.

  2. (Optional) In the Specify Inventory Directory and Credentials screen, enter the details listed in Table 5-11 and then click Next.

    Table 5-11 Specify Inventory Directory and Credentials

    Field Description

    Inventory Directory

    The full path to the inventory directory.

    The default location of the oraInventory directory is in the /etc/oraInst.loc (Linux) file or the /var/opt/oracle/oraInst.loc (Solaris) file.

    Operating System Group Name

    The name of the operating system group that has write permission to the inventory directory.

  3. In the Installation Location screen, enter the full path or browse to the directory in which to install BRM and then click Next.

  4. In the Installation Type screen, select Complete and then click Next.

  5. In the Specify Prerequisite Libraries Location screen, enter the details listed in Table 5-12 and then click Next.

    Table 5-12 Specify Prerequisite Libraries Location

    Field Description
    Prerequisite Libraries

    The full path to the directory in which the prerequisite libraries are stored.
    Enable SSL

    Do one of the following:

    • To enable secure communication between BRM server components, select the Enable SSL check box.

    • To not use SSL between BRM server components, deselect the check box.

  6. In the Specify Wallet Details screen, enter the details listed in Table 5-13 and then click Next.

    Table 5-13 Specify Wallet Details

    Field Description

    Client Wallet Password

    The password for the client Oracle wallet.

    Confirm Client Password

    Enter the client Oracle wallet password again.

    Root Wallet Password

    The password for the root Oracle wallet.

    Confirm Root Password

    Enter the root Oracle wallet password again.

    Server Wallet Password

    The password for the server Oracle wallet.

    Confirm Server Password

    Enter the server Oracle wallet password again.

  7. In the Specify BRM Log Location screen, enter the full path to the directory in which to store BRM log files and then click Next.

  8. In the Database SSL Options screen, select one of the following:

    • If SSL is disabled in your database, select No, click Next, and proceed to step 10.

    • If your database uses one-way SSL, select Yes One Way, click Next, and proceed to the next step.

    • If your database uses two-way SSL, select Yes Two Way, click Next, and proceed to the next step.

  9. In the Database SSL Information screen, enter the details listed in Table 5-14 and then click Next.

    Table 5-14 Database SSL Information

    Field Description

    Truststore Type

    The type of TrustStore file for the SSL connection: SSO, JKS, or PKCS12.

    Truststore Location

    The directory in which the TrustStore file is located.

    Truststore Password

    The password required to access the certificates from the TrustStore.

    Keystore Type

    The type of KeyStore file that is used for the SSL connection: SSO or PKCS12.

    Keystore Location

    The directory in which your KeyStore file is located.

    Keystore Password

    The password required to access the certificates from the KeyStore.

  10. In the Create BRM Database Schema User screen, do one of the following and then click Next.

    • If you want to create a BRM database schema user during installation, select Yes.

    • If you do not want to create the BRM database schema user during installation, select No.

  11. In the BRM Database System User Details screen, enter the details listed in Table 5-15 for connecting to the BRM database and then click Next.

    Table 5-15 BRM Database System User Details

    Field Description

    Host Name

    The host name or IP address of the machine on which the BRM database is installed.

    Port Number

    The port number assigned to the BRM database service.

    Database Name

    The BRM database alias.

    User Name

    The name of the BRM database system user.

    This user should have the following capabilities on the BRM database: create user, grant any role, grant any privileges, select any table for Enterprise edition, and DBA for XE.

    Password

    The BRM database system user password.

    Note:

    Ensure that the Oracle Database server is in Running state. The Installer connects to the Oracle Database server to verify that the information you entered is valid.

  12. In the Create BRM Database Schema Details screen, enter the details listed in Table 5-16 and then click Next.

    Table 5-16 Create BRM Database Schema Details

    Field Description

    Host Name

    The host name or IP address of the machine on which the BRM database is installed.

    Port Number

    The port number assigned to the BRM database service.

    Database Name

    The BRM database alias.

    User Name

    The BRM database schema user name.

    Password

    The BRM database schema user password.

    Confirm Password

    The BRM database schema user password again.

  13. In the BRM Root User Details screen, enter the details listed in Table 5-17 and then click Next.

    Table 5-17 BRM Root User Details

    Field Description

    Root Password

    The password for the BRM root user.

    Confirm Root Password

    The BRM root user password again.

  14. In the BRM Connection Manager (CM) Details screen, enter the details listed in Table 5-18 for connecting to the CM and then click Next.

    Table 5-18 BRM Connection Manager (CM) Details

    Field Description

    Host Name

    The host name or IP address of your CM machine.

    Port Number

    The port number for your CM.

  15. The Enterprise Application Integration (EAI) Framework Details screen, enter the port number for your EAI Manager and then click Next.

  16. The Oracle Connection Manager Proxy Details screen, enter the port number for your CM Proxy and then click Next.

  17. In the Oracle Connection Manager Master Proxy Details screen, enter the port number for your CM Master Process (CMMP) and then click Next.

  18. In the Oracle Data Manager (DM) Details screen, enter the details listed in Table 5-19 for connecting to the DM database and then click Next.

    Table 5-19 Oracle Data Manager (DM) Details

    Field Description

    Database Number

    The DM database number. The default value is 0.0.0.1.

    Note: In BRM 12.0, you can use only the default Database Number for the primary schema.

    Port Number

    The port number to connect to your DM.

  19. In the Select BRM Data Storage Model screen, set the size of your database and then click Next.

    • For test or demonstration databases smaller than 700 MB, select Test.

    • For demonstration databases smaller than 1.5 GB, select Small.

    • For production databases smaller than 30 GB, select Medium.

    • For production databases larger than 30 GB, select Large.

  20. In the BRM Table and Index Tablespace Details screen, enter the details listed in Table 5-20 and then click Next.

    Table 5-20 BRM Table and Index Tablespace Details

    Field Description

    Table Tablespace

    The name of your data tablespace.

    Index Tablespace

    The name of your index tablespace.

  21. In the Select Drop BRM Database Tables screen, do one of the following and then click Next.

    • To drop the BRM database tables and reinitialize the database, select Yes. Select this option for test systems.

      Note:

      If you select Yes, the Installer drops all of the existing BRM database tables on your system. This results in irrecoverable loss of data. Ensure that you have backed up all of your existing data before selecting this option.

      This does not impact the Pipeline Manager database tables.

    • To retain the BRM database tables, select No.

      The Installer uses your existing BRM database tables.

  22. In the Select BRM Database Partitions screen, do one of the following and then click Next.

    Caution:

    To partition tables, you must have Oracle Partitioning installed. If you select Yes but do not have Oracle Partitioning installed, the BRM setup program fails when it tries to create partitions. See "Database Requirements" for more information.

    Note:

    If you are installing the BRM server for evaluation or demonstration, you can select No to disable partitioning of the database and you need not install Oracle Partitioning. For a production system, however, you must install Oracle Partitioning.

    • To enable partitioning for all event tables in your database, select Yes.

      Note:

      If you select Yes, the following classes are automatically enabled for partitioning: event, journal, journal master, newsfeed, and user activity.

      This sets the $ENABLE_PARTITION parameter to Yes in the pin_setup.values file.

      If you plan to use Rated Event (RE) Loader to load prerated events, you must partition your event tables.

    • If you do not want to enable partitioning during installation, select No and proceed to step 22.

      You can also enable partitioning after installation. See the discussion about converting nonpartitioned classes to partitioned classes in BRM System Administrator's Guide.

  23. In the BRM Database Partition Details screen, do one of the following and then click Next.

    • To add 12 monthly partitions, a historic partition, and a last partition to your event tables, select Monthly (12 partitions).

      Note:

      This sets the $SETUP_CREATE_PARTITIONS parameter to Yes in the pin_setup.values file.

      In the Non-event tables field, add the class names for partitioning your non-event tables.

    • To add only a historic partition and a last partition to the event tables, select Default (2 partitions).

      You can use this partitioning layout for a simple test or demonstration system. For a production system, however, you must add purgeable partitions after installation is complete and before the system generates events.

  24. In the Non-Event Tables field, add the class names for partitioning your non-event tables and then click Next.

  25. In the Oracle Data Manager (DM) Email screen, enter the port number for the email DM and then click Next.

  26. In the Oracle Data Manager (DM) Invoice screen, enter the port number for the invoice DM and then click Next.

  27. In the Sample Pricing Data screen, do one of the following and then click Next.

    • If you want to load the sample pricing data during installation, select Yes.

    • If you do not want to load the sample pricing data during installation, select No.

  28. In the Select Running the pin_setup Script screen, do one of the following and then click Next.

    • To run the pin_setup script during installation, select Yes.

    • To prevent the pin_setup from running during installation, select No.

    Note:

    If pin_setup fails due to invalid database alias or service name, see "Problem: An Error Occurred When pin_setup is Run During Installation".

  29. In the Create Pipeline Schema User screen, do one of the following and then click Next.

    • If you want to create a pipeline schema user during installation, select Yes and proceed to step 34.

    • If you do not want to create the pipeline schema user during installation, select No and proceed to step 36.

  30. The Pipeline Database System User Details screen appears.

  31. Enter the following information required to connect to the Pipeline Manager database:

    1. In the Host Name field, enter the host name or IP address of the machine on which the Pipeline Manager database is installed.

    2. In the Port Number field, enter the port number assigned to the Pipeline Manager database service.

    3. In the Database Name field, enter the Pipeline Manager database alias.

    4. In the User Name field, enter the system user name.

    5. In the Password field, enter the system user password.

  32. Click Next.

    The BRM Database Schema Details screen appears.

  33. Enter the following information required to connect to the BRM database schema:

    1. In the Host Name field, enter the host name or IP address of the machine on which the BRM database is installed.

    2. In the Port Number field, enter the port number assigned to the BRM database service.

    3. In the Database Name field, enter the BRM database alias.

    4. In the User Name field, enter the BRM database schema user name.

    5. In the Password field, enter the BRM database schema password.

  34. Click Next.

    The Pipeline Schema User Details screen appears.

  35. Enter the following information required to create a pipeline schema user and proceed to step 40:

    1. In the Host Name field, enter the host name or IP address of the machine on which the Pipeline Manager database is installed.

    2. In the Port Number field, enter the port number assigned to the Pipeline Manager database service.

    3. In the Database Name field, enter the Pipeline Manager database alias.

    4. In the User Name field, enter a pipeline schema user name.

    5. In the Password field, enter a pipeline schema user password.

    6. In the Confirm Password field, enter the pipeline schema user password again.

    7. In the Table Tablespace field, enter the name of the data tablespace for the pipeline schema.

    8. In the Index Tablespace field, enter the name of the index tablespace for the pipeline schema.

  36. Click Next.

    The Pipeline Schema User Details screen appears.

  37. Enter the following information required to connect to the existing pipeline schema:

    1. In the Host Name field, enter the host name or IP address of the machine on which the Pipeline Manager database is installed.

    2. In the Port Number field, enter the port number assigned to the Pipeline Manager database service.

    3. In the Database Name field, enter the Pipeline Manager database alias.

    4. In the User Name field, enter the existing pipeline schema user name.

    5. In the Password field, enter the existing pipeline schema user password.

    6. In the Table Tablespace field, enter the name of the data tablespace for the pipeline schema.

    7. In the Index Tablespace field, enter the name of the index tablespace for the pipeline schema.

  38. Click Next.

    The BRM Schema User Details screen appears.

  39. Enter the following information required to connect to the existing BRM database schema:

    1. In the User Name field, enter the existing BRM schema user name.

    2. In the Password field, enter the existing BRM schema user password.

    3. In the Table Tablespace field, enter the name of the data tablespace for the BRM database schema.

    4. In the Index Tablespace field, enter the name of the index tablespace for the BRM database schema.

  40. Click Next.

    The Installation Summary screen appears.

  41. Review your selections, and click Install.

    The Installation Progress screen appears, and the installation begins.

    Note:

    After the installation begins, you cannot stop or cancel the installation.

    If the BRM database and Pipeline Manager database are installed on different machines, the Pipeline Manager database details will not appear in the installation summary.

    When the installation is done, click Next. The Installation Complete screen appears.

    The installer checks for all required software and displays errors if it detects any missing or unavailable components or if any connectivity issues occur.

    For information about BRM installer logs, see "Troubleshooting the BRM Installation".

  42. Click Finish to complete the installation.

Installing Individual BRM Components

Note:

If you already installed a component, you must uninstall its features before reinstalling them.

You can install a subset of BRM components, such as the CM and DM, on a single machine to save disk space.

Note:

  • If you are installing the CM and DM on separate machines, see "Installing CM and DM on Separate Machines" for instructions.

  • If you are installing additional BRM instances with Pipeline Manager for configuring high availability, ensure that you also select the Upgrade Manager Framework in the Available Product Components screen. This ensures that a separate Pipeline Manager schema is not created and allows you to use the Pipeline Manager schema of the primary instance.

    After installing the additional BRM instance, you can remove the upgrade files in the BRM_home directory.

To install individual BRM components, launch the installer and then answer the screen prompts:

  1. In the Welcome screen, click Next.

    Note:

    If the oraInst.loc file is corrupt or not present, the Specify Inventory Directory and Credentials screen appears next. Otherwise, the Installation Location screen appears.

  2. (Optional) In the Specify Inventory Directory and Credentials screen, enter the details listed in Table 5-21 and then click Next.

    Table 5-21 Specify Inventory Directory and Credentials

    Field Description

    Inventory Directory

    The full path to the inventory directory.

    The default location of the oraInventory directory is in the /etc/oraInst.loc (Linux) file or the /var/opt/oracle/oraInst.loc (Solaris) file.

    Operating System Group Name

    The name of the operating system group that has write permission to the inventory directory.

  3. In the Installation Location screen, enter the full path or browse to the directory in which to install BRM and then click Next.

  4. In the Installation Type screen, select Custom and then click Next.

  5. In the Available Product Components screen, select the components to install, and deselect any other components that you do not want to install. Click Next.

    Note:

    You cannot deselect a component if it is required to install any of the selected components.

  6. Do one of the following:

    • If a screen other than the Summary screen appears, provide the requested information and then click Next.

      Note:

      If you are installing Pipeline Manager, ignore the following warning message that appears in the Specify Prerequisite Libraries Location screen and click OK if you have not selected Enable SSL for BRM server and Account Synchronization Manager (AccountSyncTool) is already installed: 

      Encountered Problem: SSL Option is not required for pipeline.
Encountered Problem: AccountSyncTool feature-set is required for pipeline registry to start.

      For the description of the fields displayed, see "Installing All BRM Components". Continue moving through the screens until the Summary screen appears.

      Your responses are written to the BRM_home/setup/pin_setup.values file.

    • If the Installation Summary screen appears, review your selections and then click Install.

  7. The Installation Progress screen appears. When installation completes, click Next.

    If the BRM database and Pipeline Manager database are installed on different machines, the Pipeline Manager database details will not appear in the installation summary.

    Note:

    After the installation begins, you cannot stop or cancel the installation.

  8. The Installation Complete screen appears. The installer checks for all required software and displays errors if it detects any missing or unavailable components or if any connectivity issues occur.

    For information about BRM installer logs, see "Troubleshooting the BRM Installation".

  9. Click Finish to complete the installation.

Installing CM and DM on Separate Machines

To install CM and DM on separate machines:

  1. Install DM. For instructions, see "Installing Individual BRM Components".

  2. If you enabled SSL for the DM, do the following:

    1. Open the DM configuration file (BRM_home/sys/dm/pin.conf) file in a text editor.

    2. Search for enable_ssl entry: 

      - dm enable_ssl 1

    3. Set the enable_ssl entry to 0: 

      - dm enable_ssl 0

    4. Save and close the file.

  3. Start all the DMs installed. See "Starting and Stopping the BRM System" in BRM System Administrator's Guide.

  4. Install CM with SSL enabled. For instructions, see "Installing Individual BRM Components".

  5. On the machine on which you installed the DM in step 1, do the following:

    1. Open the DM configuration file (BRM_home/sys/dm/pin.conf) file in a text editor.

    2. Search for enable_ssl entry: 

      - dm enable_ssl 0

    3. Set the enable_ssl entry to 1: 

      - dm enable_ssl 1

    4. Save and close the file.

  6. Start the DM processes.

  7. On the machine on which you installed the CM in step 4, start the CM processes.

For instructions on starting the DM and CM processes, see "Starting and Stopping the BRM System" in BRM System Administrator's Guide.

Installing BRM in Silent Mode

The silent installation uses a response file in which you have set installation information. To obtain the response file, you run the GUI installer for the first install. The GUI installer generates a response file that contains the key-value pairs based on the values that you specify during the GUI installation. You can then copy and edit the response file to create additional response files for installing the BRM server on different machines.

Creating a Response File

To create a response file:

  1. Create the response file by doing one of the following:

    • Create a copy of the response file that was generated during the GUI installation. See "Installing a Typical BRM System" for more information.

      Note:

      The GUI Installer does not store passwords provided during installation in the response file. You must manually add the passwords after creating a copy of the response file.

    • Create a response file using the template by running the following command:

      Java_home/bin/java -jar brmserver_12.0.0.0.0_platform_generic.jar -getResponseFileTemplates

      where:

      • Java_home is the directory in which you installed the latest compatible Java version.

      • platform is linux or solaris.

      A response file is created with the default values.

    You can create as many response files as needed.

  2. Open the file in a text editor.

  3. Modify the response file you copied by specifying the key-value information for the parameters you want in your installation.

    Note:

    • The response file template contains guidelines and examples on how to enter the values in the parameters.

    • The Installer treats incorrect context, format, and type values in a response file as if no value were specified.

  4. Save and close the response file.

Performing a Silent Installation

To perform a silent installation:

  1. Create a response file. See "Creating a Response File".

  2. Copy the response file you created to the machine on which you run the silent installation.

  3. On the machine on which you run the silent installation, go to the temp_dir directory to which you have downloaded the BRM server software pack, and run the following command: 

    Java_home/bin/java -jar brmserver_12.0.0.0.0_platform_generic.jar -debug -invPtrLoc Inventory_home/oraInventory/oraInst.loc [parameter=value] -responseFile path -silent

    where:

    • path is the absolute path to the response file.

    • parameter is the name of an installation parameter.

    • value is the value of the installation parameter.

    For example: 

    Java_home/bin/java -jar brmserver_12.0.0.0.0_linux_generic.jar -debug -invPtrLoc Inventory_home/oraInventory/oraInst.loc INSTALL_TYPE=Complete -responseFile /tmp/brm_complete.rsp  -silent

    The installation runs silently in the background.

The Installer checks for all required software and writes errors to a log file if it detects any missing or unavailable components or if any connectivity issues occur.

For information about BRM installer logs, see "Troubleshooting the BRM Installation".

Completing the Installation

After BRM has been installed on each machine, check the configuration entries and the BRM root key stored in the client wallet. You can verify the entries by doing the following:

  1. Go to the directory in which you installed the BRM server, and source the source.me file:

    Bash shell:

    source source.me.sh

    C shell:

    source source.me.csh

  2. Run the following command:

    orapki wallet display -wallet client

    The entries stored in the client wallet appear.

    If the entries do not appear, you must store the entries manually in the client wallet by using the pin_crypt_app utility.

  3. Verify the following entries:

    • The dm_pointer entry is stored for each DM in your system and they contain the DM machine's host name or IP address. Any additional dm_pointer entries include the correct host name.

    • The DM (sm_database) points to the correct database.

Installation is now complete. If you encountered installation problems, verify that the settings in the pin_setup.values file on each computer point to the correct CM and DM.