1. Installation Guide
  2. Installing Account Synchronization
  3. Account Synchronization Utilities

16 Account Synchronization Utilities

Learn about the Oracle Communications Billing and Revenue Management (BRM) account synchronization utilities.

Topics in this document:

object_auditing

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

Caution:

  • When installing optional managers, you must install all optional 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 use a multischema system, do the following:

    1. Install all optional managers.

    2. Run the run the pin_multidb.pl utility. For more information, see "Installing a Multischema System".

    3. Run the object_auditing.pl utility.

The object_auditing.pl utility turns on object auditing by invoking the pin_history_on utility with the -v and pin_history_on_input input file parameters. The utility then creates the specified audit table indexes by using the create_indexes_audit_tables_oracle.source file.

You define which objects are audited by editing the BRM_home/apps/integrate_sync/pin_history_on_input file before running this utility.

You customize the audit table indexes by editing the BRM_home/sys/dd/data/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 utility needs a configuration file in the directory from which you run the utility. See "Connecting BRM Utilities" in BRM System Administrator's Guide.

Location

BRM_home/setup/scripts

Syntax

perl object_auditing

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_history_on

Use this utility to enable object auditing for storable classes and fields whose history is needed to keep data in ECE 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".

Caution:

  • When installing optional managers, you must install all optional 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 use a multischema system, do the following:

    1. Install all optional managers.

    2. Run the run the pin_multidb.pl utility. For more information, see "Installing a Multischema System".

    3. Run the object_auditing.pl utility.

To run this utility independently (not as part of the object_auditing 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 "Manually Configuring Object Auditing".

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 Utilities" in BRM System Administrator's Guide.

Location

BRM_home/bin

Syntax

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

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.

pin_history_on_input

Name of the file that specifies which object fields to audit. A sample 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_ifw_sync_oracle

Use this utility to create, drop, and monitor Oracle DM queues in your BRM database.

Account synchronization uses these queues to send BRM business events to ECE. See "About Synchronizing Account Data between the BRM Database and ECE".

Location

BRM_home/apps/pin_ifw_sync

Syntax Overview

The following actions are supported for the BRM database:

Syntax for Creating a Queue

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

pin_ifw_sync_oracle.pl create [-l /@DatabaseAlias]
                              [-q queue_name -t queue_table] 
                              [-s storage_clause]
                              [-r retention_time]

Parameters for Creating a Queue

-l /@DatabaseAlias

Specifies how to connect to the database. For example:

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

If you omit this parameter, the utility prompts you for this information.

-q queue_name -t queue_table

Specifies the queue name and queue table name.

If you omit these parameters, the utility automatically creates a queue named IFW_SYNC_QUEUE and a queue table named IFW_SYNC.

-s storage_clause

Specifies the storage settings for the queue table.

If you omit this parameter, the storage settings are set by the storage_clause parameter in the BRM_home/apps/pin_ifw_sync/create_ifw_sync_queue.conf file. See "Configuring the Queue Location".

For example:

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

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 retention time is set by the retention_time parameter in the BRM_home/apps/pin_ifw_sync/create_ifw_sync_queue.conf file. See "Configuring How Often Processed Events Are Removed from the Queue".

Syntax for Dropping a Queue

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

pin_ifw_sync_oracle.pl drop [-q queue_name] [-l /@DatabaseAlias]

Parameters for Dropping a Queue

-q queue_name

Specifies the name of the queue to drop.

If you omit this option, the utility automatically drops the default queue, IFW_SYNC_QUEUE.

-l /@DatabaseAlias

Specifies how to connect to the database.

If you omit this option, the utility prompts you for this information.

Syntax for Generating a Report

Generates a report that displays the state of each event in an Oracle DM queue.

pin_ifw_sync_oracle.pl report -r summary|detail [-q queue_name]
                              [-l /@DatabaseAlias]

Parameters for Generating a Report

-r summary | detail

Generates the specified type of report.

  • -r summary generates a report that summarizes the number of events in each state. Events can be in the states listed in Table 16-1.

    Table 16-1 Oracle DM Database Queue Event States

    State Description

    READY

    The event has not been dequeued or processed by ECE.

    PROCESSED

    The event was dequeued and processed by ECE.

  • -r detail generates a report that details the ID, event state, queuing time, and dequeuing time for each event.

-q queue_name

Specifies the queue name.

If you omit this parameter, the utility automatically generates a report for the default queue, IFW_SYNC_QUEUE.

-l /@DatabaseAlias

Specifies how to connect to the database.

If you omit this parameter, the utility prompts you for this information.

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 properly.

Note:

You need to test a queue only after it is created.

pin_ifw_sync_oracle.pl test [-q queue_name] 
                            [-l /@DatabaseAlias]

Parameters for Testing a Queue

-q queue_name

Specifies the queue name.

If you omit this parameter, the utility automatically tests the default queue, IFW_SYNC_QUEUE, and default queue table, IFW_SYNC.

-l /@DatabaseAlias

Specifies how to connect to the database.

If you omit this parameter, the utility prompts you for this information.

Syntax for Listing Queues

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

pin_ifw_sync_oracle.pl list [-l /@DatabaseAlias]

Parameters for Listing Queues

-l /@DatabaseAlias

Specifies how to connect to the database.

If you omit this parameter, the utility prompts you for this information.

Syntax for Getting Help

Displays the syntax for the pin_ifw_sync_oracle utility. 

pin_ifw_sync_oracle.pl help

Results

The pin_ifw_sync_oracle 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.