Revenue Assurance Utilities

load_ara_config_object

Use the load_ara_config_object utility to specify how to check for duplicate audit objects. This utility loads data into the /config/process_audit_conf object in the BRM database.

Caution:

The load_ara_config_object utility overwrites existing /config/process_audit_conf objects. If you are updating existing configuration data, you cannot load new configuration data only. You must load a complete set of configuration data each time you run the load_ara_config_object utility.

Note:

To connect to the BRM database, the load_ara_config_object 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/bin

Syntax

load_ara_config_object pin_config_audit_conf_file

Parameters

pin_config_audit_conf_file

The name and location of the file that defines the /process_audit object fields used for performing duplicate checks. By default, the utility uses the BRM_home/sys/data/config/pin_config_audit_conf file.

Tip:

The file must be named pin_config_audit_conf.

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

Results

The load_ara_config_object utility notifies you only if it encounters errors. Look in the default.pinlog file for errors. This file is either in the directory from which the utility was started or in a directory specified in the utility configuration file.

load_pin_config_ra_alerts

Use the load_pin_config_ra_alerts utility to configure email details in the /config/ra_alerts object in the BRM database. You define the email details in the pin_config_ra_alerts file in BRM_home/sys/data/config.

See "Configuring Email Alerts".

Caution:

The load_pin_config_ra_alerts utility overwrites existing /config/ra_alerts objects. If you are updating revenue assurance alerts, you cannot load new alerts only. You must load complete sets of alerts each time you run the load_pin_config_ra_alerts utility.

Note:

To connect to the BRM database, the load_pin_config_ra_alerts 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/bin

Syntax

load_pin_config_ra_thresholds pin_config_ra_alerts

Parameters

pin_config_ra_alerts

The name and location of the file that contains the configured alert. The default pin_config_ra_alerts file is in BRM_home/sys/data/config.

The pin_config_ra_alerts file contains the rules for configuring email details and includes an example. You can customize this example and configure your email details.

If you do not run the utility from the directory in which the file is located, you must include the complete path to the file. For example:

load_pin_config_ra_thresholds BRM_home/sys/data/config/pin_config_ra_alerts

Tip:

If you copy the pin_config_ra_alerts file to the directory from which you run the load_pin_config_ra_alerts utility, you do not have to specify the path or file name. The file must be named pin_config_ra_alerts.

Results

The load_pin_config_ra_alerts utility notifies you when it successfully creates the /config/ra_alerts object. Otherwise, look in the default.pinlog file for errors. This file is either in the directory from which the utility was started or in a directory specified in the utility configuration file.

To verify that the alerts were loaded, display the /config/ra_alerts object by using the Object Browser or by using the robj command with the testnap utility. See "Reading an Object and Writing its Contents to a File" in BRM Developer's Guide.

load_pin_config_ra_flows

Use the load_pin_config_ra_flows utility to load revenue assurance flows into the /config/ra_flows object in the BRM database. You define the flows in the pin_config_ra_flows file in BRM_home/sys/data/config.

Caution:

The load_pin_config_ra_flows utility overwrites existing flows. If you are updating flows, you cannot load new flows only. You must load complete sets of flows each time you run the load_pin_config_ra_flows utility.

Note:

To connect to the BRM database, the load_pin_config_ra_flows 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/bin

Syntax

load_pin_config_ra_flows pin_config_ra_flows

Parameters

pin_config_ra_flows

The name and location of the file that contains the configured flows. The default pin_config_ra_flows file is in BRM_home/sys/data/config.

The pin_config_ra_flows file contains the rules for configuring flows and includes an example. You can customize this example and configure flows.

If you do not run the utility from the directory in which the file is located, you must include the complete path to the file. For example:

load_pin_config_ra_flow BRM_home/sys/data/config/pin_config_ra_flows

Tip:

If you copy the pin_config_ra_flows file to the directory from which you run the load_pin_config_ra_flows utility, you do not have to specify the path or file name. The file must be named pin_config_ra_flows.

Results

The load_pin_config_ra_flows utility notifies you when it successfully creates the /config/ra_flows object. Otherwise, look in the default.pinlog file for errors. This file is either in the directory from which the utility was started or in a directory specified in the utility configuration file.

To verify that the flows were loaded, display the /config/ra_flows object by using the Object Browser or by using the robj command with the testnap utility. See "Reading an Object and Writing its Contents to a File" in BRM Developer's Guide.

load_pin_config_ra_thresholds

Use the load_pin_config_ra_thresholds utility to load revenue assurance alert threshold details into the /config/ra_thresholds object in the BRM database. You define these thresholds in the pin_config_ra_thresholds file in BRM_home/sys/data/config.

See "Configuring Alert Thresholds" in BRM Collecting Revenue Assurance Data.

Caution:

The load_pin_config_ra_thresholds utility overwrites existing thresholds. If you are updating revenue assurance thresholds, you cannot load new thresholds only. You must load complete sets of thresholds each time you run the load_pin_config_ra_thresholds utility.

Note:

To connect to the BRM database, the load_pin_config_ra_thresholds 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/bin

Syntax

load_pin_config_ra_thresholds pin_config_ra_thresholds

Parameters

pin_config_ra_thresholds

The name and location of the file that contains the configured threshold details. The default pin_config_ra_thresholds file is in BRM_home/sys/data/config.

The pin_config_ra_thresholds file contains the rules for configuring thresholds and includes an example. You can customize this example and configure thresholds.

If you do not run the utility from the directory in which the file is located, you must include the complete path to the file. For example:

load_pin_config_ra_thresholds BRM_home/sys/data/config/pin_config_ra_thresholds

Note:

If you copy the pin_config_ra_thresholds file to the directory from which you run the load_pin_config_ra_thresholds utility, you do not have to specify the path or file name. The file must be named pin_config_ra_thresholds.

Results

The load_pin_config_ra_thresholds utility notifies you when it successfully creates the /config/ra_thresholds object. Otherwise, look in the default.pinlog file for errors. This file is either in the directory from which the utility was started or in a directory specified in the utility configuration file.

To verify that the alert thresholds were loaded, display the /config/ra_thresholds object by using the Object Browser or by using the robj command with the testnap utility. See "Reading an Object and Writing its Contents to a File" in BRM Developer's Guide.

pin_ra_check_thresholds

Use the pin_ra_check_thresholds utility to notify you when the /config/re_thresholds object contains revenue assurance alerts. Alerts are loaded into this object if the revenue assurance thresholds you configured are crossed.

See "Configuring Alert Thresholds".

Note:

To connect to the BRM database, the pin_ra_check_thresholds 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. You can change the configuration logfile and loglevel entries as needed.

Location

BRM_home/bin

Syntax

pin_ra_check_thresholds

Parameters

There are no parameters for the pin_ra_check_thresholds utility.

Results

The pin_ra_check_thresholds utility returns the values listed in "Return Values" and logs other information in the revenue assurance log file. This log file is either in the directory from which the utility was started or in a directory specified in the utility configuration file.

Return Values

pin_ra_check_thresholds returns the following:

0: Success
1: Error opening the PCM connection
2: The /config/thresholds object is not present
3: All other errors