| 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 |
|
|
PDF · Mobi · ePub |
| 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 |
|
|
PDF · Mobi · ePub |
This chapter provides an overview of the invoice integration flows and discusses Siebel Customer Relationship Management (Siebel CRM) and Oracle Billing and Revenue Management (BRM) interfaces, industry Oracle Application Integration Architecture (Oracle AIA) components, and integration services
The invoice integration between Siebel CRM and BRM supports the following integration scenarios:
QueryInvoiceList enables a customer service representative (CSR) to view a list of invoices for an account billing profile in Siebel CRM.
QueryInvoice enables a CSR to view invoice details in Siebel CRM.
QueryInvoiceUsageAllocation enables a CSR to view invoice event details (call detail (CDR) records) in Siebel CRM.
SearchInvoiceUsageAllocation enables a CSR to search invoice event detail records (CDR records) in Siebel CRM.
QueryInvoiceUsageAllocationResource enables a CSR to view nonmonetary resource balance details in Siebel CRM.
Invoices are generated on a periodic basis by BRM after a bill cycle. An invoice, when calculated, does not change. An invoice usually has three segments: Header, Summary, and Details. The CSR can resolve most bill inquiries by viewing the Header and Summary of an invoice. The View Invoice feature enables the CSR to view invoice data at any of these levels: header, summary, and detail. The integration between the Siebel CRM and billing systems must present the n most current invoices in the Siebel CRM system. Additionally, the invoice header, summary, and details are never replicated from BRM to Siebel CRM. Instead they must be retrieved on demand from BRM to Siebel CRM.
When the CSR clicks the Bills tab of the Billing Profile screen, a process is started that brings the latest n invoices from the billing system. They can make n configurable in Siebel CRM based on business requirements. The value of n is passed to the billing system when a request is made to it.
When a CSR navigates to a retrieved invoice, the Bill Detail view appears. This starts another process that gets the invoice or bill header and item data, and displays it on the header and items applet of the Bill Detail view. In the billing system, two application programming language (APIs) exist that calls the invoice header and items data. However, a single request from Siebel CRM invokes these two API calls and brings a single hierarchical message back to Siebel CRM. While retrieving invoice data, the process does not return the payment and A/R items data for the selected invoice. So when a CSR clicks the Payment tab on the Bill Detail view, a separate web service call is made to retrieve payment data for the selected invoice or bill. Similarly, when a CSR clicks the A/R items tab, A/R items data for the selected invoice is retrieved and displayed.
Additionally, the integration process aggregates the item charge information to the services level so that service charges can be displayed in the Service Charges applet.
Finally, for the CSRs to obtain the Item Details record, the CSRs can select an invoice item and then click the Net Amount link associated with the item charge. This triggers another request to the billing system to send the item or event details record. Because this item detail data is generally large, an option is provided to the CSRs to limit the data retrieved using search criteria.
Note:
The date and time information of the event details and CDR, which is displayed in the Siebel UI, is specific to the time zone from where the event originated.Figure 4-1 illustrates the invoice integration flow.
To view invoice information for an account in the billing profile in Siebel CRM:
Navigate to the Accounts screen and query an account. Scroll down to the Billing Profile applet for this account and click the Billing Profile Name link.
Click the Bills tab to view a list of invoices.
Click the Bill Number link to view the details for that invoice.
Go to the Item Charges applet and click the Net Amount link to view the invoice usage allocation (CDRs) for that item.
Click the Search tab to search invoice event detail records.
In the Event Details, click View Details to query the resource impact details (non-monetary charges, for example free minutes, and so on) for an event from the billing system.
See "Mapping Siebel Billing Management UI Elements to BRM Customer Center" for more information on mapping Siebel CRM elements to BRM elements.
This integration flow uses the following interfaces:
InvoiceSiebelCommsReqABCS with operation QueryInvoiceList
QueryInvoiceListSiebelCommsReqABCSImpl
QueryInvoiceListBRMCommsProvABCSImpl
Figure 4-3 illustrates the QueryInvoiceList integration scenario.
When you initiate the QueryInvoiceList process, the following events occur:
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, Bills tab, a web service call is made to query the list of n invoices for that billing profile. Many invoices may be in BRM, but the number n of invoices to be fetched is sent from Siebel CRM as part of the request message and <=n number of invoices are returned from BRM. The default values of invoices (n) queried depends on the configuration in Siebel Integration Object CMU Request Billing Profile IO integration component Com Invoice Profile field Maximum Number Of Records.
Navigating to the Invoice applet in the Billing Profile BRM screen invokes outbound web service InvoiceSiebelCommsReqABCS, which in turn calls the InvoiceSiebelCommsReqABCS with operation QueryInvoiceList.
InvoiceSiebelCommsReqABCS is a generic Invoice interface service with several operations defined on the Invoice application business message (ABM).
Invoking InvoiceSiebelCommsReqABCS with operation QueryInvoiceList routes the QueryInvoiceListReqMsg to the QueryInvoiceListSiebelCommsReqABCSImpl.
The QueryInvoiceListSiebelCommsReqABCSImpl first transforms the QueryInvoiceListReqMsg into QueryInvoiceListRequest enterprise business message (EBM) and routes the QueryInvoiceListReqMsg to the appropriate billing systems.
As delivered, QueryInvoiceListReqMsg is routed to the QueryInvoiceListBRMCommsProvABCSImpl.
QueryInvoiceListBRMCommsProvABCSImpl first checks the Query Criteria code.
If it is Query Invoice List, 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.
From the response of PCM_OP_BAL_GET_ACCT_BILLINFO opcode, the appropriate BILLINFO and AR_BILLINFO are picked.
QueryInvoiceListReqMsg is transformed into the input of PCM_OP_AR_GET_ACCT_BILLS and calls the BRM opcode PCM_OP_AR_GET_ACCT_BILLS. Many invoices may be in the billing system for an account billing profile. Based on the value of n passed from Siebel CRM, the application programming interface (API) returns <=n number of invoices.
QueryInvoiceListBRMCommsProvABCSImpl then transforms the API output PCM_OP_AR_GET_ACCT_BILLS_RespMsg into EBM QueryInvoiceListRespMsg and returns it to QueryInvoiceListSiebelCommsReqABCSImpl.
QueryInvoiceListSiebelCommsReqABCSImpl then transforms the QueryInvoiceListRespMsg into QueryInvoiceListRespMsg, which is returned to the InvoiceSiebelCommsReqABCS.
InvoiceSiebelCommsReqABCS returns the QueryInvoiceListRespMsg to the calling Siebel web service InvoiceSiebelCommsReqABCSService.
The system then writes the list of bills to the Siebel Invoice virtual business component (VBC) for the user.
This integration flow uses the following interfaces:
InvoiceSiebelCommsReqABCS with operation QueryInvoice
QueryInvoiceSiebelCommsReqABCSImpl
QueryInvoiceListBRMCommsProvABCSImpl
Figure 4-4 illustrates the QueryInvoice integration scenario.
When you initiate the QueryInvoice process, the following events occur:
In Siebel CRM, navigate to the Accounts screen, query an account, and click a Billing Profile for the account.
This displays the Billing Profile screen. Click the Bills tab and drill-down on the Bill Number to call the query invoice information (header, service charges, and items) from the billing system.
The InvoiceSiebelCommsReqABCS with the operation QueryInvoice is called.
The InvoiceSiebelCommsReqABCS is a generic Siebel invoice interface service with several operations defined on the Invoice EBO.
The InvoiceSiebelCommsReqABCS with the operation QueryInvoice routes the QueryInvoiceReqMsg to the QueryInvoiceSiebelCommsReqABCSImpl.
The QueryInvoiceSiebelCommsReqABCSImpl transforms the QueryInvoiceReqMsg into the Invoice EBM and routes the QueryInvoiceListReqMsg to the appropriate billing system.
As delivered, QueryInvoiceListReqMsg is routed to the QueryInvoiceListBRMCommsProvABCSImpl.
The QueryInvoiceListBRMCommsProvABCSImpl first checks the Query Criteria code. If it is Query Invoice, it then transforms QueryInvoiceListReqMsg into the input of PCM_OP_BAL_GET_ACCT_BILLINFO_inputFlist and invokes PCM_OP_BAL_GET_ACCT_BILLINFO to get the Bill Info object.
This information is used to populate PCM_OP_AR_GET_BILL_ITEMS_inputFlist and calls the BRM opcode PCM_OP_AR_GET_BILL_ITEMS. The opcode returns the invoice header, service charges, and items in a flat message to the calling QueryInvoiceListBRMCommsProvABCSImpl.
The QueryInvoiceListBRMCommsProvABCSImpl transforms the API output PCM_OP_AR_GET_BILL_ITEMS_outputFlist into the EBM QueryInvoiceListRespMsg and returns it to QueryInvoiceSiebelCommsReqABCSImpl.
The QueryInvoiceSiebelCommsReqABCSImpl transforms the QueryInvoiceListRespMsg into the QueryInvoiceRespMsg and returns it to the Siebel Invoice ABC interface service.
The QueryInvoiceListRespMsg is a flat message from which service charges are calculated and the invoice header, service charges, and items are returned as the QueryInvoiceRespMsg to the calling InvoiceSiebelCommsReqABCS.
The InvoiceSiebelCommsReqABCS returns the QueryInvoiceRespMsg to the calling Siebel web service.
This integration flow uses the following interfaces:
InvoiceSiebelCommsReqABCS with operation QueryEventDetails
QueryInvoiceEventDetailsSiebelCommsReqABCSImpl
QueryInvoiceListBRMCommsProvABCSImpl
Figure 4-5 illustrates the QueryInvoiceUsageAllocation integration scenario.
When you initiate the QueryInvoiceUsageAllocation process, the following events occur:
In Siebel CRM, navigate to the Accounts screen, query an account, and select the billing profile for the account.
In the Billing Profile screen, click the Bills tab and select an invoice. Select an item charge and click the Net Amount link of the item to view Event Details. This action calls Siebel outbound web service InvoiceSiebelCommsReqABCS to query the event details from the billing system.
Navigating to the Invoice Event Details (call detail (CDR) records) applet in the Billing BRM screen invokes the InvoiceSiebelCommsReqABCSService web service with operation QueryEventDetails, which in turn calls the InvoiceSiebelCommsReqABCS with operation QueryEventDetails.
InvoiceSiebelCommsReqABCS is a generic Siebel Invoice interface service with several operations defined in the Invoice EBO.
Invoking InvoiceSiebelCommsReqABCS with operation QueryEventDetails routes the QueryEventDetailsReqMsg to the QueryInvoiceEventDetailsSiebelCommsReqABCSImpl.
The QueryInvoiceEventDetailsSiebelCommsReqABCSImpl transforms the QueryEventDetailsReqMsg into Invoice EBM and routes the QueryInvoiceListReqMsg to the appropriate billing system.
As delivered, QueryInvoiceListReqMsg is routed to the QueryInvoiceListBRMCommsProvABCSImpl.
QueryInvoiceListBRMCommsProvABCSImpl checks query criteria code.
If it is Query Usage Allocation, then it transforms QueryInvoiceListReqMsg into the input of PCM_OP_ BILL_GET_ITEM_EVENT_CHARGE_DISCOUNT and calls the opcode PCM_OP_ BILL_GET_ITEM_EVENT_CHARGE_DISCOUNT.
QueryInvoiceListBRMCommsProvABCSImpl then transforms the API output PCM_OP_ BILL_GET_ITEM_EVENT_CHARGE_DISCOUNT_RespMsg into EBM QueryInvoiceListRespMsg and returns it to QueryInvoiceEventDetailsSiebelCommsReqABCSImpl.
QueryInvoiceEventDetailsSiebelCommsReqABCSImpl transforms the QueryInvoiceListRespMsg into QueryEventDetailsRespMsg, which is returned to InvoiceSiebelCommsReqABCS.
InvoiceSiebelCommsReqABCS returns the QueryEventDetailsRespMsg to the calling Siebel web service.
The system then writes the response message to the Siebel Invoice VBC for the user.
This integration flow uses the following interfaces:
InvoiceSiebelCommsReqABCS with operation SearchEventDetails
SearchInvoiceEventDetailsSiebelCommsReqABCSImpl
QueryInvoiceListBRMCommsProvABCSImpl
The SearchInvoiceUsageAllocation supports searching invoice event details (CDR records) on the following columns in addition to the account ID and the item charge ID that are passed to Query Invoice Details:
Minimum Amount
Maximum Amount
Start Date
End Date
The BRM opcode PCM_OP_BILL_GET_ITEM_EVENT_CHARGE_DISCOUNT supports only simple queries, so the search supports passing only the data through and not passing complex query criteria, (for example, >, <, between, and so on).
Figure 4-6 illustrates the SearchInvoiceUsageAllocation integration scenario.
When you initiate the SearchInvoiceUsageAllocation process, the following events occur:
In Siebel CRM, navigate to the Accounts screen, query an account, and select the billing profile for the account.
In the Billing Profile screen, click the Bills tab and select an invoice. Select an item charge, and click the Net Amount link of the item to view event details of all CDR records for that item charge.
Clicking the Search button on the Invoice Event Details (CDR details) applet opens the search applet for query.
Entering the search criteria and clicking Go invokes an outbound web service InvoiceSiebelReqABCS that in turn calls the InvoiceSiebelCommsReqABCS with operation SearchEventDetails.
InvoiceSiebelCommsReqABCS is a generic Siebel Invoice interface service with several operations defined on the Invoice EBO.
Invoking InvoiceSiebelCommsReqABCS with operation SearchEventDetails routes the SearchEventDetailsReqMsg to the SearchInvoiceEventDetailsSiebelCommsReqABCSImpl.
The SearchInvoiceEventDetailsSiebelCommsReqABCSImpl transforms the SearchEventDetailsReqMsg into an Invoice EBM and routes the QueryInvoiceListReqMsg to the appropriate billing systems.
As delivered, QueryInvoiceListReqMsg is routed to the QueryInvoiceListBRMCommsProvABCSImpl.
QueryInvoiceListBRMCommsProvABCSImpl checks the query criteria code. If the query criteria code is Usage Allocation, it then transforms QueryInvoiceListReqMsg into the input of PCM_OP_ BILL_GET_ITEM_EVENT_CHARGE_DISCOUNT and calls the BRM opcode PCM_OP_ BILL_GET_ITEM_EVENT_CHARGE_DISCOUNT.
QueryInvoiceListBRMCommsProvABCSImpl transforms the API output PCM_OP_ BILL_GET_ITEM_EVENT_CHARGE_DISCOUNT_RespMsg into EBM QueryInvoiceListRespMsg and returns it to SearchInvoiceEventDetailsSiebelCommsReqABCSImpl.
SearchInvoiceEventDetailsSiebelCommsReqABCSImpl transforms the QueryInvoiceListRespMsg into a SearchEventDetailsRespMsg, which is returned to InvoiceSiebelCommsReqABCS.
InvoiceSiebelCommsReqABCS returns the SearchEventDetailsRespMsg to the calling Siebel web service.
The system writes the search response to the Siebel Invoice VBC for the user.
This integration flow uses the following interfaces:
InvoiceSiebelCommsReqABCS with operation QueryBalanceDetails
QueryInvoiceBalanceDetailsSiebelCommsReqABCSImpl
QueryInvoiceListBRMCommsProvABCSImpl
Figure 4-7 illustrates the QueryInvoiceUsageAllocationResource integration scenario.
When you initiate the QueryInvoiceUsageAllocationResource process, the following events occur:
In Siebel CRM, navigate to the Accounts screen, query an account, and select the billing profile for the account.
In the Billing Profile screen, click the Bills tab and select an invoice. In Event Details, click View Detail to query the resource impact details for an event from the billing system. A web service call is made to query resource impact details for a particular event from the billing system, which in turn calls the InvoiceSiebelCommsReqABCS with operation QueryResourceBalance.
InvoiceSiebelCommsReqABCS is a generic Siebel Invoice interface service with several operations defined on the Invoice EBO.
Invoking InvoiceSiebelCommsReqABCS with operation QueryBalanceDetails routes the QueryBalanceDetailsReqMsg to the QueryInvoiceBalanceDetailsSiebelCommsReqABCSImpl.
The QueryInvoiceBalanceDetailsSiebelCommsReqABCSImpl transforms the QueryBalanceDetailsReqMsg into Invoice EBM and routes the QueryInvoiceListReqMsg to the appropriate billing system.
As delivered, QueryInvoiceListReqMsg is routed to the QueryInvoiceListBRMCommsProvABCSImpl.
QueryInvoiceListBRMCommsProvABCSImpl checks the query criteria code.
If the query criteria code is Query Balance Details, it transforms QueryInvoiceListReqMsg into the input of PCM_OP_ AR_RESOURCE_AGGREGATION and calls the opcode PCM_OP_ AR_RESOURCE_AGGREGATION.
QueryInvoiceListBRMCommsProvABCSImpl transforms the API output PCM_OP_ AR_RESOURCE_AGGREGATION_RespMsg into EBM QueryInvoiceListRespMsg and returns it to QueryInvoiceBalanceDetailsSiebelCommsReqABCSImpl.
QueryInvoiceBalanceDetailsSiebelCommsReqABCSImpl transforms the QueryInvoiceListRespMsg into QueryBalanceDetailsRespMsg, which is returned to the InvoiceSiebelCommsReqABCS.
InvoiceSiebelCommsReqABCS returns the QueryBalanceDetailsRespMsg back to the calling Siebel web service.
The system writes the message to the Siebel UsageAllocationResource VBC for the user.
The QueryInvoiceList integration flow uses this opcode:
PCM_OP_AR_GET_ACCT_BILLS
The QueryInvoice integration flow uses this opcode:
PCM_ OP_AR_GET_BILL_ITEMS
The QueryInvoiceUsageAllocation integration flow uses this opcode:
PCM_OP_BILL_GET_ITEM_EVENT_CHARGE_DISCOUNT
The SearchInvoiceUsageAllocation integration flow uses this opcode:
PCM_OP_BILL_GET_ITEM_EVENT_CHARGE_DISCOUNT
The QueryInvoiceUsageAllocationResource integration flow uses this opcode:
PCM_OP_AR_RESOURCE_AGGREGATION_RespMsg
See Oracle Communications Billing and Revenue Management Opcode Flist Reference for more information.
The Invoice integration flow uses the following Siebel CRM interface:
InvoiceSiebelCommsReqABCS
See "Web Services Reference" in Siebel Order Management Guide Addendum for Communications for more information.
The Invoice integration flow uses the following delivered enterprise business object (EBO) and enterprise business messages (EBMs):
InvoiceEBO
QueryInvoiceEBM
QueryInvoiceResponseEBM
QueryInvoiceListEBM
QueryInvoiceListResponseEBM
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 the 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.
These services are delivered with the Invoice Integration flow:
InvoiceSiebelCommsReqABCS with operations QueryInvoiceList, QueryInvoice, QueryEventDetails, SearchEventDetails, and QueryBalanceDetails
QueryInvoiceListSiebelCommsReqABCSImpl
QueryInvoiceListBRMCommsProvABCSImpl
QueryInvoiceSiebelCommsReqABCSImpl
QueryInvoiceEventDetailsSiebelCommsReqABCSImpl
SearchInvoiceEventDetailsSiebelCommsReqABCSImpl
QueryInvoiceBalanceDetailsSiebelCommsReqABCSImpl
InvoiceSiebelCommsReqABCS exposes the following operations related to the Invoice integration on the Siebel ABM:
QueryInvoiceList:
Routes QueryInvoiceListReqMsg to the requester implementation service
Routes QueryInvoiceListRespMsg to the requester
QueryInvoice:
Routes QueryInvoiceReqMsg to the requester implementation service
Routes QueryInvoiceRespMsg to the requester
QueryEventDetails:
Routes QueryEventDetailsReqMsg to the requester implementation service
Routes QueryEventDetailsRespMsg to the requester.
SearchEventDetails:
Routes SearchEventDetailsReqMsg to the requester implementation service
Routes SearchEventDetailsRespMsg to the requester
QueryBalanceDetails:
Routes QueryBalanceDetailsReqMsg to the requester implementation service
Routes QueryBalanceDetailsRespMsg to the requester
QueryInvoiceListSiebelCommsReqABCSImpl
QueryInvoiceListSiebelCommsReqABCSImpl transforms the Siebel message into a QueryInvoiceList EBM and calls the provider to query the invoice list 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.
QueryInvoiceListBRMCommsProvABCSImpl transforms:
QueryInvoiceListRequestEBM into BRM API input format and calls the API to query the invoice list output from the billing system.
It then transforms the output from the API back to an Invoice EBM message and returns it to the calling requestor.
QueryInvoice EBM into BRM API input formats and calls the APIs to Query the Invoice output from the billing system.
It then transforms the output from the APIs back to an Invoice EBM message and returns it to the calling requestor.
QueryInvoiceList EBM into BRM API input formats and calls the APIs to Query the Invoice Event Details output from the billing system.
It then transforms the output from the APIs back to an Invoice EBM message and returns it to the calling requestor.
Invoice EBM into BRM API input formats and calls the APIs to Query the Resource Impact output from the billing system.
It then transforms the output from the APIs back to an Invoice EBM message and returns it to the calling requestor.
QueryInvoiceSiebelCommsReqABCSImpl transforms the Siebel message into QueryInvoiceEBM and calls the provider to query the invoice from the billing system. It then transforms the EBM response back to a Siebel message and returns it to the calling Siebel web service.
QueryInvoiceEventDetailsSiebelCommsReqABCSImpl transforms the Siebel message into QueryInvoiceList EBM and calls the provider to query the invoice event details 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.
SearchInvoiceEventDetailsSiebelCommsReqABCSImpl transforms the Siebel message into QueryInvoiceList EBM and calls the provider to query the Invoice Event Details 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.
SearchInvoiceCharge supports searching invoice event details (CDR records) on the following columns in addition to the account ID and the item charge ID that are passed to Query Invoice Details:
Minimum Amount
Maximum Amount
Start Date
End Date
The BRM opcode PCM_OP_ BILL_GET_ITEM_EVENT_CHARGE_DISCOUNT supports only simple queries, so the search supports passing only the data through and not passing complex query criteria (for example: >, <, between, and so on).
QueryInvoiceBalanceDetailsSiebelCommsReqABCSImpl transforms the Siebel message into an Invoice EBM and calls the provider to query the Resource Impact 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.
|
 Copyright © 2009, 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|
