28 Installing EAI Manager

Learn how to install the Oracle Communications Billing and Revenue Management (BRM) Enterprise Application Integration (EAI) Manager.

Topics in this document:

About Installing EAI Manager

You can install EAI Manager on the Solaris, Linux, operating systems.

To ensure proper load balancing on your BRM system, you can install these three EAI features on different computers:

  • EAI Connection Manager (CM) module

    You must install this module on the same machine where the CM is running. The EAI CM module includes the opcodes required by EAI.

  • EAI Data Manager

    You can install the EAI Data Manager (DM) on any system accessible to the BRM server.

  • Payload Generator External Module (EM)

    You can install the Payload Generator EM (also called the EAI Java Server or eai_js) on any system accessible to the BRM server.

Software Requirements

Before installing EAI Manager, you must install:

About the EAI Manager Package

Note:

If you already installed the product, you must uninstall its features before reinstalling them.

The EAI Manager downloadable package includes the installer for both EAI Manager and Synchronization Queue Data Manager. You must download the EAI Manager package and extract these two components before you can install EAI Manager. For more information about Synchronization Queue Data Manager, see "Understanding the Synchronization Queue Data Manager"see in BRM Synchronization Queue Manager.

When you install EAI Manager, the installation program assigns default values in the Connection Manager (CM) and EAI DM configuration (pin.conf) files and the Payload Generator properties (Infranet.properties) file.

For information on changing the entries in the pin.conf and properties files, see "Configuring EAI Manager".

Follow the instructions in the appropriate section to install all EAI Manager features on the same system or to install them on separate computers. See "Installing EAI Features on the Same Computer" and "Installing EAI Features on Separate Computers".

Installing EAI Features on the Same Computer

To install EAI Manager:

  1. Download the EAI Manager package (12.0.0_EAI_FrameworkMgr_platform_opt.tar.Z) where platform is the operating system name. Download this file to a temporary directory (temp_dir). For information on downloading the software, see "Downloading the BRM Applications Media Pack" in BRM Installation Guide.

    Note:

    • If you download to a Windows workstation, use FTP to copy the package to a temporary directory on your server.

    • You must increase the heap size used by the Java Virtual Machine (JVM) before running the installation program to avoid "Out of Memory" error messages in the log file. See "Increasing Heap Size to Avoid "Out of Memory" Error Messages".

  2. Go to temp_dir and uncompress and extract the .tar.Z file. The following files are extracted:

    • 12.0.0._EAI_FrameworkMgr_platform_opt.bin - EAI Manager

    • 12.0.0_DM_AQ_platform_opt.bin - Synchronization Queue Data Manager

    where platform is the operating system name.

  3. Go to the directory where you installed the Third-Party package and source the source.me file.

    Caution:

    You must source the source.me file to proceed with installation, otherwise "suitable JVM not found" and other error messages appear.

    Bash shell:

    source source.me.sh
    

    C shell:

    source source.me.csh
    
  4. Go to the temp_dir and enter this command:

    12.0.0_EAI_FrameworkMgr_platform_opt.bin
    

    where platform is the operating system name.

    Note:

    You can use the -console parameter to run the installation in command-line mode. To enable a graphical user interface (GUI) installation, install a GUI application such as X Windows and set the DISPLAY environment variable before you install the software.

  5. Follow the instructions displayed during installation.

    Note:

    The installation program does not prompt you for the installation directory if BRM or EAI Manager is already installed on the machine and automatically installs the package at the BRM_home location, where BRM_home is the directory in which the BRM server software is installed.

  6. Go to the directory where you installed the EAI Manager package and source the source.me file:

    Bash shell:

    source source.me.sh
    

    C shell:

    source source.me.csh
    
  7. Go to the BRM_home/setup directory and run the pin_setup script.

  8. Open the BRM_home/sys/cm/pin.conf file in a text editor, change the value of the enable_publish entry to 1, and then save and close the file.

  9. Load information for EAI Manager into your system's event notification list.

    See "Configuring Event Notification for EAI Manager".

  10. (Solaris and Linux) Stop and restart all BRM processes.

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

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

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

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

Save the file as Packagename.ja in the temporary directory to which you downloaded the installation software. Packagename indicates the name of the installation software.

Installing EAI Features on Separate Computers

To install EAI features on separate computers, you must download the EAI Manager software package and then complete a separate installation procedure for each component.

Note:

The EAI Connection Manager (CM) module must be installed on the same system as the CM.

Installing the EAI CM

To install the EAI CM on a separate computer:

  1. Download the software to a temporary directory (temp_dir).

  2. Log in as user pin.

  3. Go to the temp_dir where you downloaded the BRM software and enter this command:

    12.0.0_EAI_FrameworkMgr_platform_opt.bin
    

    where platform is the operating system name.

    Note:

    You can use the -console parameter to run the installation in command-line mode. To enable a graphical user interface (GUI) installation, install a GUI application such as X Windows and set the DISPLAY environment variable before you install the software.

    This starts the installation program.

  4. Enter Custom when asked to specify the setup type. Select EAI_CM by typing its respective number. Click Next.

  5. Follow the instructions displayed during installation. Your responses are written to the BRM_home/setup/pin_setup.values file.

  6. Go to the directory where you installed the EAI Manager software and source the source.me file:

    Bash shell:

    source source.me.sh
    

    C shell:

    source source.me.csh
    
  7. Open the BRM_home/setup/pin_setup.values file in a text editor.

  8. Set the value of the EAI hostname parameter to the name of the system where you will install the EAI DM:

    $EAI{'hostname'} = "hostname";
    
  9. On the system where the Oracle DM is running, perform these steps:

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

    2. Set the three dd_write_enable parameters to 1:

      - dm dd_write_enable_fields 1
      - dm dd_write_enable_objects 1
      - dm dd_write_enable_portal_objects 1
      
    3. Save and close the file.

    4. Stop and restart the Oracle DM.

  10. Log in as user pin.

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

  12. Open the BRM_home/sys/cm/pin.conf file, change the value of fm_publish entry to 1, and then save and close the file.

  13. On the system where the Oracle DM is running, perform these steps:

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

    2. Reset the three dd_write_enable parameters to their original values, probably 0:

      - dm dd_write_enable_fields 0
      - dm dd_write_enable_objects 0
      - dm dd_write_enable_portal_objects 0
      
    3. Save and close the file.

    4. Stop and restart the Oracle DM.

  14. Load information for EAI Manager into your system's event notification list.

    See "Configuring Event Notification for EAI Manager".

Installing the EAI DM

To install the EAI DM on a separate computer:

  1. Log in as user pin.

  2. Go to the temp_dir where you downloaded the BRM software and enter this command:

    12.0.0_EAI_FrameworkMgr_platform_opt.bin
    

    where platform is the operating system name.

    Note:

    You can use the -console parameter to run the installation in command-line mode. To enable a graphical user interface (GUI) installation, install a GUI application such as X Windows and set the DISPLAY environment variable before you install the software.

    This starts the installation program.

  3. Enter Custom when asked to specify the setup type. Select EAI_DM by typing its respective number. Click Next.

  4. Follow the instructions displayed during installation. Your responses are written to the BRM_home/setup/pin_setup.values file.

  5. Go to the directory where you installed the EAI Manager software and source the source.me file:

    Bash shell:

    source source.me.sh
    

    C shell:

    source source.me.csh
    
  6. Log in as user pin.

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

  8. On the computer where the Connection Manager (CM) is installed, perform these steps:

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

    2. Edit the dm_eai_pointer entry to point to the computer where you installed the EAI DM:

      - cm dm_pointer db_no ip host_name port_number # dm_eai
      

      where:

      db_no specifies the database number for the EAI DM

      host_name specifies the host name where the EAI DM is installed

      port_number specifies the port used by the EAI DM

    3. Stop and restart all BRM processes.

Installing the EAI Payload Generator

To install the EAI Payload Generator on a separate computer:

  1. Log in as user pin.

  2. Go to the temp_dir where you downloaded the BRM software and enter this command:

    12.0.0_EAI_FrameworkMgr_platform_opt.bin
    

    where platform is the operating system name.

    Note:

    You can use the -console parameter to run the installation in command-line mode. To enable a graphical user interface (GUI) installation, install a GUI application such as X Windows and set the DISPLAY environment variable before you install the software.

    This starts the installation program.

  3. Enter Custom when asked to specify the setup type. Select EAI_JS by typing its respective number. Click Next.

  4. Follow the instructions displayed during installation. Your responses are written to the BRM_home/setup/pin_setup.values file.

  5. Go to the directory where you installed the EAI Manager software and source the source.me file:

    Bash shell:

    source source.me.sh
    

    C shell:

    source source.me.csh
    
  6. Go to the BRM_home/setup directory and run the pin_setup script.

Configuring Event Notification for EAI Manager

When a BRM event that is included in a business event occurs, EAI Manager uses event notification to call the opcode that caches the BRM event in the Payload Generator.

Before you can use EAI Manager, you must configure the event notification feature as follows:

  1. If your system has multiple configuration files for event notification, merge them. See "Merging Event Notification Lists".

  2. Ensure that the merged file includes the entire event notification list in the BRM_home/sys/data/config/pin_notify_eai file.

    Note:

    The BRM events listed in the pin_notify_eai file are not business events. A business event comprises one or more BRM events. You define business events in the payloadconfig.xml file. See "Configuring Business Events".

  3. If you configured EAI Manager to publish to an HTTP port, ensure that the merged file also includes the entire event notification list in the BRM_home/sys/data/config/pin_notify_plugin_http file.

    See "Configuring EAI Manager to Publish to an HTTP Port".

  4. (Optional) If necessary, add, modify, or delete entries in your final event notification list. See "Editing the Event Notification List".

    Note:

    If you changed the default set of BRM events to be published by adding business events or by modifying the existing business events, you must edit your final event notification list to include all the BRM events in the new or modified business events.

  5. Load your final event notification list into the BRM database. See "Loading the Event Notification List".

For more information, see "Using Event Notification".