4 OCDS Integration Configuration

This chapter describes configuration options for the OCDS integration.

Xadmin-OCDS Integration Communication

Xadmin requests changes to merchandising and pricing data in OCDS by calling the REST web services.

[ON-PREMISES ONLY] The Xstore Office xcenter.properties file contains properties for the OCDS URL and service path prefix.

[CLOUD ONLY] The properties for the OCDS integration are set up through the Xadmin Integration Management feature and are stored in the Xstore Office Cloud Service database.

Note: The Integration Management feature only available for Xstore Office Cloud Service Release 18.1.

Table 4-1 Properties - OCDS URL and Service Path Prefix

Properties	Description
ocds.connectionURL	A URL describing protocol, host name, and port of the OCDS Web Services. Example: https://HOSTNAME:xxx
ocds.connection.servicePath.prefix	The root service path for OCDS. Example: /ords/ocds/omnichannel/v1
ocds.connection.username	The encrypted username used to authenticate web service communication with OCDS. This property is only necessary for on-prem installations, cloud installations store this information in the Oracle Enterprise Manager (OEM).
ocds.connection.password	The encrypted password used to authenticate web service communication with OCDS. This property is only necessary for on-prem installations, cloud installations store this information in the Oracle Enterprise Manager (OEM).

Xadmin System Settings

Xadmin's System Settings screen includes a category for Omnichannel Data Service (OCDS) configuration options. These settings govern how Xadmin integrates with OCDS.

Figure 4-1 Xstore Office - Ominichannel Data Service System Settings

Omnichannel Data Service Configuration Options

The OCDS system settings are used to enable and configure the integration.

Table 4-2 OCDS System Settings

Setting	Description
OCDS Enabled	When this setting is set to false, OCDS jobs are not scheduled and will never be triggered. When this setting is set to true, jobs are scheduled at intervals specified in the Xadmin settings "OCDS Scheduled Job Interval Minutes" and "OCDS On Demand Job Interval Minutes". Note: The OCDS Enabled setting is only available for Xstore Office and Xstore Office Cloud Service Release18.0. [CLOUD ONLY] For Xstore Office Cloud Service Release 18.1 this system setting is not available. The integration with OCDS is enabled through the Xadmin Integration Management flow.
Organization OCDS Chain mapping	Specifies a comma separated Xstore organization and OCDS chain mappings. For example, "1000:1,2000:2" maps organization 1000 to chain 1, and organization 2000 to chain 2.
OCDS Scheduled Job Interval Minutes	This is the frequency with which Xadmin requests data from OCDS. The value should be greater than or equal to 30 minutes.
OCDS On Demand Job Interval Minutes	This is the maximum amount of time that will elapse between when an on-demand job is created and is executed. The value should be greater than or equal to 5 minutes.
OCDS Orphan Data Protection Offset Seconds	This is the minimum amount of time data must age in OCDS before it can be visible to Xcenter. The offset helps to prevent related-data from becoming orphaned due to system latency. The value should be greater than or equal to 30 seconds.
OCDS Records Per Request Limit	This specifies the number of records to request in calls to OCDS. If no limit is defined then OCDS will determine the maximum number of records.
OCDS Retail Location: Till Accountability	This specifies if Retail Locations created from OCDS data are to use Till Accountability or not.
OCDS Retail Location: Default Locale	This specifies the Locale to use in Retail Locations created from OCDS data when a LANG_ISO_CODE is not defined for a location. OCDS Item: Tax Group ID for non-taxable items This specifies the Tax Group ID assigned to non-taxable items created from OCDS data.
OCDS Item: Tax Group ID for non-taxable Items	This specifies the Tax Group ID assigned to non-taxable items created from OCDS data.
OCDS Item: Include future date to determine VAT code with the greatest active date?	This specifies if future date should be included to determine VAT code with the greatest active date.

OCDS Database Tables

There are three database tables in the Xadmin database that are exclusively used for integration with OCDS. See the Oracle® Retail Xstore Point-of-Service Software Database Dictionary for complete details on these tables.

Table 4-3 OCDS Database Tables

Table Name	Description
OCDS_JOB_HISTORY	When enabled in Xadmin, an OCDS job is executed by scheduled-interval or on-demand, to detect foundation data changes in OCDS server and extract them out into .mnt files. An entry in this table records the status, start/end time and other information of a job executed.
OCDS_ON_DEMAND	An entry in this table represents an on-demand OCDS job request. On-demand jobs can be system generated (as in the case of new store detection), or user generated (from the Xadmin UI).
OCDS_SUBTASK_DETAILS	An OCDS job executes a list of subtasks. Each subtask represents a foundation data area to detect and extract out changes. The table defines metadata for all subtasks. For a scheduled job, each and every active subtask is executed. For an on-demand job, a subset of subtasks specified for the job is executed.

The only table that requires seed data is the OCDS_SUBTASK_DETAILS; the other two tables will populate during OCDS operations.

Seed Data for VAT and Non-VAT Organizations

Seed data for VAT and non-VAT organizations

The OCDS_SUBTASK_DETAILS table contains metadata that controls how .mnt files are named and deployed for data-loading into Xstore Suite databases. In general, the out-of-the box seed data values for this table are appropriate for most organizations; however, if not using VAT then the ACTIVE column for the VAT SUBTASK_ID should be set to 0.

Figure 4-2 OCDS Subtask Details Table

Download: Immediate vs Store Close

The OCDS_SUBTASK_DETAILS table includes the column DOWNLOAD_TIME, which specifies when .mnt files should be downloaded for data loading at the store. The column contains null for those OCDS Subtasks that only populate the Xcenter database. The out-of-the-box seed data is configured so that only pricing data will flow to the store immediately.