1. Installation Guide
  2. Installing BRM
  3. BRM Post-Installation Tasks

6 BRM Post-Installation Tasks

You perform post-installation tasks, such as changing your database partitions and running the pin_setup script, after installing the Oracle Communications Billing and Revenue Management (BRM) software.

Topics in this document:

Post-Installation Tasks for a BRM Non-Production System

After installing the BRM server, if you have not performed the following tasks during installation, do the following and then run the pin_setup script. See "Running the pin_setup Script" for more information.

Do the following after running the pin_setup script:

Editing the pin_setup.values File

To further configure BRM, such as by changing the default currency and country, you edit the BRM_home/setup/pin_setup.values file. This file stores the information you provided to the installer and a number of database and add-on component parameters.

The entries you need to edit in the pin_setup.values file depend on which components you install on the current machine. For example, if you are installing the Email DM on the current machine, edit the $DM_EMAIL entries.

The following examples show the important entries to check in three configurations:

  • The Connection Manager (CM) and Data Manager (DM) reside on separate machines.

  • The system contains multiple Oracle DMs connected to one database.

  • Invoices are stored in a separate database schema.

Example 6-1 The CM and DM Reside on Separate Machines

Machines that contain a CM must include the correct port number and host name of each DM in the system. This is especially critical when DMs reside on separate machines from the CM.

For example, you might install the Oracle DM and Email DM on a separate machine from the CM. In this case, you must modify the parameters in the CM machine's pin_setup.values file as shown in Table 6-1.

Table 6-1 CM Machine's pin_setup Values

Entry Description

$DM_ORACLE{'port'}

Must contain the port number of the Oracle DM.

$DM_ORACLE{'hostname'}

Must contain the host name of the machine running the Oracle DM.

$DM_EMAIL{'port'}

Must contain the port number of the Email DM.

$DM_EMAIL{'hostname'}

Must contain the host name of the machine running the Email DM.

Example 6-2 The System Contains Multiple Oracle DMs Connected to One Database

When your system contains multiple Oracle DMs connected to one database, if not already performed during the BRM server installation, you must initialize the database and drop the tablespaces. You can perform this by modifying each DM machine's pin_setup.values file as shown in Table 6-2.

Note:

You can initialize the database and drop the tablespaces only once.

Table 6-2 DM Machine's pin_setup Values

Entry Description

$SETUP_INIT_DB

Must be set to Yes on the primary Oracle DM machine; on all other machines containing an Oracle DM, set to No.

$SETUP_DROP_ALL_TABLES

Must be set to Yes on the primary Oracle DM machine; on all other machines containing an Oracle DM, set to No.

Example 6-3 Invoices Are Stored in a Separate Database Schema

Storing invoices in their own database schemas speeds up the invoicing process; enables you to store a large number of invoices; and enables you to view, email, and print invoices without affecting the performance of the main BRM schema.

If you are storing invoices in their own schemas, you must update the pin_setup.values file to include the correct pointers to the invoice schema. Therefore, you must modify the parameters listed in Table 6-3 on the machine containing the Invoice DM.

Note:

The Invoice DM is supported only on Oracle databases.

Table 6-3 Invoice DM Machine's pin_setup Values

Entry Description

$INVOICE_DB{'user'}

Must contain the user name to log in to your invoice schema. This user name must be different from the one used for the main BRM schema.

$INVOICE_DB{'alias'}

Must contain the database alias of the invoice schema.

$INVOICE_DB{'Host'}

Must contain the host name of the machine running the invoice schema.

$INVOICE_DB{'tables_group'}

Must contain the name of the data tablespace.

$INVOICE_DB{'indexes_group'}

Must contain the name of the index tablespace.

$DM_INVOICE{'port'}

Must contain the port number of the Invoice DM. For guidelines, see "Guidelines for Database and Port-Number Entries" in BRM System Administrator's Guide.

$DM_INVOICE{'db_num'}

Must contain the database number for the invoice schema.

Running the pin_setup Script

The pin_setup script reads the pin_setup.values and pin_tables.values files and configures BRM by:

  • Configuring your various configuration (pin.conf) files.

  • Setting up database tables and indexes.

To run the pin_setup script:

  1. Go to the BRM_home/setup directory and enter the following command: 

    % ./pin_setup

  2. If you receive a notification that you must append information to the CM pin.conf file:

    1. Append the lines from the BRM_home/append_to_cm_pin_conf file to the CM machine's BRM_home/sys/cm/pin.conf file.

    2. Stop and restart the CM process.

    You receive the notification shown below when you install a DM component on a separate machine from the CM component:

    Warning: File not found: BRM_home/sys/cm/pin.conf
         To complete the install, append the following 
         file to the sys/cm/pin.conf file and then restart the CM 
         process:
         "BRM_home/append_to_cm_pin_conf"

  3. Check the pin_setup.log file for status and errors.

    Note:

    After you run pin_setup, the cm.pinlog file erroneously contains several PIN_ERROC_FLIST and PIN_ERRCLASS_SYSTEM_DETERMINATE error messages. You can safely ignore these messages.

By default, the pin_setup script configures only the last installed product by reading the pin_setup.values file. You can also do the following:

  • Use the -all parameter to configure BRM and all the optional components present in the @COMPONENTS section of pin_setup.values. Before using the -all parameter to configure BRM, ensure that the following entry is commented: 

    #@COMPONENTS

    For example, go to the BRM_home/setup directory and enter the following command: 

    pin_setup -all

    To configure additional set of components using the -all parameter, add the @COMPONENT_LIST= (" "); entry in the pin_setup.values file.

Changing Your Database Partitions

If you did not enable partitioning during installation, skip this section.

If you did enable partitioning for one or more storable classes during installation, the tables for those storable classes are now divided into the following partitions:

  • Event tables

    • If you chose to add 12 fixed partitions to your event tables, those tables were divided into 12 monthly partitions, a historic partition, and a last partition. See "About the Default Partitioning Scheme" in BRM System Administrator's Guide.

    • If you chose not to add 12 fixed partitions to your event tables, those tables were divided into a historic partition and a last partition (which stores all purgeable objects for the table). This partitioning scheme is sufficient for a test or demonstration system. For a production system, however, you must create purgeable partitions.

  • Item tables

    Tables for item storable classes were divided into a historic partition and a last partition.

  • Tables for all other storable classes in @CLASSES_TO_BE_PARTITIONED

    Tables for all storable classes listed in the pin_setup.values file's @CLASSES_TO_BE_PARTITIONED entry except the item storable class were given only one partition, partition_last. See "About Objects Stored in partition_last and partition_last_pin" in BRM System Administrator's Guide. For a production system, you must create purgeable partitions.

    Note:

    • To test partitioning, you must add at least one purgeable partition.

    • To change your partitioning scheme (for example, by adding purgeable partitions), do so before any objects are stored in the partitions you want to modify. Do not modify a partition after BRM adds objects to the partition.

For information about changing your partitioning scheme, see "Partitioning Tables" in BRM System Administrator's Guide.

Setting Environment Variables for Pipeline Manager

If you installed BRM server and Pipeline Manager on separate machines or directories, on the machine on which you installed the BRM server, set the environment variables to point to the client wallet and JARs in the Pipeline_home directory (where Pipeline_home is the directory in which Pipeline Manager is installed) by running the following command: 

setenv BRM_WALLETPipeline_home/wallet/client
setenv PIN_HOME Pipeline_home/jars

Updating Client Wallet for Pipeline Manager

If you installed BRM server and Pipeline Manager on separate machines, on the machine on which you installed the BRM server, update the values for the following configuration entries in the client wallet manually:

  • oracle.security.client.connect_stringn

  • oracle.security.client.usernamen

  • oracle.security.client.passwordn

where n is the database or database schema number. For example: oracle.security.client.connect_string1.

To update configuration entries in the client wallet, see "About Oracle Wallet" in BRM System Administrator's Guide.

Copying Files for Compiling CM and FM Modules

To copy the required files for compiling CM and FM modules:

  1. Copy the following files from the BRM_home/lib directory to the BRM_home/PortalDevKit/source/sys/cm directory:

    • libcmpin.so

    • libdmpin.so

  2. Copy the cm.cpp file from the BRM_home/source/sys/cm directory to the BRM_home/PortalDevKit/source/sys/cm directory.

  3. Copy the contents from the BRM_home/PortalDevKit/include directory to the BRM_home/include directory.

  4. Open the BRM_home/PortalDevKit/source/samples/env.unix file in a text editor.

  5. 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. For example: /Linux/x86_64/packages/jdk/jdk1.8.0_144.

  6. Save and close the file.

Editing and Loading the Event Notification List

To edit and load the event notification list:

  1. Open the BRM event notification file (BRM_home/sys/data/config/pin_notify) in a text editor.

  2. Search for the following entries and remove them:

    2354 0 /event/billing/settlement/notify
2355 0 /event/billing/dispute/notify

  3. Save and close the file.

  4. Load the updated file into the database by running the load_pin_notify utility: 

    load_pin_notify -v event_notification_file

    where event_notification_file is the path to the BRM event notification file.

    See "Loading the Event Notification List" for more information.

Loading the Tailor-Made Stored Procedure

If you use the Tailor-Made Plan feature, you must load its stored procedure.

To load the stored procedure:

  1. Ensure the following:

    • BRM and Pipeline Manager are installed.

    • The BRM schema and the Pipeline Manager schema reside on the same database.

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

    % sqlplus system@databaseAlias
Enter password: password

  3. Grant access of the pipeline schema to user pin by doing the following:

    1. Run the SQL grant select, update, insert, and delete command on the specified Pipeline Manager tables:

      SQL> grant select, update, insert, delete on tableName to pin;

      where tableName is the name of the Pipeline Manager table. Run the command on the following tables:

      • ifw_rateplan

      • ifw_rateplan_cnf

      • ifw_rateplan_ver

      • ifw_model_selector

      • ifw_selector_detail

      • ifw_selector_rule

      • ifw_selector_rule_lnk

      • ifw_selector_ruleset

      • ifw_pricemodel

      • ifw_pricemdl_step

    2. Run the SQL grant select command on the specified Pipeline Manager tables:

      SQL> grant select on tableName to pin;

      Run the command on the following tables:

      • ifw_service

      • ifw_timezone

      • ifw_timemodel

      • ifw_impact_cat

      • ifw_zonemodel

      • ifw_calendar

    3. Run the SQL grant select command on the specified Pipeline Manager sequences:

      SQL> grant select sequenceName to pin;

      where sequenceName is the name of the Pipeline Manager sequence. Run the command on the following sequences:

      • ifw_seq_selectordetail

      • ifw_seq_selectorrule

      • ifw_seq_modelselector

      • ifw_seq_pricemodel

      • ifw_seq_rateplan

  4. Type exit to exit SQL*Plus.

  5. Go to the IFW_home/database/Oracle/Scripts directory, where IFW_Home is the pipeline install directory.

  6. Enter the following command to open SQL*Plus:

    % sqlplus pin@database_Name
Enter password: password

    where database_Name is the service name or database alias of the Oracle database.

  7. Enter the following command to load the stored procedure:

    SQL>@create_pricing_tailormadeplan_procedures.plb

  8. Type exit to exit SQL*Plus.

Post-Installation Tasks for a BRM Production Installation

After installing the BRM server, if you have not performed the following tasks during installation, do the following and then run the pin_setup script. See "Running the pin_setup Script" for more information.

  • (Optional) To further configure BRM, you can edit the BRM_home/setup/pin_setup.values file. See "Editing the pin_setup.values File" for more information.

  • (Optional) If you did not create multiple tablespaces during the BRM server installation, create additional tablespaces and map the BRM tables to the tablespaces. See "Editing the pin_tables.values File" for more information.

  • (Optional) If you enabled partitioning during BRM installation, the following classes are automatically partitioned: journal, journal master, newsfeed, and user activity. See "Enabling Different Classes for Partitioning during Installation" for more information. This task is common to both typical and complete BRM server installations.

Do the following after running the pin_setup script:

Editing the pin_tables.values File

If you install BRM with the default settings, BRM data is stored in a single tablespace (pin00), and BRM indexes are stored in a second tablespace (pinx00). Although you can run and test BRM with just these tablespaces, you need multiple tablespaces for optimal performance on a production system.

If your BRM database contains multiple tablespaces, you must use the BRM_home/setup/scripts/pin_tables.values file to map the BRM tables to the tablespaces you created in Oracle. For information on how to map your tables, see "Mapping Tablespaces to Logical Devices".

Enabling Different Classes for Partitioning during Installation

To enable partitioning for different storable classes, you must edit the pin_setup.values file and then run the pin_setup script.

To enable different storable classes for partitioning during installation:

  1. Open the BRM_home/setup/pin_setup.values file.

  2. Ensure that the $ENABLE_PARTITION parameter is set to Yes.

  3. In the @CLASSES_TO_BE_PARTITIONED entry, add or remove storable classes. The default list is shown below:

    @CLASSES_TO_BE_PARTITIONED = ("/journal:local","/journal master:local", "/newsfeed:local","/sepa:local","/user_activity:local");

    To add classes for partitioning, use the following format:

    "/class_name:index_type"

    where:

    • class_name is the name of a base storable class. Add only base storable classes to the list.

      The event storable class is never added to the list. If partitioning is enabled ($ENABLE_PARTITION = Yes), the event tables are always partitioned.

    • index_type is one of the following index types available for non-event partitions (all event indexes are local):

      • :local — Maintenance can be done without shutting down BRM, but performance may suffer. Search operations are more time consuming because searches must hit every local index.

      • :global — Search operations are fast, but BRM services must be shut down before adding or dropping partitions. Tables with global indexes require the indexes to be rebuilt.

    Note:

    When pin_setup is run, the tables of storable classes enabled for partitioning get an initial partition. Because BRM does not provide a tool to revert partitioned tables to nonpartitioned tables, these partitions cannot easily be removed after data starts being stored in them.

  4. Save and close the file.

Editing Optional Components Configuration Entries

If you install any optional components on a separate machine from your CM, manually edit the component's configuration entries to include the following:

  • The correct CM port number.

  • The correct host name for the CM machine.

  • Any component-specific Facilities Module (FM) entries. For information, see "Syntax for Facilities Module Entries" in BRM System Administrator's Guide.

For updating the configuration entries in the Oracle wallet, see "About Oracle Wallet" in BRM System Administrator's Guide.

What's Next?

After completing the post-installation tasks, set up your product offerings, business policies, and customer accounts in BRM. To do so, you must install the BRM client applications, including the BRM web-based client applications, such as Billing Care, Business Operations Center, and Pricing Design Center (PDC):

For a production installation, to implement BRM with the required software products for charging, billing, and revenue management, you must install and configure the required software products before you implement BRM.

See the product documentation of the required software products for instructions on installing and configuring those products. For example, if you are using Elastic Charging Engine (ECE) for usage charging, install ECE. See ECE Installation Guide for more information.