Mirror of Oracle documentation
Converted for search and offline reading. Authoritative source: Oracle. Diagrams and some complex tables are simplified — check the PDF when in doubt.
Applications deployed in PDS can get the same using RDX. For more details about the RAP Inbound Interfaces, see the Oracle Retail Analytics and Planning Implementation Guide . Any supplemental data that is specific to planning can be directly loaded into PDS as PDS Flat Files. This section shows the details about the interfaces used by PDS in RAP using RDX.
Following is the pre-defined grouping of interfaces available in the APCS template version within RAP integration.
Pre-defined imports from RAP integration to APCS:
-
Import Foundation and Transactional data from Retail Insights (RI)
-
Import Forecasts from AI Foundation (AIF)
-
Import DT Parameters from AI Foundation (AIF)
-
Import Location Clusters from AI Foundation (AIF)
-
Import Customer Segments from AI Foundation (AIF)
-
Import Size Profiles from AI Foundation (AIF)
Pre-defined exports to RAP integration to APCS:
-
Export Assortment Periods for Location Clusters from AI Foundation (AIF)
-
Export Active Assortments to AI Foundation (AIF)
-
Export Assortment Groups to AI Foundation (AIF)
-
Export Assortment Plans to Retail Insights (RI)
Import Foundation and Transactional Data from Retail Insights
RMFCS can send Foundation and Transactional data to RAP integration using Retail Insights (RI) and other systems within RAP. The systems can share the data, even if RMFCS is not implemented for the customer. The customer can upload the foundation and data files in the file format needed by RI in RAP integration. That way, the same data can be published to all applications within RAP. It can be done by scheduling required job flows in Retail Insights to get the foundation data from RMFCS and loading it into the staging tables present in Retail Data Exchange (RDX) from where the configured interfaces in APCS can pull the required data into Facts in Planning Data Schema (PDS) where APCS is deployed.
The customer can also load foundation data directly into RAP using the file format specified for RAP integration and using the same staging process in RI to write the data into RDX staging tables from where Planning can pull the data using standard configured interfaces. Only mapped columns specific to GA interfaces are detailed in this guide. For more details about interface file formats and the jobs flow details, see the Oracle Retail Analytics and Planning Implementation Guide . Also refer to those guides to find more information about the available columns in each interface staging tables in RDX sourced from RI so that customers using extensibility on template or using custom configuration (non-template) can pull the required data from RDX.
The following table shows the list of interfaces in RAP to get the foundation and transactional data:
| Interface | Interface and Table Name | Interface Type |
|---|---|---|
| Product Hierarchy | W_PDS_PRODUCT_D | Hierarchy Importer |
| Location Hierarchy | W_PDS_ORGANIZATION_D | Hierarchy Importer |
| Interface | Interface and Table Name | Interface Type |
|---|---|---|
| Calendar Hierarchy | W_PDS_CALENDAR_D (VW_CLND_HIER) | Hierarchy Importer |
| Cluster Hierarchy | VW_CLRH_HIER (W_PDS_ORGANIZATION_D | Hierarchy Importer |
| Product Attribute Hierarchy | W_PDS_UDA_D | Hierarchy Importer |
| Sales Interface | W_PDS_SLS_IT_LC_WK_A | Data Importer |
| Inventory Interface | W_PDS_INV_IT_LC_WK_A | Data Importer |
| On Order Interface | W_PDS_PO_ONORD_IT_LC_WK_A | Data Importer |
| Receipts Interface | W_PDS_INVRC_IT_LC_WK_A | Data Importer |
| Inventory Transfers | W_PDS_INVTSF_IT_LC_WK_A | Data Importer |
| Markdowns Interface | W_PDS_MKDN_IT_LC_WK_A | Data Importer |
| Wholesale/Franchise | W_PDS_SLSWF_IT_LC_WK_A | Data Importer |
| Product Attributes | W_PDS_PRODUCT_ATTR_D | Data Importer |
| Location Data | VW_LOC_DATA | Data Importer |
| Product Data | VW_PROD_DATA | Data Importer |
| UDA Data | VW_UDA_DATA | Data Importer |
| Location Attributes Hierarchy | VW_SATR_HIER | Hierarchy Importer |
| Customer Segment Hierarchy | W_PDS_CUSTSEG_D | Hierarchy Importer |
| Location Attributes | W_PDS_ORG_ATTR_STR_D | Data Importer |
| Replenishment Data | W_PDS_REPL_ATTR_IT_LC_D | Data Importer |
The following table shows the mapping of dimensions to columns for Hierarchy Importer interfaces from external interface tables:
| Hierarchy | Dimension | External Interface Table | External Mapped Column |
|---|---|---|---|
| prod | sku | W_PDS_PRODUCT_D | ITEM |
| prod | sku_label | W_PDS_PRODUCT_D | ITEM_DESC |
| prod | skup | W_PDS_PRODUCT_D | ITEM_PARENT_DIFF |
| prod | skup_label | W_PDS_PRODUCT_D | ITEM_PARENT_DIFF_DESC |
| prod | skug | W_PDS_PRODUCT_D | ITEM_PARENT |
| prod | skug_label | W_PDS_PRODUCT_D | ITEM_PARENT_DESC |
| prod | scls | W_PDS_PRODUCT_D | CLASS_ID |
| prod | scls_label | W_PDS_PRODUCT_D | DEPT |
| prod | clss | W_PDS_PRODUCT_D | GROUP_NO |
| prod | class_label | W_PDS_PRODUCT_D | DIVISION |
| prod | dept | W_PDS_PRODUCT_D | COMPANY |
| prod | dept_label | W_PDS_PRODUCT_D | CO_NAME |
| prod | pgrp | W_PDS_PRODUCT_D | GROUP_NO |
| prod | pgrp_label | W_PDS_PRODUCT_D | GROUP_NAME |
| prod | dvsn | W_PDS_PRODUCT_D | DIVISION |
| prod | dvsn_label | W_PDS_PRODUCT_D | DIV_NAME |
| prod | cmpp | W_PDS_PRODUCT_D | COMPANY |
| Hierarchy | Dimension | External Interface Table | External Mapped Column |
|---|---|---|---|
| prod | cmpp_label | W_PDS_PRODUCT_D | CO_NAME |
| prod | vndr | W_PDS_PRODUCT_D | SUPPLIER |
| prod | vndr_label | W_PDS_PRODUCT_D | SUP_NAME |
| prod | brnd | W_PDS_PRODUCT_D | BRAND_NAME |
| prod | brnd_label | W_PDS_PRODUCT_D | BRAND_DESCRIPTION |
| prod | sta1 | W_PDS_PRODUCT_D | NA |
| prod | sta1_label | W_PDS_PRODUCT_D | Unassigned |
| loc | stor | W_PDS_ORGANIZATION_D | LOCATION |
| loc | stor_label | W_PDS_ORGANIZATION_D | LOC_NAME |
| loc | dstr | W_PDS_ORGANIZATION_D | DISTRICT |
| loc | dstr_label | W_PDS_ORGANIZATION_D | DISTRICT_NAME |
| loc | regn | W_PDS_ORGANIZATION_D | REGION |
| loc | regn_label | W_PDS_ORGANIZATION_D | REGION_NAME |
| loc | chnl | W_PDS_ORGANIZATION_D | AREA |
| loc | chnl_label | W_PDS_ORGANIZATION_D | AREA_NAME |
| loc | chan | W_PDS_ORGANIZATION_D | CHAIN |
| loc | chan_label | W_PDS_ORGANIZATION_D | CHAIN_NAME |
| loc | comp | W_PDS_ORGANIZATION_D | COMPANY |
| loc | comp_label | W_PDS_ORGANIZATION_D | CO_NAME |
| loc | phwh | W_PDS_ORGANIZATION_D | PHYSICAL_WH |
| loc | phwh_label | W_PDS_ORGANIZATION_D | PHYSICAL_WH_NAME |
| loc | loct | W_PDS_ORGANIZATION_D | LOC_TYPE |
| loc | loct_label | W_PDS_ORGANIZATION_D | LOC_TYPE_NAME |
| loc | strc | W_PDS_ORGANIZATION_D | LOCATION |
| loc | strc_label | W_PDS_ORGANIZATION_D | LOCATION_NAME |
| loc | chnc | W_PDS_ORGANIZATION_D | PLANNING_CHANNEL_ID |
| loc | chnc_label | W_PDS_ORGANIZATION_D | PLANNING_CHANNEL_NAME |
| loc | ccty | W_PDS_ORGANIZATION_D | PLANNING_COUNTRY_ID |
| loc | ccty_label | W_PDS_ORGANIZATION_D | PLANNING_COUNTRY_NAME |
| clnd | day | W_PDS_CALENDAR_D | DAY |
| clnd | day_label | W_PDS_CALENDAR_D | DAY_LABEL |
| clnd | week | W_PDS_CALENDAR_D | WEEK |
| clnd | week_label | W_PDS_CALENDAR_D | WEEK_LABEL |
| clnd | mnth | W_PDS_CALENDAR_D | MNTH |
| clnd | mnth_label | W_PDS_CALENDAR_D | MNTH_LABEL |
| clnd | qrtr | W_PDS_CALENDAR_D | QRTR |
| clnd | qrtr_label | W_PDS_CALENDAR_D | QRTR_LABEL |
| clnd | half | W_PDS_CALENDAR_D | HALF |
| clnd | half_label | W_PDS_CALENDAR_D | HALF_LABEL |
| clnd | year | W_PDS_CALENDAR_D | YEAR |
Import Foundation and Transactional Data from Retail Insights
| Hierarchy | Dimension | External Interface Table | External Mapped Column |
|---|---|---|---|
| clnd | year_label | W_PDS_CALENDAR_D | YEAR_LABEL |
| clnd | woyr | W_PDS_CALENDAR_D | WOYR |
| clnd | woyr_label | W_PDS_CALENDAR_D | WOYR_LABEL |
| clnd | stdb | W_PDS_CALENDAR_D | STDB |
| clnd | stdb_label | W_PDS_CALENDAR_D | STDB_LABEL |
| clnd | hldy | W_PDS_CALENDAR_D | NA |
| clnd | hldy_label | W_PDS_CALENDAR_D | Unassigned |
| clnd | evnt | W_PDS_CALENDAR_D | NA |
| clnd | evnt_label | W_PDS_CALENDAR_D | Unassigned |
| clnd | bypd | W_PDS_CALENDAR_D | NA |
| clnd | bypd_label | W_PDS_CALENDAR_D | Unassigned |
| clrh | clus | VW_CLRH_HIER | CLUS_ID |
| clrh | clus_label | VW_CLRH_HIER | CLUS_DESC |
| patr | patv | W_PDS_UDA_D (VW_PATR_HIER) | PROD_ATTR_VALUE |
| patr | patv_label | W_PDS_UDA_D (VW_PATR_HIER) | PROD_ATTR_VALUE_DESC |
| patr | patt | W_PDS_UDA_D (VW_PATR_HIER) | PROD_ATTR |
| patr | patt_label | W_PDS_UDA_D (VW_PATR_HIER) | PROD_ATTR_DESC |
| satr | satt | VW_SATR_HIER | ATTR_ID |
| satr | satt_label | VW_SATR_HIER | ATTR_DESC |
| satr | satv | VW_SATR_HIER | ATTR_VALUE |
| satr | satv_label | VW_SATR_HIER | ATTR_VALUE_DESC |
| csgh | csvd | W_PDS_CUSTSEG_D | CUSTSEG_ID |
| csgh | csvd_label | W_PDS_CUSTSEG_D | CUSTSEG_NAME |
| csgh | csgd | W_PDS_CUSTSEG_D | CUSTSEG_ID |
| csgh | csgd_label | W_PDS_CUSTSEG_D | CUSTSEG_NAME |
Note: For Calendar Hierarchy (clnd), RMFCS is not sending the labels. Internally, VW_CLND_HIER is defined in PDS against the interface W_PDS_CALENDAR_D table to derive the labels and also default the calendar import to PDS to have two past years, one current year, and two future years based on the current business date. The Administrator can update the same using the Online Administration Tool Tasks under System Admin Tasks → List/Set/Unset PDS Integration variables and can update the CLND_PAST_YEARS and CLND_FUTURE_YEARS variables. By default, both are set to 2. The customer can also update the start fiscal month by setting the CLND_START_MONTH variable. By default, it is set to 2 to have the fiscal start month label be generated as February. CLND_TYPE can be set to ‘F’ (Fiscal) or ‘G’ (Gregorian) or ‘B’ (Both) based on the type of calendar the customer wants to use for the calendar date range in PDS. It is defaulted to Both, in order to include the calendar range of both Fiscal and Gregorian Calendar start and end dates by default.
Note: For Cluster Hierarchy (clrh), there is no direct interface table. Internally, VW_CLRH_HIER is defined in PDS against the interface W_PDS_ORGANIZATION_D table to get the locations as cluster ids.
Note: The VW_PATR_HIER view is an internal view in PDS against the base RDX tables W_PDS_UDA_D, W_PDS_DIFF_D, W_PDS_SUPPLIER_D, and W_PDS_BRAND_D by concatenating all of them as product attributes. It also concatenates the product attribute name with the product attribute values using ‘_’ to make the product attribute values unique. The Product Attribute name for Supplier (W_PDS_SUPPLIER_D) is used as ‘supp’ and Brand (W_PDS_BRAND_D) is used as ‘brnd’. Only Product attributes with UDA_TYPE_CODE as ‘LV’ from W_PDS_UDA_D are included in the view. PDS Integration variables PATR_BRAND, PATR_SUPP are defaulted with values ‘brnd’ and ‘supp’, but those can be changed if the customer wants to use different attribute names. PDS Integration variable ‘PATR_OTHER’ can be enabled to ‘Y’ (default is set ‘N’) to include the ‘Z_Other’ attribute value for all the attributes that are used by AP GA.
Note: For the Location Attribute Hierarchy (SATR), there is no direct interface table. Internally, VW_SATR_HIER is defined in PDS against the interface W_PDS_ORG_ATTR_STR_D table to get the distinct location attributes. PDS Integration variable ‘SATR_GROUP’ can be enabled to ‘Y’ (default is set to ‘N’) to include the Sales Performance Group and Space Group Location Attributes used by AP GA.
Note: For all APCS hierarchies that are not integrated using RAP integration, the customer needs to explicitly provide those files.
The following table shows the mapping of fact names/measures names to columns for the Data Importer interfaces from the external interface tables in RDX:
| Fact Name | External Interface Table | External Mapped Column | External Mapping Condition |
|---|---|---|---|
| drtyeop1c | W_PDS_INV_IT_LC_WK_A | REGULAR_INVENTORY_COST | CLEAR_IND = ‘N’ |
| drtyeop1r | W_PDS_INV_IT_LC_WK_A | REGULAR_INVENTORY_RETAIL | CLEAR_IND = ‘N’ |
| drtyeop1u | W_PDS_INV_IT_LC_WK_A | REGULAR_INVENTORY_UNITS | CLEAR_IND = ‘N’ |
| drtyeop2c | W_PDS_INV_IT_LC_WK_A | REGULAR_INVENTORY_COST | CLEAR_IND = ‘Y’ |
| drtyeop2r | W_PDS_INV_IT_LC_WK_A | REGULAR_INVENTORY_RETAIL | CLEAR_IND = ‘Y’ |
| drtyeop2u | W_PDS_INV_IT_LC_WK_A | REGULAR_INVENTORY_UNITS | CLEAR_IND = ‘Y’ |
| drtynslsclrc | W_PDS_SLS_IT_LC_WK_A | NET_SALES_CLR_COST | |
| drtynslsclrr | W_PDS_SLS_IT_LC_WK_A | NET_SALES_CLR_RETAIL | |
| drtynslsclru | W_PDS_SLS_IT_LC_WK_A | NET_SALES_CLR_UNITS | |
| drtynslsproc | W_PDS_SLS_IT_LC_WK_A | NET_SALES_PRO_COST | |
| drtynslspror | W_PDS_SLS_IT_LC_WK_A | NET_SALES_PRO_RETAIL | |
| drtynslsprou | W_PDS_SLS_IT_LC_WK_A | NET_SALES_PRO_UNITS | |
| drtynslsregc | W_PDS_SLS_IT_LC_WK_A | NET_SALES_REG_COST | |
| drtynslsregr | W_PDS_SLS_IT_LC_WK_A | NET_SALES_REG_RETAIL | |
| drtynslsregu | W_PDS_SLS_IT_LC_WK_A | NET_SALES_REG_UNITS | |
| drtyrtnclrc | W_PDS_SLS_IT_LC_WK_A | RETURNS_CLR_COST | |
| drtyrtnclrr | W_PDS_SLS_IT_LC_WK_A | RETURNS_CLR_RETAIL | |
| drtyrtnclru | W_PDS_SLS_IT_LC_WK_A | RETURNS_CLR_UNITS | |
| drtyrtnproc | W_PDS_SLS_IT_LC_WK_A | RETURNS_PRO_COST | |
| drtyrtnpror | W_PDS_SLS_IT_LC_WK_A | RETURNS_PRO_RETAIL | |
| drtyrtnprou | W_PDS_SLS_IT_LC_WK_A | RETURNS_PRO_UNITS | |
| drtyrtnregc | W_PDS_SLS_IT_LC_WK_A | RETURNS_REG_COST | |
| drtyrtnregr | W_PDS_SLS_IT_LC_WK_A | RETURNS_REG_RETAIL |
| Fact Name | External Interface Table | External Mapped Column | External Mapping Condition |
|---|---|---|---|
| drtyrtnregu | W_PDS_SLS_IT_LC_WK_A | RETURNS_REG_UNITS | |
| drtyooc | W_PDS_PO_ONORD_IT_LC_WK_A | ON_ORDER_COST | |
| drtyoor | W_PDS_PO_ONORD_IT_LC_WK_A | ON_ORDER_RETAIL | |
| drtyoou | W_PDS_PO_ONORD_IT_LC_WK_A | ON_ORDER_UNITS | |
| drtyporcptc | W_PDS_INVRC_IT_LC_WK_A | PO_RECEIPT_COST | |
| drtyporcptr | W_PDS_INVRC_IT_LC_WK_A | PO_RECEIPT_RETAIL | |
| drtyporcptu | W_PDS_INVRC_IT_LC_WK_A | PO_RECEIPT_UNITS | |
| drtytraninbc | W_PDS_INVTSF_IT_LC_WK_A | TSF_IN_COST | TSF_TYPE = ‘B’ |
| drtytraninbr | W_PDS_INVTSF_IT_LC_WK_A | TSF_IN_RETAIL | TSF_TYPE = ‘B’ |
| drtytraninbu | W_PDS_INVTSF_IT_LC_WK_A | TSF_IN_UNITS | TSF_TYPE = ‘B’ |
| drtytraninic | W_PDS_INVTSF_IT_LC_WK_A | TSF_IN_COST | TSF_TYPE = ‘I’ |
| drtytraninir | W_PDS_INVTSF_IT_LC_WK_A | TSF_IN_RETAIL | TSF_TYPE = ‘I’ |
| drtytraniniu | W_PDS_INVTSF_IT_LC_WK_A | TSF_IN_UNITS | TSF_TYPE = ‘I’ |
| drtytraninr | W_PDS_INVTSF_IT_LC_WK_A | TSF_IN_RETAIL | TSF_TYPE = ‘N’ |
| drtytraninc | W_PDS_INVTSF_IT_LC_WK_A | TSF_IN_COST | TSF_TYPE = ‘N’ |
| drtytraninu | W_PDS_INVTSF_IT_LC_WK_A | TSF_IN_UNITS | TSF_TYPE = ‘N’ |
| drtytranoutbc | W_PDS_INVTSF_IT_LC_WK_A | TSF_OUT_COST | TSF_TYPE = ‘B’ |
| drtytranoutbr | W_PDS_INVTSF_IT_LC_WK_A | TSF_OUT_RETAIL | TSF_TYPE = ‘B’ |
| drtytranoutbu | W_PDS_INVTSF_IT_LC_WK_A | TSF_OUT_UNITS | TSF_TYPE = ‘B’ |
| drtytranoutic | W_PDS_INVTSF_IT_LC_WK_A | TSF_OUT_COST | TSF_TYPE = ‘I’ |
| drtytranoutir | W_PDS_INVTSF_IT_LC_WK_A | TSF_OUT_RETAIL | TSF_TYPE = ‘I’ |
| drtytranoutiu | W_PDS_INVTSF_IT_LC_WK_A | TSF_OUT_UNITS | TSF_TYPE = ‘I’ |
| drtytranoutr | W_PDS_INVTSF_IT_LC_WK_A | TSF_OUT_RETAIL | TSF_TYPE = ‘N’ |
| drtytranoutu | W_PDS_INVTSF_IT_LC_WK_A | TSF_OUT_UNITS | TSF_TYPE = ‘N’ |
| drtytranoutc | W_PDS_INVTSF_IT_LC_WK_A | TSF_OUT_COST | TSF_TYPE = ‘N’ |
| drtyicmkur | W_PDS_MKDN_IT_LC_WK_A | INTERCOMPANY_MARKUP | |
| drtyicmkdr | W_PDS_MKDN_IT_LC_WK_A | INTERCOMPANY_MARKDOWN | |
| drtywfslsu | W_PDS_SLSWF_IT_LC_WK_A | FRANCHISE_SALES_UNITS | |
| drtywfslsc | W_PDS_SLSWF_IT_LC_WK_A | FRANCHISE_SALES_COST | |
| drtywfslsr | W_PDS_SLSWF_IT_LC_WK_A | FRANCHISE_SALES_RETAIL | |
| drtywfrtnu | W_PDS_SLSWF_IT_LC_WK_A | FRANCHISE_RETURNS_UNITS | |
| drtywfrtnr | W_PDS_SLSWF_IT_LC_WK_A | FRANCHISE_RETURNS_COST | |
| drtywfrtnc | W_PDS_SLSWF_IT_LC_WK_A | FRANCHISE_RETURNS_RETAIL | |
| addvlocopnd | VW_LOC_DATA | STORE_OPEN_DATE | |
| addvlocendd | VW_LOC_DATA | STORE_CLOSE_DATE | |
| addvlocrefd | VW_LOC_DATA | REMODEL_DATE | |
| drdvprdatt | W_PDS_PRODUCT_ATTR_D (VW_PATV_DATA) | PROD_ATTR_VALUE | |
| drdvppatvt | VW_PATV_DATA | PATV_VALUE | |
| drtyudab | VW_UDS_DATA | True for PROD_ATTR |
| Fact Name | External Interface Table | External Mapped Column | External Mapping Condition |
|---|---|---|---|
| drtypclsst | VW_PROD_DATA | CLASS_DISPLAY_ID | |
| drtypsclst | VW_PROD_DATA | SUBCLASS_DISPLAY_ID | |
| drdvskuimgt | VW_PROD_DATA | PRODUCT_IMAGE_NAME | |
| drdvskuimgl | VW_PROD_DATA | PRODUCT_IMAGE_ADDR | |
| drdvslsprcr | VW_PROD_DATA | INITIAL_ITEM_RETAIL | |
| drdvslsprcc | VW_PROD_DATA | INITIAL_ITEM_COST | |
| addvlocatt | W_PDS_ORG_ATTR_STR_D | ATTR_VALUE | |
| drtyreplb | W_PDS_REPL_ATTR_IT_LC_D | REPL_ACTIVE_FLAG | |
| drtyrcptd | W_PDS_INV_IT_LC_WK_A | FIRST_INVRC_DT | |
| drtyslsprc | W_PDS_INV_IT_LC_WK_A | UNIT_COST | |
| drtyslsprr | W_PDS_INV_IT_LC_WK_A | UNIT_RETAIL |
Note: For Location specific data, the same W_PDS_ORGANIZATION_D hierarchy table used for the location hierarchy is used. The view VW_LOC_DATA is defined in PDS to point to the same set of data and used as data importer interface. Similarly, VW_PROD_DATA is defined against W_PDS_PRODUCT_D to load any required data as measures such as Image details, RMF CS Unique Class, and Sub-Class Ids.
VW_PATR_DATA is defined against W_PDS_PRODUCT_ATTR_D for UDA_TYPE in ‘LV’ and also gets attribute values for the DIFF*, SUPPLIER, AND BRAND_NAME from the W_PDS_PRODUCT_D table at the item level. It also concatenates the product attribute values with product attribute names using ‘_’ and uses ‘supp’ and ‘brnd’ as product attribute names for Supplier and Brand.
The VW_PATV_DATA internal view defined against the Product Attribute Hierarchy table contains product attribute values without concatenation of product attribute names and it uses similar tables as in VW_PATR_HIER. The VW_UDA_DATA is defined against W_PDS_UDA_D to only contain distinct UDA to uniquely identify the UDAs defined in RMFCS.
Note: If the customer wants to use position filtering to filter a few products only in APCS in a multi-app environment, they can use the extensibility in GA, to set the Position Filter Measure property for product in Hierarchies to the measure DRDVAPFltSkuB and then can use any flex field for the product in W_PDS_PRODUCT_D to mark those items as ‘Y’ and interface that data to APCS_DRDVAPFltSkuB by changing the interface.cfg mapping for VW_PROD_DATA using extensibility guidelines.
Note: Pack Items are filtered by default for AP during the product hierarchy import from RAP using the Pack Item Filter Value measure set to N. This shared filter measure, PCKFLGVAL, can be managed in the Planning Admin workbook. In a multi-app scenario, if other applications need to bring in pack items, this can be changed to % to bring in both pack and non-pack items.
Import Forecasts from AI Foundation
Forecasts can be generated from AI Foundation (AIF) and imported to APCS using RAP integration. AI Foundation can generate different levels of forecasts as needed by different levels of plans. It generates both Pre-Season forecasts (using the Auto-ES Forecast method) and In-Season Forecasts (using the Bayesian Forecast Method). AI Foundation directly gets the actuals through RAP integration. Job flows in AI Foundation need to be scheduled to
generate the forecast and import the same to APCS. For more details, see the Oracle Retail Analytics and Planning Integration Implementation Guide .
In order to get forecasts from AI Foundation, during implementation, some initial setups need to be done in the AI Foundation platform. For more details, see the Oracle Retail Analytics and Planning Integration Implementation Guide .
Note
The AI Foundation default Location Hierarchy does not contain the Planning Channel. Customers need to use the Alternate Hierarchy setup which uses the Planning Channel as an alternate hierarchy and create forecasts at the Planning Channel level as needed by MFP GA. For more details about creating forecasts at the Planning Channel level, see the AI Foundation documentation set.
The following table shows the interface table column details from AI Foundation in RDX used for the interface.
Interface Name: RSE_FCST_DEMAND_EXP
| Table Column | Data Type | Comments |
|---|---|---|
| RUN_ID | Number(10) | The export Run ID as obtained from the RAP_INTF_UTIL. |
| CAL_HIER_LEVEL | Varchar2(30) | The calendar level data is for Fiscal Year, Fiscal Quarter, Fiscal Period, Fiscal Week, and Fiscal Day. |
| LOC_HIER_LEVEL | Varchar2(30) | The location hierarchy level data is for COMPANY, CHAIN, AREA, REGION, DISTRICT, LOCATION, and CHANNEL. |
| PROD_HIER_LEVEL | Varchar2(30) | The product hierarchy level the data is for CMP, DIV, GRP, DEPT, CLS, SBC, STYLE, STYLE_COLOR, and ITEM. |
| FCST_DATE_FROM | Date | The start date which the forecast is for. |
| LOC_EXT_KEY | Varchar2(80) | The external id of the location. It will use the integration ids as provided to RI (preferably the RMS id, and not an integration id such as AREA~123). |
| PROD_EXT_KEY | Varchar2(80) | The external id of the product hierarchy. It will use the integration ids as provided to RI (preferably the RMS id, and not an integration id such as CLS |
| CUSTSEG_EXT_KEY | Varchar2(80) | The external id of the customer segment. It will be NULL if not applicable. |
| FCST_TYPE | Varchar2(20) | The type of forecast. PI, NPI (PI=Plan Influenced, PI = Non Plan Influenced) |
| REG_SLS_QTY | Number(38,20) | Regular Sales Units |
| REG_SLS_AMT | Number(38,20) | Regular Sales Amount |
| PR_SLS_QTY | Number(38,20) | Promo Sales Units |
| PR_SLS_AMT | Number(38,20) | Promo Sales Amount |
| CLR_SLS_QTY | Number(38,20) | Clearance Sales Units |
| CLR_SLS_AMT | Number(38,20) | Clearance Sales Amount |
| REG_PR_SLS_QTY | Number(38,20) | Regular and Promo Sales Units |
| Table Column | Data Type | Comments |
|---|---|---|
| REG_PR_SLS_AMT | Number(38,20) | Regular and Promo Sales Amount |
| SLS_QTY | Number(38,20) | Total Sales Units |
| SLS_AMT | Number(38,20) | Total Sales Amount |
| RET_QTY | Number(38,20) | Return Units |
| RET_AMT | Number(38,20) | Return Amount |
The same Interface table contains the forecast data for different levels of plans differentiated by _LEVEL columns within the interface. The single interface run pulls data for different levels of forecasts which are pre-configured. Customers using non-template versions, if using different levels of plans, can use the supported levels in AI Foundation to generate forecasts. The following sections provide the default levels of forecasts exported for the APCS template version and their mappings.
Item Level Forecasts Mapping
The following table shows the mapping for pre-season and in-season Item Level Forecasts.
| Table Column | Mapping for Pre-Season (MPP) | Mapping for In-Season (MPI) |
|---|---|---|
| CAL_HIER_LEVEL | Fiscal Week | Fiscal Week |
| LOC_HIER_LEVEL | LOCATION | LOCATION |
| PROD_HIER_LEVEL | ITEM | ITEM |
| FCST_DATE_FROM | WEEK | WEEK |
| LOC_EXT_KEY | STOR | STOR |
| PROD_EXT_KEY | SKU | SKU |
| CUSTSEG_EXT_KEY | NULL | NULL |
| FCST_TYPE | NPI | PI |
| REG_PR_SLS_QTY | FCTYFCPMU | FCTYFCIMU |
| REG_PR_SLS_AMT | FCTYFCPMR | FCTYFCIMR |
Sub-Class Level Forecasts Mapping
The following table shows the mapping for pre-season Sub-Class Level Forecasts.
| Table Column | Mapping for Pre-Season (MTP) |
|---|---|
| CAL_HIER_LEVEL | Fiscal Week |
| LOC_HIER_LEVEL | LOCATION |
| PROD_HIER_LEVEL | SBC |
| FCST_DATE_FROM | WEEK |
| LOC_EXT_KEY | STOR |
| PROD_EXT_KEY | SCLS |
| CUSTSEG_EXT_KEY | NULL |
| FCST_TYPE | NPI |
| REG_PR_SLS_QTY | FCDVSlS1U |
| REG_PR_SLS_AMT | FCDVSLS1R |
Import DT Parameters from AI Foundation
The previous version of APCS used Demand Transference (DT) from AI Foundation to suggest and optimize the assortments. DT is based on Item attributes, Attribute Weights, Functional Fit for Attributes, Assortment Elasticity, and Rate of Sale of Items. Item Attributes and Rate of Sale of item are available from RI interfaces. Other DT parameters such as Attribute Weights, Functional Fit for Attributes, and Assortment Elasticity are interfaced from AI Foundation through RAP integration. The APCS template version gets the DT parameters from RAP at the Sub-Class/Channel level, so it needs to be defined in AI Foundation at that level.
In order to get DT parameters from AI Foundation, during implementation, some initial setups need to be done in the AI Foundation platform. AI Foundation needs a customer segment to be defined for DT interfaces. AI Foundation can use multiple customer segments, so those customer segments need to be loaded as the CSGH hierarchy, in order for AP to interface DT parameters. AP is not directly using customer segments in planning workbooks, but the user can choose the Customer Segment to use for a Sub-Class in the Planning Admin workbook. Only those selected Customer Segments DT Parameters for the Sub-Class will be used in the AP workbooks. For more details, see the Oracle Retail Analytics and Planning Integration Implementation Guide .
The following table shows the interface table column details from AI Foundation in RDX used for the interface and the corresponding mapping of columns in APCS. Only mapped columns are used by the APCS template version. If RAP integration is enabled and if Enable RSE DT Integration is set to true, then this interface will run as part of the weekly batch.
The current version of AP is not using the below interface but still kept the details for nontemplate customers to customize and use the same if they are still using this integration.
Interface Name: RSE_ASSORT_ELASTICITY_EXP
| Table Column | Data Type | Comments | Dimension / Measure / Value Mapping |
|---|---|---|---|
| RUN_ID | Number(10) | The export Run ID as obtained from the RAP_INTF_UTIL. | |
| LOC_HIER_LEVEL | Varchar2(30) | The location hierarchy level data is for COMPANY, CHAIN, AREA, REGION, DISTRICT, LOCATION, and CHANNEL_COUNTRY. | CHANNEL_COUNTRY |
| PROD_HIER_LEV EL | Varchar2(30) | The product hierarchy level the data is for CMP, DIV, GRP, DEPT, CLS, SBC, STYLE, STYLE_COLOR, and ITEM. | SBC |
| LOC_EXT_KEY | Varchar2(80) | The external id of the location. It will use the integration ids as provided to RI. | CHNC |
| PROD_EXT_KEY | Varchar2(80) | The external id of the product hierarchy. It will use the integration ids as provided to RI (preferably the RMS id, and not an integration id such as CLS | SCLS |
| CUSTSEG_EXT_K EY | Varchar2(80) | The external id of the customer segment. | CSGD |
| ASSORT_ELASTIC ITY | Number(38,20) | The assortment elasticity which DT has calculated. | DRTYASSRTELASV |
Table Column Data Type Comments Dimension / Measure / Value Mapping EFFECTIVE_DT_F Date The date when this data was activated. ROM
Interface Name: RSE_ASSORT_ATTR_WGT_EXP
| Table Column | Data Type | Comments | Dimension / Measure / Value Mapping |
|---|---|---|---|
| RUN_ID | Number(10) | The export Run ID as obtained from the RAP_INTF_UTIL. | |
| LOC_HIER_LEVEL | Varchar2(30) | The location hierarchy level data is for COMPANY, CHAIN, AREA, REGION, DISTRICT, LOCATION, and CHANNEL_COUNTRY. | CHANNEL_COUNTRY |
| PROD_HIER_LEV EL | Varchar2(30) | The product hierarchy level the data is for CMP, DIV, GRP, DEPT, CLS, SBC, STYLE, STYLE_COLOR, and SKU. | SBC |
| LOC_EXT_KEY | Varchar2(80) | The external id of the location. It will use the integration ids as provided to RI (preferably the RMS id, and not an integration id such as AREA~123). | CHNL |
| PROD_EXT_KEY | Varchar2(80) | The external id of the product hierarchy. It will use the integration ids as provided to RI (preferably the RMS id, and not an integration id such as CLS | SCLS |
| CUSTSEG_EXT_K EY | Varchar2(80) | The external id of the customer segment. It will be NULL if not applicable. | CSGD |
| PROD_ATTR_GRP _EXT_KEY | Varchar2(80) | The external ID for the product attribute. | PATT |
| ATTR_WGT | Number(38,20) | The attribute weight. | DRTYATTRWGTV |
| FUNC_ATTR_FLG | Varchar2(1) | Y/N Flag indicating this is a functional attribute. A functional attribute is one which fits a specific purpose and cannot be substituted by other products with other values for this attribute. | DRTYFUNCFITB |
Import Location Clusters from AI Foundation
Location Clusters can be defined in AI Foundation and can be interfaced to APCS. The APCS template version also supports defining Location Clusters within the application. AI Foundation allows defining clusters at different levels across the product hierarchy but the APCS template version allows interfacing clusters defined at the department level. Location Clusters are defined for a date range and those date ranges can be defined as Assortment Periods in APCS and the same can be exported to AI Foundation to define the Location Clusters. For more details, see Export Assortment Periods for Location Clustering to AI Foundation.
In order to get location clusters from AI Foundation, during implementation, some initial setups need to be done in the AI Foundation platform. For more details, see the Oracle Retail Analytics and Planning Integration Implementation Guide .
The following table shows the interface table column details from AI Foundation in RDX used for the interface and the corresponding mapping of columns in APCS. Only mapped columns are used by the APCS template version. If RAP integration is enabled and if Enable RSE Cluster Integration is set to true, then this interface will run as part of the weekly batch.
Interface Name: RSE_LOC_CLUSTER_EXP
| Table Column | Data Type | Comments | Dimension / Measure / Value Mapping |
|---|---|---|---|
| RUN_ID | Number(10) | The export Run ID as obtained from the RAP_INTF_UTIL. | |
| LOC_HIER_LEVEL | Varchar2(30) | The location hierarchy level data is for COMPANY, CHAIN, AREA, REGION, DISTRICT, and LOCATION. | LOCATION |
| PROD_HIER_LEV EL | Varchar2(30) | The product hierarchy level the data is for CMP, DIV, GRP, DEPT, CLS, SBC, STYLE, STYLE_COLOR, and ITEM. | DEPT |
| LOC_EXT_KEY | Varchar2(80) | The external id of the location. It will use the integration ids as provided to RI (preferably the RMS id, and not an integration id such as AREA~123). | STOR |
| PROD_EXT_KEY | Varchar2(80) | The external id of the product hierarchy. It will use the integration ids as provided to RI (preferably the RMS id, and not an integration id such as CLS | DEPT |
| EFF_START_DT | Date | The starting date which the cluster is effective. | WEEK, DRDVSRTD |
| EFF_END_DT | Date | The ending date for which the cluster is effective. | DRDVENDD |
| CLUSTER_ID | Number(10) | The identifier for the cluster. | DRDVSTRCLUST |
| CLUSTER_LABEL | Varchar2(50) | A descriptive name/label for the cluster. | DRDVSTRCLUSL |
Import Size Profiles from AI Foundation
Size Profiles can be defined in AI Foundation and can be interfaced to APCS. The previous version of the APCS template version used Size Profiles defined from AIF or the size profiles set at the Admin level within the application. The APCS template version imports size profiles from AIF at the sub-class level. It is used to define Buy Quantity by Size and Receipts by Sizes while planning them.
In order to get Size Profiles from AI Foundation, during implementation, some initial setups need to be done in the AI Foundation platform. For more details, see the Oracle Retail Analytics and Planning Integration Implementation Guide .
The following table shows the interface table column details from AI Foundation in RDX used for the interface and the corresponding mapping of columns in APCS. Only mapped columns are used by the APCS template version. For complete details of all available columns, see the Oracle Retail Analytics and Planning Integration Implementation Guide . If RAP integration is enabled and Enable RSE Size Profile Integration is set to true, then this interface will run as part of the weekly batch. If integration is enabled, it will use the same interface table data to also load the Size Hierarchy file (SIZH) using the internal view VW_SIZH_HIER and then also load the Size Profile.
The current version of AP is not using the below interface but still kept the details for nontemplate customers to customize and use the same if they are still using this integration.
Interface Name: RSE_SIZE_PROFILE_EXP
| Table Column | Data Type | Comments | Dimension / Measure / Value Mapping |
|---|---|---|---|
| RUN_ID | Number(10) | The export Run ID as obtained from the RAP_INTF_UTIL. | |
| LOC_LEVEL_NAM E | Varchar2(255) | The location hierarchy level data is for COMPANY, CHAIN, AREA, REGION, DISTRICT, and LOCATION. | LOCATION |
| PROD_LEVEL_NA ME | Varchar2(255) | The product hierarchy level the data is for CMP, DIV, GRP, DEPT, CLS, SBC, STYLE, and STYLE_COLOR. | SBC |
| LOC_EXT_KEY | Varchar2(80) | The external id of the location. It will use the integration ids as provided to RI (preferably the RMS id, and not an integration id such as AREA~123). | STOR |
| PROD_EXT_KEY | Varchar2(80) | The external id of the product hierarchy. It will use the integration ids as provided to RI (preferably the RMS id, and not an integration id such as CLS | SCLS |
| SIZE_EXT_ID | Number(10) | Size External Identifier | SIZD |
| SIZE_PCT_UNITS | Number(10,5) | Size Profile Percentage | DRDVSIZE |
| USED_BY_AIP | Varchar2(1) | Flag to indicate that record is for AIP Y | PRFP |
| SIZE_LABEL | Varchar2(255) | Size Label | SIZD_LABEL |
| SIZE_GROUP_ID | Varchar2(255) | Size Group Identifier | SRNG |
| SIZE_GROUP_LA BEL | Varchar2(255) | Size Group Label | SRNG_LABEL |
Note
For Size Hierarchy (sizh), the internal view (VW_SIZE_HIER) is defined against the AIF RSE_SIZE_PROFILE_EXP table to get the unique sizes (SIZE_EXT_ID, SIZE_LABEL) and size ranges (SIZE_GROUP_ID and SIZE_GROUP_LABEL) which are marked to be used AP (USED_BY_AIP flag as ‘Y’).
SIZE_EXT_LABEL, also available as part of this view, can be used instead of SIZE_LABEL to get extended labels for sizes from AIF.
Export Assortment Periods for Location Clustering to AI Foundation
In the APCS template version, the customer can define the Assortment periods at pre-defined product levels (DEPT). Assortment Periods are date ranges to plan the assortments; it can vary for different product levels. The customer can export the defined Assortment Periods by enabling the Boolean measure Export Period for Clustering at the Assortment Period level.
In order to import and use this data from AI Foundation, during implementation, some initial setups need to be done in the AI Foundation platform. For more details, see the Oracle Retail Analytics and Planning Integration Implementation Guide .
The following table shows the interface tables and column details from APCS in RDX used for the interface and the corresponding mapping of columns in APCS. Only mapped columns are used by the APCS template version. If RAP integration is enabled and if Enable RSE Cluster Integration is set to true, then this interface will run as part of the weekly batch.
Interface Name: AP_ASSORT_PERIOD_EXP
| Table Column | Data Type | Comments | Dimension / Measure / Value Mapping |
|---|---|---|---|
| RUN_ID | Number(10) | The export Run ID as obtained from the RAP_INTF_UTIL. | |
| PROD_LEVEL | Varchar2(80) | The product hierarchy level the data is for CMP, DIV, GRP, DEPT, CLS, SBC, STYLE, STYLE_COLOR, and SKU. | DEPT |
| PROD_KEY | Varchar2(80) | Product Identifier | DEPT |
| LOC_LEVEL | Varchar2(80) | The location hierarchy level data is for COMPANY, CHAIN, AREA, REGION, DISTRICT, and LOCATION. | COMPANY |
| LOC_KEY | Varchar2(80) | Location Identifier | COMP |
| ASSORT_PERIOD _KEY | Varchar2(80) | Assortment Period Key | BPER |
| ASSORT_PERIOD _START_DATE | Date | Assortment Period Start Date | BCDVSRTD |
| ASSORT_PERIOD _END_DATE | Date | Assortment Period End Date | BCDVENDD |
| EXT_NAME | Varchar2(80) | External Cluster Name | BCDVCLUSTERT |
| CLUSTER_DESCR | Varchar2(255) | Cluster Description | BCDVPRDL |
Export Active Assortments to AI Foundation
In the APCS template version, the customer can plan active assortments for an assortment period and those details can be exported to AI Foundation at the Item/Store level.
In order to import and use this data from AI Foundation, during implementation, some initial setups need to be done in the AI Foundation platform. For more details, see the Oracle Retail Analytics and Planning Integration Implementation Guide .
The following table shows the interface tables and column details from APCS in RDX used for the interface and the corresponding mapping of columns in APCS. Only mapped columns are used by the APCS template version. If RAP integration is enabled, then this interface will run as part of the weekly batch.
Interface Name: AP_ACTIVE_ASSORT_EXP
| Table Column | Data Type | Comments | Dimension / Measure / Value Mapping |
|---|---|---|---|
| RUN_ID | Number(10) | The export Run ID as obtained from the RAP_INTF_UTIL. |
| Table Column | Data Type | Comments | Dimension / Measure / Value Mapping |
|---|---|---|---|
| PROD_KEY | Varchar2(80) | Product Identifier | SKU |
| LOC_KEY | Varchar2(80) | Location Identifier | STOR |
| PROD_LEVEL | Varchar2(80) | The product hierarchy level the data is for CMP, DIV, GRP, DEPT, CLS, SBC, STYLE, STYLE_COLOR, and SKU. | ITEM |
| LOC_LEVEL | Varchar2(80) | The location hierarchy level data is for COMPANY, CHAIN, AREA, REGION, DISTRICT, and LOCATION. | LOCATION |
| ACTIVE_START_D ATE | Date | Active Assortment Start Date | BPDBSRTD |
| ACTIVE_END_DAT E | Date | Active Assortment End Date | BPDBENDD |
Export Assortment Groups to AI Foundation
In the APCS template version, the customer can define the Assortment Groups at pre-defined product levels (DEPT). Assortment Groups are a unique combination of Assortment Period and Associated Location Clusters defined in the Assortment Period Setup workbook. That is used by AI Foundation in order to Optimize Sales data and calculate Option Counts and Sales Potential data that is later used by the AP solution custom menu’s using web service calls.
To import and use this data from AI Foundation, during implementation, some initial setups need to be done in the AI Foundation platform. For more details, see the Oracle Retail Analytics and Planning Integration Implementation Guide .
The following table shows the interface tables and column details from APCS in RDX used for the interface and the corresponding mapping of columns in APCS. Only mapped columns are used by the APCS template version. If RAP integration is enabled, then this interface will run as part of the daily/weekly batch.
Interface Name: AP_ASSORT_GROUP_EXP
| Table Column | Data Type | Comments | Dimension/ Measure/Value Mapping |
|---|---|---|---|
| RUN_ID | Number(10) | The export Run ID as obtained from the RAP_ INTF_UTIL. | |
| LOC_HIER_LEVEL | Varchar2(30) | The location hierarchy level data is for COMPANY, CHAIN, AREA, REGION, DISTRICT, and LOCATION. | LOCATION |
| PROD_HIER_LEVEL | Varchar2(30) | The product hierarchy level the data is for CMP, DIV, GRP, DEPT, CLS, and SBC. | DEPT |
| LOC_EXT_KEY | Varchar2(80) | The external id of the location. | STOR |
| PROD_EXT_KEY | Varchar2(80) | The external id of the product hierarchy. | DEPT |
| EFF_START_DATE | Date | The starting date which the cluster is effective. | APCS_BGDVSRTD |
| EFF_END_DATE | Date | The ending date for which the cluster is effective. | APCS_BGDVENDD |
| ASSORT_PERIOD_I D | Varchar2(80) | Assort Period Id used in AP. | BPER |
| Table Column | Data Type | Comments | Dimension/ Measure/Value Mapping |
|---|---|---|---|
| ASSORT_PERIOD_L ABEL | Varchar2(255) | Assort Period User Label. | APCS_BGDVPRDL |
| ASSORT_GROUP_I D | Varchar2(80) | Unique Id to group Product/Assort Period/Cluster Grouping based on Approval Date. | APCS_BGDVPRDT |
| ASSORT_PROD_LE VEL | Varchar2(80) | The product hierarchy level for Assortment Strategy. | SBC |
| CLUSTER_ID | Varchar2(80) | Unique identifier for the cluster. | APCS_BGDVSTRCL UST |
| CLUSTER_LABEL | Varchar2(255) | A descriptive name/label for the cluster used in AP. | APCS_BGDVSTRCL USL |
Export Assortment Plans to Retail Insights
Approved plans from APCS can be exported to Retail Insights within RAP integration. The APCS template version allows creating and exporting plans at the week/store/style-color level for both different versions. Plans for different versions can be exported to Retail Insights on a weekly basis. It exports all the approved plans for the unelapsed periods. With the AP nontemplate version, customers can create a different level of plans and they can also configure various metrics. The interface staging table in Retail Sights contains more metrics columns and various flex columns. The customer can update and configure the interface.cfg mappings to export additional columns that can be used by Retail Insights.
For more details about the list of columns available in the Retail Insights Interface Staging table if the customer plans to use extensibility or use the non-template version to send additional data, see the Oracle Retail Insights Implementation Guide . This guide contains only the mapped columns for the APCS template version.
This plan is one table for one level and uses the VERSION_NUM to differentiate different versions for the same level of data, such as WP and CP versions, for exporting both the OP and CP versions of the approved Assortment Plan.
Only AP_PLAN2_EXP is used by the AP template version to export plans at the Style-Color/ Store/Week level. The AP_PLAN1_EXP table and interface is still available for non-template version customers if they want to customize and do exports at the Item/Store/Week level.
Interface Name: AP_PLAN2_EXP
-
Plan Level: Style-Color/Store/Week
-
Plan Version: AF CP
-
Plan Version Number: 2
-
Export Filter: APCS_APCPEXPORTB
| Table Column | Table Column | Data Type | Nullable | Comments | AP Fact Mapping |
|---|---|---|---|---|---|
| RUN_ID | Interface Run Identifier | Number(10) | N | The export Run ID as obtained from the RAP_INTF_UTI L |
| Table Column | Table Column | Data Type | Nullable | Comments | AP Fact Mapping |
|---|---|---|---|---|---|
| PROD_KEY | Product Dimension | VARCHAR2(80) | N | Dimension STYL from PROD | APCS_APHDP SKUGT |
| LOC_KEY | Location Dimension | VARCHAR2(80) | N | Dimension STOR from LOC | |
| CLND_KEY | Calendar Dimension | VARCHAR2(80) | N | Dimension WEEK from CLND | |
| PROD_DH_ATTR | Attribute Dimension for RI | VARCHAR2(80) | N | Color Attribute | APCS_APHDP COLORT |
| SUPPLIER_NUM | Supplier Dimension for RI | VARCHAR2(80) | N | Defaulted to -1 | |
| CAL_DATE | Last Day of Week | Date | N | Last Date of CLND_KEY as Date | APCS_APHDP WKED |
| VERSION_NUM | Version Number | Number(10) | N | Defaulted to 2 | |
| PROD_LEVEL | Product Level | VARCHAR2(80) | Defaulted to COLOR | ||
| LOC_LEVEL | Location Level | VARCHAR2(80) | Defaulted to LOCATION | ||
| FLEX1_CHAR_VALUE | Style-Color Id | VARCHAR2(80) | Dimension SKUP from PROD | ||
| SLS_QTY | AF Cp Sales U | NUMBER(20,4) | APCS_APCPS LSU | ||
| SLS_RTL_AMT | AF Cp Sales R | NUMBER(20,4) | APCS_APCPS LSR | ||
| SLS_COST_AMT | AF Cp Sales C | NUMBER(20,4) | APCS_APCPS LSC | ||
| ASRT_INTENT | AF Cp Item Intent | VARCHAR2(80) | APCS_APCPIN TENTT | ||
| ASRT_STATUS | AF Cp Item Status | VARCHAR2(80) | APCS_APCPS TATUST | ||
| ASRT_FLAG | AF Cp Option Assorted | VARCHAR2(80) | APCS_APCPA SRTSKUPB | ||
| ASRT_COUNT | AF Cp Option Assorted Count | NUMBER(18,4) | APCS_APCPA SRTSKUPCT | ||
| PLAN_START_DATE | AF Cp Week Start | DATE | APCS_APCPS RTD | ||
| PLAN_END_DATE | AF Cp Week End | DATE | APCS_APCPE NDD | ||
| • • | Plan Level: Style-Color Plan Version: AF WP | /Store/Week |
-
Plan Version Number: 3
-
Export Filter: APCS_APWPEXPORTB
| Table Column | Table Column | Data Type | Nullable | Comments | AP Fact Mapping |
|---|---|---|---|---|---|
| RUN_ID | Interface Run Identifier | Number(10) | N | The export Run ID as obtained from the RAP_INTF_UTI L | |
| PROD_KEY | Product Dimension | VARCHAR2(80) | N | Dimension STYL from PROD | APCS_APHDP SKUGT |
| LOC_KEY | Location Dimension | VARCHAR2(80) | N | Dimension STOR from LOC | |
| CLND_KEY | Calendar Dimension | VARCHAR2(80) | N | Dimension WEEK from CLND | |
| PROD_DH_ATTR | Attribute Dimension for RI | VARCHAR2(80) | N | Color Attribute | APCS_APHDP COLORT |
| SUPPLIER_NUM | Supplier Dimension for RI | VARCHAR2(80) | N | Defaulted to -1 | |
| CAL_DATE | Last Day of Week | Date | N | Last Date of CLND_KEY as Date | APCS_APHDP WKED |
| VERSION_NUM | Version Number | Number(10) | N | Defaulted to 3 | |
| PROD_LEVEL | Product Level | VARCHAR2(80) | Defaulted to COLOR | ||
| LOC_LEVEL | Location Level | VARCHAR2(80) | Defaulted to LOCATION | ||
| FLEX1_CHAR_VALUE | Style-Color Id | VARCHAR2(80) | Dimension SKUP from PROD | ||
| SLS_QTY | AF Wp Sales U | NUMBER(20,4) | APCS_APWPS LSU | ||
| SLS_RTL_AMT | AF Wp Sales R | NUMBER(20,4) | APCS_APWPS LSR | ||
| SLS_COST_AMT | AF Wp Sales C | NUMBER(20,4) | APCS_APWPS LSC | ||
| ASRT_INTENT | AF Wp Item Intent | VARCHAR2(80) | APCS_APWPI NTENTT | ||
| ASRT_STATUS | AF Wp Item Status | VARCHAR2(80) | APCS_APWPS TATUST | ||
| ASRT_FLAG | AF Wp Option Assorted | VARCHAR2(80) | APCS_APWPA SRTSKUPB | ||
| ASRT_COUNT | AF Wp Option Assorted Count | NUMBER(18,4) | APCS_APWPA SRTSKUPCT | ||
| PLAN_START_DATE | AF Wp Week Start | DATE | APCS_APWPS RTD | ||
| PLAN_END_DATE | AF Wp Week End | DATE | APCS_APWPE NDD |
-
Plan Level: Style-Color/Store/Week
-
Plan Version: IF CP
-
Plan Version Number: 4
-
Export Filter: APCS_ISCPEXPORTB
| Table Column | Table Column | Data Type | Nullable | Comments | AP Fact Mapping |
|---|---|---|---|---|---|
| RUN_ID | Interface Run Identifier | Number(10) | N | The export Run ID as obtained from the RAP_INTF_UTI L | |
| PROD_KEY | Product Dimension | VARCHAR2(80) | N | Dimension STYL from PROD | APCS_APHDP SKUGT |
| LOC_KEY | Location Dimension | VARCHAR2(80) | N | Dimension STOR from LOC | |
| CLND_KEY | Calendar Dimension | VARCHAR2(80) | N | Dimension WEEK from CLND | |
| PROD_DH_ATTR | Attribute Dimension for RI | VARCHAR2(80) | N | Color Attribute | APCS_APHDP COLORT |
| SUPPLIER_NUM | Supplier Dimension for RI | VARCHAR2(80) | N | Defaulted to -1 | |
| CAL_DATE | Last Day of Week | Date | N | Last Date of CLND_KEY as Date | APCS_APHDP WKED |
| VERSION_NUM | Version Number | Number(10) | N | Defaulted to 4 | |
| PROD_LEVEL | Product Level | VARCHAR2(80) | Defaulted to COLOR | ||
| LOC_LEVEL | Location Level | VARCHAR2(80) | Defaulted to LOCATION | ||
| FLEX1_CHAR_VALUE | Style-Color Id | VARCHAR2(80) | Dimension SKUP from PROD | ||
| SLS_QTY | IF Cp Sales U | NUMBER(20,4) | APCS_ISCPSL S1U | ||
| SLS_RTL_AMT | IF Cp Sales R | NUMBER(20,4) | APCS_ISCPSL S1R | ||
| SLS_COST_AMT | IF Cp Sales C | NUMBER(20,4) | APCS_ISCPSL S1C | ||
| EOH_COST_AMT | IF Cp EOP C | NUMBER(20,4) | APCS_ISCPEO PC | ||
| EOH_RTL_AMT | IF Cp EOP R | NUMBER(20,4) | APCS_ISCPEO PR | ||
| EOH_QTY | IF Cp EOP U | NUMBER(20,4) | APCS_ISCPEO PU | ||
| INVRC_COST_AMT | IF Cp Rcpt C | NUMBER(20,4) | APCS_ISCPRC PTC | ||
| INVRC_RTL_AMT | IF Cp Rcpt R | NUMBER(20,4) | APCS_ISCPRC PTR | ||
| INVRC_QTY | IF Cp Rcpt U | NUMBER(20,4) | APCS_ISCPRC PTU | ||
| PLAN_START_DATE | IF Cp Week Start | DATE | APCS_ISCPSR TD | ||
| PLAN_END_DATE | IF Cp Week End | DATE | APCS_ISCPEN DD |
-
Plan Level: Style-Color/Store/Week
-
Plan Version: IF WP
-
• Plan Version Number: 5
-
Export Filter: APCS_ISWPEXPORTB
| Table Column | Table Column | Data Type | Nullable | Comments | AP Fact Mapping |
|---|---|---|---|---|---|
| RUN_ID | Interface Run Identifier | Number(10) | N | The export Run ID as obtained from the RAP_INTF_UTI L | |
| PROD_KEY | Product Dimension | VARCHAR2(80) | N | Dimension STYL from PROD | APCS_APHDP SKUGT |
| LOC_KEY | Location Dimension | VARCHAR2(80) | N | Dimension STOR from LOC | |
| CLND_KEY | Calendar Dimension | VARCHAR2(80) | N | Dimension WEEK from CLND | |
| PROD_DH_ATTR | Attribute Dimension for RI | VARCHAR2(80) | N | Color Attribute | APCS_APHDP COLORT |
| SUPPLIER_NUM | Supplier Dimension for RI | VARCHAR2(80) | N | Defaulted to -1 | |
| CAL_DATE | Last Day of Week | Date | N | Last Date of CLND_KEY as Date | APCS_APHDP WKED |
| VERSION_NUM | Version Number | Number(10) | N | Defaulted to 4 | |
| PROD_LEVEL | Product Level | VARCHAR2(80) | Defaulted to COLOR | ||
| LOC_LEVEL | Location Level | VARCHAR2(80) | Defaulted to LOCATION | ||
| FLEX1_CHAR_VALUE | Style-Color Id | VARCHAR2(80) | Dimension SKUP from PROD | ||
| SLS_QTY | IF Wp Sales U | NUMBER(20,4) | APCS_ISWPSL S1U | ||
| SLS_RTL_AMT | IF Wp Sales R | NUMBER(20,4) | APCS_ISWPSL S1R | ||
| SLS_COST_AMT | IF Wp Sales C | NUMBER(20,4) | APCS_ISWPSL S1C | ||
| EOH_COST_AMT | IF Wp EOP C | NUMBER(20,4) | APCS_ISWPE OPC | ||
| EOH_RTL_AMT | IF Wp EOP R | NUMBER(20,4) | APCS_ISWPE OPR | ||
| EOH_QTY | IF Wp EOP U | NUMBER(20,4) | APCS_ISWPE OPU | ||
| INVRC_COST_AMT | IF Wp Rcpt C | NUMBER(20,4) | APCS_ISWPR CPTC | ||
| INVRC_RTL_AMT | IF Wp Rcpt R | NUMBER(20,4) | APCS_ISWPR CPTR |
| Table Column | Table Column | Data Type | Nullable | Comments | AP Fact Mapping |
|---|---|---|---|---|---|
| INVRC_QTY | IF Wp Rcpt U | NUMBER(20,4) | APCS_ISWPR CPTU | ||
| PLAN_START_DATE | IF Wp Week Start | DATE | APCS_ISWPS RTD | ||
| PLAN_END_DATE | IF Wp Week End | DATE | APCS_ISWPE NDD |
-
Plan Level: Style-Color/Store/Week
-
Plan Version: Rec Opt
-
Plan Version Number: 6
-
Export Filter: APCS_ARDBEXPORTB
| Table Column | Table Column | Data Type | Nullable | Comments | AP Fact Mapping |
|---|---|---|---|---|---|
| RUN_ID | Interface Run Identifier | Number(10) | N | The export Run ID as obtained from the RAP_INTF_UTI L | |
| PROD_KEY | Product Dimension | VARCHAR2(80) | N | Dimension STYL from PROD | APCS_APHDP SKUGT |
| LOC_KEY | Location Dimension | VARCHAR2(80) | N | Dimension STOR from LOC | |
| CLND_KEY | Calendar Dimension | VARCHAR2(80) | N | Dimension WEEK from CLND | |
| PROD_DH_ATTR | Attribute Dimension for RI | VARCHAR2(80) | N | Color Attribute | APCS_APHDP COLORT |
| SUPPLIER_NUM | Supplier Dimension for RI | VARCHAR2(80) | N | Defaulted to -1 | |
| CAL_DATE | Last Day of Week | Date | N | Last Date of CLND_KEY as Date | APCS_APHDP WKED |
| VERSION_NUM | Version Number | Number(10) | N | Defaulted to 5 | |
| PROD_LEVEL | Product Level | VARCHAR2(80) | Defaulted to COLOR | ||
| LOC_LEVEL | Location Level | VARCHAR2(80) | Defaulted to LOCATION | ||
| FLEX1_CHAR_VALUE | Style-Color Id | VARCHAR2(80) | Dimension SKUP from PROD | ||
| SLS_QTY | Rec Sales Potential U | NUMBER(20,4) | APCS_ARDBS LSPOTU | ||
| SLS_RTL_AMT | Rec Sales Potential R | NUMBER(20,4) | APCS_ARDBS LSPOTR | ||
| SLS_COST_AMT | Rec Sales Potential C | NUMBER(20,4) | APCS_ARDBS LSPOTC |
| Table Column | Table Column | Data Type | Nullable | Comments | AP Fact Mapping |
|---|---|---|---|---|---|
| ASRT_FLAG | Rec Option Assorted | VARCHAR2(80) | APCS_ARDBA SRTSK |
AIF Integration using a Web Service
Customers can use AIF to calculate the Optimized History, Option Counts and Sales Potential that are used by AP during the Assortment Fit Process. The Optimized History/Option Count and Sale Potential can be interfaced to AP.
Before using the web service calls in AP, AP needs to export the Assortment Group that is the combination of unique Assortment Periods and Location Clusters. It runs as part of the daily batch and AIF also needs additional setups during implementation to run those Option Forecasts in the nightly batch. For more details, see the Oracle Retail Analytics and Planning Integration Implementation Guide .
Generated Option Forecasts/Optimized Sales/Sales Potential from AIF can be interfaced using the custom menu planning actions, directly into relevant workspaces that are pre-configured to get the data through internal web service calls using the standard RPAS web service framework.
The RPAS web service framework uses the configured serviceConfig.json file, which can be used to map the RPAS dimensions/measures that are used in workbook templates against the keys present in web service requests and responses for web services created within RAP; the same web service can be triggered using the custom menu from those templates. For more details about the mapping of serviceConfig.json, see the Service Config Definitions section in the Deployment Tool chapter in the Oracle Retail Predictive Application Server Cloud Edition Configuration Tools User Guide .
On successful connection using a web service call, an Admin task with the name <service_name> from workbook <workbook_name> will be available in OAT. It shows the calls triggered from the template with the details of contents in the web service request and response in JSON format. Sample request and response triggered from the custom menu are provided in the examples below. The same OAT log can be used to debug any issues during the transfer of data using web service calls if the response has any errors due to any issues.
Following are the details of the two configured web services with AIF for the AP GA configuration.
WebService for Optimized History/Option Count
AIF Service Name: /app/rgbuaifpyapwebservice/optioncountinference
AP Service Name: AIFService1
Service Version: dis
The following tables shows the key fields present in the web service request and response, and the corresponding mapped measures in AP GA.
Web Service Request Input Key Mappings
| Key/Parameter | Data Type | GA Intersection | Description | Mapped Measure |
|---|---|---|---|---|
| asrtReqId | VARCHAR2(250) | Dept/Assort Period | Assortment | aft1asrtidt |
| Request Id |
| Key/Parameter | Data Type | GA Intersection | Description | Mapped Measure |
|---|---|---|---|---|
| asrtLabel asrtProdId | VARCHAR2(250) VARCHAR2(80) | Dept/Assort Period Dept/Assort Period | Assortment Label Assortment Parent Product Dimension. Department Position Id will be used in AP. | aft1asrtidl aft1prodkeyt |
| asrtPeriod | VARCHAR2(80) | Dept/Assort Period | Assort Period Dimension Id used in AP | aft1asrtlblt |
| asrtGroupId | VARCHAR2(80) | Dept/Assort Period | Assortment Group Id | aft1prdt |
| attrTypeIdList | VARCHAR2(80) | Dept/Assort Period | List of Eligible Product Attribute Type Id’s | aft1prdattt |
| prodList | Dept/Assort Period | Collection for List of Product/Store Cluster | aft1clusidb | |
| prodId | VARCHAR2(80) | Subclass/Assort Period/ Store Cluster | Product Id | bwdbprodkeyt |
| storClusId | VARCHAR2(80) | Subclass/Assort Period/ Store Cluster | Store Cluster Id | bwdbclusidt |
| keyStorId | VARCHAR2(80) | Subclass/Assort Period/ Store Cluster | One Sample Key Store Id with in Store Cluster against which to receive the data. | afdbclusidt |
| tgtSls | NUMBER(20,4) | Subclass/Assort Period/ Store Cluster | Target Sales Units | afdbtgtslsu |
| fcstSls | NUMBER(20,4) | Subclass/Assort Period/ Store Cluster | Forecasted Sales Units | afdbfcstslsu |
| histSls | NUMBER(20,4) | Subclass/Assort Period/ Store Cluster | Historical Sales Units | afdbhistslsu |
| attrSlsThr | NUMBER(20,4) | Subclass/Assort Period/ Store Cluster | Optional Historic Sales Threshold % for Attributes Values to Recommend. | afdbattrslsthrp |
Web Service Response Output Key Mappings
| Key/Parameter | Data Type | GA Intersection | Description | Mapped Measure |
|---|---|---|---|---|
| asrtStgyRecOptHeader | Dept/Assort Period | Collection for the Main Request Response Header | ||
| responseCode | VARCHAR2(80) | Dept/Assort Period | Ex: 200 - For Successful Processing of Data | aft1respcodet |
| Key/Parameter | Data Type | GA Intersection | Description | Mapped Measure |
|---|---|---|---|---|
| responseCodeMessage | VARCHAR2(255) | Dept/Assort Period | Detailed Response Message for Request | aft1respcodel |
| asrtStgyRecOptDetail | Dept/Assort Period | Collection for the Main Request Response Details | ||
| asrtReqId | VARCHAR2(80) | Dept/Assort Period | Same asrtReqId provided in the input request | aft2asrtidt |
| asrtProdId | VARCHAR2(80) | Dept/Assort Period | Same asrtProdId provided in the input request | dept |
| asrtPeriod | VARCHAR2(80) | Dept/Assort Period | Same asrtPeriod provided in the input request | bper |
| asrtGroupId | VARCHAR2(80) | Dept/Assort Period | Assortment Group Unique Id to link Prod/Assort Period/Store Clusters | aft2prdt |
| prodCnt | NUMBER(10,0) | Dept/Assort Period | Number of SubClass/Store Clusters in the request for the Dept. | afdvprdct |
| prodList | Subclass/Assort Period/ Store Cluster | Collection for List of Products/Store Cluster | ||
| prodId | VARCHAR2(80) | Subclass/Assort Period/ Store Cluster | Same product Id provided in the input request | scls |
| storClusId | VARCHAR2(80) | Subclass/Assort Period/ Store Cluster | Same Store Cluster Id provided in the input request | bwdbclusidt |
| storId | VARCHAR2(80) | Subclass/Assort Period/ Store Cluster | One Store Id with in the Store Cluster | stor |
| optTtlSls | NUMBER(20,4) | Subclass/Assort Period/ Store Cluster | Optimized Total Sales | aft1optslsu |
| optTtlCnt | NUMBER(20,4) | Subclass/Assort Period/ Store Cluster | Optimized Sales Option Count | aft1recoptnct |
| tgtTtlCnt | NUMBER(20,4) | Subclass/Assort Period/ Store Cluster | Target Sales Option Count | aft1tgtttlct |
| histTtlCnt | NUMBER(20,4) | Subclass/Assort Period/ Store Cluster | Actual Sales Option Count | aft1histttlct |
| fcstTtlCnt | NUMBER(20,4) | Subclass/Assort Period/ Store Cluster | Forecast Sales Option Count | aft1fcstttlct |
| statusCode | VARCHAR2(255) | Subclass/Assort Period/ Store Cluster | Status Code to capture any errors at detail level. | aft1statcodet |
| Key/Parameter | Data Type | GA Intersection | Description | Mapped Measure |
|---|---|---|---|---|
| statusMessage | VARCHAR2(255) | Subclass/Assort Period/ Store Cluster | Status Message to capture any errors at detail level. | aft1statcodel |
| attrTypeList | Subclass/Assort Period/ Store Cluster | |||
| attrTypeId | VARCHAR2(80) | Subclass/Assort Period/ Store Cluster/Attribute Type | Collection for Attribute Types | patt |
| attrTypeWgt | NUMBER(20,4) | Subclass/Assort Period/ Store Cluster/Attribute Type | Attribute Type Weight calculated in Science for Recommending this Attribute | aft1attrtypev |
| attrList | Subclass/Assort Period/ Store Cluster/Attribute Type | Collection for Attribute Value List | ||
| attrValue | VARCHAR2(80) | Subclass/Assort Period/ Store Cluster/Attribute Value | Attribute Value Name | aft1attridl |
| attrId | VARCHAR2(80) | Subclass/Assort Period/ Store Cluster/Attribute Value | Attribute Name and ”_” and Attribute Value Name. Unique Id used in Planning for Attribute Values. | patv |
| optAttrSls | NUMBER(20,4) | Subclass/Assort Period/ Store Cluster/Attribute Value | Optimized Attribute Value Sales Units | aft1optattrslsu |
| optAttrMix | NUMBER(20,4) | Subclass/Assort Period/ Store Cluster/Attribute Value | Recommended Attribute Value Mix Percentage | aft1optattrmixv |
Sample Web Service Request Call
{
"asrtStgyRecOptHeader": {
"requestID": "103_ap03_20230507192443",
"rspVersion": "v1",
"timeout": 4.0
},
"asrtReqId": "103_ap03_20230507192443",
"asrtLabel": "SPRING SUMMER 2023",
"asrtProdId": "103",
"asrtPeriod": "ap03",
"asrtGroupId": "103_ap03_20230507",
"attrTypeIdList": [
"brnd",
"color",
"fabric"
],
"prodList": [
{
"prodId": "1030101",
"storClusId": "us_1_52058",
"keyStorId": "1175",
"tgtSls": 0,
"fcstSls": 33592,
"histSls": 76028,
"attrSlsThr": 0.0
},
{
"prodId": "1030202",
"storClusId": "us_1_52058",
"keyStorId": "1175",
"tgtSls": 0,
"fcstSls": 14977,
"histSls": 29254,
"attrSlsThr": 0.0
}
]
}
Sample Web Service Response Call
{
"AsrtStgyRecOptDetail": {
"asrtGroupId": "103_ap03_20230507",
"asrtPeriod": "ap03",
"asrtProdId": "103",
"asrtReqId": "103_ap03_20230507192443",
"prodCnt": 2,
"prodList": [
{
"attrTypeList": [
{
"attrList": [
{
"attrId": "color_pink",
"attrValue": "pink",
"optAttrMix": 0.1364,
"optAttrSls": 212637.0
},
{
"attrId": "color_purple",
"attrValue": "purple",
"optAttrMix": 0.0909,
"optAttrSls": 7542.0
},
{
"attrId": "color_off_white",
"attrValue": "off_white",
"optAttrMix": 0.0227,
"optAttrSls": 30006.0
}
],
"attrTypeId": "color",
"attrTypeWgt": 0.0168
},
{
"attrList": [
{
"attrId": "fabric_wool",
"attrValue": "wool",
"optAttrMix": 0.1364,
"optAttrSls": 74618.0
},
{
"attrId": "fabric_polyester",
"attrValue": "polyester",
"optAttrMix": 0.0682,
"optAttrSls": 113571.0
},
{
"attrId": "fabric_organiccotton",
"attrValue": "organiccotton",
"optAttrMix": 0.2045,
"optAttrSls": 334509.0
}
],
"attrTypeId": "fabric",
"attrTypeWgt": 0.126
}
],
"fcstTtlCnt": 0.6572,
"histTtlCnt": 1.4874,
"keyStorId": "1175",
"optTtlCnt": 21.9848,
"optTtlSls": 1123705,
"prodId": "1030101",
"statusCode": "",
"statusMessage": "",
"storClusId": "us_1_52058",
"tgtTtlCnt": 0.0
},
{
"attrTypeList": [
{
"attrList": [
{
"attrId": "color_white",
"attrValue": "white",
"optAttrMix": 0.075,
"optAttrSls": 4875.0
},
{
"attrId": "color_blue",
"attrValue": "blue",
"optAttrMix": 0.075,
"optAttrSls": 39521.0
},
{
"attrId": "color_maroon",
"attrValue": "maroon",
"optAttrMix": 0.025,
"optAttrSls": 15163.0
}
],
"attrTypeId": "color",
"attrTypeWgt": 0.0338
},
{
"attrList": [
{
"attrId": "fabric_woolsilk",
"attrValue": "woolsilk",
"optAttrMix": 0.025,
"optAttrSls": 15163.0
},
{
"attrId": "fabric_polyester",
"attrValue": "polyester",
"optAttrMix": 0.025,
"optAttrSls": 16810.0
},
{
"attrId": "fabric_merinowool",
"attrValue": "merinowool",
"optAttrMix": 0.125,
"optAttrSls": 46314.0
}
],
"attrTypeId": "fabric",
"attrTypeWgt": 0.0196
}
],
"fcstTtlCnt": 1.4811,
"histTtlCnt": 2.8931,
"keyStorId": "1175",
"optTtlCnt": 39.6602,
"optTtlSls": 401023,
"prodId": "1030202",
"statusCode": "",
"statusMessage": "",
"storClusId": "us_1_52058",
"tgtTtlCnt": 0.0
}
]
},
"asrtStgyRecOptHeader": {
"responseCode": "200",
"responseCodeMessage": "Assortment Strategy - Key Attributes data returned
Successfully"
}
Web Service for Sales Potential
AIF Service Name: /app/rgbuaifpyapwebservice/salespotential
AP Service Name: AIFService2
Service Version: dis
The following tables shows the key fields present in the web service request and response, and the corresponding mapped measures in AP GA.
Web Service Request Input Key Mappings
| Key/Parameter | Data Type | GA Intersection | Description | Mapped Measure |
|---|---|---|---|---|
| asrtReqId | VARCHAR2(80) | Dept/Assort Period | Assortment Request Id | aft1asrtidt |
| asrtProdId | VARCHAR2(80) | Dept/Assort Period | Assortment Parent Product Dimension. Department Position Id will be used in AP. | aft1prodkeyt |
| asrtPeriod | VARCHAR2(80) | Dept/Assort Period | Assort Period Dimension Id used in AP | aft1asrtlblt |
| Key/Parameter | Data Type | GA Intersection | Description | Mapped Measure |
|---|---|---|---|---|
| asrtGroupId | VARCHAR2(80) | Dept/Assort Period | Assortment Group Id | aft1prdt |
| itemLevel | VARCHAR2(80) | Dept/Assort Period | Item Level used in Input - STYL (Style), COLOR (Style-Color) or ITEM (SKU). AP GA will use COLOR for Style- Color | aft1asrtitemt |
| attrTypeIdList | VARCHAR2(80) | Dept/Assort Period | List of Eligible Product Attribute Type Id’s | aft1prdattt |
| storClusCnt | NUMBER(10,0) | Dept/Assort Period | Count of Store- Clusters with in product for this request. | aft1clusidi |
| storClusList | VARCHAR2(80) | Dept/Assort Period | Collection for Store Cluster | afdbclusidb |
| storClusId | VARCHAR2(80) | Dept/Assort Period/Store Cluster | Store Cluster Id | bwt2clusidt |
| keyStorId | VARCHAR2(80) | Dept/Assort Period/Store Cluster | One Sample Key Store Id with in Store Cluster against which to receive the data. | aft2clusidt |
| itemCnt | NUMBER(10,0) | Dept/Assort Period | Count of Items (Style-Color) with in the product for this request. | afdbstatusct |
| itemList | Dept/Assort Period | afdbstatusb | ||
| itemId | VARCHAR2(80) | Style-Color/Assort Period | Item Identifier | bwdvitemidt |
| prodId | VARCHAR2(80) | Style-Color/Assort Period | Product Id | afdvprodkeyt |
| NewItem | VARCHAR2(80) | Style-Color/Assort Period | Y/N. Flag to tell if item if item is new item. For New Items it’s Y else N. | afdvphitmt |
| attrList | VARCHAR2(80) | Style-Color/Assort Period | Attribute List at Style-Color level | afdbprdattrb |
| attrTypeId | VARCHAR2(80) | Style-Color/Assort Period/Attribute Value | Attribute Type Identifier | afdvprdattl |
| attrValueId | VARCHAR2(80) | Style-Color/Assort Period/Attribute Value | Attribute Value Identifier | afdvprdattt |
| Web Service Request Output Key Mappings |
|---|
| Key/Parameter | Data Type | GA Intersection | Description Mapped Measure |
|---|---|---|---|
| asrtFitSlsPHeader | Dept/Assort Period | Collection for the | |
| Main Request | |||
| Response Header |
| Key/Parameter | Data Type | GA Intersection | Description | Mapped Measure |
|---|---|---|---|---|
| responseCode | VARCHAR2(80) | Dept/Assort Period | Ex: 200 - For Successful Processing of Data | aft2respcodet |
| responseCodeMessage | VARCHAR2(255) | Dept/Assort Period | Detailed Response Message for Request | aft2respcodel |
| asrtFitSlsPDetail | Dept/Assort Period | Collection for the Main Request Response Details | ||
| asrtReqId | VARCHAR2(80) | Dept/Assort Period | Same asrtReqId provided in the input request | aft2asrtidt |
| asrtProdId | VARCHAR2(80) | Dept/Assort Period | Same asrtProdId provided in the input request | dept |
| asrtPeriod | VARCHAR2(80) | Dept/Assort Period | Same asrtPeriod provided in the input request | bper |
| asrtGroupId | VARCHAR2(80) | Dept/Assort Period | Assortment Group Unique Id to link Prod/Assort Period/Store Clusters | aft2prdt |
| prodList | Dept/Assort Period | Collection for List of Products/Store Cluster | ||
| prodId | VARCHAR2(80) | Subclass/Assort Period/ Store Cluster | Same product Id provided in the input request | scls |
| storClusId | VARCHAR2(80) | Subclass/Assort Period/ Store Cluster | Same Store Cluster Id provided in the input request | bwdbclusidt |
| keyStorId | VARCHAR2(80) | Subclass/Assort Period/ Store Cluster | One Store Id from the Store Cluster | stor |
| avgROS | NUMBER(20,4) | Subclass/Assort Period/ Store Cluster | Average Rate of Sales | aft2rosv |
| statusCode | VARCHAR2(80) | Subclass/Assort Period/ Store Cluster | Status Code | aft3statcodet |
| statusMessage | VARCHAR2(255) | Subclass/Assort Period/ Store Cluster | Status Message | aft3statcodel |
| itemList | Style-Color/Assort Period/Store Cluster | Collection for Item List | ||
| itemId | VARCHAR2(80) | Subclass/Assort Period/ Store Cluster/Attribute Value | Same Item/Style- Color Id passed in Input | skup |
| itemASlsP | NUMBER(20,4) | StyleColor/Assort Period/ Store Cluster | Average Sales Potential calculated at Item/ Style-Color Level | aft2itemaslspu |
| Key/Parameter | Data Type | GA Intersection | Description | Mapped Measure |
|---|---|---|---|---|
| itemMSlsP | NUMBER(20,4) | StyleColor/Assort Period/ Store Cluster | Maximum Sales Potential calculated at Item/ Style-Color Level | aft2itemmslspu |
| statusCode | VARCHAR2(80) | StyleColor/Assort Period/ Store Cluster | Status Code | aft2statcodet |
| statusMessage | VARCHAR2(255) | StyleColor/Assort Period/ Store Cluster | Status Message | aft2statcodel |
Sample Web Service Request Call
{
"asrtStgyRecOptHeader": {
"requestID": "103_ap03_20230507025519",
"rspVersion": "v1",
"timeout": 4.0
},
"asrtReqId": "103_ap03_20230507025519",
"asrtProdId": "103",
"asrtPeriod": "ap03",
"asrtGroupId": "103_ap03_20230507",
"itemLevel": "COLOR",
"attrTypeIdList": [
"brnd",
"color",
"fabric"
],
"storClusCnt": 2,
"itemCnt": 2,
"storClusList": [
{
"storClusId": "us_1_52056",
"keyStorId": "1117"
},
{
"storClusId": "us_1_52058",
"keyStorId": "1175"
}
],
"itemList": [
{
"itemId": "1101279",
"prodId": "1030201",
"NewItem": "N",
"attrList": [
{
"attrTypeId": "brnd",
"attrValueId": "PrivateLabel"
},
{
"attrTypeId": "color",
"attrValueId": "red"
},
{
"attrTypeId": "fabric",
"attrValueId": "wool"
}
]
},
{
"itemId": "1101282",
"prodId": "1030201",
"NewItem": "N",
"attrList": [
{
"attrTypeId": "brnd",
"attrValueId": "PrivateLabel"
},
{
"attrTypeId": "color",
"attrValueId": "green"
},
{
"attrTypeId": "fabric",
"attrValueId": "cotton"
}
]
}
]
}
Sample Web Service Response Call
"itemASlsP": 400,
"itemMSlsP": 500,
“statusCode”: Null,
“statusMessage”: Null
},
{
"itemId": "1101282",
"itemASlsP": 500,
"itemMSlsP": 600,
“statusCode”: Null,
“statusMessage”: Null
}
],
"keyStorId": "1117",
"prodId": "1030201",
“statusCode”: Null,
“statusMessage”: Null,
"storClusId": "us_1_52056"
},
{
"avgROS": 14000,
"itemList": [
{
"itemId": "1101279",
"itemASlsP": 500,
"itemMSlsP": 600,
“statusCode”: Null,
“statusMessage”: Null
},
{
"itemId": "1101282",
"itemASlsP": 600,
"itemMSlsP": 700,
“statusCode”: Null,
“statusMessage”: Null
}
],
"keyStorId": "1175",
"prodId": "1030201",
“statusCode”: Null,
“statusMessage”: Null,
"storClusId": "us_1_52058"
}
]
},
"AsrtFitSlsPHeader": {
"responseCode": 200,
"responseCodeMessage": "Assortment Fit - Sales Potential data returned
Successfully"
}
}
Implementation Steps with RAP Integration
If RAP integration is enabled in the environment (that is, if the customer is going to get data from RMFCS using RDX integration), follow these steps for implementation. The steps assume that RPAS, RASL, UI, and RDX are already deployed:
1. Run the Batch Process in RAP in Retail Insights (RI) to load the required initial data into the RDX staging tables.
2. Upload any application-specific hierarchy files and data files that are not coming from RDX into Object Storage.
3. Once the AP Cloud Service environment is provisioned, use the bootstrap Build Application task to build the application and use the batch task as set_rdx to just set the Enable RDX Boolean before the initial batch, or run post_hier to enable the RDX Boolean and load/import only the hierarchy files, or run postbuild_rdx to enable the RDX and to load/import initial hierarchy and data files and also run the initial batch. Batch step post_hier can also be run from OAT, to enable the RDX and load the available hierarchy files after building the domain. Use postbuild only if planning to load and use only the GA data set.
4. Schedule the regular weekly flow in the RI, AIF, and Planning applications in JOS/POM to interface the initial data into the application to get data from both RDX and Object Storage.
Note
At least post_hier or postbuild_rdx should be run once with at least the calendar hierarchy file before trying to run the weekly batch using JOS/POM.
In this guide
- Guide: Assortment Planning Cloud Service Implementation Guide
- Previous: 2 Implementation Considerations
- Next: A Appendix: Integration with MFP Cloud Service
Related chapters
- 3 RAP Integration — Merchandise Financial Planning Cloud Service Implementation Guide · shares
AREA_NAME,ATTR_DESC,ATTR_ID,ATTR_VALUE - 1 MFP Batch Task Administration — Merchandise Financial Planning Cloud Service Administration Guide · shares
VW_LOC_DATA,VW_SATR_HIER,W_PDS_CALENDAR_D,W_PDS_INVRC_IT_LC_WK_A - 1 APCS Batch Task Administration — Assortment Planning Cloud Service Administration Guide · shares
VW_CLRH_HIER,VW_SATR_HIER,W_PDS_CALENDAR_D,W_PDS_ORGANIZATION_D - 5 RAP Integration — IPOCS-Demand Forecasting and IPOCS-LAR Implementation Guide · shares
AREA_NAME,ATTR_WGT,BRAND_NAME,CHAIN_NAME - 12 Pre-Pack Optimization — AI Foundation Implementation Guide · shares
CAL_DATE,EOH_COST_AMT,EOH_QTY,EOH_RTL_AMT - 2 AI Foundation Data Standalone Processes — AI Foundation Operations Guide · shares
AP_ASSORT_GROUP_EXP,AP_PLAN1_EXP,W_PDS_CALENDAR_D,W_PDS_CUSTSEG_D