2 Setting Up Data for the Routing Engine Module
Purpose: Follow the steps below when completing data setup as part of Order Broker installation and configuration for use of the Routing Engine. You should log in to Order Broker as the default admin user to perform the following setup steps.
Other setup steps:
-
See Setting Up Data for the Supplier Direct Fulfillment Module for setup required for drop ship.
-
See Setting Up Data for the Store Connect Module for additional setup required for Store Connect.
Note:
All of the Routing Engine setup described in this help topic is also required to use Store Connect.
Allow list: The allow list is a list of URLs that are approved for communication. Oracle staff need to make sure that all URLs, such as logos and those used for integrations, are included on the allow list for Order Broker. See the description of the allow list in the glossary for more information.
“From” email addresses: Email addresses must be approved in order to be used as a return address on an email generated by Order Broker. Please change the default email addresses at the Event Logging screen and the Cust Service From Email Address specified at the Store Connect Preferences screen, and contact your Oracle Representative to have the new email addresses approved.
In this topic:
-
Create each additional system that will integrate through the Order Broker
-
Configure one or more systems for online product and inventory update
Set up Locations, Products, Inventory, and Related Information:
-
Load products, system products, product locations, and locations
-
Set up default carriers and, optionally, additional carriers
For more information: See the Glossary and the Order Broker Routing Engine Overview for background.
Step | Procedure |
---|---|
Basic Order Broker Setup | |
Define tenant data About tenant data: Use the Tenant screen to enter controlling information related to your instance of Order Broker. |
Certain options at this screen are available only to the admin user. |
Create the organization
that will include your systems About organizations: The organization is the second level in the Order Broker hierarchy, below the tenant. For example, all locate items searching and order creation takes place within the organization. |
|
Create a default system
for your organization About systems: Each system in Order Broker represents an application, such as Order Management System or Xstore, that shares inventory information via Order Broker and creates cross-channel. orders. About the default system: The default system is the application that is the system of record for product creation and naming. The first system you create for an organization is automatically flagged as the default. Note: The system flagged as the Vendor Default should not be the default system for the organization. |
Order Management System or CWDirect integration: The code for the Order Management System or CWDirect system must match the setting of the Order Broker System (K50) system control value. However, names for systems do not need to be the same as the Order Management System or CWDirect company descriptions. |
Assign the default
shipping system to the default user By assigning a default system, you indicate which system product codes to display and which organization to default on Order Broker screens. Note: You can create a user profile without assigning a default system only if you have not yet created any systems yet in Order Broker. |
Note: After completing this step, you can log out of Order Broker and log back in to have this system default at screens. |
Create each additional
system that will integrate through the Order Broker See Setting Up Data for the Supplier Direct Fulfillment Module for information on setting up the default vendor system, and see Setting Up Data for the Store Connect Module for information on setting up the default Store Connect system. |
Use the instructions above under Create a default system for your organization, except do not flag the additional systems as the Organization Default. |
Configure one or more
systems for online product and inventory update About online systems: An online system is one that provides Order Broker with inventory updates for specific products when Order Broker requires the information (for example, in order to respond to a locate items request). This update can take place through a web service request or an interface program. For more information: See Importing Items/Products, Inventory, Barcodes, Images, and Locations into the Database in the overview. |
|
Create location types About location types:Types must be 1 of 3 categories (store, vendor, or warehouse) and further identify a group of locations based on the system to which they belong, such as Order Management System warehouses and Xstore locations. At least one location type is required for you to set up locations. |
|
Specify event logging
settings About event logging:Oracle staff can specify whether to log different types of activity for Order Broker, and how much detail to include. |
Oracle staff use the Event Logging screen to set the level of logging for various activities and other Order Broker-wide settings.
“From” email addresses: Email addresses must be approved in order to be used as a return address on an email generated by Order Broker. Please change the default email addresses at the Event Logging screen and contact your Oracle Representative to have the new email addresses approved. |
Optionally, create additional user roles |
Use the Role Wizard to review the roles delivered with Order Broker and make sure to review the authority associated with these roles prior to assigning them to a user. |
Import users from IDCS or OCI IAM |
Use the Identity Cloud User Synchronization job to import users from IDCS or OCI IAM. If you do not use this job, users that exist in IDCS or OCI IAM are created automatically in Order Broker when they first log in. See the Identity Cloud User Synchronization for more information. |
Set up web service
authentication About web service authentication: By setting up and requiring user IDs and passwords for web services, you confirm that Order Broker authenticates the identity of the system submitting web service messages. Web service authentication is required. If Order Broker receives a web service request message without a valid web service user and password, the request is refused with an error: Inbound Message failed validation. Note: Each web service user must also be created in IDCS or OCI IAM to support authentication. |
Use the Web Service User screen to create web service users for authentication. See these screens for details. |
Set up schedules Note: Do not attempt to schedule jobs before creating systems. |
Use the Schedule Jobs screen to schedule daily cleanup, email generation, auto-cancel unclaimed pickup orders, and the sales order data extract. Then use the Reschedule All option at the View Active Schedules screen to enable all scheduled jobs and programs, including those configured at the Schedule Jobs screen and elsewhere. Note that the Reschedule All option does not restart jobs that are temporarily in Paused status (). Order Broker restarts these jobs automatically. |
Set up Locations, Products, Inventory, and Related Information | |
Create a location
for each warehouse or store location that will be included in inventory
inquiry requests or Routing Engine processing About locations: A location can represent a store, a warehouse, or a virtual location such as a web storefront. Each location is associated with an integrated system. Locations search for inventory in other locations, and can create or fulfill orders through the Routing Engine. |
Typically, you create locations through integrations with external systems. For example, locations might be created as part of the product import process; see Importing Locations through File Storage API. You can also create locations directly in Order Broker:
Setting up the sort order: The sort at the Preferences and Probability Location screens is in alphanumeric order within each organization. In other words, location types are listed alphanumerically by name within an organization, as are locations within a location type. Since the sort is alphanumeric, numeric codes are listed before alphabetical codes; for example, location 123 is listed before location ABC. |
Upload proximity data About proximity data: If you are not using the Oracle Maps Cloud Service, uploading proximity data enables you to search for merchandise or assign orders based on the approximate distance from a store, warehouse, or customer address. Note: This step is required only if you are using proximity locator searching and are not using the Oracle Maps Cloud Service. You can also perform this step at a later time. For more information: See Proximity Locator Searching. |
If you are using proximity locator searching to restrict locate items searches to the customer’s area and are not using the Oracle Maps Cloud Service, obtain the required .CSV file of postal code information and then use the Proximity Uploads screen to upload that information into the proximity location table:
|
Schedule product imports About product imports: The automated import process enables you to import and update product and inventory information from an integrated system. See Importing Items/Products, Inventory, Barcodes, Images, and Locations into the Database for a process overview. |
Select System > Schedule Jobs to advance to the Schedule Jobs screen, and complete the steps described under Product Import to set up, change, or review the import schedule for a system or run the import on demand. Note: Important: Oracle recommends that you schedule imports daily at a time when demands on the system are limited, and when it does not interfere with the database backup, and that you do not schedule more than one import at a time against the same database. |
Load products, system products, product locations, and locations |
Consult the integrating system’s documentation and complete the steps described under Scheduling the Product Import Job for systems that support the import process, including Order Management System. |
Create the default
unfulfillable location About the default unfulfillable location: The Routing Engine assigns an order to the default unfulfillable location when it cannot find a location to fulfill the order. You need to specify a default unfulfillable location at the Preferences screen. Note: This location needs to be associated with the organization’s default system. |
Typically, you create locations through integrations with external systems. For example, locations might be created as part of the product import process; see Importing Locations through File Storage API. You can also create locations directly in Order Broker:
|
Set up default carriers
and, optionally, additional carriers About carriers: A carrier is required on each order. At a minimum you need to set up a default carrier, specified at the Preferences screen. The default PICKUP carrier is created automatically when a SubmitOrder request is received. If the Submit Order message creating a delivery order:
|
The following steps are required if you want to override the default carrier created during the installation or upgrade process:
|
Set up preferences
for your organization About preferences: Use the Preferences screen to set rules governing locate item searching and order assignment. You can set preferences at the organization, location type, and location level. |
|
Note: Important: You need to set all Order Broker preferences at the organization level before integrating any external systems with Order Broker. See the description of the Preferences screen for complete information on setting preferences. |
|
Optionally, set up
preference overrides for individual originating system, order type,
and Express carrier combinations About preference overrides: Use the Order Broker Preference Overrides screen to override the Order Broker preference settings that control sorting results for locate items searches and order assignment. |
Advance to the Order Broker Preference Overrides screen, where you can set up overrides to the Order Broker sort criteria set at the Preferences screen. Example: You can have the Routing Engine rank locations for a pickup request based first on proximity, while it ranks locations for a delivery request based first on available quantity. |
Test locate items searching |
Test searching for products, either from an integrated system or using a standalone testing tool such as soapUI (www.soapUI.org). Confirm that the products returned and their sort order are what you expect. Note: If Order Broker is not returning any locations to locate items requests, confirm that you have completed the steps described under Set up default carriers and, optionally, additional carriers. |
Test order creation |
Test creating new orders, either sending them from an integrated system or using a standalone testing tool such as soapUI (www.soapUI.org). Confirm that the orders are created as you expect, and that updates are processed correctly across the integrated systems. |
Optionally, create fulfillment zones to control the locations eligible to fulfill delivery orders based on shipping address |
|
Additional Optional Setup | |
Create probability
rules About probability rules: You can use probability rules to control the information returned in merchandise search results or that the Routing Engine uses to determine where to assign orders; for example, you can apply rules to reduce the available quantity indicated for certain products, or to exclude certain product locations temporarily from search results. |
Optionally, use the Probability Rules screen to create rules that you can apply for locate items searches and order creation. See that screen for more information. |
Assign probability rules |
Optionally, use the Probability Location screen to assign probability rules to locations, location types, or the organization. |
Test probability logic |
Test locate items searching and creating new orders to confirm that the probability rules you have set up and assigned are producing the results you expect. |
Set fulfillment options
for systems About system fulfillment options:You can flag a system to require a status update from each assigned fulfilling location after it polls for new orders through the fulfillments request message. When you flag a system to require status updates, you also indicate the number of times that an order can be included in the fulfillments request until you include it in a notification email to your system administrator. |
Optionally, use the System screen to set the fulfillment options to indicate whether Order Broker requires a status update from the system for new orders. See Require Status Update for Assigned Orders? for a discussion. |
Specify reserved statuses for systems |
Optionally, use the System to specify order or order line statuses to subtract from the total available quantity for a product location, indicating that orders in these statuses are considered reserved. For more information: See Calculating the Available to Promise Quantity for an overview. |
Set up additional import and export options for systems |
Optionally, use the Schedule Jobs to set up: |
Enable auto-cancellation of unclaimed orders |
Optionally, use the Preferences screen to set up auto-cancellation of unclaimed pickup or ship-for-pickup orders:
|