6 Script Integration

This chapter the script integration of Assortment Planning with the Fashion Planning Bundle applications.

Integration Scripts

Integration scripts are used for moving data between applications. The following rules apply to integration scripts:

The exportMeasure utility is used to export data in comma-separated values (CSV) 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.
Measure names should not be hard-coded. The names are included in a text file named <source application>_<destination application>_transferList.txt. For example, AP_IP_transferList.txt includes the measure names exported from AP to IP.

Each transfer file includes three columns that correspond to the following data:
- Source measure name
- Destination measure name
- Measure base intersection
When the transfer file is used for a load script, it contains the name of the measure to be loaded. The file names correspond to the measure names.
Do not hard-code domain paths. The paths are entered as command-line arguments.
The Batch Script Architecture (BSA) is utilized to provide enterprise-ready architecture for parallel process control, log consolidation, and dependency checks. See Oracle Retail Batch Script Architecture Implementation Guide.

Table 6-1 lists the integration scripts for AP.

Table 6-1 Integration Scripts

Application	Script Name
MFP/DW	ap_load_measures.ksh
IP	exportToIP_noODI.ksh
Allocation	exportToAlloc.ksh
SPO	importfromSPO.ksh, exportToPPK.ksh

Batch Environment Scripts

For information on these scripts, see "Batch Environment Scripts" in Chapter 7.

Batch Designs

This section contains detailed information on the following integration tasks:

Load Measure Data
Export to IP
Export to SPO
Export to Allocation

Load Measure Data

This script loads the data for the measures listed in the base_importlist.txt file. The list of measures captures all the data expected to be loaded to AP from other applications. During implementation, this list should be divided into files that should be loaded daily, weekly, monthly, yearly, and so on.

Script

ap_load_measures.ksh

importdata.ksh

Usage

importdata.ksh <measurelist>

Table 6-2 Load Measure Data

Argument	Description	Notes
measurelist	Sets the location of the file that contains the list of measures to be loaded.	By default, these files are provided with the package in the `$AP_HOME/bin` directory. The file name can be tailored during implementation and used with the importdata.ksh script. The file name used in the GA version is base_importlist.txt.

Example

importdata.ksh base_importlist.txt

Notes

ap_load_measures.ksh is a wrapper script to call the importdata.ksh to load the data listed in the base_importlist.txt file.
This script uses the RPAS loadmeasure utility. See 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. Master domain input directory if the domain structure is Global domain.
All errors and messages are processed by BSA. Refer to the BSA log files for information.
importdata.ksh can be utilized to set up the daily, weekly, monthly, and yearly data load process.

Export to IP

This script exports the AP data required for IP. AP exports the data in flat file format which can then be imported directly by IP using the standard RPAS loadmeasure utility.

Script

exportToIP_noODI.ksh

Usage

exportToIP_noODI.ksh <maxprocesses> <destination> <measurelist>

Table 6-3 Export to IP Script Arguments

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 CSV file containing the exported measure data 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, this file is provided with the package in the $AP_HOME/bin directory. The file name used in the GA version is AP_IP_transferList.txt.

Example

exportToIP_noODI.ksh 4 /{domainpath}/itemplan AP_IP_transferList.txt

Notes

This script is optional and should be used only if exports to IP are required.
The script uses the RPAS exportData utility to export measure data from the domain.. It also uses the RPAS mace utility to preprocess the AP data for the IP export. See the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client for details on these utilities.
By default, the script generates the output CSV file with a .rpl extension. This can be changed to other file extension types depending on the destination domain's requirement for this data import. See the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client for the data file extension types.
This script calls a rule group called AP_to_IP. This rule group preprocesses the AP data for the IP export. See Chapter 7 for more details about this rule group.

Export to Allocation

This script exports the AP Receipt Units measure for use by Allocation. AP exports the data in a flat file formatted for use within Allocation. Allocation then uses Oracle Retail Extract Transform and Load (RETL) to extract this information.

Script

exportToAlloc.ksh

Usage

exportToAlloc.ksh <domain> <excluded diff>

Table 6-4 Export to Allocation Script Arguments

Argument	Description	Values Allowed
domain	Sets the path to the current domain.	-d {current domain}. Master domain in Global domain environment.
excluded diff	Sets the no color differentiator for the output file.	-e {excluded diff} Default value: None

Argument

Description

Values Allowed

domain

Sets the path to the current domain.

-d {current domain}. Master domain in Global domain environment.

excluded diff

Sets the no color differentiator for the output file.

-e {excluded diff}

Default value: None

Export File Naming Convention

The output file name starts with lower-case p and follows a standard naming convention:

p<diff count><product level><domain ID> where

<diff count> represents the number of differentiators included in the output. Only a single differentiator which is color is exported. Hence this value is always 1; 0 if -e exclude differentiator is not used.
<product level> is a four-character sequence representing the product level at which the export is prepared. The valid values are itpt (item), scls (subclass), clss (class), and dept (department).
<domain ID> is a constant with a value 01.

Example

Products: item1, item2, item3, item4

Diff/Color: Red, Blue, Purple, Blue

Receipt U: 10, 11, 12, 13, 14

When executed with "exportToAlloc.ksh -d {domain} -e Blue" would result in 2 outputs:

p0itpt.01 file containing: item1 Red 10, item3 Purple 13
p1itpt.01 file containing: item2 Blue 11, item4 Blue 14

Export File Format

Table 6-5 Export File Format

Field Name	Start Position	Width	Format	Sample Content
Product ID	1	25	Alpha	100045078
Location ID	26	20	Alpha	10000002
Diff ID	46	48	Alpha	_Cc1001
EOW Date	94	8	Alpha	20150125
Quantity	102	12	Numeric	100

Import from SPO

This script loads the data from Oracle Retail Size Profile Optimization (SPO). Measure data files from SPO need to be placed in the <domain>/input directory. This script calls importdata.ksh with a list of measure names defined in SPO_AP_transferList.txt.

Script

importFromSPO.ksh

Usage

None

Import List of File Names

Table 6-6 Import from SPO

SPO export file name	AP import file name
sztyarchspl1up	sztyarchspl1p
sztyarchspl2up	sztyarchsp2p
sztyarchspl3up	sztyarchspl3p
sztyarchspl4up	sztyarchspl3p
eptpackdef	szwpeptpackdefu

Notes

This script uses the RPAS loadmeasure utility through importdata.ksh. See the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client for details on this utility.
This script renames the SPO file names to AP file names that are expected by the measure defined in SPO_AP_transferList.txt. Measure name corresponds to file name expected during the import process.
Size profiles and prepack definition data can be entered manually through the Size & Pack Profile Maintenance workbook in AP.

Export to SPO

This script is used to send input data to the Prepack Optimization module in SPO. This is not to be confused with the pack optimization in AP which is used to optimize receipt drops into predefined prepacks and eaches.

Script

exportToPPK.ksh

Usage

exportToPPK.ksh <maxprocesses> <destination> <measurelist>

Table 6-7 Export to SPO Arguments

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 file is 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 $AP_HOME/bin directory. . The file name used in the GA version is AP_PPK_transferList.txt

Notes

This script is optional and should be used only if export to SPO (Prepack Optimization module) is required.
The Prepack Optimization module is available as a plug-in which is licensed with SPO. Licensed customers can configure the plug-in with AP.
The script uses the RPAS exportData utility to export measure data from the domain. . It also uses the RPAS mace utility to preprocess the AP data for the IP export. See the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client for details on these utilities.