A Appendix: Application Programming Interface (API)

This appendix describes how to use the supplementary documentation for staging table names, descriptions, business rules and column level information (like column names, column descriptions, column data type and nullability). Business rules, provided in the API document are specifically used for the incoming data.

These APIs should be referenced in the following cases:

• To understand Retail Insights staging tables in greater detail.

• When the source systems are non-Oracle Retail systems and need to be integrated with Retail Insights. These APIs provide business rules that help in creating custom extracts for populating staging tables.

Standards Common to all APIs

• Staging Table and Retail Insights ETL Fact Loading

  Each Staging table contains a given set of alternate keys which will be used during the Retail Insights ETL Fact loading process. The staging tables are primary source tables from where the Facts will be populated.

  The main aim for this appendix is to make the Fact loading un-interrupted even if the Primary Source systems like Oracle Retail Merchandising System (RMS), Oracle Retail Invoice Match (ReIM), and Oracle Retail Price Management (RPM) are not present.

  This appendix provides details about the loading of fact staging tables with source data by using the business rules and column level information.

• Primary and Local Currency Amount fields

  Amounts will be stored in both primary and local currencies for most fact tables. If the source system uses multi-currency, then the primary currency column holds the primary currency amount, and the local currency column holds the local currency amount. If the location happens to use the primary currency, then both primary and local amounts hold the primary currency amount. If the source system does not use multi-currency, then only the primary currency fields are populated and the local fields hold NULL values.

• Required Fields in the API Staging tables appendix

  The Columns defined as 'N' in the "REQUIRED FIELDS" of the API staging table appendix are not mandatory fields and may also be holding NULL values. These fields will be populated by non oracle retail source systems only if available. The columns defined as 'Y' are though mandatory fields and would require to get loaded from the incoming source data.

API Table List

Note: Extract ODI program (SDE), for Customer dimension and Customer Loyalty related tables need to be created during implementation time. These extract programs will load data into staging tables. API for these staging tables is provided below. For example, the W_RTL_CUSTSEG_DS table will be populated with customer segment data during implementation.

Note: For the list of attributes that exist in RA and their physical mappings to the Dimension tables (_D tables), see Appendix B, "Retail Insights Attributes and Physical Mappings". For any custom attributes that are built as part of a customization, please map to the columns that are not used in the Attributes and Physical Mappings list.

For the complete list of staging table APIs, refer to the Oracle Retail Insights Cloud Services Suite and Oracle Retail Advanced Science Cloud Services Data Interface Guide (Doc ID 2114419.1).