32 Configuring EAI Manager

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

Topics in this document:

When you install EAI Manager, the installation program adds entries to the EAI DM and the CM pin.conf files and to the Infranet.properties file. After you build the connector application, you need to enable EAI by editing the pin.conf and Infranet.properties files to specify values for the entries relevant to EAI Manager.

Configuring the Connection Manager for EAI

After you build the connector application, you need to configure the CM for EAI.

  1. In a text editor, open the CM configuration file (BRM_home\sys\cm\pin.conf).

    This pin.conf file contains descriptions of all the entries and instructions for editing the entries.

  2. In the EAI_CM section of the file, assign values to the entries shown in Table 32-1:

    Table 32-1 EAI CM Entries

    Entry Description Example

    - fm_publish enable_publish

    Specifies whether to publish events.

    To publish events, specify 1. To not publish events, specify 0.

    - fm_publish  enable_publish 1

    - cm em_pointer

    Specifies the host name and port number of the computer on which the Payload Generator EM runs.

    The em_pointer entry includes the following values:

    • Tag that refers to the EM type; for example, publish for the EAI EM.

    • The address type tag, ip.

    • IP address or host name of the computer where the Payload Generator EM runs.

    • Port number of the computer where the Payload Generator EM runs.

    Important: The port number must match the port number in the Infranet.properties file in the BRM_home\sys\eai_js directory.

    - cm  em_pointer publish ip 127.0.0.1 11930

    - cm em_group

    Specifies a member opcode in a group of opcodes provided by the Payload Generator EM.

    Note: This entry is automatically inserted in the configuration file by the installation program.

    The em_group entry includes the following values:

    • Tag that refers to the EM type; for example, publish for the EAI EM.

    • The opcode name or number.

    - cm em_group publish 1301

    - cm dm_pointer

    Specifies the database number, the IP address or host name, and port number of the computer where the EAI DM runs.

    Important: The database number must match the DB entry of the publisher definition in the payloadconfig.xml file. The database number and port number must match the dm_db_no and dm_port entries in the EAI DM pin.conf file.

    - cm  dm_pointer  0.0.9.1 ip 127.0.0.1 11970

  3. Save and close the file.

  4. Stop and restart the CM:

    cd BRM_home/bin
    pin_ctl bounce cm

Configuring the EAI DM

After you build the connector application, you need to configure the EAI DM.

  1. In a text editor, open the EAI DM configuration file (BRM_home\sys\dm_eai\pin.conf).

  2. In the EAI_PINCONF entries section, assign values to the entries shown in Table 32-2:

    Table 32-2 EAI_PINCONF Entries

    Entry Description Example

    - dm plugin_name

    Specifies the name of the module connector application that you implemented.

    - dm plugin_name ./dm_eai_plugin.so

    - dm dm_db_no

    Specifies the database number assigned to the EAI DM.

    The format of the entry is 0.0.0.n. 0, where n is your database number.

    Important: This number must match the DB entry for the publisher definition in the payloadconfig.xml file and the dm_pointer entry in the CM pin.conf file.

    - dm dm_db_no 0.0.9.1 0

    - dm dm_port

    Specifies the port number of the computer where the EAI DM runs.

    Important: This number must match the port number in the dm_pointer entry in the CM pin.conf file.

    - dm dm_port 11970

    - dm loglevel

    Specifies the log level of the EAI DM:

    0 = no logging

    1 = log only error messages (default)

    2 = log error messages and warnings

    3 = log error messages, warnings, and debugging messages

    - dm loglevel 1

  3. Save and close the file.

  4. Stop and restart the EAI DM:

    cd BRM_home/bin
    pin_ctl bounce dm_eai

Configuring the Payload Generator EM

The Payload Generator has an Infranet.properties file that specifies the location of the payloadconfig.xml file:

To configure the Payload Generator:

  1. In a text editor, open the Payload Generator configuration file (BRM_home\sys\eai_js\Infranet.properties).

  2. Specify the name and location of the payloadconfig.xml file:

    • If you are not using the plugin_http module, verify that the infranet.eai.configFile entry points to the location of the payloadconfig.xml file.

      Note:

      If you edited the payloadconfig.xml file and saved it with a different name, make sure you also change the name in this entry.

    • If you are using the plugin_http module, change the infranet.eai.configFile entry to point to the location of the payloadconfig_plugin_http.xml file.

  3. Verify that the file contains the following entry:

    infranet.opcode.handler.PUBLISH_GEN_PAYLOAD=com.portal.eai.PublishHandler
    
  4. Verify that the port number specified in the infranet.server.portNR entry matches the port number in the em_pointer publish entry in the CM pin.conf file.

  5. Save and close the file.

  6. Stop and restart the Payload Generator EM:

    cd BRM_home/bin
    pin_ctl bounce ePai_js

Specifying the Date and Time Format for Business Events

In business events, the date field value uses the default EAI Manager format in the server's local time zone. You can configure the date field to use a different date and time format by using the following entry in the Payload Generator Infranet.properties file:

infranet.eai.date_pattern: Specifies the date and time format based on the ISO-8601 standard. For example, you can set this entry to any of the following formats:

  • infranet.eai.date_pattern=dd/MMM/yyyy:hh:mm:ss

  • infranet.eai.date_pattern=yyyy-MM-dd'T'hh:mm:ss. Use this format if EAI Manager uses Oracle AIA to exchange data with external applications.

To specify the date and time format in business events:

  1. In a text editor, open the Payload Generator configuration file (BRM_home\sys\eai_js\Infranet.properties).

  2. Specify the date format in the infranet.eai.date_pattern entry:

    infranet.eai.date_pattern = Format
    
  3. Save and close the file.

  4. Stop and restart the Payload Generator EM:

    cd BRM_home/bin
    pin_ctl bounce eai_js

Defining Infinite Start Date and End Date Values

In some external applications, the infinite date value is represented as a NULL (empty XML element) value and in other external applications as the epoch time (01-01-1970 1200 AM UTC).

By default, when EAI Manager sends data to your external application, the infinite date value is the start of the epoch time.

You can define how EAI Manager sets infinite date values by using the infranet.eai.xml_zero_epoch_as_null entry in the Payload Configurator Infranet.properties file.

Note:

The infranet.eai.xml_zero_epoch_as_null entry does not affect the flist payload.

To configure how EAI Manager sets infinite date values:

  1. Open the BRM_home/sys/eai_js/Infranet.properties file in a text editor.

  2. Add the following entry:

    infranet.eai.xml_zero_epoch_as_null = value
    

    where value is:

    • TRUE to use NULL to represent an infinite start or end date.

    • FALSE to use the epoch time to represent an infinite start or end date. This is the default.

  3. Save and close the file.

  4. Stop and restart the Payload Generator EM:

    cd BRM_home/bin
    pin_ctl bounce eai_js

Configuring EAI Manager to Publish to an HTTP Port

You can use EAI Manager to publish information from your BRM database to an HTTP port for use by a third-party application. For example, you can send charge offer information to a customer relationship manager (CRM), such as Siebel Communications. Information about the new charge offers is posted to a specific HTTP port to enable the CRM to create charge offer information.

To configure EAI Manager to publish to an HTTP port:

  1. Configure Connection Manager for EAI. See "Configuring the Connection Manager for EAI".

  2. Open the dm_eai configuration file (BRM_home\sys\dm_eai\pin.conf) with a text editor such as vi.

  3. Add the following line to specify the name of the dm_http module:

    - dm plugin_name plugin_http.extension
    

    where extension is the library extension for your operating system: so for Solaris and Linux.

  4. Add the following line to configure the header delimiter:

    - dm dm_http_delim_crlf value
    

    where value is:

    • 0 to specify the delimiter \n

    • 1 to specify the delimiter \r\n

    The default is 0.

  5. Specify the HTTP host name and port number of the server to which the data should be sent:

    - dm dm_http_agent_ip host_name port_number
    
  6. If required, specify the URL for the HTTP server; for example:

    - dm dm_http_url http://10.1.6.78/HTTP_Infranet/BTSHTTPRECEIVE.so

    Note:

    The URL might be required; for example, when you deploy EAI Manager in an IIS environment.

  7. If your HTTP server requires the host name in the header, add this line to the pin.conf file:

    - dm dm_http_header_send_host_name value
    

    where value is:

    • 0 to indicate that the host name won't be included in the header.

    • 1 to indicate that the host name will be included in the header.

    • 2 to indicate that both the host name and the port number will be included in the header.

    The default is 0.

  8. If your HTTP server sends a 100-Continue status code to clients that do not send a 100-Continue expectation, add this line to the pin.conf file:

    - dm dm_http_100_continue value
    

    where value is:

    • 0 to indicate that a 100-Continue status is not expected.

    • 1 to indicate that a 100-Continue status is expected.

      Note:

      Set value to 1 only if your server sends the 100-Continue status code to clients that do not send an expectation for it. Most servers do not send unexpected 100-Continue codes, but some do.

    The default is 0.

  9. Specify whether or not dm_http should read the response codes sent by the HTTP server:

    - dm dm_http_read_success value
    

    where value is:

    • 0 to indicate that the module should not wait for a response code from HTTP receiver.

    • 1 to indicate that the module should wait for a response code to be read from HTTP receiver.

    The dm_http module supports the success response codes 200 (OK) and 202 (request accepted for asynchronous processing).

    The default is 0.

  10. Save and close the file.

  11. Configure the payload generator. See "Configuring the Payload Generator EM".

  12. Load information for the dm_http module into your system's event notification list.

    See "Configuring Event Notification for EAI Manager".

  13. Stop and restart BRM.