23 Services Framework Utilities

This chapter provides reference information for Oracle Communications Billing and Revenue Management (BRM) Services Framework utilities.

load_pin_network_elements

Use the load_pin_network_elements utility to load network elements used by SIM Manager and Number Manager into the /config/network_element object.

For more information, see "Installing and Configuring Number Manager and Number Administration Center" and "Installing and Configuring SIM Manager and SIM Administration Center".

Note:

You cannot load separate /config/network_element objects for each brand. All brands use the same object.

Important:

To connect to the Oracle Communications Billing and Revenue Management (BRM) database, the load_pin_network_elements utility needs a pin.conf 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_network_elements [-d] [-v] [-i|-r] pin_network_elements_file

Parameters

-d

Creates a log file for debugging purposes. Use this parameter for debugging when the utility appears to have run with no errors but the data has not been loaded into the database.

-v

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

-i

Appends all new network elements in the pin_network_elements file to the existing elements in the /config/network_element object. This is the default.

-r

Deletes the existing /config/network_element object and creates a new object with the network elements provided in the pin_network_elements file.

pin_network_elements_file

Specifies the name of the network elements file. The default file is BRM_Home/sys/data/config/pin_network_elements.

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 either in the directory from which the utility was run or in a directory specified in the pin.conf configuration file.

To verify that the network elements were loaded, you can display the /config/network_element object by using Object Browser, or use the robj command with the testnap utility. See "Reading an Object and Writing Its Contents to a File" in BRM Developer's Guide.

Important:

You must restart the Connection Manager (CM) to make new or changed settings available to BRM. See "Starting and Stopping the BRM System" in BRM System Administrator's Guide.

load_pin_service_framework_permitted_service_types

Use the Oracle Communications Billing and Revenue Management (BRM) load_pin_service_framework_permitted_service_types utility to load the list of non-telco service types that are supported by the Services Framework into the /config/service_framework/permitted_service_types object in the BRM database. You define the supported non-telco service types in the BRM_Home/sys/data/config/pin_service_framework_permitted_service_types.xml file.

For more information, see "Specifying the Non-Telco Services Supported by Services Framework".

Caution:

This utility overwrites pre-existing data in the /config/service_framework/permitted_service_types object. If you are adding new information, you must also include the pre-existing data in the pin_service_framework_permitted_service_types.xml file.

Important:

To connect to the BRM database, the load_pin_service_framework_permitted_service_types utility needs a pin.conf 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_service_framework_permitted_service_types [-f xml_file]
                                                      [-v] [-h]

Parameters

-f xml_file

The name and location of the XML file that defines the list of non-telco service types that are supported by Services Framework. By default, the utility uses the BRM_Home/sys/data/config/pin_service_framework_permitted_service_types.xml file.

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.

-v

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

-h

Displays the syntax and parameters for this utility.

Results

The utility notifies you when it successfully creates the /config/service_framework/permitted_service_types object or if it encountered errors. You can view more detailed error messages by looking in the default.pinlog file. 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_telco_provisioning

Use this utility to load your provisioning configuration into the Oracle Communications Billing and Revenue Management (BRM) database.

The provisioning configuration specifies the service, device, and profile object fields that need to be added to a provisioning service order. You specify the configuration in a provisioning configuration file (telco_prov_config_filename) and use that file as input for the utility. The default file is BRM_Home/sys/data/config/pin_telco_provisioning.

This utility creates the /config/telco/provisioning and /config/telco/provisioning/fieldlist configuration objects.

For information, see "Specifying the Details to Add to the Service Order".

Note:

You cannot load separate /config/telco/provisioning objects for each brand. All brands use the same object.

Important:

To connect to the BRM database, the load_pin_telco_provisioning utility needs a configuration file (pin.conf) in the directory from which you run the utility. See "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.

Caution:

This utility overwrites preexisting data in the /config/telco/provisioning object. If you are adding new field information, you must also include preexisting field information in the input file.

Location

BRM_Home/bin

Syntax

load_pin_telco_provisioning [-d] [-v] telco_prov_config_filename

Parameters

-d

Creates a log file for debugging purposes. Use this parameter for debugging when the utility appears to have run with no displayed errors, but mapping between events and opcode numbers do not appear to be loaded correctly.

-v

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

telco_prov_config_filename

The name and location of the telco_prov_config_filename file.

If you copy telco_prov_config_filename to the same directory from which you run the load_pin_telco_provisioning utility, you do not have to specify either the path or the file name.

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

Results

By default, load_pin_telco_provisioning notifies you only if it encounters errors. However, if you use the -v flag, the utility displays confirmation messages when running.

Important:

After you run this utility, you must restart the Connection Manager (CM). See "Starting and Stopping the BRM System" in BRM System Administrator's Guide.

load_pin_telco_service_order_state

Use this utility to load service order state configuration data for a specific telco service, such as GSM, into the Oracle Communications Billing and Revenue Management (BRM) database.

This utility creates the /config/telco/service_order_state configuration object.

Tip:

Use the instructions and examples included in BRM_Home/sys/data/config/pin_service_order_state file. For more information on BRM configuration files, see "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.

For information, see "Specifying the Available States for Each Service Order".

Note:

You cannot load separate /config/telco/service_order_state objects for each brand. All brands use the same object.

Important:

  • To connect to the BRM database, the load_pin_telco_service_order_state utility needs a configuration file (service_order_state_config_file) in the directory from which you run the utility. See "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.

  • Specify state configuration information for only one service in the configuration file (service_order_state_config_file) for this utility. Load a separate configuration file for each service.

Caution:

This utility overwrites pre-existing data in the /config/telco/service_order_state object for a particular service.

Location

BRM_Home/bin

Syntax

load_pin_service_order_state [-d] [-v] service_order_state_config_file 

Tip:

Use a naming convention to identify the input files for each service, as in this example:
load_pin_service_order_state -d -v pin_telco_service_order_state_gsm 

Parameters

-d

Creates a log file for debugging purposes. Use this parameter for debugging when the utility appears to have run with no displayed errors, but mapping between events and opcode numbers do not appear to be loaded correctly.

-v

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

service_order_state_config_file

The path and name of the service order state file that you are loading for a particular service.

If you copy service_order_state_config_file to the same directory from which you run the load_pin_service_order_state utility, you do not have to specify the path.

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

Results

load_pin_telco_service_order_state notifies you only if it encounters errors. However, if you use the -v flag, the utility displays confirmation messages when running.

Important:

After you run this utility, you must restart the Connection Manager (CM). See "Starting and Stopping the BRM System" in BRM System Administrator's Guide.

load_pin_telco_tags

Use the load_pin_telco_tags utility to load provisioning tags for telco services into the appropriate /config/telco/service object and account-level extended rating attributes (ERAs) into the /config/account_era object in the Oracle Communications Billing and Revenue Management (BRM) database.

You define telco provisioning tags and account-level ERAs in a pin_telco_tags_service file: for example, pin_telco_tags_gsm: located in BRM_Home/sys/data/config.

For more information, see "About Provisioning Tags for Telco Services", "Defining Provisioning Tags for Telco Services by Using the pin_telco_tags file", and "Defining Account-Level ERAs in the pin_telco_tags File".

Note:

You cannot load separate /config/account_era objects for each brand. All brands use the same object.

Important:

To connect to the BRM database, the load_pin_telco_tags 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.

Caution:

By default, the load_pin_telco_tags utility appends telco provisioning tags and account-level ERAs to the BRM database. But if you use the -x parameter, this utility overwrites existing telco provisioning tags and account-level ERAs. Do not use the -x parameter unless you are certain you want to overwrite existing objects.

Location

BRM_Home/bin

Syntax

load_pin_telco_tags [-d] [-v] [-h] [-x] pin_telco_tags_file

Parameters

-d

Creates a log file for debugging purposes. Use this parameter for debugging when the utility appears to have run with no displayed errors, but mapping between events and opcode numbers do not appear to be loaded correctly.

-v

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

Note:

This parameter is always used in conjunction 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:

load_pin_telco_tags any_other_parameter –v > filename.log

-h

Displays the syntax and parameters for this utility.

-x

Overwrites all account-level ERAs and telco provisioning tags in the database, including the provisioning tags created using Pricing Center, with those that are in the file.

Caution:

Use the -x parameter with care.
pin_telco_tags_file

The name and location of the pin_telco_tags file that you are loading. The default pin_telco_tags files are located in BRM_Home/sys/data/config.

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_telco_tags BRM_Home/sys/data/config/pin_telco_tags_gsm

Tip:

If you copy the pin_telco_tags file to the directory from which you run the load_pin_telco_tags utility, you do not have to specify the path. If you do not include a file name, the utility loads the default generic telco file, pin_telco_tags.

Results

The load_pin_telco_tags utility notifies you only if it encounters errors. However, if you use the -v parameter, the utility displays confirmation messages when running.

To verify that the objects were loaded, you can display the /config/telco_service object (for example, /config/telco/gsm) and the /config/account_era object by using the Object Browser, or use the robj command with the testnap utility. See "Reading an Object and Fields" in BRM Developer's Guide.

Important:

You must restart the Connection Manager (CM) to make new provisioning tags and ERAs available. See "Starting and Stopping the BRM System" in BRM System Administrator's Guide.