| Oracle® Retail Merchandise Financial Planning Operations Guide Release 14.1 E55750-01 |
|
 Previous |
| Oracle® Retail Merchandise Financial Planning Operations Guide Release 14.1 E55750-01 |
|
Previous |
This chapter contains all the scripts that are needed to run and maintain the MFP environment.
The following directories are used by the batch scripts. These directories are subdirectories of the $MFP_HOME directory.
Table 7-1 Directories Used by Batch Scripts
| Directory Name | Content of the Directory |
|---|---|
|
Bin |
Batch scripts |
|
Config |
MFP template configuration |
|
Domain |
Domains |
|
Input |
Input files for building the domain |
|
logs |
Log files from running any of the batch scripts A system administrator can scan the logs for any errors, exceptions, or failures. If there are none, the batch completed successfully. |
|
temp |
Temporary files used by the batch scripts |
Scheduling of the batch scripts are in the following categories:
The following information is included in the tables for each batch script:
A short description of the script.
The name of the script.
The directory in the $MFP_HOME/bin directory where the batch script is found.
Dependencies on other batch scripts.
For a detailed description of each script, see Batch Designs.
The daily batch scripts are run every day before executing the weekly batch scripts.
Table 7-2 lists information on the daily batch script. For more information on the Load Actuals and Export to IP scripts, see Integration Scripts in Chapter 5.
The daily batch scripts are run before executing the weekly batch scripts.
Table 7-3 lists information on the weekly batch scripts.
Table 7-3 Weekly Batch Scripts
| Description | Script Name | Batch Directory | Dependency |
|---|---|---|---|
|
Backup |
N/A |
N/A |
N/A |
|
Export to AP |
exportToAP.ksh |
bin |
Backup |
|
Export to IP |
exportToIP.ksh |
bin |
Backup |
|
Calendar Hierarchy Load |
loadhier.ksh |
loadhier |
Backup |
|
Product Hierarchy Load |
loadhier.ksh |
loadhier |
Backup |
|
Location Hierarchy Load |
loadhier.ksh |
loadhier |
Backup |
|
Load on order data |
loadActuals.ksh |
bin |
Calendar Hierarchy Load, Product Hierarchy Load, Location Hierarchy Load |
|
Load Actuals data |
loadActuals.ksh |
bin |
Calendar Hierarchy Load, Product Hierarchy Load, Location Hierarchy Load |
|
Load IP data |
loadActuals.ksh |
bin |
Calendar Hierarchy Load, Product Hierarchy Load, Location Hierarchy Load, and export file ready from IP |
|
Propagate inventory and aggregate data for all planning levels |
processactuals.ksh |
actualize |
Load on order data, Load Actuals data |
|
Generate sales forecast |
runforecast.ksh |
forecast |
Load on order data, Load Actuals data |
|
Refresh existing workbooks Note: This script is optional. |
refresh.ksh |
workbook |
Generate sales forecast |
|
Auto build workbooks placed on queue Note: This script is optional. |
autobuild.ksh |
workbook |
None |
The following script is not part of a normal batch schedule. This script is run as a one-off process to perform the specified activity.
Table 7-4 lists information on the unscheduled administration script.
These scripts are included in the other batch scripts to control logging and set environment variables.
The first script, message.ksh, controls the overall logging. The script writes batch script details to a daily log file. The daily log file is created in the $MFP_HOME/logs directory. The format of the file name is MnthID_Day.log, for example, Apr_02.log.
The second script, environment.ksh, is called at the beginning of every batch script. This script sets the following environment variables:
export MFP_CONFIGNAME=mfprtl for MFP Retail and mfpcst for MFP Cost
export MFP_DOMAINHOME=$MFP_HOME/domain
export MFP_MASTERDOMAIN=$MFP_DOMAINHOME/mfprtl for MFP Retail and mfpcst for MFP Cost
export MFP_CONFIGHOME=$MFP_HOME/config
export MFP_EXPORT=$MFP_HOME/export
export MFP_INPUTHOME=$MFP_HOME/input
export MFP _LOG_DIR=$MFP_HOME/logs
export MFP _LIB=$MFP_HOME/bin
export MFP _TEMP=$MFP_HOME/temp
export MFP _BATCH=$MFP_HOME/bin
export LOGLEVEL=all
The LOGLEVEL parameter can be set to any of the RPAS supported logging levels—all, profile, debug, audit, information, warning, error, and none.
This section contains detailed information on the following batch scripts:
Some of the scripts have a command line argument to set the maximum number of processes that need to be run in parallel. Setting this argument can help speed up the performance of independent tasks on local domains. The default is 1.
Script
loadhier.ksh
Usage
loadhier.ksh <hierarchy> <purgeage> <maxprocesses>
Table 7-5 Calendar Hierarchy Load Usage
| Argument | Description | Notes |
|---|---|---|
|
hierarchy |
Sets the RPAS name of the hierarchy to be loaded. |
The default for the calendar hierarchy is clnd. |
|
purgeage |
Sets the number of days after updating a hierarchy position before purging the position. |
The default is 10000. |
|
maxprocesses |
Sets the maximum number of hierarchy load processes to run in parallel. |
The default is 1. |
Example
loadhier.ksh clnd 10000 10
Table 7-6 Calendar Hierarchy Load Error Information
| Task Name | Error Code | Abort Required? | Description of Error |
|---|---|---|---|
|
loadhier |
20 |
yes |
One or more arguments are missing. |
|
loadhier |
21 |
yes |
Domain does not exist. |
|
loadhier |
22 |
no |
Hierarchy file does not exist. |
|
loadhier |
24 |
yes |
Loading the hierarchy produced errors. Further batch processing should not be run until the error has been investigated. |
Notes
Before running this script, a clnd.dat file must exist in the input directory of the domain. This can be created by running the transformation scripts to transform the RMS files. For more information, see Chapter 6, "RMS and Retail Analytics Integration".
This script uses the RPAS loadHier utility. 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 calendar, product, and location hierarchy loads can be run in any order.
Script
loadhier.ksh
Usage
loadhier.ksh <hierarchy> <purgeage> <maxprocesses>
Table 7-7 Product Hierarchy Load Usage
| Argument | Description | Notes |
|---|---|---|
|
hierarchy |
Sets the RPAS name of the hierarchy to be loaded. |
The default for the product hierarchy is prod. |
|
purgeage |
Sets the number of days after updating a hierarchy position before purging the position. |
The default is 10000. |
|
maxprocesses |
Sets the maximum number of hierarchy load processes to run in parallel. |
The default is 1. |
Example
loadhier.ksh prod 10000 10
Table 7-8 Product Hierarchy Load Error Information
| Task Name | Error Code | Abort Required? | Description of Error |
|---|---|---|---|
|
loadhier |
20 |
yes |
One or more arguments are missing. |
|
loadhier |
21 |
yes |
Domain does not exist. |
|
loadhier |
22 |
no |
Hierarchy file does not exist. |
|
loadhier |
24 |
yes |
Loading the hierarchy produced errors. Further batch processing should not be run until the error has been investigated. |
Notes
Before running this script, a prod.dat file must exist in the input directory of the domain. This can be created by running the transformation scripts to transform the RMS files. For more information, see Chapter 6, "RMS and Retail Analytics Integration".
This script uses the RPAS loadHier utility. 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 calendar, product, and location hierarchy loads can be run in any order.
Script
loadhier.ksh
Usage
loadhier.ksh <hierarchy> <purgeage> <maxprocesses>
Table 7-9 Location Hierarchy Load Usage
| Argument | Description | Notes |
|---|---|---|
|
hierarchy |
Sets the RPAS name of the hierarchy to be loaded. |
The default for the product hierarchy is loc. |
|
purgeage |
Sets the number of days after updating a hierarchy position before purging the position. |
The default is 10000. |
|
maxprocesses |
Sets the maximum number of hierarchy load processes to run in parallel. |
The default is 1. |
Example
loadhier.ksh loc 10000 10
Table 7-10 Location Hierarchy Load Error Information
| Task Name | Error Code | Abort Required? | Description of Error |
|---|---|---|---|
|
loadhier |
20 |
yes |
One or more arguments are missing. |
|
loadhier |
21 |
yes |
Domain does not exist. |
|
loadhier |
22 |
no |
Hierarchy file does not exist. |
|
loadhier |
24 |
yes |
Loading the hierarchy produced errors. Further batch processing should not be run until the error has been investigated. |
Notes
Before running this script, a loc.dat file must exist in the input directory of the domain. This can be created by running the transformation scripts to transform the RMS files. For more information, see Chapter 6, "RMS and Retail Analytics Integration".
This script uses the RPAS loadHier utility. 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 calendar, product, and location hierarchy loads can be run in any order.
Script
loadActuals.ksh
Usage
loadActuals.ksh <measurelist> <maxprocesses>
Table 7-11 Load On Order Data
| Argument | Description | Notes |
|---|---|---|
|
measurelist |
Sets the location of the file which contains the list of measures to be exported. |
By default, these files are provided with the package in the |
|
maxprocesses |
Sets the maximum number of export processes to run in parallel. |
The default is 1. |
Control File
LoadOnOrderList.txt: Contains the following list of measures that can be loaded as part of this script:
MFP Cost
drtyonordc
drtyonordu
MFP Retail
drtyonordc
drtyonordu
drtyonordr
Example
loadActuals.ksh LoadOnOrderList.txt 1
Error Information
Table 7-12 Load Actuals Error Information
| Task Name | Error Code | Abort Required? | Description of Error |
|---|---|---|---|
|
loadactuals |
40 |
yes |
One or more arguments are missing. |
|
loadactuals |
41 |
yes |
Domain does not exist. |
|
loadactuals |
42 |
no |
Data file does not exist. |
|
loadactuals |
43 |
yes |
All measure input files are empty or missing. |
|
loadactuals |
44 |
yes |
Configuration file does not exist. |
|
loadactuals |
45 |
yes |
Errors occurred during the load of one or more measures. |
Notes
If you are using RMS on order file, ensure that you run the transformation and transfer the load ready file to the input directory of the domain. For more information, see Chapter 6, "RMS and Retail Analytics Integration".
This script uses the RPAS loadmeasure utility. See the RPAS Administration Guide for the Classic Client or the RPAS Administration Guide for the Fusion Client for details on this utility.
The script ignores any missing or empty measure load files.
All measure files are placed into the domain's input folder.
If there were no errors during the loading of all measures, the input file is archived into the domain's input/processed directory. A date stamp is appended to the end of the file name.
The script does not produce an error when records are rejected from the loaded files. These rejected records are logged in the log output of the load process.
Script
loadActuals.ksh
Usage
loadActuals.ksh <measurelist> <maxprocesses>
Table 7-13 Load Actuals Data
| Argument | Description | Notes |
|---|---|---|
|
measurelist |
Sets the location of the file which contains the list of measures to be exported. |
By default, these files are provided with the package in the |
|
maxprocesses |
Sets the maximum number of export processes to run in parallel. |
The default is 1. |
Control File
LoadActualsList.txt: Contains the following list of measures that can be loaded as part of this script:
MFP Cost
| drtybopclrc | drtybopclru | drtybopregc |
| drtybopregu | drtyeopclrc | drtyeopclru |
| drtyeopregc | drtyeopregu | drtyrecc |
| drtyrecu | drtyslsclrr | drtyslsclru |
| drtyslsclrc | drtyslspror | drtyslsprou |
| drtyslsproc | drtyslsregr | drtyslsregu |
| drtyslsregc | drtydevalc | buwpvatp |
| drtyshrinkc | drtyshrinku | drtymiscinc |
| drtymiscinu | drtymiscoutc | drtymiscoutu |
MFP Retail
| drtybopclrc | drtybopclru | drtybopclrr |
| drtybopregc | drtybopregu | drtybopregr |
| drtyeopclrc | drtyeopclru | drtyeopclrr |
| drtyeopregc | drtyeopregu | drtyeopregr |
| drtyrecc | drtyrecu | drtyrecr |
| drtyslsclrr | drtyslsclru | drtyslspror |
| drtyslsprou | drtyslsregr | drtyslsregu |
| buwpvatp | drtyshrinkr | drtyshrinku |
| drtymiscinr | drtymiscinu | drtymiscoutr |
| drtymiscoutu | drtymkdr | drtymkupr |
Example
loadActuals.ksh LoadOnOrderList.txt 1
Error Information
Table 7-14 Load Actuals Data Error Information
| Task Name | Error Code | Abort Required? | Description of Error |
|---|---|---|---|
|
loadactuals |
40 |
yes |
One or more arguments are missing. |
|
loadactuals |
41 |
yes |
Domain does not exist. |
|
loadactuals |
42 |
no |
Data file does not exist. |
|
loadactuals |
43 |
yes |
All measure input files are empty or missing. |
|
loadactuals |
44 |
yes |
Configuration file does not exist. |
|
loadactuals |
45 |
yes |
Errors occurred during the load of one or more measures. |
Notes
If you are using RMS inventory file, ensure that you run the transformation and transfer the load ready file to the input directory of the domain. For more information, see Chapter 6, "RMS and Retail Analytics Integration".
This script uses the RPAS loadmeasure utility. 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.
The script ignores any missing or empty measure load files.
All measure files are placed into the domain's input folder.
If there were no errors during the loading of all measures, the input file is archived into the domain's input/processed directory. A date stamp is appended to the end of the file name.
The script does not produce an error when records are rejected from the loaded files. These rejected records are logged in the log output of the load process.
Script
loadActuals.ksh
Usage
loadActuals.ksh <measurelist> <maxprocesses>
Table 7-15 Load IP Data
| Argument | Description | Notes |
|---|---|---|
|
measurelist |
Sets the location of the file which contains the list of measures to be exported. |
By default, these files are provided with the package in the |
|
maxprocesses |
Sets the maximum number of export processes to run in parallel. |
The default is 1. |
Control File
LoadActualsList.txt: Contains the following list of measures that can be loaded as part of this script.
MFP Cost
| ipcpbopc ipcpbopc | ipcpbopu ipcpbopu | ipcpeopc ipcpeopc |
| ipcpeopu ipcpeopu | ipcpgmpv ipcpgmpv | ipcprecc ipcprecc |
| ipcprecu ipcprecu | ipcpslsc ipcpslsc | ipcpslsr ipcpslsr |
| ipcpslsu ipcpslsu | ipopbopc ipopbopc | ipopbopu ipopbopu |
| ipopeopc ipopeopc | ipopeopu ipopeopu | ipopgmpv ipopgmpv |
| ipoprecc ipoprecc | ipoprecu ipoprecu | ipopslsc ipopslsc |
| ipopslsr ipopslsr | ipopslsu ipopslsu |
MFP Retail
| ipcpbopc ipcpbopc | ipcpbopu ipcpbopu | ipcpeopc ipcpeopc |
| ipcpeopu ipcpeopu | ipcpgmpv ipcpgmpv | ipcprecc ipcprecc |
| ipcprecu ipcprecu | ipcpslsr ipcpslsr | ipcpslsu ipcpslsu |
| ipcpbopr ipcpbopr | ipcpeopr ipcpeopr | ipcprecr ipcprecr |
| ipopbopc ipopbopc | ipopbopu ipopbopu | ipopeopc ipopeopc |
| ipopeopu ipopeopu | ipopgmpv ipopgmpv | ipoprecc ipoprecc |
| ipoprecu ipoprecu | ipopslsr ipopslsr | ipopslsu ipopslsu |
| ipopbopr ipopbopr | ipopeopr ipopeopr | ipoprecr ipoprecr |
Example
loadActuals.ksh LoadActualsList.txt 1
Error Information
Table 7-16 Load Actuals Data Error Information
| Task Name | Error Code | Abort Required? | Description of Error |
|---|---|---|---|
|
loadactuals |
40 |
yes |
One or more arguments are missing. |
|
loadactuals |
41 |
yes |
Domain does not exist. |
|
loadactuals |
42 |
no |
Data file does not exist. |
|
loadactuals |
43 |
yes |
All measure input files are empty or missing. |
|
loadactuals |
44 |
yes |
Configuration file does not exist. |
|
loadactuals |
45 |
yes |
Errors occurred during the load of one or more measures. |
Notes
This script uses the RPAS loadmeasure utility. 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 ignores any missing or empty measure load files.
All measure files are placed into the domain's input folder.
If there were no errors during the loading of all measures, the input file is archived into the domain's input/processed directory. A date stamp is appended to the end of the file name.
The script does not produce an error when records are rejected from the loaded files. These rejected records are logged in the log output of the load process.
Script
processactuals.ksh
Usage
processactuals.ksh
Error Information
Table 7-17 Process Actuals Error Information
| Task Name | Error Code | Abort Required? | Description of Error |
|---|---|---|---|
|
processactuals |
60 |
yes |
Domain does not exist. |
|
processactuals |
61 |
yes |
Errors occurred during the processing of actualized data. |
Notes
This script uses the RPAS mace utility. 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 can run the batch_calc rule group.
Script
runforecast.ksh
Usage
runforecast.ksh
Error Information
Table 7-18 Run Batch Forecast Error Information
| Task Name | Error Code | Abort Required? | Description of Error |
|---|---|---|---|
|
runforecast |
70 |
yes |
Domain does not exist. |
|
runforecast |
71 |
yes |
Errors occurred during forecast creation. Only forecast measures are affected by this. |
Notes
This script uses the RPAS mace utility. 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 can run the batch_fc rule group. This rule group can execute the in-season and preseason embedded forecasts.
Script
refresh.ksh
Usage
refresh.ksh <maxprocesses>
where
maxprocesses is the maximum number of workbook refresh processes to run in parallel.
Table 7-19 Refresh Workbooks Usage
| Argument | Description | Notes |
|---|---|---|
|
maxprocesses |
Sets the maximum number of refresh processes to run in parallel. |
The default is 1. |
Example
refresh.ksh 10
Error Information
Table 7-20 Refresh Workbooks Error Information
| Task Name | Error Code | Abort Required? | Description of Error |
|---|---|---|---|
|
refresh |
120 |
yes |
Argument missing. |
|
refresh |
121 |
yes |
Domain does not exist. |
|
refresh |
122 |
no |
Workbook list is either blank or missing. This may be the result of there being no workbooks available to refresh. |
|
refresh |
123 |
no |
Errors occurred during workbook refresh processing. |
Notes
This is an optional script. It enables all workbooks to be kept current with the elapsed settings and prevents stale data from being committed.
The script uses the RPAS wbbatch utility to refresh workbooks in the auto build queue. 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.
Workbooks should be committed before running the refresh batch job. If a workbook is not committed, the data in that workbook can be overwritten by data in the domain during the refresh process.
If running both the auto build and refresh scripts, it is important to run the refresh job first. The refresh updates all MFP workbooks saved in the domain. If the auto build is run first, these workbooks are unnecessarily refreshed.
Script
autobuild.ksh
Usage
autobuild.ksh <maxprocesses>
Table 7-21 Auto Build Workbooks Usage
| Argument | Description | Notes |
|---|---|---|
|
maxprocesses |
Sets the maximum number of autobuild workbook processes to run in parallel. |
The default is 1. |
Example
autobuild.ksh 10
Error Information
Table 7-22 Auto Build Workbooks Error Information
| Task Name | Error Code | Abort Required? | Description of Error |
|---|---|---|---|
|
autobuild |
110 |
yes |
Argument missing. |
|
autobuild |
111 |
yes |
Domain does not exist. |
|
autobuild |
112 |
no |
Errors occurred during auto workbook build processing. |
Notes
This script is an optional script. It should be used only if auto workbooks are utilized.
The script uses the RPAS wbbatch utility to build workbooks in the auto build queue. 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.
Auto build entries must be added via the domain before running this script. See the Oracle Retail Predictive Application Server User Guide for the Classic Client or the Oracle Retail Predictive Application Server User Guide for the Fusion Client for details on this process.
If you are running both the auto build and refresh scripts, it is important to run the refresh job first. The refresh updates all MFP workbooks saved in the domain. If the auto build is run first, these workbooks are unnecessarily refreshed.
Script
loadActuals.ksh
Usage
loadActuals.ksh <measurelist> <maxprocesses>
Table 7-23 Load Mapping Measures Usage
| Argument | Description | Notes |
|---|---|---|
|
measurelist |
Sets the location of the file which contains the list of measures to be exported. |
By default, these files are provided with the package in the |
|
maxprocesses |
Sets the maximum number of export processes to run in parallel. |
The default is 1. |
Control File
LoadMapList.txt: Contains the following list of measures that can be loaded as part of this script:
bulylagtx
buallagtx
Example
loadActuals.ksh LoadMapList.txt 1
Error Information
Table 7-24 Load Actuals Error Information
| Task Name | Error Code | Abort Required? | Description of Error |
|---|---|---|---|
|
loadactuals |
40 |
yes |
One or more arguments are missing. |
|
loadactuals |
41 |
yes |
Domain does not exist. |
|
loadactuals |
42 |
no |
Data file does not exist. |
|
loadactuals |
43 |
yes |
All measure input files are empty or missing. |
|
loadactuals |
44 |
yes |
Configuration file does not exist. |
|
loadactuals |
45 |
yes |
Errors occurred during the load of one or more measures. |
Notes
This script uses the RPAS loadmeasure utility. 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 ignores any missing or empty measure load files.
All measure files are placed into the domain's input folder.
If there were no errors during the loading of all measures, the input file is archived into the domain's input/processed directory. A date stamp is appended to the end of the file name.
The script does not produce an error when records are rejected from the loaded files. These rejected records are logged in the log output of the load process.
