General Ledger Utilities

11 General Ledger Utilities

Learn about the syntax and parameters for the Oracle Communications Billing and Revenue Management (BRM) general ledger (G/L) utilities and scripts.

Topics in this document:

load_pin_config_export_gl

Use this utility to configure general ledger exporting. See "Configuring Preview and Monthly Report XML Output Files" for more information.

This utility loads configuration data into the BRM database from the BRM_home/sys/data/config/pin_config_export_gl.xml file.

Location

BRM_home/bin

Syntax

load_pin_config_export_gl pin_config_export_gl.xml [-d] [-v] [-h]

Parameters

pin_config_export_gl.xml: The file to load.
-d: Creates a log file for debugging.
-v: Displays information as the utility runs.
-h: Displays the utility parameters.

Results

The utility notifies you only if it encounters errors.

load_pin_glchartaccts

Use this utility to load a chart of accounts (COA) into the BRM database.

See "Setting Up Your General Ledger" for information.

Location

BRM_home/bin

Syntax

load_pin_glchartaccts [-d] [-t] [-v] [-h] pin_glchartaccts_file

Parameters

-d: Creates a log file for debugging.
-t: Runs the utility in test mode. The COA is not loaded into the database.
-v: Displays information as the utility runs.
-h: Displays the utility parameters.
pin_glchartaccts_file: The file to load.

Results

The load_pin_glchartaccts utility notifies you only if it encounters errors.

load_pin_glid

Use this utility to load G/L IDs into the BRM database.

See "About Collecting General Ledger Data".

Location

BRM_home/bin

Syntax

load_pin_glid [-d] [-t] [-v] pin_glid_file |[-h]

Parameters

-d: Creates a log file for debugging.
-t: Runs the load_pin_glid utility in test mode. G/L IDs are not loaded into the database.
-v: Displays information as the utility runs.
-h: Displays the utility parameters.
pin_glid_file: The name and location of the file that defines the G/L IDs.

Results

The load_pin_glid utility notifies you when it successfully creates the G/L IDs.

If the utility displays an error message, 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.

Note:

You must restart the Connection Manager (CM) for any changes to take effect.

pin_ledger_report

Use this utility to collect BRM general ledger (G/L) information, generate G/L reports, and export the reports to XML files.

Important:

For multischema systems, you must run the utility separately against each database schema in your system.

For more information, see the following:

Location

BRM_home/bin

Syntax Overview

You can use the -mode parameter to run this utility in these modes:

"run_report Mode Syntax" runs the report. You can choose whether to post the report or not.
"post_only Mode Syntax" posts the report but does not display the report or write it to a file.
"list_previous Mode Syntax" lists previously run reports.
"export Mode Syntax" exports the report to an XML file.

run_report Mode Syntax

Creates an individual report that you can view in Oracle Analytics Publisher or BI Publisher.

See "Creating Individual G/L Reports with pin_ledger_report".

pin_ledger_report -mode run_report
                  [-start start_date]
                  [-end end_date]
                  [-segment gl_segment]
                  [-type billed | unbilled 
                        billed_earned | billed_unearned |
                        unbilled_earned | unbilled_unearned |
                        prev_billed_earned] 
                  [-report file_name]
                  [-summary | -detail]
                  [-noncurrency | -all_resource]
                  [-test]
                  [-verbose]
                  [-help]
                  [-post]

run_report Mode Parameters

-start mm/dd/yy or mm/dd/yyyy

-end mm/dd/yy or mm/dd/yyyy

The start and end dates for revenue to be included in the report. The value you supply for the start date is inclusive, but the value you supply for the end date is noninclusive and defaults to the current date.

-segment gl_segment

Creates a report for a specific G/L segment. See "Reporting Revenue for Groups of Customers". The default is the root segment.

Creates a report for the type of revenue you specify. The default is billed. See "About Event-Based Revenue Recognition".

-report file_name

Displays the output of the utility. Use the -report parameter with the -test parameter to display the report without creating the /ledger_report object.

-summary | detail

Creates a detailed report or a summary report. By default, summary customer G/L reports are created.

-noncurrency | -all_resource

Reports G/L data for noncurrency balance elements only or for both currency and noncurrency balance elements. If you do not use either of these parameters, the utility reports currency only.

-test

Runs the utility in calculation mode only.

-verbose

Displays information as the utility runs.

-help

Displays the utility parameters.

-post

Posts the report using the value in the -end_date parameter as the post date. If used, this must be the last parameter in the command line.

post_only Mode Syntax

Posts G/L data to maintain the validity of revenue data.

See "Creating Individual G/L Reports with pin_ledger_report".

pin_ledger_report -mode post_only
                  [-segment gl_segment] 
                  [-verbose] 
                  [-help]
                  [-posted posted_date | -unpost]

post_only Mode Parameters

-segment gl_segment

Posts the G/L report for a specific G/L segment. See "Reporting Revenue for Groups of Customers".

-verbose

Displays information as the utility runs.

-help

Displays the utility parameters.

-posted posted_date | -unpost

Posts or unposts the specified ledger report. You specify the report by entering the post date. To display a list of previously run reports, see "list_previous Mode Syntax".

list_previous Mode Syntax

Lists previously generated G/L reports.

See "Creating Individual G/L Reports with pin_ledger_report".

pin_ledger_report -mode list_previous 
                  -start start_date 
                  [-end end_date]
                  [-segment gl_segment] 
                  [-type billed | unbilled 
                         billed_earned | billed_unearned |
                         unbilled_earned | unbilled_unearned |
                         prev_billed_earned] 
                 [-verbose]
                 [-help]

list_previous Mode Parameters

-start start_date
-end end_date: The start and end times for listing the reports. The default for the end date is the current date.
-segment gl_segment: Shows the report for a specific G/L segment. The default is to list reports for all segments. See "Reporting Revenue for Groups of Customers".
-type billed | unbilled | billed_earned | billed_unearned | unbilled_earned | unbilled_unearned | prev_billed_earned: Lists reports for a specified type of revenue. By default, the utility lists all types. See "About Event-Based Revenue Recognition".
-verbose: Displays information as the utility runs.
-help: Displays the utility parameters.

export Mode Syntax

Generates and exports reports from the /config/export_gl object.

See "Creating Individual G/L Reports with pin_ledger_report".

pin_ledger_report  -mode export 
                   [-aggregate | -preview]
                   [-segment gl_segment]
                   [-resend report_ID] 
                   [-regenerate report_ID] 
                   [-restart] 
                   [-verbose] 
                   [-help]

export Mode Parameters

-aggregate

Exports your monthly export report to an XML file. You can then post this XML file to your external financial system. See "About the Monthly Export Report".

Use this report for deliverable-based revenue recognition.

Do not use any other parameters with this option.

-preview

Exports your preview report to an XML file. See "About the Preview G/L Report".

Use this report for deliverable-based revenue recognition.

Do not use any other parameters with this option.

-segment gl_segment

Exports XML reports for the G/L segment specified. The default is to generate and export reports for all segments. See "Reporting Revenue for Groups of Customers".

Note:

To process reports for two or more G/L segments at the same time, run multiple instances of the utility.

-resend report_ID

Re-creates the XML files for the specified reports without re-creating the /ledger_report object. See "Correcting Incorrect Data or Replacing Lost XML Output Files".

-regenerate report_ID

Re-creates the /ledger_report object and the XML report. See "Using Updated G/L Data After an Export".

-restart

Cleans up a previous abnormal run and finishes processing successfully. See "Restarting a Failed Export".

-verbose

Displays information as the utility runs.

-help

Displays the utility parameters.

Results

If the utility displays an error message, check the utility log file to determine the source of the error and correct it.

If the utility encounters an error in -export mode, either rerun the pin_ledger_report utility in -export mode or allow the next scheduled run of the utility to continue processing the remaining reports. The pin_ledger_report utility will correctly process the remaining reports.

If the utility encounters an error during -export mode when the -resend or -regenerate parameter was used, run the utility again after correcting the errors based on the log file messages. If some of the reports were successfully re-exported or regenerated, run the utility again for the failed reports.