System

Purpose: Use the System screen to:

         set a system as the default system for the organization

         indicate whether the system is an online system or offline system (Routing Engine only)

         specify the URL connection or interface program information to use obtain inventory information for an online system (Routing Engine only)

         specify whether the system requires status updates from assigned fulfilling locations (Routing Engine only)

         specify whether the Routing Engine should place a retail pickup or delivery order in another location within the system when the first selected location rejects the order (Routing Engine only)

         specify whether to create more than one retail pickup, delivery, or pickup order using the same order number and line number

         specify whether to subtract the quantities on orders in certain statuses in determining the available quantity for a product location (Routing Engine only)

         specify whether to calculate the probable available quantity after factoring in the reserved quantity and probability rules, and set up the schedule for the export (Routing Engine only)

         create a default vendor system so that you can create vendors to fulfill drop ship orders (Supplier Direct Fulfillment module only)

         create a default Store Connect system so that you can fulfill orders through the Store Connect module

         set up an fulfilled quantity export schedule for the system, or run the export on demand

         schedule or run incremental updates from the system

         schedule or run exports of updated product locations for one or more systems, including updating probable quantities

         set configuration options for integration with Oracle Retail Integration Cloud Service (RICS) for order communication with Oracle Retail Merchandising Foundation Cloud Service (RMFCS), as well as Oracle Retail Store Inventory Management (SIM)

         set configuration options for integration with Omnichannel Cloud Data Service (OCDS) to import locations, products, system products, and product locations

System relationships: See Organization, System, and Location for an overview of the data hierarchy in Order Broker, including products.

First system for an organization is flagged as the default: The Organization Default flag is selected when you create the first system for an organization, and the flag cannot be unselected at this time. To designate a different system as the default, you need to create another system and flag that system as the default; this unflags the first system.

How to display this screen:

         Create a new system at the Systems screen

Note:             If you click Cancel after advancing to the System screen, the system is not created.

         Click the edit icon (edit_icon.png) for an existing system code at the Systems screen

Note:             

         Only users with Systems authority can display this screen. See the Role Wizard for more information.

         If the System screen was already open in another tab when you clicked the edit icon, you advance to this screen with the previously-selected system displayed.

In this topic:

         Options at this screen

         Flag a system as the organization default

         Configure a system for a RESTful web service connection for interactive updates

         Configure a system to receive interactive updates from Oracle Retail Store Inventory Management (SIM)

         Configure a system to use an integration program for interactive inventory updates (for example, CWDirect)

         Configure a system to require a status update before flagging an order as Polled

         Configure a system to subtract the total reserved quantity when calculating the effective available quantity of an item in a location

         Prevent the Routing Engine from assigning retail pickup and delivery orders to another location in the originating system

         Configure a system for Order Broker to import incremental inventory updates for product locations

         Configure a system for Order Broker to calculate the probable available quantity for product locations and create an export file including the probable quantities

         Flag a system as the Store Connect default

         Schedule the Fulfilled Order Inventory Export

         Configure communication with Oracle Retail Integration Cloud Service (RICS) for order information

         Configure communication with Omnichannel Cloud Data Service for location, product, system product, and product location imports

         Configuring System Connections for Supported Integrations (Routing Engine)

         Order Management System or CWDirect System Setup for Polling

         Fields at this screen

         Inventory tab

         Orders tab

         Reservation tab

         Probable Qty Export tab

         Incremental Inv Import tab

         Fulfilled Inv Export tab

         RICS Integration tab

         OCDS Integration tab

         Updating and Exporting Probable Quantity

         Probable Quantity

         Evaluating Probable Quantity Rules

         Probable Quantity Export File Layout and Contents

         Incremental Inventory Import

         Sample Incremental Inventory Import File

         Incremental Inventory File Mapping

         Incremental Inventory Import Status Email

         Fulfilled Inventory Export

         Fulfilled Inventory Export File

Options at this screen

Option

Procedure

Flag a system as the organization default

Select the Organization Default flag and click Save. When you select this flag for a system, it clears the flag for the system that was previously the organization default. See the description of the Organization Default flag for background.

Note:  The system flagged as the Vendor Default should not be the default system for the organization.

Flag a system as the vendor default for the organization so that you can create vendors for the organization

(Supplier Direct Fulfillment module only)

Select the Vendor Default flag and click Save.

An organization can have only one vendor default system. Once you flag a system as the vendor default for an organization, you cannot change the vendor default assignment to a different system.

Note:  The system flagged as the Vendor Default should not be the default system for the organization.

It is not necessary to specify any additional information for the vendor default system besides the organization, name, and this flag.

Configure a system for a RESTful web service connection for interactive updates

(Routing Engine only)

1.      Select the Online flag.

2.      Select a Connection Type of URL to display the remaining Inventory Service fields in the Inventory tab.

3.      Enter the URL where Order Broker should post the RESTful request messages. Your entry should not end with /getAvailable, because Order Broker appends this string to the URL.

4.      Enter the Wait Time indicating the number of seconds to wait for a response to the RESTful service requests to a remote, online system for an interactive inventory availability update.

5.      Enter the User ID and Password to authenticate the inventory request to the system.

6.      Select the Use Proxy Server if the messages should be relayed through the proxy server specified at the Tenant - Admin screen.

7.      Click Save.

OMS integration: For integration with Oracle Retail Order Management System Cloud Service, you need to use the Work with Web Service Authentication (WWSA) menu option to set up a corresponding user ID and password for the CWServiceIn web service. The user ID you enter at the System screen must be in all capital letters. Also, the URL you enter is typically in the format of http://SERVER:1234/SerenadeSeam/sxrs/Inventory, where SERVER is the server name and 1234 is the port number. See Generic Web Services in the Order Management System online help for more information.

For more information: See Additional Types of Import Processes (Other than RMFCS File Upload and OCDS) in the overview for background, and see the RESTful Inventory Request and Response Messages chapter in the Order Broker Operations Guide for details and more setup requirements.

Configure a system to receive interactive updates from Oracle Retail Store Inventory Management (SIM)

1.      Select the Online flag.

1.      Select a Connection Type of SIM to display the remaining Inventory Service fields in the Inventory tab.

2.      Enter the URL where Order Broker should post the lookupAvailableInventoryAllStores messages to SIM.

3.      Enter the Wait Time indicating the number of seconds to wait for a response from SIM to the available inventory lookup request.

4.      Enter the User ID and Password to authenticate the inventory request to SIM.

5.      Select the Use Proxy Server if the messages should be relayed through the proxy server specified at the Tenant - Admin screen.

6.      Click Save.

Important:                               For inventory integration with SIM, the system code must be INV (all capital letters).

For more information: See Additional Types of Import Processes (Other than RMFCS File Upload and OCDS) for a discussion of interactive inventory updates from SIM.

Configure a system to use an integration program for interactive inventory updates (for example, CWDirect)

(Routing Engine only)

1.      Select the Online flag.

2.      Select a Connection Type of Interface Pgm to display the remaining Interface Pgm fields in the Inventory tab.

3.      Complete the additional Interface Pgm fields:

         Optionally, enter the number of seconds to wait for a database connection in the Wait Time field.

         Enter the Query Time Out indicating the number of seconds to wait before a database query against the system’s database, such as a full import process, times out.

         Enter the name of the database server in the Server field.

         Enter the name of the system’s database in the Database field.

         Enter valid login information in the User ID and Password fields.

         Complete the Class field. This field is typically set to com.mr.locate.integration.impl.OnlineBatchProductCWDirectImpl for integration with CWDirect.

4.      Click Save.

For more information: See Configuring System Connections for Supported Integrations (Routing Engine) for more background.

Configure a system to require a status update before flagging an order as Polled

(Routing Engine only)

1.      At the Orders tab, select the Require Status Update flag.

2.      Enter the number of Polling Retries indicating how many times to include an order in the fulfillment response message to a fulfilling location before it is included in a notification email to the system administrator. You can enter any number from 1 to 99.

3.      Optionally, enter one or more email addresses in the System Ops Email field to receive the Order Broker Polling Status Email. If you enter multiple email addresses, separate each with a semicolon (;). Order Broker verifies that the email addresses you enter are formatted correctly.

4.      Click Save.

For more information: See Require Status Update for Assigned Orders? for a discussion.

Note:             This setting does not apply to Store Connect locations, which do not use the fulfillment request and response message.

Configure a system to subtract the total reserved quantity when calculating the effective available quantity of an item in a location

(Routing Engine only)

You can configure a system so that, when Order Broker determines the current available quantity of an item in a location, it subtracts the total quantity currently reserved for orders from the reported available quantity in order to determine the effective available quantity. This calculation helps you prevent overcommitting the inventory for the location.

Example:                    The available quantity reported by a system for a product location is 37; however, the location is assigned to fulfill an order for 4 units, and the order is in new_order status, indicating that the location has not yet polled for new orders and been notified of this order assignment. As a result, the effective available quantity is actually 33 (37-4). You can configure the system to consider order lines in new_order status as reserved, and subtract the total quantity of order lines in this status from the reported available quantity to determine the effective available quantity for a fulfilling location.

To configure the system for reserved quantity calculation:

1.      At the Reservation tab, select the Include Reserved flag to make the Reserved Statuses flags available for selection.

2.      Select each status that should be considered reserved, indicating that order lines in this status should be subtracted from the available quantity to avoid overcommitting the inventory.

3.      Click Save. The screen displays a message indicating that it is updating the reserved quantities based on your selection. The number of product locations affected by the update determines how long this calculation takes to complete.

Note:             

         Processing the update does not affect any existing orders that are already assigned to a location for fulfillment. For example, an order is currently assigned to a location whose on-hand quantity of an item is 5. After processing the update, the on-hand quantity of the item is now -1. However, the order remains assigned to the location and is not automatically rejected.

         Ship-to-store orders: The fulfilling locations for ship-to-store orders are excluded from reserved quantity calculation, since they do not need to provide the inventory for ship-to-store orders; instead, the originating location transfers the inventory to the fulfilling location for pickup.

For more information: See Calculating the Available to Promise Quantity for an overview.

Prevent the Routing Engine from assigning retail pickup and delivery orders to another location in the originating system

(Routing Engine only)

You can configure a system so that, when a retail pickup or delivery order originates in a location within that system, the Routing Engine does not assign the order to another location that is also within the system.

Example:  System A includes locations DC1 and DC2, both distribution centers for the same enterprise sharing the same order database. When DC1 submits a delivery order, you do not want that order assigned to DC2.

Note:             This setting also prevents the locate items response from including locations within the system submitting the request.

To prevent order assignment to a location within the system:

1.      At the Orders tab, select the Disallow shopping within same system flag.

2.      Click Save.

For more information: See the Disallow shopping within same system flag.

Configure a system for Order Broker to import incremental inventory updates for product locations

(Routing Engine only)

Schedule the update program to process the import file: Use the Incremental Inv Import tab to specify the days of the week and times of day when the program should run the incremental import.

Optionally, you can also use the Incremental Inv Import tab to run the inventory update on demand.

Note:             

         The incremental inventory update is supported only if the Connection Type is set to None.

         Enter the times using the retailer’s time zone rather than your user’s time. See Time Zones for a discussion.

         See File Storage API for Imports and Exports for information on using a RESTful web service and database table, rather than secure FTP, for file imports and exports

For more information: See Incremental Inventory Import for a process overview, file layout and mapping, and information on the email generated if there is an error.

Configure a system for Order Broker to calculate the probable available quantity for product locations and create an export file including the probable quantities

(Routing Engine only)

Note:  This information is available for an external system, such as your ecommerce site.

         Optionally, use the Probable Quantity Rules screen to create probable quantity rules.

         Optionally, use the Probable Quantity Location screen to apply probable quantity rules to location types. (Note: Probable quantity rules applied to individual locations might not update the probable quantity.)

         Select the Probable Qty Export flag at the Inventory tab for each system that should have its updated product locations included in the probable quantity export file.

         Use the Probable Qty Export tab to schedule the probable quantity export, and optionally to flag the product locations for the system to configure the export. Enter the times using the retailer’s time zone rather than your user’s time. See Time Zones for a discussion.

         Specify the Export Files path specified in the Data Folder Settings section of the Tenant screen to indicate where the export file should be created.

Conflicting jobs? This job can run only if the following jobs are not already running:

         Incremental Inventory Import

         An import running through Schedule Imports

         Another instance of the Probable Quantity export

 

Note:  Select Reset if the job is currently in Running status but the job is not running correctly.

For more information: See Updating and Exporting Probable Quantity. Also, see File Storage API for Imports and Exports for information on using a RESTful web service and database table, rather than secure FTP, for file imports and exports.

Flag a system as the Store Connect default

(Store Connect module only)

         Select the Store Connect Default flag.

         Use the Reservation tab to specify the statuses to include in the reserved quantity for each Store Connect location. Typically, the reserved statuses are New Order, Accepted, Picked, and Polled.

         Click Save.

About the Store Connect system:

         Locations associated with the Store Connect system are eligible for assignment to store associates, who can log into the Store Connect module to work with orders assigned to these locations.

         Orders assigned to these locations are ordinarily updated by store associates working through the Store Connect screens rather than through XML messages.

         Store Connect locations do not poll for newly assigned orders; instead, a background job updates new orders to polled status, making the orders available for store associates to work with, based on your settings at the Store Connect Preferences screen.

         Order Broker generates email notifications to store locations associated with this system when new orders are ready for processing.

         You can import barcodes from RMFCS for this system. See Importing Product or Product Barcode Data from Merchandising Cloud Services Applications (RMFCS) through a MOMZIP File Upload for background.

For more information: See the Store Connect Overview for background.

Note:  Once you create any locations for the Store Connect system, you cannot change the setting of this flag for the Store Connect system or for any other systems in the organization.

Schedule the Fulfilled Order Inventory Export

         Select the Fulfilled Inv Export tab.

         Use this tab to specify the days and times when the Fulfilled Inventory Export should run.

         Click Save.

Note:  

         Typically, you would set the Track Fulfilled Quantity field to Reset During Inventory Export. See that field and the Fulfilled Inventory Export for more information.

         You can also run the export on demand by selecting the Run Now option.

         Enter the times using the retailer’s time zone rather than your user’s time. See Time Zones for a discussion.

For more information: See File Storage API for Imports and Exports for information on using a RESTful web service and database table, rather than secure FTP, for file imports and exports.

Configure communication with Oracle Retail Integration Cloud Service (RICS) for order information

         Select the RICS Integration tab.

         Use this tab to specify settings for communication with Oracle Retail Integration Cloud Service (RICS) to communicate order information between Order Broker and Oracle Retail Merchandising Foundation Cloud Service (RMFCS), as well as Oracle Retail Store Inventory Management (SIM).

For more information: See the RICS Integration tab.

Configure communication with Omnichannel Cloud Data Service for location, product, system product, and product location imports

         Select the OCDS Integration tab.

         Use this tab to specify settings for communication with Omnichannel Cloud Data Service (OCDS) to obtain location, product, system product, and product location information.

For more information: See the OCDS Integration tab.

 

Configuring System Connections for Supported Integrations (Routing Engine)

See Importing Items/Products, Inventory, Barcodes, and Locations into the Database for an overview, and see the System Import Schedule screen for additional required setup. The steps to complete this screen are listed under Options at this screen.

Also, see:

         Configure a system for a RESTful web service connection for interactive updates for information on how to integrate with Order Management System for interactive inventory updates.

         Configure a system to use an integration program for interactive inventory updates (for example, CWDirect) for information on how to integrate with CWDirect for interactive inventory updates.

         Configure a system to receive interactive updates from Oracle Retail Store Inventory Management (SIM) for information on how to integrate with SIM for interactive inventory updates.

         Configure communication with Oracle Retail Integration Cloud Service (RICS) for order information.

         Configure communication with Omnichannel Cloud Data Service for location, product, system product, and product location imports.

Order Management System or CWDirect System Setup for Polling

If the Routing Engine sends orders to Order Management System or CWDirect for fulfillment, your setup related to requiring status updates should be consistent at the System screen in Order Broker and for the related system control value in Order Management System or CWDirect:

Setup

Status Update Required

No Status Update Required

Require Status Update at the System screen in Order Broker:

selected; also, complete the Polling Retries and System Ops Email fields

unselected

Re-polling for Orders Brokered to OROMS or Re-polling for Orders Brokered to CWDirect system control value in Order Management System or CWDirect (labeled Re-polling at the Order Broker Values (K15) screen):

selected

unselected

For more information: See Require Status Update for Assigned Orders? for a discussion.

Fields at this screen

Update any of the fields described below and click Save, or click Cancel to return to the Systems screen without making any changes. See the Fields at this screen for more information.

Note:             If you are creating a new system, clicking Cancel prevents the creation.

Field

Description

Organization

See organization.

System

See system. The system code can be 1 to 10 positions in length, can include special characters, and must be unique in Order Broker. Required if you are creating a system; otherwise, display-only.

Order Management System or CWDirect integration: The code representing the Order Management System or CWDirect system must match the setting of the OROB 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.

System fields

Name

The Name of a system. System names can be 1 to 40 positions in length and can include special characters. Required.

Organization Default

Select this check box to flag the system as the default system for the organization. Products in Order Broker can have relationships with every integrated system, but they are defined by the default system. You should load the Order Broker database with the default system’s products first, and then create system products for each additional integrated system.

An organization can have only one default system.

First system created: The Organization Default flag is selected when you create the first system for an organization, and the flag cannot be unselected at this time. To designate a different system as the default, you need to create another system and flag that system as the default; this unflags the first system.

Note:  The system flagged as the Vendor Default should not be the default system for the organization.

Vendor Default

Select this checkbox to flag the system as the vendor default for the organization. A vendor default system is required before you can create any vendors for the organization.

An organization can have only one vendor default system. When you select this flag for a system, it clears the flag for the system that was previously the vendor default.

Note:  The system flagged as the Vendor Default should not be the default system for the organization.

The vendor system cannot originate sales orders or purchase orders.

It is not necessary to specify any additional information for the vendor default system besides the organization, name, and this flag.

Used for the Supplier Direct Fulfillment module only. Available if Use Vendor Portal is selected at the Tenant screen.

Store Connect Default

Select this checkbox to flag the system as the Store Connect system.

About the Store Connect system:

         Locations associated with the Store Connect system are eligible for assignment to store associates, who can log into the Store Connect module to work with orders assigned to these locations.

         Delivery, pickup, and ship to store orders assigned to these locations are ordinarily updated by store associates working through the Store Connect screens rather than through XML messages.

         You use the Store Connect Preferences screen to set up preferences related strictly to Store Connect, as opposed to the general Routing Engine preferences you set up at the Preferences screen.

         Store Connect locations do not poll for newly assigned delivery or pickup orders; instead, a background job updates new orders to polled status, making the orders available for store associates to work with. Your settings at the Store Connect Preferences screen control when the orders are updated to polled status.

         Order Broker generates an email notification to the store location when new delivery or pickup orders are polled.

         Optionally, Order Broker generates pickup-ready notification emails to customers for pickup and ship to store orders or shipment notification emails for shipped delivery orders.

         The Store Connect system cannot originate orders.

         You can import barcodes from RMFCS for this system. See Importing Product or Product Barcode Data from Merchandising Cloud Services Applications (RMFCS) through a MOMZIP File Upload for background.

For more information: See the Store Connect Overview for background.

Note:  Once you create any locations for the Store Connect system, you cannot change the setting of this flag for the Store Connect system or for any other systems in the organization.

Used for the Store Connect module only. Available if Use Store Connect is selected at the Tenant - Admin screen.

Inventory tab

Available only with the Routing Engine module.

Online

Select this check box to indicate that this is an online system, meaning that Order Broker requests interactive inventory updates when it receives a locate items request, product availability search request, or needs to select a fulfilling location for a delivery or retail pickup order, either as part of initial order creation or through the status update process

About online processing: If Order Broker is unable to retrieve an interactive update from the system, it uses the available quantity stored in the Order Broker database (offline inventory). This available quantity is updated either through a recent online inventory inquiry, or through the most recent inventory download from the system. Typically, inventory levels in the Order Broker database are updated daily, or whenever scheduled by your systems administrator. See Example: Searching for Items for more information.

Offline system: If the check box is not selected, this is on offline system, meaning that Order Broker does not request interactive inventory updates; instead, it relies on the available quantity stored in the Order Broker database (offline inventory). Typically, inventory levels in the Order Broker database are updated daily, or whenever scheduled by your system administrator.

Changing to offline: You can temporarily change a system from online to offline if you know that communication with the system will not be available and you would like to avoid unnecessary processing time for locate items requests.

When you clear the checkbox, the interface information or URL is retained so that you will not need to specify it again if the system goes back online.

Changing to online: When you change a system to online, you need to specify the Interface Information or URL, described below.

For more information: See Configure a system for a RESTful web service connection for interactive updates and Configure a system to use an integration program for interactive inventory updates (for example, CWDirect) for setup steps.

Probable Qty Export

Indicates whether to include updated product locations from this system in the pipe-delimited file generated when you run the probable quantity export for any system in the organization. See the Probable Qty Export tab for information on running the export.

Track Fulfilled Quantity

Indicates whether to track the fulfilled quantity for a product location when you ship a delivery order (status is fulfilled), transfer a retail pickup order (status is intransit), or when a pickup order is picked up (status is fulfilled):

         Do Not Track Fulfilled: Do not update a product location’s fulfilled quantity when a delivery or pickup order is fulfilled, or when a retail pickup order is intransit.

Used when? You might use this setting for a system that tracks its own inventory levels, tracks order fulfillments through status inquiry requests, and keeps Order Broker product locations in sync through interactive inventory updates.

Note: If you select this setting, then you cannot enter information or make selections at the Fulfilled Inv Export tab. Also, if you change to Do Not Track Fulfilled from another setting, the fulfilled quantities for product locations within the system are reset to 0.

         Reset During Inventory Export: Update a product location’s fulfilled quantity when a delivery or pickup order is fulfilled, or when a retail pickup order is intransit. When the Fulfilled Inventory Export runs, reset the product location’s fulfilled quantity to 0, and subtract the fulfilled quantity from the product location’s available quantity. These updates leave the product location’s available to promise quantity unchanged (available to promise = available quantity - reserved quantity + fulfilled quantity).

Used when? You might use this setting for a system such as Store Connect, that typically relies on Order Broker to manage order activity, and uses the fulfilled inventory export for updates on fulfilled orders. Tracking the fulfilled quantity enables you to avoid overstating the actual quantity available for orders.

Note: If you select this setting, you need to have at least one day selected for the fulfilled inventory export at the Fulfilled Inv Export tab, and the export runs automatically at the selected day(s) and time.

         Reset During Product Import: Update a product location’s fulfilled quantity when a delivery or pickup order is fulfilled, or when a retail pickup order is intransit. When the import process runs, reset the product location’s fulfilled quantity to 0. Do not subtract the fulfilled quantity from the available quantity; instead, update the product location’s inventory information with the current information received in the import, if any. If the product location is not included in the import, the fulfilled quantity is still reset to 0.

Note: The fulfilled quantity is not reset through the incremental import set up through the Incremental Inv Import tab, only through the import process.

Used when? You might use this setting for a system that periodically updates inventory levels based on activity outside of Order Broker and also receives information on fulfilled orders through status update requests, but uses the fulfilled quantity to calculate a more accurate available to promise quantity in the interval between product imports.

Note:  The above settings are available for selection regardless of whether the system is flagged as Online.

For more information: See below for examples of the calculations for each setting.

 

Examples of fulfilled quantity updates

 

Track Fulfilled Quantity set to Do Not Track Fulfilled: 

A product location has:

         Available: 10

         Reserved: 0

         Fulfilled: 0

         Available to Promise: 10

The location is assigned a new delivery order for a quantity of 2:

         Available: 10

         Reserved: 2

         Fulfilled: 0

         Available to Promise: 8

The order is fulfilled:

         Available: 10

         Reserved: 0

         Fulfilled: 0

         Available to Promise: 10

The next time the system updates the product location through a periodic product and inventory import or an interactive inventory update, it resets the available quantity to the current level.

 

Track Fulfilled Quantity set to Reset During Inventory Export:

A product location has:

         Available: 10

         Reserved: 0

         Fulfilled: 0

         Available to Promise: 10

The location is assigned a new delivery order for a quantity of 2:

         Available: 10

         Reserved: 2

         Fulfilled: 0

         Available to Promise: 8

The order is fulfilled:

         Available: 10

         Reserved: 0

         Fulfilled: 2

         Available to Promise: 8

The Fulfilled Inventory Export runs:

         Available: 8

         Reserved: 0

         Fulfilled: 0

         Available to Promise: 8

The next time the system updates the product location through a periodic product and inventory import, it resets the available quantity to the current level if it is different.

 

Track Fulfilled Quantity set to Reset During Product Import:

A product location has:

         Available: 10

         Reserved: 0

         Fulfilled: 0

         Available to Promise: 10

The location is assigned a new delivery order for a quantity of 2:

         Available: 10

         Reserved: 2

         Fulfilled: 0

         Available to Promise: 8

The order is fulfilled:

         Available: 10

         Reserved: 0

         Fulfilled: 2

         Available to Promise: 8

If the Fulfilled Inventory Export runs, there is no update.

The product and inventory import runs, passing an available quantity of 3 as a result of additional activity within the system:

         Available: 3

         Reserved: 0

         Fulfilled: 0

         Available to Promise: 3

The fulfilled quantity is not subtracted from the available quantity, since the product and.inventory import provides the most current inventory level based on all activity.

Connection Type

For an Online system, select:

         SIM to have Order Broker send a lookupAvailableInventoryAllStores request to Oracle Retail Store Inventory Management (SIM) for interactive inventory updates for requested items. To use the interactive inventory requests, you need to complete the Inventory Service fields (URL, Wait Time, User ID, and Password) and select the Online flag.

Note:             For integration with SIM, the system code must be INV (all capital letters).

         URL to have Order Broker send a RESTful service call to the remote system for interactive inventory updates for requested items. To use the interactive inventory requests, you need to complete the Inventory Service fields (URL, Wait Time, User ID, and Password) and select the Online flag.

         Interface Pgm to have Order Broker run an interface program, specified in the Class field, to retrieve inventory updates in real time for requested items. In this case, you need to complete the Interface Information fields (Wait Time, Query Time Out, Server, Database, User ID, Password, and Class) and select the Online flag.

Leave this field set to None for an offline system.

For more information: See Importing Items/Products, Inventory, Barcodes, and Locations into the Database in the overview.

Inventory Service

The remaining fields on the Inventory tab enable Order Broker to retrieve interactive product and inventory information when the Connection Type is set to SIM, URL, or Interface Pgm and the inventory hasn’t been updated in the time frame defined at the Preferences screen. The interactive inventory updates take place only if the Online flag is selected.

Displayed and required when? The Connection Type setting controls which fields are displayed and required.

Connection Type is URL or SIM: Use the following fields to configure the communication with the system:

         Required if a URL is specified, regardless of whether the Online flag is selected:

         Wait Time

         User ID

         Password

         Use Proxy Server

The Online flag must be selected in order for inventory updates to take place.

Connection Type is Interface Pgm: If the Online flag is selected, the following are displayed and required:

         Wait Time

         Query Time Out

         Server

         Database

         User ID

         Password

         Class

See below for details.

URL

The URL where Order Broker should send RESTful service requests to a remote, online system for real-time inventory updates for requested items, or the URL to use for integration with SIM.

This field is available only if the Connection Type is set to URL or SIM, and is required if the Online flag is selected.

If a URL is specified, then the Wait Time, User ID, and Password are also required.

Order Broker appends /getAvailable to the URL if the Connection Type is set to URL, so this string should not be included in the URL specified here.

Note:  The Inventory Request/Response setting at the Event Logging screen controls whether to log the inventory update request and response messages generated in the inventory.log file.

OMS integration: For integration with Oracle Retail Order Management System Cloud Service, you need to use the Work with Web Service Authentication (WWSA) menu option to set up a corresponding user ID and password for the CWServiceIn web service. The user ID you enter at the System screen must be in all capital letters. Also, the URL you enter is typically in the format of http://SERVER:1234/SerenadeSeam/sxrs/Inventory, where SERVER is the server name and 1234 is the port number. See Generic Web Services in the Order Management System online help for more information.

For more information: See the RESTful Inventory Request and Response Messages chapter in the Order Broker Operations Guide for details and more setup requirements.

Wait Time

Defines:

         Interface Pgm: The number of seconds to wait for connection to the online database before timing out and using offline inventory information from the Order Broker database. Defaults to 0 (do not time out).

         URL: The number of seconds to wait for a response to the RESTful service requests to a remote, online system for an interactive inventory update before timing out and using offline inventory information from the Order Broker database. Defaults to 30 seconds.

         SIM: The number of seconds to wait for a response to the lookupAvailableInventoryAllStores request to SIM before timing out and using offline information from the Order Broker database. Defaults to 30 seconds.

This field is required if a Connection Type of URL, SIM, or Interface Pgm is specified.

Query Time Out

The number of seconds to wait before a database query against the system’s database times out. If the Query Time Out is 0, a query never times out.

This field is available only if the Connection Type is Interface Pgm, and required if the Online flag is selected.

Server

The name of the server where the system’s database is located. In the case of a database on the iSeries, this is the name or IP address of the iSeries. Up to 51 positions.

This field is available only if the Connection Type is Interface Pgm, and required if the Online flag is selected.

Database

The name of the database. In the case of a CWDirect database, this is the CWDirect database library, as specified in the Data Base Library (A37) system control value. Up to 51 positions.

This field is available only if the Connection Type is Interface Pgm, and required if the Online flag is selected.

User ID

If the Connection Type is Interface Pgm: A valid user ID with access to the database server or iSeries. Your entry is masked on the screen and encrypted in the database.

If the Connection Type is URL: A valid user ID required to authenticate the inventory update request message to the system.

For integration with Oracle Retail Order Management System Cloud Service (URL), you need to use the Work with Web Service Authentication (WWSA) menu option to set up a corresponding user ID and password for the CWServiceIn web service. The user ID you enter at the System screen must be in all capital letters.

If the Connection Type is SIM: A valid user ID required to authenticate the lookupAvailableInventoryAllStores request message to SIM.

This field is available only if the Connection Type is set to URL, SIM, or Interface Pgm. Required if the Online flag is selected, or if a URL is specified.

Password

The valid password for the user ID. Your entry is masked on the screen and encrypted in the database.

This field is available only if the Connection Type is set to URL, SIM, or Interface Pgm. Required if the Online flag is selected, or if a URL is specified.

Class

The interface program that retrieves inventory updates from the system’s database. Typically set to com.mr.locate.integration.impl.OnlineBatchProductCWDirectImpl for integration with CWDirect.

This field is available only if the Connection Type is set to Interface Pgm, and required if the Online flag is selected.

Use Proxy Server

Indicates whether to use the proxy server specified at the Tenant - Admin screen to relay interactive inventory requests to the system.

This field is available only when the Connection Type is set to URL or SIM.

Orders tab

Use these fields to control:

         Whether the Routing Engine can assign an order to another location within the system

         Whether to create a new pickup, delivery, or retail pickup order using the same order number and line number as an existing order, or reject it as a duplicate

         Whether the Routing Engine continues to include a new order in the fulfillments response to the assigned fulfilling location until the location sends a status update. See Require Status Update for Assigned Orders? for a discussion.

Available only with the Routing Engine module.

Order Broker Shopping

Disallow shopping within same system

Indicates whether the Routing Engine should assign a retail pickup or delivery order to another location in the same system.

If the Disallow shopping within same system flag is:

         Selected: The Routing Engine does not assign an order to another location within the same system that submitted the order. The order can be assigned to a location in a different system, based on the rules set up at the Preferences screen; otherwise, it is unfulfillable. Also, the locate items response does not include any locations within the system submitting the request, unless the requested location is within the same system.

Note:  If the submit order message specifies a location within the same system, the order is created in the specified location regardless of the setting of this flag.

         Unselected (default): The Routing Engine can assign the order to another location within the system, based on the rules set up at the Preferences screen. Also, the locate items response can include locations within the system submitting the request.

When to disallow shopping? You might use this field to disallow shopping if your OMS system, such as Order Management System, supports multiple warehouses and each warehouse is represented as a separate location in Order Broker.

Use Duplicate Order Checking

Select this flag to have the Routing Engine return an error when it receives a SubmitOrder message from the system for a retail pickup, delivery, or pickup order that has the same order_id and line number (from the line_item_no attribute for the transaction_detail) as an existing retail pickup, delivery, or pickup order from the system.

This setting does not apply to ship-to-store orders.

Examples:

         Duplicate order, multiple duplicate lines: The system submits a retail pickup order with order number 12345 and lines 1 and 2. The system then submits another retail pickup order 12345 with lines 1 and 2. Result: The Routing Engine returns an error indicating that line 1 is a duplicate. Line 2 is not mentioned in the error, because the Routing Engine stops evaluating once it finds the first duplicate line.

         Same order number, different line numbers: The system submits a delivery order with order number 23456 and lines 1 and 2. The system then submits a delivery order 23456 with line 3. Result: The Routing Engine creates the order without error, since there are no duplicate lines for the order number.

         Ship-to-store order: The system submits a ship-to-store order with order number 34567 and lines 1 and 2. The system then submits an order (of any type) with the same order number and line numbers. Result: The Routing Engine creates the order without error, since ship-to-store orders are not included in duplicate order checking.

         Same order number, different system: The system submits a pickup order with order number 45678 and line 1. An order number 45678 also exists for another system. Result: The Routing Engine creates the order without error, since duplicate order checking applies only within the system.

         Duplicate system product code, no duplicate line number: The system submits a delivery order with order number 56789 with system product AB123 on line 1. The system then submits a delivery order with order number 56789 with system product AB123 on line 2. Result: The Routing Engine creates the order without error, since it does not check the system product code for duplicates.

         Same order and line number, different order type: The system submits a delivery order with an order number 67890 and line 1. The system then submits a retail pickup order with an order number 67890 and line 1. Result: The Routing Engine returns an error indicating that line 1 is a duplicate, regardless of the fact that the order types are different.

Note:  The Routing Engine does not evaluate any other information on the order, such as product code, quantity, or customer name and address, when checking for duplicates. The check takes place only during the SubmitOrder process, and only for the system originating the order. The duplicate order check applies regardless of the version specified in the SubmitOrder message.

Leave this flag unselected to have the Routing Engine create orders without error, even if the order and line number(s) are the same as existing orders for the originating system.

Order Fulfillment

Order Management System setup: If you send orders to Order Management System warehouses for fulfillment, check Order Management System or CWDirect System Setup for Polling for more information.

Require Status Update

Fulfillment response message: Indicates whether to automatically flag an order or line as Polled when it is included in the fulfillment response message, or to continue including it in the fulfillments response message until the assigned location sends a status update message accepting the order:

         Selected = Order Broker continues to send an order or line in the fulfillments response message when the assigned fulfilling location polls for new orders until the order is flagged as polled:

         The order is flagged as polled when the location sends a status update message to with a status of polled (any order type) or accepted (any order type except ship-to-store orders).

         Order Broker uses the order’s or line’s Poll Count field to track the number of times it has been included in the fulfillments response message.

         When the order’s or line’s Poll Count exceeds the Polling Retries specified for the system, Order Broker includes the order in the Order Broker Polling Status Email sent to the System Ops Email specified for the system. Each item’s current Poll Count is indicated on the Order screen.

         Unselected (default) = Flag the order or line as Polled when it is included in a fulfillment response message to the location; do not include the order or line more than once.

Note:  This setting does not apply to Store Connect locations, which do not use the fulfillment request and response message. Also, it does not apply to orders fulfilled through Order Fulfillment through RICS Integration.

Intransit response message: If the Require Status Update flag is:

         Selected = the Routing Engine continues to include a ship-for-pickup order in the intransit response message to a pickup location or system, until the location or system sends a status update indicating that the order or order line is intransit polled.

         Unselected = the Routing Engine includes each ship-for-pickup order or line just once in the intransit response message to a pickup location, and then changes the status to intransit polled.

Polling count: The polling count for the order line is initially set to 0 when it is in transit. Each time the Routing Engine includes an order or line in the intransit response message, it increases the order line’s Poll Count.

Unlike the rules for the fulfillment response, the rules for the intransit response do not include generating the Order Broker Polling Status Email when an in transit order exceeds the Polling Retries specified for the system.

Note:  The setting of this flag does not affect Order Fulfillment through RICS Integration.

Use Requesting System Line Number in Status Update

Controls how the line_no in the status update request identifies the order line to update when the Allow Split Line preference is selected but the Allow Partial Updates preference is not.

Applies to specific configuration only: The line_no is interpreted as the originating system's line number ONLY if:

         the Allow Split Order and Allow Split Line preferences are selected, AND

         the Allow Partial Updates preference is unselected, AND

         the request message is from the originating location for the order, AND

         this flag is selected

Otherwise, the line_no identifies the current line number in Order Broker.

Example:  The configuration described above is in place. The originating location submits a status update request to cancel line 1, referencing its own line number rather than the Order Broker line number. Line 1 originated with 4 units, but has since split across 2 locations, resulting in lines 1 and 2 in Order Broker for 2 units each, with an originating line number of 1. The result is that the update request cancels both order lines. Otherwise, if the configuration described above is not in place, or if the originating location did not submit the status request, only the first of the two lines is canceled.

When the organization has Allow Split Line selected and Allow Partial Updates unselected, this flag should be:

         selected for a system such as Oracle Retail Order Management System Cloud Service, which includes its line number in the status update request

         unselected (default) for a system such as Xstore, which includes the Order Broker line number in the status update request

Note:  When the Allow Partial Updates preference is selected, the requesting system needs to first obtain the current line numbers in Order Broker before submitting a status update.

Polling Retries

The number of times to include the order or line in a fulfillment response message before including the order in the Order Broker Polling Status Email.

If the Require Status Update flag is:

         Selected: You can enter any number from 1 to 99

         Unselected: Enter 0

Required.

Order Broker tracks the number of retries in the Poll Count field at the Order screen.

Note:  This setting does not apply to Store Connect locations, which do not use the fulfillment request and response message.

System Ops Email

The email address where Order Broker should send the notification email listing orders that have not been acknowledged after the number of Polling Retries has been reached.

This email address also receives a notification if a job is rejected because of conflict with another running job, including:

         Incremental Inventory Import

         An import running through Schedule Imports

         The Probable Quantity export; see Updating and Exporting Probable Quantity

If you enter multiple email addresses, separate each with a semicolon (;). Order Broker verifies that the email address you enter are formatted correctly.

Optional, even if the Require Status Update flag is selected.

Reservation tab

Use this tab to indicate the order or order line statuses to subtract from a location’s available quantity in order to determine the quantity that is actually available to fulfill new orders.

Typically, the reserved statuses for a Store Connect system are New Order, Accepted, Picked, and Polled.

Available only with the Routing Engine module.

Include Reserved

Select this check box to have Order Broker subtract reserved order lines from the reported available quantity for a product location. This calculation helps you prevent overcommitting inventory when assigning orders, responding to locate items requests, or evaluating selected fulfilling locations.

If this check box is selected, the Reserved Statuses listed below are available for selection. Once you select any statuses and click update, Order Broker calculates the total reserved quantity for each product location in the system currently assigned to any selected status.

For more information: See Calculating the Available to Promise Quantity for an overview.

Reserved Statuses

These statuses are available for selection if you select the Include Reserved checkbox. Select each status that indicates that inventory is reserved for an open order line and should not be assigned to new orders or listed in the LocateItems response message.

For more information: See Calculating the Available to Promise Quantity for an overview.

Possible statuses are:

         New Order

         Accepted

         Canceled

         Picked

         Fulfilled

         Unfulfillable

         Polled

         Posted

         Processed

         Verified

         Intransit

         Received

         Partially Fulfilled

Typically, reserved statuses for your Store Connect system are New_Order, Accepted, Polled, and Picked.

Note:  The fulfilling locations for ship-to-store orders are excluded from reserved quantity calculation, since they do not need to provide the inventory for ship-to-store orders; instead, the originating location transfers the inventory to the fulfilling location for pickup.

Probable Qty Export tab

Use this tab to configure a system for probable quantity export. See Updating and Exporting Probable Quantity for a process overview, background, and details.

Available only with the Routing Engine module.

Enabled

Select this option to enable the probable quantity export program to run on schedule. Order Broker runs the program on the selected day(s) of the week at the specified time(s).

Apply Probable Qty Rule

Select this flag to apply probable quantity rules to product locations included in the probable quantity export file.

If this flag is unselected, the probable quantity indicated in the export is the available to promise quantity.

Aggregate by Product

Controls whether the probable quantity export includes all quantities for all products at the product level, or changed quantities at the product location level.

         Select this flag to have the probable quantity export include current total quantities of all products across all product locations;

         Leave this flag unselected to have the probable quantity export include quantities broken out by product location, and include product locations only if they have had updates since the most recent probable location export.

Run Now

Select this option to run the probable quantity export program immediately, provided you have completed the requirements described under Configure a system for Order Broker to calculate the probable available quantity for product locations and create an export file including the probable quantities.

Schedule Interval

Resolving a scheduling issue: If the export does not run as scheduled, you can use the Reschedule All option at the View Active Schedules screen to stop and restart the schedules for all jobs and periodic programs. For example, you might need to use this option after a server shuts down unexpectedly, or after applying an upgrade.

Conflicting jobs? This job can run only if the following jobs are not already running:

         Incremental Inventory Import

         An import running through Schedule Imports

         Another instance of the Probable Quantity export

Day of Week

The day(s) of the week when Order Broker should run the probable quantity export program.

When you first advance to this tab, each day of the week is selected. Select or unselect days to control when the program runs. At least one day is required if the Enabled option is selected.

The program can run only if you have completed the requirements described under Configure a system for Order Broker to calculate the probable available quantity for product locations and create an export file including the probable quantities.

Time

The time, in 24-hour HH:MM format, when the program should run on each selected day of the week. At least one time is required if the Enabled option is selected. Separate multiple times with commas.

Note:  Enter the times using the retailer’s time zone rather than your user’s time. See Time Zones for a discussion.

Next Run

The next date and time when the program is scheduled to run. This information is updated only if the Enabled option is selected. Format is based on the settings at the User Profile Configuration screen.

Last Run

The most recent date and time when the program ran. The user ID indicated is always Admin, even if a user ran the process on demand from this screen. Format is based on the settings at the User Profile Configuration screen.

Last Updated

The most recent date and time when the schedule for the program was updated, and the user ID of the person who performed the update.

Last Status

The most recent status of the export job. Possible statuses are:

         Running

         Success

         Rejected, if there was a conflict with another running job

         Error

If the current status is Running but the job is not actually active, you can select Reset to end the job.

Reset

Select this option if the job is currently in Running status but the job is not running correctly.

After you confirm this option and Save, the job status changes to Error and the job is ended.

This option is available only when the job is in Running status.

Incremental Inv Import tab

Import incremental inventory updates: The incremental inventory update uses the contents of a pipe-delimited import file to update product location records for the system. See Incremental Inventory Import for a process overview, file layout and mapping, and information on the email generated if there is an error.

Enabled

Indicates whether the schedule to import incremental inventory updates is enabled.

Run Now

Select this flag and click Save to run the incremental inventory import on demand.

Schedule Interval

Resolving a scheduling issue: If the import does not run as scheduled, you can use the Reschedule All option at the View Active Schedules screen to stop and restart the schedules for all jobs and periodic programs. For example, you might need to use this option after a server shuts down unexpectedly or after applying an upgrade.

Day of Week

The day(s) of the week when Order Broker should run the incremental inventory import program.

When you first advance to this tab, each day of the week is selected. Select or unselect days to control when the program runs. At least one day is required if the Enabled option is selected.

The program can run only if you have completed the requirements described under Configure a system for Order Broker to import incremental inventory updates for product locations.

Time

The time, in 24-hour HH:MM format, when the program should run on each selected day of the week. At least one time is required if the Enabled option is selected. Separate multiple times with commas.

Note:  Enter the times using the retailer’s time zone rather than your user’s time. See Time Zones for a discussion.

Last Run

The most recent date and time when the program ran. Product locations that have been updated since this date and time are legible to be included in the next generated export file. The user ID indicated is always Admin, even if a user ran the process on demand from this screen. Format is based on the settings at the User Profile Configuration screen.

Last Updated

The most recent date and time when the schedule was updated, and the user ID of the person who performed the update. Format is based on the settings at the User Profile Configuration screen.

Fulfilled Inv Export tab

Use this tab to set up an export of fulfilled orders for a system, such as the Store Connect Default system, or to run the export on demand.

Note:  

         You can work with this tab to run the export only if the Track Fulfilled Quantity field is not set to Do Not Track Fulfilled.

         The export runs automatically based on the schedule interval set up at this tab if the Track Fulfilled Quantity field is set to Reset During Inventory Export.

For more information: See Fulfilled Inventory Export for details.

Run Now

Select this flag to run the export process on demand. The process runs after you click Save, and then click OK at the confirmation window.

Schedule Interval

This information is stored in the system_export table. This information is required if the Track Fulfilled Quantity field is set to Reset During Inventory Export.

The export runs automatically if a schedule is defined.

Resolving a scheduling issue: If the export does not run as scheduled, you can use the Reschedule All option at the View Active Schedules screen to stop and restart the schedules for all jobs and periodic programs. For example, you might need to use this option after a server shuts down unexpectedly or after applying an upgrade.

Day of Week

Use these fields to select the day(s) of the week and the time of day to have Order Broker run the Fulfilled Inventory Export process:

         Day: Select one or more days of the week (Sunday through Saturday).

         Time: Enter the time to begin the export process for all selected days.

Last Run

Includes:

         The last date and time when the export process ran, either because it was scheduled or because you ran it on demand.

         The user ID of the person who last run the export. Set to SYSTEM if the export ran when scheduled.

Last Updated

Includes:

         The last date and time when you updated the information at this screen.

         The user ID of the person who last updated the information at this screen.

RICS Integration tab

Use this tab to set up integration with the Oracle Retail Integration Cloud Service (RICS) to communicate order information between Order Broker and: Oracle Retail Merchandising Foundation Cloud Service (RMFCS), as well as Oracle Retail Store Inventory Management (SIM).

For more information: See Order Fulfillment through RICS Integration for background.

Online

Select this check box to indicate that this is a system is:

         Oracle Retail Merchandising Foundation Cloud Service (RMFCS), or

         Oracle Retail Store Inventory Management (SIM)

Order Broker integrates with these systems through the Oracle Retail Integration Cloud Service (RICS).

When you select this check box, you need to specify the Outbound Orders Service information, described below.

For more information: See Order Fulfillment through RICS Integration for background.

Send Release Reservation Inventory Message

Select this check box to send an order cancellation message through RICS when an order is rejected or canceled.

Hold Under Review Orders

Select this check box to post an order through RICS to RMFCS or SIM only when the order is not currently held for review, based on its Under Review flag. When you clear the Under Review flag for the order, it is then posted automatically. See Order Fulfillment through RICS Integration for background.

Note:  This flag should be selected.

Outbound Order Service

Use these fields to define how to integrate with Oracle Retail Integration Cloud Service (RICS) in order to communicate order information with Oracle Retail Merchandising Foundation Cloud Service (RMFCS), as well as Oracle Retail Store Inventory Management (SIM).

These fields are required if the Online flag is selected at the RICS Integration tab.

URL

The URL for RICS. This is the URL where Order Broker should send order-related messages for communication with RMFCS or SIM.

This field is required if the Online flag is selected.

Also, if the Online flag is selected, then the Wait Time, User ID, and Password are also required.

Example:  The URL might be similar to https://SERVERNAME:47220/rib-oms-services-web/resources/publisher.

Wait Time

Defines the number of seconds to wait for a response from RICS before timing out. Defaults to 30 seconds. Numeric, 9 positions.

User ID

A valid user ID required to authenticate messages to RICS. Alphanumeric, 50 positions.

Password

The valid password for the user ID. Your entry is masked on the screen and encrypted in the database. Alphanumeric, 50 positions.

OCDS Integration tab

Use this tab to set up integration with the Omnichannel Cloud Data Service (OCDS) to import warehouse or store location, product, and product location information from Oracle Retail Merchandising Foundation Cloud Service (RMFCS). When you use ODCS for these imports, Order Broker generates web service requests for this information rather than processing an upload file.

Note:  If any of the URLs on this tab are flagged as active, the OCDS import process is run rather than any other type of product or location import when you submit an import through the System Import Schedule screen.

On this tab:

         OCDS Store location import fields

         OCDS Warehouse location import fields

         OCDS Product fields

         OCDS Store inventory import fields

         OCDS Warehouse inventory import fields

For more information: See:

         OCDS Imports and Importing Data from Merchandising Cloud Services (RMFCS) through the Omnichannel Cloud Data Service (OCDS) for an overview and mapping details.

         System Import Schedule screen for information on scheduling the imports or running them on demand.

OCDS Store location import fields

The first line on this tab includes the following three fields, which are related to the import of store location information.

Store Location URL

The endpoint to use when requesting store location information from OCDS, for example, https://SERVER/ords/ocdspdb/omnichannel/v1/location/retailstore, where SERVER is the name of the server.

Alphanumeric, 255 positions. Required if the Active flag is selected for store locations.

Active

(store location)

Select this flag to enable importing store locations through OCDS.

If this flag is selected, the Store Location URL and Default Location Type for stores are also required.

Default Location Type (store)

Select the code for a store location type to associate with the store locations imported through the Store Location URL. All location types in your organization with a Category of Store are available for selection. Required if the Active flag is selected for store locations.

Note:  If you change this setting after initially importing store locations, existing store location records are not updated.

OCDS Warehouse location import fields

The second line on this tab includes the following three fields, which are related to the import of virtual warehouse location information.

Note:  The import does not include information on physical warehouses.

Warehouse Location URL

The endpoint to use when requesting virtual warehouse location information from OCDS, for example, https://SERVER/ords/ocdspdb/omnichannel/v1/location/warehouse, where SERVER is the name of the server.

Alphanumeric, 255 positions. Required if the Active flag is selected for warehouse locations.

Active (warehouse location)

Select this flag to enable importing virtual warehouse locations through OCDS.

If this flag is selected, the Warehouse Location URL and Default Location Type for warehouses are also required.

Default Location Type (warehouse, unlabeled)

Select the code for a warehouse location type to associate with the virtual warehouse locations imported through the Warehouse Location URL. All location types in your organization with a Category of Warehouse are available for selection. Required if the Active flag is selected for warehouse locations.

Note:  If you change this setting after initially importing warehouse locations, existing warehouse location records are not updated.

OCDS Product fields

The third line on this tab includes the following two fields, which are related to the import of product information.

Products URL

The endpoint to use when requesting product information from OCDS, for example, https://SERVER/ords/ocdspdb/omnichannel/v1/item, where SERVER is the name of the server.

Alphanumeric, 255 positions. Required if the Active flag is selected for products.

Active

(products)

Select this flag to enable importing products and system products through OCDS.

If this flag is selected, the Products URL is also required.

OCDS Store inventory import fields

The fourth line on this tab includes the following two fields, which are related to the import of product location information from store locations.

Store Inventory URL

The endpoint to use when requesting product location information for store locations from OCDS, for example, https://SERVER/ords/ocdspdb/omnichannel/v1/inventory/Store, where SERVER is the name of the server.

Alphanumeric, 255 positions. Required if the Active flag is selected for store inventory.

Active

(store inventory)

Select this flag to enable importing products and system products in store locations through OCDS.

If this flag is selected, the Store Inventory URL is also required.

OCDS Warehouse inventory import fields

The fifth line on this tab includes the following two fields, which are related to the import of product location information from virtual warehouse locations.

Warehouse Inventory URL

The endpoint to use when requesting product location information for virtual warehouse locations from OCDS, for example, https://SERVER/ords/ocdspdb/omnichannel/v1/inventory/warehouse, where SERVER is the name of the server.

Alphanumeric, 255 positions. Required if the Active flag is selected for warehouse inventory.

Active

(warehouse inventory

Select this flag to enable importing products and system products in warehouse locations through OCDS.

If this flag is selected, the Warehouse Inventory URL is also required.

OCDS Web service configuration fields

The final three fields on this tab control web service authentication and timeout for OCDS.

Wait Time

The number of seconds to wait for a response before timing out. A non-negative number is required if the Active flag is selected for any of the import types. Can be up to 9 positions. Defaults to 30 seconds.

User ID

The user ID to use for authenticating the web service requests. Required if the Active flag is selected for any of the import types. Up to 50 positions.

Note:  The user ID and password must be valid for authentication of the web service requests to OCDS; however, no validation takes place at this screen.

Password

The password to use for authenticating the web service requests. Required if the Active flag is selected for any of the import types. Up to 50 positions.

Updating and Exporting Probable Quantity

Probable quantity update and export: If the Aggregate by Product flag is unselected, the probable quantity update and export:

         subtracts the current reserved quantity for updated product locations.

         subtracts the fulfilled quantity for product locations, populated if it has not been cleared by the Fulfilled Inventory Export.

         updates the probable quantity field, if necessary, in the product location table in Order Broker, as well as the probable updated date. See Probable Quantity, below, for a discussion.

         creates a pipe-delimited export file for all product locations in the organization whose probable quantities were updated since the last time the export ran for the system running the update and export, provided the Probable Qty Export flag is selected at the Inventory tab of the System screen.

Aggregate by product? Otherwise, if the Aggregate by Product flag is selected, the update and export:

         sums the quantities for each product across product locations, regardless of whether there has been any activity since the last export

         creates a pipe-delimited export file containing the products and totals. In this situation, the file does not include the location code.

No other uses of probable quantity: Order Broker does not use the probable quantity field in any calculation, return it in any web service, or display it on any screen. Its only use is to be available for in the probable quantity export.

Which product locations are included in the export file? If the Aggregate by Product flag is unselected, the export file includes product locations that:

         are part of a system that has the Probable Qty Export flag selected.

         has been updated since the last time the export file was generated for the requesting system.

If the Aggregate by Product flag is selected, the export file includes products that are part of a system that has the the Probable Qty Export flag selected.

Configuring the export: Use the Probable Qty Export tab.

Resolving a scheduling issue: If the export does not run as scheduled, you can use the Reschedule All option at the View Active Schedules screen to stop and restart the schedules for all jobs and periodic programs. For example, you might need to use this option after a server shuts down unexpectedly, or after applying an upgrade.

Conflicting jobs? This job can run only if the following jobs are not already running:

         Incremental Inventory Import

         An import running through Schedule Imports

         Another instance of the Probable Quantity export

Job notifications: If the Event Notifications settings are configured at the Event Logging screen, a job notification message is generated each time the export job runs. See Event Notifications settings and the Job Notification Messages appendix of the Operations Guide for more information.

Status email: If the probable quantity export job is rejected because a conflicting job was already running, Order Broker generates the Probable Quantity Export Status email to the System Ops Email, indicating:

         System Code: The system submitting the job.

         Blocking System Code: The system that submitted the job that blocked the export job.

         Date/Time File Rejected

         Run By: The user ID of the person who submitted the job, or set to SYSTEM if the job was scheduled.

Typical probable quantity export usage: An example of how you might use the probable quantity export would be an ecommerce system that requires an estimate of availability for display at the ecommerce site:

         System A is your ecommerce system. For this system:

         the Probable Qty Export flag is not selected, because the system does not require its own product locations in the export file

         at the Probable Qty Export tab, the Enabled flag is selected, a schedule is defined, and the Apply Probable Qty Rule flag is selected

         Systems B and C are additional systems in your organization that can fulfill orders. For these systems, the Probable Qty Export flag is selected, because updated inventory should be included in the probable quantity export file.

         When the probable quantity export runs for system A, it includes all product locations in systems B and C that have been updated since the last probable quantity export for system A.

         The probable quantity specified in the export file may be the same as the available to promise quantity, based on the conditions described under Probable Quantity, below. Since the Apply Probable Qty Rule flag is selected for system A, the program applies assigned rules for product locations included in the export.

Note:             The Default Unfulfillable Location is not included in the probable quantity export.

For details, see:

         Probable Quantity

         Evaluating Probable Quantity Rules

         Probable Quantity Export File Layout and Contents

         File Storage API for Imports and Exports for information on using a RESTful web service and database table, rather than secure FTP, for file imports and exports

Probable Quantity

Usage: If the Apply Probable Qty Rule flag is selected, the probable quantity export program updates the probable_qty and the probable_updated fields in the product location table. The probable_qty is not used in any additional process or displayed on any screen in Order Broker; however, it is included in the probable quantity export so that a remote system, such as your ecommerce system, can display a more accurate picture of an item’s availability, without the need for interactive inquiries.

However, if the Apply Probable Qty Rule flag is unselected, the system uses the available to promise quantity as the probable quantity.

Which product locations evaluated? If the Apply Probable Qty Rule flag is selected, when the probable quantity export program runs for a system, it evaluates, and potentially updates, the probable_qty for all product locations that are flagged as eligible to be included in the export file (based on a probable_updated field set to NULL). The product location is flagged as eligible by setting this field set to NULL when:

         a product import, including the incremental inventory import, updates the product location

         you update a product location at the Edit Product Location screen

         the product location is updated through an interactive inventory update (for example, triggered by a submit order request or a locate items search)

         you assign a probable quantity rule, modify an assigned probable quantity rule, or delete a probable quantity rule assignment for the location type that includes the location through the Probable Quantity Location screen, even if the product does not qualify for that particular rule

When the probable quantity export program evaluates and resets the probable_qty based on whether the Apply Probable Qty Rule flag is selected, it updates the probable_updated field with the current date and time, indicating that the product location is not currently eligible for probable quantity update until the next activity that updates the probable_updated field.

Backorders? For the purposes of calculating the probable quantity for export, a negative available quantity is treated the same way as an available quantity of zero.

Calculation details: To determine the probable_qty for a product location, the program uses the following rules:

1. The calculation starts with the current on-hand quantity (the available_qty in the product_location table).

2. The update calculates the available to promise quantity by:

         Subtracting the reserved quantity, if any, based on the Reserved Statuses at the Reservation tab.

         Subtracting the fulfilled quantity, if any, for recently fulfilled orders in the store location that have not been reset to 0 through the Fulfilled Inventory Export.

3. If:

         The Apply Probable Qty Rule flag is unselected for the system, or if no probable quantity rules apply to the product location based on the location type, the probable_qty = the available to promise quantity; however, if the available to promise quantity is less than zero, then the probable_qty is set to zero.

         Otherwise, if the Apply Probable Qty Rule flag is selected for the system, and there are any probable quantity rules that apply to the product location based on the location type, then the probable_qty is calculated by applying the probable quantity rule to the available to promise quantity. If the result is less than zero, then the probable_qty is set to zero.

About probable quantity rules: Probable quantity rules can add or subtract a quantity, increase or decrease by a percentage, or set the probable_qty to a specified quantity.

Examples:

If the available to promise quantity (Available quantity - reserved quantity) = 10 and...

Probable quantity rule is:

then the probable_qty is:

 

Available + 5

15

 

Available - 15

0

 

5

5

 

Available - 10%

9

If the available to promise quantity is negative: The program still applies the probable quantity rule if the available to promise quantity is negative. For example, if the available to promise quantity is -3, but the probable quantity rule indicates to add 10, then the probable_qty is 7. However, if the result after applying the probable quantity rule is still negative, then the probable_qty is 0.

Probable quantity rules that apply a percentage increase or decrease do not affect the probable_qty if the available to promise quantity is less than 0. The result is still negative, so the probable_qty is still 0. For example, if the available to promise quantity is -5, and the rule increases the quantity by 25%, the result is still less than 0, so the probable quantity is 0.

Evaluating Probable Quantity Rules

You can set up probable quantity rules based on:

         matching system product code, or

         matching master style code

         matching department, class, or category

         no required matching

Also, you can assign probable quantity rules at the location type level or at the location level.

If multiple probable quantity rules could apply to the same product location, the program applies only the last possible rule as follows to calculate the probable_qty:

First, evaluate rules assigned to the location type:

1

no matching required

5

matching master style

6

matching system product

Next, evaluate rules assigned to the location, using the same sequence listed above; however, rules assigned at the location level might not apply if there was no additional activity, such as a product import, that flagged the product location as eligible for probable quantity calculation.

Example:                    For a particular product, rules have been assigned to:

         the location type, specifying a matching master style

         the location, without any matching required

         the location, specifying a matching system product

Result: The rule that is assigned at the location level and specifies a matching system product is applied to the product location and updates the probable_qty.

Important:                               Rules assigned at the location level are eligible to be applied only if another activity, such as an inventory import, updates the product location.

For accurate calculation of the probable_qty, do not apply multiple probable quantity rules at the same level and with the same criteria.

Date and time updated: When it updates the probable_qty, the program also updates the probable_updated date and time in the product location table. This update occurs regardless of whether the probable_qty was updated solely because of a change in probability rule assignment.

What if the probable_qty doesn’t change? If the probable_qty does not change as a result of the probable quantity update program, the program does not update the probable_updated field unless the probable_updated field was set to NULL because of one of the activities listed above.

Example:                    If a user advances to the Edit Product Location screen in Order Broker and then clicks Save, this changes the probable_qty and probable_updated date for the product location to NULL; as a result, the update program includes this product location in its updates, and the product location is then eligible to be included in the extract file, even if there has not been any actual inventory change or change to the resulting probable_qty.

Note:             Even if the probable_qty for a product location is more than zero, this does not indicate if the location supports a particular transaction type, such as pickup.

Probable Quantity Export File Layout and Contents

When the probable quantity export runs:

         If you use File Storage API for Imports and Exports: The program creates the export record in the FILE_STORAGE table. The CONTAINER setting for the record is OROB-EXPORT. You can use the File Storage API to download export file records from the FILE_STORAGE table.

         If you use secure FTP for imports and exports: The program creates the file in the Export Files path specified in the Data Folder Settings section of the Tenant - Admin screen.

File naming: The file name is Probable_Quantity_Extract_SYS_150702_123456.txt, where SYS is the system (in all uppercase) running the export, and 150702 is the date when the file was generated, in YYMMDD format, and 123456 is the time when the file was generated, in HHMMSS format, and in the retailer’s time.

Column Name

Contents

SYSTEM_CD

The code identifying the system associated with the product.

PRODUCT_CD

The system product code for the item in the system generating the extract. The process trims any blank, trailing spaces.

LOCATION_CD

The code identifying the location.

Note:  This field is not included when the Aggregate by Product flag is selected. In this case, the following quantities are totals across all eligible product locations, and all products are included in the export file regardless of whether there has been any activity since the last export.

AVAILABLE_QTY

The current on-hand quantity of the product, without factoring in any reserved quantity or rules. From the available_qty in the product_location table, or the total available quantity across all product locations if the Aggregate by Product flag is selected.

RESERVED_QTY

The current quantity reserved for the product, based on the selected Reserved Statuses for the system. From the reserved_amt in the product_location table, or the total reserved quantity across all product locations if the Aggregate by Product flag is selected.

PROBABLE_QTY

See Probable Quantity.

 

Incremental Inventory Import

Overview: The incremental inventory update uses the following process:

         At the day and time scheduled at the Incremental Inv Import tab:

         If you use File Storage API for Imports and Exports: The program checks for an incremental inventory record in the FILE_STORAGE table.

         If you use secure FTP for imports and exports: The program checks for any incremental inventory pipe-delimited files in the Product Import Files folder specified in the Data Folder Settings area of the Tenant- Admin screen.

Identifying the incremental inventory file: The file in the folder or specified in the FILE_STORAGE table needs to be named INCREMENTAL_INVENTORY_SYS_xxx.TXT, where SYS is the system code and xxx is a user-defined alphanumeric sequence number. The sequence number indicates to the program the order in which to process multiple import files for the system. For example, if the files are named INCREMENTAL_INVENTORY_ABC_AB1.TXT and INCREMENTAL_INVENTORY_ABC_AB.TXT, the program first processes the file with the AB1 sequence number, and then the file with the AB2 sequence number. If there are records for the same product location in both import files, the record from the second file overwrites the first.

You cannot submit an import if another import process, including the product import, is already running in your organization.

Job Batch Size: The Job Batch Size controls the number of records to process in each batch.

         The program creates or updates the product location records in the Order Broker database.

         If there are any errors that prevent the program from processing a record in one of the files:

         If you use File Storage API for Imports and Exports: The program creates an error record in the FILE_STORAGE table. The CONTAINER setting for the record is OROB-ERRORS. You can use the FileService API to download export file records from the FILE_STORAGE table.

         If you use secure FTP for imports and exports: The program creates a copy of the file, including just the records in error, in the error folder below the Product Import Files folder, naming the file INCREMENTAL_INVENTORY_SYS_xxx.TXT.20170703.105108.err, where SYS is the system code, 20170703 is the date in YYMMDD format, and 105108 is the time in HHMMSS format. Errors that result from database validation, such as data that exceeds the length of the field in the database, are not captured in the error file.

Errors that might occur include an invalid number of columns, alphabetical characters in a numeric field, or a numeric field that is null: for example, the next PO quantity is blank rather than 0 or another number.

         If the Incremental Inventory Import field at the Event Logging screen is set to Administrator, the program sends the Incremental Inventory Import Status Email to your system administrator (the Administrative Email addresses) if the incremental inventory update fails.

Records imported regardless of system: The incremental inventory update program processes all records in the pipe-delimited file or FILE_STORAGE record if they are product locations for the organization, regardless of whether they are associated with the system selected for import; however, if they are not associated with the organization, they are skipped and are not reported as errors.

Resolving a scheduling issue: If the import does not run as scheduled, you can use the Reschedule All option at the View Active Schedules screen to stop and restart the schedules for all jobs and periodic programs. For example, you might need to use this option after a server shuts down unexpectedly, or after applying an upgrade.

Conflicting jobs? This job can run only if the following jobs are not already running:

         The probable quantity export (see the Probable Qty Export tab)

         An import running through Schedule Imports

         Another instance of the incremental inventory import

History: Use the Incremental Imports History to review incremental imports that have run.

Job notifications: If the Event Notifications settings are configured at the Event Logging screen, a job notification message is generated each time the import job runs. See Event Notifications settings and the Job Notification Messages appendix of the Operations Guide for more information.

Sample Incremental Inventory Import File

The pipe-delimited incremental inventory import file needs to include the following fields. The first row is the header information, which is informational only, and the following row is the product location data to update.

SYSTEM_CD|LOCATION_CD|PRODUCT_CD|AVAILABLE_QTY|NEXT_PO_QTY|NEXT_PO_DATE

6|1|PEN123|100|123|2015-08-27

Incremental Inventory File Mapping

Field

Attributes

Description

system_cd

alphanumeric, 10 positions

The code identifying the system importing the updated inventory for the product locations into Order Broker.

Required.

location_cd

alphanumeric, 10 positions

The code identifying the location where the product is stocked in the external system.

Required.

product_cd

alphanumeric, 35 positions

The system product code identifying the product in the external system. The system product code might differ from the product code if the external system is not the default system for the organization.

Required.

available_qty

numeric, 6 positions

The current quantity of the product available to sell in this location as of the time of the import process. A negative quantity, preceded by a minus sign (-), indicates that the item is backordered.

Required, but can be set to 0.

next_po_qty

numeric, 6 positions

The quantity ordered for this product on the next purchase order for this location.

Required, but can be set to 0.

next_po_date

datetime

The next date when a purchase order for this product is expected for delivery in this location. Datetime format; if set to YYYY-MM-DD, a time of 12:00:00 AM is appended. Can be empty, even if there is a next_po_qty.

Incremental Inventory Import Status Email

Order Broker sends this email to the Administrative Email address specified at the Event Logging screen if the incremental inventory program was unable to import the pipe-delimited file and if the Email Notifications flag for the Incremental Inventory Import option is set to Administrator.

The language used for the email is based on the Language specified for the organization, and the formatting of dates, times, and numbers is also based on the organization-level settings. See the Edit Organization screen for more information.

The Uploaded By entry always indicates a user of SYSTEM.

****ATTENTION****

 

Your Incremental Inventory Import has failed.

 

System Code

6

Date/Time File Failed

2016-11-02 13:01:06.257

Uploaded By      

SYSTEM

Please do not respond to this message.

 

--Order Broker

Fulfilled Inventory Export

Purpose: Use the Fulfilled Inventory Export to generate a pipe-delimited file of recent order fulfillments, so the inventory system of record can use this information to update its own inventory based on activity in Order Broker.

How to run the export: You can run the export by:

         clicking Run Now at the Fulfilled Inv Export tab of the System screen, or

         using the Fulfilled Inv Export tab of the System screen to set up an export to run on a specified schedule, if the Track Fulfilled Quantity field is set to Reset During Inventory Export.

Resolving a scheduling issue: If the export does not run as scheduled, you can use the Reschedule All option at the View Active Schedules screen to stop and restart the schedules for all jobs and periodic programs. For example, you might need to use this option after a server shuts down unexpectedly, or after applying an upgrade.

Job notifications: If the Event Notifications settings are configured at the Event Logging screen, a job notification message is generated each time the export job runs. See Event Notifications settings and the Job Notification Messages appendix of the Operations Guide for more information.

Export updates: The export program:

         identifies each order line within the system since the last time the export was run, based on the export update date and time in the xom_status_history table:

         delivery, pickup, and ship-to-store orders: the order line assigned to the location for fulfillment has gone into fulfilled status

         retail pickup orders: the order line assigned to the location for sourcing (transferring or shipping the item to the originating location) has gone into intransit status

         for each order line whose fulfilled or intransit quantity was included in the export, updates the export update date and time in the xom_status_history table

         for each product location included in the export:

         if the Track Fulfilled Quantity setting is Reset During Inventory Export, sets the Fulfilled Quantity to 0

         decreases the Available Quantity by the total quantity of fulfilled order lines included in the export, based on the quantity from the xom_status_history table

         updates the Last Updated Date for the product location

         generates the export file:

         If you use File Storage API for Imports and Exports: The program creates the export record in the FILE_STORAGE table. The CONTAINER setting for the record is OROB-EXPORT. You can use the FileService API to download export file records from the FILE_STORAGE table.

         If you use secure FTP for imports and exports: The program creates the file in the Export Files path specified in the Data Folder Settings section of the Tenant - Admin screen.

         generates the export file, creating the export record in the FILE_STORAGE table. The CONTAINER setting for the record is OROB-EXPORT. You can use the FileService API to download export file records from the FILE_STORAGE table. See File Storage API for Imports and Exports for details.

See the Fulfilled Inventory Export File.

Fulfilled quantity used in availability calculation: Both the Reserved Quantity and the Fulfilled Quantity are subtracted from the product location’s Available Quantity when calculating the Available to Promise quantity. See Calculating the Available to Promise Quantity for an overview.

Note:             The Fulfilled Quantity is not tracked for ship-to-store orders; however, they are included in the export file for the location where they were fulfilled (picked up by the customer).

Fulfilled Inventory Export File

         File format: The file is pipe-delimited (|).

         File location: If you use secure FTP, in a folder on the Order Broker server, based on the Export Files path specified in the Data Folder Settings section of the Tenant - Admin screen. Otherwise, if you use File Storage API for Imports and Exports, in the FILE_STORAGE table.

         File naming: Named FULFILLED_QUANTITY_EXTRACT_SYSCD_150831_165819.csv, where SYSCD is the code for the system, and 150831_165819 the date (August 31, 2015) and time when the file was created, in the retailer’s time.

File contents: 

Field

Description

Location code

The code identifying the location that shipped the delivery order, where the ship-to-store or pickup order was picked up, or that shipped or transferred the retail pickup order.

Order type

Either DELIVERY, PICKUP, SHIPTOSTORE, or RETAILPICKUP.

Order number

The number or code identifying the order in the originating system.

System product code

The number or code identifying the item in the fulfilling system.

Quantity fulfilled

The quantity of the item shipped, picked up, or in transit.

Unit price

The unit price of the item on the order.

Date and time

The date and time when the item was shipped or picked up. YYYY-MM-DDTHH:MM:SS:XXX format, where XXX is milliseconds (for example, 2014-05-19T16:15:34.710).

   

 

________________________________