8 LDAP Manager Utilities

This chapter provides reference information for Oracle Communications Billing and Revenue Management (BRM) LDAP Manager utilities.

Topics in this document:

load_channel_config

Use this utility to load channel definitions into the /channel object in the Oracle Communications Billing and Revenue Management (BRM) database and to export existing channels to an XML file. Define the channel definitions in the BRM_home/sys/data/config/channel_config.xml file or another file that uses the same format. The format of the XML file is specified in the channel_config.xsd schema file in the BRM_home/xsd directory.

Caution:

When you run the load_channel_config utility, it overwrites the existing channel definitions in the /channel object in the BRM database. If a channel definition exists in the BRM database, but isn't included in the channel_config.xml file, the database definition won't be overwritten.

When you run the utility, the channel_config.xml and channel_config.xsd files must be in the same directory. If you do not run the utility from the directory in which channel_config.xml is located, include the complete path to the file. For example:

load_channel_config BRM_home/sys/data/config/channel_config.xml 
  

For information on the contents and format of the channel_config.xml file, see "About Defining Channels".

Note:

To connect to the BRM database, the load_channel_config utility needs a configuration file in the directory from which you run the utility. See "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.

Location

BRM_home/sys/data/config

Syntax

load_channel_config [-d] [-v] [-t] [-r] [-h] channel_config.xml

Parameters

-d

Displays detailed information on status and error messages as the utility loads data.

-v

Writes error information for debugging purposes to the utility log file. By default, the file is located in the same directory as the utility and is called default.pinlog. You can specify a different name and location in the Infranet.properties file.

-t

Checks the validity of the config_channel.xml file without creating the /channel object.

-r

Retrieves the contents of the /channel object and writes it to the XML file specified.

-h

Displays the syntax and parameters for this utility.

channel_config.xml

The XML file containing the channel definitions. A sample file (BRM_home/sys/data/config/channel_config.xml) is included, which you can edit to meet your business needs.

If you copy the channel_config.xml file to the same directory from which you run the load_channel_config utility, you don't have to specify either the path or the file name.

If you run the command in a different directory from where the load_channel_config pin.conf file is located, you must include the entire path for the file.

pin_channel_export

The Oracle Communications Billing and Revenue Management (BRM) LDAP Manager uses the pin_channel_export utility to collect channel events accumulated in the BRM database since the last run of this utility. After collecting all necessary information and translating the BRM object model to the directory server object model, the utility pushes the data to the LDAP directory servers.

Note:

To connect to the BRM database, the pin_channel_export utility needs a configuration file in the directory from which you run the utility. See "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.

Note:

To specify the time interval after which the utility runs and to specify whether to delete channel events from the Informant database after they are pushed to the LDAP directory server, edit the pin_channel_export utility's configuration file. See "Installing LDAP Manager".

For more information, see "About Channels and Data Propagation".

Location

BRM_home/apps/pinapps/exportapps

Syntax

pin_channel_export [-f family_ID]

Parameters

-f family_ID

Publishes channels with the specified family ID to the LDAP directory server specified in the channel definition. There must be one pin_channel_export instance running per family ID.

For example, the following command publishes channels with the family ID 100:

pin_channel_export -f 100