|Oracle® Application Integration Architecture Siebel CRM Integration Pack for Oracle Order Management: Order to Cash Implementation Guide
Part Number E20515-05
|PDF · Mobi · ePub|
This chapter provides an overview of Payment Authorization Requests and discusses Siebel Customer Relationship Management (Siebel CRM) and Oracle E-Business Suite (Oracle EBS) interfaces, core Oracle Application Integration Architecture (Oracle AIA) components, and integration services.
This chapter includes the following sections:
If the payment method is Credit Card, then the Payment Authorization integration flow can be called on request before submitting the order.
The Payment Authorization integration flow is a synchronous call, initiated in Siebel CRM, which obtains the credit authorization status from Oracle EBS. The credit card details and order amount are passed to Oracle EBS to authorize the payment for the order amount. Oracle EBS responds with a message that indicates whether the amount was charged to the credit card or whether it failed authorization. This data is returned to Siebel CRM so that a Customer Service Representative (CSR) can inform the customer. The order is not sent to the back office until the payment authorization is successful.
Only one credit card is supported per order. If the credit authorization fails, the status is set to Rejected. An order cannot be submitted for fulfillment if the credit authorization fails.
This integration flow works with Siebel sales orders only, not quotes.
The Payment Authorization flow applies to integration with Oracle EBS 11i10 only.
Find prerequisites in Chapter 13, "Reviewing Prerequisites and Data Requirements."
The Payment Authorization integration flow has the following assumptions:
Only one credit card per order is supported.
Only payment authorization is supported. Settlement is not supported.
Payment Authorization is supported for sales orders only.
In this flow, the expiration month and year for the Credit Card Expiry details are passed from Siebel CRM.
However, Oracle EBS also requires a day of the month. Therefore, the date format MM/YYYY from Siebel CRM is changed to YYYY-MM-DD format in Oracle EBS, where DD is set as 01 always to denote the first of the month. The issue with this approach is that the credit card is not authenticated in cases in which the current month, year, or both equals the expiry month, year, or both and the current date is beyond the first of the month.
This business flow of Payment Authorization integration is supported for Oracle EBS 11i10 only.
This flow is not applicable for Oracle EBS 12.1.x due to inherent changes in the iPayment module. If implementations on Oracle EBS 12.1.x require Credit Card mode of payment, Oracle recommends following options:
Siebel CRM natively supports Credit Card authorization with third-party payment providers.
The authorization codes received from this integration along with credit card details can be passed as part of the Order submit to Oracle EBS.
For more information, see the Siebel eSales Administration Guide, "Integrating Siebel eSales with Third-Party Payment Applications. "
Alternately, only the credit card details can be synchronized to Oracle EBS as part of Order submit process, and the payment authorization can be accomplished in Oracle EBS itself.
This integration flow uses the following interfaces:
Figure 10-3 illustrates the Payment Authorization integration flow:
From the Siebel Order window, search for and select your order.
Order line items appear in the line item applet. Navigate to the Siebel Payments window and enter specific payment attributes, such as credit card type, credit card number, credit card holder, and so on. Click Authorize.
Invoke the Siebel web service, which calls the PaymentAuthorizationSalesOrderSiebelReqABCSImpl with the operation PaymentAuthorization.
The PaymentAuthorizationSalesOrderSiebelReqABCSImpl transforms the PaymentAuthorizationSalesOrderReqMsg into ProcessCreditChargeAuthorizationEBM and invokes the ReceivedPaymentEBS with the operation ProcessCreditChargeAuthorization.
Invoking the ReceivedPaymentEBS with the message ProcessCreditChargeAuthorizationEBM and the operation ProcessCreditChargeAuthorization routes the message to the ProcessCreditChargeAuthorizationEbizProvABCSImpl.
The ProcessCreditChargeAuthorizationEbizProvABCSImpl with the input message ProcessCreditChargeAuthorizationEBM does a transformation from ProcessCreditChargeAuthorizationEBM to the input of the IBY_PAYMENT_ADAPTER_PUB API and calls the Oracle EBS-provided adapter for the procedure.
ProcessCreditChargeAuthorizationEbizProvABCSImpl transforms the output of the IBY_PAYMENT_ADAPTER_PUB API returned by the Oracle EBS adapter into the ProcessCreditChargeAuthorizationResponseEBM.
The same EBM is returned to the ReceivedPaymentEBS.
The ReceivedPaymentEBS with the message ProcessCreditChargeAuthorizationResponseEBM and the operation ProcessCreditChargeAuthorization routes the message to the PaymentAuthorizationSalesOrderSiebelReqABCSImpl.
The PaymentAuthorizationSalesOrderSiebelReqABCSImpl transforms the ProcessCreditChargeAuthorizationResponseEBM into the PaymentAuthorizationSalesOrderRespMsg, and the response is sent back to the invoking web service.
If the integration flow is successful, the authorization code and date appear in Siebel CRM.
The Siebel interfaces for the Payment Authorization integration flow are:
Siebel should call PaymentAuthorizationSalesOrderSiebelReqABCSImpl with a PaymentAuthorizationSalesOrderReqMsg application business message (ABM).
Siebel expects PaymentAuthorizationSalesOrderRespMsg ABM from PaymentAuthorizationSalesOrderSiebelReqABCSImpl.
For more information about Siebel web services, see CRM Web Services Reference.
The Oracle EBS interfaces for the Payment Authorization integration flow are:
Service Name: IBY_BPEL_EBS11I10PAYMENTAUTH IBY_PAYMENT_ADAPTER_PUB$ORAPM
Service Name: IBY_BPEL_EBS11I10PAYMENTAUTH IBY_PAYMENT_ADAPTER_PUB$ORAPM
For more information about Oracle E-Business Suite web services and documentation prior to Release 12.1.3, see the library on Oracle Technology Network:
http://www.oracle.com/technetwork/documentation/applications-167706.html?. For Oracle E-Business Suite documentation for R12.1.3 and beyond, see this library:
The Payment Authorization integration flow uses the following horizontal components:
The industry enterprise business object (EBO) and enterprise business message XML schema (EBM XSD) files are located here: $AIA_HOME/AIAMetaData/AIAComponents/EnterpriseObjectLibrary/Core/EBO/
The industry enterprise business service (EBS) WSDL files are located here: $AIA_HOME/AIAMetaData/AIAComponents/EnterpriseBusinessServiceLibrary/Core/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.
For more information about using the Oracle Enterprise Repository and configuring it to provide the AIA Reference Doc link, see Oracle Fusion Middleware Developer's Guide for Oracle Application Integration Architecture Foundation Pack, "Configuring and Using Oracle Enterprise Repository as the Oracle AIA SOA Repository."
EBOs can be extended, for instance, to add new data elements. These extensions are protected, and they remain intact after a patch or an upgrade.
For more information, see Oracle Fusion Middleware Concepts and Technologies Guide for Oracle Application Integration Architecture Foundation Pack, "Understanding Extensibility."
The following services are delivered with the Payment Authorization integration flow:
For more information, see Oracle Fusion Middleware Developer's Guide for Oracle Application Integration Architecture Foundation Pack, "Configuring and Using Oracle Enterprise Repository as the Oracle AIA SOA Repository."
For the Payment Authorization integration flow, the ReceivedPaymentEBS exposes the ProcessCreditChargeAuthorization operation and:
Routes the ProcessCreditChargeAuthorizationEBM to the Oracle EBS provider service
Routes ProcessCreditChargeAuthorizationResponseEBM to the requester service
For more information about this service, see Oracle Fusion Middleware Developer's Guide for Oracle Application Integration Architecture Foundation Pack, "Designing and Developing Enterprise Business Services" and Oracle Fusion Middleware Concepts and Technologies Guide for Oracle Application Integration Architecture Foundation Pack, "Understanding Enterprise Business Services."
The PaymentAuthorizationSalesOrderSiebelReqABCSImpl is the application business connector service (ABCS) that exposes the following operations related to Payment Authorization integration on the Siebel ABM.
This Business Process Execution Language (BPEL) process is used by the ProcessCreditChargeAuthorization integration flow. The PaymentAuthorizationSalesOrderSiebelReqABCSImpl transforms the Siebel request message into the ProcessCreditChargeAuthorizationEBM and calls the ReceivedPaymentEBS. The ReceivedPaymentEBS routes the message to the provider service ProcessCreditChargeAuthorizationEbizProvABCSImpl. The provider service sends a request for payment authorization to iPayment and gets the payment authorization details from Oracle EBS and sends back ProcessCreditChargeAuthorizationResponseEBM to the ReceivedPaymentEBS EBS. The ReceivedPaymentEBS then routes ProcessCreditChargeAuthorizationResponseEBM to the PaymentAuthorizationSalesOrderSiebelReqABCSImpl.
The PaymentAuthorizationSalesOrderSiebelReqABCSImpl then transforms the ProcessCreditChargeAuthorizationResponseEBM into the Siebel response message and returns it to the calling Siebel web service ProcessCreditChargeAuthorizationEbizProvABCSImpl.
PaymentAuthorizationSalesOrderSiebelReqABCSImpl has the following transformations:
The ProcessCreditChargeAuthorizationEbizProvABCSImpl BPEL process is used by the ProcessCreditChargeAuthorization integration flow. The ReceivedPaymentEBS routes the ProcessCreditChargeAuthorizationEBM message to the provider ABCS ProcessCreditChargeAuthorizationEbizProvABCSImpl.
The ProcessCreditChargeAuthorization EbizProvABCSImpl transforms the ProcessCreditChargeAuthorizationEBM message to the Oracle EBS API-specific ABM message. The Provider ABCS calls the Oracle EBS adapter with the ABM message and gets the ABM response message from Oracle EBS. The ProcessCreditChargeAuthorizationEbizProvABCSImpl transforms this response ABM message into the ProcessCreditChargeAuthorizationResponseEBM and sends it back to the ReceivedPaymentEBS.
The ProcessCreditChargeAuthorizationEbizProvABCSImpl has the following transformations: