3 Tracking Failed BRM Operations
Learn how to configure Oracle Communications Billing and Revenue Management (BRM) to collect details about failed operations and store them in the database.
Topics in this document:
About Tracking Failed BRM Operations
BRM operations may occasionally fail to process completely. For example, a payment could fail due to an insufficient balance or an incorrect account address, or a loan request could fail because it doesn't meet the eligibility requirements. Likewise, a network connection could drop while processing a transaction. You can configure BRM to store information about these failed operations in the BRM database, so you can view them for analysis and reporting, or reprocess them at a later time.
BRM can record details about failed operations that occur in the following components:
-
Billing Care REST API
To configure the Billing Care REST API to record details about failed REST requests, see "Recording Billing Care REST API Request Failures" in Billing Care SDK Guide.
-
BRM multithreaded application (MTA) utilities
To configure MTA utilities to record failed operations, see "Configuring MTA Utilities to Record Operation Failures".
-
Custom client applications
To configure a custom client application to record and retrieve failed operations, use the PCM_OP_ACT_REQUEST_CREATE and PCM_OP_ACT_REQUEST_RETRIEVE opcodes. See "Managing Operation Failure Records" in BRM Opcode Guide.
When configured to do so, BRM stores details about failed operations, such as the request payload and the error that occurred, in /request/failed, /request/failed/rest, and /request/failed/opcode objects. In multischema systems, the /request/* object is stored in the schema in which the failed operation occurred. For more information about these objects, see Storable Class Reference.
The Billing Care REST API and MTA utilities remove sensitive information, such as passwords, from request payloads before they are stored in the database. If you use a custom client application, you must configure it to mask sensitive information before calling the PCM_OP_ACT_REQUEST_CREATE opcode. See "Recording Failed Operations" in BRM Opcode Guide.
Configuring MTA Utilities to Record Operation Failures
To configure BRM MTA utilities to record details about failed operations and transactions, include the -record_failure true parameter in the utility's command line. For example, to record details about failures that occur when generating bills for active accounts, you would run the following:
pin_bill_accts -active -record_failure true
Table 3-1 lists the MTA utilities that support the -record_failure parameter.
Table 3-1 Utilities Supporting Operation Failure Records
Utility Type | Utility Name |
---|---|
Accounts Receivable |
pin_apply_bulk_adjustment pin_balance_transfer pin_monitor_balance pin_roll_up_ar_items |
Billing |
pin_bill_accts pin_cycle_fees pin_cycle_forward pin_rollover pin_roll_up_ar_items pin_update_journal |
Collections Management |
pin_collections_process pin_collections_send_dunning |
Customer Management |
pin_contracts pin_deferred_act pin_state_change |
Invoicing |
pin_inv_accts pin_make_corrective_bills pin_upd_assoc_bus_profile |
Payment |
pin_cc_migrate pin_collect pin_deposit pin_deposit_calc_interest pin_deposit_release_purchased_deposit pin_deposit_transfer_deposit pin_installment_status_change pin_installments pin_refund |
Analytics |
pin_generate_analytics |