Skip Headers
Oracle® Application Integration Architecture Siebel CRM Integration Pack for Oracle Communications Billing and Revenue Management: Agent Assisted Billing Care Implementation Guide
Release 11.3

Part Number E50336-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

3 Account Balance Integration Flow

This chapter provides an overview of the account balance integration flows and discusses Siebel customer relationship management (Siebel CRM) and Oracle Communications Billing and Revenue Management (BRM) interfaces, industry Oracle Application Integration Architecture (Oracle AIA) components, and integration services.

Account Balance Integration Flows Overview

The account balance integration between Siebel CRM and BRM supports the following integration flows:

  • QueryBalanceSummary enables a customer service representative (CSR) to view an account billing profile balance summary in Siebel CRM.

  • QueryBalanceGroupList enables a CSR to view the list of balance groups under an account billing profile.

  • QueryBalanceDetails enables a CSR to view balance details under a balance group.

  • QueryBalanceGroupServices enables a CSR to view services under a balance group.

The account balance integration enables the CSR to retrieve balance information from BRM. The CSR can obtain balance information at a summary or detail level. They can also query a list of balance groups for a selected billing profile.

After the CSR obtains the balance group information from BRM, they can navigate and query additional details, such as monetary and nonmonetary balances, credit limits, and validity dates.

When the CSR accesses the Siebel Billing Profile screen, a request is made from Siebel CRM to retrieve an account balance summary. When the CSR clicks the Balance Group tab, a call is made to fetch the list of balance groups. When the CSR clicks the view detail button for a balance group, the corresponding balance group detail data appears on the Balance Group detail applet.

With the add-on support for viewing account balance and other billing data for service accounts, the account balance integration now enables the CSR to retrieve balance and billing information for the service account (in addition to the billing account) from BRM.

From the Account Summary view in Siebel CRM, the CSR can retrieve both the account balance information of the billing (paying) account and the service (nonpaying) account. The click stream action determines which account billing information is retrieved from the billing system. By default there are the following three navigation paths available:

  • From the Billing Account Summary page, navigate to the Siebel Billing Portal page for the billing account.

    If the intent is to see the billing account's billing data (account balance, bills, unbilled usage, adjustments and payments), then the user must use the Billing Profile link under the Billing Profile applet.

    In cases were a single billing profile is used to pay for both the billing account and service account(s) services, then the billing data that is displayed using this navigation option contains the consolidated billing information of account balance, bills, unbilled usage, adjustments and payments across all accounts that are tied to this billing profile.

    Alternatively, if different parent billing profiles are used to pay for self and other service accounts, then clicking a specific billing profile displays the billing data of account(s) that are tied to that billing profile.

  • From the Billing Account Summary page, navigate to the Siebel Billing Portal page for one service account.

    If the intent is to see a particular service account's billing data then the user must use the Billing Profile link under the Billing Items applet.

    The user must identify the correct billing item that is mapped to the service account for which the billing data is to be seen. Billing data like account balance, bills, unbilled usage and adjustments that are specific to the selected service account can be viewed using this navigation option.

  • From the Service Account Summary page, navigate to the Siebel Billing Portal page for the service account.

    If the intent is to see the billing data of the service account that is currently accessed in Siebel CRM, the user must use the Billing Profile link under the Installed Asset applet.

    Clicking on any of the Billing Profile links under this applet navigates the user to the service account's billing portal screen. Billing data like account balance, bills, unbilled usage, and adjustments that are specific to a service account can be viewed using this navigation option.

Figure 3-1 illustrates the account balance integration flow.

Figure 3-1 Account Balance Integration Flow

Description of Figure 3-1 follows
Description of "Figure 3-1 Account Balance Integration Flow"

Figure 3-2 Account Balance Integration Flow Legend

This image shows the legend for the previous figure.

To view account balance information for an account using the billing profile portal screen in Siebel CRM:

  1. Navigate to the Accounts screen and query an account.

  2. Scroll down to the Billing Profile applet for this account and click the Billing Profile Name link.

    You can now view the account's billing profile portal screen which has the applet with the balance summary for this account.

  3. Click the Balance Group tab to view the list of balance groups under an account billing profile. Click View Detail to view the corresponding balance group detail on the Balance Detail applet.

See "Mapping Siebel Billing Management UI Elements to BRM Customer Center" for more information about the mapping of Siebel CRM elements to BRM elements.

QueryBalanceSummary Integration Flow

This integration flow uses the following interfaces:

  • AccountBalanceSiebelCommsReqABCS with operation QueryBalanceSummary

  • QueryBalanceSummarySiebelCommsReqABCSImpl

  • QueryCustomerPartyListBRMCommsProvABCSImpl

Figure 3-3 illustrates the QueryBalanceSummary integration scenario:

Figure 3-3 QueryBalanceSummary Sequence Diagram

This image is described in the surrounding text.

When you initiate the QueryBalanceSummary process, the following events occur:

  1. In Siebel CRM, a user navigates to the Accounts screen, queries an account, and clicks a Billing Profile for the account.

    This opens up the Billing Profile BRM screen, and a web service call is made to query the balance summary from the billing system.

  2. Navigating to the Billing BRM screen invokes AccountBalanceSiebelCommsReqABCS web service with the QueryBalanceSummary method, which in turn calls the AccountBalanceSiebelCommsReqABCS with operation QueryBalanceSummary.

    AccountBalanceSiebelCommsReqABCS is a generic Siebel Account Balance interface service with several operations defined on the application business message (ABM).

  3. Invoking AccountBalanceSiebelCommsReqABCS with operation QueryBalanceSummary routes the QueryBalanceSummaryReqMsg to the QueryBalanceSummarySiebelCommsReqABCSImpl.

  4. The QueryBalanceSummarySiebelCommsReqABCSImpl first transforms the QueryBalanceSummaryReqMsg into QueryCustomerPartyListReqMsgEBM and routes the QueryCustomerPartyListReqMsg to the appropriate billing systems.

    As delivered, QueryCustomerPartyListReqMsg is routed to the QueryCustomerPartyListBRMCommsProvABCSImpl.

  5. QueryCustomerPartyListBRMCommsProvABCSImpl transforms QueryCustomerPartyListReqMsg into the input of PCM_OP_AR_GET_ACCT_BAL_SUMMARY and calls the opcode PCM_OP_AR_GET_ACCT_BAL_SUMMARY.

  6. QueryCustomerPartyListBRMCommsProvABCSImpl then transforms the application programming interface (API) output PCM_OP_AR_GET_ACCT_BAL_SUMMARY _outputFlist into enterprise business message (EBM) QueryCustomerPartyListRespMsg and returns it to QueryBalanceSummarySiebelCommsReqABCSImpl

  7. QueryBalanceSummarySiebelCommsReqABCSImpl transforms the QueryCustomerPartyListRespMsg into QueryBalanceSummaryRespMsg, which is returned to the AccountBalanceSiebelCommsReqABCS.

  8. AccountBalanceSiebelCommsReqABCS returns the QueryBalanceSummarySiebelMsg to the calling Siebel web service AccountBalanceSiebelCommsReqABCS.

  9. The response is then written to the Siebel Balance Summary virtual business component (VBC) for the user.

QueryBalanceGroupList Integration Flow

This integration uses the following service interfaces:

  • AccountBalanceSiebelCommsReqABCS with operation QueryBalanceGroupList

  • QueryBalanceGroupListSiebelCommslReqABCSImpl

  • QueryCustomerPartyListBRMCommsProvABCSImpl

Figure 3-4 displays the QueryBalanceGroupList integration scenario.

Figure 3-4 QueryBalanceGroupList Sequence Diagram

This image is described in the surrounding text.

When you initiate the QueryBalanceDetails process, the following events occur:

  1. In Siebel CRM, a user navigates to the Accounts screen, queries an account, and clicks a billing profile for the account.

    This displays the Billing Profile BRM screen. On the Billing Profile screen, when the user clicks the Balance Group tab, a web service call is made to query the complete list of balance groups for that account billing profile.

  2. Navigating to the Billing BRM screen and clicking the Balance Group tab invokes the AccountBalanceSiebelCommsReqABCS web service, which in turn invokes the Siebel Account Balance Interface service AccountBalanceSiebelCommsReqABCS with operation QueryBalanceGroupList.

    AccountBalanceSiebelCommsReqABCS is a generic Oracle AIA Application Business Connector Service (ABCS) interface service with several operations on the Siebel ABM.

  3. Invoking AccountBalanceSiebelCommsReqABCS with operation QueryBalanceGroupList routes the QueryBalanceGroupListReqMsg to the QueryBalanceGroupListSiebelCommsReqABCSImpl.

  4. The QueryBalanceGroupListSiebelCommslReqABCSImpl transforms the QueryBalanceGroupListReqMsg into QueryCustomerPartyListReqMsgEBM and routes the QueryCustomerPartyListReqMsg to the appropriate billing system.

    As delivered, QueryCustomerPartyListReqMsg is routed to the QueryCustomerPartyListBRMCommsProvABCSImpl.

  5. QueryCustomerPartyListBRMCommsProvABCSImpl checks the Query Criteria code. If it is QueryBalanceGroupList, the QueryInvoiceListReqMsg is transformed into PCM_OP_BAL_GET_ACCT_BILLINFO_inputflist.

    This opcode call returns the list of BILLINFO and AR_BILLINFO of that account.

  6. QueryCustomerPartyListBRMCommsProvABCSImpl first checks the Query Criteria code. If it is QueryBalanceGroupList, then it transforms QueryCustomerPartyListReqMsg into the input of PCM_OP_BAL_GET_ACCT_BAL_GRP_AND_SVC and then invokes the BRM API PCM_OP_BAL_GET_ACCT_BAL_GRP_AND_SVC to query the list of balance groups of the account billing profile.

  7. From the response of PCM_OP_BAL_GET_ACCT_BILLINFO opcode, the appropriate BILLINFO and AR_BILLINFO are picked.

    QueryCustomerPartyListReqMsg is transformed into the input of PCM_OP_BAL_GET_ACCT_BAL_GRP_AND_SVC and calls the BRM opcode PCM_OP_BAL_GET_ACCT_BAL_GRP_AND_SVC. Several balance groups can be in the billing system for an account billing profile. Based on the value of n passed from Siebel CRM, the API returns <=n number of balance groups.

  8. The list of balance groups from the BRM output list is transformed into QueryCustomerPartyListRespMsg and returned to the QueryBalanceGroupListSiebelCommslReqABCSImpl service.

  9. QueryBalanceGroupListSiebelCommslReqABCSImpl then transforms the response messages into QueryBalanceGroupListRespMsg, which is returned to the AccountBalanceSiebelCommsReqABCS.

  10. AccountBalanceSiebelCommsReqABCS returns the QueryBalanceGroupListRespMsg to the calling Siebel web service AccountBalanceSiebelCommsReqABCS.

  11. The response message is then written to the Siebel Balance Group VBCs for the user.

QueryBalanceDetails Integration Flow

This integration uses the following service interfaces:

  • AccountBalanceSiebelCommsReqABCS with operation QueryBalanceDetails

  • QueryBalanceDetailsSiebelCommsReqABCSImpl

  • QueryCustomerPartyListBRMCommsProvABCSImpl

Figure 3-5 displays the QueryBalanceDetails integration scenario.

Figure 3-5 QueryBalanceDetails Sequence Diagram

This image is described in the surrounding text..

When you initiate the QueryBalanceDetails process, the following events occur:

  1. Siebel web service calls AccountBalanceSiebelCommsReqABCS (operation - QueryBalanceDetails) with QueryBalanceDetailsReqMsg ABM comprising account ID, billing profile ID, and balance group ID.

  2. AccountBalanceSiebelCommsReqABCS invokes QueryBalanceDetailsSiebelCommsReqABCSImpl with QueryBalanceDetailsReqMsg ABM.

  3. QueryBalanceDetailsSiebelCommsReqABCSImpl transforms QueryBalanceGroupListReqMsg ABM to QueryCustomerPartyListReqMsgEBM and sets the value of the field, Query Criteria Code, to Query Balance Details.

  4. QueryBalanceDetailsSiebelCommsReqABCSImpl then routes the QueryCustomerPartyListReqMsgEBM to QueryCustomerPartyListBRMCommsProvABCSImpl.

  5. QueryCustomerPartyListBRMCommsProvABCSImpl ensures that the value in Query Criteria Code is Query Balance Details and transforms QueryCustomerPartyListReqMsgEBM into BRM ABM and calls the BRM API, PCM_OP_BAL_GET_BALANCES.

  6. PCM_OP_BAL_GET_BALANCES takes balance group ID as the input and returns the balance and balance details for that balance group.

  7. QueryCustomerPartyListBRMCommsProvABCSImpl transforms the BRM output to QueryCustomerPartyListResMsgEBM.

  8. QueryCustomerPartyListResMsgEBM goes as a response to QueryBalanceDetailsSiebelCommsReqABCSImpl.

QueryBalanceGroupServices Integration Flow

This integration uses the following service interfaces:

  • AccountBalanceSiebelCommsReqABCS

  • QueryBalanceGroupServicesSiebelCommsReqABCSImpl

  • QueryInstalledProductListBRMCommsProvABCSImpl

Figure 3-6 displays the QueryBalanceGroupServices integration scenario.

Figure 3-6 QueryBalanceGroupServices Sequence Diagram

This image is described in the surrounding text.

When you initiate the QueryBalanceGroupServices process, the following events occur:

  1. Siebel web service calls AccountBalanceSiebelCommsReqABCS using operation QueryBalanceGroupServices with QueryBalanceGroupServicesReqMsg ABM comprising account ID, billing profile ID, and balance group ID.

  2. AccountBalanceSiebelCommsReqABCS invokes QueryBalanceGroupServicesSiebelCommsReqABCSImpl with QueryBalanceGroupServicesReqMsg ABM.

  3. QueryBalanceGroupServicesSiebelCommsReqABCSImpl transforms QueryBalanceGroupServicesReqMsg ABM to QueryInstalledProductListReqMsgEBM and sets the value of the field, Query Criteria Code, to Query Balance Group Services.

  4. QueryBalanceGroupServicesSiebelCommsReqABCSImpl routes QueryInstalledProductListReqMsgEBM to QueryInstalledProductListBRMCommsProvABCSImpl.

    This service:

    1. Transforms QueryInstalledProductListReqMsgEBM to BRM ABM and calls the BRM API, PCM_OP_SEARCH, which takes a query statement involving balance group ID as input and returns the list of service IDs for that balance group.

    2. Calls the BRM API, PCM_OP_SUBSCRIPTION_GET_PURCHASED_OFFERINGS for each of the service IDs queried, which accepts a service ID as input and returns the list of product IDs associated with that service.

    3. Calls the BRM API, PCM_OP_READ_FLDS for each of the product IDs queried, which takes a product ID as input and returns the product details for that ID.

  5. QueryInstalledProductListBRMCommsProvABCSImpl merges and transforms the BRM output to QueryInstalledProductListResMsg enterprise business message (EBM).

  6. QueryInstalledProductListResMsgEBM goes as a response to QueryBalanceGroupServicesSiebelCommsReqABCSImpl.

BRM Interfaces

The QueryBalanceSummary integration flow uses this opcode:

  • PCM_OP_AR_GET_ACCT_BAL_SUMMARY

The QueryBalanceGroupList integration flow uses these opcodes:

  • PCM_OP_AR_GET_ACCT_BILLS

  • PCM_OP_BAL_GET_ACCT_BAL_GRP_AND_SVC

The QueryBalanceDetails integration flow uses this opcode:

  • PCM_OP_BAL_GET_BALANCES

The QueryBalanceGroupServices integration flow uses these opcodes:

  • PCM_OP_SEARCH

  • PCM_OP_SUBSCRIPTION_GET_PURCHASED_OFFERINGS

  • API, PCM_OP_READ_FLDS

See Oracle Communications Billing and Revenue Management Opcode Flist Reference for more information.

Siebel CRM Interfaces

The account balance integration flow uses this Siebel CRM interface:

  • AccountBalanceSiebelCommsReqABCS

See "Web Services Reference" in the Siebel Order Management Guide Addendum for Communications.

Industry Oracle AIA Components

The account balance integration uses the following delivered enterprise business objects (EBOs) and enterprise business messages (EBMs):

  • CustomerPartyEBO

  • InstalledProductEBO

  • QueryCustomerPartyListEBM

  • QueryCustomerPartyListResponseEBM

  • QueryInstalledProductListEBM

  • QueryInstalledProductListResponseEBM

The industry enterprise business object (EBO) and enterprise business message XML schema (EBM XSD) files are located under the Metadata Services (MDS) repository at: $AIA_HOME/AIAMetaData/AIAComponents/EnterpriseObjectLibrary/Industry/Communications/EBO/

The industry enterprise business service (EBS) WSDL files are located under the MDS repository at: $AIA_HOME/AIAMetaData/AIAComponents/EnterpriseBusinessServiceLibrary/Industry/Communications/EBO/

For detailed documentation of individual EBOs and EBMs, click the AIA Reference Doc link on EBO and EBM detail pages in Oracle Enterprise Repository (OER).

See "Configuring and Using Oracle Enterprise Repository as the Oracle SOA Repository" in Oracle Fusion Middleware Developer's Guide for Oracle Application Integration Architecture Foundation Pack for more information on how to use and configure OER to provide the AIA Reference Doc link.

EBOs can be extended such as adding new data elements. These extensions are protected and will remain intact even after a patch or an upgrade, so long as the extensibility guidelines are followed.

See "Working with AIA Design Patterns", AIA Assets Extensibility Patterns, Extending Existing Schemas in AIA in Oracle Fusion Middleware Developer's Guide for Oracle Application Integration Architecture Foundation Pack for more information.

Integration Services

These services are delivered with the account balance integration:

  • AccountBalanceSiebelCommsReqABCS

  • QueryBalanceSummarySiebelCommsReqABCSImpl

  • QueryCustomerPartyListBRMCommsProvABCSImpl

  • QueryBalanceGroupListSiebelCommsReqABCSImpl

  • QueryBalanceDetailsSiebelCommsReqABCSImpl

  • QueryBalanceGroupServicesSiebelCommsReqABCSImpl

  • QueryInstalledProductListBRMCommsProvABCSImpl

AccountBalanceSiebelCommsReqABCS

AccountBalanceSiebelCommsReqABCS mediates calls between the clients and the provider. AccountBalanceSiebelCommsReqABCS exposes the following operations related to Account Balance integration on the Siebel ABM.

  • QueryBalanceSummary:

    • Routes QueryBalanceSummaryReqMsg to the requester implementation service

    • Routes QueryBalanceSummaryRespMsg to the requester

  • QueryBalanceDetails:

    • Routes QueryBalanceDetailsReqMsg to the requester implementation service

    • Routes QueryBalanceDetailsRespMsg to the requester

  • QueryBalanceGroupList:

    • Routes QueryBalanceGroupListReqMsg to the requester implementation service

    • Routes QueryBalanceGroupListRespMsg to the requester

  • QueryBalanceGroupServices:

    • Routes QueryBalanceGroupServicesReqMsg to the requester implementation service

    • Routes QueryBalanceGroupServicesRespMsg to the requester

QueryBalanceSummarySiebelCommsReqABCSImpl

QueryBalanceSummarySiebelCommsReqABCSImpl transforms the Siebel message into QueryBalanceSummaryEBM and calls the provider to query the balance summary response from the billing system. It then transforms the EBM response back to a Siebel message and returns it to the calling Siebel web service.

QueryCustomerPartyListBRMCommsProvABCSImpl

QueryCustomerPartyListBRMCommsProvABCSImpl transforms the QueryBalanceSummaryEBM into BRM API input format and calls the API to query the balance summary output from the billing system. It then transforms the output from the API back to a CustomerPartyBalanceEBM message and returns it to the requestor.

QueryBalanceGroupListSiebelCommslReqABCSImpl

The QueryBalanceGroupListSiebelCommslReqABCSImpl transforms the QueryBalanceGroupListReqMsg into QueryCustomerPartyListReqMsgEBM.

QueryBalanceDetailsSiebelCommsReqABCSImpl

The QueryBalanceDetailsSiebelCommsReqABCSImpl is a Business Process Execution Language (BPEL) process that transforms the Siebel message into the QueryBalanceDetailsEBM and calls the provider to query the balance group and balance group balance details response from BRM. It then transforms the EBM response back to a Siebel message and returns it to the calling Siebel web service.

QueryBalanceGroupServicesSiebelCommsReqABCSImpl

QueryBalanceGroupServicesSiebelCommsReqABCSImpl transforms the Siebel message into QueryInstalledProductListEBM and calls the provider to query the balance group list from the billing system. It then transforms the EBM response back to a Siebel message and returns it to the calling Siebel web service.

QueryInstalledProductListBRMCommsProvABCSImpl

QueryInstalledProductListBRMProvABCSImpl transforms QueryInstalledProductListReqMsgEBM to BRM ABM and calls the BRM API, PCM_OP_SEARCH, which takes a query statement involving balance group ID as input and returns the list of service IDs for that balance group.

For each of the service IDs queried, QueryInstalledProductListBRMProvABCSImpl calls the BRM API, PCM_OP_SUBSCRIPTION_GET_PURCHASED_OFFERINGS, which takes a service ID as input and returns the list of product IDs associated with that service.

For each of the product IDs queried, QueryInstalledProductListBRMProvABCSImpl calls the BRM API, PCM_OP_READ_FLDS, which takes a product ID as input and returns the product details for that ID.