5 Event Notification Definitions

This chapter provides a brief description of each Oracle Communications Billing and Revenue Management (BRM) notification event and includes links to the notification event specifications. See "Using Event Notification" in BRM Developer's Guide for more information.

For more information about event notification definitions and field definitions, see BRM Event Notification Reference.

Event Notification Definitions

Table 5-1 lists the BRM event notification definitions and descriptions.

Table 5-1 Event Notification Definitions

Event Notification Description

/event/billing/dispute/notify

Generated when an event is disputed. When the notification event is detected, BRM reserves the disputed amount to prevent misuse of balances during the dispute.

/event/billing/settlement/notify

Generated when a dispute is settled. When the notification event is detected, BRM releases the reserved disputed amount as part of the settlement process.

/event/notification

An abstract class to define event notifications.

/event/notification/account

An abstract class to define event notifications for operations on the account object.

/event/notification/account/create

Generated when an account is created.

/event/notification/account/delete

Generated when an account is deleted.

/event/notification/account/pre_delete

Generated at the start of the account deletion process.

/event/notification/activity

An abstract class to define event notifications on activities.

/event/notification/amt

An abstract class to define event notifications for operations on the Account Migration Manager process.

/event/notification/amt/HoldCDRProcessing

  1. Gets the migration job ID, the source database schema, and the target database schema from this event.

  2. Queries the BRM database for the list of accounts that belong to the migration job.

  3. Waits for all existing rated events associated with those accounts to be extracted from the Oracle NoSQL database data store.

  4. Does one of the following:

    If the extraction succeeds:

    – Assigns the IN_ACCOUNT_MIGRATION status to the accounts.

    – Updates their target database schema information.

    – Sends an ACKHoldCDRProcessing acknowledgment to the BRM acknowledgment queue.

    – Continues rating incoming usage events for the migrated accounts but does not extract them from the Oracle NoSQL database data store.

    If the extraction fails, ECE sends a NACKHoldCDRProcessing acknowledgment to BRM, and BRM does not migrate the accounts.

/event/notification/amt/MigrateAcct

Sends an ACKMigrateAcct acknowledgment to the AMM acknowledgment queue.

Generated after Account Migration Manager successfully migrates a group of accounts from one database schema to another. This event notifies ECE that it needs to update the POIDs for the specified list of accounts.

/event/notification/amt/MigrateDestination

Sends an ACKMigrateDestination acknowledgment to the AMM acknowledgment queue.

Generated after Account Migration Manager successfully migrates a group of accounts from one database schema to another. This event notifies ECE that it needs to update the account information stored in cache.

/event/notification/amt/MigrateSource

Sends an ACKMigrateSource acknowledgment to the AMM acknowledgment queue.

Generated after Account Migration Manager successfully migrates a group of accounts from one database schema to another.

/event/notification/amt/ResumeCDRProcessing

  1. Gets the migration job ID, the source database schema, and the target database schema from this event.

  2. Queries the BRM database for the list of accounts that belong to the migration job.

  3. Removes the IN_ACCOUNT_MIGRATION status from those accounts.

  4. Loads all the rated events that were generated while the accounts' status was IN_ACCOUNT_MIGRATION into the new target database schema.

Generated after both Account Migration Manager successfully migrates a group of accounts and ECE successfully updates its account information. This event notifies ECE that it can begin processing all suspended and new events for the specified list of accounts.

/event/notification/auto_rerate

Generated when an event is backdated and requires rerating.

/event/notification/bal_grp

An abstract class to define event notifications for operations on the balance group object.

/event/notification/bal_grp/create

Generated when a new balance group is created.

/event/notification/bal_grp/modify

Generated when an existing balance group is modified.

/event/notification/billing

An abstract class to define event notifications for billing operations.

/event/notification/billing/end

Generated when final billing ends for an accounting cycle.

Note: Final billing occurs after the end of the billing delay period, if configured.

/event/notification/billing/end_partial

Generated when partial billing ends for an accounting cycle. Partial billing occurs only if you configured delayed billing and you run billing during the delay period.

/event/notification/billing/start

Generated when final billing starts for an accounting cycle.

Note: Final billing occurs after the end of the billing delay period, if configured.

/event/notification/billing/start_partial

Generated when partial billing starts for an accounting cycle. Partial billing occurs only if you configured delayed billing and you run billing during the delay period.

/event/notification/customer

An abstract class to define event notifications for operations on the customer object.

/event/notification/customer/modify

Generated after an account is successfully modified.

/event/notification/customer/pre_modify

Generated just prior to an account modification.

/event/notification/customer/reg_complete

Generated when customer account creation is complete.

/event/notification/customer/uniqueness_confirmed

Generated after BRM confirms that a customer's account POID is unique for all database schemas in your multischema system.

/event/notification/cycle

An abstract class to define event notifications for cycle operations.

/event/notification/cycle/end

Generated at the end of a billing cycle either by the PCM_OP_BILL_MAKE_BILL opcode or after applying the cycle fees.

/event/notification/cycle/start

Generated at the start of a billing cycle either by the PCM_OP_BILL_MAKE_BILL opcode or before applying the cycle fees.

/event/notification/deal

An abstract class to define event notifications for operations on the /deal object.

/event/notification/deal/change

When transitioning an account from one bundle to another, this event is generated just prior to canceling the old bundle.

/event/notification/deal/change_complete

When transitioning an account from one bundle to another, this event is generated after successfully canceling the old bundle.

/event/notification/deal/transition

When transitioning an account from one bundle to another, this event is generated just prior to adding the new bundle.

/event/notification/deal/transition_complete

When transitioning an account from one bundle to another, this event is generated after successfully adding the new bundle.

/event/notification/device

An abstract class to define event notifications for operations on the device object.

/event/notification/device/state

Generated after a device is successfully changed to a new state.

/event/notification/device/state/in_transition

Generated just before a device changes state.

/event/notification/order

An abstract class to define event notifications for operations on an order object.

/event/notification/order/state

Generated after an order is successfully changed to a new state.

/event/notification/order/state/in_transition

Generated just before an order changes state.

/event/notification/plan

An abstract class to define event notifications for operations on a package.

/event/notification/plan/transition

Generated just before an account transitions from one package to another.

/event/notification/plan/transition_complete

Generated after an account successfully transitions to a new package.

/event/notification/price

An abstract class to define event notifications for operations on a pricing component.

/event/notification/price/discounts

An abstract class to define event notifications for operations on a discount offer.

/event/notification/price/discounts/modify

Generated after a discount is created or updated in the BRM database. This event is used to synchronize discount offers between BRM and external CRM applications.

/event/notification/price/products

An abstract class to define event notifications for operations on a charge offer.

/event/notification/price/products/modify

Generated after a charge offer is created or updated in the BRM database. This event is used to synchronize charge offers between BRM and external CRM applications.

/event/notification/price/sponsorships

An abstract class to define event notifications for operations on a chargeshare.

/event/notification/price/sponsorships/modify

Generated after a chargeshare is created or updated in the BRM database. This event is used to synchronize chargeshare data between BRM and external CRM applications.

/event/notification/process_audit

An abstract class to define event notifications for operations on the process audit object.

/event/notification/process_audit/create

Generated when Revenue Assurance Manager creates a /process_audit object.

/event/notification/process_audit/update

Generated when Revenue Assurance Manager updates a /process_audit object with revenue assurance data.

/event/notification/product/cancel/no_refund

Generated when a refund could not be applied due to a canceled override charge offer.

/event/notification/profile

An abstract class to define event notifications for operations on the profile object.

/event/notification/profile/create

Generated when a new profile is created.

/event/notification/profile/delete

Generated when a profile is deleted.

/event/notification/profile/modify

Generated after a profile is successfully changed.

/event/notification/profile/pre_modify

Generated just prior to a profile being modified.

/event/notification/rate_change

Generated when a condition occurs that may require rerating.

/event/notification/ra_threshold

Generated by the pin_ra_check_thresholds utility when specified conditions for producing revenue leakage alerts occur.

/event/notification/rental_failure Generated when a subscription fails because the customer has exceeded their credit limit.

/event/notification/rerating

An abstract class to define event notifications for the rerating operation.

/event/notification/rerating/end

Generated when a rerating job is finished.

/event/notification/rerating/PrepareToRerate

Generated just prior to the rerating process. This event notifies ECE to suspend event processing for all accounts affected by the rerating job.

/event/notification/rerating/ReratingCompleted

Generated after rerating completes successfully. This signals that ECE should resume processing for all accounts affected by the rerating job.

/event/notification/rerating/start

Generated just prior to the start of the rerating process. This signals that ECE should halt processing for all accounts affected by the rerating job.

/event/notification/rollover

An abstract class to define event notifications for the rollover operation.

/event/notification/rollover/end

Generated after a sub-balance is successfully rolled over to another cycle.

/event/notification/rollover/start

Generated just prior to a sub-balance being rolled over from one cycle to another.

/event/notification/rollover_correction

An abstract class to define event notifications for operations on the rollover correction object.

/event/notification/rollover_correction/rerate

Generated when a rollover correction during billing requires an event to be rerated. This rollover correction, in turn, is necessitated by delayed usage events after the end of the cycle.

/event/notification/service

An abstract class to define event notifications for operations on the service object.

/event/notification/service_balgrp_transfer

An abstract class to define event notifications for the service balance group transfer operation.

/event/notification/service_balgrp_transfer/data

Generated when either of the following occurs:

  • A service is transferred from one balance group to another.

  • A balance group is transferred from one bill unit (/billinfo object) to another.

This is used to synchronize balance group transfer data between ECE and the BRM database.

/event/notification/service_balgrp_transfer/end

Generated after a service is successfully transferred from one balance group to another.

/event/notification/service_balgrp_transfer/start

Generated just prior to a service being transferred from one balance group to another.

/event/notification/service/create

Generated when a service is created.

/event/notification/service/delete

Generated when a service is deleted.

/event/notification/service/modify

Generated when a service is modified.

/event/notification/service/post_change

Generated after a service has been successfully updated.

/event/notification/service/pre_change

Generated just prior to a service being updated.

/event/notification/service/pre_create

Generated just prior to the creation of a service.

/event/notification/service/pre_purchase

Generated just before a charge offer purchase.

/event/notification/suspense

An abstract class to define event notifications for the suspense operation.

/event/notification/suspense/batch_delete

Generated when a suspended batch is purged.

/event/notification/suspense/batch_resubmit

Generated when a suspended batch is submitted for recycling.

/event/notification/suspense/batch_writeoff

Generated when a suspended batch is written off.

/event/notification/suspense/delete

Generated when a suspense record is deleted.

/event/notification/suspense/edit

Generated when a suspense record is modified.

/event/notification/suspense/recycle

Generated when a suspense record is recycled.

/event/notification/suspense/writeoff

Generated when a suspense record is written off.

/event/notification/svc_order

An abstract class to define event notifications for operations on the service order object.

/event/notification/svc_order/state

Generated after a service order is successfully changed to a new state.

/event/notification/svc_order/state/in_transition

Generated just prior to a service order changing state.

/event/notification/threshold

Generated when an balance crosses above a threshold value or credit limit.

/event/notification/threshold_below

Generated when a balance crosses below a threshold value or credit limit.