3 Build Scripts

This chapter describes the scripts that must be executed to build or patch the Item Planning RPAS domain.

Installation Dependencies

RPAS and Item Planning must be installed before setting up and configuring Item Planning.

For information on installing RPAS, see the Oracle Retail Predictive Application Server Installation Guide.
For information on installing Item Planning, see the Oracle Retail Item Planning Installation Guide.

Environment Setup

Before downloading the installation package to the UNIX server, a central directory structure to support the environment needs to be created. This central directory is referred to as IP_HOME. The UNIX user performing the installation needs to set up an environmental variable called IP_HOME in the user's profile: export IP_HOME=<full path name to IP home>

RPAS Installation

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.

RPAS Client Installation

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).

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.

Item Planning Installation

The Item Planning installer performs the following functions:

Downloads the configuration and batch scripts into the $IP_HOME/config and $IP_HOME/bin directories.
Downloads a set of sample hierarchy and data files into the $IP_HOME/input directory.
Builds a sample domain at $IP_HOME/domain/itemplan.

Custom Domain Build

To do a custom build of a domain:

Change to the configuration directory: cd $IP_HOME/config.
Update the globaldomainconfig.xml file with the correct domain paths. Update the partition position information to correspond to the product hierarchy used in the file.
Change to the bin directory: cd $IP_HOME/bin.
Update the localdomainlist.cfg file with the correct paths for the local domains.
If needed, update the default environment variables in environment.ksh.
Execute the build_item.ksh script: ./build_item.ksh.

It is expected that the first time build_item.ksh is executed, an error occurs when it tries to remove the old log file because a log file does not yet exist.

Item Planning Taskflow for the RPAS Fusion Client

The Item Planning 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 RPAS Fusion Client.

Handling Common Hierarchy Files

The following hierarchy files contain the superset of all the dimensions along the product, location, and calendar hierarchies:

prod.hdr.csv.dat
loc.hdr.csv.dat
clnd.hdr.csv.dat

These common hierarchy files are shared among the Fashion Planning Bundle applications: AP, IP, MFP, and SPO.

Note:

The common hierarchy files are not available for Item Planning Configured for COE.

Each hdr.csv.dat (hdr) hierarchy file contains a header line that lists all the dimensions for which position information is contained in the file. The RPAS build process handles these hdr files, so that every application extracts the position information relevant to itself and ignores dimensions not configured in the application.

The filterHier utility is run on the hdr files to convert them into standard hierarchy files that are then passed to loadHier. The build process, which uses rpasInstall, can differentiate between standard and hdr hierarchy files. There is no need for the implementer to make any changes in the domain build process.

If using hdr files, the implementer needs to run filterHier before running loadHier. The filterHier utility converts the hdr files into standard hierarchy files that can be processed by loadHier. Note that there is no need to run filterHier if the standard hierarchy files are already available.

Note:

The hdr files must reside outside the domain input directory before running filterHier. By default, the filterHier utility puts the newly created filtered hierarchy files into the input folder of the domain.

See the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client or the Oracle Retail Predictive Application Server Administration Guide for the Classic Client for details on the RPAS utilities.

Files Needed to Build the IP Domain

Before building the domain, the following types of files need to be set up:

Standard RPAS Hierarchy Files.
IP Specific Hierarchy Files.

This section contains a description of each file and includes an example of each file.

Standard RPAS Hierarchy Files

The following hierarchy files are needed:

Calendar Hierarchy File
Product Hierarchy File
Location Hierarchy File

Calendar Hierarchy File

File name: clnd.hdr.csv.dat.

File format: comma-separated value (CSV) file.

The following table describes the fields in this file.

Table 3-1 Calendar Hierarchy File

Name	Label	Description	Hierarchy Type	Child
day	Day	Day or Date in YYYYMMDD format	Main	None
week	Week	Week Number	Main	day
mnth	Month	Month Number	Main	week
qrtr	Quarter	Quarter of the Year	Main	mnth
ssn	Half	Half Year	Main	qrtr
year	Year	Year	Main	ssn
woy	Week of Year	Week of Year	Alternate	week

Example:

day, day_label, week, week_label,mnth, mnth_label, qrtr, qrtr_label, ssn, ssn_label, year, year_label, woy, woy_label

20070121,1/21/2007,W01_2007,1/27/2007,M01_2007,Feb FY2007,Q1_2007,Q1 FY2007,H1_2007,Half1 FY2007,A2007,FY2007,01,Week 01

20070122,1/22/2007,W01_2007,1/27/2007,M01_2007,Feb FY2007,Q1_2007,Q1 FY2007,H1_2007,Half1 FY2007,A2007,FY2007,01,Week 01

20070123,1/23/2007,W01_2007,1/27/2007,M01_2007,Feb FY2007,Q1_2007,Q1 FY2007,H1_2007,Half1 FY2007,A2007,FY2007,01,Week 01

20070124,1/24/2007,W01_2007,1/27/2007,M01_2007,Feb FY2007,Q1_2007,Q1 FY2007,H1_2007,Half1 FY2007,A2007,FY2007,01,Week 01

Product Hierarchy File

File name: prod.hdr.csv.dat

File format: comma-separated value (CSV) file

The following table describes the fields in this file:

Table 3-2 Product Hierarchy File

Name	Label	Description	Hierarchy Type	Child
skup	Style-Color	Style-Color	Main	None
skug	Style	Style	Main	skup
scls	Subclass	Subclass	Main	skug
clss	Class	Class	Main	scls
dept	Dept	Department	Main	clss
pgrp	Group	Group	Main	dept
dvsn	Division	Division	Main	pgrp
cmpp	Company	Company	Main	dvsn
clr	Color	Color	Alternate	skup

Example:

skup,skup_label,skug,skug_label,scls,scls_label,clss,clss_label,dept,dept_label,pgrp,pgrp_label,dvsn,dvsn_label,cmpp,cmpp_label,clr,clr_label

1000000_6,1000000_6 Suede Loafer Brown size 6,1000000,1000000 Suede Loafer Brown,200000,200000 Suede Loafer,30000,30000 Loafers,4000,4000 Casual,100,100 Men's Footwear,21,21 Men's Footwear,20,20 Menswear,1,1 Acme Home,BROWN,Brown

1000001_6,1000001_6 Suede Loafer Black size 6,1000001,1000001 Suede Loafer Black,200000,200000 Suede Loafer,30000,30000 Loafers,4000,4000 Casual,100,100 Men's Footwear,21,21 Men's Footwear,20,20 Menswear,1,1 Acme Home,BLACK,Black

Location Hierarchy File

File name: loc.hdr.csv.dat

File format: comma-separated value (CSV) file

The following table describes the fields in this file:

Table 3-3 Location Hierarchy File

Name	Label	Description	Hierarchy Type	Child
str	Store	Store	Main	None
pzon	Price Zone	Price Zone	Main	str
zone	Zone	Zone	Main	pzon
chnl	Channel	Channel	Main	zon
chn	Chain	Chain	Main	chnl
cmpy	Company	Company	Main	chn

Example:

1000,1000 Charlotte,PZ1,FB PriceZone 1,Z1,FB Zone 1,1,Brick & Mortar,1,Chain 1,1,Retailer Ltd

1001,1001 Atlanta,Unassigned,No price zone,Unassigned,No zone,1,Brick & Mortar,1,Chain 1,1,Retailer Ltd

IP Specific Hierarchy Files

The following are special IP Hierarchy files.

Seasonality Hierarchy File
Price Tier Hierarchy File
Size Hierarchy File
Curve Library Hierarchy File
Measure_Status Hierarchy File
Measure Details Hierarchy File
Promotion Hierarchy File
Clearance Cadence Hierarchy File
Week of Year Hierarchy File

Seasonality Hierarchy File

This hierarchy is a single dimension hierarchy that contains the seasonality type of items.

File name: at1h.csv.dat

File format: comma-separated value (CSV) file

The following table describes the fields in this file:

Table 3-4 Seasonal Hierarchy File

Name	Label	Description	Hierarchy Type	Child
at1d	Seasonality	Seasonality	Main	None

Example:

01,Fashion

05,Seasonal Basic

99,Basic

Price Tier Hierarchy File

This hierarchy is a single dimension hierarchy that contains the price tiers.

File name: at2h.csv.dat

File format: comma-separated value (CSV) file

The following table describes the fields in this file.

Table 3-5 Price Tier Hierarchy File

Name	Label	Description	Hierarchy Type	Child
at2d	Price Tier	Price Tier	Main	None

Example:

1,1 Good

2,2 Better

3,3 Best

Size Hierarchy File

The Size hierarchy captures all valid size ranges and corresponding sizes in each size range.

File name: sizh.csv.dat

File format: comma-separated value (CSV) file

The following table describes the fields in this file:

Table 3-6 Size Hierarchy File

Name	Label	Description	Hierarchy Type	Child
sizd	Size	Size identifier. Note: The size is expected to have a unique identifier. For example an S in an S-M-L size range needs to have a unique identifier from an S in an S-M-L-XL size range	Main	None
srng	Size Range	Unique size range identifier. The size range is a hierarchical aggregate of size.	Main	Sizd

Name

Label

Description

Hierarchy Type

Child

sizd

Size

Size identifier.

Note: The size is expected to have a unique identifier. For example an S in an S-M-L size range needs to have a unique identifier from an S in an S-M-L-XL size range

Main

None

srng

Size Range

Unique size range identifier. The size range is a hierarchical aggregate of size.

Main

Sizd

Example:

XS_SML,XS,SML,SML

S_SML,S,SML,SML

M_SML,M,SML,SML

L_SML,L,SML,SML

XL_SML,XL,SML,SML

XXL_SML,XXL,SML,SML

04_0t15,4,0t15,0-15

06_0t15,6,0t15,0-15

08_0t15,8,0t15,0-15

10_0t15,10,0t15,0-15

12_0t15,12,0t15,0-15

14_0t15,14,0t15,0-15

16_0t15,16,0t15,0-15

18_0t15,18,0t15,0-15

6_MensShoes,6,MensShoes,Men's Shoes

6_5_MensShoes,6.5,MensShoes,Men's Shoes

Curve Library Hierarchy File

This hierarchy is a single dimension hierarchy that contains the positions of different sales curves.

File name: libh.csv.dat

File format: comma-separated value (CSV) file

The following table describes the fields in this file:

Table 3-7 Curve Library Hierarchy File

Name	Label	Description	Hierarchy Type	Child
libd	Curve Library	Curve Library	Main	None

Example:

01,Lifecycle Curve 01

02,Lifecycle Curve 02

03,Lifecycle Curve 03

04,Lifecycle Curve 04

05,Lifecycle Curve 05

06,Lifecycle Curve 06

07,Lifecycle Curve 07

08,Lifecycle Curve 08

Measure_Status Hierarchy File

This hierarchy is a single dimension hierarchy that contains the positions of status of measures.

File name: dash.csv.dat

File format: comma-separated value (CSV) file

The following table describes the fields in this file:

Table 3-8 Measure_Status Hierarchy File

Name	Label	Description	Hierarchy Type	Child
dshs	Status	Status	Main	None

Example:

001,01. Total Plan

002,02. Total Act/Proj

003,03. Total Act/Proj diff to Total Plan

004,04. Total Act/Proj var to Total Plan

005,05. LTD Plan

006,06. LTD Actual

007,07. LTD Actuals diff to Plan

008,08. LTD Actuals var to Plan

009,09. Remaining Plan

010,10. Remaining Projection

011,11. Remaining Projection diff to Plan

012,12. Remaining Projection var to Plan

013,13. LTD Plan % of Plan

014,14. LTD Actual % of Plan

Measure Details Hierarchy File

This hierarchy is a single dimension hierarchy that contains the positions of details of measures.

File name: dsh2.csv.dat

File format: comma-separated value (CSV) file

The following table describes the fields in this file:

Table 3-9 Measure Details Hierarchy File

Name	Label	Description	Hierarchy Type	Child
detl	Measure Detail	Measure Detail	Main	None

Example:

01,01. Total Plan

02,02. Total Act/Proj

03,03. Total Act/Plan diff to Total Plan

04,04. Total Act/Proj var to Total Plan

05,05. Total Act/Initial Optimization Forecast

06,06. Total Act/Initial Opt Fcst diff to Total Plan

07,07. Total Act/Initial Opt Fcst var to Total Plan

08,08. Total Act/Revised Optimization Forecast

09,09. Total Act/Rev Opt Fcst diff to Total Plan

10,10. Total Act/Rev Opt Fcst var to Total Plan

Promotion Hierarchy File

This hierarchy is a single dimension hierarchy that contains the positions of promotions.

File name: prom.csv.dat

File format: comma-separated value (CSV) file

The following table describes the fields in this file:

Table 3-10 Promotion Hierarchy File

Name	Label	Description	Hierarchy Type	Child
pro	Promotion	Promotion	Main	None

Example:

Prom01,Promotion 01

Prom02,Promotion 02

Prom03,Promotion 03

Prom04,Promotion 04

Prom05,Promotion 05

Prom06,Promotion 06

Prom07,Promotion 07

Prom08,Promotion 08

Prom09,Promotion 09

Prom10,Promotion 10

Prom11,Promotion 11

Prom12,Promotion 12

Clearance Cadence Hierarchy File

This hierarchy is a single dimension hierarchy that contains the positions of Clearance Cadence.

File name: cdnc.csv.dat

File format: comma-separated value (CSV) file

The following table describes the field in this file:

Table 3-11 Clearance Cadence Hierarchy File

Name	Label	Description	Hierarchy Type	Child
cdnc	Clearance Cadence	Clearance Cadence	Main	None

Example:

01,Cadence 01

02,Cadence 02

03,Cadence 03

04,Cadence 04

05,Cadence 05

Week of Year Hierarchy File

This hierarchy is a single dimension hierarchy that contains the positions of week of year.

File name: woy2.csv.dat

File format: comma-separated value (CSV) file

The following table describes the field in this file:

Table 3-12 Week of Year Hierarchy File

Name	Label	Description	Hierarchy Type	Child
wy2	Week of Year	Week of Year	Main	None

Example:

01,Week 01

02,Week 02

03,Week 03

04,Week 04

05,Week 05

06,Week 06

Building the Item Planning Domain

The following scripts are not part of a normal batch schedule but are executed only to build or patch a domain.

Table 3-13 outlines the build scripts. These scripts are located in the
$IP_HOME/bin directory.

Table 3-13 Build Scripts

Description	Script Name	Dependency
Build a domain	build_item.ksh	None
Patch a domain when the configuration changes do not affect formatting	patch_item_keepformats.ksh	None
Patch a domain when the configuration changes require updates to formatting	patch_item _deleteformats.ksh	None

Batch Designs

This section contains detailed information on the following build scripts:

Building a Domain
Patching a Domain

Building a Domain

Script
build_item.ksh

Usage
build_item.ksh

Error Information

Table 3-14 Building a Domain Error Information

Task Name	Error Code	Abort Required?	Description of Error
build_item	-1	yes	Error during domain build.
build_item	-2	yes	Error when adding default users.
build_item	-3	yes	Error during initial measure load.
build_item	-4	yes	Error found when running the batch calculations in the master domain.
build_item	-5	yes	The localdomainlist.cfg file was not found.
build_item	-6	yes	Error when running the batch calculations over the local domains.
build_item	-7	yes	Error during the disabling of commit later.
build_item	-8	yes	Error when updating the local domain paths to relative paths.

Notes

The script uses the Configuration Tools rpasInstall utility to build a domain. See the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client or the Oracle Retail Predictive Application Server Administration Guide for the Classic Client for details on this utility.
The script also uses the following RPAS utilities: usermgr, mace, loadmeasure, copyDomain, and domainprop. See the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client or the Oracle Retail Predictive Application Server Administration Guide for the Classic Client for details on these utilities.
All hierarchy and measure files are placed into the $IP_HOME/input directory.
The commit later functionality and insert measure functionality are disabled.

Patching a Domain

When changes have been made to Item Planning that require changes to the domain, the following scripts are used to apply the patch to the domain.

Script
patch_item_keepformats.ksh
or
patch_item_deleteformats.ksh

Usage
patch_item_keepformats.ksh
patch_item_deleteformats.ksh

Error Information

Table 3-15 Patching a Domain Error Information

Task Name	Error Code	Abort Required?	Description of Error
patch_item_deleteformats	-10	yes	Could not find the localdomainlist.cfg file.
patch_item_deleteformats	-11	yes	Error during domain patch.
patch_item_keepformats	-20	yes	Error during domain patch.

Notes

Prior to RPAS 13.1.1, formats were not transferable across major versions, and users had to delete formats before patching and then reapply the formats after the patch was installed. RPAS 13.1.1 included an upgrade to the save format process that allows RPAS applications to keep the formats when updating versions. Because this update is not backwards compatible, the script you use depends on the version of RPAS you are upgrading from:
- If you are upgrading from an RPAS version prior to 13.1.1, use patch_ap_deleteformats. This script removes all existed saved formats (template, group, and user). Once you have installed the patch, reapply your formats.
- If you are upgrading from RPAS 13.1.1 or later, use patch_ap_keepformats. The formats are automatically converted.
The scripts use the Configuration Tools rpasInstall utility to build a domain. See the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client or the Oracle Retail Predictive Application Server Administration Guide for the Classic Client for details on this utility.
The scripts use the Configuration Tools rpasInstall utility to build a domain. See the Oracle Retail Predictive Application Server Administration Guide for details on this utility.

Creating Users and User Groups

For greater security, users and user groups are not automatically created when you build or patch a domain. To create users and user groups, you must use the usermgr utility. To learn more about usermgr, see the Operational Utilities chapter of the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client or the Oracle Retail Predictive Application Server Administration Guide for the Classic Client.

Loading and Extracting Data

Data is loaded into Item Planning using the standard RPAS approach. See the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client or the Oracle Retail Predictive Application Server Administration Guide for the Classic Client for details on formatting the load data files and on the utilities that enable administrators to load data into RPAS. If you are using the ODI enabled integration, see Chapter 5, "Fashion Planning and ODI Integration". If you are using script integration for the bundle, see Chapter 6, "Script Integration". For information on any other batch script, see Chapter 7, "Batch Processing".