1. Configuring Pipeline Rating and Discounting
  2. Configuring Pipeline Discounting
  3. Discounting Utilities

38 Discounting Utilities

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

pin_discount_cleanup

Use this utility to change the status of expired discounts from active to canceled and to delete canceled discounts.

You use this utility to close or delete the discounts that are canceled in the middle of a cycle and the discount's validity rule is set to Full discount.

You can run this utility daily or add it to the pin_bill_day script to be run automatically.

Location

BRM_home/bin

Syntax

pin_discount_cleanup -m [close|delete] [-n days] [-d date] [-v] [-t] [-help]

Parameters

-m close|delete

Specifies whether to delete discounts when they are canceled:

  • close

    Changes the status of all active, expired discounts to canceled without deleting the discounts.

  • delete

    Deletes all expired discounts.

-n days

The number of days prior to -d date for which the expired discounts are retained. The utility changes the status to canceled for the discounts that expired more than -n days prior to -d date.

- d date

The end date (in the format MM/DD/YYYY) of the period in which discounts that expired are retained.

For example, if -n is 5 and -d is 07/15/2015, the status of the discounts that expired before 7/10/2015 are changed to canceled.

Note:

  • The expiry date cannot be greater than the current date. For instance, in the example above, if 7/10/2015 is greater than the current date, pin_discount_cleanup returns an error. Similarly, if only -d is specified, and is greater than the current date, pin_discount_cleanup returns an error.

  • If neither -n nor -d parameter is specified, the current date is used.

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

pin_discount_cleanup other_parameters –v > filename.log

-t

Displays the number of records processed (the number of discounts that were canceled.

-help

Displays the syntax and parameters for this utility.

Results

To check results of running this utility, look in the log file (normally default.pinlog) for error messages. The log file is located in the directory from which the utility was started or in a directory specified in the utility's configuration file (pin.conf).

load_pin_snowball_distribution

Use this utility to load snowball discount distribution rules into the /config/snowball_distribution object in the BRM database. You define how snowball discounts are distributed in the pin_snowball_distribution file in BRM_home/sys/data/pricing/example.

Note:

This utility overwrites existing distribution rules. If you are updating distribution rules, you cannot load new distribution rules only. You must load a complete set of distribution rules each time you run this utility.

Location

BRM_home/bin

Syntax

load_pin_snowball_distribution pin_snowball_distribution_file [-d] [-v]

Parameters

pin_snowball_distribution_file

The name and location of the file that defines the snowball distribution rules. The default pin_snowball_distribution file is in BRM_home/sys/data/pricing/example.

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_snowball_distribution BRM_home/sys/data/pricing/example
-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.

Note:

This parameter is always used in conjunction with other parameters. To redirect the output to a log file, use the following syntax:

load_pin_snowball_distribution other_parameter –v > filename.log