77 ECE Utilities

Learn about the syntax and parameters for the Oracle Communications Billing and Revenue Management Elastic Charging Engine (ECE) utilities.

Topics in this document:

configLoader

Use the configLoader utility to load mediation specification files into ECE. These files are used by Diameter Gateway and RADIUS Gateway. See ECE Implementing Charging and "Configuring the configLoader Utility".

Location

ECE_home/bin

Syntax

[start] [stop] configLoader

Parameters

-help

Displays the syntax for this utility.

Results

Results are written to the ECE_home/logs/configLoader.log file.

customerLoader

On a development system, use the customerLoader utility to load customer data into ECE from XML files. See ECE Implementing Charging and "Configuring the customerLoader utility".

In a production environment, use the customerLoader utility with the -incremental parameter to load customer data incrementally.

Caution:

Do not run the customerLoader utility without the -incremental parameter in a production environment.

Location

ECE_home/bin

Syntax

{start|stop} customerLoader [-incremental [customerupdaterfilename]] [-help]

Parameters

start

Starts customerLoader.

stop

Stops customerLoader.

-incremental customerupdaterfilename

Incrementally loads customer data. Use this parameter to selectively synchronize the BRM database and the ECE cache. This is typically done to manage data migration errors.

-help

Displays the syntax for customerLoader.

Results

Results are written to the ECE_home/logs/customerLoader.log file

To verify that the customer objects were loaded in the ECE cluster distributed cache, use the query tool to form CohQL queries on the cache name that stores the respective object. For example, you would look in the Customer cache.

encrypt.sh

Use the encrypt.sh utility to encrypt passwords that ECE uses for connecting to BRM and Pricing Design Center (PDC).

For more information, see "About Managing External Application Passwords".

Location

ECE_home/bin

Syntax

encrypt.sh string storepassword [-help]

Parameters

string

Specifies the new password to encrypt.

storepassword

Specifies the password to the keystore.

-help

Displays the syntax for this utility.

Results

The utility returns a message containing the encrypted value for the new password.

Results are written to the ECE_home/logs/encrypt.log file.

events_propagate_utility.pl

Use the events_propagate_utility.pl utility to propagate failed customer data updates from the suspense queue to the BRM Oracle DM database queue.

For more information, see "Managing Failed Customer Data Updates".

Location

ECE_home/brm_utils/

Copy event_propagate.sql and events_propagate_utility.pl from the ECE installation directory (ECE_home/brm_utils/) to your BRM machine (for example, BRM_home/sys/test/).

Syntax for Moving Events from Suspense Queue

Moves events from the suspense queue to the BRM Oracle DM database queue.

perl events_propagate_utility.pl move -s queue_name -d queue_name [-l user_id/password@oracle_sid] 
                                      -n number_of_events

Parameters for Moving Events from the Suspense Queue

The following parameters are used to move from the suspense queue to the BRM Oracle DM database queue:

-s queue_name

Specifies the suspense queue name.

-d queue_name

Specifies the BRM Oracle DM database queue name.

-l user_id/password@oracle_sid

Specifies the user ID and password to connect to the database.

-n number_of_events

Specifies the number of events that are being moved from the suspense queue.

Syntax for Listing All Queues

Lists all queues on a BRM machine.

perl events_propagate_utility.pl list [-l user_id/password@oracle_sid] 

Parameters for Listing All Queues

The following parameters are used to list all queues on a BRM machine:

-l user_id/password@oracle_sid

Specifies the user ID and password to connect to the database.

Syntax for Loading Data into Database

Loads data from the queue into the database.

perl events_propagate_utility.pl load [-l user_id/password@oracle_sid] 

Parameters for Loading Data into Database

The following parameters are used to load data into the database:

-l user_id/password@oracle_sid

Specifies the user ID and password to connect to the database.

Syntax for Purging Data from the Queue

Purges data from the suspense queue or BRM Oracle DM database queue.

perl events_propagate_utility.pl purge [-l user_id/password@oracle_sid] -q queue_name 

Parameters for Purging Data from Queues Events

The following parameters are used to purge data from the suspense queue and the BRM Oracle DM database queue:

-l user_id/password@oracle_sid

Specifies the user ID and password to connect to the database.

-q queue_name

Specifies the queue name on which data is purged.

Syntax for Getting Help

Displays the syntax for the events_propagate_utility script.

perl events_propagate_utility.pl help

Results

The events_propagate_utility script notifies you when it runs successfully. Otherwise, look in the logs.

gridSync

Use the gridSync utility in a disaster-recovery system. You use the gridSync utility to start the federation service to replicate data to the participant sites asynchronously and to also replicate all existing ECE cache data to the participant sites. See "Configuring ECE for Disaster Recovery".

Location

ECE_home/bin

Syntax

[-help] gridSync {start|stop|pause|replicate} [remoteClusterName]

Parameters

-help

Displays the syntax.

start

Starts the federation service to replicate the ECE cache data to the backup or remote production sites.

stop

Stops replicating ECE cache data to the backup or remote production sites.

pause

Pauses replication of ECE cache data to the backup or remote production sites.

replicate

Replicates all the existing ECE cache data to the backup or remote production sites.

remoteClusterName

Specify the name of the Coherence cluster in the backup site.

Results

Results are written to the ECE_home/logs/encrypt.log file.

pricingLoader

Use the pricingLoader utility to load sample pricing data into ECE from an XML file. On a development system, you use pricingLoader after ECE starts up to prime its cache with sample pricing data.

See ECE Implementing Charging and "Configuring the pricingLoader Utility".

Note:

  • Do not mix running pricingLoader and Pricing Updater on an ECE deployment.

  • Use pricingLoader only on a development system.

Location

ECE_home/bin

Syntax

[start] [stop] pricingLoader

Parameters

-help

Displays the syntax.