1 Opcode Descriptions

Learn about the Oracle Communications Billing and Revenue Management (BRM) opcodes.

About Using Opcodes

For information about using opcodes, see the following discussions in BRM Developer's Guide:

• About customizing BRM

• Writing a custom Facilities Module (FM)

• Understanding the Portal Communications Module (PCM) application programming interface (API) and the Portal Information Network (PIN) library

• Understanding API error handling and logging

• Header files

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.

You can find information about the input and output fields required for each opcode in the opcode flist specifications. See BRM Opcode Flist Reference for more information.

Each opcode flist specification also specifies the following information:

• The opcode's visibility. See "About the Opcode Visibility Value".

• The opcode's transaction handling. See "About the Opcode Transaction Value".

About the Opcode Visibility Value

An opcode's visibility field can have one of these values:

• Public: This is a recommended opcode. Oracle will strive to keep the interface intact.

• Private: Call this opcode only if absolutely necessary. This opcode may change from release to release.

• Deprecated: This opcode is deprecated. Either the functionality is being discontinued or other opcodes may provide equivalent or better functionality.

• Obsolete: This opcode is obsolete and should no longer be used. It is no longer supported.

About the Opcode Transaction Value

An opcode's transaction field can have one of these values:

• Required: The transaction for this opcode can be wrapped in a transaction opened by another opcode.

  If a read-write transaction is already open when this opcode is run, all data modifications take place within the open transaction. The modifications are committed or canceled along with all other changes when the transaction is committed or canceled.

  If no transaction is open when the opcode is called, a read-write transaction is opened. All actions are performed within this transaction, ensuring that the entire operation is performed atomically. If an error occurs during the execution of the opcode, all changes are canceled when the transaction is canceled. If no error occurs, the transaction is committed at the end of the operation.

  This opcode requires a read-write transaction. It is therefore an error to have a read-only transaction open when this opcode is called.

• Requires New: This opcode manages transactions internally to ensure absolute integrity of the database. A transaction for this opcode cannot be wrapped in another transaction.

  If no transaction is open when the opcode is called, a read-write transaction is automatically opened and all actions are performed within this transaction.

  If a transaction is already open when the opcode is called, an error occurs.

• Supports: This opcode does not modify object data. If it is called while a transaction is not already open, the operation is run without transactional control.

  If a read-write or read-only transaction is already open when this opcode is called, the opcode is run as part of the transaction and reads the in-process state of the data.

  If the opcode is called when a separate, unrelated transaction is taking place, it reads the last saved state of the database.

Account Dump FM Policy Opcodes

Use the account dump policy opcodes to customize Account Dump Utility (ADU) validation and output file format. The Account Dump utility (ADU) is a diagnostics tool that enables you to validate account information before or after certain business processes (for example, after completion of a migration or upgrade or before billing or payment allocation).

See BRM Customer Management for information about ADU.

Include the ops/cust.h header file in all applications that call these opcodes.

Table 1-1 Account Dump FM Policy Opcodes

Opcode	Description
PCM_OP_ADU_POL_DUMP	Recommended. Enables you to convert the ADU output format to a format other than XML. See "Customizing the Account Dump Utility (ADU)".
PCM_OP_ADU_POL_VALIDATE	Recommended. Enables you to define custom validations for validating account data. See "Customizing the Account Dump Utility (ADU)".

Account Dump FM Standard Opcode

Use the account dump policy opcodes to customize Account Dump Utility (ADU) validation and output file format. The Account Dump utility (ADU) is a diagnostics tool that enables you to validate account information before or after certain business processes (for example, after completion of a migration or upgrade or before billing or payment allocation).

See BRM Customer Management for information about ADU.

Include the ops/cust.h header file in all applications that call these opcodes.

Table 1-2 Account Dump FM Standard Opcode

Opcode	Description
PCM_OP_ADU_VALIDATE	Recommended. Dumps the contents of objects for an account into an output file and validates the contents of the output file.

Accounts Receivable FM Policy Opcodes

Use the accounts receivable policy opcodes to manage accounts receivable (A/R) functions such as adjustments, disputes, and write-offs.

Include the ops/ar.h header file in all applications that call these opcodes.

Table 1-3 Accounts Receivable FM Policy Opcodes

Opcode	Description
PCM_OP_AR_POL_PRE_EVENT_ADJUSTMENT	Recommended. Enables you to customize the input flist by adding or deleting events. Customizing the input flist allows you to include amounts from events into the total amount available for adjustments.
PCM_OP_AR_POL_REVERSE_WRITEOFF	Recommended. Enables you to customize how to retrieve write-off reversal items from the /profile/writeoff object. See "Reversing Write-Offs".

Accounts Receivable FM Standard Opcodes

The accounts receivable standard opcodes take PIN_FLD_END_T as an optional field in the input flist to determine when an A/R operation needs to be done. If this field is not passed in the input flist, the A/R operation is carried out with the current time. If PIN_FLD_END_T is specified, the date must be earlier than or equal to the current date. BRM does not support future dating an A/R operation.

Include the ops/ar.h header file in all applications that call these opcodes.

Table 1-4 Accounts Receivable FM Standard Opcodes

Opcode	Description
PCM_OP_AR_ACCOUNT_ADJUSTMENT	Recommended. Debits or credits an account balance for currency adjustments. See "Adjusting Accounts, Subscription Services, and Member Services".
PCM_OP_AR_ACCOUNT_WRITEOFF	Recommended. Performs write-off of one or more A/R bill units (/billinfo objects) for an account. See "About Initiating Write-Offs" and "About Account Write-Offs".
PCM_OP_AR_BILL_ADJUSTMENT	Recommended. Credits the currency balance of an account's AR bill. See "Adjusting Bills".
PCM_OP_AR_BILL_CREDIT_TRANSFER	Recommended. Transfers the amount from a bill that has a negative balance to one or more bills that have a positive balance. See "Transferring From a Negative to a Positive Balance".
PCM_OP_AR_BILL_DISPUTE	Recommended. Opens a dispute against the account's A/R bill. See "Disputing Bills".
PCM_OP_AR_BILL_SETTLEMENT	Recommended. Settles an A/R bill that is in dispute. See "Settling Disputed Bills".
PCM_OP_AR_BILL_WRITEOFF	Recommended. Performs write-off adjustments against a specified bill. See "About Bill Write-Offs".
PCM_OP_AR_BILLINFO_WRITEOFF	Recommended. Performs write-off adjustments for a specific bill unit. See "About Bill Unit Write-Offs".
PCM_OP_AR_EVENT_ADJUSTMENT	Recommended. Adjusts the balance impact of an event on an account's balance. See "Adjusting Events".
PCM_OP_AR_EVENT_DISPUTE	Recommended. Opens a dispute against one or more events associated with an account. See "Disputing Events".
PCM_OP_AR_EVENT_SETTLEMENT	Recommended. Settles dispute events associated with an account. See "Settling Disputed Events".
PCM_OP_AR_GET_ACCT_ACTION_ITEMS	Recommended. Retrieves the list of A/R items applied to all bill units in an account or to a single bill unit. See "Retrieving A/R Items That Apply to a Bill Unit".
PCM_OP_AR_GET_ACCT_BAL_SUMMARY	Recommended. Retrieves the consolidated unapplied, open bill due, pending bill due, and total dispute balances for the all the bill units in an account or for a specified bill unit in an account. See "Retrieving a Balance Summary".
PCM_OP_AR_GET_ACCT_BILLS	Recommended. Retrieves the list of bills for all bill units in an account or for a single bill unit. See "Retrieving a List of Bills for a Bill Unit".
PCM_OP_AR_GET_ACTION_ITEMS	Recommended. Retrieves the list of A/R items applied to a bill unit. See "Returning a Limited Set of Dispute Data" and "Retrieving Dispute Details for a Bill Unit".
PCM_OP_AR_GET_BAL_SUMMARY	Recommended. Retrieves the applied, unapplied, open bill due, pending bill due, and total dispute balances for a specified bill unit. See "Retrieving a Balance Summary".
PCM_OP_AR_GET_BILL_ITEMS	Recommended. Retrieves the list of bill items for a bill unit. See "Retrieving a List of Bills for a Bill Unit".
PCM_OP_AR_GET_BILLS	Recommended. Retrieves a list of bills for a bill unit based on the start time and end time search criteria. See "Retrieving a List of Bills for a Bill Unit".
PCM_OP_AR_GET_DISPUTE_DETAILS	Recommended. Retrieves all event and item disputes and the aggregated disputed amount for the events associated with a dispute item (/item/dispute object). See "Retrieving Dispute Details for a Bill Unit".
PCM_OP_AR_GET_DISPUTES	Recommended. Retrieves details of all disputed bill items for a bill unit. See "Retrieving Dispute Details for a Bill Unit".
PCM_OP_AR_GET_ITEM_DETAIL	Recommended. Retrieves details for the specified A/R item or bill item. See "Retrieving Details about a Specific A/R Item or Bill Item".
PCM_OP_AR_GET_ITEMS	Recommended. Retrieves details for the specified A/R item or bill item. See "Retrieving Details about a Specific A/R Item or Bill Item".
PCM_OP_AR_ITEM_ADJUSTMENT	Recommended. Makes adjustments against an item. See "Adjusting Items".
PCM_OP_AR_ITEM_DISPUTE	Recommended. Files a dispute against an item. See "Disputing Items".
PCM_OP_AR_ITEM_SETTLEMENT	Recommended. Settles an item that is in dispute. See "Settling Disputed Items".
PCM_OP_AR_ITEM_WRITEOFF	Recommended. Performs a write-off adjustment of an item. See "Performing Write Offs".
PCM_OP_AR_RESOURCE_AGGREGATION	Limited. Calculates the aggregated amount of event balance impacts for each balance affected by the event. See "Retrieving Details about a Specific A/R Item or Bill Item".
PCM_OP_AR_REVERSE_REFUND	Limited. Reverses failed refunds on accounts. See "Reversing Refunds".
PCM_OP_AR_REVERSE_WRITEOFF	Limited. Reverses write-offs on all written-off bills and bill items associated with a written-off account or bill unit when a payment for the account or bill unit is received. See "Reversing Write-Offs".

Account Synchronization FM Opcodes

The account synchronization opcodes synchronize BRM and Elastic Charging Engine (ECE) data. BRM events that trigger event notification for account synchronization make up the business events that the Oracle Data Manager (DM) sends to ECE via an Oracle DM database queue.

See BRM Installation Guide for information about account synchronization.

Include the ops/ifw_sync.h header file in all applications that call these opcodes.

Table 1-5 Account Synchronization FM Opcodes

Opcode	Description
PCM_OP_IFW_SYNC_PUBLISH_EVENT	Limited Passes events associated with this opcode in your system's event notification list to PCM_OP_IFW_SYNC_POL_PUBLISH_EVENT for processing. PCM_OP_IFW_SYNC_PUBLISH_EVENT does not modify events. See "About Synchronizing Account Data between the BRM Database and ECE" in BRM Installation Guide.
PCM_OP_IFW_SYNC_POL_PUBLISH_EVENT	Recommended. Enables you to modify account synchronization events before they are sent to ECE. See "Modifying Events before Sending Them to ECE".

Activity FM Policy Opcodes

Uses the activity policy opcodes to manage event creation, event recording, and event notification.

Include the ops/act.h header file in all applications that call these opcodes.

Table 1-6 Activity FM Policy Opcodes

Opcode	Description
PCM_OP_ACT_POL_CONFIG_BILLING_CYCLE	Recommended. Enables you to specify in which billing cycle to apply an event when an event occurs between the end of a billing cycle and when billing applications are run. See "Customizing How to Bill Events That Occur between Billing Cycles".
PCM_OP_ACT_POL_EVENT_LIMIT	Recommended. Enables you to inactivate an account or account hierarchy, and send a notification that a limit has been reached. See "Inactivating Accounts that Exceed a Specified Limit".
PCM_OP_ACT_POL_EVENT_NOTIFY	Recommended. Enables you to implement custom event notification. See "Using Event Notification" in BRM Developer's Guide.
PCM_OP_ACT_POL_LOCK_SERVICE	Recommended. Enables you to customize how to lock an account for /service/pcm_client and /service/admin_client after a specified number of invalid login attempts. See "Managing Login Names and Passwords" in BRM System Administrator's Guide.
PCM_OP_ACT_POL_LOG_USER_ACTIVITY	Recommended. Enables you to add details for the events that must be logged. See "Logging Customer Service Representative Activity Events" in BRM System Administrator's Guide.
PCM_OP_ACT_POL_PROCESS_EVENTS	Recommended. Processes events and updates the database with news feed entries. See "Customizing News Feed Values and Events".
PCM_OP_ACT_POL_REQUEST_CREATE	Recommended. Enables you to customize operation failure records before they are stored in the database. See "Recording Failed Operations".
PCM_OP_ACT_POL_SPEC_EVENT_CACHE	Recommended. Enables you to define which balance impact fields are cached for invoicing. See "Specifying Event Fields to Cache for Invoicing".
PCM_OP_ACT_POL_SPEC_GLID	Recommended. Enables you to customize how BRM assigns a G/L ID to an event. See "Assigning G/L IDs for an Adjustment".
PCM_OP_ACT_POL_SPEC_RATES	Recommended. Enables you to implement custom rating. See "Implementing Custom Rating".
PCM_OP_ACT_POL_SPEC_VERIFY	Recommended. Enables you to customize authentication checks. See "Customizing Authentication Checks".
PCM_OP_ACT_POL_VALIDATE_SCHEDULE	Recommended. Enables you to customize policy checks before creating /schedule objects. See "Performing Policy Checks before Scheduling Deferred Actions".

Activity FM Standard Opcodes

The activity standard opcodes manage sessions.

Include the ops/act.h header file in all applications that call these opcodes.

Table 1-7 Activity FM Standard Opcodes

Opcode	Description
PCM_OP_ACT_END_SESSION	Recommended. Logs the end of a session event. See "Recording the End of a Session" and "Recording Session Events".
PCM_OP_ACT_FIND	Recommended. Finds a customer's account. See "Finding a Customer's Account Information".
PCM_OP_ACT_FIND_VERIFY	Recommended. Authenticates a user action. See "Starting Sessions".
PCM_OP_ACT_LOAD_SESSION	Recommended. Creates and records a session event as a single operation. See "Loading Sessions".
PCM_OP_ACT_LOGIN	Recommended. Authorizes users to start login sessions. See "Starting Sessions".
PCM_OP_ACT_LOGOUT	Recommended. Records the end of a login session. See "Recording the End of a Session".
PCM_OP_ACT_REQUEST_CREATE	Recommended. Creates a /request object, which records information about a failed operation. See "Recording Failed Operations".
PCM_OP_ACT_REQUEST_RETRIEVE	Recommended. Retrieves /request objects. See "Retrieving Operation Failure Records".
PCM_OP_ACT_SCHEDULE_CREATE	Recommended. Creates a /schedule object, which defers a single action to a predetermined date and time. See "Scheduling Deferred Actions".
PCM_OP_ACT_SCHEDULE_DELETE	Recommended. Deletes a /schedule object. See "Managing Deferred Actions".
PCM_OP_ACT_SCHEDULE_EXECUTE	Recommended. Runs any deferred actions in specified /schedule objects. See "Executing Deferred Actions".
PCM_OP_ACT_SCHEDULE_MODIFY	Recommended. Modifies the text description of an existing /schedule object. See "Modifying Deferred Actions".
PCM_OP_ACT_START_SESSION	Recommended. Creates session events and records their start times. See "Recording the Start of a Session".
PCM_OP_ACT_UPDATE_SESSION	Recommended. Updates session event information. See "Updating a Session Event".
PCM_OP_ACT_USAGE	Last resort Manages session events. See "Managing Sessions".

Balance FM Policy Opcodes

Use the balance policy opcodes to trigger service life cycle state changes based on balance adjustments or to customize algorithms to select the default balance group of a bill unit.

Include the ops/bal.h header file in all applications that call these opcodes.

Table 1-8 Balance FM Policy Opcodes

Opcode	Description
PCM_OP_BAL_POL_APPLY_MULTI_BAL_IMPACTS	Recommended. Enables you to customize threshold processing for policy-driven charging. When you start your BRM system, BRM caches the set of unique balance element IDs that you configured in your offer profiles. This opcode processes the threshold calculation logic only if the balance element ID is one of the entries in its cache. This opcode is called by PCM_OP_BAL_APPLY_MULTI_BAL_IMPACTS.
PCM_OP_BAL_POL_CHECK_LIFECYCLE_STATE	Recommended. Enables you to customize how to get life-cycle states. See "Creating Custom Service Life Cycles" in BRM Managing Customers.
PCM_OP_BAL_POL_GET_BAL_GRP_AND_SVC	Recommended. Enables you to customize how to select the default balance group of a bill unit and the default service of the default balance group. See "Customizing the Default Balance Group of a Bill Unit".
PCM_OP_BAL_POL_SET_SUB_BALANCES	Recommended. Enables you to customize an account's or service's sub-balance before it is transferred. See "Customizing Balance Transfers".

Balance FM Standard Opcodes

The balance standard opcodes adjust account balances.

Include the ops/bal.h header file in all applications that call these opcodes.

Table 1-9 Balance FM Standard Opcodes

Opcode	Description
PCM_OP_BAL_CHANGE_VALIDITY	Recommended. Changes a sub-balance's validity period. See "Modifying the Sub-balance Validity Period".
PCM_OP_BAL_GET_ACCT_BAL_GRP_AND_SVC	Recommended. Returns the balance groups and services for all the account's bill units or for a single bill unit. See "Finding a Balance Group and Service for Bill Units".
PCM_OP_BAL_GET_ACCT_BILLINFO	Recommended. Returns the main contact information for an account and a list of the account's bill units with the default bill unit marked. See "Finding a Bill Unit".
PCM_OP_BAL_GET_BALANCES	Recommended. Returns the POID of a /balance_group object and, optionally, the balances it contains. See "Finding a Balance Group and Its Balances".
PCM_OP_BAL_GET_BAL_GRP_AND_SVC	Recommended. Gets the balance groups and services for a bill unit See "Finding a Balance Group and Service for Bill Units".
PCM_OP_BAL_GET_ECE_BALANCES	Recommended. Gets the real-time balances for a service from ECE. This opcode can be called by a custom application.
PCM_OP_BAL_TRANSFER_BALANCE	Recommended. Transfers currency and non-currency balances from one account or service to another. See "Transferring Balances between Accounts or Services".

Base Opcodes

The base opcodes can be used by any opcode. Unlike all other opcodes, which belong to the Connection Manager, the base opcodes are run by data managers.

Each DM included with BRM uses a different implementation of the base opcodes. For example, the base opcode PCM_OP_SEARCH is implemented differently for the Oracle DM and the LDAP DM. For information, see:

• LDAP Base Opcodes

• Email Data Manager Opcodes

Include the ops/base.h header file in all applications that call these opcodes.

Table 1-10 Base Opcodes

Base Opcodes	Description
PCM_OP_BULK_CREATE_OBJ	Recommended. Creates a large number of objects of the same type. See the discussion on creating a large number of objects in BRM Developer's Guide.
PCM_OP_BULK_DELETE_OBJ	Recommended. Deletes a large number of objects of the same type. See the discussion on deleting a large number of objects in BRM Developer's Guide.
PCM_OP_BULK_WRITE_FLDS	Recommended. Updates the value of the same fields in a large number of objects that meet the conditions you specify in the query in the input flist. See the discussion on editing large numbers of objects in BRM Developer's Guide and "Editing Suspended Records in Bulk" for more information.
PCM_OP_CREATE_OBJ	Recommended. Creates an object. See the discussion on creating objects in BRM Developer's Guide.
PCM_OP_DELETE_FLDS	Recommended. Deletes arrays or array elements from an object. See the discussion on deleting fields in objects in BRM Developer's Guide.
PCM_OP_DELETE_OBJ	Recommended. Deletes a specified object and all its fields. See the discussion on deleting objects in BRM Developer's Guide.
PCM_OP_GET_DD	Recommended. Retrieves the Data Dictionary. Oracle recommends using the pin_deploy utility to invoke this opcode. See the discussion on the pin_deploy utility in BRM Developer's Guide.
PCM_OP_GET_PIN_VIRTUAL_TIME	Recommended. Retrieves the virtual time that is set in the BRM Connection Manager (CM). Use this opcode only in a test environment when you want to retrieve the virtual time for a custom application that is connected to the CM. Oracle recommends using the pin_virtual_time utility to invoke this opcode. See the discussion on the pin_deploy utility in BRM Developer's Guide.
PCM_OP_GLOBAL_SEARCH	Recommended. To perform a global search, use PCM_OP_GLOBAL_SEARCH. See the discussion on performing a global search in BRM Developer's Guide.
PCM_OP_GLOBAL_STEP_END	Recommended. Ends global step-searching initiated by PCM_OP_GLOBAL_STEP_SEARCH. See the discussion on performing a global step search in BRM Developer's Guide.
PCM_OP_GLOBAL_STEP_NEXT	Recommended. Receives the next set of search results from a step search. See the discussion on getting the next set of search results from a global step search in BRM Developer's Guide.
PCM_OP_GLOBAL_STEP_SEARCH	Recommended. Step-searches for objects across multiple BRM database schemas. See the discussion on performing a global step search in BRM Developer's Guide.
PCM_OP_INC_FLDS	Recommended. Increments or decrements one or more fields in an object. See the discussion on incrementing fields in objects in BRM Developer's Guide.
PCM_OP_READ_FLDS	Recommended. Reads one or more fields in an object. See the discussion on reading fields in an object BRM Developer's Guide.
PCM_OP_READ_OBJ	Recommended. Reads an entire object. See the discussion on reading an entire object in BRM Developer's Guide.
PCM_OP_SEARCH	Recommended. Searches for objects in a single BRM database schema. See the discussion on performing single-schema searches in BRM Developer's Guide.
PCM_OP_SET_DD	Recommended. Modifies the Data Dictionary. Oracle recommends using the pin_virtual_time utility to invoke this opcode. See the discussion on the pin_deploy utility in BRM Developer's Guide.
PCM_OP_STEP_END	Recommended. Ends a step search initiated by PCM_OP_STEP_SEARCH. See the discussion on ending a step search in BRM Developer's Guide.
PCM_OP_STEP_NEXT	Recommended. Retrieves the next set of search results from a step search. See the discussion on getting the next set of search results from a step search in BRM Developer's Guide.
PCM_OP_STEP_SEARCH	Recommended. Step-searches for objects in a BRM database schema. See the discussion on performing single-schema step searches in BRM Developer's Guide.
PCM_OP_TEST_LOOPBACK	Recommended. Tests directory server connections. See the discussion on the noop testnap command in the chapter about testing applications in BRM Developer's Guide.
PCM_OP_TRANS_ABORT	Recommended. Ends an open PCM transaction. See the discussion on cancelling transactions in BRM Developer's Guide.
PCM_OP_TRANS_COMMIT	Recommended. Commits an open transaction on a PCM context. See the discussion on committing transactions in BRM Developer's Guide.
PCM_OP_TRANS_OPEN	Recommended. Opens a transaction. See the discussion on using transactions in BRM Developer's Guide.
PCM_OP_TRANS_POL_ABORT	Recommended. Enables you to customize how to cancel a transaction. See the discussion on cancelling transactions in BRM Developer's Guide
PCM_OP_TRANS_POL_COMMIT	Recommended. Enables you to customize how to commit an open transaction. See the discussion on committing transactions in BRM Developer's Guide.
PCM_OP_TRANS_POL_OPEN	Recommended. Enables you to customize how to open a transaction. See the discussion on using transactions in BRM Developer's Guide.
PCM_OP_TRANS_POL_PREP_COMMIT	Recommended. Enables you to customize how to verify that a transaction can be committed. See the discussion on customizing how to verify the readiness of an external system to commit a transaction opcode in BRM Developer's Guide.
PCM_OP_WRITE_FLDS	Recommended. Writes fields in an object. See the discussion on writing fields in objects in BRM Developer's Guide.

Batch Suspense Manager FM Standard Opcodes

The batch suspense manager standard opcodes manage batch files for suspended event records stored in the BRM database as /suspended_batch objects.

For information about suspending and recycling event records, see ECE Implementing Charging.

Include the ops/batch_suspense.h header file in all applications that call these opcodes.

Table 1-11 Batch Suspense Manager FM Standard Opcodes

Opcode	Description
PCM_OP_BATCH_SUSPENSE_DELETE_BATCHES	Recommended. Deletes suspended batches from the BRM database. See "Deleting Records for Suspended Batches".
PCM_OP_BATCH_SUSPENSE_RESUBMIT_BATCHES	Recommended. Resubmits the batches that have been suspended. See "Resubmitting Suspended Batches".
PCM_OP_BATCH_SUSPENSE_WRITE_OFF_BATCHES	Recommended. Writes off the batches which are at the “Suspended" stage because of some business rule. See "Writing Off Suspended Batches".

Billing FM Policy Opcodes

Use the billing policy opcodes to customize billing and A/R processes.

Include the ops/bill.h header file in all applications that call these opcodes.

Table 1-12 Billing FM Policy Opcodes

Opcode	Description
PCM_OP_BILL_POL_BILL_PRE_COMMIT	Recommended. Enables you to perform custom modifications to a bill object before it is committed to the BRM database. See "Modifying a Bill Object".
PCM_OP_BILL_POL_CALC_PYMT_DUE_T	Recommended. Enables you to customize how to calculate the due date and the payment collection date of a bill (/bill object). See the following topics: Calculating When a Bill is Due Payment Due Dates for Corrective Bills Calculating Payment Collection Dates
PCM_OP_BILL_POL_CHECK_SUPPRESSION	Recommended. Enables you to customize exceptions to bill suppressions. See "Determining Whether Bills Should Be Suppressed" and "Suppressing Bills".
PCM_OP_BILL_POL_EVENT_SEARCH	Recommended. Enables you to customize how to search for events associated with an account. See "Finding Events Associated with an Account".
PCM_OP_BILL_POL_GET_EVENT_SPECIFIC_DETAILS	Recommended. Enables you to customize how to get event specific details based on the type of the event. This opcode is called by PCM_OP_BILL_GET_ITEM_EVENT_CHARGE_DISCOUNT.
PCM_OP_BILL_POL_GET_ITEM_TAG	Recommended. Enables you to customize the event attributes that set and return a customized item tag. See the discussion on creating custom bill items in BRM Configuring and Running Billing.
PCM_OP_BILL_POL_GET_PENDING_ITEMS	Recommended. Enables you to customize how to select the pending items to be included in a bill. See "Customizing Bill Now"
PCM_OP_BILL_POL_POST_BILLING	Recommended. Enables you to perform custom processing on a bill unit at the time of billing. See "About Suspending Billing of Accounts and Bills"
PCM_OP_BILL_POL_POST_SET_LIMIT_AND_CR	Recommended. Enables you to customize the notification sent after a temporary credit limit is created or modified. See "Managing Credit Limits and Sub-Balance Consumption Rules".
PCM_OP_BILL_POL_PRE_SET_LIMIT_AND_CR	Recommended. Enables you to modify the validity dates for a temporary credit limit. See "Managing Credit Limits and Sub-Balance Consumption Rules".
PCM_OP_BILL_POL_REVERSE_PAYMENT	Recommended. Enables you to implement additional rules for performing write-off reversals and allocating funds to written-off accounts and bill units. See "Customizing Reversal of Payments Allocated to Written-Off Accounts".
PCM_OP_BILL_POL_SPEC_BILLNO	Recommended. Enables you to customize bill numbers. See "Customizing the Format of Bill and Invoice Numbers".
PCM_OP_BILL_POL_SPEC_FUTURE_CYCLE	Recommended. Enables you to customize accounting cycles. See "Customizing Accounting Cycles"
PCM_OP_BILL_POL_VALID_ADJUSTMENT	Recommended. Enables you to customize item adjustment validation criteria. See "Customizing Item Adjustments".
PCM_OP_BILL_POL_VALID_CORRECTIVE_BILL	Recommended. Enables you to customize how BRM determines if a corrective bill can be generated. See "Validating Bills for the Corrective Billing Process" and "Policy Bill Validations".
PCM_OP_BILL_POL_VALID_DISPUTE	Recommended. Enables you to customize how to validate fields in an /item object when a dispute is made. See "Customizing Item Disputes".
PCM_OP_BILL_POL_VALID_SETTLEMENT	Recommended. Enables you to customize how to validate the information used for settling an item which is in dispute. See "Customizing Item Disputes" and "Settling Disputed Items".
PCM_OP_BILL_POL_VALID_TRANSFER	Recommended. Enables you to customize how to validate the information used for transferring money from the payment item to the target item. See "Customizing Item Transfer Validation".
PCM_OP_BILL_POL_VALID_WRITEOFF	Recommended. Enables you to customize how items are validated for a write-off. See "Customizing Write-Off Validation".

Billing FM Standard Opcodes

The billing standard opcodes manage billing and billing group processes, as well as some A/R and payment processes.

To customize groups, use the billing opcodes, such as PCM_OP_BILL_GROUP_CREATE. The billing opcodes call the group opcodes.

Include the ops/bill.h header file in all applications that call these opcodes.

Table 1-13 Billing FM Standard Opcodes

Opcode	Description
PCM_OP_BILL_CREATE_SPONSORED_ITEMS	Recommended. Creates /item/sponsor objects for sponsoring accounts. See "Creating /item/sponsor Objects".
PCM_OP_BILL_CURRENCY_CONVERT_AMOUNTS	Recommended. Converts currency amounts from a source currency to a destination currency. See "About Currency Conversion".
PCM_OP_BILL_CURRENCY_QUERY_CONVERSION_RATES	Recommended. Supplies currency conversion rates. See "About Currency Conversion".
PCM_OP_BILL_CYCLE_TAX	Last Resort. Calculates tax on deferred taxable amounts. See "Calculating Taxes during Billing".
PCM_OP_BILL_DEBIT	Recommended. Debits or credits a noncurrency balance. See "Applying Debits and Credits".
PCM_OP_BILL_FIND	Recommended. Locates a /bill object, given a bill number. See "Finding a Bill".
PCM_OP_BILL_GET_ITEM_EVENT_CHARGE_DISCOUNT	Limited. Retrieves the discount for events of a given bill item. See "Finding Discounts in Bill Items".
PCM_OP_BILL_GET_LIMIT	Recommended. Retrieves the permanent and temporary credit limits for an account. See "Retrieving Credit Limits".
PCM_OP_BILL_GROUP_ADD_MEMBER	Last Resort. Adds one or more accounts to an existing account group. See "Adding Accounts to Account Hierarchies".
PCM_OP_BILL_GROUP_CREATE	Last Resort. Creates a new account group (/group object.) for billing purposes. See "Creating Account Hierarchies".
PCM_OP_BILL_GROUP_DELETE	Last Resort. Deletes an existing /group object. See "Deleting Accounts from Account Hierarchies".
PCM_OP_BILL_GROUP_DELETE_MEMBER	Last Resort. Deletes an account from an existing group. See "Deleting Accounts from Account Hierarchies".
PCM_OP_BILL_GROUP_GET_CHILDREN	Last Resort. Gets child accounts of a specified account group. See "Getting a List of Child Accounts in an Account Hierarchy".
PCM_OP_BILL_GROUP_GET_PARENT	Last Resort. Gets the parent account of a given account group. See "Finding the Parent of an Account Hierarchy".
PCM_OP_BILL_GROUP_MOVE_MEMBER	Recommended. Moves a group member; deletes the group if it is empty, and creates the new group if it does not exist. See "Moving Accounts from One Account Hierarchy to Another".
PCM_OP_BILL_ITEM_EVENT_SEARCH	Recommended. Searches the /event object for details related to a specific item. See "Finding Events Associated with Bill Items".
PCM_OP_BILL_ITEM_REFUND	Recommended. Creates a refund item for a bill or bill unit. See "Refunding Payments".
PCM_OP_BILL_ITEM_TRANSFER	Limited. Transfers money from a source item to a target item. See "Transferring Balances between Items".
PCM_OP_BILL_MAKE_BILL	Last Resort. Creates a bill for a specified bill unit See "Creating Bills".
PCM_OP_BILL_MAKE_BILL_NOW	Last Resort. Bills a specified bill unit immediately. See "Running Bill Now".
PCM_OP_BILL_MAKE_BILL_ON_DEMAND	Last Resort. Creates a bill immediately after a bill unit is created or when a bundle is purchased. See "On-Purchase Billing".
PCM_OP_BILL_MAKE_CORRECTIVE_BILL	Recommended. Creates a corrective bill for a bill unit. See "Making a Corrective Bill".
PCM_OP_BILL_MAKE_TRIAL_BILL	Limited. Creates a trial invoice and collects revenue assurance data for trial billing. See "Making Trial Bills".
PCM_OP_BILL_RCV_PAYMENT	Limited. Creates a payment item and records that currency has been received. See "Receiving Payments".
PCM_OP_BILL_REMOVE_ACCOUNT_SUPPRESSION	Recommended. Deactivates manual account suppression immediately or on a specified future date. See "Ending Manual Account Suppression".
PCM_OP_BILL_REVERSE	Last Resort. Opens a closed payment item and removes the credit. This opcode is a wrapper for PCM_OP_BILL_REVERSE_PAYMENT. See "Reversing Payments".
PCM_OP_BILL_REVERSE_PAYMENT	Limited. Reverses a payment. See "Reversing Payments".
PCM_OP_BILL_SET_ACCOUNT_SUPPRESSION	Recommended. Activates manual account suppression immediately or on a specified future date. See "Suppressing Accounts".
PCM_OP_BILL_SET_BILL_SUPPRESSION	Recommended. Handles manual bill suppression. See "Manually Suppressing Bills".
PCM_OP_BILL_SET_LIMIT_AND_CR	Recommended. Sets a permanent credit limit, a temporary credit limit, and/or a consumption rule for both currency and noncurrency sub-balances. See "Customizing Credit Limit and Consumption Rules".
PCM_OP_BILL_TRANSFER_BALANCE	Recommended. Transfers balances from one balance group to another balance group. See "Transferring Balances between Balance Groups".
PCM_OP_BILL_VIEW_INVOICE	Recommended. Retrieves a formatted invoice from the database. This opcode is deprecated and included only for backward compatibility. Use PCM_OP_INV_VIEW_INVOICE instead.

Channel FM Standard Opcodes

The channel standard opcodes propagate object changes from BRM to a directory server.

See the discussion about the channel framework in BRM LDAP Manager.

Include the ops/channel.h header file in all applications that call these opcodes.

Table 1-14 Channel FM Standard Opcodes

Opcode	Description
PCM_OP_CHANNEL_PUSH	Recommended. Creates /channel_event objects whenever a change occurs to a specified /account or /service object. You specify which events trigger the opcode to create /channel_event objects by using event notification.
PCM_OP_CHANNEL_SYNC	Limited Propagates /channel_event objects to the LDAP Server. BRM does not use this opcode, but you can use it for custom applications.

Collections Manager FM Policy Opcodes

Use the collections policy opcodes to customize collections features.

For information about Collections Manager, see "Understanding Collections Manager" in BRM Collections Manager.

Include the ops/collections.h header file in all applications that call these opcodes.

Table 1-15 Collections Manager FM Policy Opcodes

Opcode	Description
PCM_OP_COLLECTIONS_POL_APPLY_FINANCE_CHARGES	Recommended. Enables you to customize how a finance charge is calculated or add collections functionality. See "Applying Finance Charges".
PCM_OP_COLLECTIONS_POL_APPLY_LATE_FEES	Recommended. Enables you to customize how the late fee is calculated or to add functionality. See "Applying Late Fees".
PCM_OP_COLLECTIONS_POL_ASSIGN_AGENT	Recommended. Enables you to customize how account bill units are assigned to collections agents. See "Assigning Bill Units Automatically".
PCM_OP_COLLECTIONS_POL_ASSIGN_DCA	Recommended. Enables you to automate the logic of selecting a debt collections agent (DCA) when multiple DCAs are configured. See "Assigning Bill Units to a Debt Collections Agency".
PCM_OP_COLLECTIONS_POL_CALC_DUE_DATE	Recommended. Enables you to customize how due dates are set. "Customizing Due Dates".
PCM_OP_COLLECTIONS_POL_EXEC_POLICY_ACTION	Recommended. Enables your custom application to perform custom collections actions. See "Performing Custom Collections Actions".
PCM_OP_COLLECTIONS_POL_EXIT_SCENARIO	Recommended. Enables your custom application to perform cleanup or other tasks when a bill unit leaves a collections scenario. See "Performing Custom Actions when a Bill Unit Leaves Collections".
PCM_OP_COLLECTIONS_POL_GET_GROUP_TARGET_ACTIONS	Recommended. Enables you to customize how to assign bill units to collection actions. See "Customizing How to Apply Collections Actions to Collections Group Members".
PCM_OP_COLLECTIONS_POL_GET_VALID_SCENARIOS	Recommended. Enables you to customize how to validate if a scenario is valid for a bill unit. See "Getting All Valid Collections Scenarios".
PCM_OP_COLLECTIONS_POL_HANDLE_BREACH_PROMISE_TO_PAY	Recommended. Enables you to break a promise-to-pay agreement when a customer misses an installment payment. See "Breaking a Promise-to-Pay Agreement".
PCM_OP_COLLECTIONS_POL_INITIATE_PAYMENT	Recommended. Enables you to customize auto-collect of the due amount for promise_to_pay and collect_payment actions, if the customer has opted to pay off the due amount through credit card or direct debit. See "Executing Pending Actions for a Bill Unit".
PCM_OP_COLLECTIONS_POL_INVOKE_PROMISE_TO_PAY	Recommended. Enables you to perform additional validation before invoking promise obligation for a bill unit. See "Creating a System-Configured Promise-to-Pay Agreement" and "Creating a Manually Configured Promise-to-Pay Agreement".
PCM_OP_COLLECTIONS_POL_PREP_DUNNING_DATA	Recommended. Enables you to customize dunning letter data. See "Customizing Dunning Letters".
PCM_OP_COLLECTIONS_POL_PROCESS_BILLINFO	Recommended. Enables you to include additional criteria to determine whether bill units should enter and exit collections. Important: The source code for this opcode is not shipped with BRM. See "Executing Automatic Collections Actions".
PCM_OP_COLLECTIONS_POL_SELECT_PROFILE	Recommended. Enables you to group bill units into collections profiles based on any criteria you choose. See "Mapping Bill Units to Collections Profiles".

Collections Manager FM Standard Opcodes

The collections standard opcodes identify account bill units with overdue balances and manage activities to collect those balances.

For information about Collections Manager, see "Understanding Collections Manager" in BRM Collections Manager.

Include the ops/collections.h header file in all applications that call these opcodes.

Table 1-16 Collections Manager FM Standard Opcodes

Opcode	Description
PCM_OP_COLLECTIONS_ADD_ACTION	Recommended. Adds collections actions to a collections scenario of a bill unit. See "Adding Actions to a Collections Scenario".
PCM_OP_COLLECTIONS_ASSIGN_AGENT	Recommended. Assigns bill units to a collections agent. See "Assigning Bill Units to a Collections Agent".
PCM_OP_COLLECTIONS_CALC_AGING_BUCKETS	Recommended. Gets aging bucket details for a bill unit. See "Retrieving Aging Buckets Information".
PCM_OP_COLLECTIONS_CONFIG_DELETE_ACTION	Recommended. Deletes a collections action. See "Deleting an Existing Collections Action".
PCM_OP_COLLECTIONS_CONFIG_DELETE_PROFILE	Recommended. Deletes a collections profile. See "Deleting an Existing Collections Profile".
PCM_OP_COLLECTIONS_CONFIG_DELETE_SCENARIO	Recommended. Deletes an existing collections scenario. See "Deleting an Existing Collections Scenario".
PCM_OP_COLLECTIONS_CONFIG_GET_ACTIONS	Recommended. Gets a list of all currently defined collections actions. See "Getting All Currently Defined Collections Actions".
PCM_OP_COLLECTIONS_CONFIG_GET_PROFILES	Recommended. Retrieves a list of currently defined collections profiles. See "Getting All Currently Defined Collections Profiles".
PCM_OP_COLLECTIONS_CONFIG_GET_SCENARIOS	Recommended. Gets a list of all collections scenarios and associated profiles. See "Getting All Currently Defined Collections Scenarios".
PCM_OP_COLLECTIONS_CONFIG_GET_SCENARIO_DETAIL	Recommended. Gets details of a particular collections scenario. See "Getting Details of a Collections Scenario".
PCM_OP_COLLECTIONS_CONFIG_GET_TEMPLATES	Recommended. Gets a list of templates. See "Getting a List of Message Templates".
PCM_OP_COLLECTIONS_CONFIG_SET_ACTION	Recommended. Creates or updates a collections action. See "Creating or Updating Collections Actions".
PCM_OP_COLLECTIONS_CONFIG_SET_PROFILE	Recommended. Creates or updates a collections profile. See "Creating or Updating Collections Profiles".
PCM_OP_COLLECTIONS_EXEMPT_BILLINFO	Recommended. Exempts bill units from collections. See "Exempting Bill Units from Collections".
PCM_OP_COLLECTIONS_GET_ACTION_HISTORY	Recommended. Finds historic information about a particular collections action. See "Retrieving Collections Action History Information".
PCM_OP_COLLECTIONS_GET_AGENTS_ACTIONS	Recommended. Retrieves a list of collections actions assigned to collections agents. See "Retrieving a List of Collections Actions".
PCM_OP_COLLECTIONS_GET_BILLINFOS	Recommended. Gets a list of bill units that are in collections. See "Retrieving a List of Bill Units in Collections".
PCM_OP_COLLECTIONS_GET_DUNNING_LETTER	Recommended. Creates formatted dunning letters. See "Retrieving Dunning Letters".
PCM_OP_COLLECTIONS_GET_SCENARIO_DETAIL	Recommended. Gets details of the collections scenario for a bill unit. See "Getting Details of a Collections Scenario".
PCM_OP_COLLECTIONS_GET_VALID_SCENARIOS	Recommended. Determines all the eligible collections scenarios for a bill unit. See "Getting All Valid Collections Scenarios".
PCM_OP_COLLECTIONS_GROUP_ADD_MEMBER	Recommended. Adds members to a collections group. See "Adding Members to a Collections Group".
PCM_OP_COLLECTIONS_GROUP_CREATE	Recommended. Creates the collections group. See "Creating a Collections Group".
PCM_OP_COLLECTIONS_GROUP_DELETE	Recommended. Deletes the collections group. See "Deleting a Collections Group".
PCM_OP_COLLECTIONS_GROUP_DELETE_MEMBER	Recommended. Deletes members from the collections group. See "Removing a Member from a Collections Group".
PCM_OP_COLLECTIONS_GROUP_GET_BILLINFO	Recommended. Verifies whether a bill unit belongs to a collections group or not. It also provides information about the pending receivables for each bill unit. If the bill unit is a parent of a collection group, it provides the name of the group and its members. See "Retrieving a Collections Group".
PCM_OP_COLLECTIONS_GROUP_MODIFY	Recommended. This opcode is used to rename the group, change parent, or replace existing members. While replacing the existing members, this opcode validates all the members and replaces the existing set of group members. See "Modifying a Collections Group".
PCM_OP_COLLECTIONS_GROUP_SET_PARENT	Recommended. Sets the parent for a collections group. Validation is performed to verify if the bill unit is already a parent of another collections group. A bill unit can be the owner or parent of only one collections group. See "Changing the Parent of a Collections Group".
PCM_OP_COLLECTIONS_INVOKE_PROMISE_TO_PAY	Recommended. For a bill unit that is already in collections, creates a promise-to-pay agreement. See "Creating a System-Configured Promise-to-Pay Agreement" and "Creating a Manually Configured Promise-to-Pay Agreement".
PCM_OP_COLLECTIONS_PROCESS_BILLINFO	Recommended. Determines whether bill units enter or exit collections and performs collections actions. See "Executing Automatic Collections Actions".
PCM_OP_COLLECTIONS_RESCHEDULE_ACTION	Recommended. Reschedules an action that was scheduled by a bill unit's collections scenario. See "Rescheduling an Action Scheduled for a Bill Unit".
PCM_OP_COLLECTIONS_REPLACE_SCENARIO	Recommended. Replaces the existing collections scenario for a bill unit with a new collections scenario. See "Replacing a Collections Scenario".
PCM_OP_COLLECTIONS_REVOKE_PROMISE_TO_PAY	Recommended. Cancels the promise-to-pay agreement, by canceling the outstanding payment milestones, deleting the corresponding schedule objects, rescheduling the scenario actions to start from the next day, and updating the scenario objects. See "Breaking a Promise-to-Pay Agreement".
PCM_OP_COLLECTIONS_SET_ACTION_STATUS	Recommended. Changes the status of a collections action. See "Changing the Status of a Collections Action".
PCM_OP_COLLECTIONS_SET_DUNNING_LETTER	Recommended. Gathers data for system-generated dunning letters. See "Gathering and Storing Data for Dunning Letters".
PCM_OP_COLLECTIONS_SET_INVOICE_REMINDER	Recommended. Prepares an invoice reminder message. See "Preparing Invoice Reminders".
PCM_OP_COLLECTIONS_TAKE_ACTION	Recommended. Runs pending actions for a bill unit. See "Executing Pending Actions for a Bill Unit".
PCM_OP_COLLECTIONS_UPDATE_ACTION_PAYMENT_DETAILS	Recommended. Updates the amount and payment details for Promise to Pay and Collect Payment actions. See "Updating Amount and Payment Details".

Contract FM Policy Opcodes

Use the contract policy opcodes to customize contracts.

Include the ops/contract.h header file in all applications that call these opcodes.

Table 1-17 Contract FM Policy Opcodes

Opcode	Description
PCM_OP_CONTRACT_POL_POST_CREATE_CONTRACT	Recommended. Enables you to customize how contracts are created. By default, the opcode does nothing.
PCM_OP_CONTRACT_POL_PREP_CONTRACT	Recommended. Enables you to customize how contracts are created. By default, the opcode does nothing.
PCM_OP_CONTRACT_POL_VALID_CONTRACT	Recommended. Validates a customer's contract for valid start and end dates, pricing objects, account objects, and contract objects (during modification). The opcode is triggered during contract creation, modification, and renewal.

Contract FM Standard Opcodes

Note:

The contract opcodes are supported only in BRM 12.0.0.3.0 with Interim Patch 31426340 and later releases, and PDC 12.0.0.3.0 with Interim Patch 31426374 and later releases.

Use the contract standard opcodes to manage customer contracts.

Include the ops/contract.h header file in all applications that call these opcodes.

Table 1-18 Contract FM Policy Opcodes

Opcode	Description
PCM_OP_CONTRACT_CANCEL_CONTRACT	Recommended. Cancels a customer's existing contract and applies an early termination fee if required by the contract terms. See "Canceling Contracts".
PCM_OP_CONTRACT_CREATE_CONTRACT	Recommended. Creates a contract for a customer. See "Creating Contracts".
PCM_OP_CONTRACT_MODIFY_CONTRACT	Recommended. Modifies a customer's existing contract. See "Modifying Contracts".
PCM_OP_CONTRACT_RENEW_CONTRACT	Recommended. Renews a customer's contract. See "Renewing Contracts".

Customer FM Policy Opcodes

Use the customer policy opcodes to customize the business logic to process account information during customer account creation.

Include the ops/cust.h header file in all applications that call these opcodes.

Table 1-19 Customer FM Policy Opcodes

Opcode	Description
PCM_OP_CUST_POL_CANONICALIZE	Recommended. Enables you to customize canonicalization when you create a localized version of BRM. See the discussion on creating a localized version of BRM in BRM Developer's Guide.
PCM_OP_CUST_POL_COMPARE_PASSWD	Recommended. Enables you to customize the password encryption mechanism. See "Implementing Password Encryption".
PCM_OP_CUST_POL_DECRYPT_PASSWD	Recommended. Enables you to customize how to decrypt a password. See "Implementing Password Encryption".
PCM_OP_CUST_POL_ENCRYPT_PASSWD	Recommended. Enables you to customize password encryption. See "Implementing Password Encryption".
PCM_OP_CUST_POL_EXPIRATION_PASSWD	Recommended. Enables you to customize how passwords are expired. See "Customizing Password Expiration".
PCM_OP_CUST_POL_GET_CONFIG	Recommended. Enables you to customize the configuration data that should be returned to an external customer management system. See "Sending Account Information to Your Application when an Account is Created".
PCM_OP_CUST_POL_GET_DB_LIST	Recommended. Enables you to create and customize a list of schemas to use when creating accounts. See "Getting a List of Database Schemas".
PCM_OP_CUST_POL_GET_DB_NO	Recommended. Enables you to choose which schema to use when creating accounts. See "Selecting a Database Schema"
PCM_OP_CUST_POL_GET_DEALS	Recommended. Enables you to retrieve a customized list of bundles from the BRM database. See "Getting Data about Bundles, Charge Offers, Discount Offers, and Services".
PCM_OP_CUST_POL_GET_INTRO_MSG	Recommended. Enables you to customize how to send an introductory message to a customer. See "Customizing the Introductory Message".
PCM_OP_CUST_POL_GET_PLANS	Recommended. Enables you to retrieve a customized list of packages from the BRM database. See "Getting Data about Bundles, Charge Offers, Discount Offers, and Services".
PCM_OP_CUST_POL_GET_POPLIST	Recommended. Enables you to customize how to return a point-of-presence (POP) list. See "Returning a Point-of-Presence (POP) List".
PCM_OP_CUST_POL_GET_PRODUCTS	Recommended. Enables you to retrieve a customized list of charge offers from the BRM database. See "Getting Data about Bundles, Charge Offers, Discount Offers, and Services".
PCM_OP_CUST_POL_GET_SUBSCRIBED_PLANS	Recommended. Enables you to retrieve a customized list of packages, bundles, or both that an account owns. See "Getting a List of Packages and Bundles That an Account Owns"
PCM_OP_CUST_POL_POST_COMMIT	Recommended. Enables you to customize interactions with an external account creation application before an account is committed during customer account creation. See: Adding Custom Account Creation Steps After the Account Is Committed Creating Accounts Customizing the Introductory Message
PCM_OP_CUST_POL_POST_MODIFY_CUSTOMER	Recommended. Enables you to send information to an external account creation application when an account is modified. See "Sending Account Information to Your Application when an Account is Modified".
PCM_OP_CUST_POL_PRE_COMMIT	Recommended. Enables you to customize interactions with an external account creation application after an account is committed during customer account creation. See "Adding Custom Account Creation Steps Before the Account Is Committed".
PCM_OP_CUST_POL_PRE_DELETE_PAYINFO	Recommended. Enables you to add custom actions before a /payinfo object is deleted. See "Customizing Customer Payment Information".
PCM_OP_CUST_POL_PREP_AACINFO	Recommended. Enables you to prepare automatic account creation (AAC) data for validation. See "Customizing Automatic Account Creation (AAC) Information".
PCM_OP_CUST_POL_PREP_ACCTINFO	Recommended. Enables you to customize account numbers. See "Customizing Account Numbers".
PCM_OP_CUST_POL_PREP_BILLINFO	Recommended. Enables you to customize the creation of a /billinfo object during customer account creation or while updating billing information to prepare for validation. See "Preparing Bill Unit Data".
PCM_OP_CUST_POL_PREP_INHERITED	Recommended. Enables you to customize inherited information when a service object is created. See "Creating Services".
PCM_OP_CUST_POL_PREP_LIMIT	Recommended. Enables you to customize credit limit information prior to validation. See "Managing Credit Limits and Sub-Balance Consumption Rules".
PCM_OP_CUST_POL_PREP_LOCALE	Recommended. Enables you to customize how to set the locale for an account. See "Customizing Locale Information".
PCM_OP_CUST_POL_PREP_LOGIN	Recommended. Enables you to customize login names for services. See "Customizing Login Names".
PCM_OP_CUST_POL_PREP_NAMEINFO	Recommended. Enables you to customize how name and address information is processed. See "Customizing Name and Address Information".
PCM_OP_CUST_POL_PREP_PASSWD	Recommended. Enables you to customize password creation. See "Customizing Passwords".
PCM_OP_CUST_POL_PREP_PAYINFO	Limited Enables you to customize how /payinfo objects are created. See "Customizing Payment Method Data Preparation".
PCM_OP_CUST_POL_PREP_PROFILE	Limited Enables you to customize how profiles are created. See "Managing and Customizing Profiles".
PCM_OP_CUST_POL_PREP_STATUS	Limited Enables you to customize status data before modifying the status. See "Customizing Status Changes".
PCM_OP_CUST_POL_PREP_TOPUP	Recommended. Enables you to customize how to set up and modified. See "Preparing an Account's Top-Up Information".
PCM_OP_CUST_POL_READ_PLAN	Recommended. Enables you to retrieve a customized list of services, bundles, and charge offers for purchase. See "Getting Packages, Bundles, and Charge Offers for Purchase".
PCM_OP_CUST_POL_TAX_CALC	Recommended. Enables you to customize tax calculation. See "Using Custom Tax Rates".
PCM_OP_CUST_POL_TAX_INIT	Recommended. Enables you to customize tax calculation. See "Using Custom Tax Rates".
PCM_OP_CUST_POL_TRANSITION_DEALS	Recommended. Enables you to create and customize a list of bundles and charge offers available for transition. See "Customizing Bundle Transitions".
PCM_OP_CUST_POL_TRANSITION_PLANS	Recommended. Enables you to customize how bundles in a specified package are transitioned. See "Customizing Bundle Transitions". Note: To customize how to transition a package from one account to another, use PCM_OP_SUBSCRIPTION_POL_PRE_TRANSITION_PLAN. See "Customizing Package Transitions without Configuring /transition Objects".
PCM_OP_CUST_POL_VALID_AACINFO	Recommended. Enables you to validate data in the automatic account creation (AAC) fields. See "Customizing Automatic Account Creation (AAC) Information".
PCM_OP_CUST_POL_VALID_ACCTINFO	Recommended. Enables you to customize account numbers. See "Customizing Account Numbers".
PCM_OP_CUST_POL_VALID_BILLINFO	Recommended. Enables you to customize how to validate billing informaiton in a /billinfo object. See "Validating Bill Unit Data".
PCM_OP_CUST_POL_VALID_LIMIT	Recommended. Enables you to validate custom credit limit information before it is set in the account. See "Managing Credit Limits and Sub-Balance Consumption Rules".
PCM_OP_CUST_POL_VALID_LOCALE	Recommended. Enables you to customize how to validate locale information before it is set in the account. See "Customizing Locale Information".
PCM_OP_CUST_POL_VALID_LOGIN	Recommended. Enables you to Enables you to customize how to validate login names. See "Customizing Login Names".
PCM_OP_CUST_POL_VALID_NAMEINFO	Recommended. Enables you to customize how customer contact information is validated. See "Customizing Name and Address Information".
PCM_OP_CUST_POL_VALID_PASSWD	Recommended. Enables you to customize how passwords are validated. See "Customizing Passwords".
PCM_OP_CUST_POL_VALID_PAYINFO	Limited Enables you to customize how payment methods are validates. See "Customizing Payment Method Validation".
PCM_OP_CUST_POL_VALID_PROFILE	Limited Enables you to customize how profiles are validated. See "Managing and Customizing Profiles".
PCM_OP_CUST_POL_VALID_STATUS	Limited Enables you to customize how status changes are validated. See "Customizing Status Changes".
PCM_OP_CUST_POL_VALID_TAXINFO	Recommended. Enables you to customize how to validate the VAT certificate number provided during account creation. See "Validating Tax Information".
PCM_OP_CUST_POL_VALID_TOPUP	Recommended. Enables you to customize how top-up data is validated. See "Validating an Account's Top-Up Information".

Customer FM Standard Opcodes

The customer standard opcodes manage the creation, deletion, and modification of account information during customer account creation.

Include the ops/cust.h header file in all applications that call these opcodes.

Important:

To create an account, use PCM_OP_CUST_COMMIT_CUSTOMER. This wrapper opcode performs all of the tasks necessary to create an active and billable account in the database. The value of its PIN_FLD_TXN_FLAGS input flist field determines how the opcode handles transactions. See "Transaction Handling During Account Creation" for more information.

Table 1-20 Customer FM Standard Opcodes

Opcode	Description
PCM_OP_CUST_CHANGE_BUSINESS_PROFILE	Recommended. Changes a bill unit's business profile. See "Changing a Bill Unit's Business Profile".
PCM_OP_CUST_COMMIT_CUSTOMER	Recommended. Creates an account. This opcode is a wrapper opcode that performs all the tasks necessary to create an account. See "Creating Accounts".
PCM_OP_CUST_CREATE_ASSOCIATED_BUS_PROFILE	Recommended. Creates one /associated_bus_profile object for each bill unit in the account. See "Creating Business Profiles".
PCM_OP_CUST_CREATE_BAL_GRP	Limited Creates an active /balance_group object. Use PCM_OP_CUST_SET_BAL_GRP to create the /balance_group object. See "Creating Balance Groups".
PCM_OP_CUST_CREATE_BILLINFO	Limited Creates an active bill unit. See "Creating Bill Units".
PCM_OP_CUST_CREATE_CUSTOMER	Limited Creates an active customer account, including creating and initializing an /account object and one or more /service objects. See "Creating Accounts".
PCM_OP_CUST_CREATE_PAYINFO	Limited Creates an active /payinfo object. See "Creating Accounts".
PCM_OP_CUST_CREATE_PROFILE	Limited Creates a /profile object. See "Managing and Customizing Profiles".
PCM_OP_CUST_CREATE_SERVICE	Last Resort Creates a service object with inheritance pass through. See "Creating Services".
PCM_OP_CUST_CREATE_TOPUP	Limited Creates /topup and /group/topup objects. See "Setting Up Top-Up Information in an Account".
PCM_OP_CUST_DELETE_ACCT	Last Resort Deletes the specified /account object and all related objects (such as events, bill items, bill history, balances, and notes) and disassociates devices that are assigned to the services. See "Deleting Accounts".
PCM_OP_CUST_DELETE_BAL_GRP	Last Resort Deletes a /balance_group object. See "Deleting a Balance Group".
PCM_OP_CUST_DELETE_BILLINFO	Last Resort Deletes the specified bill unit and the balance groups associated with it. See "Deleting Bill Units".
PCM_OP_CUST_DELETE_PAYINFO	Recommended. Deletes the specified /payinfo object. See "Customizing Customer Payment Information".
PCM_OP_CUST_DELETE_PROFILE	Limited Deletes the specified /profile object. See "Managing and Customizing Profiles".
PCM_OP_CUST_DELETE_TOPUP	Limited Deletes /topup objects. See "Deleting Top-Ups".
PCM_OP_CUST_FIND	Recommended. Searches for information in an /account object given an account number. See "Finding Accounts".
PCM_OP_CUST_FIND_PAYINFO	Recommended. Finds /payinfo objects that belong to a specified account. See "Finding Payment Info".
PCM_OP_CUST_FIND_PROFILE	Recommended. Retrieves the /profile objects associated with a specified account. See "Retrieving Account Profile Information".
PCM_OP_CUST_GET_BUSINESS_PROFILE_INFO	Recommended. Gets the value of a key in the business profile and validation templates associated with an object. See "Getting Information about a Business Profile".
PCM_OP_CUST_GET_LIFECYCLE_STATES	Recommended. Gets information from the life cycle states configuration object (/config/lifecycle_states) associated with a specified service type or gets the configuration object itself. See "Getting Life Cycle States".
PCM_OP_CUST_GET_NEWSFEED	Recommended. Retrieves and returns the news feed information stored in the /newsfeed object. See BRM Managing Customers.
PCM_OP_CUST_GET_NOTE	Recommended. Gets notes and note exchanges based on any of the /note object fields, such as the date, the type of note, the status, the CSR who wrote the note, and so on.
PCM_OP_CUST_GET_SUBSCRIBER_PREFERENCES	Recommended. Retrieves the subscriber's preferences from the /profile/subscriber_preferences object for a subscriber's service or account. See "Maintaining Subscriber's Charging Preferences Data".
PCM_OP_CUST_INIT_SERVICE	Last Resort Initializes a service object. See "Maintaining Subscriber's Charging Preferences Data".
PCM_OP_CUST_MODIFY_BAL_GRP	Limited Modifies the specified /balance_group object. See "Creating Balance Groups".
PCM_OP_CUST_MODIFY_CUSTOMER	Recommended. Modifies customer account information. See "Modifying an Account" and "Moving a Balance Group from One Bill Unit to Another".
PCM_OP_CUST_MODIFY_PAYINFO	Limited Modifies selected fields in the /payinfo object. See "Customizing Customer Payment Information".
PCM_OP_CUST_MODIFY_PROFILE	Limited Modifies the specified /profile object. See "Managing and Customizing Profiles".
PCM_OP_CUST_MODIFY_SERVICE	Limited Modifies the specified /service object. See "Modifying Services".
PCM_OP_CUST_MODIFY_TOPUP	Limited Modifies /topup and /group/topup objects. See "Setting Up Top-Up Information in an Account".
PCM_OP_CUST_PREP_CUSTOMER	Recommended. Validates customer information prior to account creation. See "Creating Accounts".
PCM_OP_CUST_SET_ACCTINFO	Limited Initializes an /account object with generic fields passed in on the input flist. See "Customizing Account Numbers".
PCM_OP_CUST_SET_ASSOCIATED_BUS_PROFILE	Recommended. Updates the /associated_bus_profile objects whenever invoice business profiles are modified in the /config/business_profile object. See "Assigning Bill Units to Business Profiles".
PCM_OP_CUST_SET_BAL_GRP	Limited Performs all necessary tasks to set up the /balance_group object and create a link to the customer account. See "Creating Balance Groups".
PCM_OP_CUST_SET_BILLINFO	Limited Updates billing information in a bill unit for a specified account. See "Updating Bill Units".
PCM_OP_CUST_SET_LOCALE	Limited Sets the Locale field of a specified /account object. See "Customizing Locale Information".
PCM_OP_CUST_SET_LOGIN	Limited Updates the service login. See "Customizing Login Names".
PCM_OP_CUST_SET_NAMEINFO	Limited Sets account contact information such as customer name, address, and phone number. See "Managing Name and Address Information".
PCM_OP_CUST_SET_NOTE	Recommended. Creates a /note object or modifies an existing one. If you pass in a type-only POID, a /note object is created. Otherwise, this opcode modifies the /note object. This opcode generates the following events: /event/customer/note/create /event/customer/note/modify
PCM_OP_CUST_SET_PASSWD	Limited Updates the service password for a customer. See "Creating Passwords".
PCM_OP_CUST_SET_PAYINFO	Limited Adds or updates the payment information for a bill unit. See "Customizing Customer Payment Information".
PCM_OP_CUST_SET_STATUS	Limited Sets the status of an /account, /billinfo, or /service object. See "Changing the Status of an Account, Bill Unit, or Service".
PCM_OP_CUST_SET_SUBSCRIBER_PREFERENCES	Recommended. Creates, modifies, or deletes a /profile/subscriber_preferences object for a specified service or account. See "Maintaining Subscriber's Charging Preferences Data".
PCM_OP_CUST_SET_TAXINFO	Recommended. Adds or updates the tax information in the account object. See "Adding Tax Information to Accounts".
PCM_OP_CUST_SET_TOPUP	Recommended. Sets up standard top-ups and sponsored top-ups. See "Setting Up Top-Up Information in an Account".
PCM_OP_CUST_UPDATE_CUSTOMER	Recommended. Updates several pieces of customer information in one operation. See "Modifying an Account".
PCM_OP_CUST_UPDATE_SERVICES	Recommended. Modifies service information for multiple services in one operation. See "Modifying Services".
PCM_OP_CUST_VALID_FLD	Recommended. Validates fields on the input flist based on the information contained in the /config/fld_validate object.
PCM_OP_CUST_VALIDATE_CUSTOMER	Recommended. Validates customer information during account creation. This opcode is called by several different opcodes when account information is created or changed. See "Customer Management Opcode Workflows".

Customer Care FM Standard Opcodes

Use the customer care standard opcodes to manage customers. These opcodes are used by the Billing Care and Customer Center applications.

Include the ops/custcare.h header file in all applications that call these opcodes.

Table 1-21 Device FM Policy Opcodes

Opcode	Description
PCM_OP_CUSTCARE_MOVE_ACCT	Recommended. Moves an account into or out of an account hierarchy.

Deposit FM Policy Opcodes

Use the deposit policy opcodes to customize deposits.

See "About Deposits" in BRM Managing Customers.

Include the ops/deposit.h header file in all applications that call these opcodes.

Table 1-22 Deposit FM Policy Opcodes

Opcode	Description
PCM_OP_DEPOSIT_POL_POST_ADD_INTEREST	Recommended. Enables you to add information to the calculated interest amount and interest period. See "Customizing the Interest Calculation".
PCM_OP_DEPOSIT_POL_PRE_ADD_INTEREST	Recommended. Enables you to update the EFFECTIVE_T for interest calculation. Any changes to the EFFECTIVE_T from this opcode impacts the interest calculation such that the interest is applied on per-day basis. See "Customizing the Interest Calculation".
PCM_OP_DEPOSIT_POL_VALID_COLLECT_PAYMENT	Recommended. Enables you to validate the PCM_OP_DEPOSIT_COLLECT_PAYMENT opcode. See "Validating Deposit Payment Collections".
PCM_OP_DEPOSIT_POL_VALID_PURCHASE_DEPOSIT	Recommended. Enables you to validate the deposit purchase. See "Validating a Deposit Purchase".
PCM_OP_DEPOSIT_POL_VALID_REFUND_REQUEST	Recommended. Enables you to validate the deposit refund request. See "Validating a Deposit Refund Request".
PCM_OP_DEPOSIT_POL_VALID_RELEASE_DEPOSIT	Recommended. Enables you to validate the deposit release. See "Validating a Deposit Release".
PCM_OP_DEPOSIT_POL_VALID_REVERSE_DEPOSIT	Recommended. Enables you to validate a deposit reversal. See "Validating a Deposit Reversal".
PCM_OP_DEPOSIT_POL_VALID_SPECIFICATION	Recommended. Enables you to validate the /deposit_specification object. See "Validating Deposit Specifications
PCM_OP_DEPOSIT_POL_VALID_SPECIFICATION_PROFILE	Recommended. Enables you to validate the input flist for PCM_OP_DEPOSIT_CREATE_SPECIFICATION_PROFILE opcode. See "Validating Deposit Specification Profiles".
PCM_OP_DEPOSIT_POL_VALID_TRANSFER_DEPOSIT	Recommended. Enables you to validate a deposit transfer. See "Validating a Deposit Transfer".
PCM_OP_DEPOSIT_POL_VALID_UPDATE_DEPOSIT	Recommended. Enables you to validate a request to update a deposit with PCM_OP_DEPOSIT_UPDATE_DEPOSIT. See "Validating Deposit Updates".

Deposit FM Standard Opcodes

The deposit opcodes manage customer deposits.

See "About Deposits" in BRM Managing Customers.

Include the ops/deposit.h header file in all applications that call these opcodes.

Table 1-23 Deposit FM Standard Opcodes

Opcode	Description
PCM_OP_DEPOSIT_ADD_INTEREST	Limited. Calculates the interest amount for a given purchased deposit and period. Used during deposit release, reversal, transfer, update or refund, and called by the pin_deposit_calc_interest utility. See "Adding Interest to a Deposit".
PCM_OP_DEPOSIT_COLLECT_PAYMENT	Recommended. Makes the up-front payment for a deposit. See "Collecting Deposit Payments".
PCM_OP_DEPOSIT_CREATE_SPECIFICATION	Recommended. Creates the /deposit_specification object. See "Creating Deposit Specifications".
PCM_OP_DEPOSIT_CREATE_SPECIFICATION_PROFILE	Recommended. Creates the /config/deposit_spec_profile object. See "Creating Deposit Specification Profiles".
PCM_OP_DEPOSIT_DELETE_DRAFT	Recommended. Deletes a /deposit_specification object that is in draft state. See "Deleting Draft Deposit Specifications".
PCM_OP_DEPOSIT_GET_DEPOSITS	Limited. Get the purchased deposits of the given account, service, or bill unit from the /purchased_deposit object. See "Getting Deposits".
PCM_OP_DEPOSIT_GET_REFUND_REQUEST	Recommended. Gets all deposit refund requests. See "Getting Refund Requests".
PCM_OP_DEPOSIT_GET_SPECIFICATION	Recommended. Gets the /deposit_specification object. See "Getting Deposit Specifications".
PCM_OP_DEPOSIT_GET_SPECIFICATION_PROFILE	Recommended. Gets the /config/deposit_spec_profile objects. See "Getting Deposit Specification Profiles".
PCM_OP_DEPOSIT_GET_TRANSACTIONS	Recommended. Gets the transaction details of a purchased deposit. It returns the complete details of the events. See "Retrieving Transaction Details of a Deposit".
PCM_OP_DEPOSIT_MODIFY_SPECIFICATION	Recommended. Modifies the /deposit_specification object. See "Modifying Deposit Specifications".
PCM_OP_DEPOSIT_MODIFY_SPECIFICATION_PROFILE	Recommended. Updates the /config/deposit_spec_profile object. See "Modifying Deposit Specification Profiles".
PCM_OP_DEPOSIT_PURCHASE_DEPOSIT	Recommended. Creates a deposit for a given customer. This opcode triggers a deposit charge event and deposit charge item, creates the /purchased_deposit object, and makes the up-front payment for the deposit. See "Purchasing Deposits".
PCM_OP_DEPOSIT_REFUND_REQUEST	Recommended. Creates a deposit refund request. See "Requesting Deposit Refunds".
PCM_OP_DEPOSIT_RELEASE_DEPOSIT	Recommended. Releases an existing deposit as follows, depending on the request type: Prepayment : Creates /item/payment immediately. Refund Request: Creates /deposit_refund_request, which can then be approved if needed. Once approved, the opcode creates /item/payment and /item/refund. Zeroize: Settles dues and raises a refund request for the remaining amount. Creates /item/payment immediately, makes a call to PCM_OP_BILL_MAKE_BILL_NOW to bill the pending items, allocates the /item/payment to the bill items, and refunds the remaining balance to the customer. See "Releasing Deposits".
PCM_OP_DEPOSIT_REVERSE_DEPOSIT	Recommended. Reverses deposits by opening the /item/payment made against /item/deposit_charge. See "Reversing Deposits".
PCM_OP_DEPOSIT_TRANSFER_DEPOSIT	Recommended. Transfers deposit from one account to another account. See "Transferring Deposits".
PCM_OP_DEPOSIT_TRIGGER_DEPOSIT	Limited. Creates a /purchased_deposit object when any charge offers with event type of /event/billing/product/fee/purchase/deposit are created as part of a deal purchase. See "Triggering Deposits".
PCM_OP_DEPOSIT_UPDATE_DEPOSIT	Recommended. Increases or decreases the amount of an already purchased deposit. This opcode reverses the existing deposit charge item, creates a new deposit charge for the given amount, and updates the same purchased deposit object. See "Updating Deposits".
PCM_OP_DEPOSIT_UPDATE_DEPOSIT_RECEIVED	Recommended. Called through event notification for /event/billing/item/transfer to update the received amount and balance amount, and to map /event/billing/item/transfer to this PIN_FLD_EVENTS array. See "Updating Received Deposits".
PCM_OP_DEPOSIT_UPDATE_REFUND_REQUEST	Recommended. Updates the deposit refund review request. See "Updating Refund Requests".

Device FM Policy Opcodes

Use the device policy opcodes to customize device management.

See the discussion about device management in BRM Developer's Guide.

Include the ops/device.h header file in all applications that call these opcodes.

Table 1-24 Device FM Policy Opcodes

Opcode	Description
PCM_OP_DEVICE_POL_ASSOCIATE	Recommended. Enables you to customize validation during device-to-service association and disassociation. See "Associating /service and /device Objects".
PCM_OP_DEVICE_POL_CREATE	Recommended. Enables you to customize validation during device creation. See "Creating /device Objects".
PCM_OP_DEVICE_POL_DELETE	Recommended. Enables you to customize validation during device deletion. See "Deleting /device Objects".
PCM_OP_DEVICE_POL_SET_ATTR	Recommended. Enables you to customize validation of device attribute changes. See "Changing the Attributes of /device Objects".
PCM_OP_DEVICE_POL_SET_STATE	Recommended. Enables you to customize validation during device state changes. See "Changing the State of a /device Object".

Device FM Standard Opcodes

The device standard opcodes run device management processes.

See the discussion about device management in BRM Developer's Guide.

Include the ops/device.h header file in all applications that call these opcodes.

Table 1-25 Device FM Standard Opcodes

Opcode	Description
PCM_OP_DEVICE_ASSOCIATE	Recommended. Associates or disassociates /service objects with /device objects. See "Associating /service and /device Objects".
PCM_OP_DEVICE_CREATE	Recommended. Creates a /device object of the type specified in the input flist. See "Creating /device Objects".
PCM_OP_DEVICE_DELETE	Recommended. Deletes a /device object. See "Deleting /device Objects".
PCM_OP_DEVICE_SET_ATTR	Recommended. Changes the attributes for a /device object. See "Changing the Attributes of /device Objects".
PCM_OP_DEVICE_SET_STATE	Recommended. Sets the state for a /device object. See "Changing the State of a /device Object".
PCM_OP_DEVICE_UPDATE	Recommended. Changes any combination of attribute values tate of a device in a single transaction. See "Changing Device Attributes and States".

Email Data Manager Opcodes

The Email Data Manager opcodes are base opcodes. They provide a different implementation from the standard BRM base opcodes. Unlike FM opcodes, which belong to the Connection Manager, the Email DM opcodes are part of the Email DM.

Include the ops/base.h header file in all applications that call these opcodes.

Table 1-26 Email Data Manager Base Opcodes

Email Data Manager base opcode	Description
PCM_OP_CREATE_OBJ	Recommended. Provides a platform-independent interface to dm_email for sending one or more email attachments. See "Sending the Introductory Message".
PCM_OP_DELIVERY_MAIL_SENDMSGS	Recommended. Queries the pin.conf file for the location of the Email DM, and ensures the data in the PIN_FLD_MESSAGES array is valid. See "Sending the Introductory Message".

General Ledger FM Policy Opcodes

Use the general ledger policy opcodes to customize the data in exported G/L reports.

See BRM Collecting General Ledger Data for more information.

Include the ops/gl.h header file in all applications that call these opcodes.

Table 1-27 General Ledger FM Policy Opcodes

Opcode	Description
PCM_OP_GL_POL_EXPORT_GL	Recommended. Enables you to customize data in the exported G/L reports. See "Customizing G/L Reports for Export".
PCM_OP_GL_POL_PRE_UPDATE_JOURNAL	Recommended. Enables you to customize general ledger data before it is recorded into /journal objects. See "Customizing G/L Data Stored in /journal Objects".

General Ledger FM Standard Opcode

The general ledger standard opcodes calculate account information and create /ledger_report objects.

See BRM Collecting General Ledger Data for more information.

Include the ops/gl.h header file in all applications that call these opcodes.

Table 1-28 General Ledger FM Standard Opcode

Opcode	Description
PCM_OP_GL_LEDGER_REPORT	Recommended. Creates /ledger_report objects, which store general ledger reports. . See "How BRM Stores General Ledger Reports".

GPRS Manager 3.0 FM Policy Opcode

Use the GPRS policy opcodes to customize the GPRS service extensions.

See the discussion on GPRS Manager in BRM Telco Integration.

Include the ops/gprs.h header file in all applications that call these opcodes.

Table 1-29 GPRS Manager 3.0 FM Policy Opcode

Opcode	Description
PCM_OP_GPRS_POL_APPLY_PARAMETER	Recommended. Enables you to customize GPRS service extensions. See "Updating Custom GPRS Service Fields".

GPRS Manager 3.0 FM Standard Opcode

The GPRS standard opcodes add GPRS-specific service extensions.

See the discussion on GPRS Manager in BRM Telco Integration.

Include the ops/gprs.h header file in all applications that call these opcodes.

Table 1-30 GPRS Manager 3.0 FM Standard Opcode

Opcode	Description
PCM_OP_GPRS_APPLY_PARAMETER	Recommended. Reads the service extensions from the input flist and adds corresponding GPRS service values. See "Updating Custom GPRS Service Fields".

Group FM Standard Opcodes

The group standard opcodes create and delete account groups and account group members.

To customize groups, use the billing opcodes, such as PCM_OP_BILL_GROUP_CREATE. The billing opcodes call the group opcodes.

For information about groups, see "Managing Account and Bill Unit Hierarchies" in BRM Managing Customers.

Include the ops/group.h header file in all applications that call these opcodes.

Table 1-31 Group FM Standard Opcodes

Opcode	Description
PCM_OP_GROUP_ADD_MEMBER	Limited Adds members to a group. See "Adding Members to Groups".
PCM_OP_GROUP_CREATE_GROUP	Limited Creates a new group object. See "Creating Groups".
PCM_OP_GROUP_DELETE_GROUP	Limited Deletes an existing /group object from the database. See"Deleting Groups" .
PCM_OP_GROUP_DELETE_MEMBER	Limited Deletes members from a group. See "Deleting Members from Groups".
PCM_OP_GROUP_SET_PARENT	Limited Sets the parent object of a group. See "Setting a Group Parent".
PCM_OP_GROUP_UPDATE_INHERITED	Limited Updates the inheritance fields of an existing group. See "Updating Inheritance Fields in Groups".

GSM Manager FM Policy Opcode

Use the GSM Manager policy opcode to add custom service attributes.

See the discussion on GSM Manager in BRM Telco Integration.

Include the ops/gsm.h header file in all applications that call this opcode.

Table 1-32 GSM Manager FM Policy Opcode

Opcode	Description
PCM_OP_GSM_POL_APPLY_PARAMETER	Recommended. Enables you to customize GSM service extensions. See "Updating Custom GSM Service Fields".

GSM Manager FM Standard Opcode

The GSM Manager standard opcode performs telco provisioning functions.

See the discussion on GSM Manager in BRM Telco Integration.

Include the ops/tcf.h header file in all applications that call these opcodes.

Table 1-33 GSM Manager FM Standard Opcode

Opcode	Description
PCM_OP_GSM_APPLY_PARAMETER	Recommended. Reads the service extensions from the input flist and adds corresponding GSM service values. See "Updating Custom GSM Service Fields".

Installment FM Policy Opcodes

Use the installment policy opcodes to customize installments.

See "About Installments" in BRM Configuring and Collecting Payments.

Include the ops/installment.h header file in all applications that call these opcodes.

Table 1-34 Installment FM Policy Opcodes

Opcode	Description
PCM_OP_INSTALLMENT_POL_GET_SCHEDULE_SPEC	Recommended. Enables you to customize getting installment schedule specifications. See "Getting Installment Schedule Specifications".
PCM_OP_INSTALLMENT_POL_PREP_INSTALLMENT	Recommended. Enables you to customize installment fields. See "Preparing Installments".
PCM_OP_INSTALLMENT_POL_PREP_SCHEDULE_SPEC	Recommended. Enables you to customize installment schedule specification creation fields. See "Preparing Installment Schedule Specifications".
PCM_OP_INSTALLMENT_POL_VALID_INSTALLMENT	Recommended. Enables you to validate the information in an installment. See "Validating Installments".
PCM_OP_INSTALLMENT_POL_VALID_SCHEDULE_SPEC	Recommended. Enables you to validats the installment schedule specification information in the /config/installment/schedule_spec object. See "Validating Installment Schedule Specifications".

Installment FM Standard Opcodes

The installment opcodes manage installment processes.

See "About Installments" in BRM Configuring and Collecting Payments.

Include the ops/installment.h header file in all applications that call these opcodes.

Table 1-35 Installment FM Standard Opcodes

Opcode	Description
PCM_OP_INSTALLMENT_APPLY_CHARGE	Recommended. Applies the installment amount on the effective date. See "Applying Installment Charge".
PCM_OP_INSTALLMENT_CANCEL_INSTALLMENT	Recommended. Cancels the remaining installments and charges the customer for the total amount due. See "Canceling Installments".
PCM_OP_INSTALLMENT_CREATE_INSTALLMENT	Recommended. Create an installment schedule for a customer. See "Creating Installments".
PCM_OP_INSTALLMENT_CREATE_SCHEDULE_SPEC	Recommended. Creates an installment schedule specification, including minimum installment amount, the maximum number of unequal installments, unequal installment frequency, installment type, and eligibility criteria. See "Creating Installment Schedule Specifications".
PCM_OP_INSTALLMENT_GET_INSTALLMENTS	Recommended. Retrieves information about all the installments associated with an account and service. See "Retrieving Installments".
PCM_OP_INSTALLMENT_GET_SCHEDULE_SPEC	Recommended. Retrieves information about the installment schedule specification. See "Retrieving Installment Schedule Specifications".
PCM_OP_INSTALLMENT_MODIFY_SCHEDULE_SPEC	Recommended. Modifies an existing installment schedule specification object. See "Modifying Installment Schedule Specifications".
PCM_OP_INSTALLMENT_PROPOSAL	Recommended. Prepares an installment proposal based on the installment amount, term (the number of months), and start date. See "Installment Proposal".
PCM_OP_INSTALLMENT_UPDATE_INSTALLMENT	Recommended. Updates the /installment object for open installments. See "Updating Installments".
PCM_OP_INSTALLMENT_UPDATE_INSTALLMENT_STATUS	Recommended. Changes the status of an installment after a payment is allocated. See "Updating Installment Status".

Invoicing FM Policy Opcodes

The invoicing standard opcodes generate invoices in different formats.

For more information, see BRM Designing and Generating Invoices.

Include the ops/inv.h header file in all applications that call these opcodes.

Table 1-36 Invoicing FM Policy Opcodes

Opcode	Description
PCM_OP_INV_POL_FORMAT_INVOICE	Recommended. Specifies the format in which to store invoices. See "How Invoices Are Formatted".
PCM_OP_INV_POL_FORMAT_INVOICE_DOC1	Limited Enables you to customize invoices that use the DOC1 format. See "Customizing the Format for DOC1 Invoices".
PCM_OP_INV_POL_FORMAT_INVOICE_HTML	Limited Enables you to customize HTML invoices. See "Customizing the Format for HTML Invoices".
PCM_OP_INV_POL_FORMAT_INVOICE_XSLT	Limited Enables you to customize invoices that use an XSL style sheet. See "Customizing the Invoice Format by Using an XSL Style Sheet".
PCM_OP_INV_POL_FORMAT_INVOICE_XML	Limited Enables you to customize XML invoices. See "Customizing the Format for XML Invoices".
PCM_OP_INV_POL_FORMAT_VIEW_INVOICE	Recommended. Enables you to generate a custom invoice. See "Displaying an Invoice On Demand".
PCM_OP_INV_POL_POST_MAKE_INVOICE	Recommended. Enables you to capture and return errors that were created due to custom invoicing operations defined in PCM_OP_INV_POL_SELECT. See "Configuring Error Checking for Customized Invoicing".
PCM_OP_INV_POL_PREP_INVOICE	Recommended. Enables you to customize invoice formatting prior to formatting and storing. See "Adding Soft Descriptors to Invoices".
PCM_OP_INV_POL_SELECT	Recommended. Enables you to write custom search templates for items and events to be displayed on invoices. See "Customizing Invoice Search Operations" and "Configuring Error Checking for Customized Invoicing".

Invoicing FM Standard Opcodes

The invoicing standard opcodes create and format invoices.

For more information, see BRM Designing and Generating Invoices.

Include the ops/inv.h header file in all applications that call these opcodes.

Table 1-37 Invoicing FM Standard Opcodes

Opcode	Description
PCM_OP_INV_DECODE_INVOICE_DATA	Recommended. Decodes the value of the PIN_FLD_INVOICE_DATA field in the /event object, which contains cached items and events to be displayed on the invoice. See "Decoding Cached Event Data for Invoicing".
PCM_OP_INV_FORMAT_INVOICE	Limited Performs XSL Transformation on an invoice. See "How Invoices Are Formatted".
PCM_OP_INV_MAKE_INVOICE	Recommended. Creates an invoice for a specified regular or corrective bill object. See "How Invoices Are Generated".
PCM_OP_INV_VIEW_INVOICE	Recommended. Retrieves an invoice from the database. See "Displaying Invoices".

IP Address Manager APN FM Policy Opcodes

Use the IP Address Manager APN policy opcodes to perform various checks and maintenance on the APN device.

See the discussion on IP Address Manager in BRM Telco Integration.

Include the ops/apn.h header file in all applications that call these opcodes.

Table 1-38 IP Address Manager APN FM Policy Opcodes

Opcode	Description
PCM_OP_APN_POL_DEVICE_ASSOCIATE	Recommended. Enables you to customize verification checks on the APN device and the account or service being associated. See "Associating APN with an Account or Service".
PCM_OP_APN_POL_DEVICE_CREATE	Recommended. Enables you to customize verification checks during APN device creation. See "Creating an APN Device".
PCM_OP_APN_POL_DEVICE_DELETE	Recommended. Enables you to customize verification checks during APN device deletion. See "Deleting an APN Device".
PCM_OP_APN_POL_DEVICE_SET_ATTR	Recommended. Enables you to customize how to verify that an APN device is in a state to accept changes. See "Changing the APN Device State".
PCM_OP_APN_POL_DEVICE_SET_STATE	Recommended. Enables you to customize how to verify that an APN device is eligible to accept a device state change. See "Changing the APN Device State".

IP Address Manager FM Policy Opcodes

Use the IP Address Manager policy opcodes to perform various checks and maintain the state of the IP address device.

See the discussion on IP Address Manager in BRM Telco Integration.

Include the ops/ip.h header file in all applications that call these opcodes.

Table 1-39 IP Address Manager FM Policy Opcodes

Opcode	Description
PCM_OP_IP_POL_DEVICE_ASSOCIATE	Recommended. Enables you to customize how to verify that an IP address device is in a state to accept changes. See "Associating an IP Address with Accounts or Services".
PCM_OP_IP_POL_DEVICE_CREATE	Recommended. Enables you to customize verification checks during IP address device creation. See "Creating a Single IP Address Device" and "Creating a Range of IP Address Devices".
PCM_OP_IP_POL_DEVICE_DELETE	Recommended. Enables you to customize verification checks during IP address device deletion. See "Deleting an IP Address Device".
PCM_OP_IP_POL_DEVICE_SET_ATTR	Recommended. Enables you to customize how to verify that an IP address device is in a state to accept changes. See "Modifying an IP Address Device".
PCM_OP_IP_POL_DEVICE_SET_STATE	Recommended. Enables you to customize how to verify that an IP address device is eligible to accept a device state change. See "Changing IP Device States from Unallocated to Returned".

IP Address Manager FM Standard Opcodes

The IP Address Manager standard opcodes create, delete, and maintain the attributes and state of one or more IP address devices.

See the discussion on IP Address Manager in BRM Telco Integration.

Include the ops/ip.h header file in all applications that call these opcodes.

Table 1-40 IP Address Manager FM Standard Opcodes

Opcode	Description
PCM_OP_IP_DEVICE_CREATE	Recommended. Creates one or more IP address devices. See "Creating a Single IP Address Device" and "Creating a Range of IP Address Devices".
PCM_OP_IP_DEVICE_DELETE	Recommended. Deletes one or more IP address devices. See "Deleting an IP Address Device".
PCM_OP_IP_DEVICE_SET_ATTR	Recommended. Sets the attributes for one or more IP address devices. See "Modifying an IP Address Device".
PCM_OP_IP_DEVICE_SET_STATE	Recommended. Sets the device state for one or more IP devices. See "Changing IP Device States from Unallocated to Returned".

Job FM Standard Opcodes

Use the Job standard opcodes to run BRM applications and business operations jobs.

Include the ops/job.h header file in all applications that call these opcodes.

Table 1-41 Job FM Standard Opcodes

Opcode	Description
PCM_OP_JOB_EXECUTE	Recommended Runs business operations jobs or BRM applications. See the following: "How Business Operations Center Runs Jobs" in BRM System Administrator's Guide. "Running Business Operation Jobs" "Running BRM Applications"
PCM_OP_JOB_PROCESS_TEMPLATE	Recommended Creates, modifies, or deletes /job_template objects. See "Managing Business Operations Job Templates".

LDAP Base Opcodes

The LDAP opcodes are the base opcodes as implemented by LDAP Manager. These Base opcodes may be used by any of the opcodes in the BRM system to perform basic operations. Unlike all other opcodes, which belong to the Connection Manager, the base opcodes are part of the Data Manager.

For more information, see BRM LDAP Manager and "Base Opcodes".

Include the ops/base.h header file in all applications that call these opcodes.

Table 1-42 LDAP Base Opcodes

Opcode	Description
PCM_OP_CREATE_OBJ	Recommended. Creates new directory server entries or reuses entries in the directory server for replication purposes.
PCM_OP_DELETE_FLDS	Recommended. Deletes values and attributes in a directory server entry. This opcode performs the delete operation by using the LDAP modify operation, which imposes delete semantics.
PCM_OP_DELETE_OBJ	Recommended. Deletes an entire entry from the directory server. Invokes the delete entry semantics of the LDAP modify operation in the directory server.
PCM_OP_READ_FLDS	Recommended. Reads attributes from a directory server entry from the database using the LDAP search operation.
PCM_OP_READ_OBJ	Recommended. Reads an entire object from the database using the LDAP search operation.
PCM_OP_SEARCH	Recommended. Searches the directory server based on a specified search criteria. Only those objects and attributes that you define in the mapping file can be returned by the LDAP Data Manager in the output flist.
PCM_OP_TEST_LOOPBACK	Recommended. Tests directory server connections. Verifies that the LDAP Data Manager and the directory server daemon/service processes are running and communicating with each other.
PCM_OP_WRITE_FLDS	Recommended. Updates attributes in a directory server entry or renames entries. This opcodes performs the following operations: Updates attributes by using the LDAP modify operation. Uses the replace semantics of the LDAP modify operation. Renames directory server entries

Loan FM Policy Opcodes

Use the loan policy opcodes to customize loan eligibility, granting, recovery, and reset fields in loan profiles.

See "Configuring Loans" in BRM Configuring and Collecting Payments.

Include the ops/loan.h header file in all applications that call these opcodes.

Table 1-43 Loan FM Policy Opcodes

Opcode	Description
PCM_OP_LOAN_POL_ELIGIBILITY	Recommended. Enables you to customize the eligibility verification for loans. See "Customizing Loan Eligibility Checks."
PCM_OP_LOAN_POL_PRE_APPLY_LOAN	Recommended. Enables you to customize the loan grant process. See "Customizing Loan Grants."
PCM_OP_LOAN_POL_PRE_RECOVER_LOAN	Recommended. Enables you to customize the loan recovery process. See "Customizing Loan Recovery."
PCM_OP_LOAN_POL_RESET_CYCLE	Recommended Enables you to reset fields in the /profile/loan object. See "Resetting a Loan Cycle and Other Loan Profile Fields".

Loan FM Standard Opcodes

The loan standard opcodes verify loan eligibility, apply loans, retrieve loans, and manage the loan cycle.

See the "Configuring Loans" in BRM Configuring and Collecting Payments.

Include the ops/loan.h header file in all applications that call these opcodes.

Table 1-44 Loan FM Standard Opcodes

Opcode	Description
PCM_OP_LOAN_ELIGIBILITY	Recommended. Checks whether a customer is eligible for a requested loan. See "Checking a Customer's Eligibility for a Loan".
PCM_OP_LOAN_APPLY_LOAN	Recommended. Grants a loan to an eligible customer. See "Granting a Loan".
PCM_OP_LOAN_GET_LOAN	Recommended. Retrieves the list of loans for an account. See "Retrieving Loan Information".
PCM_OP_LOAN_POL_RESET_CYCLE	Recommended Resets the loan cycle date. See "Resetting a Loan Cycle and Other Loan Profile Fields".

Monitor FM Standard Opcodes

The monitor standard opcodes enable your customers to monitor the balance of a group of accounts in near real time.

See "Managing Balance Monitoring Groups" in BRM Managing Customers.

Include the ops/monitor.h header file in all applications that call these opcodes.

Table 1-45 Monitor FM Standard Opcodes

Opcode	Description
PCM_OP_MONITOR_ACCOUNT_HIERARCHY	Recommended. Adds members to hierarchy-type balance monitors when an account hierarchy changes. See the following: Adding Members to Newly Created Sharing Groups Automatically Adding Members to Hierarchy-Type Sharing Groups Automatically
PCM_OP_MONITOR_BILLING_HIERARCHY	Recommended. Adds members to paying responsibility-type monitors when changes occur in an account hierarchy. See the following: Adding Members to Newly Created Sharing Groups Automatically Adding Members to Paying Responsibility-Type Sharing Groups Automatically
PCM_OP_MONITOR_HIERARCHY_CLEANUP	Recommended. Removes members from hierarchy-type or paying responsibility-type monitors when an account hierarchy changes. See the following: Adding Members to Newly Created Sharing Groups Automatically Removing Members from Balance Monitor Groups
PCM_OP_MONITOR_PROCESS_BILLING_MONITORS	Recommended. Adds members to payment responsibility-type balance monitors. See the following: Adding Members to Newly Created Sharing Groups Automatically Adding Members to Payment Responsibility-Type Balance Monitors
PCM_OP_MONITOR_PROCESS_HIERARCHY_MONITORS	Recommended. Adds members to hierarchy-type balance monitors. See the following: Adding Members to Newly Created Sharing Groups Automatically Adding Members to Hierarchy-Type Balance Monitors
PCM_OP_MONITOR_PROCESS_SERVICE_MONITORS	Recommended. Adds the following members to the balance monitor: the parent subscription service and all member services. See "Adding Members to Newly Created Sharing Groups Automatically".
PCM_OP_MONITOR_SERVICE_HIERARCHY	Recommended. Adds members to subscription-type monitors when a subscription group changes. See "Updating Subscription-Type Monitors Automatically".
PCM_OP_MONITOR_SETUP_MEMBERS	Recommended. Automatically adds members to a balance monitor when it is first created. This opcode is a wrapper opcode that, according to monitor group type, calls other standard monitor opcodes. See "Adding Members to Newly Created Sharing Groups Automatically".
PCM_OP_MONITOR_UPDATE_MONITORS	Recommended. Generates these events: /event/billing/monitor/update when an /ordered_balgrp object is created or modified. /event/billing/monitor/delete when an /ordered_balgrp object is deleted. See "Adding a Monitor Group to a Member's /ordered_balgrp Object".

Notification FM Standard Opcodes

Use the notification standard opcodes to manage messages that are sent to your customers through external notification applications.

See "Sending Messages to Customers through External Notification Applications" in BRM Managing Customers.

Include the ops/notification.h header file in all applications that call these opcodes.

Table 1-46 Notification FM Standard Opcodes

Opcode	Description
PCM_OP_NOTIFICATION_CALC_DELIVERY_TIME	Recommended. Calculates the customer's message delivery time. See "Calculating the Notification Delivery Time".
PCM_OP_NOTIFICATION_CREATE_SPECIFICATION	Recommended. Creates a notification specification. See "Creating Notification Specifications".
PCM_OP_NOTIFICATION_GET_LASTNOTIFY_TSTAMP	Recommended. Retrieves a customer's message delivery time range and offset value. See "Retrieving Last Notification Time and Offset".
PCM_OP_NOTIFICATION_GET_SPECIFICATION	Recommended. Retrieves the specified notification specification. See "Retrieving Notification Specifications".
PCM_OP_NOTIFICATION_MODIFY_SPECIFICATION	Recommended. Modifies the specified notification specification. See "Modifying Notification Specifications".
PCM_OP_NOTIFICATION_PROCESS_NOTIFICATION	Recommended. Manages in-advance and post-expiration notifications. See "Managing In-Advance and Post-Expiration Notifications".
PCM_OP_NOTIFICATION_VERIFY_PUBLISH_REQUIRED	Recommended. Verifies a customer's opt-in or opt-out preferences for receiving notification messages. See "Verifying Customer Opt-In Preferences".

Notification FM Policy Opcodes

Use the notification policy opcodes to customize messages that are sent to your customers through external notification applications.

See "Sending Messages to Customers through External Notification Applications" in BRM Managing Customers.

Include the ops/notification.h header file in all applications that call these opcodes.

Table 1-47 Notification FM Standard Opcodes

Opcode	Description
PCM_OP_NOTIFICATION_POL_GET_SPECIFICATION	Recommended. Enables you to customize the notification specification retrieval process. See "Customizing Notification Retrieval".
PCM_OP_NOTIFICATION_POL_PREP_SPECIFICATION	Recommended. Enables you to customize notification specifications. See "Preparing Notification Specifications".
PCM_OP_NOTIFICATION_POL_VALID_SPECIFICATION	Recommended. Enables you to customize validation of the notification specifications. See "Validating Notification Specifications".

Number Manager FM Policy Opcodes

Use the Number Manager policy opcodes to customize Number Manager.

See the discussion on Number Manager in BRM Telco Integration.

Include the ops/num.h header file in all applications that call these opcodes.

Table 1-48 Number Manager FM Policy Opcodes

Opcode	Description
PCM_OP_NUM_POL_CANONICALIZE	Recommended. Enables you to customize number normalization when receiving numbers from applications and outputting numbers to other opcodes or applications. See "Customizing Number Normalization".
PCM_OP_NUM_POL_DEVICE_ASSOCIATE	Recommended. Enables you to customize the rules for associating or disassociate a number and a service. See "Customizing How Numbers Are Associated with Services".
PCM_OP_NUM_POL_DEVICE_CREATE	Recommended. Enables you to customize number validation to make sure the number is unique in the database. See "Customizing Telephone Number Attributes".
PCM_OP_NUM_POL_DEVICE_DELETE	Recommended. Enables you to customize number deletion. See "Deleting a Number".
PCM_OP_NUM_POL_DEVICE_SET_ATTR	Recommended. Enables you to customize which digits in a number can be changed. See "Customizing How a Number Can Be Changed".

Number Manager FM Standard Opcodes

The Number Manager standard opcodes create and modify blocks of numbers, manage number quarantine, and manage number portability.

See the discussion on Number Manager in BRM Telco Integration.

Include the ops/num.h header file in all applications that call these opcodes.

Table 1-49 Number Manager FM Standard Opcodes

Opcode	Description
PCM_OP_NUM_CREATE_BLOCK	Recommended. Creates a block of telephone numbers. See "Creating Blocks of Numbers".
PCM_OP_NUM_MODIFY_BLOCK	Recommended. Modifies a block of numbers, for example, changes the block name or numbers. See "Modifying Blocks of Numbers".
PCM_OP_NUM_PORT_IN	Limited Creates a number device by using the provided number. See "Managing Number Portability".
PCM_OP_NUM_PORT_OUT	Limited Sets the status of the provided number device to quarantine_port_out. See "Managing Number Portability".
PCM_OP_NUM_QUARANTINE	Recommended. Either creates or deletes a /schedule/device object to manage the telephone number quarantine. See "Managing Number Quarantine".
PCM_OP_NUM_SPLIT_BLOCK	Recommended. Splits an existing block of numbers into two or more blocks. See "Splitting Blocks of Numbers".

Offer Profile FM Standard Opcode

The offer profile standard opcodes create and manage the offer profile.

See the discussion on managing offer profiles with offer profile opcodes in BRM Setting Up Pricing and Rating.

Include the ops/offer_profile.h header file in all applications that call these opcodes.

Table 1-50 Offer Profile FM Standard Opcode

Opcode	Description
PCM_OP_OFFER_PROFILE_SET_OFFER_PROFILE	Limited Creates, modifies, or deletes the offer profiles (/offer_profile objects).

Order FM Policy Opcodes

Use the order policy opcodes to customize order management.

See the discussion on managing orders in BRM Developer's Guide.

Include the ops/device.h header file in all applications that call these opcodes.

Table 1-51 Order FM Policy Opcodes

Opcode	Description
PCM_OP_ORDER_POL_ASSOCIATE	Recommended. Enables you to customize validation during order association and disassociation.
PCM_OP_ORDER_POL_CREATE	Recommended. Enables you to customize validation during order creation.
PCM_OP_ORDER_POL_DELETE	Recommended. Enables you to customize validation during order deletion.
PCM_OP_ORDER_POL_PROCESS	Recommended. Enables you to customize processing of the order response. This opcode is called by PCM_OP_ORDER_PROCESS.
PCM_OP_ORDER_POL_SET_ATTR	Recommended. Enables you to customize how to validate order attribute changes. This opcode is called by PCM_OP_ORDER_SET_ATTR.
PCM_OP_ORDER_POL_SET_STATE	Recommended. Enables you to customize order state changes. This opcode is called by PCM_OP_ORDER_SET_STATE. Policy opcodes called during state changes are specified in the /config/order_state object.

Order FM Standard Opcodes

The order standard opcodes create, delete, and update /order objects.

See the discussion on orders in BRM Developer's Guide.

Include the ops/order.h header file in all applications that call these opcodes.

Table 1-52 Order FM Standard Opcodes

Opcode	Description
PCM_OP_ORDER_ASSOCIATE	Recommended. Associates or disassociates an order with a master /order object.
PCM_OP_ORDER_CREATE	Recommended. Creates an /order object.
PCM_OP_ORDER_DELETE	Recommended. Deletes an /order object.
PCM_OP_ORDER_PROCESS	Recommended. Processes the response of the order.
PCM_OP_ORDER_SET_ATTR	Limited Sets attribute values for an /order object.
PCM_OP_ORDER_SET_STATE	Limited Sets the state for an /order object.
PCM_OP_ORDER_UPDATE	Recommended. Updates the state or attributes for an /order object.

Payment FM Policy Opcodes

Use the payment policy opcodes to manipulate A/R functions and collect payments from customers.

See BRM Configuring and Collecting Payments for more information.

Include the ops/pymt.h header file in all applications that call these opcodes.

Table 1-53 Payment FM Policy Opcodes

Opcode	Description
PCM_OP_PYMT_POL_APPLY_FEE	Recommended. Enables you to customize payment fees by preprocessing, filtering, and extending the information available in failed payment fee events. See "Applying Payment Fees" and "Customizing Payment Fees" for more information.
PCM_OP_PYMT_POL_CHARGE	Limited. Enables you to map the online and offline payment result to the payment status and the reason IDs defined in the /strings object. See "BRM-Initiated Payment Processing" for more information.
PCM_OP_PYMT_POL_COLLECT	Recommended. Enables you to customize the results of a credit card transaction. See "Processing the Results of Credit Card Transactions" for more information.
PCM_OP_PYMT_POL_EXEC_COLLECTIONS_ACTION	Recommended. Completes a promise-to-pay installment as part of the payment process. See "Completing Promise-to-Pay Installments during Payment Processing".
PCM_OP_PYMT_POL_GRANT_INCENTIVE	Recommended. Enables you to enrich the PCM_OP_PYMT_GRANT_INCENTIVE input flist by specifying additional event attributes used to determine whether a payment incentive is granted. See "Customizing Payment Incentives".
PCM_OP_PYMT_POL_MBI_DISTRIBUTE	Recommended. Enables you to customize the default payment distribution logic to distribute the submitted account payment to multiple bill units. See "Allocating Externally Initiated Payments by Due Amount" for more information.
PCM_OP_PYMT_POL_OVER_PAYMENT	Recommended. Enables you to customize how to allocate payments when there is an overpayment. See "How BRM Selects the Items to Which Payments Are Applied" for more information.
PCM_OP_PYMT_POL_PRE_COLLECT	Recommended. Enables you to check a batch of charges and refunds for any amounts below minimums before charging and refunding customers. See "BRM-Initiated Payment Processing" and "Externally Initiated Payment Processing" for more information.
PCM_OP_PYMT_POL_PROVISION_INCENTIVE	Recommended. Enables you to customize how to determine the payment date that should be considered when provisioning incentives. See "Customizing Payment Incentives".
PCM_OP_PYMT_POL_PURCHASE_DEAL	Recommended. Enables you to customize how to apply custom discounts and incentives to account balances when an account is topped up. See "Processing Top-Ups" for more information.
PCM_OP_PYMT_POL_SPEC_COLLECT	Recommended. Enables you to customize how much should be collected from an account after a specified action has been performed. See "Processing Credit Card Information during Account Creation" for more information.
PCM_OP_PYMT_POL_SPEC_VALIDATE	Recommended. Enables you to customize how to change the account used for credit card validation. See "Validating Credit Card and Direct Debit Transactions" for more information.
PCM_OP_PYMT_POL_SUSPEND_PAYMENT	Recommended. Enables you to customize how to send a payment marked for suspense to the payment suspense account. See "Validating Payments" for more information.
PCM_OP_PYMT_POL_UNDER_PAYMENT	Recommended. Enables you to customize how to allocate payments when there is an underpayment. See "How BRM Selects the Items to Which Payments Are Applied" for more information.
PCM_OP_PYMT_POL_VALID_VOUCHER	Recommended. Enables you to customize how to interact with voucher management systems to validate vouchers. See "How BRM Handles Manual Standard Top-Ups" and the discussion on vouchers in BRM Telco Integration.
PCM_OP_PYMT_POL_VALIDATE	Recommended. Enables you to customize the result of validating a credit card transaction, including a description of that result. See "Validating Credit Card and Direct Debit Transactions" for more information.
PCM_OP_PYMT_POL_VALIDATE_PAYMENT	Recommended. Enables you to customize how to validate payments to determine whether they can be successfully posted or whether a failed, unconfirmed payment needs reversal. See "Validating Payments" for more information.

Payment FM Standard Opcodes

The payment standard opcodes collect payments and validate payment methods.

See BRM Configuring and Collecting Payments for more information.

Include the ops/pymt.h header file in all applications that call these opcodes.

Table 1-54 Payment FM Standard Opcodes

Opcode	Description
PCM_OP_PYMT_APPLY_FEE	Recommended. Creates payment fees for payments that fail, for example, due to insufficient account funds or an expired credit card. See "Processing Payment Fees" for more information.
PCM_OP_PYMT_CHARGE	Limited. Performs a BRM-initiated payment transaction. See: BRM-Initiated Payment Processing Initiating a Charge Processing Credit Card Charges Processing Direct Debit Charges
PCM_OP_PYMT_CHARGE_CC	Last Resort. Performs an online credit card transaction. See "Processing Credit Card Charges" for more information.
PCM_OP_PYMT_CHARGE_DD	Recommended. Performs a batch of Paymentech direct debit transactions. See "Processing Direct Debit Charges" for more information.
PCM_OP_PYMT_CHARGE_DDEBIT	Recommended. Performs a debit card transaction. This opcode is used for the Paymentech direct debit implementation. See "About Paymentech Direct Debit Implementation".
PCM_OP_PYMT_COLLECT	Recommended. Performs payment collections and refunds. See: Collecting Payments Allocating Account Payments to Multiple Bill Units
PCM_OP_PYMT_FIND_TOPUP_EVENTS	Limited. Finds the /event/billing/adjustment/account event associated with sponsored top-ups. See "Finding Top-Up Events".
PCM_OP_PYMT_GET_ACH_INFO	Recommended. Retrieves the database ID of the DM interfacing with the automated clearing house using available information such as vendor name or element ID in the /config/ach object. See "Processing Credit Card Information during Account Creation" for more information.
PCM_OP_PYMT_GRANT_INCENTIVE	Limited. Applies a payment incentive to a bill during the billing run. See "Granting Payment Incentives" for more information.
PCM_OP_PYMT_ITEM_SEARCH	Limited. Searches for /item objects with a variable number of input parameters. This opcode calls PCM_OP_SEARCH based on the input argument fields. See "Finding Payments" for more information.
PCM_OP_PYMT_MBI_DISTRIBUTE	Limited. Distributes the account payment to multiple bill units. See "Allocating Externally Initiated Payments by Due Amount" for more information.
PCM_OP_PYMT_MBI_ITEM_SEARCH	Limited. Gets all the items of the bill units in a tree view. See "Allocating Account Payments to Multiple Bill Units".
PCM_OP_PYMT_PROVISION_INCENTIVE	Limited. Evaluates a payment to determine whether a payment incentive should be provisioned and, if so, sets the payment incentive trigger. See "Processing Payment Incentives" for more information.
PCM_OP_PYMT_RECOVER	Recommended. Checks results of charges sent in a batch and posts results of charges for which no information was returned. See "Checking the Results of BRM-Initiated Batch Payment Operations" for more information.
PCM_OP_PYMT_RECOVER_CC	Limited. Checks results of credit card charges sent in a batch and posts results of credit card charges for which no information was returned. See "Checking the Results of BRM-Initiated Batch Payment Operations" for more information.
PCM_OP_PYMT_RECOVER_DD	Limited. Checks results of direct debit charges sent in a batch. The results are passed back and used for transaction reconciliation. This opcode is specific to the Paymentech DM. See "Checking the Results of BRM-Initiated Batch Payment Operations" for more information.
PCM_OP_PYMT_RECYCLE_PAYMENT	Limited. Processes payment reversals during payment recycling and assigns action owner codes to suspended payments. See "How Payments Are Recycled to and from Suspense" for more information.
PCM_OP_PYMT_RECYCLED_PAYMENTS_SEARCH	Limited. Searches for recycled payments that have not been reversed, including those recycled to the payment suspense account. See "Retrieving Recycled Payments" for more information.
PCM_OP_PYMT_REVERSE_INCENTIVE	Limited. Reverses a payment incentive, provided the incentive has not yet been applied. See "Reversing Payment Incentives" for more information.
PCM_OP_PYMT_SELECT_ITEMS	Limited. Identifies a list of items based on the input fields and the accounting type of the account. See "How BRM Selects the Items to Which Payments Are Applied" for more information.
PCM_OP_PYMT_TOPUP	Recommended. Performs standard top-ups and sponsored top-ups. See "Processing Top-Ups" for more information.
PCM_OP_PYMT_VALIDATE	Recommended. Validates a credit card or direct debit transaction. See "Validating Payments" and "About the Default Payment Validation Process" for more information.
PCM_OP_PYMT_VALIDATE_CC	Limited. Performs a batch of credit card validations and applies the validation policy to the results. See "Validating Credit Card and Direct Debit Transactions" for more information.
PCM_OP_PYMT_VALIDATE_DD	Limited. Performs a batch of online direct debit validations and applies the validation policy to the results. See "Validating Credit Card and Direct Debit Transactions" for more information.
PCM_OP_PYMT_VALIDATE_PAYMENT	Recommended. Validates payment records. See "Validating Payments" and "About the Default Payment Validation Process" for more information.

Permissioning FM Standard Opcodes

The permissioning standard opcodes create and manage Access Control Lists (ACLs), which specify the CSRs that can access customer accounts in an account group.

Include the ops/perm.h header file in all applications that call these opcodes.

Table 1-55 Permissioning FM Standard Opcodes

Opcode	Description
PCM_OP_PERM_ACL_GET_SUBGROUPS	Limited Retrieves a particular account group (/group/billing hierarchy) beneath the provided access control list. See "Managing ACL Groups".
PCM_OP_PERM_ACL_GROUP_CREATE	Limited Creates a /group/acl object.
PCM_OP_PERM_ACL_GROUP_DELETE	Limited Deletes a /group/acl object. Deleting an ACL does not affect services. It simply removes the ACL.
PCM_OP_PERM_ACL_GROUP_MODIFY	Limited Modifies a /group/acl object.
PCM_OP_PERM_ACL_GROUP_ADD_MEMBER	Limited Adds a group member to a /group/acl.
PCM_OP_PERM_ACL_GROUP_DELETE_MEMBER	Limited Deletes a group member from a /group/acl
PCM_OP_PERM_FIND	Limited Retrieves a list of Access Control Lists (ACLs) to which a CSR belongs and returns user specified information about each ACL. See "Finding CSR Membership".
PCM_OP_PERM_GET_CREDENTIALS	Limited Retrieves a list of ACLs and billing groups that can access an application.
PCM_OP_PERM_SET_CREDENTIALS	Limited Sets the current connection scope. Scope is defined by the billing group.

Process Audit FM Policy Opcodes

Use the process audit policy opcodes to create audit objects with revenue assurance data.

For more information about collecting revenue assurance data, see the discussion on understanding Revenue Assurance Manager in BRM Collecting Revenue Assurance Data.

Include the BRM_home/include/ops/process_audit.h header file in all applications that call these opcodes.

Table 1-56 Process Audit FM Policy Opcodes

Opcode	Description
PCM_OP_PROCESS_AUDIT_POL_CREATE	Recommended. Checks for duplicate audit objects and validates audit data. You can customize this opcode by modifying the fields in the flist, modifying duplicate checks, and adding validation checks. This opcode is called by PCM_OP_PROCESS_AUDIT_CREATE. The transaction handling for this opcode is done in the standard opcode.
PCM_OP_PROCESS_AUDIT_POL_ALERT	Recommended. Sends email messages when threshold values are crossed. You can customize this opcode to notify an external system and change the message body or subject of the email. This opcode is not called by any opcode.
PCM_OP_PROCESS_AUDIT_POL_CREATE_WRITEOFF_SUMMARY	Recommended. Called by PCM_OP_PROCESS_AUDIT_CREATE_WRITEOFF_SUMMARY opcode to map the fields of /suspended_usage/telco to fields of /process_audit/batchstat/status. You can customize this opcode to read and aggregate any fields of the /suspended_usage/xxx storable class, where xxx are subclasses of /suspended_usage, and map them to corresponding fields in the /process_audit/batchstat/status storable class. This opcode is called by PCM_OP_PROCESS_AUDIT_CREATE_WRITEOFF_SUMMARY. The transaction handling for this opcode is done in the standard opcode.

Process Audit FM Standard Opcodes

The process audit standard opcodes are called by billing utilities to create audit objects with revenue assurance data.

For more information about collecting revenue assurance data, see the discussion on understanding Revenue Assurance Manager in BRM Collecting Revenue Assurance Data.

Include the BRM_home/include/ops/process_audit.h header file in all applications that call these opcodes.

Table 1-57 Process Audit FM Standard Opcodes

Opcode	Description
PCM_OP_PROCESS_AUDIT_CREATE	Recommended. Creates audit objects for revenue assurance. Called by the BRM billing applications.
PCM_OP_PROCESS_AUDIT_CREATE_WRITEOFF_SUMMARY	Recommended. Creates /process_audit/batchstat/status objects with revenue assurance data for written-off records. Checks the PIN_FLD_FLG in the input flist during bulk suspense operations: If PIN_FLD_FLG is zero, generates a normal summary. If PIN_FLD_FLG is nonzero, creates a /schedule object after checking the mandatory fields. If PIN_FLD_FLG is nonzero and the calling opcode is PCM_OP_ACT_SCHEDULE_EXECUTE, creates a bulk write-off summary.
PCM_OP_PROCESS_AUDIT_SEARCH	Recommended. Retrieves summary and detail data for control points for /process_audit/batchstat objects and subclasses.

Provisioning FM Policy Opcode

Use the provisioning policy opcode to customize provisioning.

See the discussion on managing GSM service provisioning in BRM Managing Customers.

Include the ops/prov.h header file in all applications that call these opcodes.

Table 1-58 Provisioning FM Policy Opcode

Opcode	Description
PCM_OP_PROV_POL_UPDATE_SVC_ORDER	Recommended. Enables you to customize how to validate and modify parameters for updating service orders. See "Managing GSM Service Provisioning".

Provisioning FM Standard Opcodes

The provisioning standard opcodes manage service order provisioning.

See the discussion on managing GSM service provisioning in BRM Managing Customers.

Include the ops/prov.h header file in all applications that call these opcodes.

Table 1-59 Provisioning FM Standard Opcodes

Opcode	Description
PCM_OP_PROV_PUBLISH_SVC_ORDER	Recommended. Sends a /event/provisioning/service_order/* event to the Provisioning Data Manager. See "Managing GSM Service Provisioning".
PCM_OP_PROV_UPDATE_SVC_ORDER	Recommended. Updates the status of an /event/provisioning/service_order/* event. See "Managing GSM Service Provisioning".

Publish FM Policy Opcodes

Use the publish policy opcodes to customize the notifications being published to the EAI Framework.

Include the ops/fm_publish_pol.h header file in all applications that call these opcodes.

Table 1-60 Publish FM Policy Opcode

Opcode	Description
PCM_OP_PUBLISH_POL_PREP_EVENT	Recommended. Enables you to customize the notifications that are published to the EAI Framework. See "Customizing Notification Enrichment" in BRM Developer's Guide.

Rating FM Policy Opcodes

The rating policy opcodes are called by Activity FM opcodes to calculate charges and taxes for an event.

Include the ops/rate.h header file in all applications that call these opcodes.

Table 1-61 Rating FM Policy Opcodes

Opcode	Description
PCM_OP_RATE_POL_GET_TAXCODE	Recommended. Enables you to customize the tax code information from the taxcodes.map file. See "Retrieving a List of Tax Codes".
PCM_OP_RATE_POL_GET_TAX_SUPPLIER	Recommended. Enables you to customize a list of tax suppliers retrieved from the /profile/tax_supplier object. See "Retrieving a List of Tax Suppliers".
PCM_OP_RATE_POL_MAP_TAX_SUPPLIER	Recommended. Enables you to customize how a tax supplier is chosen for an event. See "Retrieving a List of Tax Suppliers".
PCM_OP_RATE_POL_POST_RATING	Recommended. Enables you to modify rated /event objects, for example, change the G/L ID of an event. See "Modifying Rated Events".
PCM_OP_RATE_POL_PRE_RATING	Recommended. Enables you to modify subscription events before rating. See "Modifying Rated Events".
PCM_OP_RATE_POL_PROCESS_ERAS	Recommended. Enables you to add extended rating attribute (ERA) information to an event. See "Modifying ERAs".
PCM_OP_RATE_POL_POST_TAX	Recommended. Enables you to modify data after taxes are calculated. See "Modifying Tax Data After Calculating Taxes".
PCM_OP_RATE_POL_PRE_TAX	Recommended. Enables you to modify data before you send the data to the taxation DM for calculating taxes. See "Modifying Tax Data Before Calculating Taxes".
PCM_OP_RATE_POL_TAX_LOC	Last Resort Enables you to retrieve locations for an event, which are then used to establish jurisdictions for tax calculation. See "Retrieving Tax Location Data".

Rating FM Standard Opcodes

The rating standard opcodes are called by Activity FM opcodes to calculate charges and taxes for an event.

Include the ops/rate.h header file in all applications that call these opcodes.

Table 1-62 Rating FM Standard Opcodes

Opcode	Description
PCM_OP_RATE_EVENT	Last Resort Applies pricing and taxes to a subscription event. See "Subscription Rating Opcodes".
PCM_OP_RATE_GET_ERAS	Last Resort Retrieves the extended rating attribute (ERAs) for an event. See "Getting ERAs for an Event".
PCM_OP_RATE_GET_PRODLIST	Last Resort Retrieves the list of charge offers owned by an account and filters them with input criteria. See "Subscription Rating Opcodes".
PCM_OP_RATE_TAX_CALC	Last Resort Calculates taxes due at the time of purchase or billing. See "How PCM_OP_RATE_TAX_CALC Calculates Taxes".
PCM_OP_RATE_TAX_EVENT	Last Resort Directs the calculation of taxes. See "Subscription Rating Opcodes".

Remittance FM Policy Opcodes

Use the remittance policy opcode to customize remittance criteria.

Include the ops/remit.h header file in all applications that call these opcodes.

Table 1-63 Remittance FM Policy Opcodes

Opcode	Description
PCM_OP_REMIT_POL_SPEC_QTY	Recommended. Retrieves the quantity to be rated for a customized RUM. See "Customizing Remittance" in BRM Configuring and Running Billing.

Remittance FM Standard Opcodes

The remittance standard opcodes manage remittance.

Include the ops/remit.h header file in all applications that call these opcodes.

Table 1-64 Remittance FM Standard Opcodes

Opcode	Description
PCM_OP_REMIT_GET_PROVIDER	Limited Retrieves a list of remittance accounts that need to be remitted when a particular event occurs. See "Retrieving Remittance Accounts" in BRM Configuring and Running Billing.
PCM_OP_REMIT_REMIT_PROVIDER	Limited Calculates the remittance amount. See "Calculating the Remittance Amount" in BRM Configuring and Running Billing.
PCM_OP_REMIT_VALIDATE_SPEC_FLDS	Limited Validates remittance criteria. See "Verifying the Remittance Specification File" in BRM Configuring and Running Billing.

Replication FM Policy Opcode

The replication policy opcode implements the translation logic for /account and /service objects.

Include the ops/repl.h header file in all applications that call these opcodes.

Table 1-65 Replication FM Policy Opcode

Opcode	Description
PCM_OP_REPL_POL_PUSH	Recommended. Enables you to implement the translation logic for /account and /service objects.This opcode is the BRM interface for the LDAP Data Manager mapping operations. By default, the LDAP Data Manager implements a single-entry mapping operation. See the discussion on understanding the replication policy push operation in BRM LDAP Manager.

Rerating FM Standard Opcode

The rerating standard opcode calls other standard opcodes to create /job/rerate objects and /job_batch/rerate objects.

Include the ops/rerate.h header file in all applications that call these opcodes.

Table 1-66 Rerating FM Standard Opcode

Opcode	Description
PCM_OP_RERATE_INSERT_RERATE_REQUEST	Recommended. Calls other opcodes to create /job/rerate objects and /job_batch/rerate objects. See "How BRM Creates Rerate Jobs".

SDK FM Standard Opcodes

The SDK standard opcodes add, delete, and modify data dictionary components, including opcode mapping, storable classes, and fields.

See the discussion on the BRM SDK in BRM Developer's Guide.

Include the ops/sdk.h header file in all applications that call these opcodes.

Table 1-67 SDK FM Standard Opcodes

Opcode	Description
PCM_OP_SDK_DEL_FLD_SPECS	Limited. Deletes field specifications from all database schemas in your BRM system. Caution: If you delete field specifications for fields that have been instantiated, you will corrupt your database. For example, never delete PIN_FLD_POID from a base BRM system. Because of this danger, we recommend that you do not use this opcode on a production system.
PCM_OP_SDK_DEL_OBJ_SPECS	Limited. Deletes storable class specifications from the data dictionary of all database schemas in your BRM system. Caution: If you delete a storable class that has been instantiated, you will corrupt your database. For example, never delete the /account object. Because of this danger, we recommend that you do not use this opcode on a production system.
PCM_OP_SDK_GET_FLD_SPECS	Limited. Retrieves one or more field specifications.
PCM_OP_SDK_GET_OBJ_SPECS	Limited. Retrieves one or more storable class specifications.
PCM_OP_SDK_SET_FLD_SPECS	Limited. Creates or modifies field specifications. Caution: If you change field specifications for fields that have been instantiated, you will corrupt your database. Instead of using this opcode, it is safer and more reliable to create or modify field specifications by using the Storable Class Editor in Developer Center.
PCM_OP_SDK_SET_OBJ_SPECS	Limited. Creates or modifies a storable class. Caution: If you change field specifications for fields that have been instantiated, you will corrupt your database. Instead of using this opcode, it is safer and more reliable to create or modify field specifications by using the Storable Class Editor in Developer Center.

Services Framework Manager FM Policy Opcodes

The services framework opcodes are used for provisioning any prepaid service type.

See the discussion on the BRM SDK in BRM Developer's Guide.

Include the ops/tcf.h header file in all applications that call these opcodes.

Table 1-68 Services Framework Manager FM Policy Opcodes

Opcode	Description
PCM_OP_TCF_POL_APPLY_PARAMETER	Recommended. Enables you to to map service types to specific opcodes when associating APNs and QoS values with GPRS services. See "Mapping Service Types to Service-Specific Opcodes".
PCM_OP_TCF_POL_PROV_HANDLE_SVC_ORDER	Recommended. Enables you to perform custom actions to a provisioning service order before it is passed to dm_prov_telco. See "Provisioning Process Opcode Flow".

Services Framework Manager FM Provisioning Opcodes

The service framework provisioning opcodes perform provisioning functions.

See the discussion on provisioning in BRM Telco Integration.

Include the ops/tcf.h header file in all applications that call these opcodes.

Table 1-69 Services Framework Manager FM Provisioning Opcodes

Opcode	Description
PCM_OP_TCF_APPLY_PARAMETER	Recommended. Updates the objects impacted by the charge offer provisioning update. See "Associating APNs and QoS with GPRS Services".
PCM_OP_TCF_SVC_LISTENER	Recommended. Checks the action's start and end date and performs one of the following: If it is a current action, this opcode calls PCM_OP_TCF_APPLY_PARAMETER. If the action is deferred for the future, this opcode creates a /schedule object for executing PCM_OP_TCF_APPLY_PARAMETER at the scheduled time. See "Associating APNs and QoS with GPRS Services".
PCM_OP_TCF_PROPAGATE_STATUS	Recommended. When the service status changes to inactive, active, or closed, this opcode propagates the status to any associated features and extended rating attributes (ERAs). When the status changes to closed, this opcode also disassociates any existing devices from the service.
PCM_OP_TCF_PROV_CREATE_SVC_ORDER	Recommended. Creates service orders for provisioning prepaid services, devices, and profiles. See "Provisioning Process Opcode Flow".
PCM_OP_TCF_PROV_HANDLE_SVC_ORDER	Recommended. Prepares provisioning event data for publishing to the provisioning DM and initiates status change to PROVISIONING. See "Provisioning Process Opcode Flow".
PCM_OP_TCF_PROV_UPDATE_PROV_OBJECT	Recommended. Updates the status of the /service/device object upon receiving the response from the provisioning platform. See "Provisioning Process Opcode Flow".
PCM_OP_TCF_PROV_UPDATE_SVC_ORDER	Recommended. Updates the /event/provisioning/service_order/telco object with the provisioning response specified in the opcode input flist. See "Provisioning Process Opcode Flow".
PCM_OP_TCF_PROV_SERVICE_ORDER_NOTIFY	Recommended. Performs service order state changes. See "Provisioning Process Opcode Flow".
PCM_OP_TCF_PROV_SERVICE_ORDER_SET_ATTR	Recommended. Updates a service order object. See "Provisioning Process Opcode Flow".
PCM_OP_TCF_PROV_SERVICE_ORDER_SET_STATE	Recommended. Sets the state for service order objects and validates the service order state transition using information stored in the configuration object. See "Provisioning Process Opcode Flow".

SIM Manager FM Policy Opcodes

Use the SIM Manager policy opcodes to customize SIM Manager.

See the discussion on SIM Card Manager in BRM Telco Integration.

Include the ops/sim.h header file in all applications that call these opcodes.

Table 1-70 SIM Manager FM Policy Opcodes

Opcode	Description
PCM_OP_SIM_POL_DEVICE_ASSOCIATE	Recommended. Enables you to customize how SIM cards and services are associated. See "Customizing SIM Card Number Changes".
PCM_OP_SIM_POL_DEVICE_CREATE	Recommended. Enables you to customize validation rules for creating SIM card devices. See "Customizing SIM Card Validation".
PCM_OP_SIM_POL_DEVICE_SET_ATTR	Recommended. Enables you to customize how SIM cards are associated with services. See "Customizing SIM Card Number Changes".
PCM_OP_SIM_POL_ORDER_CREATE	Recommended. Enables you to customize how to validate SIM card orders. See "Creating SIM Cards".

SIM Manager FM Standard Opcodes

The SIM Manager standard opcodes create and manage SIM card objects in the BRM database.

See the discussion on SIM Card Manager in BRM Telco Integration.

Include the ops/sim.h header file in all applications that call these opcodes.

Table 1-71 SIM Manager FM Standard Opcodes

Opcode	Description
PCM_OP_SIM_CREATE_ORDER	Recommended. Creates a SIM card order object (/order/sim). See "Creating and Updating SIM Card Orders".
PCM_OP_SIM_DEVICE_PROVISION	Recommended. Moves the device state from New to Provisioning, associates a service, and disassociates the pre-provisioning service. See "Provisioning SIM Cards".
PCM_OP_SIM_PROCESS_ORDER_RESPONSE	Recommended. Processes a vendor response file. See "Creating SIM Cards".
PCM_OP_SIM_UPDATE_ORDER	Recommended. Updates an existing SIM card order object (/order/sim). See "Creating and Updating SIM Card Orders".

Subscription Management FM Policy Opcodes

Use the subscription management policy opcodes to customize subscription services.

Include these header files in all applications that call these opcodes:

• ops/subscription.h
• ops/bill.h

See the header file for a list of the Subscription Management FM opcodes defined in that file.

Table 1-72 Subscription Management FM Policy Opcodes

Opcode	Description
PCM_OP_SUBSCRIPTION_POL_AUTO_SUBSCRIBE_MEMBERS	Recommended. Enables you to customize how to add sharing groups to ordered balance groups. See "Adding Members to a Profile Sharing Group".
PCM_OP_SUBSCRIPTION_POL_AUTO_SUBSCRIBE_SERVICE	Recommended. Enables you to customize how to add ordered balance groups. See "Adding Members to a Profile Sharing Group".
PCM_OP_SUBSCRIPTION_POL_CANCEL_PROD_PROVISIONING	Limited. Enables you to clear fields in a /service object when you cancel a charge offer. See "Customizing Provisioning When Canceling a Charge Offer".
PCM_OP_SUBSCRIPTION_POL_GENERATE_RERATE_REQUEST	Recommended. Enables you to customize automatic rerating or handle your own automatic rerating scenarios. See "How BRM Creates Rerate Jobs".
PCM_OP_SUBSCRIPTION_POL_GET_PROD_PROVISIONING_TAGS	Limited. Enables you to customize provisioning. See "Getting a List of Provisioning Tags".
PCM_OP_SUBSCRIPTION_POL_GET_SPONSORS	Recommended. Enables you to filter or return a subset of /sponsorship objects from the list of all available /sponsorship objects. See "Getting a List of Charges Available for Charge Sharing".
PCM_OP_SUBSCRIPTION_POL_POST_PROMO_EVENT	Recommended. Enables you to customize how promotions are applied to accounts. See "Customizing Special Date, Event, or Action Promotions".
PCM_OP_SUBSCRIPTION_POL_PRE_FOLD	Limited. Enables you to customize how folds are applied to currency and noncurrency balances. See "Customizing How Folds Are Applied".
PCM_OP_SUBSCRIPTION_POL_PRE_PROMO_EVENT	Recommended. Enables you to customize how promotions are rated. See "Customizing Special Date, Event, or Action Promotions".
PCM_OP_SUBSCRIPTION_POL_PREP_FOLD	Recommended. Enables you to customize the list of balances that must be folded when a charge offer is canceled. See "Customizing Which Balances to Fold When Charge Offers Are Canceled".
PCM_OP_SUBSCRIPTION_POL_PREP_MEMBERS	Recommended. Enables you to customize how to validate the members of a profile sharing group. See "Validating Profile Sharing Group Members".
PCM_OP_SUBSCRIPTION_POL_PRE_TRANSITION_DEAL	Recommended. Enables you to customize validation based on account data during bundle-to-bundle transition. See "Customizing Bundle Transitions".
PCM_OP_SUBSCRIPTION_POL_PRE_TRANSITION_PLAN	Recommended. Enables you to customize validation based on account data during package-to-package transition. See "Customizing Package Transitions without Configuring /transition Objects".
PCM_OP_SUBSCRIPTION_POL_PURCHASE_PROD_PROVISIONING	Limited. Enables you to customize provisioning when a charge offer is purchased. See "Customizing Provisioning When a Charge Offer Is Purchased".
PCM_OP_SUBSCRIPTION_POL_SNOWBALL_DISCOUNT	Recommended. Enables you to specify the distribution of group discounts to group members. See "Customizing Snowball Discounts".
PCM_OP_SUBSCRIPTION_POL_SPEC_CANCEL	Recommended. Enables you to customize how charge offers are canceled. See "Customizing Charge Offer Cancellation".
PCM_OP_SUBSCRIPTION_POL_SPEC_CANCEL_DISCOUNT	Recommended. Enables you to customize how discount offers are canceled. See "Customizing Discount Offer Cancellation".
PCM_OP_SUBSCRIPTION_POL_SPEC_CYCLE_FEE_INTERVAL	Recommended. Enables you to customize the time interval for applying cycle forward and cycle arrears fees for a specified charge offer. See "Customizing Accounting Cycles."
PCM_OP_SUBSCRIPTION_POL_SPEC_FOLD	Recommended. Enables you to specify the order in which to fold balances in a balance group. See "Customizing the Order to Apply Folds."
PCM_OP_SUBSCRIPTION_POL_SPEC_RERATE	Recommended. Enables you to define custom searches for rerating events for selected accounts. See "Customizing Event Searches for Rerating."
PCM_OP_SUBSCRIPTION_POL_VALIDATE_OFFERING	Recommended. Enables you to define custom validation of product specification attributes for pricing components. See "Validating Product Specification Attributes for Pricing Components."

Subscription Management FM Standard Opcodes

The subscription management standard opcodes manage subscription services.

Include these header files in all applications that call these opcodes:

• ops/subscription.h

• ops/bill.h

• ops/cust.h

See the header file for a list of the Subscription Management FM opcodes defined in that file.

Table 1-73 Subscription Management FM Standard Opcodes

Opcode	Description
PCM_OP_SUBSCRIPTION_CANCEL_DEAL	Recommended. Cancels ownership of a bundle for a specified account or service. See "How Bundles Are Canceled".
PCM_OP_SUBSCRIPTION_CANCEL_DISCOUNT	Recommended. Cancels the discount instances associated with the /account object or /service object specified in the input flist. See "How Discount Offers Are Canceled".
PCM_OP_SUBSCRIPTION_CANCEL_PRODUCT	Recommended. Cancels the charge offers for the /account object specified in the input flist. See "How Charge Offers Are Canceled".
PCM_OP_SUBSCRIPTION_CANCEL_SUBSCRIPTION	Recommended. Cancels a subscription service and its member services.
PCM_OP_SUBSCRIPTION_CHANGE_DEAL	Recommended. Changes the charge offers associated with a bundle for an account. See "How Bundles Are Modified".
PCM_OP_SUBSCRIPTION_CHANGE_OPTIONS	Recommended. Validates changes to bundles (for example, to check for prerequisite or mutually exclusive bundles). See "Validating Changes to Bundles".
PCM_OP_SUBSCRIPTION_CRUD_OFFER_OVERRIDE	Recommended. Specifies how and when to override charges and discounts during specified time periods. See "Overriding Charges and Discounts for a Period of Time".
PCM_OP_SUBSCRIPTION_CYCLE_ARREARS	Last Resort. Applies cycle arrears charges to an account. See "Applying Cycle Arrears Fees".
PCM_OP_SUBSCRIPTION_CYCLE_FOLD	Last Resort. Applies cycle fold events for an account. If successful, it returns the POIDs of the /account object and the /event/billing/product/fee/cycle/fold event. See "Applying Folds".
PCM_OP_SUBSCRIPTION_CYCLE_FORWARD	Last Resort. Applies cycle forward charges or refunds to an account. See "Applying Cycle Forward Fees".
PCM_OP_SUBSCRIPTION_GET_HISTORY	Recommended. Retrieves the event history for a bundle, charge offer, discount offer, or service instance associated with an account. See "Finding Events Associated with Bundles, Charge Offers, Discount Offers, and Services".
PCM_OP_SUBSCRIPTION_GET_PURCHASED_OFFERINGS	Recommended. Retrieves the purchased charge offers and discount offers associated with an account. See "Reading Data for All Valid Purchased Charge Offers and Discount Offers".
PCM_OP_SUBSCRIPTION_HANDLE_PROMO_EVENT	Recommended. Applies promotions to accounts. See "Applying Promotions for Special Dates, Events, or Actions".
PCM_OP_SUBSCRIPTION_ORDERED_BALGRP	Recommended. Creates, modifies, or deletes the ordered balance group (/ordered_balgrp object) for an account or service that is a member of a charge, discount, or profile sharing group. See "Managing Ordered Balance Groups".
PCM_OP_SUBSCRIPTION_ORDERED_BALGRP_BULK_MODIFY	Recommended. Creates one or more ordered balance groups (/ordered_balgrp objects) for an account or service. See "Creating and Modifying Multiple Ordered Balance Groups Simultaneously".
PCM_OP_SUBSCRIPTION_PREP_RATE_CHANGE	Recommended. Creates the /rate_change object, which stores details about the charge offers affected by a pricing change, including the price tiers and charges in the charge offer. See "Rerating Cycle Forward and Cycle Forward Arrears Events".
PCM_OP_SUBSCRIPTION_PROVISION_ERA	Recommended. This opcode creates, modifies, or deletes /profile objects. When specified in a /config/provisioning_tag object, this opcode runs when a charge offer or discount offer containing the provisioning tag is purchased or canceled. Profiles can store extended rating attributes (ERAs) and other custom attributes. See "Managing Provisioning" in BRM Implementing Charging.
PCM_OP_SUBSCRIPTION_PURCHASE_DEAL	Recommended. Purchases the charge offers and discount offers in a bundle for the account or service object specified in the input flist. See "How Bundles Are Purchased".
PCM_OP_SUBSCRIPTION_PURCHASE_DISCOUNT	Limited Allows purchase of a discount offer in a bundle. Important: Do not call this opcode directly. This opcode is always called by PCM_OP_SUBSCRIPTION_PURCHASE_DEAL. See "How Discount Offers Are Purchased".
PCM_OP_SUBSCRIPTION_PURCHASE_FEES	Recommended. Applies deferred purchase fees for a charge offer with an expired purchase start time. See "Applying Deferred Charge Offer Purchase Fees".
PCM_OP_SUBSCRIPTION_PURCHASE_PRODUCT	Limited. Purchases a charge offer for an account or service. Important: Do not call this opcode directly. This opcode is always called by PCM_OP_SUBSCRIPTION_PURCHASE_DEAL. See "Purchasing Charge Offers".
PCM_OP_SUBSCRIPTION_RATE_CHANGE	Recommended. Creates rerating requests when there is a cycle forward or cycle forward arrears event pricing change in the middle of the current cycle. See "Rerating Cycle Forward and Cycle Forward Arrears Events".
PCM_OP_SUBSCRIPTION_READ_ACCT_PRODUCTS	Recommended. Retrieves the hierarchical relationships of bundles, charge offers, discount offers, and services for an account. See "Getting a List of Bundles, Charge Offers, Discount Offers, and Services".
PCM_OP_SUBSCRIPTION_RERATE_REBILL	Recommended. Rerates events for a specified account. See "Customizing Event Searches for Rerating".
PCM_OP_SUBSCRIPTION_SERVICE_BALGRP_TRANSFER	Recommended. A wrapper opcode that performs all the tasks necessary to transfer a service from one balance group to another. See "Transferring Services between Balance Groups".
PCM_OP_SUBSCRIPTION_SET_BUNDLE	Recommended. Creates, modifies, and deletes /purchased_bundle objects. Use this opcode to add promotion names and details to BRM invoices. See "Managing Promotions with Siebel CRM".
PCM_OP_SUBSCRIPTION_SET_DISCOUNTINFO	Recommended. Modifies or sets a discount's purchase, cycle, or usage date information. See "How Discount Offer Purchase, Cycle, and Usage Validity Is Modified".
PCM_OP_SUBSCRIPTION_SET_DISCOUNT_STATUS	Recommended. Changes the status of a /purchased_discount object in a bundle for an account or service. See "How BRM Changes Discount Offer Status".
PCM_OP_SUBSCRIPTION_SET_PRODINFO	Recommended. Changes the information for a specified charge offer in an account. See "Changing the Purchase, Usage, and Cycle Start and End Times".
PCM_OP_SUBSCRIPTION_SET_PRODUCT_STATUS	Recommended. Sets the charge offer status of a /purchased_product object owned by an account. See "How BRM Changes Charge Offer Status".
PCM_OP_SUBSCRIPTION_SHARING_GROUP_CREATE	Recommended. Creates a discount sharing group, charge sharing group, or profile sharing group. See "Creating a Sharing Group".
PCM_OP_SUBSCRIPTION_SHARING_GROUP_DELETE	Recommended. Deletes a discount sharing group or charge sharing group. See "Deleting a Sharing Group".
PCM_OP_SUBSCRIPTION_SHARING_GROUP_MODIFY	Recommended. Modifies sharing groups. See "Modifying a Sharing Group".
PCM_OP_SUBSCRIPTION_SHARING_GROUP_SET_PARENT	Recommended. Changes the owner of a discount sharing group, charge sharing group, or profile sharing group. See "Changing the Owner of a Sharing Group".
PCM_OP_SUBSCRIPTION_TRANSFER_ROLLOVER	Recommended. Checks the rollover-transfer profile object, /profile/rollover_transfer, to make sure it is configured and valid for the balance and receiver, and then transfers the entire rollover amount to the receiver. See "Performing Rollover Transfers".
PCM_OP_SUBSCRIPTION_TRANSFER_SUBSCRIPTION	Recommended. Transfers a subscription service to another subscriber account. See "Transferring Service Groups between Accounts in Different Schemas".
PCM_OP_SUBSCRIPTION_TRANSITION_DEAL	Recommended. Transitions a bundle from one account to another. See "How Bundles Are Transitioned".
PCM_OP_SUBSCRIPTION_TRANSITION_PLAN	Recommended. Transitions one package to another. See "How BRM Transitions Accounts from Source Packages to Target Packages".
PCM_OP_SUBSCRIPTION_VALIDATE_DEAL_DEPENDENCY	Recommended. Validates bundle-to-bundle dependency rules. See "How Bundle Dependencies Are Validated".
PCM_OP_SUBSCRIPTION_VALIDATE_DISCOUNT_DEPENDENCY	Recommended. Validates a discount to see whether it can be used with other discounts or packages. Mutually exclusive dependencies are configured in the /dependency storable class. See "Validating Discount Offer Dependencies".

Suspense Manager FM Standard Opcodes

The Suspense Manager standard opcodes manage suspended event records stored in the BRM database as /suspended_usage objects. The opcodes are available only if you have purchased Suspense Manager.

For information about suspense manager, see BRM Implementing Charging.

Include the ops/suspense.h header file in all applications that call these opcodes.

Table 1-74 Suspense Manager FM Standard Opcodes

Opcode	Description
PCM_OP_SUSPENSE_DEFERRED_DELETE	Recommended. Deletes event records in a written-off state or a succeeded state. See "Deleting Suspended Records in Bulk".
PCM_OP_SUSPENSE_DELETE_USAGE	Recommended. Deletes event records in a written-off state or a succeeded state. See "Deleting Suspended Records".
PCM_OP_SUSPENSE_EDIT_USAGE	Recommended. Changes the contents of event record fields for a suspended call record. Suspense Management Center calls this opcode to edit a suspended call record. See "Changing the Contents of Fields in Suspended Event Records".
PCM_OP_SUSPENSE_RECYCLE_USAGE	Recommended. Initiates event record recycling. See "Initiating Suspense Recycling".
PCM_OP_SUSPENSE_SEARCH_DELETE	Recommended. Deletes call records with a status of succeeded or written off that match criteria specified in the input flist. See "Deleting Call Records with a Specific Recycle Key and a Status of Succeeded or Written-Off".
PCM_OP_SUSPENSE_SEARCH_EDIT	Recommended. Changes fields in a large number of suspended records in one database operation. See "Editing Suspended Records in Bulk".
PCM_OP_SUSPENSE_SEARCH_RECYCLE	Recommended. Searches for and queues suspended call records for recycling based on criteria specified in the input flist. See "Recycling Suspended Records".
PCM_OP_SUSPENSE_SEARCH_WRITE_OFF	Recommended. Writes off a large number of suspended records in one database operation. See "Writing Off Suspended Records in Bulk".
PCM_OP_SUSPENSE_UNDO_EDIT_USAGE	Recommended. Undoes edits to suspended call records used by Suspense Manager. See "Undoing Edits to Suspended Event Records".
PCM_OP_SUSPENSE_WRITTEN_OFF_USAGE	Recommended. Writes off suspended event records. When a suspended event record is written off, they cannot be edited or recycled. See "Writing Off Suspended Records in Bulk".

Universal Message Store (UMS) FM Standard Opcodes

The UMS standard opcodes support Universal Message Store functionality.

See the discussion of BRM message services in BRM Developer's Guide for more information.

Include the ops/ums.h header file in all applications that call these opcodes.

Table 1-75 Universal Message Store FM Standard Opcodes

Opcode	Description
PCM_OP_UMS_GET_MESSAGE	Recommended. Retrieves /message objects. An application that consumes messages from the UMS framework uses this opcode to retrieve messages that match the scope specified in the input flist.
PCM_OP_UMS_GET_MESSAGE_TEMPLATE	Recommended. Retrieves message templates from /strings objects. Applications that produce messages for the UMS framework call this opcode to retrieve message templates.
PCM_OP_UMS_GET_MESSAGE_TEMPLATES	Recommended. Retrieves a list of message templates.
PCM_OP_UMS_SET_MESSAGE	Recommended. Creates a /message object from the message template, filling in placeholders with supplied data.