Skip Headers
Oracle® Communications Billing and Revenue Management Managing Accounts Receivable
Release 7.5

E16695-08
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
PDF · Mobi · ePub

11 Accounts Receivable Utilities

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

load_pin_ar_taxes

Use this utility to load configurable tax information into the /config/ar_taxes object in the BRM database.

This information enables BRM to correctly calculate tax reversals for particular event types during adjustments, disputes, and settlements. Typically, you define this type of tax information in the BRM_Home/sys/data/config/pin_config_ar_taxes.xml file, where BRM_Home is the directory in which BRM is installed. You can optionally place the file in a different location or use a different file name.

For information on the contents and format of the pin_config_ar_taxes.xml file, see "Configuring Taxes for Adjustments, Disputes, and Settlements".

Note:

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

Caution:

The load_pin_ar_taxes utility overwrites the existing tax information that BRM uses for the various adjustments and dispute events types. If you are updating the current tax information base to add event types or change the tax specifications for an event type, you cannot load the new tax information only. You must load complete sets of tax information for all event types you want to treat as taxable each time you run the load_pin_ar_taxes utility.

Important:

To connect to the BRM database, load_pin_ar_taxes requires a configuration file in the directory from which you run the utility. The pin.conf file for this utility is in BRM_Home/apps/pin_ar_taxes. Also, you must restart the Connection Manager (CM) to make new tax calculation information available. For more information on the configuration file and restarting CM, see "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.

Location

BRM_Home/bin

Syntax

load_pin_ar_taxes [-v] [-h] -f input_file.xml

Parameters

-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_ar_taxes other_parameter –v > filename.log

-h

Displays the utility's syntax and parameters.

-f input_file.xml

Specifies the name and location of the file that defines the configurable tax information; for example, C:\taxconf\adjust_taxes.xml. If you do not specify the -f parameter and a path, load_pin_ar_taxes looks for a file named pin_config_ar_taxes.xml in the directory from which you started the utility. You can use the BRM_Home/sys/data/config/pin_config_ar_taxes.xml file as a basis for creating a configuration file that suits your needs.

pin_apply_bulk_adjustment

Use this BRM command-line utility to apply an adjustment across a broad range of accounts, such as all accounts charged a regular day-time rate when they should have been charged a holiday rate.

This utility reads information on how to apply the bulk adjustment from a CSV format text file that you supply. The CSV file specifies the account POIDs and balance groups that BRM will adjust, the amount of the adjustment, and whether the adjustment should include taxes.

Note:

To connect to the BRM database, pin_apply_bulk_adjustment needs a configuration file in the BRM_Home/apps/pin_bulk_adjust directory. You can define the name and level of the log file generated by this utility in the configuration file. For information on creating the configuration file, see "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.

For information on the contents and format of the CSV file, see "About Adjusting Multiple Accounts Simultaneously".

Location

BRM_Home/bin

Syntax

pin_apply_bulk_adjustment [-v] [-h] -f input_file.csv

Parameters

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

pin_apply_bulk_adjustment other_parameter –v > filename.log

-h

Displays the utility's syntax and parameters.

-f input_file.csv

Specifies the name and location of the file that specifies how BRM will apply the bulk adjustment; for example, C:\bulkadj\bulk_run_1.csv.

Results

Each account adjustment initiated during a bulk adjustment is handled as a separate transaction. Therefore, if any single adjustment in the bulk adjustment fails, BRM does not need to roll back the entire bulk adjustment. Rather, the adjustment remains in place for all accounts that had successful adjustments, and the utility identifies the accounts that failed to adjust so you can correct the problem. The utility provides this feedback in a log file (default.pinlog) that it generates in its start directory or in a directory specified by the configuration file.

pin_mass_refund

This utility creates a refund item for accounts that have a credit balance.

Refund items are used by the pin_refund utility to give refunds, and by Payment Tool to close refunds made to accounts that use the invoice payment method.

Location

BRM_Home/bin

Syntax

pin_mass_refund   -active | close | inactive 
                  [-pay_type payment_method]
                   [-test] [-verbose] [-help]

Parameters

-active | close | inactive

Specifies the status of the accounts for which to create refund items.

-pay_type payment_method

Specifies the payment method. There are three possible values:

  • 10003 for credit card

  • 10005 for direct debit

  • 10018 for SEPA

Payment methods are defined in BRM_Home/include/pin_pymt.h.

-test

Finds the bill units that meet the criteria but does not create any refund objects.

-verbose

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 -verbose 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_mass_refund other_parameter –verbose > filename.log

-help

Displays syntax and parameters for this utility.

Results

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

pin_monitor_balance

Use this utility to update monitored balances and to check whether the balances have crossed thresholds.

For more information on using the pin_monitor_balance utility, see "Running pin_monitor_balance to Update Monitored Balances".

Note:

To connect to the BRM database, this utility needs a configuration file in the directory from which you run it. The pin.conf file for this utility is in BRM_Home/apps/pin_monitor. See "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.

Location

BRM_Home/bin

Syntax

pin_monitor_balance [-d] [-v] [-t] [-h]

Parameters

-d

Prints error logs for debugging.

-v

Displays detailed information on status and error messages as the utility updates balances and generates notification events.

-t

Runs a test to find out how many accounts meet the criteria without performing the action. The test has no effect on the accounts. This is most useful when run with the -v option.

-h

Displays the syntax and parameters for this utility.

Results

This utility generates notification events when a balance crosses a credit threshold. It logs errors in the log file, which is either in the directory from which the utility was started or in a directory specified in the configuration file.

pin_refund

This utility finds accounts that have refund items and makes online refund transactions.

When you use multiple payment processors, you run this utility for each one. See "Using More Than One Payment Processor" in BRM Configuring and Collecting Payments.

For information about refunds, see "About Refunds".

Note:

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

Important:

For multischema systems, you must run the utility separately against each database schema in your system. See "Running Non-MTA Utilities in Multischema Systems" in BRM System Administrator's Guide.

Location

BRM_Home/bin

Syntax

pin_refund   -pay_type payment_type_indicator
             [-vendor] payment_processor_name 
             [-active | close | inactive]
             [-verbose] [-test] [-help]

Parameters

-pay_type payment_type_indicator

Specifies the payment type. There are three possible values:

  • 10003 for credit card

  • 10005 for direct debit

  • 10018 for SEPA

Payment types are defined in BRM_Home/include/pin_pymt.h.

-vendor payment_processor_name

Specifies the credit card processor or automated clearing house (ACH) to use for validating credit cards, debit cards, and direct debit transactions. This parameter is used to get the payment processor information from the /config/ach object.

This parameter is not applicable for the SEPA payment type.

For information on configuring payment processor information, see "Setting Up Merchants and Payment Processors" in BRM Configuring and Collecting Payments.

-active | close | inactive

Specifies the status of the accounts to give refunds to.

-verbose

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

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_refund –verbose > filename.log

Note:

If a file with the same name exists, it is overwritten.
-test

Returns the number of refund items that would be created, but does not create any refund items.

-help

Displays syntax and parameters for this utility.

Results

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

When it is called internally by the pin_bill_day script, the pin_refund utility logs error information in the pin_billd.pinlog file.