Skip Headers
Oracle® Retail Merchandise Financial Planning Operations Guide
Release 14.1
E55750-01
  Go To Table Of Contents
Contents

Previous
Previous
 
Next
Next
 

5 Script Integration

This chapter describes the script integration of the Fashion Planning Bundle applications.

For information about ODI enabled integration for the Fashion Planning Bundle, see Chapter 4, "Fashion Planning Bundle and ODI Integration". For information about RMS integration, see Chapter 6, "RMS and Retail Analytics Integration".

Integration Scripts

These scripts can be used for moving data between applications. The following rules apply to integration scripts:

  • The exportMeasure utility is used to export data in CSV (comma-separated values) format. This maintains the consistency of start and width attributes across different applications.

  • Data exported from a source application is placed in the destination domain input directory.

  • Export scripts must run before load scripts. They should be run in the batch window.

  • Measure names should not be hard-coded. The names are included in a text file named <source application>_<destination application>_transferList.txt. For example, MFP_AP_transferList.txt includes the measure names exported from MFP to AP.

    Each transfer file includes two columns that correspond to the following data:

    • Measure name

    • File name

    When the transfer file is used for a load script, it contains the name of the measure to be loaded and the name of the file that contains the data.

    For an export script, the transfer file contains the name of the measure in the source application and the name of the ovr file that will be created in the input directory of the destination application. The file names correspond to the measure names in the destination application.

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

  • Do not hard-code domain paths. The paths are entered as command-line arguments.

Table 5-1 lists the integration scripts for MFP. These scripts are located in
$MFP_HOME/bin
.

Table 5-1 Integration Script

Application Script Name Arguments

MFP

loadacutals.ksh

measurelist, maxprocesses

IP

exportToIP.ksh

maxprocesses, destination, measurelist

AP

exportToAP.ksh

maxprocesses, destination, measurelist

IP and AP

resetExportFlags.ksh

none


Batch Designs

This section contains detailed information on the following integration scripts:

Load Actuals

Script
loadActuals.ksh

Usage
loadActuals.ksh <measurelist> <maxprocesses>

Table 5-2 Load Actuals 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 $MFP_HOME/bin directory. The file name should follow the convention of
IP_MFP_transferList.txt.

maxprocesses

Sets the maximum number of export processes to run in parallel.

The default is 1.


Control File
IP_MFP_transfer_list.txt contains the following list of measures that can be loaded as part of this script:

MFP Cost

List of Measures
ipcpbopc ipcpslsc ipopgmpv
ipcpbopu ipcpslsr ipoprecc
ipcpeopc ipcpslsu ipoprecu
ipcpeopu ipopbopc ipopslsc
ipcpgmpv ipopbopu ipopslsr
ipcprecc ipopeopc ipopslsu
ipcprecu ipopeopu

MFP Retail

List of Measures
ipcpbopc ipcpslsu ipopgmpv
ipcpbopu ipcpbopr ipoprecc
ipcpeopc ipcpeopr ipoprecu
ipcpeopu ipcprecr ipopslsr
ipcpgmpv ipopbopc ipopslsu
ipcprecc ipopbopu ipopbopr
ipcprecu ipopeopc ipopeopr
ipcpslsr ipopeopu ipoprecr

Example
loadActuals.ksh IP_MFP_transfer_list.txt 1

Error Information

Table 5-3 Load Actuals Error Information

Task Name Error Code Abort Required? Description of Error

loadactuals

40

yes

Arguments are missing.

loadactuals

41

yes

Domain path does not exist.

loadactuals

42

yes

Data file does not exist.

loadactuals

43

no

All measure input files are empty or missing.

loadactuals

44

no

localdomainlist.cfg file is missing.

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.

Export to IP

Script
exportToIP.ksh

Usage
exportToIP.ksh <maxprocesses> <destination> <measurelist>

Table 5-4 Export to IP Usage

Argument Description Notes

maxprocesses

Sets the maximum number of export processes to run in parallel.

The default is 1.

destination

Sets the path to the input folder of the destination domain where the exported files are placed.

The export script creates the file containing the exported measures in the input folder of the destination domain.

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 $MFP_HOME/bin directory. The file name should follow the convention of MFP_IP_transferList.txt.


Control File
MFP_IP_transfer_list.txt contains the following list of measures that can be exported as part of this script:

MFP Cost

List of Measures
buopbopc buopbopc buopeopu buopeopu bucpeopc bucpeopc
buopeopc buopeopc buoprecu buoprecu bucpgmpv bucpgmpv
buopgmpv buopgmpv buopslsu buopslsu bucprecc bucprecc
buoprecc buoprecc bucpbopu bucpbopu bucpslsc bucpslsc
buopslsc buopslsc bucpeopu bucpeopu bucpslsnetr bucpslsnetr
buopslsnetr buopslsnetr bucprecu bucprecu bucpslsr bucpslsr
buopslsr buopslsr bucpslsu bucpslsu
buopbopu buopbopu bucpbopc bucpbopc

MFP Retail

List of Measures
bucpbopc bucpbopc buopbopc buopbopc bucpbopu bucpbopu
bucpbopr bucpbopr buopbopr buopbopr bucpeopu bucpeopu
bucpeopc bucpeopc buopeopc buopeopc bucprecu bucprecu
bucpeopr bucpeopr buopeopr buopeopr bucpslsu bucpslsu
bucpgmpv bucpgmpv buopgmpv buopgmpv buopbopu buopbopu
bucpmkdr bucpmkdr buopmkdr buopmkdr buopeopu buopeopu
bucprecc bucprecc buoprecc buoprecc buoprecu buoprecu
bucprecr bucprecr buoprecr buoprecr buopslsu buopslsu
bucpslsr buopbopc buopslsr buopslsr

Error Information

Table 5-5 Export to IP Error Information

Task Name Error Code Abort Required? Description of Error

export

200

yes

Argument missing.

export

210

yes

Domain does not exist.

export

220

yes

Missing $EXPORTLISTFILE.

export

230

no

Errors found in the export log file.


Notes

  • This optional script is used only if exports to IP are required.

  • The script uses the RPAS exportMeasure utility to export measure data from the 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 exportToIP.ksh script does not clear the export (approval) flags. In order to clear the export flags, the customer must run the script resetExportFlags.ksh. See Reset Export Flags for details.

Export to AP

Script
exportToAP.ksh

Usage
exportToAP.ksh <maxprocesses> <destination> <measurelist>

Table 5-6 Export to AP Usage

Argument Description Notes

maxprocesses

Sets the maximum number of export processes to run in parallel.

The default is 1.

destination

Sets the path to the input folder of the destination domain where the exported files are placed.

The export script creates the file containing the exported measures in the input folder of the destination domain.

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 $MFP_HOME/bin directory. The file name should follow the convention of MFP_AP_transferList.txt.

exportAtSubclas

Sets the product level for the exported measure data to be sub-class instead of class.

By default, the product level for the exported measure data is class. This argument changes the product level of the export to sub-class.


Control File

MFP_AP_transfer_list.txt contains the following list of measures that can be exported as part of this script:

MFP Cost

List of Measures
bucpgmpv mfcpposgmr bucpslsr mfcpslsr bucpslsu mfcpslsu
bucprecc mfcprecc bucpslsr mfcpslsr

MFP Retail

List of Measures
bucpgmpv mfcpposgmr bucpslsr mfcpslsr bucpslsu mfcpslsu
bucprecc mfcprecc bucprecu mfcprecu bucprecr mfcprecr

Error Information

Table 5-7 Export to AP Error Information

Task Name Error Code Abort Required? Description of Error

export

200

yes

Argument missing.

export

210

yes

Domain does not exist.

export

220

yes

Missing $EXPORTLISTFILE.

export

230

no

Errors found in the export log file.


Notes

  • This optional script is used only if exports to AP are required.

  • The script uses the RPAS exportMeasure utility to export measure data from the 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 exportToIP.ksh script does not clear the export (approval) flags. In order to clear the export flags, the customer must run the script resetExportFlags.ksh. See Reset Export Flags for details.

Reset Export Flags

Script

resetExportFlags.ksh

Usage

resetExportFlags.ksh

Table 5-8 Export Flag Measures

Measure Name

Measure Label

mowpappcpnewb

Wp Newly approved CP (used by ODI)

mowpappopnewb

Wp Newly approved OP (used by ODI)

modyappcpnewb

Wp Newly approved CP (used in export script)

modyappopnewb

Wp Newly approved OP (used in export script)


Notes

  • This optional script is used to clear the Boolean measures listed in Table 5-8.

  • If the customer will only be exporting MFP data to one external application (either Assortment Planning or Item Planning), the customer may wish to have these flags reset automatically after the export of the MFP data. To do so, the customer should uncomment the following two lines in exportToAP.ksh or in exportToIP.ksh:

    # _call "$MFP_HOME/bin/resetExportFlags.ksh"
    # _verify_script
    

    To uncomment these two lines, remove the "#" from the beginning of each line.

  • If the customer will be exporting MFP data both to AP and to IP, the customer may wish to train the users to do the exports in a particular order and only uncomment the above two lines in one of the export scripts but leave them commented out in the other export script.

    For example, if the customer always exports MFP-to-AP followed by MFP-to-IP, then the customer could execute the script exportToAP.ksh as is (with the call to resetExportFlags.ksh commented out), which would leave the approval flags unchanged, but have exportToIP.ksh reset the flags by uncommenting out the above lines.