Oracle® Retail Merchandise Financial Planning Operations Guide Release 14.1 E55750-01 |
|
![]() Previous |
![]() Next |
This chapter describes the scripts that must be executed to build the MFP RPAS domain.
RPAS and MFP must be installed before setting up and configuring MFP.
For information on installing RPAS, see the Oracle Retail Predictive Application Server Installation Guide.
For information on installing MFP, see the Oracle Retail Merchandise Financial Planning Retail Installation Guide and the Oracle Retail Merchandise Financial Planning Cost Installation Guide.
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 MFP_COST_HOME for MFP Cost and MFP_RETAIL_HOME for MFP Retail. The UNIX user performing the installation needs to set up an environmental variable called MFP_COST_HOME or MFP_RETAIL_HOME in the user's profile: export MFP_COST_HOME=<full path name to MFP Cost home>
or
export MFP_RETAIL_HOME=<full path name to MFP Retail home>
The MFP_Home is now referred either as $MFP_COST_HOME or $MFP_RETAIL_HOME depending on the environment.
Note: In this document, to simply MFP Cost or MFP Retail is referred as $MFP_HOME depending on the installation. All reference to $MFP_HOME is interpreted either as $MFP_COST_HOME or $MFP_RETAIL_HOME appropriately.The bath scripts for MFP Cost and MFP Retail do not use the variable $MFP_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 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, see the Oracle Retail Predictive Application Server Installation Guide.
The MFP installer performs the following functions:
Downloads the configuration and batch scripts into the $MFP_HOME/config
and $MFP_HOME/bin
directories.
Downloads a set of sample hierarchy and data files into the $MFP_HOME/input
directory.
Builds a sample domain at:
For MFP Cost, $MFP_HOME/domain/mfpcst
For MFP Retail, $MFP_HOME/domain/mfprtl
To do a custom build of a domain:
Change to the configuration directory: cd $MFP_HOME/config.
Update the globaldomainconfig.xml file with the correct domain paths. In addition, the groups that were part of the sample installation are replaced with the position information for the groups that are part of the retailer's hierarchy.
Change to the bin directory: cd $MFP_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_mfp.ksh script: ./build_mfp.ksh.
The MFP 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.
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. |
For more information on RPAS utilities, see the Oracle Retail Predictive Application Server Administration Guide for the Classic Client or the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client.
The following scripts are not part of a normal batch schedule but are executed only to build or patch a domain.
Table 3-1 lists the build scripts. These scripts are located in the
$MFP_HOME/bin
directory.
Table 3-1 Build Scripts
Description | Script Name | Dependency |
---|---|---|
Build a domain. |
build_mfp.ksh |
None |
Patch a domain when the configuration changes do not affect formatting. |
patch_mfp_keepformats.ksh |
None |
Patch a domain when the configuration changes require updates to formatting. |
patch_mfp_deleteformats.ksh |
None |
This section contains detailed information on the following build scripts:
Script
build_mfp.ksh
Usage
build_mfp.ksh
Error Information
Table 3-2 Building a Domain Error Information
Task Name | Error Code | Abort Required? | Description of Error |
---|---|---|---|
build_mfp |
-1 |
yes |
Error during domain build. |
build_mfp |
-2 |
yes |
Error when loading users. |
build_mfp |
-3 |
yes |
Error when loading measures. |
build_mfp |
-4 |
yes |
Error in the master domain calculations. |
build_mfp |
-5 |
yes |
localdomainlist.cfg file is not found. |
build_mfp |
-6 |
yes |
Error in local domain calculations. |
build_mfp |
-7 |
yes |
Error when disabling commit later and insert measure functionality. |
build_mfp |
-8 |
yes |
Error when running copyDomain to set 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 Classic Client or 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: usermgr, mace, loadmeasure, copyDomain, and domainprop. See the Oracle Retail Predictive Application Server Administration Guide for the Classic Client or the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client for details on these utilities.
All hierarchy and measure files need to be placed in $MFP_HOME/input
before the execution of this script.
The commit later and insert measure functionality is disabled.
When changes have been made to MFP that require changes to the domain, the following scripts are used to apply the patch to the domain.
Script
patch_mfp_keepformats.ksh
or
patch_mfp_deleteformats.ksh
Usage
patch_mfp_keepformats.ksh
patch_mfp_deleteformats.ksh
Error Information
Table 3-3 Patching a Domain Error Information
Task Name | Error Code | Abort Required? | Description of Error |
---|---|---|---|
patch_mfp_deleteformats |
-10 |
yes |
Missing configuration file |
patch_mfp_deleteformats |
-10 |
yes |
Error during domain patch. |
patch_mfp_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 utilize the Configuration Tools rpasInstall utility to build a domain. See the Oracle Retail Predictive Application Server Administration Guide for the Classic Client or the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client for details on this utility.
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 Classic Client or the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client.
Data is loaded into MFP using the standard RPAS approach. See the Oracle Retail Predictive Application Server Administration Guide for the Classic Client or 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. If you are using the ODI enabled integration, see Chapter 4, "Fashion Planning Bundle and ODI Integration" for more information on data integration among Fashion Planning Bundle applications. If you are using script integration for the bundle, see Chapter 5, "Script Integration". For information about RMS integration, see Chapter 6, "RMS and Retail Analytics Integration". For information on batch scripts, see Chapter 7, "Batch Processing".