2 Installing BRM Reports

This chapter explains how to install Oracle Communications Billing and Revenue Management (BRM) reports that are implemented with Oracle Business Intelligence (BI) Publisher 11g and 10g.

Note:

Running reports and generating invoices with BI Publisher 11g running on Windows is not supported.

For an overview of BRM reports, see "About BRM Reports".

Installation Overview

To set up your system to run BRM reports with BI Publisher, perform the following tasks:

  1. Installing and Configuring BI Publisher

  2. Installing BRM Reports

Installing and Configuring BI Publisher

To set up BI Publisher software, you need the following:

  • For Windows operating systems, Windows administrator privileges on the computer where you install BI Publisher. Administrators can assign user rights. Depending on the rights administrators give to themselves and to others, users can design and customize reports or schedule reports to run.

  • A BI Publisher Enterprise license

Stop Oracle WebLogic Server

For BI Publisher 11g only: stop the server on which Oracle WebLogic server is running before installing BI Publisher 11g.

Installing BI Publisher

To install BI Publisher, follow the instructions in the BI Publisher documentation.

Note:

For BI Publisher 11g, before installing BRM Reports, verify if the BIP_Home/file_location/BIPExtension.jar file is installed, where BIP_Home is the directory in which BI Publisher is installed. If the BIPExtension.jar file is installed, you must manually move the file to a directory that is not included in the CLASSPATH. This is because the required version of the BIPExtension.jar file is installed when you install BRM Reports.

Setting the BI Publisher Home Environment Variable

The following information describes how to set the BI Publisher home environment variable.

Setting the BI Publisher Home Environment Variable on Windows

For BI Publisher 10g only: set the BI Publisher 10g home environment variable in Windows:

  1. Right-click My Computer, and select Properties.

  2. On the Advanced tab, click Environment Variable.

  3. In the System Variable section, click New.

  4. In the Variable name field, enter BIP_Home.

  5. In the Variable value field, enter the path where the BI Publisher server is installed.

  6. Click OK.

  7. In the Environment Variables dialog box, click OK.

  8. In System Properties dialog box, click OK.

Setting the BI Publisher Home Environment Variable on Solaris, Linux, and AIX

To set the BI Publisher Home environment variable on Solaris, Linux, and AIX, run the following command:

setenv BIP_Home BIP_server_path

where BIP_server_path is the directory in which the BI Publisher software is installed.

Configuring a JDBC Data Source

By default, the reports are configured to run against a JDBC data source named BRM_DATA_SOURCE. See ”Setting up Data Sources” in the BI Publisher documentation for information about configuring a JDBC data source on your system.

Configuring Run-Time Properties

You need to configure run-time properties to allow BI Publisher to refer to external references such as plug-ins.

To configure run-time properties:

  1. Follow the instructions in "Accessing BI Publisher".

  2. Click the Admin tab.

  3. Under Runtime Configuration, click the Properties link.

  4. From the Disable external references list, select False.

  5. Click Apply.

Installing BRM Reports

To install BRM Reports, perform the following tasks:

  1. Installing BRM Base Reports

  2. Loading the BI Publisher Utility File

  3. Installing BRM Reports for Optional Managers

Installing BRM Base Reports

Caution:

You need to install BRM base reports before you can install any other reports.

Installing the BRM Base Reports on Windows

For BI Publisher 10g only: to install BRM base reports:

  1. Create a temporary directory (temp_dir).

  2. Go to the My Oracle Support Web site:

    https://support.oracle.com

  3. Sign in with your user name and password.

  4. Click the Patches & Updates tab.

  5. From the list, select Patch Name or Number.

  6. In the text field, enter 16429299 and click Search.

    The Patch Search Results page appears.

  7. Click the patch name.

    The patch details appear.

  8. From the Platform list, select the platform and click Download.

    The File Download dialog box appears.

  9. Download the appropriate p16429299_750_platform.zip software pack to temp_dir, where platform is WINNT.

  10. Unzip the p16429299_750_platform.zip file.

  11. Go to temp_dir and run the following command:

    7.5PS4_BIP_BRM_Base_Reports_10g_platform_32_opt.exe

    The Installation Wizard appears.

  12. Click Next.

    In the next screen do one of the following:

    • If you are installing BRM base reports for the first time:

      1. Select Full Installation.

        This installs the .rtf, .xdo, and .source files, and the BI Publisher utility file, BIPExtension.plb.

      2. Follow the instructions in "Loading the BI Publisher Utility File".

    • If you are not installing BRM base reports for the first time, do one of the following:

      • To install only BRM base reports, select Reports only.

        This installs the .rtf, .xdo, and .source files.

      • To install libraries without overwriting customized reports, select Libraries only.

        This installs the BI Publisher utility file, BIPExtension.plb.

        Note:

        You must upload the .source files that are in the StoredProcedures folder to the database after the base reports are installed. For more information about loading stored procedures see "Loading Stored Procedures".

  13. Execute the source files with SQL*Plus before you use reports in BI Publisher.

Installing the BRM Base Reports on Linux, Solaris, and AIX

To install BRM base reports:

  1. Create a temporary directory (temp_dir).

  2. Go to the My Oracle Support Web site:

    https://support.oracle.com

  3. Sign in with your user name and password.

  4. Click the Patches & Updates tab.

  5. From the list, select Patch Name or Number.

  6. In the text field, enter 16429299 and click Search.

    The Patch Search Results page appears.

  7. Click the patch name.

    The patch details appear.

  8. From the Platform list, select the platform and click Download.

    The File Download dialog box appears.

  9. Download the appropriate p16429299_750_platform.zip software pack to temp_dir, where platform is linux, aix, hpux_ia64, or solaris.

  10. Unzip the p16429299_750_platform.zip file.

  11. Go to temp_dir and enter one of the following command:

    • For BI Publisher 10g:

      7.5PS4_BIP_BRM_Base_Reports_10g_platform_32_opt.bin -console

    • For BI Publisher 11g:

      7.5PS4_BIP_BRM_Base_Reports_platform_32_opt.bin -console

  12. Follow the instructions displayed during installation.

    BRM base reports and BRM base libraries are installed.

  13. Execute the source files by using SQL*Plus in the BRM environment before using reports in BI Publisher. For BI Publisher 11g, the source files are located in: BIP_HOME/user_projects/domains/bifoundation_domain/config/bipublisher/repository/Reports/BRM_Reports/Base_BRM_Reports/StoredProcedures.

Configuring Post-Installation Tasks

The following post-installation tasks are only applicable to BI Publisher 11g:

  1. Restart Oracle WebLogic Server.

  2. Log in to BI Publisher 11g.

    If BRM reports are not visible, your report repository is pointing to an incorrect location. See the BI Publisher documentation for more information.

  3. If you are using a custom BI Publisher server setup, do the following:

    1. Copy the BIP_home/user_projects/domains/bifoundation_domain/servers/AdminServer/tmp/WebLogic_user/bipublisher_11.1.1/6uc731/lib/BIPExtension.jar file to your domain lib directory.

    2. Stop and restart the Oracle WebLogic Server, which adds the BIPExtension.jar file to the Oracle WebLogic server classpath and enables the BI Publisher extension library.

  4. If you are using custom paths, copy the BRM-BI Publisher template files from BIP_home/user_projects/domains/bifoundation_domain/config/bipublisher/repository/Reports to your custom directories.

Loading the BI Publisher Utility File

  1. Open a command window and enter the following command:

    cd Local_drive:\BIP_Home\BRM Reports\Utils\StoredProcedures

    where BIP_Home is the directory in which BI Publisher is installed.

  2. At the prompt, enter the following command, which opens SQL*Plus:

    sqlplus user_name/password@Database_Name

    where:

    • user_name is your user name.

    • password is your password.

    • Database_Name is the service name or database alias of the Oracle database.

  3. At the SQL prompt, enter the following command:

    @BIPExtension.plb

    The BIPExtension.plb file is loaded into Database_Name.

    The BI Publisher utility file includes functions that you can use to customize reports.

  4. Quit SQL*Plus, and close the command window.

Installing BRM Reports for Optional Managers

The following information describes how to install BRM reports for optional managers.

Installing BRM Reports for Optional Managers on Windows

To install BRM reports for optional managers:

  1. Back up any BI Publisher Reports .rtf, .xdo, and .source files that you customized. If you do not, your customized report files will be overwritten.

  2. Create a temporary directory (temp_dir).

  3. Go to the My Oracle Support Web site:

    https://support.oracle.com

  4. Sign in with your user name and password.

  5. Click the Patches & Updates tab.

  6. From the list, select Patch Name or Number.

  7. In the text field, enter 16429299 and click Search.

    The Patch Search Results page appears.

  8. Click the patch name.

    The patch details appear.

  9. From the Platform list, select the platform and click Download.

    The File Download dialog box appears.

  10. Download the appropriate p16429299_750_platform.zip software pack to temp_dir, where platform is WINNT.

  11. Unzip the p16429299_750_platform.zip file.

  12. Go to temp_dir and run the following command:

    7.5PS4_BIP_BRM_Base_Reports_10g_platform_32_opt.exe

    The Installation Wizard appears.

  13. During installation, you must select Reports only.

    This installs the.rtf, xdo, and source files.

  14. Execute the source files with SQL*Plus before you use reports in BI Publisher.

Installing BRM Reports on Linux, Solaris, and AIX

To install BRM reports for optional managers:

  1. Create a temporary directory (temp_dir).

  2. Go to the My Oracle Support Web site:

    https://support.oracle.com

  3. Sign in with your user name and password.

  4. Click the Patches & Updates tab.

  5. From the list, select Patch Name or Number.

  6. In the text field, enter 16429299 and click Search.

    The Patch Search Results page appears.

  7. Click the patch name.

    The patch details appear.

  8. From the Platform list, select the platform and click Download.

    The File Download dialog box appears.

  9. Download the appropriate p16429299_750_platform.zip software pack to temp_dir, where platform is linux, aix, hpux_ia64, or solaris.

  10. Unzip the p16429299_750_platform.zip file.

  11. Go to temp_dir and enter one of the following command:

    • For BI Publisher 10g:

      7.5PS4_BIP_BRM_Base_Reports_10g_platform_32_opt.bin -console

    • For BI Publisher 11g:

      7.5PS4_BIP_BRM_Base_Reports_platform_32_opt.bin -console

  12. Follow the instructions displayed during installation.

  13. Execute the source files by using SQL*Plus in the BRM environment before using reports in BI Publisher. For BI Publisher 11g, the source files are located in: BIP_home/user_projects/domains/bifoundation_domain/config/bipublisher/repository/Reports/BRM_Reports/Base_BRM_Reports/StoredProcedures.

  14. If you are using a custom BI Publisher server setup, do the following:

    1. Copy the BIP_home/user_projects/domains/bifoundation_domain/servers/AdminServer/tmp/WebLogic_user/bipublisher_11.1.1/6uc731/lib/BIPExtension.jar file to your domain lib directory.

    2. Stop and restart the Oracle WebLogic Server, which adds the BIPExtension.jar file to the Oracle WebLogic server classpath and enables the BI Publisher extension library.

  15. If you are using custom paths, copy the BRM-BI Publisher template files from BIP_home/user_projects/domains/bifoundation_domain/config/bipublisher/repository/Reports to your custom directories.

Uninstalling BRM Reports

Caution:

Do not uninstall BRM base reports before uninstalling all other reports.

When you uninstall BRM base reports, the SubTemplates folder is deleted and all the reports that use the sub-template-parameters.rtf file will not display the correct data.

Complete the procedure for the appropriate operating system.

Uninstalling BRM Reports on Windows

To uninstall BRM reports:

  1. Do one of the following to start the uninstaller:

    • (Windows 8.1) Use the Windows uninstall feature.

    • (Other Windows versions) From the start options, select Uninstall Portal Report_name, which is under Portal or use the Windows uninstall feature, where Report_name is the report you want to uninstall.

  2. Do one of the following:

    • To uninstall a complete report:

      1. Click Report_name.

      2. Select View Components only.

      3. Click Uninstall.

    • To uninstall individual components of a report:

      1. Click Report_name.

      2. Select View Components and Features.

      3. Select the individual component.

      4. Click Uninstall.

  3. Click Finish.

Uninstalling BRM Reports for Linux, Solaris, and AIX

To uninstall BRM reports for optional managers:

  • To uninstall BRM optional reports with BI Publisher 11g, enter the following command:

    BIP_Home/uninstaller/BIP_BRM_OptionalMgr_Reports/uninstaller.bin

  • To install BRM optional reports with BI Publisher 10g, enter the following command:

    BIP_BRM_OptionalMgr_Reports/uninstaller.bin -console

  • To uninstall BRM base reports with BI Publisher 11g, enter the following command:

    BIP_Home/uninstaller/BIP_BRM_Base_Reports/uninstaller.bin

  • To uninstall BRM base reports with BI Publisher 10g, enter the following command:

    BIP_BRM_Base_Reports/uninstaller.bin -console