This chapter describes the setup that must be done before building the RDF domain and the batch script that must be run to build the domain.
Note: For information on building the Curve and Grade domains, refer to the Oracle Retail Predictive Application Server Installation Guide. |
RPAS and RDF must be installed before setting up and configuring RDF:
For information on installing RPAS, see the Oracle Retail Predictive Application Server Installation Guide.
For information on installing RDF, see the Oracle Retail Demand Forecasting Installation Guide.
The Java-based RPAS installation programs that are included with the installation package are used to install the server-side RPAS components on UNIX operating systems.
The RPAS installer performs the following functions:
Installs the RPAS server
Installs the Configuration Tools on the server
On Windows, an InstallShield package is used to install the Configuration Tools.
Defines the DomainDaemon port
The RPAS server installation package also includes the following RPAS clients:
RPAS Classic Client: A Windows-based client interface for end users and system administrators of an RPAS domain.
RPAS Fusion Client: A Web-based client developed using Oracle Application Development Framework (ADF).
Note: RDF Cloud Service only supports the RPAS Fusion Client. |
Each RPAS client installation package includes a separate installer to help you install the client. For more information on installing the RPAS clients, refer to the Oracle Retail Predictive Application Server Installation Guide.
In addition to the RPAS installer, the installation package also includes the Java-based RPAS installation program for the RDF application.
The RDF installer automates the following tasks:
Installs the RDF mock install configuration
Installs RDF plug-ins for the Configuration Tools
Installs Language Translation files
Optionally creates a sample RDF domain
The RDF installation software enables you to install the taskflow and online help files for the RPAS Fusion Client. In order to install the taskflow files, the RPAS Fusion Client must already be installed. For more information on installing the RPAS Fusion Client, see the Oracle Retail Predictive Application Server Installation Guide.
During the RPAS Fusion Client installation, the installer automatically sets up the RPAS domain connection configurations in the ProfileList.xml
file. If you choose to set up the domain connection after the installation or set up an additional domain, you must manually set up the connection. For more information, see the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client.
In addition to the regular RPAS environment variables, including RPAS_HOME, you need to set up the following environment variables and export them. We recommend that this is done in your .profile
script
Table 4-1 Environment Variables
Environment Variable | Description | Use |
---|---|---|
BSA_ARCHIVE_DIR |
Location of the BSA archive. Not currently used by RDF. If not set, it will use $HOME as the default. |
Optional |
BSA_CONFIG_DIR |
Location of the BSA configuration files. Not currently used by RDF. If not set, it will use $HOME as the default. |
Optional |
BSA_LOG_HOME |
This is the location in which logging from the RDF scripts will be placed. If not set, it will use $HOME as the default. |
Optional |
BSA_TEMP_DIR |
This is the location where some temporary files are stored by the scripts. If not set, it will use $HOME as the default. |
Optional |
PATH |
The standard operating system path. Running the script |
Mandatory |
RDF_BATCH_TIMEOUT |
This numeric value, set in seconds, controls the amount of time that the Batch Forecast workbook will wait for another Batch Forecast workbook process to finish. This allows several users in different local domains to start a Batch Forecast workbook simultaneously. |
Optional |
RIDE_HOME |
The location of the Configuration Tools. |
Mandatory for Installation and Patching |
Before the domain is built, the following types of files need to be set up:
The following hierarchy files are needed:
Note: As with all standard RPAS hierarchies, these hierarchies are configurable. For information about configuring these hierarchies, see Chapter 1, "Introduction." |
File name: clnd.csv.dat
File format: comma-separated values file
Table 4-2 describes the fields in the file:
Table 4-2 Calendar Hierarchy Fields
Name | Description | Parent |
---|---|---|
DAY |
Day ID (YYYYMMDD format) |
None |
DAY label |
Day label |
not applicable |
WEEK |
Week ID |
DAY |
WEEK label |
Week label |
not applicable |
MNTH |
Month ID |
WEEK |
MNTH label |
Month label |
not applicable |
QRTR |
Quarter ID |
MNTH |
QRTR label |
Quarter label |
not applicable |
SSN |
Fiscal Half ID |
QRTR |
SSN label |
Fiscal Half label |
not applicable |
YEAR |
Year ID |
SSN |
YEAR label |
Year label |
not applicable |
DOW |
Day of Week ID |
DAY |
DOW label |
Day of Week label |
not applicable |
DOS |
Day of Season ID |
DAY |
DOS label |
Day of Season label |
not applicable |
WOY |
Week of Year ID |
WEEK |
WOY label |
Week of Year label |
not applicable |
WOS |
Week of Season ID |
WEEK |
WOS label |
Week of Season label |
not applicable |
Example 4-1 CLND Format
20050130,01/30/2005,w01_2005,01/30/2005,JAN_2005,January 2005,Q1_2005,Quarter 1 2005,H1_2005,2005 First Half, A2005, Year 2005, SAT, Saturday,DOS01,DOS 01,WY01, Week 01, WS01,WOS 01
There is also one user dimension supported for the calendar hierarchy. This dimension is not loaded. It is maintained in the Hierarchy Maintenance workbook. For more information, see the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client.
Name | Description | Parent |
---|---|---|
WG1 | Week grouping ID | WEEK |
Note: After upgrading a domain or loading a new calendar hierarchy into the RDF domain, ensure that the current date measures value is within the new calendar hierarchy. |
File name: prod.csv.dat
File format: comma-separated values file
Table 4-3 describes the fields in the file with the GA hierarchy definition. The hierarchy may be configured per implementation, in which case the implementer will need to provide the file format. Note that the product hierarchy must have Item (ITEM), Subclass (SCLS), and Group (PGRP) dimensions.
Table 4-3 Product Hierarchy Fields
Name | Description | Parent |
---|---|---|
ITEM |
Item ID |
None |
ITEM label |
Item label |
not applicable |
ITPT |
Parent ID |
ITEM |
ITPT label |
Parent label |
not applicable |
ITGP |
Grand Parent ID |
ITPT |
ITGP label |
Grand Parent label |
not applicable |
SCLS |
Subclass ID |
ITGP |
SCLS label |
Subclass label |
not applicable |
CLSS |
Class ID |
SCLS |
CLSS label |
Class label |
not applicable |
DEPT |
Department ID |
|
DEPT label |
Department label |
not applicable |
PGRP |
Group |
|
PGRP label |
Group label |
not applicable |
DVSN |
Division ID |
PGRP |
DVSN label |
Division label |
not applicable |
SPLR |
Supplier ID |
ITEM |
SPLR label |
Supplier label |
not applicable |
The following fields are unavailable in RDF Cloud Service |
||
PTD1 |
Parent Diff 1ID |
ITEM |
PTD1 label |
Parent Diff 1 label |
not applicable |
GPD1 |
Grand Parent Diff 1 ID |
PTD1 |
GPD1 label |
Grand Parent Diff 1 label |
not applicable |
SCD1 |
Subclass Diff 1 ID |
GPD1 |
SCD1 label |
Subclass Diff 1 label |
not applicable |
CLD1 |
Class Diff 1 ID |
SCD1 |
CLD1 label |
Class Diff 1 label |
not applicable |
DPD1 |
Dept Diff 1 ID |
CLD1 |
DPD1 label |
Dept Diff 1 label |
not applicable |
DIF1 1 |
Diff 1 ID |
DPD1 |
DIF1 1 label |
Diff 1 label |
not applicable |
Example 4-2 PROD Format (RDF Cloud Service)
10000010,10000010Leather Loafer - Black 6 B,10000010,10000010Leather Loafer - Black 6 B,10000009,10000009Leather Loafer,122,122Loafer,1312,1312Casual*,1310,1310Footwear Women's*,1300,Group 1,1,All Product,1000,Supplier 1
Example 4-3 PROD Format (RDF)
10000010,10000010Leather Loafer - Black 6 B, 10000010, 10000010Leather Loafer - Black 6 B, 10000009, 10000009Leather Loafer, 122, 122Loafer, 1312, 1312Casual, 1310, 1310Footwear Women's, 1300, Group 1, 1, All Product, 1000, Supplier 1, 10000010_sml, 10000010Leather Loafer - Black 6 B Small, 10000009_sml, 10000009Leather Loafer Small, 122_sml, 122Loafer Small, 1312_sml,, 1312Casual* Small, 1310_sml,, 1310Footwear Women's* Small, _sml, Small
There are also two user dimensions supported for the product hierarchy. These dimensions are not loaded. They are maintained in the Hierarchy Maintenance workbook.. For more information, see the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client.
Name | Description | Parent |
---|---|---|
ITG1 | Item Grouping 1 | ID ITEM |
ITG2 | Item Grouping 2 | ID ITEM |
File name: loc.csv.dat
File format: comma-separated values file
Table 4-4 describes the fields in the file with the GA hierarchy definition. The hierarchy may be configured per implementation, in which case the implementer will need to provide the file format. Note that the location hierarchy must have Store (STR) and Region (RGN) dimensions.
Table 4-4 Location Hierarchy Fields
Name | Description | Parent |
---|---|---|
STR |
Store ID |
none |
STR label |
Store label |
not applicable |
DSTR |
District ID |
STR |
DSTR label |
District label |
not applicable |
RGN |
Region ID |
DSTR |
RGN label |
Region label |
not applicable |
AREA |
Area ID |
RGN |
AREA label |
Area label |
not applicable |
CHN |
Chain ID |
AREA |
CHN label |
Chain label |
not applicable |
CMPN |
Company ID |
CHN |
CMPN label |
Company label |
not applicable |
SFMT |
Store Format ID |
STR |
SFMT label |
Store Format label |
not applicable |
STCL |
Store Class |
STR |
STCL label |
Store Class Label |
not applicable |
Example 4-4 LOC Format
1000, New York City, 1000, US, 1000, North America, 1000, The Americas, 1000, Bricks & Mortar, 100, JCB Trading Company, 4, 4, A, A
There are also two user dimensions supported for the product hierarchy. These dimensions are not loaded. They are maintained in the Hierarchy Maintenance workbook.. For more information, see the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client.
Name | Description | Parent |
---|---|---|
STG1 | Store Grouping 1 ID | STR |
STG2 | Store Grouping 2 ID | STR |
File name: attr.csv.dat
File format: comma-separated values file
Table 4-5 describes the fields in the file with the GA hierarchy definition.
Table 4-5 Time Series Grouping Hierarchy Fields
Name | Description | Parent |
---|---|---|
ATN |
Attribute name ID |
none |
ATN label |
Attribute name label |
not applicable |
There are no user dimensions supported for the product attributes hierarchy.
File name: grph.csv.dat
File format: comma-separated values file
Table 4-6 describes the fields in the file.
Table 4-7 describes the measures as defined in the GA configuration. The levels and intersections may be configured per implementation, in which case the implementer will need to provide updated information.
Table 4-7 Data Files
Measure Name | Measure Label | Base Intersection | Data Type | On-premise or Cloud | Required or Optional | Loaded By |
---|---|---|---|---|---|---|
Category: Sales |
||||||
dpos |
Daily Sales |
day / item /str |
Real |
On-premise |
Required |
rdf_load_measures.ksh |
rsal |
Load intersection: day_itemStr Measure intersection: itemstr_week |
Real |
Both |
Required |
rdf_load_measures.ksh |
|
psal |
Real |
Both |
Optional |
rdf_load_measures.ksh |
||
csal |
Real |
Both |
Optional |
rdf_load_measures.ksh |
||
Category: Preprocessing |
||||||
ldpreoosind |
Loaded Out of Stock Indicator |
week / item /str |
Boolean |
Both |
Optional |
rdf_load_measures.ksh |
preppiind |
Promotion Indicator |
week / item /str |
Boolean |
Both |
Optional |
rdf_load_measures.ksh |
preseaprof |
Seasonal Profile |
woy / scls / rgn |
Real |
Both |
Optional |
rdf_load_measures.ksh |
Category: New Item / New Store |
||||||
nitattval |
Attribute Value |
item / atn1 |
String |
Both |
Only required for Attribute Based New Item |
rdf_load_measures.ksh |
nitattvaltyp |
Attribute Value Type |
atn |
Integer |
Both |
Only required for Attribute Based New Item |
rdf_load_measures.ksh |
nitdattwgt |
Attribute Weight |
clss / atn3 |
Real |
Both |
Only for required Attribute Based New Item |
rdf_load_measures.ksh |
nitdatttau |
Numeric Attribute Tau |
clss / atn3 |
Real |
Both |
Only required for Attribute Based New Item |
rdf_load_measures.ksh |
nitfcststovr |
Forecast Start Date Override |
item / str2 |
Date |
Both |
Optional |
rdf_load_measures.ksh |
nishiststovr |
History Start |
item / str2 |
Date |
Both |
Optional |
rdf_load_measures.ksh |
nititm2itr |
Item to Item RHS map |
item/iter |
Boolean |
Both |
Only required for Attribute Based New Item |
rdf_load_measures.ksh |
Category: Grouping |
||||||
grpasnmt |
Group Assignment |
item / str |
String |
Both |
Only required if intersection of forecast level includes time series group dimension |
rdf_load_measures.ksh |
Category: Promotions |
||||||
pvarxlpprc |
Promotion Variable Price Discount |
week / item /str |
Real |
On-premise |
Optional |
rdf_load_measures.ksh |
pvarxlcirc |
Promotion Variable Circular |
week /item / str |
Boolean |
On-premise |
Optional |
rdf_load_measures.ksh |
pvarxlisd |
Promotion Variable In-Store Display |
week /item / str |
Boolean |
On-premise |
Optional |
rdf_load_measures.ksh |
pvarxlcovr |
Promotion Variable Cover |
week /item / str |
Boolean |
On-premise |
Optional |
rdf_load_measures.ksh |
pvarxlmuby |
Promotion Variable Multibuy |
week /item / str |
Boolean |
On-premise |
Optional |
rdf_load_measures.ksh |
pvarxltvad |
Promotion Variable TV Ad |
week /item / str |
Boolean |
On-premise |
Optional |
rdf_load_measures.ksh |
pvarxlbts |
Promotion Variable Back to School |
week / item |
Boolean |
On-premise |
Optional |
rdf_load_measures.ksh |
pvarxldml |
Promotion Variable Direct Mail |
day / item / str |
Boolean |
On-premise |
Optional |
rdf_load_measures.ksh |
pvarxleas |
Promotion Variable Easter |
day / item |
Boolean |
On-premise |
Optional |
rdf_load_measures.ksh |
pvarxlnyd |
Promotion Variable New Years Day |
day / item |
Boolean |
On-premise |
Optional |
rdf_load_measures.ksh |
pvarxlsgn |
Promotion Variable Signage |
day / item / str |
Boolean |
On-premise |
Optional |
rdf_load_measures.ksh |
pvarxlxmas |
Promotion Variable Christmas |
day / clss |
Boolean |
On-premise |
Optional |
rdf_load_measures.ksh |
pvarxlxmss |
Promotion Variable Christmas Season |
week / item |
Boolean |
On-premise |
Optional |
rdf_load_measures.ksh |
promoenable |
Enable Promotions |
prmo / prml |
Boolean |
On-premise |
rdf_load_measures.ksh |
|
pvarxlbp1 |
Promotion Variable Boolean Promotion 1 |
week / item /str4 |
Boolean |
Cloud |
Optional |
rdf_load_measures.ksh |
pvarxlbp2 |
Promotion Variable Boolean Promotion 2 |
week / item /str4 |
Boolean |
Cloud |
Optional |
rdf_load_measures.ksh |
pvarxlbp3 |
Promotion Variable Boolean Promotion 3 |
week / item /str4 |
Boolean |
Cloud |
Optional |
rdf_load_measures.ksh |
pvarxlbp4 |
Promotion Variable Boolean Promotion 4 |
week / item /str4 |
Boolean |
Cloud |
Optional |
rdf_load_measures.ksh |
pvarxlbp5 |
Promotion Variable Boolean Promotion 5 |
week / item4 |
Boolean |
Cloud |
Optional |
rdf_load_measures.ksh |
pvarxlbp6 |
Promotion Variable Holiday 1 |
week / item /str4 |
Boolean |
Cloud |
Optional |
rdf_load_measures.ksh |
pvarxlbp7 |
Promotion Variable Holiday 2 |
week / item /str4 |
Boolean |
Cloud |
Optional |
rdf_load_measures.ksh |
pvarxlbp8 |
Promotion Variable Holiday 3 |
week / item /str4 |
Boolean |
Cloud |
Optional |
rdf_load_measures.ksh |
pvarxlbp9 |
Promotion Variable Holiday 4 |
week / item /str4 |
Boolean |
Cloud |
Optional |
rdf_load_measures.ksh |
pvarxlbp10 |
Promotion Variable Holiday 5 |
week / item /str4 |
Boolean |
Cloud |
Optional |
rdf_load_measures.ksh |
pvarxlexpp |
Promotion Variable Price Discount |
week / item /str4 |
Real |
Cloud |
Optional |
rdf_load_measures.ksh |
Category: Causal Set Up |
||||||
calcintxlxb |
Causal Calculation Intersection |
pgrp / flvl |
String |
On-premise |
Optional |
rdf_load_measures.ksh |
causalextbxlxb |
Causal Baseline |
pgrp / flvl |
String |
Both |
Only required for causal |
rdf_load_measures.ksh |
dowprof6 |
Day of Week Profile |
dow |
Real |
Both |
Optional |
rdf_load_measures.ksh, rdf_e_apcro.ksh |
Category: Bayesian Plan |
||||||
bayesianplan01 |
Bayesian Plan 01 - Final Level |
week / item /str5 |
Real |
Cloud |
Only required for levels with Bayesian forecast method |
rdf_load_bayesian_plan.ksh |
bayesianplan02 |
Bayesian Plan 02 - Source Level |
week / scls/ str5 |
Real |
Cloud |
Only required for levels with Bayesian forecast method |
rdf_load_bayesian_plan.ksh |
bayesianplan03 |
Bayesian Plan 03 - Source Level |
week / pgrp/ grpd5 |
Real |
Cloud |
Only required for levels with Bayesian forecast method |
rdf_load_bayesian_plan.ksh |
bayesianplan04 |
Bayesian Plan 04 - Source Level |
week / item / rgn5 |
Real |
Cloud |
Only required for levels with Bayesian forecast method |
rdf_load_bayesian_plan.ksh |
bayesianplan05 |
Bayesian Plan 05 - Source Level |
week / dept / str5 |
Real |
Cloud |
Only required for levels with Bayesian forecast method |
rdf_load_bayesian_plan.ksh |
bayesianplan06 |
Bayesian Plan 06 - Source Level |
week / item/ chn5 |
Real |
Cloud |
Only required for levels with Bayesian forecast method |
rdf_load_bayesian_plan.ksh |
Category: APC-RO Export |
||||||
apcroexptmask |
Export to APC-RO Mask |
item /str |
Boolean |
Both |
Optional |
rdf_e_apcro.ksh |
dowprof6 |
Day of Week Profile |
dow |
Real |
Both |
Optional |
rdf_load_measures.ksh, rdf_e_apcro.ksh |
Category: Cross Promotion |
||||||
appcanneff |
Approved Promo Cannibalization Spreading Profile |
item / rgn / iter |
Real |
On-premise |
Only required for cannibalization cross promotions |
rdf_load_measures.ksh |
apphaloeff |
Approved Promo Halo Spreading Profile |
clss / rgn / clsr |
Real |
On-premise |
Only required for halo cross promotions |
rdf_load_measures.ksh |
halochgratio |
Halo Transfer Ratio |
rgn / clsr |
Real |
On-premise |
Only required for halo cross promotions |
rdf_load_measures.ksh |
halomaxratio |
Halo Max Ratio |
clss / rgn |
Real |
On-premise |
Only required for halo cross promotions |
rdf_load_measures.ksh |
cannchgratio |
Cannibalization Transfer Ratio |
item / rgn |
Real |
On-premise |
Only required for cannibalization cross promotions |
rdf_load_measures.ksh |
cannmaxratio |
Cannibalization Max Ratio |
item / rgn |
Real |
On-premise |
Only required for cannibalization cross promotions |
rdf_load_measures.ksh |
Category: Regular Price |
||||||
promoind07xb |
Promotion Indicator 07 - itm/str/week-Weekly Causal Final |
week / item / str |
Boolean |
On-premise |
Only required for regular price effects |
rdf_load_measures.ksh |
rdfgamma |
Price Elasticity |
item /str / iter |
Real |
On-premise |
Only required for regular price effects |
rdf_load_measures.ksh |
rdfprice |
Regular Price |
week / item / str |
Real |
On-premise |
Only required for regular price effects |
rdf_load_measures.ksh |
rdfpromoind |
Promotion Indicators |
week / item / str |
Boolean |
On-premise |
Only required for regular price effects |
rdf_load_measures.ksh |
regprice07xb |
Regular Price 07 - itm/str/week-Weekly Causal Final |
week / item / str |
Real |
On-premise |
Only required for regular price effects |
rdf_load_measures.ksh |
Category: Short Life Cycle Causal |
||||||
slcitemind |
Short Lifecycle Item Flag |
item |
Boolean |
On-premise |
Optional |
rdf_load_measures.ksh |
salesprice |
Sales Price |
week / item / str |
Real |
On-premise |
Optional |
rdf_load_measures.ksh |
Category: Floating Events |
||||||
preevnindt01 through preevnindt20 |
Float Event <level> Indicator |
week / item / str7 |
Boolean |
On-premise |
Optional |
rdf_load_measures.ksh |
Table Key
Following is the key for Table 4-7:
1 On RDF Cloud Services, the intersection will be the same as the Intersection specified for level 01 in the RDF configuration tools plug-in.
2 The product and location dimensions of the intersection will match the product dimension and location dimensions of the measure specified in the Clone Input field in the New Item configuration tools plug-in.
3 The product dimension of the intersection will match the product dimension specified in the Attribute Weight Level field in the New Item configuration tools plug-in.
4 The intersection will be the same as the Intersection specified for the corresponding promotion in the Promote configuration tools plug-in.
5 The intersection will be the same as the Intersection specified for the corresponding level in the RDF configuration tools plug-in.
6 The dowprof measure is used for both Causal Set Up and APC-RO export.
7 The intersection will be the same as the Intersection specified for level 01 in the RDF configuration tools plug-in.
It is required that you have at least two years of historical sales to produce an optimal forecast.
Data is loaded into RDF using the standard RPAS approach. For information on formatting the load data files and the utilities that enable administrators to load data into RPAS, see the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client. Information is provided on all the batch scripts that are used for loading, processing, and extracting data.