Oracle® Retail Advanced Inventory Planning Implementation Guide Release 14.1 E64951-02 |
|
![]() Previous |
![]() Next |
AIP Online consists of three different but equally important environments: a UNIX-based platform for executing RETL scripts and batch shell scripts; an Oracle database; and an application server for hosting the web-based Java graphical user interface (GUI). Each environment requires specific values, properties, and files to be configured in order to fully implement the AIP Online portion of the solution.
The batch scripts that execute on the data stored in the Oracle database run on a UNIX-based platform. RETL must be installed, and it must be able to access the AIP Oracle database. In order to execute the batch scripts, config.xml, the integration directories, and any files shared by the Online and RPAS must be set up and operational.
The RETL interface process, run from a UNIX-based platform, is designed to be fully automated once configured. In addition to the environment variables described above, config.xml is required when invoking the RETL scripts. This file should be located in the root integration directory on the UNIX server in which the AIP Online application is installed.
This configuration file contains the database connection information required by RETL for performing import and export operations. Refer to the RETL documentation for detailed descriptions of element definitions.
There are two operator sections that must be completed, one for oraread and one for orawrite. The oraread section defines the properties required for all export operations on the database, and the orawrite section defines these for all import operations. Though both contain similar attributes, it is imperative that each section is defined as needed for the specific Oracle database installation. This information is also dependent on the requirement that all databases can be connected to through a properly defined tnsnames file and reachable by SQLPlus.
Example 5-1 Example config.xml File
<CONFIG> <DEFAULTS operator="oraread"> <PROPERTY name="arraysize" value="@oraread.arraysize@" /> <PROPERTY name="hostname" value="@oraread.hostname@"/> <PROPERTY name="port" value="@oraread.port@"/> <PROPERTY name="dbname" value="@oraread.dbname@"/> <PROPERTY name="dbuseralias" value="@oraread.dbuseralias@"/> </DEFAULTS> <DEFAULTS operator="orawrite"> <PROPERTY name="dbname" value="@orawrite.dbname@"/> <PROPERTY name="hostname" value="@orawrite.hostname@"/> <PROPERTY name="port" value="@orawrite.port@"/> <PROPERTY name="dbuseralias" value="@orawrite.dbuseralias@"/> <PROPERTY name="method" value="@orawrite.method@"/> </DEFAULTS> <NODE hostname="localhost" numpartitions="1" bufsize="2000"> <!-- If you change the TEMPDIR settings, you may also want to change the performance log file location specified in logger.conf. --> <TEMPDIR path="/tmp" /> </NODE> </CONFIG>
The configuration settings listed in Table 5-1 will overwrite the setting in the rfx.conf file.
Table 5-1 Configuration Field Descriptions
Element Name | Attribute Name | Attribute Value/Description |
---|---|---|
NODE |
NODE is a child element of the CONFIG element. |
|
hostname |
The name of the UNIX server where RETL is installed. |
|
bufsize |
The number of records allowed between operators at any given time. The default bufsize is 2048 records. The bufsize can have a significant impact on performance. Setting this value too low causes a significant amount of contention between processes, slowing down RETL. A value that is too high can also slow RETL down because it will consume more memory than it needs to. Finding the right value for your hardware configuration and flow is part of tuning with RETL. |
|
numpartitions |
Optional value, defaults to 1. |
|
TEMPDIR |
TEMPDIR is a child element of the NODE element. This element can be specified more than one time. RETL will use the temporary file directories in a round-robin fashion. |
|
path |
Path to the directory where the RETL writes temporary files. |
The following directories must be created by the system administrator. They are required and will cause errors if absent:
$INTEGRATION_HOME/inbound
$INTEGRATION_HOME/archive
When the AIP-RPAS module is not installed on the same server as the AIP ONLINE module, the shared credential and verification files must be present in both locations.
Table 5-2 lists the files and the appropriate location on the UNIX server. Copy the files from the AIP-RPAS server location to the AIP ONLINE server. Where the destination directory does not exist, one should be made. All server locations are written in reference to the aip_env_online.sh environment variables.
Table 5-2 Shared Files
File Name | Location |
---|---|
prep_files.sh |
$INTEGRATION_HOME/scripts/ |
bsa_prep_files.config |
$INTEGRATION_HOME/config |
bsa_archive.sh |
$INTEGRATION_HOME/bsa |
bsa_check_for_required_files.sh |
$INTEGRATION_HOME/bsa |
bsa_common.sh |
$INTEGRATION_HOME/bsa |
bsa_env.sh |
$INTEGRATION_HOME/bsa |
bsa_prep_files.sh |
$INTEGRATION_HOME/bsa |
bsa_logger.sh |
$INTEGRATION_HOME/bsa |
bsa_para.sh |
$INTEGRATION_HOME/bsa |
bsa_sort.sh |
$INTEGRATION_HOME/bsa |
bsa_sql.sh |
$INTEGRATION_HOME/bsa |
bsa_verify.sh |
$INTEGRATION_HOME/bsa |
The files imported into AIP Online are bundled (in a *.tar file) together into logical groupings based on dependencies and availability within the batch window. Each RETL import file has one, and only one, corresponding script that executes the loading of the file into the database. The execution of all RETL import scripts is controlled by a set of configuration files that list the load scripts to be run and the order in which they will run. Each configuration file corresponds to one *.tar file.
The configuration files can be modified to prevent the execution of load scripts for files that will never be present (for example, they are optional files for functionality that will not be used by the business). For example, Sister Stores cannot be available in the merchandising system to provide to AIP or purged order numbers cannot be available for PO number recycling. The line containing the path to the ”_in.sh” load script should be deleted or commented out.
The configuration files are a command line argument passed to the parent script, process_aiponline_data.sh
. Either a modified configuration file or a specially constructed configuration file can be passed to the parent script to aid the initial, first day import, restart/recovery, or special ad hoc processing.
In addition to the configuration file, the location of import scripts as defined in AIP Online environment variable ONL_IMPORT_DIR is also passed as an argument to the process_aiponline_data.sh
script.
The parent script will execute all load files listed in the configuration file that are passed to it. A warning message will be logged when the load script is run but the corresponding data file is not present.
The import configuration files are listed in Table 5-3, along with any potentially optional load scripts. Optional load scripts are those that are not critical to replenishment processing. They are either related to functionality outside of replenishment or provide special information that can be used as an alternative to the standard processing. Settings in both AIP-RPAS import/export configuration files and AIP Online import configuration files should reflect the file requirements consistently.
Table 5-3 Configuration Files
Configuration File | Optional Load Scripts |
---|---|
import_sku_store_hierarchy.config |
|
import_post_store_hierarchy.config |
|
import_dm.config |
dm_banded_comm_in.sh dm_is_prepriced_in.sh dm_dir_store_frmt_pksz_in.sh dm_dir_store_pksz_in.sh dm_sis_store_in.sh dm_sis_wh_in.sh dm_store_frmt_pksz_in.sh dm_store_pksz_in.sh dm_value_added_comm_in.sh dm_wh_prom_dates_in.sh dm_whse_stop_receipt_in.sh dm_warehouse_unorderable_in.sh dm_alternate_source_list_in.sh |
import_dm_alerts.config |
|
import_sale_date.config |
|
import_om.config |
om_po_recycling_in.sh |
import_sku_attribute.config |
commodity_weight_volume_in.shcommoditiy_cost_in.sh |
import_rms.config |
The files exported from AIP Online are bundled (.tar) together into logical groupings based on dependency. Each RETL export file has one, and only one, corresponding script that executes the extraction of the file data from the database. The execution of all RETL extract scripts is controlled by a set of configuration files that list the export scripts to be run and the order in which they will run.
The configuration files can be modified to prevent the execution of export scripts for files that will never be present (for example, they are optional files for functionality that will not be used by the current client). For example, if Sister Stores are never imported then the copy date never needs to be extracted for AIP on RPAS.
Note: Files that are optional for import cannot be optional for export. Some import files are optional because the data can be loaded. Alternatively, the data can be entered in the Data Management (DM) application. Regardless of how the data gets into the Oracle database, this data is required by AIP-RPAS to run the replenishment batch. |
The configuration files are a command line argument passed to the parent script, process_aiponline_data.sh. A modified configuration file or a specially constructed configuration file can be passed to the parent script to aid restart/recovery or special ad hoc processing.
In addition to the configuration file, the location of export scripts as defined in AIP Online environment variable ONL_EXPORT_DIR is also passed as an argument to the process_aiponline_data.sh script.
The export configuration files are:
export_hierarchy.config
export_dm.config
export_scale.config
export_hierarchy_purge.config
export_schedule.config
export_dcrp.config
The configurations performed in the Oracle database affect how the business uses AIP. Each setting will be used when performing some action (either automatically or manually) of supply chain setup or order execution and maintenance.
Table 5-4 contains the configuration parameters contained in the SYSTEM_PARAMETERS database table, the default value assigned to the parameter, and a description about what the parameters controls. The default parameter values in the table must be set according to your individual business needs.
Note: In addition to the parameters listed in Table 5-4, there are a number of parameters that can be tweaked for performance reasons. These parameters begin with the BFL prefix and serve to limit the number of records retrieved at one time when executing a Bulk Fetch. The parameters are specific to a procedure or function. |
Table 5-4 Configuration Parameters Contained in the SYSTEM_PARAMETERS Database Table
Configuration Parameter | Default Value | Description |
---|---|---|
AIP_VERSION |
14.1 |
The currently installed version of AIP Online. |
ALLOC_INTERFACE_METHOD |
M |
Determines whether allocations are interfaced to external systems through XML messages (M) or text files (F). |
ALTERNATES_AS_PRIMARIES_INDICATOR |
0 |
Scalar value indicating how many delivery days from an Alternate Source should be considered as primary delivery opportunities. Valid values are: 0(None), 1 (Earliest), 2(All). |
AUTO_ASSIGN_CASE_WT |
N |
Indicates whether case weights should be automatically assigned for new SKU/pack size combinations. This flag and the assignment process are deprecated. |
AUTO_ASSIGN_OF_SKUS_TO_PROFILES |
Y |
Indicates whether to automatically assign the SKU of new SKU/supplier combos to profiles. |
AUTO_ASSIGN_ORDER_CYCLES |
Y |
Indicates whether to calculate the store lead time prior to the store opening. If no calculation is performed, the profile order cycle and any applicable exceptions will be used. |
AUTO_ASSIGN_ORDER_MULTIPLES |
Y |
Indicates whether order multiples should be automatically assigned for new SKU/pack size combinations. |
AUTO_ASSIGN_ORDERABLE_UNIT |
N |
Indicates whether location orderable units should be automatically assigned for new SKU/pack size combinations. |
AUTO_ASSIGN_PALLET_MULT |
N |
Indicates whether pallet multiples should be automatically assigned for new SKU/pack size combinations. |
AUTO_ASSIGN_STACKING_FLAG |
N |
Indicates whether stacking flag should be automatically assigned for new SKU/pack size combinations. This flag and the assignment process are deprecated. |
AUTO_ASSIGN_STORE_FORMAT_PACK_SIZE |
Y |
Indicates whether to automatically assign a store format pack size for warehouse and supplier sources. |
AUTO_ASSIGN_WH_PACK_SIZE_RANGES |
Y |
Indicates whether SKU/pack size combinations should be automatically ranged to warehouses. |
AUTO_CREATION_OF_ORDER_GROUP |
Y |
Indicates whether to automatically create order groups for new supplier. |
AUTO_CREATION_OF_PROFILE |
Y |
Indicates whether to automatically create profiles for new suppliers. |
AUTO_RANGE_BY_SHIP_TO_ONLY |
N |
Indicates whether to automatically range new SKU packs only to warehouses that match the supplier Ship To value. Otherwise ranges to all valid SKU pack/warehouse combinations. |
AUTO_RANGE_DEMAND_GROUP |
Y |
Indicates whether to automatically range demand group for new SKU. |
BATCH_LOCK |
N |
The Batch Lock system parameter indicates that user operations are limited in the GUI because batch is running. Possible values are Y (indicating batch in progress, actions will be limited) and N (Batch not in progress, no GUI limitations). See also: BATCH_LOCK_RELEASE_WAVE. |
BATCH_LOCK _RELEASE_WAVE |
-1 |
This parameter holds the release wave that is locked for batch operations (when BATCH_LOCK=Y). A value of -1 indicates an overnight batch run. Valid values are integer values from -0 to 23. |
CMDTY_BATCH |
500 |
The number of commodities to process at a time for Release Schedule Creation. |
CONTAINER_SCALING_GLOBAL_FLAG |
Y |
Indicates whether or not Container Scaling is enabled at a global level. Valid values are Y and N. |
CONTINUE_ORDER_SENDER_BEAN_FOR_PO |
Y |
Switch to start/stop polling for purchase orders by order sender bean. Possible values are Y (start) and N (stop). |
CONTINUE_ORDER_SENDER_BEAN_FOR_TSF |
Y |
Switch to start/stop polling for transfer orders by order sender bean. Possible values are Y (start) and N (stop). |
COPY_SISTER_STORE |
Y |
Indicates whether to copy sister store to associated new store. |
COPY_SISTER_WAREHOUSE |
Y |
Indicates whether to copy sister warehouse to associated new warehouse. |
CROSS_DOCK_CMDTY_BATCH |
500 |
Number of commodities processed at a time by cross docking batch runs. |
DAYS_OF_IGNORED_AVAILABILITY |
1 |
Days of Ignored Availability |
DEFAULT_CASE_WT |
1 |
The default case weight used by the case weight automatic assignment process. This value must be between 0.1 and 9999.99, inclusive. |
DEFAULT_DMG_SIZE |
1 |
The demand group size inserted for all automatically created demand groups. Valid values are 1 (small), 2 (medium), 3 (large), 4 (x-large). |
DEFAULT_DMG_TYPE |
0 |
The demand group type inserted for all automatically created demand groups. Valid values are 0 (cases) and 1 (merchandising unit). |
DEFAULT_STACKING_FLAG |
0 |
The default stacking flag used by the order multiple automatic assignment process. Valid values are: 0 = Yes, 1 = Same, 2 = No. Note that Same implies that only item A can be stacked on top of item A. |
DIFFERENT_ORDER_MULTIPLE_FLAG |
Y |
Indicates if there is more than one order multiple for the scaling group assignments.This parameter is used in PO scaling. |
DLG_OG_VALIDATION_IND |
Y |
This property indicates whether the validation that checks if there is an order group assigned for the given demand group, destination, and effective date should execute. |
DMG_ASSIGNMENT_METHOD |
1 |
The value 1 indicates that new pack sizes associated with an existing SKU will be assigned to the existing SKU's demand group. The value 2 indicates that each new SKU/pack size will be assigned to a unique demand group. |
DROP_INDEX_THRESHOLD_PERCENT |
50 |
This parameter is a percentage of incoming data versus existing data in a table used to decide if indexes should be dropped before load. If calculated percent is more than this value, indexes are dropped during merge load. |
EXT_LOAD_ALLOWED_REJECTS |
10000000000 |
Max Number of Rejects Allowed for External Data Loads |
EXTENDED_PLANNING_HORIZON |
7 |
The number of days beyond the planning horizon for which AIP Online will extract data. This ensures proper order quantities for delivery on the last day of the planning horizon and must match the corresponding AIP-RPAS implementation parameter. |
GATHER_SCHEMA_STATS |
Y |
Switch to turn ON/OFF schema analyze option. A value of Y will turn the option ON, and N will turn the option OFF. |
GATHER_SCHEMA_STATS_ESTIMATE_PERCENT |
100 |
The estimate percent to be used for gathering schema statistics. |
GLOBAL_SMOOTHING_HORIZON |
-1 |
The Global smoothing horizon is a default smoothing horizon value that is used when smoothing horizon at SG level is not specified. Valid values are -1, 0, and a positive integer. A value of -1 indicates the sku planning horizon will be used. |
HEAVY_LOAD_THRESHOLD |
100000 |
This parameter controls the performance of batch load process. If load is more than threshold than local indexes are turned unusable prior to load and rebuild later. |
INDEX_LOGGING |
Y |
This parameter determines whether indexes are rebuild or recreated in regular LOGGING (Y) or NOLOGGING (N) mode. If you can tolerate a window where recovery of the index requires it to be re-created, then consider setting this to N for faster performance. |
INVENTORY_TRACKING_LEVEL |
EACHES |
The level at which inventory is tracked. Valid values are PACKS and EACHES. If the value is EACHES, then the DMG_ASSIGNMENT_METHOD parameter will be overridden, and all pack sizes of a SKU will be assigned to the same demand group. |
MAX_WALKING_LEAD_TIME |
22 |
Indicates the maximum lead time to use in calculating a walking lead time. |
MIN_PLANNING_HORIZON |
35 |
Minimum number of planning days for any SKU. This value is used in SKU planning horizon when there exists no SKU level planning horizon exception or class level planning horizon default. |
MULTIPLE_DELIVERY_DATE_FLAG |
Y |
Indicates if there are multiple delivery dates for a warehouse schedule. This parameter is used in PO scaling. |
OFF_SUPPLY_OFFSET |
3 |
The corporate off-supply offset value is used to calculate off-supply dates based on off-sale dates imported from the merchandising system. Off-supply dates will be set to: [off-sale date] - OFF_SUPPLY_OFFSET. |
ON_OFF_SUPPLY_OVERWRITE_IND |
Y |
Indicates whether or not to update the existing on/off supply dates when importing sale dates. A value of Y will update both on/off supply and on/off sale dates. A value of N will update only the on/off sale dates. |
ON_SUPPLY_OFFSET |
3 |
The corporate on-supply offset value is used to calculate on-supply dates based on on-sale dates imported from the merchandising system. On-supply dates will be set to: [on-sale date] - ON_SUPPLY_OFFSET. |
ONL_SCHEMA_OWNER |
USER |
The user name of the AIP Online schema owner. |
ORDER_CYCLE_REFERENCE_DATE |
20000102 |
Reference date used to determine order cycle sequence value. |
ORDER_DELETE_RATE |
10000 |
The maximum number of order lines deleted at a time during the batch order purge process. This parameter controls the performance of order purge process. |
ORDER_UPDATE_RATE |
100000 |
The maximum number of order lines updated at a time during the batch order release process. This parameter controls the performance of order release process. |
PARTIAL_PALLET_ROUNDING_FLAG |
N |
Indicates if partial pallets should be rounded during scaling and smoothing. Valid values are Y and N. |
PDDL_PARALLEL_DEGREE |
8 |
This parameter controls the degree of parallelism when executing a DDL. This value should be set based on DB CPUs available and timing of batch. |
PLSQL_LOG_LEVEL |
INFORMATION |
Indicates PLSQL logging level. Valid values are DEBUG, INFORMATION, ERROR, and NONE. While DEBUG level is the most informative, ERROR level is the least informative logging. Logging level NONE results in no logging at all. |
PLSQL_LOG_PURGE_PERIOD |
7 |
This parameter is used for purging PLSQL logs from table. Records that have logging VDATE <= (current VDATE - PLSQL_LOG_PURGE_PERIOD) are purged. |
PLSQL_LOG_TARGETS |
FILES_AND_TABLES |
Indicates where the PLSQL logs are written. Valid values are FILES_ONLY (for BSA log files), TABLES_ONLY (for logging table), and FILES_AND_TABLES (for both). |
PO_INTERFACE_METHOD |
M |
Determines whether purchase orders are interfaced to external systems through XML messages (M) or text files (F). |
PULL_ACROSS_STOCKLESS_DAYS |
N |
Indicates whether orders can be pulled across stockless days when performing Supplier Scaling and Container Scaling. Valid values are Y for yes and N for no. |
REBUILD_INDEXES_POST_RELEASE |
Y |
A value of Y (recommended) will rebuild unusable indexes after all orders are released. A value of N will rebuild the indexes during LOAD. This flag and the rebuild process are deprecated. |
RESET_SEQUENCE_FOR_SCALING |
Y |
Indicates if IDs used in order scaling start from same value on every load. If N, the order id starts from sequence NEXTVAL |
RESTART_SCALING_FROM_SAVEPOINT |
Y |
Indicates if system recovery should be used for scaling. If Y, then the scaling starts from the point that it failed earlier, else this starts from beginning. |
RESTART_SMOOTHING_FROM_SAVEPOINT |
Y |
Indicates if re-smoothing should skip the already smoothed (scaling_group, warehouse, delivery date) combinations. Valid values are Y and N. If Y, then already smoothed combinations are skipped, else they are considered again for smoothing. |
RETL_LOAD_METHOD |
conven- |
Load method, conventional or direct. Direct: load directly into the Oracle data files, avoiding the use of the conventional path (standard INSERTs). Direct load is typically faster but requires Lock Any Table system privilege if connection user is different from owner. |
RETL_NUM_LOADERS |
16 |
Number of Parallel SQL Loaders to execute for loads |
SCALING_HORIZON_MAX |
35 |
The Scaling Horizon Max is a maximum cap to individual Scaling Group horizon values. All individual Scaling Group horizon values will be capped by this value. |
SCHEDULE_EXCEPTION_OFFSET |
9 |
Indicates the number of days after store open that schedule exceptions copied in the sister store process will begin. |
SCHEMA_STATS_DEGREE |
8 |
Controls parallelization of function gen_schema_stats. |
SEQUENCE_CACHE_BULK_INSERT_VALUE |
20 |
This is the recommended cache value for the sequences while doing bulk insert. |
SET_WH_ORD_MULT |
1000 |
Bulk fetch limit for the procedure/function. |
SISTER_STORE_OFFSET_WEEKS |
12 |
Indicates the maximum number of weeks before store open that a sister store copy will take place. |
SISTER_WAREHOUSE_OFFSET_WEEKS |
12 |
Indicates the maximum number of weeks before warehouse open that a sister warehouse copy will take place. |
SMOOTHING_GLOBAL_FLAG |
Y |
Indicates whether or not Smoothing is enabled at a global level. Valid values are Y and N. |
SUPPLIER_MINIMUM_SCALING_GLOBAL_FLAG |
Y |
Indicates whether or not Supplier Minimum Scaling is enabled at a global level. Valid values are Y for yes and N for no. |
SYSTEM_HIGH_DATE |
99991231 |
The default high date used by the system. Date format is yyyymmdd. |
TABLE_PARALLEL_DEGREE |
8 |
Controls the degree of parallelism for a table. Valid values are 0 (equivalent to Oracle DEFAULT degree), 1 (equivalent to NOPARALLEL) and > 1 (MANUAL). Set this value based on DB CPUs available and timing of batch if manual degree is desired |
TABLE_STATS_DEGREE |
8 |
Controls parallelization of function gen_table_stats. |
TSF_INTERFACE_METHOD |
M |
Determines whether transfers are interfaced to external systems through XML messages (M) or text files (F). |
USE_DBMS_STATS_AUTO_SAMPLE_SIZE |
Y |
A value of Y (recommended) will use AUTO_SAMPLE_SIZE as estimate_percent in gen stat functions of aip_util package. A value of N will use NULL in gen_table_stats and GATHER_SCHEMA_STATS_ESTIMATE_PERCENT in gen_schema_stats. |
VALID_SOURCE_VALIDATION_IND |
Y |
Indicates whether to execute the validation to determine whether a source is valid. A valid source is one that is currently acting as a destination with a split percentage against it or where all the commodity pack sizes for the demand group are pending de-ranged. |
VDATE |
19991231 |
Used to maintain the same date throughout the batch run. Functions get_vdate, set_vdate, and inc_vdate of the aip_util package are used to retrieve, set, and increment. Date format is YYYYMMDD. |
WALKING_LEAD_TIME_OFFSET |
45 |
Indicates the number of days before a store open date to begin calculating a walking lead time for that store. |
The Oracle RESTART_CONTROL table defines the number of parallel subprocesses that a high data-volume process uses in shell script. For example:
Importing STORE SOURCE data from RPAS into Online
Exporting STORE SOURCE data from Online to RPAS
Importing INTO-STORE PURCHASE ORDERS from RPAS to Online
Importing INTO-STORE Transfers from RPAS to Online
Importing ON-SALE-OFF-SALE data from RPAS to Online
Executing ORDER-SMOOTHING process in AIP Online
Executing ORDER-SCALING process in AIP Online
The column NUM_THREADS controls the degree of parallelism while executing the processes defined in column PROGRAM_NAME of this table.
The Oracle ORDER_NUMBER table defines the valid range of order numbers for purchase orders and transfers. The range of values should not overlap the range of values allocated to any other system capable of generating orders. Update the ORDER_NUMBER table to reflect the range of purchase order and transfer numbers that are appropriate for AIP.
The Oracle ORDER_PURGE_PERIOD table defines the number of days an order remains in the system after it has been set to a Closed status. Review the default purge periods inserted in the table at installation time, and update the values for purchase order purging and transfer purging when needed.
In AIP Online, orders are held at order detail level (such as order line time level). When an order number is generated, it is generated at the order header level. The Oracle ORDER_DEFINITION table holds information that specifies how order line items are grouped into to order headers.
The following options are available for defining the level of grouping:
Source - Indicates if order sources are used in order header round-up.
SKU - Indicates if SKUs are used in order header round-up.
Pack Size - Indicates if pack sizes are used in order header round-up.
Destination - Indicates if the order destinations are used in order header round-up.
Delivery Date - Indicates if delivery dates are used in order header round-up.
In the example shown in Table 5-5, SKU (commodity) and pack size are not used in the order definition. This means that, for each order type, an order number will be assigned to each unique combination of source, destination, and delivery date. This will result in one too many SKU pack sizes being grouped under a single order number for an order type.
Table 5-5 Example of the Oracle ORDER_DEFINITION table
Destination | Order Type | Use Source | Use Commodity | Use Pack_Size | Usedest | Use Delivery_Date |
---|---|---|---|---|---|---|
Warehouse |
Purchase Order |
Y |
N |
N |
Y |
Y |
Store |
Purchase Order |
Y |
N |
N |
Y |
Y |
Warehouse |
Transfer |
Y |
N |
N |
Y |
Y |
Store |
Transfer |
Y |
N |
N |
Y |
Y |
Warehouse |
Allocation |
Y |
N |
N |
Y |
Y |
Store |
Allocation |
Y |
N |
N |
Y |
Review the ORDER_DEFINITION table and change the settings if needed.
Note: The only supported configurations for this release of AIP are the defaults provided in the table above and Y for all columns. These two configurations can be applied per destination/order type. They do not need to be applied uniformly across destination or order type. |
The default order cycles created at implementation time are used by the batch processes that automatically create Profiles and Order Groups. These order cycles can be modified to match your business needs; however, they must remain in sync with the same special default order cycles created in the RPAS platform.
Store order cycles are assigned to a profile when it is automatically generated by the batch processes. The following Store Order Cycles exist for these procedures:
Warehouse profiles (PRFWS)
Direct Profiles (PRFVS)
The following store order cycles are created during installation.
Order Cycle | Sun | Mon | Tues | Wed | Thurs | Fri | Sat |
---|---|---|---|---|---|---|---|
PRFVS | 15 | ||||||
PRFWS | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
Store Order cycles are maintained in two tables, STORE_ORDER_CYCLE and STORE_ORDER_CYCLE_LEAD_TIME.
Table 5-6 STORE_ORDER_CYCLE
STORE_ORDER _CYCLE_ID | STORE_ORDER_CYCLE_CODE | STORE_ORDER_CYCLE_NAME | STORE_ORDER_CYCLE_LENGTH |
---|---|---|---|
2 |
PRFVS |
New Sup To Store Default OC |
7 |
3 |
PRFWS |
New Sup Warehouse to Store OC |
7 |
Table 5-7 STORE_ORDER_CYCLE_LEAD_TIME
STORE_ORDER_CYCLE_ID | STORE_ORDER_CYCLE_SEQ | RELEASE_LEAD_TIME | PLACEMENT_LEAD_TIME |
---|---|---|---|
2 |
1 |
-1 |
-1 |
2 |
2 |
||
2 |
3 |
-1 |
-1 |
2 |
4 |
-1 |
-1 |
2 |
5 |
-1 |
-1 |
2 |
6 |
-1 |
-1 |
2 |
7 |
-1 |
-1 |
3 |
1 |
1 |
1 |
3 |
2 |
1 |
1 |
3 |
3 |
1 |
1 |
3 |
4 |
1 |
1 |
3 |
5 |
1 |
1 |
3 |
6 |
1 |
1 |
3 |
7 |
1 |
1 |
The STORE_ORDER_CYCLE_LENGTH is 7; therefore, there is one row in the STORE_ORDER_CYCLE_LEAD_TIME table for each of the 7 days in the order cycle. Changing the length of the Store order cycle requires additional rows to be added to the STORE_ORDER_CYCLE_LEAD_TIME table such that the STORE_ORDER_CYCLE_SEQ runs from 1 to n, where n is the order cycle length. The only supported lengths are 7, 14, or 28. Do not choose a length other than those values.
A RELEASE_LEAD_TIME or PLACEMENT_LEAD_TIME value of -1 indicates blank on the window or no lead time.
The PLACEMENT_LEAD_TIME value must be equal to or greater than the RELEASE_LEAD_TIME. Therefore, you cannot change one and not the other. The PLACEMENT_LEAD_TIME must not contain a value other than -1 when the RELEASE_LEAD_TIME is -1.
Warehouse Order Cycles are assigned to an Order Group when the Warehouse Order Cycle is automatically generated by the batch procedures. The following Warehouse Order Cycles exist for these procedures:
Warehouse sourced Order Groups (OGWW)
Supplier sourced Order Groups (OGVW)
The following store order cycles are created during installation.
Order Cycle | Sun | Mon | Tues | Wed | Thurs | Fri | Sat |
---|---|---|---|---|---|---|---|
OGVW | 15 | ||||||
OGWW | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
Warehouse order cycles are maintained in two tables, ORDER_CYCLE and ORDER_CYCLE_LEAD_TIME.
ORDER_CYCLE Table
Table 5-8 ORDER_CYCLE
ORDER _CYCLE_ID | ORDER_CYCLE_CODE | ORDER_CYCLE_NAME | ORDER_CYCLE_LENGTH | ORDER_CYCLE_LENGTH |
---|---|---|---|---|
1 |
OGVW |
New Supplier Default Order Cycle |
7 |
-1 |
2 |
OGWW |
New Supplier WHS to WHS Order Cycle |
7 |
-1 |
ORDER_CYCLE_LEAD_TIME Table
Table 5-9 ORDER_CYCLE_LEAD_TIME
ORDER_CYCLE_ID | ORDER_CYCLE_SEQ | ORDER_LEAD_TIME |
---|---|---|
1 |
1 |
-1 |
1 |
2 |
15 |
1 |
3 |
-1 |
1 |
4 |
-1 |
1 |
5 |
-1 |
1 |
6 |
-1 |
1 |
7 |
-1 |
2 |
1 |
1 |
2 |
2 |
1 |
2 |
3 |
1 |
2 |
4 |
1 |
2 |
5 |
1 |
2 |
6 |
1 |
2 |
7 |
1 |
The warehouse order cycle length (ORDER_CYCLE_LENGTH) is 7; therefore, there is one row in the ORDER_CYCLE_LEAD_TIME table for each of the 7 days in the order cycle. Changing the length of the warehouse order cycle requires additional rows to be added to the ORDER_CYCLE_LEAD_TIME table, such that the ORDER_CYCLE_SEQ runs from 1 to n, where n is the order cycle length. The only supported lengths are 7, 14, or 28. Do not choose a length other than those values.
An ORDER_LEAD_TIME value of -1 indicates blank on the window or no lead time.
The COLLECTION_LEAD_TIME must be equal to or less than the smallest ORDER_LEAD time for the order cycle. For the existing, unmodified, order cycle OGVW, the COLLECTION_LEAD_TIME can be at most 15. For the existing, unmodified, order cycle OGWW, the COLLECTION_LEAD_TIME can be at most 1.
In order to purge invalid or ineffective hierarchy data from AIP Online tables, purge parameters are used to configure the purge ages. These parameters are defined in a table called PURGE_PARAMETER and are used by purging script aip_purge.sh to identify invalid/ineffective data for purging. The default parameter values in Table 5-10 must be set according to individual business needs.
Table 5-10 DATA_PURGE_PARAMETERS
Name | Value | Description |
---|---|---|
AUDIT_PURGE_FREQUENCY |
W |
The frequency at which audit tables are purged. Valid values are D (Daily), W (Weekly), M (Monthly), H (every 6 months), Y (Yearly). |
CHAMBER_PURGE_AGE |
60 |
The number of days a chamber remains in the system before being purged, beginning when the chamber was set to a closed status. |
CLOSED_ALERT_PURGE_AGE |
14 |
The number of days a closed alert remains in the system before being purged, beginning when the alert was closed. |
COMMODITY_PACK_SIZE_PURGE_AGE |
30 |
The number of days a SKU-pack size remains in the system before being purged, beginning when the SKU-pack size does not appear in the daily import from RPAS. |
ENT_AUDIT_PURGE_AGE |
90 |
The number of days a END_AUDIT record remains in the system before being purged, beginning from when the record was created. |
LAST_AUDIT_PURGE_DATE |
<SYSDATE> |
The date the audit tables were last purged. Used in conjunction with the AUDIT_PURGE_FREQUENCY to determine when audit tables are purged. |
NON_ORDER_NON_RELEASE_PURGE_AGE |
180 |
The number of days a non-order or non-release date record remains in the system after it has passed before being purged. |
ON_SUPPLY_OFF_SUPPLY_PURGE_AGE |
45 |
The number of days an on supply/off supply record remains in the system before being purged, beginning from the off sale date. |
ORDER_GROUP_PURGE_AGE |
60 |
The number of days an order group remains in the system before being purged, beginning from when the order group does not have at least one demand group assigned to it. |
PLANNING_GROUP_PURGE_AGE |
90 |
The number of days a planning group remains in the system before being purged, beginning when the planning group is not assigned to at least one network group. |
PROFILE_PURGE_AGE |
60 |
The number of days a profile remains in the system before being purged, beginning when the profile does not have at least one SKU assigned to it. |
SCALING_GROUP_PURGE_AGE |
60 |
The number of days a scaling group remains in the system before being purged, beginning when the order group does not have at least one SKU assigned to it. |
STORE_ORDER_CYCLE_PURGE_AGE |
366 |
The number of days a store order cycle remains in the system before being purged, beginning when the order cycle is not assigned to at least one profile. |
STORE_PURGE_AGE |
90 |
The number of days a store remains in the system before being purged, beginning when the store does not appear in the daily import from RPAS. |
SUPPLIER_COMMODITY_PACK_ SIZE_PURGE_AGE |
30 |
The number of days an on supplier/sku link remains in the system before being purged, beginning when the link does not appear in the daily import from RPAS. This value should be less than or equal to COMMODITY_PACK_SIZE_PURGE_AGE and SUPPLIER_PURGE_AGE values. |
SUPPLIER_PURGE_AGE |
90 |
The number of days a supplier remains in the system before being purged, beginning when the supplier does not appear in the daily import from RPAS. |
WAREHOUSE_ORDER_PURGE_AGE |
366 |
The number of days a warehouse order cycle remains in the system before being purged, beginning when the order cycle is not assigned to at least one order group. |
WAREHOUSE_PURGE_AGE |
90 |
The number of days a warehouse remains in the system before being purged, beginning when the warehouse does not appear in the daily import from RPAS. |
The Oracle WH_TYPE_INITIAL_PACK_TYPE table contains the warehouse type and pack type associations that are used for defaulting warehouse orderable units and order multiples. When the AIP Automated Data Maintenance batch processes run the pack type value defined for the respective process, it defines which pack size should be used for assignment first. If the pack size associated with the pack type is not valid for a given warehouse of the assigned warehouse type, additional logic in the batch will determine the next valid pack size to use.
The constraints on the table must be modified if additional warehouse types are added to the system by the STOCKING_POINT table. The warehouse type describes the destination warehouse type.
The process type identifies the process to which the warehouse type/pack type setting applies: either warehouse orderable units or order multiples.
Prior to importing any supplier data, the column constraint on the SHIP_TO column should be modified to match the SHIP_TO values that will be imported from the merchandising system. If additional values are being added, the Ship-to source and destination mappings must also be added to the SHIP_TO_WH_TYPE_SOURCE and SHIP_TO_WH_TYPE_DEST tables.
Prior to importing any warehouse data, the column constraint on the WH_TYPE column should be modified to match the WH_TYPE values that will be imported from the merchandising system.
This Oracle table contains the mappings between Supplier SHIP_TO values and the appropriate sources. These values are used when automatically generating Order Groups. When the WH_TYPE column is null, the supplier will be used as the source. A non-null WH_TYPE value indicates that the warehouse the supplier ships to is an intermediate warehouse that does not ship directly to the store. When the WH_TYPE is populated, the source of the Order Groups created will be Warehouses that match the WH_TYPE.
This Oracle table contains the mappings between Supplier sources (SHIP_TO_WH_TYPE_SOURCE) and the destinations. The destinations are used to determine the valid warehouse chambers to assign to the order groups. One SHIP_TO value can map to many sources and destination WH_TYPEs.
Every alert is assigned a priority based on the type of the alert. The priority assigned to each alert type can be set in the ALERT_DEFINITION table. The priority setting currently has no bearing on the rest of the system. It is simply a visual indicator of importance and a search mechanism for the user.
Note: Updating the alert type priority in the ALERT_DEFINITION table changes the priority of any previously existing alerts corresponding to the alert type being modified |
The Oracle ALERT_DEFINITION_DESC table contains the text of each alert and the corresponding SHORT_DESC or alert type description. The SHORT_DESC value is displayed to you as a search criteria. You can modify the text of the SHORT_DESC; however, the window is optimized to display the values provided in the installation. It is not recommended that you modify the LONG_DESC, as the correct placement of the data displayed to you depends on the structure of the LONG_DESC text.
The LONG_DESC and SHORT_DESC are translated for several different LANGUAGE and COUNTRY codes.
Each alert that is imported or generated by AIP Automated Data Maintenance batch will be assigned a status. The status is displayed to you in the Data Management (DM) window. You can then modify the status of the alert by selecting a status option from a drop-down list. The status options displayed in the list and their descriptions are contained in the ALERT_STATUS_DESC table.
The ALERT_STATUS_CODE indicates the chronological order of the statuses displayed on the window as well as the code that is saved, indicating the alert's current status.
When adding a status:
The smallest value will be automatically assigned to every new alert.
The largest value will be considered the final status, indicating no more work needs to be completed related to the alert.
The following properties files are used to configure the application during implementation:
All files are located in:
<ear file deploy location>/AIPOnlineWAR.war/config
Review the values in the files for completeness and accuracy. There are additional properties outlined that must be manipulated when using the RIB with AIP.
File Location:
<ear file deploy location>/AIPOnlineWAR.war/WEB-INF/config
The following table provides a description of the properties contained in the main.properties file. This file is used by the Java-enabled applications: DM, OM, and RIB publication through the OrderSenderBean.
Property | Description |
---|---|
base | This must match the context root of the ear or war file. This is ”/” for a production system, or ”/test1” for the first of several test systems on a single physical computer. |
setfileattr.rcapps.properties | This defines a file to contain color attributes. The default setting is rcapps.properties. |
You can configure AIP Online to publish Purchase Order and Transfer Data to the Oracle Retail Merchandising System (RMS) through the Oracle Retail Integration Bus (RIB). Perform the following procedure to enable RIB publication.
Change the Off status of keys to On status where applicable in the main.properties file to activate the OrderSenderBean, which calls the RIB publication routines:
aip.prop.order.po.export=OFF
aip.prop.order.tsf.export=OFF
aip.prop.order.period.count=1
aip.prop.order.period.start.1=08:00:00
aip.prop.order.period.end.1=20:00:00
aip.prop.order.time.interval=00:01:00
aip.prop.order.po.message.family=XOrder
aip.prop.order.po.message.type.name=msg_type
aip.prop.order.po.queue.table.name=PO_MFQUEUE
aip.prop.order.po.table.id.name= orderNo
aip.prop.order.tsf.message.family=XTsf
aip.prop.order.tsf.message.type.name=msg_type
aip.prop.order.tsf.queue.table.name=TSF_MFQUEUE
aip.prop.order.tsf.table.id.name= tsfNo
aip.prop.order.max.messages.per.bundle=20
aip.prop.order.max.number.of.bundles=10
Save the main.properties file.
Have the application server administrator restart the server instance where the OrderSenderBean and AIP Online application are deployed.
File Location:
<ear file deploy location>/AIPOnlineWAR.war/WEB-INF/config
The following table provides a description of the publication properties referenced in "Publishing Purchase Orders and Transfer Data to RMS".
Property | Description |
---|---|
aip.prop.order.po.export | This property must be set to ON to do RIB-based publications Purchase Orders. (PO_MFQUEUE). |
aip.prop.order.tsf.export | This property must be set to ON to do RIB-based publications of Transfers (TSF_MFQUEUE). |
aip.prop.order.period.count | The number of periods in the day during which the OrderSenderBean will invoke RIB publication. This value must be greater than zero if RIB-based publication is to be used. In addition, at least one of the above two properties must be set to ON. |
aip.prop.order.period.start.x | The start time in HH:MM:SS format of period x where x is 1 … aip.prop.order.period.count. |
aip.prop.order.period.end.x | The end time in HH:MM:SS format of period x where x is 1 … aip.prop.order.period.count. |
aip.prop.order.time.interval | The amount of time in HH:MM:SS format between calls to OrderSenderBean.checkAndPublish() function. |
aip.prop.order.po.message.family | The purchase order message family name. This value is required by the RIB to ensure proper validation of message payloads. This value should be set to XOrder. |
aip.prop.order.po.message.type.name | This value can be used to indicate if the message is a header-create, header-update, detail-create, or detail-update message. Although message types are used to order the OrderSenderBean query, this parameter value is not currently used. |
aip.prop.order.po.queue.table.name | The AIP Online table that OrderSenderBean queries to check for Purchase Order related messages awaiting publication. This value should be: PO_MFQUEUE. |
aip.prop.order.po.table.id.name | This value is used to group functionally related message content. For example, all message content related to purchase order number 123 would be grouped. This value should be orderNo. |
aip.prop.order.tsf.message.family | The transfer message family name. This value is required by the RIB to ensure proper validation of message payloads. This value should be set to XTsf. |
aip.prop.order.tsf.message.type.name | This value can be used to indicate if the message is a header-create, header-update, detail-create, or detail-update message. Although message types are used to order the OrderSenderBean query, this parameter value is not currently used. |
aip.prop.order.tsf.queue.table.name | The AIP Online table that OrderSenderBean queries to check for Transfer-related messages awaiting publication. This value should be TSF_MFQUEUE. |
aip.prop.order.tsf.table.id.name | This value is used to group functionally related message content. For example, all message content related to transfer number 456 would be grouped. This value should be tsfNo. |
aip.prop.order.max.number.of.bundles | The maximum number of message bundles to publish per call to OrderSenderBean.checkAndPublish(). The default is 10, but this number should be recalculated by the client based upon on-site performance testing. |
aip.prop.order.max.messages.per.bundle | The maximum number of messages per message bundle. For example, multiple Purchase Order header create message can be grouped in one message bundle to improve performance. The default value is 20, but this value should be recalculated by the client based upon on-site performance testing. |
File Location:
<ear file deploy location>/AIPOnlineWAR.war/WEB-INF/config
These properties are applied to the main application login and navigation pages. These property settings do not apply to the pop-up applet windows.
The color properties can be set to any six- character hexadecimal value and are preceded with the # symbol.
Hexadecimal color property examples:
#0000FF = blue
#FF0000 = red
The files defined for various properties are located off of the following base directory:
<ear file deploy location>/AIPOnlineWAR.war
Property settings that contain path assignments are appended to the base directory provided above. Use the complete path ( base directory plus property path) to locate specific files as needed.
Example:
apptop.page=/fragments/apptop.jsp
apptop.jsp can be found in the following path:
<ear file deploy location>/AIPOnlineWAR.war/fragments
The following table provides a description of the properties contained in the rcapps.properties file:
Property | Description |
---|---|
about.width | Width of about windows. Currently, about windows are not supported. |
apps.width | Width of application windows. |
appbanner.bg | Defines the main background color. This appears as the horizontal banner. |
appmenu.bg | Menu banner background color. This appears as the vertical strip on the left side of the page. It is the background for any Applications, User Console, and Administration menu items. |
text.fg | Main text color. This is the text color for the main welcome on the login pages. |
File Location:
<ear file deploy location>/AIPOnlineWAR.war/WEB-INF/config
This file defines security administration settings for the application.
This file provides the displayed text for the windows. Error text originating in the database is not provided in this file and is not accessible for customization. Customizing this file can have an effect on the visual presentation of the window or pop-up message. The new text should be of equal or similar character length as the modified text.
The file is located in the following server path:
<ear file deploy location>/AIPOnlineWAR.war/appclasses/res/com/retek/applet/strings.properties
This file contains configurable settings for Data Management and Order Management that determine how certain windows appear immediately when opened. It also contains settings that allow or prevent certain user activities on the windows.
This file is located in:
<ear file deploy location>/AIPOnlineWAR.war/appclasses/res/com/retek/applet
The following table provides a description of properties found in the config.properties file that are used to define Data Management (DM) settings:
Property | Description |
---|---|
datamanagement.suppress.pre.save.message | Indicates whether or not to suppress the pre-save message saying that all applicable rows will be updated. This setting currently only applies to the On Supply/Off Supply window when performing mass updates of SKUs and Stores. The valid values for this property are 0 to display the pre-save message and 1 for do not display the pre-save message. |
datamanagement.unit.of.measure.default | Defines the unit of measure (UOM) option button that is initially selected when displaying Data Management (DM) windows containing UOM. Valid values are 0 for cases or 1 for eaches. |
datamanagement.warehouse.type.available | This setting determines whether the warehouse type field is displayed in the Data Management (DM) application. This should be set to 0 when warehouse types are not defined for warehouses or set to 1 if warehouse types are assigned to warehouses. |
delivery.demand.percent.entry.type | This property indicates whether Delivery Demand Percentages are user-entered for all locations, warehouses only, or none. The window will be accessible to users only if this value is not none. Valid values are 0 for all, 1 for warehouses only, and 2 for none. |
export.launch | When you export the Alerts from the Data Management (DM) application to a savable file, this setting will determine whether the file is opened immediately or not. If set to launch immediately, you must have a default program for the particular file extension being saved. Two file formats are available: spreadsheet (.xls) or comma delimited (.csv). The default program associated with the file extension is specific per PC and is not an AIP-controlled setting. If no program is associated to the file extension, you can receive an error, and the file will not be opened. If an error occurs, you must manually open the file in the appropriate program. The valid values for this property are 0 for do not launch, and 1 for launch immediately. |
export.type.default | When exporting the Alerts from the Data Management (DM) application to a savable file, you have the option of saving the data in spreadsheet or a comma-delimited file format. This property setting is applied to the initial option button selection that defines the format. This property defines the value selected by default. You have the option of choosing the other format by selecting the other option button. The valid values for this property are 0 for comma-separated file (CSV) or 1 for spreadsheet (XLS). |
intraday.releasewave.earliest.wave | This property indicates the hour of the earliest possible Intra-day release wave on any day. The default value is 7. |
intraday.releasewave.entry.type | This property indicates whether Intra-day release wave assignments and snapshot times are user-entered for all sku/stores or none. The window will be accessible to users only if this value is all. Valid values are 0 for all and 1 for none. |
intraday.releasewave.latest.wave | This property indicates the hour of the latest possible Intra-day release wave on any day. The default value is 20. |
intraday.revise.sales | This property indicates the method of revising the forecasted store sales after Intra-day sales have been loaded. The revision occurs when re-planning a sku/store Intra-day. A value of actuals will set the revised sales forecast to actual sales when actual sales have exceeded the forecast sales for the day. A value of recalculate will calculate a new value based on the actual sales and sales profile. Inventory Snapshot Time will be required when set to recalculate. Valid values are 0 for actuals and 1 for recalculate. |
paginggrid.<window name>.page.size | Each window that uses paging has its own pagesize setting. This setting, when greater than 0, will override the default pagesize setting. The same considerations for the default should be applied to the individual window settings. A value of -1 indicates that the default should be used. The valid values for this property are -1 or any number greater than 0 and less than or equal to 9999999. |
paginggrid.page.size | This is the default pagesize setting applied to all windows with paging. Pages contain a certain number of rows, and only the content for one page is displayed at a time. This property defines the number of rows that are displayed in a single page. When setting this value you should consider that the setting is system-wide setting, not a user-specific setting. The resolution of each user's window will affect how many rows are visible without scrolling. Assign a large number to this property can result in the need for some users to scroll down the page to see all of the rows. Setting this property to an arbitrarily large number also negates the benefits of paging, which is used to improve window rendering-time performance and display information in a more usable fashion. This property can be set to any value greater than 0 and less than or equal to 9999999. |
scalinggroups.container.assignments.defaul | This property indicates the default selection for Container Assignments when creating new Scaling Groups.
|
The following table provides a description of properties found in the config.properties file that are used to define Order Management (OM) settings.
Property | Description |
---|---|
ordermanagement.order.type.default | This setting defines which order-type option button is selected by default. The available options are All, Transfers, or Purchase Orders. This setting applies to all Order Management windows that allow you to search or select an order type. Valid values for this property are as follows:
Note: The ordermanagement.viewable.order.type setting takes precedence over this setting. If this setting conflicts with it, the ordermanagement.viewable.order.type will be used instead. |
ordermanagement.viewable.order.type | This setting defines which order types users are able to view and possibly manipulate. Users cannot perform any operations on order types that do not match this setting, nor can they view order types that do not match this setting. This setting applies to all Order Management windows. The valid values for this property are as follows:
Note: Users can have privileges to the Order Create window but they will be unable to perform any operations if the ordermanagement.viewable.order.type is not set to All or Purchase Order. |
ordermanagement.unit.of.measure.default | Defines the unit of measure (UOM) option button that is initially selected when displaying OM Online windows containing UOM. Valid values are 0 for cases or 1 for eaches. |
ordermaintenance.order.display.format | This setting defines the display format that is selected by default in the Order Maintenance search criteria pop-up. The valid options for this property are 0 for the tree format and 1 for the grid format. |
ordermaintenance.expand.all.default | When the search results in the Order Maintenance window are displayed in a tree format, this setting is used to determine whether the tree should be initially displayed in a collapsed or expanded state. When collapsed, only the header-level order information appears. When expanded, all of the SKU-pack sizes and order quantities associated with the order display. Valid values for this property are 0 for collapsed or 1 for expanded. |
ordermaintenance.update.quantity.default | In the Order Maintenance window, you have the option of viewing the quantity for the order as the total ordered quantity or as the outstanding order quantity. This setting is used to determine which option button will be initially selected on the window. The valid values for this property are 0 to view the total order quantity or 1 to view the outstanding order quantity. |
ordermaintenance.supplier.tracking.default | When moving the outstanding purchase order quantity to a new delivery date and/or destination, you must specify whether it is the supplier or the businese that was the cause of the change. The value that is specified affects the supplier performance tracking. This property defines which drop-down list option should be selected by default. The valid values are as follows:
The Always Ask option is recommended if the business will be viewing and using the supplier performance-tracking information. This option forces you to consciously select the appropriate value. If the business will not be using the supplier performance-tracking information, then either the Supplier Initiated or Business Initiated option should be selected so that a value is always selected by default. This prevents you from having to randomly pick one of the two options, as well as prevents the unnecessary pop-up that appears when the Always Ask option is selected in the drop-down list. |
ordermaintenance.view.default | This setting defines which view should be displayed initially in the Order Maintenance Window: the Standard View or the Extended View. The extended view includes the Supplier Tracking value and the Release Date. The additional columns displayed in the extended view result in each column having a smaller display size. Valid values for this property are 0 for the standard view and 1 for the extended view. |
ordermaintenance.allow.move.outstanding | This setting allows the business to prevent users from changing the destination and delivery date of a purchase order. The valid values for this property are 0 to allow changing delivery dates and destinations or 1 to prohibit changing delivery dates and destinations. |
ordermaintenance.move.outstanding.criteria | This setting allows the business to define when it is acceptable to move outstanding order quantities to a new delivery date and/or destination. Outstanding quantity is defined as order quantity - (received quantity + in-transit quantity).
The first option is any time the outstanding quantity is less than or equal to the order quantity and greater than zero. This means that you can change the order delivery date and/or destination any time the order is released and not fully shipped from supplier. The second option is any time the order is totally outstanding. This means that you can change the order delivery date and/or destination anytime the order has been released but not yet shipped from supplier. The valid values for this property are 0 for not fully shipped or 1 for zero shipped quantity. |
ordermaintenance.move.allow.destination.change | This setting allows the business to restrict users from changing delivery destinations of their orders. This setting is used in the Order Maintenance Move Outstanding Order Quantity popup. When users are not allowed to change order destinations, they are left with the sole option of changing the delivery date. Valid values for this property are 0 to allow destination changes or 1 to prevent destination changes. |
ordermaintenance.move.require.new.order.number | This setting determines whether or not a new order number is required when moving an order. If a new order number is not required, users are allowed to choose whether to retain the existing order number or generate a new one when moving outstanding quantities. Valid values for this property are 0 - Do not require a new order number or 1 - Require a new order number. |
ordermaintenance.allow.cancel.outstanding | This setting allows the business to restrict users from fully canceling a Purchase Order. You can still modify the Purchase Order quantity but you cannot fully cancel the outstanding quantity. The valid values for this property are 0 to allow the outstanding order quantity to be canceled or 1 to prohibit the cancelling of all outstanding order quantities. |
ordermaintenance.allow.release.orders | This setting allows the business to prevent users from manually releasing purchase orders in the Order Maintenance window. Orders that have not been released cannot be modified. Only purchase orders released on their lead time by the batch order release process would be available for modification. The valid values for this property are 0 to allow manual release of orders or 1 to prevent manual release of orders. |
ordermaintenance.allow.edit.quantities | This setting allows the business to prevent users from modifying purchase order quantities. You still have the ability to cancel the outstanding order quantity unless the ordermaintenance.allow.cancel outstanding property is also set to disallow cancelling outstanding order quantities. Valid values for this property are 0 to allow modification of order quantities or 1 to prevent modification of order quantities. |
ordermaintenance.release.status.default | This setting determines which Release Status option button is initially selected in the Order Maintenance search criteria popup. The valid values for this property are 0 for all statuses, 1 for Released, or 2 for unreleased. |
orderreview.display.quantity.default | This setting determines which Display Quantity value is initially selected in the Order Review search criteria popup.
The first option is total quantity. This displays the summed order quantity in the search results. The second option is outstanding quantity. This displays the total order quantity that is still outstanding. This quantity is calculated as the total order quantity minus the sum of total received quantity and total in-transit quantity. The third option is received quantity. This displays the summed received quantity in the search results. The fourth option is in-transit quantity. This displays the summed in-transit quantity. The valid values for this property are 0 for total quantity, 1 for outstanding quantity, 2 for received quantity, and 3 for in-transit quantity. |
orderreview.display.zero.values.default | This setting determines whether the Display Zero Values check box is initially checked or unchecked in the Order Review search criteria popup. Choosing to display zero values will result in zeros being displayed in the columns where no quantity is found. Note, that at least one order must be found for the search criteria and date range in order to have a row displayed in the search results. When choosing to view received or outstanding or in-transit quantities instead of the order quantity, it will be impossible to distinguish a displayed zero, which means no orders were found for the date range, from a 0 quantity was received or 0 quantity is outstanding or a 0 quantity is in-transit.
The valid values for this property are 0 to not initially select the check box (do not display zeros) or 1 to initially select the check box (display zeros). |