OCDS Imports

About OCDS integration: You can use 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 to OCDS for this information rather than processing an upload file.

Required setup: To import data through the integration with OCDS:

Use the OCDS Integration tab at the System screen to define the URLs for requests to OCDS, as well as other data required for the integration, including the maximum number of records to request for each import type and authentication information.
Use the Schedule Jobs screen to submit the imports. If any of the URLs are specified at the OCDS Integration tab at the System screen and are flagged as active, this screen triggers the import from OCDS rather than another data import method.

See each of the imports described below for more details on required configuration and mapping.

Confirming the version number of OCDS: If you need to confirm the version of OCDS, you can submit a web service request to a URL such as https://SERVER/ords/ocds/omnichannel/v1/admin/version, where SERVER is the name of the server.

OCDS returns a response that includes something such as the following:

"version": "16.0.031",

"hotfix": "ocds-hf-003.0"

Where 16.0.031 is the version and 003 is the hot fix.

In this topic:

For more information: See:

Importing Items/Products, Inventory, Barcodes, and Locations into the Database for an overview on import processes and background information.
Schedule Jobs for more information on setting up the import schedule or running the import process on demand.

OCDS Import Steps

The import steps are:

Use the OCDS Integration tab at the System screen to specify the URLs for each type of import to take place, activate selected imports, and complete additional information such as the location types to use when creating location records and connection information for OCDS.

If any of the URLs are flagged as active at the OCDS Integration tab, the OCDS import process runs rather than any other import process.
Use the Schedule Jobs screen to schedule the import, or run it on demand. If you select Run Now, you need to also indicate whether to perform a Full Refresh or Since Last Run; however, the store location and virtual warehouse location imports always perform a full refresh. See the OCDS Integration fields at this screen for more information.

Note:

Use caution when selecting Full Refresh when the active import options include store inventory or warehouse inventory, as the number of records to import can affect system performance.

Troubleshooting: If one of the URLs specified at the OCDS Integration tab at the System screen is incorrect, this is not listed as an error at the Product Imports History screen; however, the issue is noted as a communication error in the tenant error log file.

Error reports: See the Location Import Errors Report for errors that occur related to missing location name or code, and see the Product Import Errors Report for errors that occur related to the product or product description.

No report is generated for any store or warehouse inventory records; however, an error file is available through the file storage API. See Product Location Import Error Files for more information.

Batch size: The import process uses the Job Batch Size specified at the Tenant-Admin screen to indicate the maximum number of records that OCDS should return at a time. This number, typically set to 1000, is appended to the request messages to OCDS for each import type. Order Broker continues submitting requests until OCDS no longer indicates that there are more records to return.

No deletions: The OCDS import creates or updates records. No deletions take place as a result of this import.

Note:

The request messages to OCDS include "Accept-Encoding: gzip" in the request header, in order to receive compressed data in the response and enhance processing performance.

Store Location Import Mapping

The table below lists the fields updated for store locations through import from OCDS.

Requirements: To import store locations from OCDS, complete the following fields at the OCDS Integration tab tab at the System screen:

Complete the Store Location URL and select the Active flag.
Use the Default Location Type for store locations to select the Location Type to assign to imported store locations.

Unmapped fields: Any fields not listed in the following table do not exist in OCDS or are not mapped or updated through the import process. To update some of these additional fields:

Use the Edit Location screen to specify additional information, such as days open for auto-cancel or labor cost. Additional fields that you can define at the Edit Location screen, such as store hours, rank, and region, are informational only.
Use the Preferences screen to define the types of orders that the store location is eligible to fulfill. You can set these preferences for the location type, and then optionally set overrides at the location level.

Invalid address? The import process creates a location record even if the address specified in the import response is incomplete or invalid. If the location is not included as expected in inventory search results or order assignments, you can use the Edit Location to verify or correct the address.

Update Latitude and Longitude: The import process updates the location’s Latitude and Longitude when creating or updating the location, providing the location is valid. See Proximity Locator Searching for an overview.

Days Open not updated: The Days Open fields for a location are all automatically selected when the import process creates a new location, and the existing settings are not updated when the import process updates an existing location. You can update these fields at the Edit Location screen, or through the Location Bulk Updates wizard.

Error report: The Location Import Errors Report lists any errors that occur related to missing location name or code. These are the only two errors that can occur related to imported locations through OCDS.

No records are deleted through the import.

Note:

Regardless of whether you select Run Now or Since Last Run at the Schedule Jobs screen, all store locations are imported each time you submit the import.

Field	Attributes	Description
system	alphanumeric, 10 positions	From the system selected at the Schedule Jobs screen.
location type	alphanumeric, 10 positions	From the Default Location Type (store) specified at the OCDS Integration tab at the System screen.
location	alphanumeric, 10 positions	See location. If the location code does not exist, the system creates a new location; if the location code already exists, the system updates the location.
name	alphanumeric, 40 positions	Description of the store location. Always updated.
phone	alphanumeric, 20 positions	Optional.
fax	alphanumeric, 20 positions	Optional.
contact name	alphanumeric, 50 positions	Optional.
email	alphanumeric, 255 positions	The email address must be formatted as user@host.com (or other valid suffix such as .org). Order Broker does not validate that your entry represents an existing email address. Separate multiple email addresses with a semicolon (;).
Address fields: The import process updates all address information if any address information was included in the import response, including clearing the data in any of the address fields that are blank or empty in the response from OCDS.
address lines 1 through 3	alphanumeric, 50 positions	Optional.
city	alphanumeric, 35 positions	Optional.
state/province	alphanumeric, 3 positions	Required if you use the proximity locator. Should be a valid ISO code.
postal code	alphanumeric, 10 positions	The ZIP or postal code for the location. Required if you use the proximity locator. Note: To prevent issues with proximity calculation, Canadian postal codes should be imported with an embedded space. For example, the correct format is Y1A 1A3 rather than Y1A1A3.
country	alphanumeric, 3 positions	Required if you use the proximity locator; in this situation, the country code must exist in the proximity table. Should be a valid ISO code. Note: The import process creates a location record even if the address specified in the import response is incomplete or invalid. If the location is not included as expected in inventory search results or order assignments, you can use the Edit Location to verify or correct the address.

Warehouse Location Import Mapping

The table below lists the fields updated for virtual warehouse locations through import from OCDS.

Requirements: To import virtual warehouse locations from OCDS, complete the following fields at the OCDS Integration tab tab at the System screen:

Complete the Warehouse Location URL and select the Active flag.
Use the Default Location Type for warehouse locations to select the Location Type to assign to imported warehouse locations.

Virtual warehouses only: The OCDS integration imports virtual warehouses only; it does not import physical warehouses. Because the warehouses are virtual locations, the address information that is imported is from the physical warehouse associated with the virtual warehouse.

Note:

The virtual warehouse is imported only if the warehouse ID (warehouseid) specified in the response message from OCDS is different from the physical warehouse ID (physicalwh) in the response.

Unmapped fields: Any fields not listed in the following table do not exist in OCDS or are not mapped or updated through the import process. To update some of these additional fields:

Use the Edit Location screen to specify additional information, such as days open for auto-cancel or labor cost. Additional fields that you can define at the Edit Location screen, such as store hours, rank, and region, are informational only.
Use the Preferences screen to define the types of orders that the warehouse location is eligible to fulfill. You can set these preferences for the location type, and then optionally set overrides at the location level.

No records are deleted through the import.

Note:

Regardless of whether you select Run Now or Since Last Run at the Schedule Jobs screen, all virtual warehouses are imported each time you submit the import.

Field	Attributes	Description
system	alphanumeric, 10 positions	From the system selected at the Schedule Jobs screen.
location type	alphanumeric, 10 positions	From the Default Location Type (warehouse, unlabeled) specified at the OCDS Integration tab at the System screen.
location	alphanumeric, 10 positions	See location. If the location code does not exist, the system creates a new location; if the location code already exists, the system updates the location.
name	alphanumeric, 40 positions	Description of the store location. Always updated.
Address fields: The import process updates all address information for the physical warehouse associated with the virtual warehouse, including clearing the data in any of the address fields that are blank or empty in the response from OCDS. Physical warehouses are associated with virtual warehouses based on the PHYSICAL_WH defined in the WAREHOUSE table in the OCDS database.
address lines 1 through 3	alphanumeric, 50 positions	Optional.
city	alphanumeric, 35 positions	Optional.
state/province	alphanumeric, 3 positions	Required if you use the proximity locator. Should be a valid ISO code.
postal code	alphanumeric, 10 positions	The ZIP or postal code for the location. Required if you use the proximity locator. Note: To prevent issues with proximity calculation, Canadian postal codes should be imported with an embedded space. For example, the correct format is Y1A 1A3 rather than Y1A1A3.
country	alphanumeric, 3 positions	Required if you use the proximity locator; in this situation, the country code must exist in the proximity table. Should be a valid ISO code. Note: The import process creates a location record even if the address specified in the import response is incomplete or invalid. If the location is not included as expected in inventory search results or order assignments, you can use the Edit Location to verify or correct the address.

Product Import Mapping

The table below lists the fields updated for products and system products through import from OCDS. When the system is the default, the import creates both product and system product records; otherwise, the import creates just the system product record.

Requirements: To import products and create system products from OCDS, complete the following fields at the OCDS Integration tab tab at the System screen, complete the Products URL and select the Active flag.

The product must already exist in the organization’s default system in order to create or update the system product for a non-default system.

Error report: The Product Import Errors Report lists any errors that occur. Typically, the only possible error that can occur is if no product description is provided.

No records are deleted through the import.

Field	Attributes	Description
system	alphanumeric, 10 positions	From the system selected at the Schedule Jobs screen.
product and system product	alphanumeric, 35 positions	Both from the item passed by OCDS. Not updated after initial product creation in Order Broker.
description	alphanumeric, 40 positions	From the `description` passed by OCDS. Truncated if it exceeds 40 positions.
master style	alphanumeric, 35 positions	From the `itemparent` passed by OCDS (up to 25 positions, alphanumeric).
department	alphanumeric, 40 positions	From the `dept` passed by OCDS (4 positions, numeric).
class	alphanumeric, 40 positions	From the `class` passed by OCDS (4 positions, numeric).
subclass	alphanumeric, 40 positions	From the `subclass` passed by OCDS (4 positions, numeric). Displayed as the product Category in Order Broker.

Item Image URL Import Mapping

Importing item image URLs to display in Store Connect works the same way as the product import described above, except for the additional setup requirements at the OCDS Integration tab at the System screen for the default system: you need to complete the Product Image URL and select the Active flag.

The item image URL should be formatted as https://www.example.com/folder/image.png, where:

http or https is the protocol
www.example.com is the domain or server name
folder is a folder or subfolder where the image is found
image.png or image.jpg is the name of the image

Image image URL updated? If the Product Image URL specified at the System screen for the default system is valid, and the URL passed does not exceed 255 positions, the import uses the imageuri passed in the response to update the Image URL for the product.

Errors: If the specified item image URL is not formatted correctly, or if it exceeds 255 positions, an error is returned and is listed on the Product Import Errors Report.

Product Barcode Import Mapping

Importing product barcode that can be used to scan items in Store Connect works the same way as the imports described above, except for the additional setup requirements at the OCDS Integration tab at the System screen for the default system: you need to complete the Product Barcode URL and select the Active flag.

If a product barcode already exists for the product, it is not overwritten; instead, an additional barcode is created. Existing barcodes are deleted through integration with OCDS if the Action passed is Delete. Deleted records are included in the UPC Records count at the Product Imports History screen.

Errors: Any errors are listed on the Product Barcode Import Errors Report.

Store and Warehouse Inventory Import Mapping

The table below lists the fields in the product location record that are updated through store inventory and warehouse inventory imports from OCDS. Both of these imports work the same way to update product locations in Order Broker, except for the setup requirements at the OCDS Integration tab tab at the System screen:

To import store inventory, complete the Store Inventory URL and select the Active flag.
To import warehouse inventory, complete the Warehouse Inventory URL and select the Active flag.

Record created? The import creates the product location if it does not already exist, provided both the product and the location already exist for the requesting system. If both the product and the location do not already exist, the record is counted as an error.

Errors: No report is generated for any store or warehouse inventory records; however, an error file is available through the file storage API. See Product Location Import Error Files for more information.

Additional fields for the product location, including the Next PO Date and Next PO Quantity, are not updated.

Note:

You would ordinarily run these imports just once as an initial load of data; however, you have the option of using the Since Last Run option if you run the import on demand at the Schedule Jobs screen.
Because of the potentially large number of records, it is important to run this import at a time when it will have less effect on system performance.
The available quantity is also updated interactively through the Oracle Retail Integration Cloud Service (RICS) when Importing Data from Merchandising Cloud Services (RMFCS) through the Omnichannel Cloud Data Service (OCDS) is implemented. See Available-to-Sell Individual Inventory Updates through Oracle Retail Integration Cloud Service (RICS) for a summary.

No records are deleted through the import.

Field	Attributes	Description
system	alphanumeric, 10 positions	From the system selected at the Schedule Jobs screen.
product	alphanumeric, 35 positions	From the item passed by OCDS.
location	alphanumeric, 10 positions	From the location passed by OCDS.
available quantity	numeric, 10 positions	From the availablequantity passed by OCDS. Note: Interactive updates to the available quantity for product locations take place through Oracle Retail Integration Cloud Service (RICS). This information originates in Oracle Retail Merchandising Foundation Cloud Service (RMFCS).
last updated by	alphanumeric, 10 positions	Set to the ADMIN user ID.
last updated	datetime	Set to the date and time when the import ran.