Skip Headers
Oracle® Communications Billing and Revenue Management Setting Up Pricing and Rating
Release 7.5

E16711-09
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

31 Pricing Utilities

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

load_brm_pricing

Use this utility to load real-time and pipeline pricing data into the database. This utility runs the following utilities to load the pricing data:

  • loadpricelist loads the real-time pricing data into the BRM database.

  • LoadIfwConfig loads the pipeline pricing data into the Pipeline Manager database.

For more information, see the following topics:

Location

BRM_Home/bin

Syntax

Load data:

load_brm_pricing [-v] [-d] [-f] -c Real_time_data_filename -F Pipeline_data_filename

Retrieve data:

load_brm_pricing [-v] [-d] [-f] -r Real_time_data_filename -F Pipeline_data_filename [-P] [-D] [-S][-s ServiceType] [-t ModifiedTime] [-N name]

Get help:

load_brm_pricing -h

Parameters

-v

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

Note:

This parameter is always used with other parameters and commands.
-d

Creates a log file for debugging purposes. Use this parameter for troubleshooting when the utility runs with no errors but the event map is not loaded into the database.

-f

Executes the command without prompting for a confirmation.

-c Real_time_data_filename

Reads the pricing data from Real_time_data_filename and commits it to the BRM database.

Important:

When you use the -c parameter, it must immediately precede the file name. The -v, -d, and -f parameters can be used in any order, but must precede -c Real_time_data_filename.
-F Pipeline_data_filename

Reads the pricing data from or writes the pricing data to Pipeline_data_filename.

  • When used with the -c parameter, -F Pipeline data filename reads the pricing data from Pipeline data filename and commits it to the Pipeline Manager database.

  • When used with the -r parameter, -F Pipeline data filename retrieves the pricing data from the Pipeline Manager database and writes it to Pipeline data filename.

-r Real_time_data_filename [-P] [-D] [-S] [-s ServiceType] [-t ModifiedTime] [-N name]

Retrieves pricing objects from the BRM database and writes the pricing data to Real_ time_data_filename.

Important:

When you use the -r parameter, it must immediately precede the file name. The -v, -d, and -f parameters can be used in any order, but must precede -r and the file name. The parameters for determining the subset of information can be used in any order after the file name.

Use -r Real_ time_data_filename with no additional parameters to retrieve all types of pricing objects from the BRM database.

Use the following parameters with -r Real_ time_data_filename to retrieve only a subset of pricing objects from the BRM database:

  • -P retrieves only the /product objects from the database.

  • -D retrieves only the /discount objects from the database.

  • -S retrieves only the /sponsorship objects from the database.

  • -s ServiceType retrieves objects based on the specified service type. You can list multiple service types by using a comma (,) as a delimiter. For example: -s /service/telco/gsm/telephony,  /service/telco/gsm/data.

    Note:

    Do not use -s ServiceType with the -S parameter.
  • -t ModifiedTime retrieves objects that were modified after the specified timestamp. You specify time using the ISO-8601 standard. Table 31-1 lists the supported formats.

    Table 31-1 Supported Formats

    Format Time Zone

    YYYY

    Local time of system used to run load_brm_pricing.

    YYYY-MM

    Local time of system used to run load_brm_pricing.

    YYYY-MM-DD

    Local time of system used to run load_brm_pricing.

    YYYY-MM-DDThh:mmZ

    UTC

    YYYY-MM-DDThh:mm:ssZ

    UTC

    YYYY-MM-DDThh:mm[+|-]TZD

    TZD is the time zone relative to UTC. You can use a negative or positive offset from 00:00 to 12:00 (for example, -05:00 or +10:00).

    YYYY-MM-DDThh:mm:ss[+|-]TZD

    TZD is the time zone relative to UTC. You can use a negative or positive offset from 00:00 to 12:00 (for example, -05:00 or +10:00).


  • -N name retrieves objects based on the specified product, discount, or sponsorship.

    Note:

    You can use an asterisk (*) as a wildcard character to match zero or more characters in the name (for example, -N *GSM*). Use -N with -P, -D, or -S to indicate the object type to be retrieved.
-h

Displays the syntax for the load_brm_pricing utility.

Results

The load_brm_pricing utility notifies you when it successfully completes a command.

If the utility does not notify you that it was successful, look in the utility log 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 utility configuration file.

If an error occurs, enter the command again. The load_brm_pricing utility does not commit the pricing data to the database until it completes the command.

loadchangesets

Use this utility to import or export pipeline pricing data change sets. You can use the utility in interactive mode or non-interactive mode. In interactive mode, you enter single-word commands to perform individual actions.

You specify the BRM server to export from and the server to import to in a configuration file.

For more information, see "Exporting and importing change sets by using the loadchangesets utility" in BRM Configuring Pipeline Rating and Discounting.

Location

Pricing_Center_Home/lib

Syntax: Non-Interactive Mode

loadchangesets    [-v] [-fi change_set_file] 
                  [-v] [-fx change_set_file]

Parameters: Non-Interactive Mode

-v

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

-f change_set_file

Mandatory parameter that must precede -i and -x. Forces execution without prompting for confirmation.

-i change_set_file

When used with the -f parameter, imports change sets from change_set_file to the database. The file name must include the extension .exp.

When used alone, switches the utility to interactive mode. See "Syntax: Interactive Mode".

-x

When used with the -f parameter, exports the change sets from the database to change_set_file. Must be preceded with the -f parameter. The file name must include the extension .exp.

Syntax: Interactive Mode

loadchangesets -i

[read change_set_file]
[export]
[write change_set_file]
[import] 
[help]
[quit]
[list]

Parameters: Interactive Mode

-i

Switches the utility to interactive mode. After entering interactive mode, commands are single words without the utility name.

export

Exports change sets from the database into memory.

write change_set_file

Writes the change sets stored in memory to change_set_file. Be sure to include the file name extension .exp.

read change_set_file

Reads change sets from change_set_file and stores them in memory. The file name must include the extension .exp.

import

Imports the change sets stored in memory to the database.

list

Lists the change sets currently stored in memory.

help

Displays help the syntax for the utility.

quit

Exits the utility.

Results: Export

Exported files are initially created in the Pricing_Center_Home/export directory. The status of the exported change sets changes to Exported. If all change sets are exported successfully, the file moves automatically into the /export/done directory.

If there are any errors during export, the entire transaction is rolled back. In addition, the status of the change sets is automatically reset from Exported to In Progress.

Results: Import

The import process generates a log file called import.log.0. The log file contains information about validation errors, change sets that have passed validation, and change sets that have been imported successfully.

If all change sets are imported without any errors, the transaction is committed. If there are any errors, the entire transaction is rolled back.

load_event_map

Use this utility to load the event maps into the BRM database. You define the event maps in the BRM_Home/sys/data/pricing/example/pin_event_map file.

For more information about event maps, see "Mapping event types to services".

Caution:

The load_event_map utility overwrites the entire event map. If you are updating the event map, you cannot load new mappings only. You load the entire event map each time you run the load_event_map utility. The load_event_map utility does not restrict to load any particular event type with a service. However, if the service types and event pairs are duplicated, the load_event_map utility reports an error.

Note:

To connect to the BRM database, the load_event_map utility needs a configuration file in the directory from which you run the utility. See the discussion of configuration files in BRM System Administrator's Guide.

Location

BRM_Home/bin

Syntax

load_event_map [-d] [-v] pin_event_map_file

Parameters

-d

Logs messages to the default.pinlog file in the current directory, or in a directory specified in the utility configuration file. Use this parameter for troubleshooting when the utility runs with no errors, but the event map is not loaded into the database.

-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:

load_event_map other_parameter –v > filename.log

pin_event_map_file

The name and location of the file that defines event maps. The default is BRM_Home/sys/data/pricing/example/pin_event_map.

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

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

Results

The load_event_map 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_beid

Use this utility to load resources into the BRM database. You define the resources in the BRM_Home/sys/data/pricing/example/pin_beid file.

Tip:

It is easier to use the Resource Editor to define resources.

For more information about defining resources, see "About resources".

Caution:

  • The load_pin_beid utility overwrites the existing resources. If you are updating resources, you cannot load new resources only. You load complete sets of resources each time you run the load_pin_beid utility.

  • When you add or edit resources by using the Resource Editor, the Resource Editor does not update the pin_beid file. Therefore, if you want the pin_beid file to include all of your resources, you must edit it by hand.

Note:

To connect to the BRM database, the load_pin_beid utility needs a configuration file in the directory from which you run the utility. See the discussion of configuration files in BRM System Administrator's Guide.

Location

BRM_Home/bin

Syntax

load_pin_beid [-d] [-v] pin_beid_file

Parameters

-d

Sends all flists used in creating the resources to a log file. Use this parameter for debugging when the utility appears to have run with no errors, but the resources do not appear in the database.

-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:

load_pin_beid other_parameter –v > filename.log

pin_beid_file

The name and location of the file that defines resources. The default is BRM_Home/sys/data/pricing/example/pin_beid.

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

Results

The load_pin_beid utility notifies you only if it encounters errors.

Important:

You must restart the Connection Manager to make the new resources available.

load_pin_impact_category

Use this utility to load impact categories into the BRM database. You define the impact categories for the rate plan selector charges in the BRM_Home/sys/data/config/pin_impact_category file.

For information about impact categories, see "Using Event Attributes to Rate Events in Real Time".

Caution:

The load_pin_impact_category overwrites the existing impact categories. If you are updating a set of impact categories, you cannot load new impact categories only. You load complete sets of impact categories each time you run the load_pin_impact_category utility.

Note:

To connect to the BRM database, the load_pin_impact_category utility needs a configuration file in the directory from which you run the utility. See the discussion of configuration files in BRM System Administrator's Guide.

Location

BRM_Home/bin

Syntax

load_pin_impact_category pin_impact_category_file

Parameters

pin_impact_category_file

The name and location of the file that defines the impact categories. The default is BRM_Home/sys/data/config/pin_impact_category.

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

Results

The load_pin_impact_category utility notifies you when it successfully creates the /config/impact_category storable object.

If the load_pin_impact_category 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 started or in a directory specified in the utility configuration file.

Important:

You must restart the Connection Manager to make the new impact categories available.

load_pin_rum

You use this utility to load ratable usage metrics (RUMs) into the /config/rum storable object in the BRM database. You define RUMs in the BRM_Home/sys/data/pricing/example/pin_rum file.

For information about RUMs, see "About setting up RUMs for real-time rating".

Caution:

The load_pin_rum utility overwrites the existing RUMs. If you are updating a set of RUMs, you cannot load new RUMs only. You load complete sets of RUMs each time you run the load_pin_rum utility.

Note:

To connect to the BRM database, the load_pin_rum utility needs a configuration file in the directory from which you run the utility. See the discussion of configuration files in BRM System Administrator's Guide.

Location

BRM_Home/bin

Syntax

load_pin_rum [-d] [-v] pin_rum_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 RUMs do not appear in the database.

-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:

load_pin_rumother_parameter –v > filename.log

pin_rum_file

The name and location of the file that defines RUMs. The default is BRM_Home/sys/data/pricing/example/pin_rum.

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

Results

The load_pin_rum utility notifies you only if it encounters errors.

Important:

You must restart the Connection Manager to make the new RUMs available.

load_pin_spec_rates

Use this utility to set up charging for administrative events by loading the contents of the pin_spec_rates file into the BRM database.

For information about charging for administrative events, see "About Charging for Custom Events and Attributes".

Caution:

The load_pin_spec_rates overwrites the existing setup for administrative events charges. If you are updating a set of administrative events charges, you cannot load new charges only. You load complete sets of charges each time you run the load_pin_spec_rates utility.

Note:

To connect to the BRM database, the load_pin_spec_rates utility needs a configuration file in the directory from which you run the utility. See the discussion of configuration files in BRM System Administrator's Guide.

Location

BRM_Home/bin

Syntax

load_pin_spec_rates pin_spec_rates_file

Parameters

pin_spec_rates_file

The name and location of the file that maps opcodes to event types to be rated. The default is BRM_Home/sys/data/config/pin_spec_rates.

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

Results

If the load_pin_spec_rates 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 started or in a directory specified in the utility configuration file.

Important:

You must restart the Connection Manager for the new administrative event charges to take effect.

load_pin_sub_bal_contributor

Use this utility to load the configuration for contributor-based sub-balances into the BRM database. You define the sub-balance configuration in the BRM_Home/sys/data/pricing/example/pin_sub_bal_contributor file.

For information about contributor-based sub-balances, see "About tracking resources in account sub-balances".

Note:

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

Caution:

The load_pin_sub_bal_contributor utility overwrites the existing sub-balance configurations. If you are updating a set of sub-balance configurations, you cannot load new configurations only. You load complete sets of sub-balance configurations each time you run the load_pin_sub_bal_contributor utility.

Important:

  • The resources specified in the pin_sub_bal_contributor file must exist in the BRM database before running the load_pin_sub_bal_contributor utility. This includes any aggregation counters used to track consumption of resources that are shared among several accounts. Therefore, you must first load the pin_beid file by running the load_pin_beid utility. See "load_pin_beid".

  • To connect to the BRM database, the load_pin_sub_bal_contributor utility needs a configuration file in the directory from which you run the utility. See the discussion of configuration files in BRM System Administrator's Guide.

Location

BRM_Home/bin

Syntax

load_pin_sub_bal_contributor [-d] [-v] pin_sub_bal_contributor_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 sub-balance configurations have not been loaded into the database.

-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:

load_pin_sub_bal_contributor other_parameter –v > filename.log

pin_sub_bal_contributor_file

The name and location of the file that defines the configuration for contributor-based sub-balances. The default pin_sub_bal_contributor file is in BRM_Home/sys/data/pricing/sample.

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

Results

The load_pin_sub_bal_contributor utility notifies you when it successfully creates the /config/sub_bal_contributor storable object.

If the load_pin_sub_bal_contributor utility does not notify you that it was successful, look in the default.pinlog file to find any errors. This log file is either in the directory from which the utility was started or in a directory specified in the utility configuration file.

Important:

You must restart the Connection Manager to make the new sub-balance configurations available.

loadpricelist

Use this utility to prepare and commit price list information, such as products, deals, plans, offer profiles, and plan lists, to your BRM database. You define the price list or offer profile configurations by using the price_list.xsd file in the BRM_Home/PricingCenter directory.

Note:

The loadpricelist utility is the XML Pricing Interface.

Important:

  • The loadpricelist utility does not support the price list text format used by releases before Infranet Release 6.0.

  • Do not use the loadpricelist utility to assign custom rateable usage metrics (RUMs) to fold events in any rate plans. Fold events cannot use custom RUMs; therefore, products configured with them are rated incorrectly.

  • To connect to the BRM database, the CLASSPATH should point to an Infranet.properties file with the correct login information for the loadpricelist utility. The default Infranet.properties file is in the /common directory. To put the Infranet.properties file in the local directory with the loadpricelist utility, add period-slash (./) to the beginning of the CLASSPATH.

For information, see "Using the XML Pricing Interface to Create a Price List".

Location

BRM_Home/bin

Syntax: Non-Interactive Mode

Copy:

loadpricelist [-v] [-d] [-f] -c PriceListFile

Purge:

loadpricelist [-v] [-d] [-f] -p

Retrieve:

loadpricelist [-v] [-d] [-f] -r PriceListFile [-P] [-D] [-S] [-s ServiceType] [-t ModifiedTime]

Get help:

loadpricelist -h

Parameters: Non-Interactive Mode

-v

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

Note:

This parameter is always used with other parameters and commands.
-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.

-f

Executes the command without prompting for a confirmation.

-c PriceListFile

Reads the price list information from PriceListFile and commits it to the BRM database.

Important:

  • When you use the -c parameter, it must immediately precede the file name. The -v, -d, and -f parameters can be used in any order, but must precede -c and the file name.

  • PriceListFile must be in the same directory as the price_list.xsd file. If they are not in the same directory, edit the noNamespaceSchemaLocation entry in PriceListFile to include the full path to price_list.xsd. By default, price_list.xsd is in the BRM_Home\PricingCenter directory. For example, if the XSD file is located in C:\pricelists, change the entry to:

xsi:noNamespaceSchemaLocation="C:\pricelists\price_list.xsd"
-p

Purges pricing objects from the BRM database.

-r PriceListFile [-P] [-D] [-S] [-s ServiceType] [-t ModifiedTime]

Retrieves pricing objects from the BRM database and writes them to PriceListFile. When the infranet.batchsize entry is present in the loadpricelist Infranet.properties file, the utility retrieves objects in batches based on the value of the entry. See "Downloading Price Lists in Batches".

Use -r PriceListFile with no additional parameters to retrieve all types of pricing objects from the BRM database.

Use the following parameters with -r PriceListFile to retrieve only a subset of pricing objects from the BRM database:

  • -P retrieves only the /product objects from the database.

  • -D retrieves only the /discount objects from the database.

  • -S retrieves only the /sponsorship objects from the database.

  • -s ServiceType retrieves objects based on the specified service type. You can list multiple service types by using a comma (,) as a delimiter. For example: -s /service/telco/gsm/telephony,  /service/telco/gsm/data.

    Note:

    Do not use -s ServiceType with the -S parameter.
  • -t ModifiedTime retrieves objects that were modified after the specified timestamp. You specify time using the ISO-8601 standard. Table 31-2 lists the supported formats:

Table 31-2 Supported Formats

Format Time Zone

YYYY

Local time of system used to run loadpricelist.

YYYY-MM

Local time of system used to run loadpricelist.

YYYY-MM-DD

Local time of system used to run loadpricelist.

YYYY-MM-DDThh:mmZ

UTC

YYYY-MM-DDThh:mm:ssZ

UTC

YYYY-MM-DDThh:mm[+|-]TZD

TZD is the time zone relative to UTC. You can use a negative or positive offset from 00:00 to 12:00 (for example, -05:00 or +10:00).

YYYY-MM-DDThh:mm:ss[+|-]TZD

TZD is the time zone relative to UTC. You can use a negative or positive offset from 00:00 to 12:00 (for example, -05:00 or +10:00).


Important:

When you use the -r parameter, it must immediately precede the file name. The -v, -d, and -f parameters can be used in any order, but must precede -r and the file name. The parameters for determining the subset of information can be used in any order after the file name.
-h

Displays the syntax for the loadpricelist utility.

Syntax: Interactive Mode

loadpricelist    read PriceListFile 

                 write 
                   PriceListFile [planlist [type] | plan | 
                   | bestpricing | deal | product | discount | 
                   | sponsorship | offerprofile] [PriceObjectName]

                 write 
                   PriceListFile [dependency | transition]

                 delete 
                   [planlist [type] | plan | bestpricing | deal |
                   | product | discount | sponsorship |
                       offerprofile] [PriceObjectName]

                 delete 
                   [dependency | transition]

                 retrieve 
                   [-s ServiceType] [-t ModifiedTime] [product]
                     [discount] [sponsorship]

                 commit
                 purge
                 help
                 quit
                 verbose [on | off | debug]
                 list

Parameters: Interactive Mode

read PriceListFile

Reads the price list information from PriceListFile and stores it in internal memory as an flist.

Caution:

loadpricelist maintains only one flist. When you load the price list information from your database, loadpricelist removes the current flist and creates a new flist.

Important:

PriceListFile must be in the same directory as the price_list.xsd file. If they are not in the same directory, edit the noNamespaceSchemaLocation entry in PriceListFile to include the full path to price_list.xsd. By default, price_list.xsd is in the BRM_Home\PricingCenter directory. For example, if the XSD file is located in C:\pricelists, change the entry to: xsi:noNamespaceSchemaLocation="C:\pricelists\price_list.xsd"
write

Writes the price list information from the in-memory internal flist into PriceListFile.

write PriceListFile [planlist [type] | plan | bestpricing | deal | product | discount | sponsorship | offerprofile] [PriceObjectName]

write PriceListFile [dependency | transition]

Use write PriceListFile without any other parameters to write all pricing objects from the in-memory internal flist into PriceListFile.

Use the following parameters to write only a subset of pricing objects from the in-memory internal flist into PriceListFile:

  • planlist [type] specifies to write only plan list information into PriceListFile. You can optionally specify to write only a plan list object of a particular type into PriceListFile.

  • plan specifies to write only the /plan objects into PriceListFile.

  • bestpricing specifies to write only the /bestpricing objects into PriceListFile.

  • deal specifies to write only the /deal objects into PriceListFile.

  • product specifies to write only the /product objects into PriceListFile.

  • discount specifies to write only the /discount objects into PriceListFile.

  • sponsorship specifies to write only the /sponsorship objects into PriceListFile.

  • offerprofile specifies to write only the /offer_profile objects into PriceListFile.

  • PriceObject specifies to write only the specified pricing object into PriceListFile.

  • dependency specifies to write only /dependency objects into PriceListFile.

  • transition specifies to write only /transition information objects into PriceListFile.

delete

Deletes in-memory price list information from the BRM database.

delete [planlist [type] | plan | bestpricing | deal |
       | product | discount | sponsorship | offerprofile]
 [PriceObject] 

delete [dependency | transition]

Use delete without any other parameters to delete all in-memory pricing information from the database.

Use the following parameters to delete only a subset of in-memory pricing information from the database:

  • planlist [type] specifies to delete the plan list information of a particular type.

  • plan specifies to delete only the /plan objects from the database.

  • bestpricing specifies to delete only the /bestpricing objects from the database.

  • deal specifies to delete only the /deal objects from the database.

  • product specifies to delete only the /product objects and all related product information, such as the rate plan, rate, rate tier, and balance impact, from the database.

  • discount specifies to delete only the /discount objects from the database.

  • sponsorship specifies to delete only the /sponsorship objects from the database.

  • offerprofile specifies to delete only the /offer_profile objects from the database.

  • PriceObject specifies to delete only the specified pricing object from the database.

  • dependency specifies to delete only /dependency objects.

  • transition specifies to delete only /transition objects.

retrieve

Retrieves the specified price list objects from the BRM database and stores it in internal memory as an flist.

retrieve    [-s ServiceType] [-t ModifiedTime] [product]
            [discount] [sponsorship]

Use retrieve without any other parameters to retrieve all pricing objects from the BRM database.

Use the following parameters to retrieve only a subset of pricing objects from the BRM database:

  • -s ServiceType retrieves objects based on the specified service type. Multiple service types are delimited with a comma (,).

    Do not use this parameter with the sponsorship parameter.

  • -t ModifiedTime retrieves objects that were modified after the specified time. You specify time using the ISO-8601 standard. Table 31-3 lists the supported formats:

    Table 31-3 Supported Formats

    Format Time Zone

    YYYY

    Local time of system used to run loadpricelist.

    YYYY-MM

    Local time of system used to run loadpricelist.

    YYYY-MM-DD

    Local time of system used to run loadpricelist.

    YYYY-MM-DDThh:mmZ

    UTC

    YYYY-MM-DDThh:mm:ssZ

    UTC

    YYYY-MM-DDThh:mm[+|-]TZD

    TZD is the time zone relative to UTC. You can use a negative or positive offset from 00:00 to 12:00 (for example, -05:00 or +10:00).

    YYYY-MM-DDThh:mm:ss[+|-]TZD

    TZD is the time zone relative to UTC. You can use a negative or positive offset from 00:00 to 12:00 (for example, -05:00 or +10:00).


  • product retrieves only the /product objects from the database.

  • discount retrieves only the /discount objects from the database.

  • sponsorship retrieves only the /sponsorship objects from the database.

commit

Commits the pricing information to the database.

purge

Removes all price objects from the database.

help

Displays the syntax for the loadpricelist utility.

quit

Exits the utility.

verbose on | off | debug

Sets verbose information.

  • verbose on displays the status of the command most recently executed.

  • verbose off displays the status only if there is an error.

  • verbose debug logs the status of the command to the log file specified in the Infranet.properties file. The default log file is javapcm.log.

list

Prints to the screen all price list information currently stored in internal memory. Because the in-memory price list is in flist format, the utility displays the price list in flist format.

Results

The loadpricelist utility notifies you when it successfully completes a command.

If the utility does not notify you that it was successful, look in the javapcm.log file to find any errors. This log file is either in the directory from which the utility was started or in a directory specified in the Java property file.

If an error occurs, enter the command again. The loadpricelist utility does not save changes until it completes the command.

load_usage_map

Use this utility to load the usage map into the config/usage_map/system storable object in the BRM database. You define the usage map in the BRM_Home/sys/data/pricing/example/pin_usage_map file.

For more information, see "Mapping event types to RUMs".

Caution:

The load_usage_map overwrites the existing usage maps. If you are updating a set of usage maps, you cannot load new usage maps only. You load complete sets of usage maps each time you run the load_usage_map utility.

Note:

To connect to the BRM database, the load_usage_map utility needs a configuration file in the directory from which you run the utility. See the discussion of configuration files in BRM System Administrator's Guide.

Location

BRM_Home/bin

Syntax

load_usage_map [-d] [-v] pin_usage_map_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 usage maps do not appear in the database.

-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:

load_usage_map other_parameter –v > filename.log

pin_usage_map_file

The name and location of the file that defines usage maps. The default is BRM_Home/sys/data/pricing/example/pin_usage_map.

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

Results

The load_usage_map utility notifies you only if it encounters errors.

Universal Event Loader

Use the Universal Event (UE) Loader to load event records from event log files into the BRM database. For information about loading events, see "About Rating Events Created by External Sources" and "Loading Events from External Sources".

Note:

To connect to the database, the UE Loader needs a configuration file in the directory from which you run the utility. See the discussion of configuration files in BRM System Administrator's Guide.

UE Loader runs in three modes:

  • Preprocessing mode (-m parse). In the preprocessing mode, UE Loader parses the event log file and writes data to an intermediate file, including which accounts to load events for.

  • Event loading mode (-m load). In event loading mode, UE Loader uses the data in the intermediate file (created in preprocessing mode) to load events into the BRM database.

  • Combined mode. Use combined mode to run both preprocessing and event loading modes without stopping. This is the default mode.

UE Loader records all errors that occur in these modes in the log file BRM_Home/apps/uel/event_log_file_name_lerr.xml. It also records all event load successes in the log file BRM_Home/apps/uel/event_log_file_name_lsucc.xml.

For details, see "Troubleshooting Event Loading".

Location

BRM_Home/apps/uel

Syntax

uel -t template_name [-v] [-m parse | load] [-test] event_log_file_name 

Parameters

-t template_name

The name of the event import template.

-v

Sends error messages or debug messages to the console according to the debug level you set in the Infranet.properties file.

-m parse | load

The mode of operation. You specify the mode of operation only when testing the import template. When you load events in a production database, you do not need to specify the mode of operation.

  • Use parse to read the event log file and store the results in an intermediate cache file instead of in the BRM database.

  • Use load to load the results contained in the intermediate cache file that was created by using the parse entry. The UE Loader loads the events into the BRM database.

  • To parse the event log file and load events in one operation, do not enter the -m parameter. This is the default mode in a production database.

-test

Runs the program, but loads events in calculate-only mode. To test how events are loaded, read the output flist.

event_log_file_name

The file name of the event log file from which you are loading events.

Note:

Do not enter the file path of the event log file. You specify the file path in the properties file. See "Specifying the Event Log File Location".

Results

For information about troubleshooting UE Loader, see "Troubleshooting Event Loading".