Integrate Order Management with Source Systems

Set up your source system in Order Management so it can access reference data and master data that your source system uses.

Setting up the source system allows Order Management to identify where the sales order originates and helps to define the characteristics of the source system, such as whether its an order capture system or order fulfillment system, and whether the source system requires Order Management to do cross-referencing when a user creates a sales orders in Order Management. Order Management uses these details to establish cross-reference values for various entities.

If your deployment must integrate with a system that resides outside of Order Management, then you can register a connector that allows Order Management to communicate with it. You must create, deploy, and register the connector. This topic describes how to register the connector and connect Order Management to a source system, such as Oracle Configure, Price, and Quote Cloud. You add a connector that uses a web service that communicates order details with the source system.

Summary of the Set Up

1. Create a user credential key.

2. Set up the source system.

3. Administer the source system.

4. Add the connector.

5. Add roles and privileges.

6. Test your set up.

This topic uses example values. You might need different values, depending on your business requirements.

Create Credential Key

You must create a user credential key to integrate Order Management with the service.

The interface uses open access protocols, such as HTTP, so extra security setup is required. You must make sure the user credential is valid in the source system you're integrating, and in the security certificate so the integration can encrypt and decrypt messages. For details, see Securing SCM.

Create a user credential key.

1. Use Oracle Wallet Manager to add a user credential key to a credential map.

   You must use the administration privilege and administrator role.

2. In Oracle Wallet Manager, in the Select Map list, select oracle.wsm.security.

3. Enter the user credential key, user name, and password from the service that you're integrating with Order Management.

4. Make sure you have the privileges that you need to administer Order Management.

5. Go to the Setup and Maintenance work area, then go to the task.

   • Offering: Order Management

   • Functional Area: Orders

   • Task: Manage External Interface Web Service Details

6. On the Manage Connector Details page, click Actions > Add Row, then set the values that you set in steps 1 through 3.

Set Up the Source System

1. In the Setup and Maintenance work area, go to the task.

   • Offering: Order Management

   • Functional Area: Customers

   • Task: Manage Trading Community Source Systems

2. On the Manage Trading Community Source Systems page, click Actions > Create.

3. On the Create Source System page, set the values.

   Attribute	Description
   Code	Enter any text that Order Management can use as an abbreviation for the system. Order Management uses this code to identify this system throughout the user interface, such as in lists and logs. For example, assume you work for a company named Vision Corporation, and that your deployment must integrate with a legacy order capture system named Vision Capture. You can enter VCAP. The Manage Trading Community Source Systems page comes predefined to use Order Orchestration and Planning (OPS) to orchestrate and plan your sales order. If you use the Order Management work area to create sales orders, then you must not change this behavior, but you can use this page to add the source system you use to import a source order from a channel system.
   Name	Enter text that describes the source system, such as Vision Capture.
   Type	Select a value. Spoke. Identifies a spoke system, such as a legacy system. Purchased. Identifies a purchased system, such as data from a third party provider.
   Options	Specify the type of data that you will import. Enable for Items. Required. Import data for items. Enable for Trading Community Members. Required. Import data for the trading community. Establishes the Original System Unique Reference (OSR) for customer entities. Enable for Order Orchestration and Planning. Required. Import data for Order Orchestration. Enable for Assets. Optional. Import data for assets. For example, if you add a check mark to Enable for Trading Community Members, then you can select the source system as a data source on various pages in the Order Management work area and the Order Orchestration work area.

4. Click Save and Close > Done.

Administer the Source System

1. In the Setup and Maintenance work area, go to the task.

   • Offering: Order Management

   • Functional Area: Orders

   • Task: Manage Upstream and Fulfillment Source Systems

2. On the Manage Upstream and Fulfillment Source Systems page, click Actions > Create.

3. In the Create Source System dialog, set the values.

   Attribute	Description
   Code	Select the code that you created earlier, such as VCAP.
   Time Zone	Select the time zone where the server is located.
   Version	Select Other.
   Order Orchestration Type	Select a value. Fulfillment. Specify the source system as a fulfillment system where Order Management sends fulfillment requests and receives fulfillment replies. Order Capture. Specify the source system as an order capture system that sends source orders to Order Management. You typically use Order Capture with the import web service.
   Collections Allowed	Contains a check mark.
   Enable Data Cross-Reference	If the source system. Expects Order Management to do the cross-reference, then enable this option. Uses the same values that Oracle Applications use, and you already set up these values in Oracle Applications, then don't enable this option.

4. Click Save and Close > Done.

Add the Connector

1. In the Setup and Maintenance work area, go to the task.

   • Offering: Order Management

   • Functional Area: Orders

   • Task: Manage External Interface Web Service Details

2. On the Manage Connector Details page, click Actions > Add Row.

3. In the new row, set the values, then click Save and Close.

   Attribute	Description
   Target System	Select the code you created in the Create Source System dialog, such as VCAP.
   Connector Name	Enter text that describes the connector. For example, enter Connector_to_VCAP
   Connector URL	Enter the URL that locates the connector service that resides on the source system. In this example, enter the URL that locates the VCAP system.
   User Name and Password	Enter the values that the Status Update service requires. For example, the user that you specify must be a valid user, and this user must use the privileges that allow this user to run the Status Update service. Order Management uses the credentials you provide so it can communicate with the order capture system when it creates the order, and when it provides a status update.

4. Optional. Allow more than one source system instance to communicate with Order Management.

   • Use Trading Community Architecture to add a value to the Target System list.

   • Repeat step 3, except set Target System to the value that you added in Trading Community Architecture.

     For example, assume you work for a telecommunications company. You add one connection to a system named PER_ORA_BM_CPQ for personal phone lines, then add another connection to a system named BUS_ORA_BM_CPQ for business lines. CPQ is an acronym for Configure, Price and Quote. Order Management will deliver status notifications and billing notifications to any system that contains the string ORA_BM_CPQ.

     You can add a prefix, a suffix, a prefix and a suffix, or no prefix or suffix to the string. For example, you can use ABC_ORA_BM_CPQ_XYZ.

5. Verify that Order Management is connected to the source system, and that its communicating sales order data.

   • Use a page in the Order Management work area to verify that it updated the order status. For example, verify that it updated the status from Scheduled to Shipped.

   • Sign into your source system, then verify that it displays the updated status of the sales order that you examined in Order Management. For example, if Order Management updated the status from Scheduled to Shipped on the fulfillment line, then verify that your source system also displays Shipped.

   If Order Management can't connect to your source system, then it might display an error message that indicates it can't connect. For details, see Fix Connection Problems with Source Systems.

Connecting to Configure, Price, and Quote

If you connect to Configure, Price, and Quote, then do these steps.

• Set the Target System for the connector to ORA_BM_CPQ.

• Use the Manage Business Event Trigger Points page to enable the Fulfillment Line Status Update trigger point.

• Make sure the connector URL references the BM-CPQ status update service. If it doesn't reference this service, then the Business Events Message page will display an error. The URL is different for each BM-CPQ instance. For example, host:port//BM-CPQ-statusUpdateService, where you replace host:port with your sever address.

• The setup you make for Fulfillment Line Status Update and the corresponding set up in the Edit Status Rule Set area of the Manage Orchestration Process Definitions page doesn't affect how Order Management communicates status values.

• Order Management sends only the following status values. You can't modify this behavior.

  • Scheduled

  • Shipped

  • Awaiting Billing

  • Billed

  • Canceled

  • Closed

Add Roles and Privileges

The user who calls the web service must use an application role with web service privilege Manage Order Orchestration Decomposition Web Service (DOO_MANAGE_ORDER_ORCHESTRATION_DECOMPOSITION_WEB_SERVICE_PRIV).

This role and privilege makes sure each service and response request from a source system works correctly when the source system isn't part of Oracle Applications, or when receiving a request from a fulfillment task that isn't in Oracle Applications.

Add roles and privileges.

1. Sign into the security console.

2. Click Application Roles.

3. On the General tab, set the values, then save your changes.

   Attribute	Value
   Display Name	DOO Modified Role Service
   Role Name	DOOModifiedAppRole
   Role Category	SCM - Abstract Roles

   

4. Navigate to the Search Authorization Policies tab, then search for DOOCustomAppRole.

5. In the Functional Policies tab, click New.

   

6. In the Untitled tab, set the value, then save your changes.

   Attribute	Value
   Name	DOOCustomRolePolicy

   

7. In the Targets area, click Add Target.

8. In the Search Targets dialog, set values, then click Search.

   Attribute	Value
   Display Name Contains	Web service
   Name Starts With	DOO

   

9. Add the privileges you need for each of the web services that you must grant to the user.

   

10. Navigate to the DOOCustomRolePolicy page.

    

11. In the DOO Webservice Role area, click Add.

12. In the Add a User dialog, add a user, then click Map Users.

    

Test Your Set Up

Create a test user in your test environment to make sure your deployment can authenticate the message that Order Management sends.

1. Sign into the Administration Console of the Oracle WebLogic Server.

2. In the Administration Console, click Create Users.

3. In the Create a New User area, set the values, then click OK.

   Attribute	Value
   Name	The value you enter must match the name you used when you created the user credential key earlier in this topic.
   Description	User name and password to use when sending a message to the test client.
   Provider	DefaultAuthentication
   Password	The value you enter must match the name you used when you created the user credential key earlier in this topic.

4. Test the client in your source system to make sure it can send and receive messages to and from Order Management.