4 Storable Class Changes

This chapter provides an overview of the storable class changes introduced in Oracle Communications Billing and Revenue Management (BRM) 7.5 Patch Set 1 through BRM 7.5 Maintenance Patch Set 1.

New Storable Classes

Table 4-1 lists the storable classes introduced in the BRM 7.5 patch sets. The new storable classes are grouped by the respective patch sets.

Table 4-1 New Storable Classes

New Storable Class Description

/config/gl_calendar

(Maintenance Patch Set 1) Stores information about the general ledger (G/L) reporting calendar, which is used to determine the G/L cycle a journal entry belongs to.

/event/billing/adjustment/bill

(Patch Set 12) Stores information about the bill-level adjustments.

/event/billing/dispute/bill

(Patch Set 12) Stores information about the bill-level disputes.

/event/billing/settlement/bill

(Patch Set 12) Stores information about the bill-level settlements.

/newsfeed

(Patch Set 12) Stores all the data required for News Feed for different events.

/config/creditor

(Patch Set 9) Stores information about a creditor, such as name, address, and creditor ID.

For each unique creditor ID, the creditor information is stored in the PIN_FLD_CREDITOR_INFO array.

/data/trial_bill_sequence

(Patch Set 9) Monitors the amount of times a subordinate account has been run with trial billing.

/event/activity/sepa

(Patch Set 9) Records activity related to the SEPA payment method.

/event/activity/sepa/mandate_amendment

(Patch Set 9) Records an amendment to a mandate.

This event is created if any of the following information is changed in a mandate.

  • IBAN: International Bank Account Number

  • BIC: Business Identifier Code

  • UMR: Unique mandate reference

  • Creditor ID

  • Creditor name

/event/audit/customer/payinfo/sepa

(Patch Set 9) Audit event to record changes to the SEPA payment method.

/event/billing/charge/sepa

(Patch Set 9) Records the payment request information for SEPA Direct Debit and SEPA Credit Transfer.

/event/billing/payment/sepa

(Patch Set 9) Records a SEPA Direct Debit payment.

This event is created when a SEPA Direct Debit payment is completed.

/event/billing/refund/sepa

(Patch Set 9) Records a SEPA Credit Transfer payment.

This event is created when a SEPA Credit Transfer payment is completed.

/event/billing/reversal/sepa

(Patch Set 9) Records a SEPA Direct Debit payment reversal.

This event is created when a SEPA Direct Debit payment reversal is completed.

/payinfo/sepa

(Patch Set 9) Extended /payinfo class. Stores the SEPA payment information including the mandate information for SEPA Direct Debit.

/sepa

(Patch Set 9) Generic class to store SEPA payment request information.

/sepa/ct

(Patch Set 9) Stores information about the SEPA Credit Transfer payment request.

/sepa/dd

(Patch Set 9) Stores information about the SEPA Direct Debit payment request.

/sepa/dd/reversal

(Patch Set 9) Stores information about the SEPA Direct Debit payment reversal.

This object is created when a SEPA Direct Debit payment reversal is initiated to reverse a duplicate payment that was collected.

/config/note_status

(Patch Set 8) Stores information about the status of a /note object so that notes can be retrieved by that criteria.

/config/note_type

(Patch Set 8) Stores information about the type and subtype of a /note object so that notes can be retrieved by that criteria.

/event/customer/note

(Patch Set 8) The parent class for classes that contain information (audit trail) regarding creating and modifying a /note object.

/event/customer/note/create

(Patch Set 8) Stores information about the creation of a /note object.

/event/customer/note/modify

(Patch Set 8) Stores information about the modification of a /note object.

/profile/collections_params

(Patch Set 4) Stores the customer's collections profile information. The /profile/collections_params object is created when the customer's account is created using the PCM_OP_CUST_COMMIT_CUSTOMER opcode.

See the discussion about creating customer's collections profiles at the time of customer account creation in BRM Managing Customers for more information.

/offer_profile

(Patch Set 3) Stores the static information associated with services in policy labels. An /offer_profile object is an optional element in a price list and is associated with a /product object or a /discount object. /offer_profile objects are created and managed using the loadpricelist utility and the price list opcodes (PCM_OP_SET_PRICE_LIST and PCM_OP_GET_PRICE_LIST).

See the discussion about managing offer profiles in BRM Managing Customers for more information.

/collections_action/collect_payment

(Patch Set 2) Stores information about the amount to be paid and a link to the /payinfo object for a Collect Payment action.

See the discussion about collecting payments in BRM Collections Manager for more information.

/collections_action/promise_to_pay

(Patch Set 2) Stores information about the promise-to-pay milestones.

See the discussion about promise-to-pay in BRM Collections Manager for more information.

/config/collections/scenario_params

(Patch Set 2) Stores additional parameters for scenario assignment or replacement.

See the discussion about collections scenario replacement in BRM Collections Manager for more information.

/event/activity/collections

(Patch Set 2) Stores information about the collections for promise-to-pay and scenario replacement activities.

See the discussion about promise-to-pay agreements and collections scenario replacement in BRM Collections Manager for more information.

/event/activity/collections/promise_to_pay

(Patch Set 2) Stores the parameter information while entering into the promise-to-pay agreement.

See the discussion about promise-to-pay events in BRM Collections Manager for more information.

/event/activity/collections/replace_scenario

(Patch Set 2) Stores the parameter information while replacing a bill unit's existing scenario with a new scenario.

See the discussion about collections scenario replacement in BRM Collections Manager for more information.

/event/group/collections_targets

(Patch Set 2) Stores the information about the collections group.

/group/collections_targets

(Patch Set 2) Stores the information about several bill units under a single group entering or exiting collections and processes the collections actions.

/config/lifecycle_states

(Patch Set 1) Stores configuration information about the states, rules, and transitions in a custom service life cycle. A separate instance of this class is created for each custom service life cycle in your system.

See the discussion about managing service life cycles in BRM Managing Customers for more information.

/config/service_state_map

(Patch Set 1) Stores mapping between custom service life cycle states (PIN_FLD_LIFECYCLE_STATE field in /service objects) and default service life cycle statuses (PIN_FLD_STATUS field in /service objects). All state-to-status mapping in your system is stored in a single instance of this class. The instance can contain mapping for multiple service life cycles.

See the discussion about managing service life cycles in BRM Managing Customers for more information.

/config/subscriber_preferences_map

(Patch Set 1) Stores the possible configurations for subscriber preferences.

See the discussion about in-session notifications in BRM Telco Integration for more information.

/profile/subscriber_preferences

(Patch Set 1) Stores the preferences associated with a subscriber's profile.

See the discussion about in-session notifications in BRM Telco Integration for more information.


Changed Storable Classes

Table 4-2 lists the storable classes changed in the BRM 7.5 patch sets. The changed storable classes are grouped by the respective patch sets.

Table 4-2 Changed Storable Classes

Changed Storable Class Description

/journal

(Maintenance Patch Set 1) Now includes the PIN_FLD_EFFECTIVE_T field, which indicates the G/L cycle the journal entry belongs to.

/tmp_journals_to_process

(Maintenance Patch Set 1) Now includes the PIN_FLD_EFFECTIVE_T field, which indicates the G/L cycle the journal entry belongs to.

/event

(Patch Set 12) Now includes the PIN_FLD_NETWORK_SESSION_ID field, which stores the network session ID received from Elastic Charging Engine (ECE) that indicates ECE-rerated events with conditional balance impacts.

/event/customer/billinfo/create

(Patch Set 12) Now includes the PIN_FLD_ACTG_TYPE field in the PIN_FLD_BILLINFO array to store the accounting type for the /billinfo object.

/event/customer/billinfo/modify

(Patch Set 12) Now includes the PIN_FLD_ACTG_TYPE field in the PIN_FLD_BILLINFO array to store the accounting type for the /billinfo object.

/user_activity

(Patch Set 12) Modified to store information such as external customer service representative (CSR) ID and correlation ID sent by the customer relations management (CRM) applications:

  • Added the PIN_FLD_EVENTS array, which now contains the PIN_FLD_EVENT_OBJ field.

  • Added the PIN_FLD_EXTERNAL_USER field.

  • Added the PIN_FLD_CORRELATION_ID field.

  • Added the PIN_FLD_API_USER field

Note: If the CRM application does not send the external CSR ID, correlation ID, and API user to BRM, BRM logs NULL values for these fields in the /user_activity storable class.

/config/payment

(Patch Set 9) Now includes the PIN_FLD_PAY_TYPES array for storing SEPA payment method configurations.

/invoice

(Patch Set 9) Modified for trial invoicing to include the following:

  • Added a new PIN_FLD_BILLS array, which contains the following fields:

    PIN_FLD_START_T

    PIN_FLD_END_T

    PIN_FLD_AR_BILLINFO_OBJ

    PIN_FLD_DUE

    PIN_FLD_ADJUSTED

    PIN_FLD_WRITEOFF

    PIN_FLD_DISPUTED

    PIN_FLD_RECVD

  • Added the PIN_FLD_CHECK_SPLIT_FLAGS field to the /invoice object.

/note

(Patch Set 8) Now includes numerous new fields to support:

  • Editing notes

  • Replying to or following up on notes

  • Retrieving notes by ID, the owning account, the associated object (for example, adjustment or dispute), the type and subtype, or by date range

  • Drilling down to the original event

The following fields have been added:

  • PIN_FLD_HEADER_STR: The conversation header

  • PIN_FLD_EFFECTIVE_T : The effective date

  • PIN_FLD_CLOSED_T : The time of resolution

  • PIN_FLD_REASON_DOMAIN_ID : The reason domain ID; for example, A/R

  • PIN_FLD_AMOUNT: The associated amount

  • PIN_FLD_REASON_ID : The reason ID associated with the action

  • PIN_FLD_ITEM_OBJ : The POID of the item associated with the note; for example, if the note is created for an item adjustment

  • PIN_FLD_SERVICE_OBJ: The POID of the service associated with the note; for example, if the note is created for a service adjustment

  • PIN_FLD_BILLINFO_OBJ : The POID of billinfo associated with the note; for example, if the note is created for the adjustment of a bill

  • PIN_FLD_NOTE_TYPE : The category of note, for example, balance, A/R activity, and so on: used for enquiry (Required field)

  • PIN_FLD_NOTE_SUB_TYPE: The category subtype: used for enquiry (Required field)

  • PIN_FLD_STATUS : The status: Not Set, Resolved, Unresolved (Required field)

  • PIN_FLD_COUNT : The number of notes in the conversation

  • PIN_FLD_DATA_ARRAY: The note details that follow

  • PIN_FLD_ENTRY_T: The creation time

  • PIN_FLD_CSR_ACCOUNT_OBJ: The CSR making the entry

  • PIN_FLD_TRACKING_ID: The external system identifier

  • PIN_FLD_NOTE_STR : The actual description

The following field has been removed:

  • PIN_FLD_TYPE

/event/audit/service_balgrp_transfer

(Patch Set 6) Now includes the PIN_FLD_TO_SERVICE_OBJ field in the PIN_FLD_SERVICES array to store details about the new service after the transfer.

/event/audit/subscription

(Patch Set 6) Now includes the PIN_FLD_TO_SERVICE_OBJ field in the PIN_FLD_SERVICES array to store details about the new service after the transfer.

/event/audit/subscription/transfer

(Patch Set 6) Now includes the following fields:

  • PIN_FLD_TO_BAL_GRP_OBJ in the PIN_FLD_BALANCE_GROUPS array to store details about the new balance group after the transfer

  • PIN_FLD_TO_PROFILE_OBJ in the PIN_FLD_PROFILES array to store details about the new profile after the transfer

  • PIN_FLD_TO_SERVICE_OBJ in the PIN_FLD_PROFILES array to store details about the new service after the transfer

  • PIN_FLD_TO_SERVICE_OBJ in the PIN_FLD_DEVICES array to store details about the new devices after the transfer

/billinfo

(Patch Set 5) Now enhances the PIN_FLD_BILLING_STATUS_FLAGS field to include the following values to indicate error conditions:

  • For regular cycle fee: PIN_BILL_FLAGS_CF_ERROR (bit value 0x100)

  • For deferred cycle fee: PIN_BILL_FLAGS_DEF_CF_ERROR (bit value 0x200)

  • For deferred purchase cycle fee: PIN_BILL_FLAGS_DEF_PURCHASE_ERROR (bit value 0x400)

  • For deferred cancel cycle fee: PIN_BILL_FLAGS_DEF_CANCEL_ERROR (bit value 0x800)

  • For billing validation: PIN_BILL_FLAGS_CF_NOT_APPLIED (bit value 0x1000)

  • For updating journal objects: PIN_BILL_FLAGS_UPDATE_JOURNALS_ERROR (bit value 0x2000)

  • For updating item objects: PIN_BILL_FLAGS_UPDATE_ITEMS_ERROR (bit value 0x4000)

/balance_group

(Patch Set 3) Now includes the PIN_FLD_CONSUMED_RESERVED_AMOUNT field in the PIN_FLD_BALANCES array to store the consumed reserved amount for the resource.

/config/reserve

(Patch Set 3) Now includes the PIN_FLD_RESOURCE_ID field, which stores the resource counter corresponding to the PIN_FLD_REQ_MODE field passed in the input flist.

/event/billing/product/action

(Patch Set 3) Now includes the PIN_FLD_PRICE_LIST_NAME field, which stores information about the price list name associated with the purchased products.

/purchased_product

(Patch Set 3) Now includes the PIN_FLD_PRICE_LIST_NAME field, which stores information about the price list name associated with the purchased products.

/reservation

(Patch Set 3) Now includes the PIN_FLD_CONSUMED_RESERVED_AMOUNT field in the PIN_FLD_BALANCES array to store the input (from the network) about the used quantities and the consumed reserved amount for the resource.

/reservation_list

(Patch Set 3) Now includes the PIN_FLD_CONSUMED_RESERVED_AMOUNT field in the PIN_FLD_BALANCES array to store the consumed reserved amount for the resource.

/collections_scenario

(Patch Set 2) Now includes the PIN_FLD_PROMISE_TO_PAY array that stores the date and time the promise-to-pay agreement is effective for a bill unit, the total promised amount, and the link to the /event/activity/collections/promise_to_pay object.

See the discussion about promise-to-pay in BRM Collections Manager for more information.

/config/collections/action

(Patch Set 2) Now includes the PIN_FLD_TARGET_ACTION field to determine which bill units the action should target.

/config/collections/scenario

(Patch Set 2) Now includes the following parameters:

  • PIN_FLD_SEVERITY: Stores the scenario severity information. This parameter is added in the PIN_FLD_SCENARIO_INFO substruct.

  • PIN_FLD_PROFILE_DATA_ARRAY: Stores the additional configurable parameters that are used to evaluate assignment or replacement of a scenario. The array elements form the evaluation formula associated with the collections scenario.

See the discussion about collections scenario replacement in BRM Collections Manager for more information.

/event/audit

(Patch Set 2) Now includes the PIN_FLD_EVENT_AUDIT array to store the pending receivables of the child and the effective_t field for auditing when a parent goes into collections because a group member has gone into collections.

/active_session

(Patch Set 1) Now includes the list of all thresholds breached during the current session.

See the discussion about in-session notifications in BRM Telco Integration for more information.

/config/aaa

(Patch Set 1) Now includes the maximum scaled delay time MaxScaledDelayTime configured for each resource ID. Used in calculating scaled delay time for tariff change indications in in-session notifications.

See the discussion about in-session notifications in BRM Telco Integration for more information.

/config/business_params

(Patch Set 1) Now includes the following parameters:

  • SubscriberLifeCycle

    This parameter enables BRM to support custom service life cycles. By default, it is set to disabled.

    See the discussion about managing service life cycles in BRM Managing Customers for more information.

  • Piggyback

    This parameter enables BRM to support in-session notifications. By default, it is set to disabled.

    See the discussion about providing in-session notifications in BRM Telco Integration for more information.

/config/opcodemap/tcf

(Patch Set 1) Now includes the VALIDATE_LIFECYCLE processing stage.

During this stage, the PCM_OP_TCF_AAA_VALIDATE_LIFECYCLE helper opcode is called to validate a service request against the business rules configured for the current state of a service that uses a custom service life cycle.

See the discussion about managing service life cycles in BRM Managing Customers for more information.

/config/template

(Patch Set 1) Now supports the following key-value pair:

  • Key: lifecycle_obj

  • Value: Name of the custom service life cycle

This key-value pair enables users to associate a /config/lifecycle_states object with a particular /service object.

See the discussion about managing service life cycles in BRM Managing Customers for more information.

/event/customer/status

(Patch Set 1) Now includes the following fields:

  • PIN_FLD_LIFECYCLE_STATE: Stores the numeric ID of a custom service life cycle state.

  • PIN_FLD_SERVICE_STATE_EXPIRATION_T: Stores the expiration day and time (time stamp) of the custom service life cycle state.

See the discussion about managing service life cycles in BRM Managing Customers for more information.

/service

(Patch Set 1) Now includes the following fields:

  • PIN_FLD_LIFECYCLE_STATE: Stores the numeric ID of the service's current custom life cycle state.

  • PIN_FLD_SERVICE_STATE_EXPIRATION_T: Stores the day and time (time stamp) the current state of the service expires and the transition to the next state in the service life cycle occurs. This field can contain a value only when the PIN_FLD_LIFECYCLE_STATE field contains a value.

See the discussion about managing service life cycles in BRM Managing Customers for more information.


New Notification Events

Table 4-3 lists the notification events introduced in the BRM 7.5 patch sets. The new notification events are grouped by the respective patch sets.

Table 4-3 New Notification Events

New Notification Event Description

/event/notification/refund/create

(Patch Set 12) Generated when a new refund item is created.

/event/notification/offer_profile/create

(Patch Set 3) Generated when a new offer profile is created.

/event/notification/offer_profile/delete

(Patch Set 3) Generated when an offer profile is deleted.

/event/notification/offer_profile/ThresholdBreach

(Patch Set 3) Generated when the sum of the current balance and the consumed reservation is equal to or greater than the nearest threshold configured in the offer profile for a service and resource ID.

/event/notification/offer_profile/update

(Patch Set 3) Generated when an existing offer profile is modified.