90 Pipeline Manager Opcode Reference
This chapter provides reference information for Oracle Communications Billing and Revenue Management (BRM) opcodes related to Pipeline Manager.
Caution:
-
Always use the BRM API to manipulate data. Changing data in the database without using the API can corrupt the data.
-
Do not use SQL commands to change data in the database. Always use the API.
Account Synchronization FM Opcodes
The opcodes in Table 90-1 synchronize customer and service data with pipeline rating data.
Header File
Include the ops/ifw_sync.h header file in all applications that call these opcodes.
Opcode Index
Table 90-1 Account Synchronization FM Opcodes
| Opcode | Description | Use |
|---|---|---|
|
Passes events associated with this opcode in your system's event notification list to the policy opcode. |
Limited |
|
|
Policy for modifying the events passed to the standard opcode. |
Recommended |
PCM_OP_IFW_SYNC_PUBLISH_EVENT
Passes events associated with this opcode in your system's event notification list to the PCM_OP_IFW_SYNC_POL_PUBLISH_EVENT policy opcode for processing.
By default, PCM_OP_IFW_SYNC_PUBLISH_EVENT passes events without modifying them.
PCM_OP_IFW_SYNC_POL_PUBLISH_EVENT
Modifies events included in account synchronization business events.
Events that trigger event notification for account synchronization make up the business events that the Account Synchronization Data Manager (DM) sends to Pipeline Manager. This opcode modifies specified triggering events before they are published to Pipeline Manager.
This opcode can also be used to filter out certain events that are not included in account synchronization (for example, an event that has only balance impacts for currency balance elements), thereby reducing the traffic in the listener queue.
If you pass an event that does not need any modification to this opcode, the opcode passes that event to the EAI framework for publishing.
Batch Suspense Manager FM Standard Opcodes
The opcodes listed in Table 90-2 manage batch files for suspended EDRs stored in the BRM database as /suspended_batch objects.
Header File
Include the ops/batch_suspense.h header file in all applications that call these opcodes.
Opcode Index
Table 90-2 Batch Suspense Manager FM Standard Opcodes
| Opcode | Description | Use |
|---|---|---|
|
Deletes suspended batches from the BRM database. Available with Suspense Manager. |
Recommended |
|
|
Resubmits the batches which have been suspended by the pipeline. |
Recommended |
|
|
Writes off suspended batches. |
Recommended |
PCM_OP_BATCH_SUSPENSE_DELETE_BATCHES
Deletes suspended batches from the BRM database.
Note:
This opcode is available to Suspense Manager customers only.
PCM_OP_BATCH_SUSPENSE_RESUBMIT_BATCHES
Initiates batch resubmission. During the resubmission process, suspended batches are sent back through their original rating pipelines. The Suspense Management Center calls this opcode when the user chooses to resubmit suspended batches.
Filter Set FM Standard Opcodes
This document describes the filter set opcodes listed in Table 90-3. These opcodes support BRM Pricing Center in providing separate products and discounts to the different market segments of your customer base. These opcodes allow you to divide your customers into market segments by filtering them based on criteria that you set in Pricing Center.
Header File
Include the ops/filterset.h header file in all applications that call these opcodes. See the discussion on header files in BRM Developer's Guide.
Opcode Index
Table 90-3 Filter Set FM Standard Opcodes
| Opcode | Description | Use |
|---|---|---|
|
Creates a new /filter_set/product object. See the discussion on creating filter sets in BRM Setting Up Pricing and Rating. |
Recommended |
|
|
Deletes a /filter_set/product object. See the discussion on deleting filter sets in BRM Setting Up Pricing and Rating. |
Recommended |
|
|
Modifies a /filter_set/product object. See the discussion on updating filter sets in BRM Setting Up Pricing and Rating. |
Recommended |
PCM_OP_FILTER_SET_CREATE
Creates /filter_set/product objects, which store the list of system products and discounts that belong to a particular filter set. This opcode is called directly by Pricing Center.
See the discussion on creating filter sets in BRM Setting Up Pricing and Rating.
PCM_OP_FILTER_SET_DELETE
Deletes /filter_set/product objects. This opcode is called directly by Pricing Center.
See the discussion on creating filter sets in BRM Setting Up Pricing and Rating.
PCM_OP_FILTER_SET_UPDATE
Modifies the following data in /filter_set/product objects:
-
The filter criteria
-
The list of applicable system products and discounts
-
The validity period
This opcode is called directly by Pricing Center.
See the discussion on updating filter sets in BRM Setting Up Pricing and Rating.
Suspense Manager FM Standard Opcodes
The opcodes listed in Table 90-4 manage suspended EDRs stored in the BRM database as /suspended_usage objects.
Header File
Include the ops/suspense.h header file in all applications that call these opcodes.
Opcode Index
Table 90-4 Suspense Manager FM Standard Opcodes
| Opcode | Description | Use |
|---|---|---|
|
Deletes records for suspended EDRs after Revenue Assurance has been completed. Available with Suspense Manager. |
Recommended |
|
|
Deletes records for suspended EDRs. Available with Suspense Manager. |
Recommended |
|
|
Changes the contents of fields in suspended EDRs. Available with Suspense Manager. |
Recommended |
|
|
Initiates EDR recycling. |
Recommended |
|
|
Deletes call records with a specific recycle key and a status of succeeded or written off. |
Recommended |
|
|
Changes fields in a large number of suspended records in one database operation. |
Recommended |
|
|
Recycles suspended EDRs. Available with Suspense Manager. |
Recommended |
|
|
Writes off a large number of suspended records in one database operation. |
Recommended |
|
|
Undoes edits to suspended EDRs. Available with Suspense Manager. |
Recommended |
|
|
Writes off suspended EDRs. |
Recommended |
PCM_OP_SUSPENSE_DEFERRED_DELETE
Deletes EDRs in a written off state or succeeded state. This opcode is scheduled to run at a later time to ensure Revenue Assurance.
Note:
This opcode is available to Suspense Manager customers only.
PCM_OP_SUSPENSE_DELETE_USAGE
Deletes EDRs in a written off state or succeeded state.
Note:
This opcode is available to Suspense Manager customers only.
PCM_OP_SUSPENSE_EDIT_USAGE
Changes the contents of EDR fields for a suspended call record. The Suspense Management Center calls this opcode to edit a suspended call record.
Note:
This opcode is available to Suspense Manager customers only.
PCM_OP_SUSPENSE_RECYCLE_USAGE
Initiates EDR recycling. During recycling, suspended EDRs are sent back through their original rating pipelines. The Suspense Management Center calls this opcode when the user chooses to recycle suspended EDRs.
PCM_OP_SUSPENSE_SEARCH_DELETE
Deletes call records with a status of succeeded or written off that match criteria specified in the input flist. You can specify the following criteria:
-
A recycle key
-
A CDR file
-
A search template
This opcode can also delete a suspended call record if PIN_FLD_MODE is set correctly.
PCM_OP_SUSPENSE_SEARCH_EDIT
This opcode makes changes to a large number of suspended records that meet the criteria specified in the input template.
PCM_OP_SUSPENSE_SEARCH_RECYCLE
Searches for and queues suspended call records for recycling based on criteria specified in the input flist. You can specify the following criteria:
-
A recycle key
-
A CDR file
-
A search template
PCM_OP_SUSPENSE_SEARCH_WRITE_OFF
This opcode writes off a large number of suspended records that match the search criteria in the input flist.
PCM_OP_SUSPENSE_UNDO_EDIT_USAGE
Undoes edits to suspended call records used by Suspense Manager. This opcode is called by Suspense Management Center to perform the undo edit action. It replaces the value of a field in a suspended call record with the value in that field before the last edit was made.
Note:
This opcode is available to Suspense Manager customers only.