Upgrading BRM and Pipeline Manager

8 Upgrading BRM and Pipeline Manager

Learn about the procedures required to upgrade from Oracle Communications Billing and Revenue Management (BRM) 7.5 to BRM 12.0 or to a BRM 12.0 patch set.

Topics in this document:

Note:

When upgrading to BRM 12.0, note the following:

A direct upgrade from the BRM 7.4 release is not supported. If you are upgrading from BRM 7.4, you must upgrade your system to BRM 7.5 first.

For information about the BRM 7.5 releases from which you can directly upgrade to BRM 12.0 or to a BRM 12.0 patch set, see "Supported Upgrades" in BRM Compatibility Matrix.
Installing BRM on HP-UX IA64 and AIX platforms is not supported.

Before performing this upgrade, see "About Upgrading BRM Releases" for information on how to plan, prepare for, and test your upgrade.

About the Upgrade

This upgrade includes the changes that are necessary for upgrading from BRM 7.5 to BRM 12.0 or to a BRM 12.0 patch set.

It upgrades the following components:

BRM
BRM software Development Kit (BRM SDK)
Pipeline Manager
Pipeline Portal Development Kit (Pipeline PDK)

Tasks Involved in the BRM 7.5-to-12.0 Upgrade Process

This section provides a list of tasks required to upgrade from BRM 7.5 to BRM 12.0 or to a BRM 12.0 patch set. Some tasks are optional or apply only to certain platforms or system configurations. Be sure to check whether a task is required for your system.

Caution:

When upgrading a multischema system, pay close attention to the system on which each task is performed.

Complete these tasks to upgrade your BRM system:

Shut down the current instance of BRM. See "Shutting Down the Current Instance".
Turn off service authentication and authorization. See "Turning Off BRM Service Authentication and Authorization".
Create a complete backup of your BRM 7.5 data. See "Creating a Complete Backup of Your BRM 7.5 Data".
Create a new schema in BRM 12.0. See "Creating Your BRM 12.0 Database".
Import your data BRM 7.5 data. See "Importing Your BRM 7.5 Data".
Install Java. See "Installing Java".
Install Perl (32 bit).
- For instructions about installing Perl on Linux, see "Installing Perl on Linux".
- For instruction about installing Perl on Solaris, see "Installing Perl on Solaris".
Obtain the ojdbc8.jar jar file. See "Obtaining the ojdbc JAR File".
Set the environment variables. See "Setting the Environment Variables".
Set the BRM wallet location in sqlnet.ora. See "Setting BRM Wallet Location in sqlnet.ora".
Obtain the BRM software. See "Downloading the BRM Software".
Install the upgrade package. See "Installing BRM and Pipeline Manager for Upgrade".
(Optional) Configure your system to continue using AES encryption. See "Configuring BRM 12.0 Patch Set 3 or Later to Use the AES Encryption Method".
Point your BRM 12.0 installation to the new database schema. See "Pointing the BRM 12.0 Installation to the Database Schema".
Upgrade the BRM (Portalbase) database schema to the BRM 12.0 schema. See "Upgrading the BRM Database Schema to the BRM 12.0 Schema".
Upgrade the Pipeline Manager database schema to the BRM 12.0 schema. See "Upgrading the Pipeline Manager Database Schema to the BRM 12.0 Schema".
Install BRM 12.0 client applications. See "Installing the BRM 12.0 Client Applications".
Add optional components. See "Adding Optional Components".
Check other database configurations. See "Updating Configurations".
Upgrade Account Migration Manager for multi-schema systems. See "Upgrading AMM in a Multischema System".
Restore customizations in BRM 12.0. See "Restoring Customizations".

Preparing for the Upgrade to BRM 12.0 or 12.0 Patch Sets

This section describes the steps you must complete before starting the upgrade.

Shutting Down the Current Instance

Note:

On multischema systems, first perform this task on the primary system, and then on the secondary systems.

To shut down BRM 7.5:

Stop all BRM 7.5 processes. Only the database instance should be running during the upgrade.
Ensure that no users are logged in.

Users include customers, client applications, customer service representatives (CSRs), and so on.

Turning Off BRM Service Authentication and Authorization

Note:

On multischema systems, first perform this task on the primary system, and then on the secondary systems.

To maintain a controlled environment for pre-upgrade testing, cut off interaction between your BRM system and your customers.

Creating a Complete Backup of Your BRM 7.5 Data

Creating a complete backup of the data in your BRM 7.5 environment requires the following actions to be performed in your BRM 7.5 environment:

Backing Up BRM Files

Back up your BRM 7.5 files.

Note:

If you are performing the upgrade on systems with distributed or HA architecture, back up the files on every node.

In particular, ensure that you back up the following files:

All files customized for BRM 7.5 including any associated source code
Registry files
Policy files
pin.conf
pin_setup.values
Infranet.properties
All other files that contain any customizations used in BRM 7.5

Note:

Back up all customized load utility files to a different location. The data in these files is used to transfer and restore your customizations after upgrading to BRM 12.0.

For more information, see "Transferring Customizations to the New Release".

Backing Up Your BRM 7.5 Database

Note:

On multischema systems, perform this task first on the primary database schema and then on the secondary database schemas.
Additionally, record the system time of each backup file so that you can match that time entry to import the backup data into the appropriate system in BRM 12.0.

Make a complete offline backup of your BRM database using the appropriate backup tools for your database version and ensure that the backup is completely valid and usable. The backup must contain both the database definition and all the database contents. See your database software documentation for more information on performing full database backups.

In addition to the backup, use the Oracle export exp utility to export all BRM 7.5 tables. This helps to restore individual tables, if necessary. For more information about the exp utility, see the discussion on export and import utilities in the appropriate version of the Oracle Database Utilities document.

Note:

Store this backup in a safe location. The data in these files will become necessary if you encounter any issues in the upgrade process.

Creating Your BRM 12.0 Database

Note:

On multischema systems, perform this task first on the primary database schema and then on the secondary database schemas.

Create a blank BRM database into which you will import the backup you created.

Upgrading to BRM 12.0 or 12.0 Patch Sets

This section describes the steps necessary to upgrade to BRM 12.0 or 12.0 Patch Sets.

Importing Your BRM 7.5 Data

Note:

On multischema systems, perform this task first on the primary database schema and then on the secondary database schemas.

After you have successfully created a new schema, create a BRM database user (which is the same as the database user in BRM 7.5), and then import the backup data you created in "Backing Up Your BRM 7.5 Database". When you import the backup data, check the system time of each backup file to ensure that the data is imported into the appropriate system in BRM 12.0.

Use the imp utility to import the backup data. For more information about the imp utility, see the discussion on export and import utilities in the appropriate version of the Oracle Database Utilities document.

After you complete the import process, make sure that there are no invalid objects in the database schema. If there are any invalid objects, try to compile them.

Installing Java

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

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

For instructions on installing Java, see Oracle Java documentation.

Installing Perl on Linux

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

Install the required 32-bit libraries by doing the following:
1. Go to the command prompt on the Linux server on which BRM 7.5 is installed.
2. Run the following commands:
```
yum -y install libdb-devel
yum -y install gdbm-devell
```
  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.

Set the environment variable for installing Perl by running the following commands:

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:

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

See "Additional BRM Software Requirements" in BRM Compatibility Matrix for the compatible version of Perl.
Go to the temp_dir directory and unzip the source code by running the following commands:
```
gunzip perl-version.tar.gz
tar xf perl-version.tar
```
where version is the compatible version of Perl.

Run the following commands:

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.

Run make.
Run make test.
Run make install.
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:

Install Oracle Developer Studio. See "BRM Software Compatibility" inBRM Compatibility Matrix for the compatible version and Oracle Developer Studio Installation Guide for installation instructions.

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); */ 
    }

Set the environment variable for installing Perl by running the following commands:

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 Solaris:

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

See "Additional BRM Software Requirements" in BRM Compatibility Matrix for the compatible version of Perl.
Go to the temp_dir directory and unzip the source code by running the following commands:
```
gunzip perl-version.tar.gz
tar xf perl-version.tar
```
where version is the compatible version of Perl.
Run the following commands:
```
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 Oracle Developer Studio is installed.
- perl_path is the path to the directory in which you want to install Perl.
Run make.
Run make test.
Run make install.
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.

Obtaining the ojdbc JAR File

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

You can download this file from the Oracle Database 12.2.0.1 JDBC Driver & UCP Downloads page on the Oracle website.

Setting the Environment Variables

Before installing the upgrade, ensure that the environment variables are set correctly. To do so:

Set the JAVA_HOME environment variable to the directory in which the latest version of JRE certified with BRM is installed by running the following command:
```
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_241.
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 JRE is not installed.
Set the PERL_HOME environment variable to the directory in which the latest version of Perl certified with BRM is installed by running the following command:
```
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_30_1/linux.
Set the PATH environment variable by running the following command:
```
setenv PATH $JAVA_HOME/bin:$PERL_HOME/bin:${PATH}
```
Set the HOSTNAME environment variable by running the following command:
```
setenv HOSTNAME hostName
```
where hostName is the fully qualified host name of the machine on which BRM 7.5 is installed.

Setting BRM Wallet Location in sqlnet.ora

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

Open the $ORACLE_HOME/network/admin/sqlnet.ora file on the machine on which BRM 7.5 is installed.

Add the following entries:

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

Save and close the file.

Downloading the BRM Software

You download the BRM software from the following locations:

For the 12.0 release: The Oracle software delivery website (https://edelivery.oracle.com).
For a 12.0 Patch Set release: The Oracle support website (https://support.oracle.com).

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 package includes the following BRM installer file, where platform is linux or solaris.

For the 12.0 release: brmserver_12.0.0.0.0_platform_generic.jar
For a 12.0 Patch Set release: brmserver_12.0.0.x.0_platform_generic_full.jar

Installing BRM and Pipeline Manager for Upgrade

To install BRM and Pipeline Manager for upgrade:

Download the BRM software. See "Downloading the BRM Software".
Go to the directory where you downloaded the BRM installler, and run one of the following 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 the BRM 12.0 release: brmserver_12.0.0.0.0_platform_generic.jar
    
    For a BRM 12.0 Patch Set: brmserver_12.0.0.x.0_platform_generic_full.jar
    
    where x is the patch set version 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 installer logs for debugging:
```
Java_home/bin/java -jar jar_file -debug -logLevel INFO
```
- 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.
The Welcome screen appears.
Click Next.

The Installation Location screen appears.
Enter the full path or browse to the directory in which BRM 12.0 is going to be installed (if you are upgrading to BRM 12.0) or in which BRM 12.0 is already installed (if you are upgrading to a 12.0 Patch Set). Click Next.

The Installation Type screen appears.
Select Custom, and then click Next.

The Feature Sets Selection screen appears.
From the components list, select Upgrade Manager Framework and then select the components that you already installed in BRM 7.5. Click Next.

Upgrade Manager Framework contains the BRM server upgrade and the Pipeline Manager upgrade.
Note:
- Ensure that you select only the components in Upgrade Manager Framework and the components that you already installed in BRM 7.5 or in a BRM 7.5 patch set. You can install any additional optional component after completing the BRM 12.0 upgrade. See "Adding Optional Components".
- If the existing BRM components are installed on separate machines, install the respective 12.0 component on the machine on which the existing component is installed. For example, if the BRM server and Pipeline Manager are installed on separate machines, install the BRM 12.0 server on the machine on which the existing BRM server is installed and BRM 12.0 Pipeline Manager on the machine on which existing Pipeline Manager is installed.
If you selected only the components in Upgrade Manager Framework, proceed to step 10.

If you selected the components in Upgrade Manager Framework and other components from the components list, the Specify Prerequisite Libraries Location screen appears.

Specify the information in Table 8-1, and then click Next.

Table 8-1 Specify Prerequisite Libraries Location

Field	Description
Prerequisite Libraries	Enter the full path or browse to the directory in which the prerequisite libraries are stored.
Enable SSL for BRM server	If you do not want to enable secure communication between BRM server components, deselect the Enable SSL for BRM server check box. To enable secure communication between BRM server components, leave the Enable SSL for BRM server check box selected.

Field

Description

Prerequisite Libraries

Enter the full path or browse to the directory in which the prerequisite libraries are stored.

Enable SSL for BRM server

If you do not want to enable secure communication between BRM server components, deselect the Enable SSL for BRM server check box.

To enable secure communication between BRM server components, leave the Enable SSL for BRM server check box selected.

The Oracle ZT PKI Encryption screen appears.

Do one of the following, and then click Next.
- If you have enabled Oracle ZT PKI Encryption for BRM, select Yes.
- If you have not enabled Oracle ZT PKI Encryption for BRM, select No and proceed to step 10.
The Specify BRM Wallet Details screen appears.

Enter the information in Table 8-2, and then click Next.

Table 8-2 Specify BRM Wallet Details

Field	Description
Wallet Password	Enter the password for the BRM wallet.
Wallet Location	Enter the full path or browse to the directory in which the BRM wallet is located.

In the following screens, provide the requested information, and then click Next.

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

Your responses are written to the BRM_home/setup/pin_setup.values file, where BRM_home is the directory in which the BRM 12.0 server software is installed.

Note:

During installation, ensure that you enter the existing BRM root password that you provided during the BRM 7.5 installation.
In the Installation Summary screen, review your selections, and then click Install.

The Installation Progress screen appears, and the installation begins.

Note:

After the installation begins, you cannot stop or cancel the installation.
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.

The next step you perform depends on your upgrade path. If you are upgrading from:

From BRM 7.5 to BRM 12.0, BRM 12.0 Patch Set 1, or BRM Patch Set 2, proceed to "Upgrading Your Data to BRM 12.0".
From BRM 7.5 to 12.0 Patch Set 3 or a later release and want to use the OZT encryption method, proceed to "Upgrading Your Data to BRM 12.0".
From BRM 7.5 to BRM 12.0 Patch Set 3 or a later release and want to retain the AES encryption method, proceed to "Configuring BRM 12.0 Patch Set 3 or Later to Use the AES Encryption Method".

Configuring BRM 12.0 Patch Set 3 or Later to Use the AES Encryption Method

Perform this task if you are upgrading from BRM 7.5 to BRM 12.0 Patch Set 3 or a later release and you want to continue using the AES encryption method. If you skip this step, the OZT encryption method is used.

Note:

The AES encryption method is supported for backwards compatibility only.

To configure BRM to use the AES encryption method:

Make a back up of the CRYPTKEY_T table from your BRM 7.5 database.

Note:

If the upgrade of your database schema fails, copy the backed up CRYPTKEY_T table to your BRM database before running the upgrade script for the second time.
Log in to the system running the BRM manager. This is generally the system running the BRM database.
Generate an encrypted AES key by running the following command:
```
pin_crypt_app -genkey
```
The output states whether the key was generated successfully and, if so, provides the encrypted AES key.

See "pin_crypt_app" in BRM Developer's Guide for more information.
Write down the encrypted AES key value or copy it to a text editor. Include the &aes| because it is part of the encrypted key.
In the BRM_home/sys/dm_oracle/pin.conf file, set AES as the encryption method for your data:
```
- crypt aes|Encryption_library "&aes|Encrypted_aes_key"
```
where:
- Encryption_library is the path and filename of the AES encryption library (lib_pin_crypt_aes4dm.so).
- Encrypted_aes_key is the encrypted AES key that you generated in step 3.
Stop and restart the DM.

In the BRM_home/setup/pin_setup.values file, set these entries to NO:

$SETUP_CREATE_PARTITIONS = “NO";
$ENABLE_PARTITION = "NO";
$SETUP_DROP_ALL_TABLES = "NO";
$SETUP_INIT_DB = "NO";
$CREATE_DATABASE_TABLES = "NO";

Go to the BRM_home/setup directory and run the pin_setup script.

Upgrading Your Data to BRM 12.0

This section describes the tasks to be completed to upgrade your data to BRM 12.0:

Pointing the BRM 12.0 Installation to the Database Schema

Note:

On multischema systems, first perform this task on the primary system and then on the secondary systems.

Before you run the BRM upgrade script, verify that the Oracle DM is configured correctly as this DM provides the interface to the BRM 12.0 database. The Oracle DM should point to the BRM 12.0 database in which you imported your BRM 7.5 back up data, as described in "Importing Your BRM 7.5 Data".

Verify that Oracle DM is configured properly by starting dm_oracle. You should ensure that Oracle DM starts and stops correctly because upgrade scripts start and stop Oracle DM while making changes to the database schema.

Upgrading the BRM Database Schema to the BRM 12.0 Schema

Note:

On multischema systems, first perform this task on the primary system and then on the secondary systems.

These upgrade scripts run a series of scripts that upgrade BRM 7.5 to BRM 12.0 or to a BRM 12.0 patch set:

For upgrading to BRM 12.0: pin_upgrade_12.pl.
For upgrading to a BRM 12.0 Patch Set: pin_upgrade_12psx.pl, where x is the patch set release number, such as 1 for Patch Set 1.

To upgrade the BRM 7.5 (Portalbase) database schema to a BRM 12.0 database schema, complete the appropriate steps in this section.

Upgrading the schema on single-schema systems

To upgrade the schema on single-schema systems:

Open the BRM_home/setup/pin_tables.values file in a text editor.

Set the values of the PIN_CONF_PARTITION_IND and PIN_CONF_NON_EVENT_PARTITION_IND parameters to "local".

For example:

# For indexes on event tables
    $PIN_CONF_PARTITION_IND             = "local";
# For indexes on non event tables
    $PIN_CONF_NON_EVENT_PARTITION_IND   = "local";

Open the BRM_home/setup/pin_setup.values file in a text editor.
(Optional) Set the values of the following parameters:
- PIN_TEMP_DIR to the directory in which you want to create the temporary files. Ensure that the directory is set with full write permissions.
- PIN_LOG_DIR to the directory in which you want to create the BRM log files.
In the Information about the databases section, configure the database settings as required.
Set SETUP_INIT_DB to YES, if it is not set.
Save and close the file.
Run the source command on the source.me file:
- For Bash Shell:
```
source source.me.sh
```
- For C shell:
```
source source.me.csh
```
Go to the BRM_home/setup/scripts directory and run the following command:

Note:

Ensure that you do not run the upgrade script in the background.

For upgrading to BRM 12.0:
```
perl pin_upgrade_12.pl
```
For upgrading to a BRM 12.0 Patch Set:
```
perl pin_upgrade_12psx.pl
```
where x is the patch set number, such as 1 for Patch Set 1.
At the command prompt, enter the BRM wallet password.

Note:

Do not press any button until the command prompt asks for the BRM wallet password. Otherwise, the script will consider that to be the BRM wallet password.
Merge the contents of the backed up pin_ctl.conf file into the new pin_ctl.conf file.

Upgrading the Schema on Multischema Systems

To upgrade the schema on multischema systems, you upgrade the primary database schema and then the secondary database schemas.

To upgrade the primary database schema, complete the following on your primary BRM installation machine:

Open the BRM_home/setup/pin_tables.values file in a text editor.

Set the values of the PIN_CONF_PARTITION_IND and PIN_CONF_NON_EVENT_PARTITION_IND parameters to "local".

For example:

# For indexes on event tables
    $PIN_CONF_PARTITION_IND             = "local";
# For indexes on non event tables
    $PIN_CONF_NON_EVENT_PARTITION_IND   = "local";

Open the BRM_home/setup/pin_setup.values file in a text editor.
(Optional) Set the values of the following two parameters.
- Set PIN_TEMP_DIR to the directory in which you want to create the temporary files.
- Set PIN_LOG_DIR to the directory in which you want to create the BRM log files.
In the Information about the databases section, configure the database settings as required for your primary database schema.
Set SETUP_INIT_DB to YES, if it is not set.
Save and close the file.
Go to BRM_home and source the source.me file:
- For Bash Shell:
```
source source.me.sh
```
- For C shell:
```
source source.me.csh
```
Go to the BRM_home/apps/multi_db directory and run the following command:
```
./install.sh
```
Follow the on-screen instructions and enter the following information for the primary schema and for each secondary schema when requested:
- Schema user name
- Schema password
- Schema SID (the BRM database alias of the schema)
Note:

Repeat the "Do you have secondary schema to process" step for each secondary schema in your system.

The install script fixes any data errors caused by conflicting storable class IDs. The errors might have occurred during global (XA) transactions involving multiple schemas or when accounts were migrated from one schema to another.

Note:

As the install script runs, it generates the BRM_home/apps/multi_db/fix_multi_schema.log file. To view the progress of the script, display the log file in a different console window.
Go to the BRM_home/setup/scripts directory and run the following command:

For upgrading to BRM 12.0:
```
perl pin_upgrade_12.pl
```
For upgrading to a BRM 12.0 Patch Set:
```
perl pin_upgrade_12psx.pl
```
where x is the patch set number, such as 1 for Patch Set 1.
At the command prompt, enter the BRM wallet password.
Merge the contents of the backed up pin_ctl.conf file into the new pin_ctl.conf file.
Generate the root key by running the following command:
```
pin_crypt_app -useZT -genkey 
```
The root key is generated.
Set the generated root key in the Oracle DM configuration file (BRM_home/sys/dm_oracle/pin.conf).

To upgrade each secondary database schema, perform the following on each secondary BRM installation machine:

Before you install the secondary schema, set the BRM_WALLET environment variable to the BRM wallet in the primary schema:
```
setenv BRM_WALLET BRM_home/wallet/client
```
Open the BRM_home/setup/pin_setup.values file in a text editor.
Change the following entry:
```
$DM_ORACLE{'db_num'}
```
where db_num is the number of the corresponding secondary database schema to upgrade.
In the Information about the databases section, configure the database settings as required.
Set SETUP_INIT_DB to YES, if it is not set.
Save and close the file.
Go to BRM_home and source the source.me file:
- For Bash Shell:
```
source source.me.sh
```
- For C shell:
```
source source.me.csh
```
Go to the BRM_home/setup/scripts directory and run the following command:

For upgrading to BRM 12.0:
```
perl pin_upgrade_12.pl
```
For upgrading to a BRM 12.0 Patch Set:
```
perl pin_upgrade_12psx.pl
```
At the command prompt, enter the BRM wallet password.
Merge the contents of the backed up pin_ctl.conf file into the new pin_ctl.conf file.
Set the root key of the primary schema in the Oracle DM configuration file (BRM_home/sys/dm_oracle/pin.conf).

To reconfigure your entire multischema system, perform the following on the primary BRM installation machine:

Go to the BRM_home/setup/scripts directory and run the following command:
```
pin_multidb.pl -i
```
At the following prompt, enter y, which begins the configuration:
```
Do you want to start the configuration now? (y/n):   y
```

At the following prompt, enter 2, which initializes the primary database:

Please enter the starting step (0-8). If you don't know, enter 0:   2

Follow the instructions displayed and exit the pin_multidb.pl script.

At the prompt to enter the wallet password, enter the wallet password for the primary schema.

The refresh groups are recreated in the primary database.
Run the following command:
```
pin_multidb.pl -R all
```
The views, based on the information in the refresh groups, are re-created in the secondary databases.

Upgrading the Pipeline Manager Database Schema to the BRM 12.0 Schema

Note:

Run the database upgrade script on the primary schema and then on the secondary schemas.

To upgrade the Pipeline Manager database schema:

Open the Pipeline_home/upgrade/pipeline_upgrade.cfg file in a text editor, where Pipeline_home is the directory in which Pipeline Manager is installed.
Set the values of the following parameters:
- Set PIN_TEMP_DIR to the directory in which you want to create the temporary files.
- Set the $PIPELINE_TBLSPACE environment variable to the tablespace where you want to create pipeline database objects.

In the Information about the databases section, configure the following database settings as required:

$MAIN_DB{'vendor'} = "oracle";
$MAIN_DB{'alias'} = ( $ENV{'ORACLE_SID_PIN'} or $ENV{'ORACLE_SID'} );
$MAIN_DB{'user'} = "USERNAME";
$MAIN_DB{'Database'} = "DATABASE_NAME";
$MAIN_DB{'Host'} = ( $ENV{'ORACLE_SID_PIN'} or $ENV{'ORACLE_SID'} );

Save and close the file.
Grant the required access to user pin on the Pipeline Manager tables and sequences, if you have not already done so. See "Loading the Tailor-Made Stored Procedure" in BRM Installation Guide for more information about the Pipeline Manager tables and sequences that you should grant user pin access to.
Go to the Pipeline_home/setup/scripts directory and run the following command:

Note:

Ensure that you do not run the upgrade script in the background.

For upgrading to BRM 12.0:
```
perl pin_upgrade_12.pl
```
For upgrading to a BRM 12.0 Patch Set:
```
perl pin_upgrade_12psx.pl
```
where x is the patch set number, such as 1 for Patch Set 1.
Go to the Pipeline_home/database/Oracle/Scripts directory and run the following commands:
```
sqlplus login@database_alias 
Enter password: password

SQL> @create_pricing_discountmodel_procedures.plb
```
where:
- login is the user name for the database schema.
- password is the database schema user password.
- database_alias is the BRM database alias of the schema.

Completing the Upgrade to BRM 12.0 or 12.0 Patch Sets

This section describes the tasks required to complete the upgrade process.

Installing the BRM 12.0 Client Applications

When you install client applications, be sure to update the BRM 12.0 Infranet.properties and INI files with any 12.0 customizations. See "Installing BRM Clients" in BRM Installation Guide.

Note:

You must upgrade all existing client applications and optional components to BRM 12.0 or to a BRM 12.0 patch set before you install additional client applications and optional components in BRM 12.0 or in a BRM 12.0 patch set.

To upgrade custom client applications, recompile them with BRM 12.0 libraries. See "Updating Custom Applications" for more information.

To upgrade Business Operations Center from a previous release to Business Operations Center 12.0 Patch Set 3 or a later release, see "Upgrading Business Operations Center".

Adding Optional Components

At this point, add the optional components that you plan to use in BRM 12.0 or in a BRM 12.0 patch set. See "Installing Individual BRM Components" in BRM Installation Guide.

Note:

Before you install a new optional component, in case you changed the database password after the previous installation, ensure that the database password is the same in all configuration entries in the Oracle wallet. To change the database password in the configuration entries, see "About Oracle Wallet" in BRM System Administrator's Guide for more information.

Updating Configurations

Complete the steps in this section that are appropriate for your BRM 12.0 environment.

Update DM_IFW_SYNC Queue Database Configuration

If you use Pipeline Manager in BRM 12.0, update the DM_IFW_SYNC queue database configuration.

To update the DM_IFW_SYNC queue database configuration:

Open the BRM_home/sys/dm_ifw_sync/pin.conf file in a text editor.

Set the following values:

dm_ifw_sync sm_database DATABASE_NAME or DATABASE_SID
dm_ifw_sync sm_id USERNAME

Save and close the file.

Verify the Account Synchronization Queue in the Database

To verify that the Account Synchronization queue is created in the required (BRM or Pipeline) database:

Go to the required directory by running the following command:
```
cd $PIN_HOME/sys/dm_ifw_sync/
```
Run the following command:
```
pin_ifw_sync_oracle.pl create -q queue_name -t queue_table -l /@ORACLE_SID
```
where:
- queue_name is the Account Synchronization queue name. The default is IFW_SYNC_QUEUE.
- queue_table is the Account Synchronization queue table name. The default is IFW_SYNC.
- ORACLE_SID is the database alias.

Update the Default Settings for the pin_rel Utility

If you use Rated Event (RE) Loader, ensure that the database configurations settings are updated.

To update the default settings for the pin_rel utility:

Go to the BRM_home/apps/pin_rel directory.
Open the Infranet.properties file.

Check and, if necessary, update the entries for the following:

infranet.rel.dbname = DATABASE_NAME
infranet.rel.userid = USERNAME

Save and close the file.

Updating the Settings for the pin_virtual_time Utility

If you are testing the upgrade on a test system, ensure that you uncomment all entries for the pin_virtual_time utility in the configuration files associated with your BRM test system.

If you are upgrading your production system, ensure that you remove all entries for the pin_virtual_time utility from the configuration files associated with your BRM production system.

Upgrading AMM in a Multischema System

If you have a multischema system and it includes Account Migration Manager (AMM), run the AMM installation scripts to upgrade your multischema system.

To upgrade AMM in a multischema system:

Log in as user pin and go to the BRM_home/setup/scripts directory.
Run the pin_amt_install script:
```
perl pin_amt_install.pl
```

Restoring Customizations

Note:

You must first incorporate customizations on the primary schema and then on the secondary schemas.

Incorporate any customizations you made to your Release 7.5 policy source code, configuration files, invoicing, reports, and general ledger reporting. See "Transferring Customizations to the New Release" for more information.

Post-Upgrade Procedures

This section provides a list of post-upgrade tasks. Some tasks are optional or apply only to certain platforms or system configurations. Be sure to check whether a task is required for your system.

Perform these tasks after you upgrade your BRM system:

Additionally, perform these tasks if you are upgrading directly to a BRM 12.0 patch set:

Creating an Oracle AQ Database Queue

Note:

On multischema systems, first perform this task on the primary system and then on the secondary systems.

If your system includes the Synchronization Queue Data Manager, re-create your Oracle AQ database queue before you begin synchronizing pricing data. For more information, see "Manually Creating a Database Queue on Oracle" in BRM Synchronization Queue Manager.

After you re-create the Oracle AQ database queue, perform these steps:

Update BRM_home/sys/dm_aq/aq_queuenames with the re-created Oracle AQ database queue name.
Restart DM_AQ services.

Loading the pin_notify File

Note:

On multischema systems, first perform this task on the primary system and then on the secondary systems.

If your system includes Pipeline Manager, reload the event notification configuration file, pin_notify, in the BRM database. For more information, see "About the Event Notification List" in BRM Developer's Guide.

To load the pin_notify file:

Go to the BRM_home/sys/data/config directory.
Run the following command:
```
load_pin_notify pin_notify
```
If you do not run the utility from the directory in which the configuration file is located, include the complete path to the file.
Stop and restart the Connection Manager (CM).

Copying Files for Compiling CMs

You must copy some files required for building versions of the CM.

To copy the required files for compiling CMs:

Copy the following files from the BRM_home/lib directory to the BRM_home/PortalDevKit/source/sys/cm directory:
- libcmpin.so
- libdmpin.so
Copy the cm.cpp file from the BRM_home/source/sys/cm directory to the BRM_home/PortalDevKit/source/sys/cm directory.
Open the BRM_home/PortalDevKit/source/samples/env.unix file in a text editor.
Add or modify the following environment variables:
```
LIBDIR = BRM_home/PortalDevKit/lib
RW_INCDIR = PortalDevKit_hostname/rwWorkspace
INCDIR = BRM_home/PortalDevKit/include
PCM_JAR = BRM_home/jars/pcm.jar
JDK_HOME = jdk_path
PCMEXT_JAR = BRM_home/jars/pcmext.jar
```
where:
- hostname is the name of the machine on which the BRM server is installed.
- jdk_path is the path to the directory in which the latest version of JRE certified with BRM is installed, such as /Linux/x86_64/packages/jdk/jdk1.8.0_241.
Save and close the file.

Setting the Environment Variables for Pipeline Manager

If your system includes Pipeline Manager and if you have the Oracle ZT PKI Encryption enabled in BRM 7.5, you must set some environment variables for Pipeline Manager.

On the machine on which you installed the BRM 12.0 server, set the BRM_WALLET environment variable for pipelines by running the following command:

setenv BRM_WALLET Pipeline_home/wallet/client

Configuring SSL for the BRM Database

Note:

SSL-enabled databases are not supported on multischema systems.

On single-schema systems, you can configure secure sockets layer (SSL) for the BRM database by creating wallets for storing certificates and then modifying the following configuration files in the Oracle_home/network/admin directory, where Oracle_home is the directory in which the Oracle database is installed, to point to the appropriate wallet:

sqlnet.ora
tnsnames.ora
listener.ora

You can use the Orapki utility to create the wallets.

For information about configuring SSL for the Oracle database, see the Oracle Database documentation.

Running the create_procedures Script

After installing the BRM patch set, run the create_procedures script to remove any invalid objects in the BRM database.

In a multischema system, perform this task on the primary Oracle DM machine.

To run the create_procedures script:

Go to the BRM_home/sys/dm_oracle/data directory.
Run the following command, which opens SQL*Plus:
```
sqlplus login@ORACLE_SID
Enter password: password
```
where:
- login is the user name for the BRM database schema.
- password is the password for the specified user name.
- ORACLE_SID is the database alias of the BRM database schema.
Run the following command:
```
@create_procedures_character_set.plb
```
where character_set specifies the database character set of either UTF8 or AL32UTF8.

Merging the Price Lists

You must perform this task only if you were using branding in BRM 7.5.

Branding is not supported in BRM 12.0. Therefore, if you have upgraded BRM 7.5 to BRM 12.0 or if you are upgrading BRM 7.5 to a BRM 12.0 patch set, merge the brand price lists.

To merge the price lists:

Go to the BRM_home/sys/dd/data directory.
Run the following command, which opens SQL*Plus:
```
sqlplus login@ORACLE_SID
Enter password: password
```
where:
- login is the user name for the BRM database schema.
- password is the password for the specified user name.
- ORACLE_SID is the database alias of the BRM database schema.
Run the following command:
```
@merge_price_list.sql
```

Setting the DM_IFW_SYNC Queue Database and CM Configuration Entries

You must add the required DM_IFW_SYNC Queue Database and CM configuration entries to the corresponding pin.conf files.

To set the DM_IFW_SYNC queue database and CM configuration entries:

Open the BRM_home/sys/dm_ifw_sync/pin.conf file.

Add the following required configuration entries:

- dm pcm_connect_max_retries 1
- dm pcm_reconnect_max_retries 3
- dm pcm_op_max_retries 0
- dm pcm_op_timeout_max_retries 0
- dm pcm_timeout_in_msecs -1
- dm pcm_auto_reconnect 1
- dm pcm_suspect_timeout_in_msecs -1
- dm pcm_bad_connection_retry_delay_time_in_secs 0
- dm pcm_reconnect first
- - custom_field_caching 0
-- ops_fields_extension_file dummy

Save and close the file.
Open the BRM_home/sys/cm/pin.conf file.

Add the following required configuration entries:

- cm pcm_connect_max_retries 1
- cm pcm_reconnect_max_retries 3
- cm pcm_op_max_retries 0
- cm pcm_op_timeout_max_retries 0
- cm pcm_reconnect first
- cm pcm_timeout_in_msecs -1
- cm pcm_suspect_timeout_in_msecs -1
- cm pcm_auto_reconnect 1
- cm pcm_bad_connection_retry_delay_time_in_secs 0
- cm pcm_connect_rcvbuf_size 87380
- cm keepalive 1
- cm log_session 0

Save and close the file.

Restoring Service to Your Customers

The Oracle Communications Online Charging Solution document contains the details on the steps that must be completed to restore service to your customers. Complete the process that is appropriate for your BRM 12.0 installation.