Synchronization Utilities

54 Synchronization Utilities

Learn about the syntax and parameters for the Oracle Communications Billing and Revenue Management (BRM) synchronization utilities.

Topics in this document:

object_auditing.pl

Use this utility to enable object auditing for storable classes and fields whose history is needed to keep data in Elastic Charging Engine (ECE) or Pipeline Manager synchronized with data in the BRM database.

Caution:

When installing wireless optional managers, you must install all optional wireless managers before running this utility. If you run this utility before installing an optional manager, object auditing for that optional manager's storable classes will fail.
If you are using a BRM multischema system, you must install all wireless managers, then install your multischema system, and then run the object_auditing.pl utility, in that order.

The utility turns on object auditing by invoking the pin_history_on utility with the -v and input file parameters. The utility then creates the specified audit table indexes using the create_indexes_audit_tables_oracle.source file. For more information about object auditing, see "Turning On Object Auditing".

Note:

To connect to the BRM database, the object_auditing.pl utility needs a configuration file in the directory from which you run the utility. See "About Connecting BRM Components".

Location

BRM_home/setup/scripts

Syntax

perl object_auditing.pl

Results

Look in the utility log file (default.pinlog) to find any errors. The log file is either in the directory from which the utility was started or in a directory specified in the configuration file.

pin_export_price

Use this utility to export pricing data from your BRM database in a batch to an Oracle Advanced Queuing (AQ) database queue.

This utility collects data about pricing data according to the criteria specified by the command-line parameters. The utility then triggers notification events that send the pricing data to the AQ database queue via the Payload Generator External Module (EM) and Oracle DM.

For more information about exporting pricing data in a batch, see "Exporting Pricing Data in a Batch".

Note:

The pin_export_price utility needs the configuration file in BRM_home/apps/pin_export_price. This configuration file must be in the directory from which you run the utility.
The configuration file also requires some performance-related configuration entries because pin_export_price is based on the BRM multithreaded application (MTA) framework. For more information, see "Configuring Your Multithreaded Application" in BRM Developer's Guide.

Location

BRM_home/bin

Syntax

pin_export_price [-product | -discount | -sponsorship | -deal | -plan | -planlist] 
                 [-S ServiceType1, ServiceType2,...] [-t modifiedTimestamp] 
                 [-verbose] [-help]

If you do not include a -product, -discount, -sponsorship, -deal, -plan, -planlist, or -S ServiceType parameter at the command line, the utility exports all pricing data.

Parameters

-product

Exports data about charge offers (/product objects) only.

-discount

Exports data about discount offers (/discount objects) only.

-sponsorship

Exports data about chargeshare offers (/sponsorship objects) only.

-deal

Exports data about bundles (/deal objects) only.

-plan

Exports data about packages (/plan objects) only.

-planlist

Exports data about package lists (/group/plan_list objects) only.

-S ServiceType1, ServiceType2,...

Exports pricing data for the specified service types. In place of ServiceType1 and ServiceType2, use the full name of a service type, such as /service/telco/gsm/telephony. Delimit multiple service types with a comma (,). Wildcards are not supported in service-type names.

For example:

-S /service/telco/gsm/telephony, /service/telco/gsm/data

Note:

Use this option with the -discount or -product parameter only.
The utility does not validate the name of the service type passed in with the parameter. If you pass an invalid service type, the utility does not return anything or report an error.

-t modifiedTimestamp

Exports pricing data modified on or after the specified timestamp in the format: YYYY-MM-DDThh:mm:ssTZ. For example:

-t 2030-07-16T19:20:30+01:00

-verbose

Displays information about successful or failed processing as the utility runs.

-help

Displays the syntax and parameters for this utility.

Results

To check the results of running this utility, look in the pin_export_price.pinlog log file for error messages. You specify the directory in which the log file is created in the utility's configuration file (pin.conf).

pin_history_on

Use this utility to enable object auditing for storable classes and fields whose history is needed to keep data in ECE or Pipeline Manager synchronized with data in the BRM database. For more information about object auditing, see "Turning On Object Auditing".

Use the object_auditing.pl utility to run this utility after installing all of your optional managers. See "object_auditing.pl".

To run this utility independently (not as part of the object_auditing.pl utility), you must also perform these tasks:

Manually modify entries in the Oracle DM configuration file to give the DM permission to write the objects in the input file to the database.
Create audit table indexes for the objects that you audit.

See "Running the pin_history_on Utility".

Note:

To connect to the BRM database, the pin_history_on utility needs a configuration file in the directory from which you run the utility. See "Connecting BRM Components".

Location

BRM_home/bin

Syntax

pin_history_on [-d | -v | -h] inputFile

Parameters

-d: Enables debugging mode.
-v: Displays information about successful or failed processing as the utility runs.

Note:

This parameter is always used with other parameters and commands. It is not position dependent. For example, you can enter -v at the beginning or end of a command to initiate the verbose parameter. To redirect the output to a log file, use the following syntax with the verbose parameter. Replace filename.log with the name of the log file:

pin_history_on any_other_parameter -v > filename.log
-h: Displays the syntax and parameters for this utility.
inputFile: The name of the file that specifies which object fields to audit. A sample pin_history_on file is included in the BRM_home/apps/integrate_sync directory.

Results

Look in the utility's default.pinlog file to find any errors. The log file is either in the directory from which the utility was started or in a directory specified in the configuration file.

pin_publish_aq_oracle.pl

Use this utility to create, drop, and monitor AQ database queues in your Oracle databases. The Oracle Data Manager (DM) uses these queues to:

Synchronize account data between BRM and Elastic Charging Engine (ECE). See "Synchronizing Account Data Between the BRM Database and ECE" for more information.
Synchronize pricing data between BRM and external customer relationship management (CRM) applications. See "Synchronizing Pricing Data Between the BRM Database and External CRMs" for more information.

Location

BRM_home/apps/pin_publish_aq

Syntax Overview

The utility supports the following actions:

Create an AQ database queue. See "Syntax for Creating a Queue".
Drop an AQ database queue. See "Syntax for Dropping a Queue".
Generate a report for an AQ database queue. See "Syntax for Generating a Queue Report".
Test an AQ database queue. See "Syntax for Testing a Queue".
List all AQ queues in the database. See "Syntax for Listing Queues".
Print the utility's syntax. See "Syntax for Getting Help".

Syntax for Creating a Queue

Creates the Oracle AQs queue, queue table, and database package in your database schema. The database package contains stored procedures for queuing, dequeuing, and purging business events.

pin_publish_aq_oracle.pl create -q queueName -t queueTable -r retentionTime -s storageClause
                                [-l /@databaseAlias]

Parameters for Creating a Queue

-q queueName -t queueTable

Specifies the name of the queue and queue table.

-s storageClause

Specifies the storage settings for the queue table. For example:

pin_publish_aq_oracle.pl create -s "tablespace PIN00 initrans 5 storage (initial 200k next 200k maxextents unlimited pctincrease 0 )"

If you omit this parameter, the utility uses the storage settings in the storagle_clause parameter of the BRM_home/apps/pin_publish_aq/create_aq_queue.conf file. See "Configuring the AQ Queue's Default Location".

-r retentionTime

Specifies the amount of time, in seconds, that processed events are retained in the database queue before being removed.

If you omit this parameter, the utility uses the retention time in the retention_time parameter of the BRM_home/apps/pin_publish_aq/create_aq_queue.conf file. See "Configuring the Default Retention for Events in the AQ Queue".

-l /@databaseAlias

Specifies how to connect to the database. For example:

pin_publish_aq_oracle.pl create -l /@pindb.example.com

The utility prompts you for this information if the parameter is omitted.

Syntax for Dropping a Queue

Drops the specified queue and its associated queue table from your database. If the database contains no other queues, this command also drops the database package, which contains stored procedures for queuing, dequeuing, and purging events.

pin_publish_aq_oracle.pl drop -q queueName [-l /@databaseAlias]

Parameters for Dropping a Queue

-q queueName: Specifies the name of the queue to drop.
-l /@databaseAlias: Specifies how to connect to the database. The utility prompts you for this information if the parameter is omitted.

Syntax for Generating a Queue Report

Generates a report that displays the state of each event in the specified queue.

pin_publish_aq_oracle.pl report -r summary|detail -q queueName [-l /@databaseAlias]

Parameters for Generating a Report

-r summary | detail

Generates the specified type of report:

-r summary generates a report summarizing the number of events in each state.
-r detail generates a report that details the ID, event state, queuing time, and dequeuing time for each event.

Events can be in the states listed in Table 54-1.

Table 54-1 Queue Event States

State	Description
READY	The event has not been dequeued or processed.
PROCESSED	The event was dequeued and processed.

-q queueName

Specifies the queue name.

-l /@databaseAlias

Specifies how to connect to the database. The utility prompts you for this information if the parameter is omitted.

Syntax for Testing a Queue

Tests the specified queue by attempting to queue and dequeue 20 test events. You run this command to verify that a newly created queue functions correctly.

pin_publish_aq_oracle.pl test -q queueName [-l /@databaseAlias]

Parameters for Testing a Queue

-q queueName: Specifies the name of the queue to test.
-l /@databaseAlias: Specifies how to connect to the database. The utility prompts you for this information if the parameter is omitted.

Syntax for Listing Queues

Lists all of the AQ queues in the current user's database.

pin_publish_aq_oracle.pl list [-l /@databaseAlias]

Parameters for Listing Queues

-l /@databaseAlias: Specifies how to connect to the database. The utility prompts you for this information if the parameter is omitted.

Syntax for Getting Help

Displays the syntax for the pin_publish_aq utility.

pin_publish_aq_oracle.pl help

Results

The pin_publish_aq_oracle.pl utility notifies you when it runs successfully. Otherwise, look in the default.pinlog file for errors. This file is either in the directory from which the utility was started or in the directory specified in the utility configuration file.