5Integrating Order to Cash and Distributed Order Orchestration
Integrating Order to Cash and Distributed Order Orchestration
This chapter describes how to integrate order-to-cash and distributed-order-orchestration functionality using Oracle’s Application Integration Architecture (AIA). It includes the following topics:
Process of Integrating Order to Cash
You integrate order to cash functionality using Oracle Application Integration Architecture (AIA) rather then using the integration strategies described in Integrating Order Management with Back-Office Applications.
Order to cash features are described in the following topics:
Canceling an Order Line Item. Users can cancel order line items.
Placing an Order on Hold. Users can stop orders temporarily by using the Hold and Hold Reason fields in the order header.
Canceling an Order. Users can cancel orders with a status of Booked or Awaiting Shipping by clicking the Cancel Order button.
Adding Shipping Information. Users can enter special instructions on shipping and packing in the Ship Instructions and Pack Instructions fields.
Checking the Status of Order Shipments. A read-only Back Office Error Text field in the order header shows feedback from the back office about order errors.
To integrate order to cash using AIA, perform the following tasks:
Setting System Preferences for Order to Cash
Administrators must set system preference values. The system preferences listed in this topic control aspects of Oracle Application Integration Architecture integration functionality.
This task is a step in Process of Integrating Order to Cash.
To set the system preferences for order to cash
Navigate to the Administration - Application screen, then the System Preferences view.
Query for the Oracle Application Integration Architecture integration system preferences, and set the appropriate value for each.
Oracle Application Integration Architecture integration system preferences are listed in the following table.
System Preference Comments Cancel Error Mode
Controls the behavior when an order that has future-dated line items is cancelled. Those future-dated line items will be affected by the cancellation of this order. Values are as follows:
1 Do not display warning messages.
2 Display warning messages.
3 (Default) Display warning and error messages, and stop processing.
Validate Due Date
Controls the behavior of the pop-up applet that prompts for the Due Date for change orders such as Modify, Disconnect, Suspend, and Resume. Values are as follows:
1 No warning messages are displayed. Modify, Suspend, Resume, and Disconnect (MACD) operations are continued for assets and orders.
2 (Default) Display warning messages. Enable the Continue button on the Due Date window.
3 Display warning messages. Disable the Continue button on the Due Date window.
Enable AIA Comms
Controls whether or not to enable the Oracle Application Integration Architecture Communications integration features. Values are as follows:
TRUE Enable Oracle Application Integration Architecture Communications integration features.
FALSE Disable Oracle Application Integration Architecture Communications integration features.
Enable AIA Testing
Controls whether or not to enable the Oracle Application Integration Architecture Communications integration testing features. Values are as follows:
TRUE Enable Oracle Application Integration Architecture Communications integration testing.
FALSE Disable Oracle Application Integration Architecture Communications integration testing.
AIA Order Backup Path
XML files are available on the specified path, with file names in the form OrderNumber>_RevisionNumber>.xml. The files can be sorted by Date Modified. Enabled only if the Enable AIA Testing system preference is set to TRUE. Value is as follows:
/export/home/qa1/orderbackup/
Workspace Release Flag
A product that is synchronized from Oracle Product Information Management Data Hub is a workspace version, that is, a test version, in Siebel CRM. This system preference holds or releases all the products associated with a workspace. This system preference appears in the SWIProductImportIO, SWIAttributeImportIO, and SWIProductClassImport Web services.
Additionally, a Product Release Flag in each product definition can be used to release the individual product.
The Workspace Release Flag system preference has the following values:
N. Default value. Siebel CRM does not automatically release the products.
In this case, a user can set the Product Release Flag of an individual product to Y to release that specific product, and all the other products in the same payload will not be released.
Y. Siebel CRM automatically releases the products.
In this case, all the products belonging to the Workspace are automatically released. This setting overrides the Product Release Flag settings of the individual products in the Workspace.
D. Signifies a default or empty value.
In this case, the default value of this system preference, which is N, determines whether to automatically release the product.
Enable AIA MDM
Enables or disables the Master Data Management (MDM) PIP. Default value is set to FALSE. To enable the MDM PIP, you must change this system preference value to TRUE and restart the Siebel server.
Enable AIA OrderToCash
Enables or disables the Distributed-Order-Orchestration integration and Order-to-Cash PIP. Default value is set to FALSE. To enable the Distributed-Order-Orchestration integration, you must change this system preference value to TRUE and restart the Siebel server.
Caution: It is recommended that you not set the Enable AIA Comms and Enable AIA OrderToCash system preferences to TRUE in the same Siebel CRM instance. Interoperability of Siebel Communications PIPs (Order-to-Bill and Agent Assisted Billing Care) with the Order-to-Cash PIP is not tested or supported by Oracle.Set other system preferences, if necessary.
For more information about system preferences, see the chapter on ongoing tasks and the system preferences appendix in Siebel Applications Administration Guide.
Setting Up Integration Users for Order to Cash
Administrators must designate integration users. These integration user credentials are used by the Siebel application to accept inbound Web service calls from the Oracle Application Integration Architecture product. Integration users are used by the inbound Web services to log in and to create, update, or query records in the Siebel application. You must also set up integration user credentials in the Oracle Application Integration Architecture product that you are using.
This task is a step in Process of Integrating Order to Cash.
To set up an integration user
Navigate to the Administration - User screen, then the Employees view.
In the employees list, select the record for the employee who you want to set up as an integration user.
Select the check box in the Integration User Flag field for this employee.
Configuring Web Services for Order to Cash
The Process Integration Packs (PIPs) in the Oracle Application Integration Architecture product can use Web services. To configure a Web service, administrators change the URI address for its service ports. For descriptions of Web services used by order to cash, and information about Web services, see Siebel CRM Web Services Reference.
This task is a step in Process of Integrating Order to Cash.
Web Services Used by Order to Cash
This section lists Siebel Web Services that are available for customer management integration, which you can configure using the instructions in subsequent sections.
Integration uses the following inbound Siebel Web Services:
SWICustomerParty
Operation Name: SWICustomerPartyInsertOrUpdate
Request Schema: SWICustomerPartyInsertOrUpdate_Input
Response Schema: SWICustomerPartyInsertOrUpdate_Output
SWICustomerParty
SWICustomerPartyQueryByExample
Request Schema: SWICustomerPartyQueryByExample_Input
Response Schema: SWICustomerPartyQueryByExample_Output
SWICustomerParty
Operation Name: SWICustomerPartySynchronize
Request Schema: SWICustomerPartySynchronize_Input
Response Schema: SWICustomerPartySynchronize_Output
SWICustomerParty
Operation Name: SWIMergeServices
Request: SchemaSWIMergeServicesMerge_Input
Response Schema: SWIMergeServicesMerge_Output
The following events trigger Siebel Web Services:
Account Updated
The Siebel application calls the SyncCustomerSiebelEventAggregator service with an AccountUpdatedABM.
Contact Updated
The Siebel application calls the SyncCustomerSiebelEventAggregator service with a ContactUpdatedABM.
Address Updated
The Siebel application calls the SyncCustomerSiebelEventAggregator service with an AddressUpdatedABM.
Integration uses the following outbound Siebel Web Services:
CalculateShippingChargeSalesOrderSiebelReqABCSImpl
CheckATPSalesOrderSiebelReqABCSImpl
ConfiguratorUserLangSiebelAdapter
CreditCheckSalesOrderSiebelReqABCSImpl
FetchAccountSiebelReqABCSImpl
FetchContactSiebelReqABCSImpl
MatchAccountSiebelReqABCSImpl
MatchContactSiebelReqABCSImpl
PaymentAuthorizationSalesOrderSiebelReqABCSImpl
ProcessQuoteSiebelJMSProducer
ProcessSalesOrderSiebelJMSProducerV2
RequestProductStructureSiebelJMSProducer
SyncCustomerSiebelEventAggregator
ESB_ConfiguratorCopyConfigEbizAdapter_Service
Configuring Inbound Web Services
A call into the Siebel business application uses an inbound Web service. To configure the inbound Web services, complete the steps in the following procedure.
To configure the inbound Web services
Navigate to the Administration - Web Services screen, then the Inbound Web Services view.
Query for the Web service name in the Inbound Web Services list.
For the names of the inbound Web services, see the Web service summary in Siebel CRM Web Services Reference.
If the Web service is not active, then change the status from Inactive to Active, and click Clear Cache.
In the Service Ports list for the Web service, change the following text strings in the Address field to the appropriate data for your server:
<webserver>
<lang>
<UserName>
<Password>
Configuring Outbound Web Services
A call out of the Siebel business application uses an outbound Web service. To configure the outbound Web services, complete the steps in the following procedure.
To configure the outbound Web services
Navigate to the Administration - Web Services screen, then the Outbound Web Services view.
Query for the Web service name in the Outbound Web Services list.
For the names of the outbound Web services, see the Web service summary in Siebel CRM Web Services Reference.
In the Service Ports list for the Web service, change the web server name and port in the Address field to the appropriate data for your server.
Enabling Component Groups for Order to Cash
Administrators must verify that the component groups for order creation are enabled on the Siebel Server. When you enable component groups, all of the required components in those groups are started on the server for transaction logging. For information about enabling component groups, see Siebel System Administration Guide.
You must also turn asset-based ordering off for the components that you enable for order to cash or for distributed order orchestration.
This task is a step in Process of Integrating Order to Cash.
To enable component groups for order to cash
Navigate to Administration - Server Configuration screen, then Enterprises and Component Groups view.
Enable Component Groups for order to cash.
Query for each of the following Component Groups
. SIA
. Siebel CME [Alias- Communications]
. Siebel ISS [Alias- ISS]
. Workflow Management [Alias- Workflow]
. HTIM
. EAI
For each component group, if the value of Enable State is Disabled, then click Enable.
Click the Parameters view tab.
Query for the parameter Order Management - Enable Asset Based Ordering.
Set the Current Value to False and save by stepping off the record.
Disable asset-based ordering for these components.
Navigate to Administration - Server Configuration screen, then Servers view.
Query for Order Management - Enable Asset Based Ordering.
Set the value to false.
Synchronize the components:
Navigate to Administration - Server Configuration screen, then Enterprises, and Synchronize view.
Select all the records.
Click Synchronize.
Restart the server.
For more information about enabling components, see Siebel CTI Administration Guide
Configuring Workflow Policies for Order to Cash
After administrators enable the component groups for order creation, they must configure the workflow policies. When information about an account or contact changes in the Siebel application, workflow policies invoke workflows and call Web services to synchronize data with the third-party billing application.
Workflow policies are used to support the following functions in Order to Cash.
Account synchronization and update
Contact synchronization and update
Though these two functions are not supported in distributed order orchestration, these workflow policies can be useful to track the changes in Siebel accounts and contacts in AIA.
This task is a step in Process of Integrating Order to Cash.
To configure the workflow policies
Create a job to run the Generate Triggers component in the Workflow Management component group.
For more information, see the topic about running Generate Trigger in Siebel Business Process Framework: Workflow Guide.
Expose the Default Tasks parameter so that you can change this parameter value when you copy the Workflow Manager Agent component in the next step.
For more information, see Exposing the Default Tasks Parameter.
Create a copy of the Workflow Monitor Agent component.
For more information, see Copying the Workflow Monitor Agent Component.
Start the new Workflow Monitor Agent task for customer synchronization.
For more information, see the topic about using the Workflow Monitor Agent in Siebel Business Process Framework: Workflow Guide.
(Optional) Review the log files for the new Workflow Monitor Agent task.
For more information, see the topic about workflow policies and Siebel Server task trace files in Siebel Business Process Framework: Workflow Guide.
Exposing the Default Tasks Parameter
The Workflow Monitor Agent component in the Workflow Management component group contains the Default Tasks parameter, which is hidden from view by default. Administrators must reveal this parameter to advanced users so that these users can change its value in a copy of the Workflow Manager Agent component that they create.
To expose the Default Tasks Parameter
Navigate to the Administration - Server Configuration screen, then the Servers view.
Select the appropriate server in the Siebel Servers list.
Click the Components view tab, and select the Server Manager component in the Components list.
Page down, click the Parameters view tab, and select the Show Advanced Objects parameter in the Component Parameters list.
Change the Value field for this parameter to TRUE.
Log out of the application and then log in again so that the parameter setting takes effect.
Copying the Workflow Monitor Agent Component
For information about creating a copy of the Workflow Monitor Agent component, see the topic about using Workflow Monitor Agent in Siebel Business Process Framework: Workflow Guide.
\ses\siebsrvr\bin so that a new dictionary cache file is created when you restart.
The following table shows the values to enter for some fields for the copied component. To see this view, click the Component Definitions view in the Administration - Server Configuration screen, then the Enterprises view.
Table Field Values for Copied Workflow Monitor Agent Component
| Field | Value |
|---|---|
Component |
Workflow Monitor Agent SWI |
Alias |
WorkflowMonSWI |
Component Group |
Workflow Management |
The following table shows the values to enter for some parameters for the copied component in the Component Definitions view in the Administration - Server Configuration screen, then the Enterprises view. To see the advanced parameters, click Advanced in the Component Parameters list.
Table Parameter Values for Copied Workflow Monitor Agent Component
| Parameter | Type | Value |
|---|---|---|
Action interval |
Not applicable. |
5 |
Default Tasks |
Advanced |
1 |
Sleep Time |
Advanced |
15 |
Group Name |
Not applicable. |
SWI Customer Update Policy Grp |
Activating Workflows for Order to Cash
The administrator must activate the workflows used by order to cash.
This task is a step in Process of Integrating Order to Cash.
To activate workflows for order to cash
Revise and activate workflows.
Revise the following workflows, changing the Process Property UTCCanonical from its default value of Y to N:
CMU Credit Alert Status Sync
CMU SIA Submit Adjustment Request to External
SISOMBillingSubmitOrderWebService
SWI Account Update Workflow
SWI Billing Profile Update Workflow
SWI Contact Update Workflow
SWI Address Update Workflow
SWI Cancel Sales Order_O2C
SWI External Account Request Sync Process
SWI External Contact Request Sync Process
SWI Special Rating - Synchronize Process
SWIAdjustmentStatusUpdate
SWIOrderUpsert
SWIOrderUpsert_O2C
SWIOrderUpsertSubProcess
SWIQuoteUpsert
SWISendATPCheck
SWISendATPCheckLine
SWISendCalculateShippingCharge
SWISendCreditCheck
SWISendOrder
SWISendPaymentAuthorization
SWISendQuote
Publish and then activate these workflows.
Check the status of these workflows, and if it is In Progress, then make it complete by deploying the Workflow.
Activate the following workflows:
Submit Quote ASI
Submit Order ASI
SWI Initial Load Non CP Order Release
SWI External Product Sync Workflow
SWI Configurator Load
SWI Account Update Workflow
Oracle Verify Item (Quote)
Oracle Verify Item (Order)
Oracle Verify Header (Quote)
Oracle Verify Header (Order)
Oracle Verify Complex Product All (Quote)
Oracle Verify Complex Product All (Order)
Oracle Configurator Load
CZ Return
CZ PSP Interface
Account - New Order
SWIReviseOrderValidation
Setting Up Data Validation Rules for Order to Cash
Validation rules validate an order based on the rules configured in the Data Validation expression. By default, the data validation rules are set to False. When a workflow evaluates the data validation rules and finds a rule set to False, it continues to the next expression in turn. When it finds a rule set to True, it stops searching and no other rules are evaluated.
To place an order, all conditions must pass all the validation rules. If the order passes, then the order is submitted to the back office. If the order is evaluated as False, then the corresponding error message is shown.
If you are using order to cash functionality, then you can set up data validation rules to verify the quality and accuracy of your transactions, you can set up data validation.
This task is a step in Process of Integrating Order to Cash.
To set up data validation rules for order to cash
Navigate to the Administration - Data Validation screen, Rules Sets view.
In the relevant Expression field, modify the expression.Transferring the Shipping Method From Quote to Asset to Order
Integrating Distributed Order Orchestration
To set up an Oracle Application Integration Architecture integration between your Siebel business application and Oracle Distributed Order Orchestration, you perform the same tasks needed to integrate order to cash, except that you define different data validation rules.
Distributed order orchestration uses the same workflows and Web services as order to cash.
To integrate distributed order orchestration
Perform the tasks for integrating order to cash
For more information, see Process of Integrating Order to Cash.
Instead of setting the data validation rules in this process, set the data validation rules described in Setting Up Data Validation Rules for Distributed Order Orchestration.
Instead of setting up Siebel eBusiness Configurator, set up and use Siebel Configurator for DOO integration.
Setting Up Data Validation Rules for Distributed Order Orchestration
For information about why you must set up data validation rules, see Setting Up Data Validation Rules for Order to Cash.
To set up data validation rules for distributed order orchestration
Navigate to the Administration - Data Validation tab, then the Rules Sets view.
Create a new rule set based on the existing rule set named SWI Revise Order Validation.
In the Rule Sets list, select SWI Revise Order Validation.
From the menu, select Revise Rule Set.
A new copy of this rule set is created.
Click the name of the newly created rule set to display the list of rules in this rule set.
Modify the expression for two rules, as shown in the following table.
Rule Expression SWI Revise Order
(SystemPreference("Enable AIA OrderToCash")="FALSE") OR ((([Status] = LookupValue("FS_ORDER_STATUS","Booked"))) AND (([Status] <> LookupValue("FS_ORDER_STATUS","Shipped")) AND ([Status] <> LookupValue("FS_ORDER_STATUS","Closed"))))
SWI Revise Order Line
(SystemPreference("Enable AIA OrderToCash")="FALSE") OR((([Status] = LookupValue("FS_ORDER_STATUS","Booked")) OR ([Status] = LookupValue("FS_ORDER_STATUS","Picked")) OR ([Status] = LookupValue("FS_ORDER_STATUS","Cancelled")) OR ([Status] = LookupValue("FS_ORDER_STATUS","Pending")) OR ([Status] = LookupValue("FS_ORDER_STATUS","Shipped")) OR ([Status] = LookupValue("FS_ORDER_STATUS","Closed")) OR ([Status] = LookupValue("FS_ORDER_STATUS","Supply Eligible")) OR ([Status] = LookupValue("FS_ORDER_STATUS","Billed")) OR ([Status] = LookupValue("FS_ORDER_STATUS","Partially Shipped"))))
From the menu, select Activate Rule Set.
The status changes from In Process to Active.
Create a new rule set based on the existing rule set named O2C Cancel Order Validation.
In the Rule Sets list, select O2C Cancel Order Validation.
From the menu, select Revise Rule Set.
A new copy of this rule set is created.
Click the name of the newly created rule set to display the list of rules in this rule set.
Modify the expression for one rule, as shown in the following table.
Rule Expression PONR Not Reached
NOT(SystemPreference("Enable AIA OrderToCash")="TRUE" AND ([Status] = LookupValue ('FS_ORDER_STATUS', 'Shipped')) or ([Status] = LookupValue ('FS_ORDER_STATUS', 'Closed')) or ([Status] = LookupValue ('FS_ORDER_STATUS', 'Fulfilled')) or ([Status] = LookupValue ('FS_ORDER_STATUS', 'Supply Eligible')) or ([Status] = LookupValue ('FS_ORDER_STATUS', 'Billed')) or ([Status] = LookupValue ('FS_ORDER_STATUS', 'Partially Shipped')))
From the menu, select Activate Rule Set.
The status changes from In Process to Active.