| Oracle® Retail Assortment Planning Implementation Guide Release 14.1 E55310-01 |
|
 Previous |
 Next |
| Oracle® Retail Assortment Planning Implementation Guide Release 14.1 E55310-01 |
|
Previous |
Next |
This chapter describes the scripts that must be executed to build the AP domain on RPAS.
RPAS infrastructure (including the server and client), and AP must be installed before setting up and configuring AP.
For information on installing RPAS server and the relevant client, see the Oracle Retail Predictive Application Server Installation Guide.
For information on installing AP, see the Oracle Retail Assortment Planning Installation Guide.
Before downloading the installation package to the UNIX server, a central directory structure to support the environment has to be created. This central directory is referred to as AP_HOME. The UNIX user performing the installation needs to set up an environmental variable called AP_HOME in the user's profile: export AP_HOME=<full path name to AP home>
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 client:
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.
After the RPAS installation process is complete, it is necessary to modify portions of two files: delphi.log4j.properties and delphi.properties. These files are located in the $RPAS_HOME/applib/resources/Engine directory. Each file contains an absolute path for a specific file, and these two paths must be valid paths to execute the Assortment Planning Prepack Optimization logic:
The delphi.log4j.properties file contains an entry named log4j.appender.Delphi.File. Ensure that the path for this parameter is a valid one.
The delphi.properties file contains an entry named engine.agorai.lib. This parameter's value needs to be the absolute path to the $RPAS_HOME/applib directory.
The delphi.properties file contains an entry named delphi.sku.store.combination.upperBound. The value of this parameter defines the maximum number of sku-store combinations that the calculation engine optimizes. This variable may need to be increased based upon the size of the optimization problem.
The AP installer performs the following functions:
Downloads the configuration and batch scripts into the $AP_HOME/config and $AP_HOME/bin directories.
Downloads a set of sample hierarchy and data files into the $AP_HOME/input directory.
Builds a sample domain at $AP_HOME/domain/APFA.
To do a custom build of a domain, perform the following steps:
Change to the configuration directory: cd $AP_HOME/config.
Update the globaldomainconfig.xml file with the correct domain paths.
Change to the bin directory: cd $AP_HOME/bin.
If needed, update the default environment variables in environment.ksh.
Execute the build_ap.ksh script: ./build_ap.ksh.
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 AP, IP, MFP, and SPO.
|
Note: The common hierarchy is not available for IP 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 for details on the RPAS utilities.
The following scripts are not part of a normal batch schedule but are executed only to build or patch a domain.
Table 3-1 outlines the build scripts. These scripts are located in the
$AP_HOME/bin directory.
Table 3-1 Build Scripts
| Description | Script Name | Dependency |
|---|---|---|
|
Build a domain |
build_ap.ksh |
None |
|
Patch a domain when the configuration changes do not affect formatting |
patch_ap_keepformats.ksh |
None |
|
Patch a domain when the configuration changes require updates to formatting |
patch_ap _deleteformats.ksh |
None |
Before building the domain, set up the following types of file:
Standard RPAS Hierarchy files
AP-specific Hierarchy files
Data files
For information on the standard and AP-specific hierarchy files, see Chapter 9.
In addition, there are some general environmental requirements needed for running any sort of AP-related batch script. For information on these requirements, see Chapter 7.
This section contains detailed information on the following build scripts:
Script
build_ap.ksh
Usage
build_ap.ksh
Notes
The script overwrites an existing domain, so it should never be run on top of an existing domain unintentionally. Updating an existing domain should be done through the <AP_HOME>/bin/patch_ap_keepformats.ksh or <AP_HOME>/bin/patch_ap_deleteformats.ksh scripts.
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 for details on this utility.
The script also uses the following RPAS utilities: mace, loadmeasure, and domainprop. See the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client for details on these utilities.
All hierarchy and measure files should be placed in $AP_HOME/input.
The commit later functionality is disabled.
The script generates logs for itself and each called script. These logs are written to the directory indicated by the environment variable BSA_LOG_HOME. By default, this is set to $AP_HOME/logs. Any error in processing aborts the script, and the logs are designed to provide detail on what caused the error.
When changes have been made to AP that require changes to the domain, the following scripts are used to apply the patch to the domain.
Script
patch_ap_keepformats.ksh
or
patch_ap_deleteformats.ksh
Usage
patch_ap_keepformats.ksh
patch_ap_deleteformats.ksh
Notes
The main difference between the scripts patch_ap_deleteformats.ksh and patch_ap_keepformats.ksh is that patch_ap_deleteformats.ksh runs the rpasInstall command with the -updatestyles option. (This option causes rpasInstall to import formatting information configured in the Configuration Tools. Omitting it leaves existing formatting information unchanged.)
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 for details on this utility.
The script generates logs for itself and each called script. These logs are written to the directory indicated by the environment variable BSA_LOG_HOME. By default, this is set to $AP_HOME/logs. Any error in processing aborts the script, and the logs are designed to provide detail on what caused the error.
The AP installation software enables you to install the activity taskflow and online help files for the RPAS Fusion Client. In order to install the activity taskflow files, the RPAS Fusion Client must already be installed. For more information on installing the RPAS Fusion Client, refer to 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. In case 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, refer to the Oracle Retail Predictive Application Server Administration Guide for the RPAS Fusion Client.
For security purposes, 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.
Data is loaded into AP using the standard RPAS approach. See the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client for details on formatting the load data files and on the utilities that enable administrators to load data into RPAS. For information on integration using scripts, see Chapter 6. For information on any other batch script, see Chapter 7.
