89 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 {-help}
Results
Results are written to the ECE_home/logs/configLoader.log file.
customerLoader
Use the customerLoader utility to load customer data incrementally into ECE, in batches or in bulk. See ECE Implementing Charging.
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
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 events_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 Overview
The following actions are supported for events_propagate_utility:
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@connection] -n number_of_events
Parameters for Moving Events from the Suspense Queue
The following parameters are used to move events 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@connection
-
Provides the user ID and connection for connecting to the database. If not provided, the script prompts for them. The script always prompts for the password.
- -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@connection]
Parameters for Listing All Queues
The following parameters are used to list all queues on a BRM machine:
Syntax for Loading Data into Database
Loads data from the queue into the database.
perl events_propagate_utility.pl load [-l user_id@connection]
Parameters for Loading Data into Database
The following parameters are used to load data into 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@connection] -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:
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.
preselect_customers.sh
Use the preselect_customers.sh utility to load a subset of customer data into ECE cache.
For more information, see "Loading a Subset of Customer Data".
Location
ECE_home/bin
Syntax
The following actions are supported for preselect_customers.sh:
-
If SSL is enabled:
preselect_customers.sh -s dbHost -o oracleSID -c dbPort -n noOfDBConnections -f dbFetchSize -d false -e true -v sslType -l walletPath -y walletType -x sslServerCertDN -t oraFilesLocation -m tlsVersion
-
If SSL is not enabled:
preselect_customers.sh -s dbHost -o oracleSID -c dbPort -n noOfDBConnections -f dbFetchSize -d aaDisRec -e false
Parameters
The following parameters are used:
- -s dbHost
-
Specifies the host name or IP address of the BRM database user.
- -o oracleSID
-
Specifies the Oracle database alias.
- -c dbPort
-
Specifies the number for the Oracle database port.
- -n noOfdbConnections
-
Specifies the number of connections to use when retrieving BRM customer data from the database.
You must set noOfdbConnections and the Customer Updater dbConnections parameter to the same value.
- -f dbFetchSize
-
Specifies the number of records to fetch from the database at one time.
You must set dbFetchSize and the Customer Updater dbFetchSize parameter to the same value.
- -d aaDisRec
-
Specifies whether ECE is deployed in an active-active disaster recovery system. The possible values are true and false.
- -e SSL
-
Set to true if SSL is enabled, and false if SSL is not enabled.
- -v sslType
-
Specifies the type of SSL connection required for connecting to the database. The possible values are oneway and twoway.
- -I walletPath
-
Specifies the location of the SSL database wallets.
- -y walletType
-
Specifies the type of wallet. The possible values are SSO and PKCS12.
- -x sslServerCertDN
-
Specifies the SSL server certificate distinguished name (DN). The default value is DC=local,DC=oracle,CN=pindb.
- -t oraFilesLocation
-
Specifies the location of the client's tnsnames.ora and sqlnet.ora files.
- -m tlsVersion
-
Specifies the TLS version that is supported. The possible values are 1.2 and 1.3.
Results
If the utility does not notify you that it was successful, look in the default.pinlog file to find any errors. This file is in the directory from which the utility was run.