Go to primary content
Oracle® Retail Enterprise Inventory Cloud Service Administration Guide
Release 18.1
F22920-01
  Go To Table Of Contents
Contents

Previous
Previous
 
Next
Next
 

5 Batches

This section information describes following batch topics:

Operation Batches

Operation Batches are used to perform back ground operations on the transaction and includes such tasks as generation of a transaction, closing the transaction after a specified date is passed, auto confirmation of the transaction, and so on.

Archive Activity History

This batch moves aged activity history into archive table.

Batch Job Definition Name

Audits_ArchiveJob

Batch Job Parameters

N/A

Key Tables

Table 5-1 Key Tables for Archive Activity History

Table Select Insert Update Delete

ACTIVITY_HISTORY

Yes



Yes

ARV_ACTIVITY_HIST


Yes




Archive Store Item Stock History

This batch moves aged store item stock history records into archive table.

Batch Job Definition Name

StoreItemStockHistory_ArchiveJob

Batch Job Parameters

N/A

Key Tables

Table 5-2 Key Tables for Archive Store Item Stock History

Table Select Insert Update Delete

STORE_ITEM_STOCK_HISTORY

Yes



Yes

ARV_STORE_ITEM_STOCK_HIST


Yes




Archive Item Uin History

This batch moves aged activity history into archive table.

Batch Job Definition Name

ItemUinHistory_ArchiveJob

Batch Job Parameters

N/A

Key Tables

Table 5-3 Key Tables for Archive Item Uin History

Table Select Insert Update Delete

ITEM_UIN_HISTORY

Yes



Yes

ARV_ITEM_UIN_HIST


Yes




Cleanup Batch Directories

This job deletes the processed files from batch archive folder and failed files from reject folder of the respective job's directory. The retention period is specified by system configuration parameter "Days to Hold Archived and Rejected Files".

Batch Job Definition Name

CleanupBatchDirectories_OpsJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-4 Key Tables for Cleanup Batch Directories

Table Select Insert Update Delete

ACTIVITY_HISTORY

Yes





Cleanup Shelf Replenishment

The end of day batch process runs at the end of each day to reset the delivery bay and close any open pending shelf replenishments. The system takes the entire inventory from the delivery bay and moves it to the back room. Any pending or in progress shelf replenishment are changed to a cancelled state. Users who are performing a shelf replenishment are kicked out of the system. That is, the batch process takes over the shelf replenishment user's application activity locking. The current user's shelf replenishment process is discarded without being saved. After the batch process is run, all shelf replenishments are either completed or cancelled, and the delivery bay has zero inventory.

Batch Job Definition Name

CleanupShelfReplenishment_OpsJob

Batch Job Parameters

N/A

Key Tables

Table 5-5 Key Tables for Cleanup Shelf Replenishment Batch

Table Select Insert Update Delete

shelf_replenish



Yes


stock_item_stock



Yes



DSD Receiving Closure

This batch program looks for all the open vendor deliveries whose expected date added to store parameter ”Auto Close Days after Expected Date” is before today and automatically confirms all the vendor deliveries.

Batch Job Definition Name

DSDReceivingClosure_OpsJob

Batch Job Parameters

N/A

Key Tables

Table 5-6 Key Tables for Close DSD Receivings Batch

Table Select Insert Update Delete

activity_history


Yes



config_store

Yes




dsd

Yes


Yes


dsd_carton

Yes


Yes


dsd_line_item

Yes


Yes


dsd_line_item_att

Yes


Yes


dsd_line_item_uin

Yes


Yes


inv_adjust_reason

Yes




purchase_order

Yes


Yes


stock_item_v

Yes




store

Yes





Fulfillment Order Pick Reminders

This batch process sends out e-mail alerts for fulfillment order picks for which create date has expired by minutes to hold customer orders before sending e-mail alert parameter value and the status is new or in progress.

Batch Job Definition Name

FulfillmentOrderPickReminders_OpsJob

Batch Job Parameters

N/A

Key Tables

Table 5-7 Key Tables for Fulfillment Order Pick Reminders Batch

Table Select Insert Update Delete

ful_ord_pick

Yes




ful_ord_pick_line_item

Yes




store_item_stock

Yes




store

Yes




comfig_system

Yes





Fulfillment Order Reminders

This batch process sends out e-mail alerts for fulfillment orders for which create date has expired by minutes to hold customer orders before sending e-mail alert parameter value.

Batch Job Definition Name

FulfillmentOrderReminders_OpsJob

Batch Job Parameters

N/A

Key Tables

Table 5-8 Key Tables for Fulfillment Order Reminders Batch

Tables Select Insert Update Delete

config_system

Yes




config_store

Yes




store

Yes




store_item_stock

Yes




ful_ord

Yes




ful_ord_line_item

Yes





Generate Problem Line Stock Count

Before the batch process runs, the retailer establishes a group of items and item hierarchies (by associating them to the problem line group type) and selects applicable parameters (negative SOH, negative available, and so on). The problem line batch process goes through the list of items in the group, determining which fall within the parameters. The system automatically creates a stock count from those items that do fall within the parameters.

If an item is a problem line item (negative inventory for example) on a stock count, and the user does not get the chance to perform the stock count on it that day, the next day the item may no longer be a problem line (positive inventory). However, the system continues to create a stock count for that item because a problem existed at one time.

Batch Job Definition Name

GenerateProblemLineStockCount_OpsJob

Batch Job Parameters

N/A

Key Tables

Table 5-9 Key Tables for Problem Line Stock Count Batch

Tables Select Insert Update Delete

group_schedule_extract

Yes

Yes



prod_group_item_bkdn



Yes

Yes

stock_count

Yes

Yes

Yes

Yes

stock_count_line_item

Yes

Yes

Yes

Yes

stock_count_line_item_uin

Yes

Yes

Yes

Yes

stock_count_child

Yes

Yes

Yes

Yes

product_group_schedule

Yes


Yes


product_group

Yes




product_group_sched_store

Yes




item

Yes




store_item

Yes




stock_count_line_item

Yes





Generate Unit Amount Stock Count

This batch program generates UnitAmount stock counts.

On a daily basis, the batch process creates the stock counts that are scheduled for the current day or future date which matches the next scheduled date. The system looks at all the scheduled stock count records and determines whether any are scheduled for today or the user-specified future date. The process creates the stock counts for each individual store. For example, if a scheduled count includes a list of five stores, then five separate stock count records are created.

If an all-location stock count is being run, the batch processing generates individual counts for every macro sequence location.

The date parameter is optional when running the Extract Stock Counts batch. If no date is provided, today's date is used.

Batch Job Definition Name

GenerateUnitAmountStockCount_OpsJob

Batch Job Parameters

N/A

Key Tables

Table 5-10 Key Tables for Generate Unit Amount Stock Count Batch

Table Select Insert Update Delete

group_schedule_extract


Yes


Yes

product_group

Yes




product_group_hierarchy

Yes




product_group_item

Yes




product_group_sched_store

Yes




product_group_schedule

Yes


Yes


product_group_item_bkdn


Yes


Yes

stock_count

Yes

Yes

Yes


stock_count_child


Yes

Yes


stock_count_line_item


Yes

Yes


stock_count_line_item_uin


Yes

Yes


item

Yes




store_item

Yes




store_item_stock

Yes




item_component

Yes





Generate Unit Stock Count

This batch program generates Unit stock counts.

On a daily basis, the batch process creates the stock counts that are scheduled for the current day or future date which matches the next scheduled date. The system looks at all the scheduled stock count records and determines whether any are scheduled for today or the user specified future date. The process creates the stock counts for each individual store.For example, if a scheduled count includes a list of five stores, then five separate stock count records are created.

If the system is configured to use unguided stock counts, the batch process does not generate multiple counts even if the item is located at multiple locations within the store.

The date parameter is optional when running the Extract Stock Counts batch. If no date is provided, today's date is used.

Batch Job Definition Name

GenerateUnitStockCount_OpsJob

Batch Job Parameters

N/A

Key Tables

Table 5-11 Key Tables for Generate Unit Stock Count Batch

Table Select Insert Update Delete

group_schedule_extract


Yes


Yes

product_group

Yes




product_group_hierarchy

Yes




product_group_item

Yes




product_group_sched_store

Yes




product_group_schedule

Yes


Yes


product_group_item_bkdn


Yes


Yes

stock_count

Yes

Yes

Yes

Yes

stock_count_child


Yes

Yes

Yes

stock_count_line_item


Yes

Yes

Yes

stock_count_line_item_uin


Yes

Yes


item

Yes




store_item

Yes




store_item_stock

Yes




item_component

Yes





Item Price to History

This batch writes the active item price records into item price history table. After the active item prices are recorded in the item price history table, the batch updates the ITEM_PRICE table statuses as completed for these records.

Batch Job Definition Name

ItemPriceToHistory_OpsJob

Batch Job Parameters

N/A

Key Tables

Table 5-12 Key Tables for Item Price to History Batch

Table Select Insert Update Delete

item_price

Yes


Yes

Yes

item_price_history


Yes




Product Group Schedule Cleanup

This batch program searches for all open product group schedules that have ended date before today (or user specified date), and change the product group schedule status to closed.

Batch Job Definition Name

ProductGroupScheduleCleanup_OpsJob

Batch Job Parameters

N/A

Key Tables

Table 5-13 Key Table for Close Prod Group Schedule Batch

Table Select Insert Update Delete

Product_group_schedule

Yes


Yes



Return Not After Date Alert

This batch process warns users a number of days in advance that the RTV/RTW is about to reach the Not After date and must be dispatched. The value for the number of days of advance warning is configurable using the system's administration screens.

Batch Job Definition Name

ReturnNotAfterDateAlert_OpsJob

Batch Job Parameters

N/A

Key Tables

Table 5-14 Key Tables for Return Not After Date Alert Batch

Tables Select Insert Update Delete

rtv

Yes




rtv_line_item

Yes




shipment_reason

Yes




stock_item

Yes





Stock Count Authorize Recovery

This batch process looks for stock counts that are stuck in Authorize Processing state. This is a unique state that appears when an error occurs during the final processing of a stock count. The batch attempts to fully authorize the stock count. Errors that occur during the batch process are logged to the server error logs and will indicate the reason for any further processing failures. Successfully authorized stock counts will move to authorized completed state.

Batch Job Definition Name

StockCountAuthorizeRecovery_OpsJob

Batch Job Parameters

N/A

Key Tables

Table 5-15 Key Tables for Stock Count Authorize Recovery Batch

Tables Select Insert Update Delete

stock_count

Yes


Yes


stock_count_child

Yes


Yes


stock_count_line_item

Yes


Yes


stock_count_line_item_uin

Yes




item_uin

Yes


Yes


store_item

Yes




store_item_stock



Yes


product_group_schedule

Yes




product_group_sched_store

Yes




store

Yes




stock_count_sale

Yes



Yes

inv_adjust_reason

Yes





Stock Count Unit and Amount Snapshots

This job takes the snapshot of current inventory for Unit and Amount Type of Stock Counts for the items across all stores or for a specific store.

Batch Job Definition Name

StockCountUnitAndAmountSnapshot_OpsJob

Batch Job Parameters

<store_id> If store_id is not specified, then stock count snapshot will be taken for all stores.

Key Tables

Table 5-16 Key Tables for Stock Count Unit And Amount Snapshot Batch

Table Select Insert Update Delete

stock_count

Yes


Yes


stock_count_child

Yes


Yes


stock_count_line_item

Yes


Yes


Store_item

Yes




store_item_stock

Yes





Transfer Close

This batch program looks for all the open transfers which have passed their not after date and are in valid state for closure.

Batch Job Definition Name

TransferClose_OpsJob

Batch Job Parameters

N/A

Key Tables

Table 5-17 Key Tables for Close Transfers Batch

Table Select Insert Update Delete

activity_history


Yes



config_store

Yes




msp_staged_message


Yes



store

Yes




store_item_stock

Yes


Yes


tsf

Yes


Yes


tsf_line_item

Yes


Yes


tsf_ship

Yes




tsf_ship_carton

Yes




tsf_ship_line_item

Yes





Transfer Delivery Auto Receive

Transfer Delivery Auto Receive batch does the following:

  • Retrieves a list of all stores.

  • Retrieves the auto receive configuration option for the location types (Store, Warehouse, and Finisher).

  • For each store, if the Auto Receive store parameter is set to Date Driven, then the batch auto-receives all deliveries that are in New and In Progress status and who's Ship Date added to the Auto Receive Number of Days is less than the current date.

Batch Job Definition Name

TransferDeliveryAutoReceive_OpsJob

Batch Job Parameters

N/A

Key Tables

Table 5-18 Key Tables for Auto Receive Transfer Deliveries

Table Select Insert Update Delete

activity_history


Yes



config_store

Yes




inv_adjust_reason

Yes




item_uin

Yes


Yes

Yes

store_item_stock

Yes


Yes


store_item_stock_history


Yes



store_sequence_area

Yes




store_sequence_item

Yes




tsf

Yes


Yes


tsf_allocation

Yes


Yes


tsf_delv

Yes




tsf_delv_carton

Yes


Yes

Yes

tsf_delv_line_item

Yes


Yes


store

Yes





Transfer Delivery Close

This batch program looks for all the open transfer deliveries and auto confirms all the transfer deliveries based on the store parameter ”Auto Close Receipt”.

When the parameter value is "0", close the deliveries at the end of day today and when value is "x" close the deliveries at the end of "x" days stating from today.

Batch Job Definition Name

TransferDeliveryClose_OpsJob

Batch Job Parameters

N/A

Key Tables

Table 5-19 Key Tables for Close Transfer Deliveries Batch

Table Select Insert Update Delete

activity_history


Yes



config_store

Yes




inv_adjust_reason

Yes




item_uin

Yes


Yes

Yes

store_item_stock

Yes


Yes


store_item_stock_history


Yes



store_sequence_area

Yes




store_sequence_item

Yes




tsf

Yes


Yes


tsf_allocation

Yes


Yes


tsf_delv

Yes




tsf_delv_carton

Yes


Yes

Yes

tsf_delv_line_item

Yes


Yes


store

Yes





Transfer Not After Date Alert Batch

This batch process generates email alerts for any pending transfer requests with not after date coming up within number of days specified in the system parameter "Days to Send Email Alert Before Not After Date for Transfer Requests".

Batch Job Definition Name

TransferNotAfterDateAlert_OpsJob

Batch Job Parameters

N/A

Key Tables

Table 5-20 Key Tables for Transfers Not After Date Alert Batch

Tables Select Insert Update Delete

tsf

Yes




tsf_line_item

Yes




store

Yes





Transfers Overdue

This batch process sends user e-mail for dispatched transfers which have not been received after a number of days. The value for the number of days of e-mail alert is configurable using the system's administration screen.

Batch Job Definition Name

TransfersOverdueBatch_OpsJob

Batch Job Parameters

N/A

Key Tables

Table 5-21 Key Tables for Transfers Overdue Batch

Tables Select Insert Update Delete

tsf_delv

Yes




tsf_delv_carton

Yes





Vendor Return Closure

This batch program looks for all the open vendor returns which are in valid state (Closed /Rejected) for closure.

Batch Job Definition Name

VendorReturnClosure_OpsJob

Batch Job Parameters

N/A

Key Tables

Table 5-22 Key Tables for Close Vendor Return

Table Select Insert Update Delete

rtv

Yes

Yes

Yes


rtv_line_item

Yes

Yes

Yes

Yes

rtv_line_item_uin




Yes

store_item_stock

Yes


Yes


shipment_reason

Yes





Wastage Inventory Adjustments

This batch process looks for wastage product groups that are scheduled for today and creates an inventory adjustment for each item in the product group. The batch process uses amounts based on percentage/units. Note that if both a percentage and unit exist, the batch process applies the least amount of the two. For example, consider an item with a stock on hand value of 100. If the two values are 10% and 5 units, the batch process would create an inventory adjustment of 5 units for the item.

The batch process creates a completed inventory adjustment record using the adjustment reason of Shrinkage (code = 1) for each item that is published to the merchandising system.


Note:

Wastage is not run for items that require UINs.

Batch Job Definition Name

GenerateStockWastageAdjustment_OpsJob

Batch Job Parameters

N/A

Key Tables

Table 5-23 Key Tables for Wastage Inventory Adjustments Batch

Tables Select Insert Update Delete

group_schedule_extract

Yes

Yes


Yes

inv_adjust_reason

Yes




item

Yes




product_group

Yes




product_group_hierarchy

Yes




product_group_item

Yes




product_group_sched_str

Yes


Yes


product_group_schedule

Yes


Yes


schedule_group_item

Yes

Yes


Yes

store_item

Yes




store_item_stock

Yes


Yes


store_item_stock_history


Yes



store_item_stock_publish

Yes

Yes


Yes


BDI-Based Batches

BDI (Bulk Data Integration) is the Oracle Retail Integration tool for bulk data movement. The BDI infrastructure applications move data from one application to another. So there is data producing applications and data consuming applications. This section describers the importer details.

Clearance Transaction Import

This batch imports the clearance price changes from BDI Inbound Interface tables into EICS application tables.

Batch Job Definition Name

Clearance_Tx_ImporterJob

Batch Job Parameters

<dataSetId>

Key Tables

Table 5-24 Key Tables for Clearance Transaction Import

Table

CLEARANCE_IN

ITEM_PRICE


Price Change Transaction Import

This batch imports the regular price changes from BDI Inbound Interface tables into EICS application tables.

Batch Job Definition Name

PriceChange_Tx_ImporterJob

Batch Job Parameters

<dataSetId>

Key Tables

Table 5-25 Key Tables for Price Change Transaction Import

Table

CLEARANCE_IN

ITEM_PRICE


Rfid Transaction Import

This batch imports the external RFID from BDI Inbound Interface tables into EICS application tables.

Batch Job Definition Name

ExtRfid_Tx_ImporterJob

Batch Job Parameters

<dataSetId>

Key Tables

Table 5-26 Key Tables for Rfid Transaction Import

Table

EXT_RFID_IN

RFID


Third Party Pricing Import

This batch imports the external item pricing from BDI Inbound Interface tables into EICS application tables.

Batch Job Definition Name

ExtPrice_Tx_ImporterJob

Batch Job Parameters

<dataSetId>

Key Tables

Table 5-27 Key Tables for Third Party Pricing Import

Table

EXT_PRICE_IN

ITEM_PRICE


Warehouse Avail Inventory Import

This batch imports the warehouse available inventory from BDI Inbound Interface tables into EICS application tables.

Batch Job Definition Name

InvAvailWh_Tx_ImporterJob

Batch Job Parameters

<dataSetId>

Key Tables

Table 5-28 Key Tables for Third Party Pricing Import

Table

INV_AVAIL_WH_IN

WAREHOUSE_ITEM


SFTP File-Based Batches

EICS SFTP-Based File batches are file integration via SFTP. The following topics are covered:

High Level Batch File Process Overview

  • The file import job processes each file from incoming directory when a corresponding completer file presents. The completer is a zero byte file which indicates file transfer is complete and ready for processing.

  • The batch file process also handle the movement of input, output and reject files to the respective directories.

  • Output files and reject files will be pushed to outgoing for client review and usage.

  • Incoming files can be NFS mounted file system or SFTP (for external integration) as single file or zipped by each file type.

  • Outgoing files will be zipped by file type and pushed to outgoing location.

File-Based Batch List

Table 5-29 File-Based Batch List

Batch Name Description Name Pattern (see Note below table)

Clearance Price Change Import

This batch process imports the clearance price changes from flat files into item price table. Application uses this data to update price information of the items.

Prefix: CLRPC_

Suffix: .zip

Completer: .zip.complete

Job Parameter: none

Promotion Price Change Import

This batch process imports the promotion price changes from flat files into item price table. Application uses this data to update price information of the items.

Prefix: PRMPC_

Suffix: .zip

Completer: .zip.complete

Job Parameter: none

Regular Price Change Import

This batch process imports the price changes from flat files into item price table. Application uses this data to update price information of the items.

Prefix: REGPC_

Suffix: .zip

Completer: .zip.complete

Job Parameter: none

POS transaction import

This batch imports POS Transaction records from the flat file, that came from POS into the database staging table where polling timer framework will pick those staged requests and update the stock tables.

Prefix: SIMTLOG_

Suffix: .zip

Completer: .zip.complete

Job Parameter: none

Retail Sale Audit Import

This batch program imports sales/order transaction data (SIM-ReSA file) that originated in Oracle Retail Xstore Point of Service. The batch also writes each failure record into a transaction log table.

Prefix: SIMT_

Suffix: .zip

Completer: .zip.complete

Job Parameter: none

Store Sequence Import

This batch file import sequencing information like store sequence areas and items mapped to those areas from a flat file.

Prefix: SSEQ_

Suffix: .zip

Completer: .zip.complete

Job Parameter: none

Warehouse Item Stock Import

This batch imports the inventory of an items in a warehouse from flat files into warehouse item table.

Prefix: WHIMS_

Suffix: .zip

Completer: .zip.complete

Job Parameter: none

Inventory Extract

This batch extracts the inventory to a file that has been altered on or after the specified date for the specified store. The store id is not mandatory for the batch process. In case store id is not passed the files will be generated per store. The scheduled job will always generate files for all stores.

Prefix: PRODUCT_LOCATION_INV_

Suffix: .zip

Job Parameter: storeId (optional)



Note:

Incoming File Pattern: The integration incoming files from file provider which are in old release (such as ORPM16.0.x, ORMS 16.0.x) which are not using the .zip and completer indicator file. EICS 17.0 is backward compatible with the incoming files which are not in zip and without completer indicator file.

Clearance Price Change Import

This batch imports the clearance price changes from flat file into SIM item price table. Each file contains price change record for a single location. Files with location type of store (file name with suffix of "S" are relevant to SIM. The import process skips file with location type which are not store.

There are two phases involve in the batch process. The file load phase loads the file into price change worksheet table; the extract phase kicks off multiple threads to extract the approved worksheet records into item price table.

To optimize price change batch import process, admin user can change the SIM system configuration parameter 'DAYS_TO_HOLD_PRICE_CHANGE_WORKSHEET' value to 0, the completed staged worksheet records will be deleted after price change records are extracted into item_price table.

Batch Job Definition Name

ClearancePriceChange_OpsJob

Batch Job Parameters

<File name>

If not specified, then the data file in incoming directory are processed.

File Error Handling

The batch job will be marked as failed if the file staging fails. The staging process is all or none transaction so if an error occurs during the batch process, none of the transactions in the file will be staged. The user will need to rerun the same file again after resolving any errors.

Key Tables

Table 5-30 Key Tables for Clearance Price Change Batch

Table Select Insert Update Delete

batch_execution

Yes

Yes

Yes


price_change_worksheet

Yes

Yes

Yes

Yes

Item_price

Yes

Yes

Yes



Inventory Extract

This batch extracts the inventory to a file that has been altered on or after the specified date for the specified store.

Batch Job Definition Name

ClearancePriceChange_OpsJob

Batch Job Parameters

N/A.

Key Tables

Table 5-31 Key Tables for Inventory Extract Batch

Table Select Insert Update Delete

item

Yes




store_item

Yes




store_item_stock

Yes





Pos Transaction Import

This batch imports pos transaction records from the flat file (SIMT-LOG file) that came from ORXPOS into the SIM database staging table where polling timer framework will pick those staged requests and update the stock tables in SIM.

The batch process takes the sales/order transaction data and stage them to the SIM database staging table from where they are picked up by the polling timer framework to update the store item's inventory buckets (for example, store item's total quantity, shop floor quantity), if applicable.

The file will contain both sale and order transactions. The batch will assign separate request IDs to sales and order transactions.

For sale transactions, a single request ID cannot contain more than MAX_VALUE = 500 transaction line items with an exception that a single transaction ID cannot span across multiple request IDs.

For order transactions, a single request ID cannot contain more than MAX_VALUE = 500 transaction line items with an exception that a single customer order ID cannot span across multiple request IDs.

The file contains transactions for a single store.

Batch Job Definition Name

PosTransaction_OpsJob

Batch Job Parameters

<File name>

If not specified, then the data file in incoming directory are processed.

File Error Handling

The batch job will be marked as failed if the file staging fails. The staging process is all or none transaction so if an error occurs during the batch process, none of the transactions in the file will be staged. The user will need to rerun the same file again after resolving any errors.

Key Tables

Table 5-32 Key Tables for Pos Transaction Import Batch

Table Select Insert Update Delete

pos_transaction

Yes

Yes



item

Yes




inv_adjust_reason

Yes





Promotion Price Change Import

This batch imports the promotion price changes from flat file into SIM item price table.

There are two phases involve in the batch process. The file load phase loads the file into price change worksheet table; the extract phase kicks off multiple threads to extract the approved worksheet records into item price table.

To optimize price change batch import process, admin user can change the SIM system configuration parameter 'DAYS_TO_HOLD_PRICE_CHANGE_WORKSHEET' value to 0, the completed staged worksheet records will be deleted after price change records are extracted into item_price table.

Batch Job Definition Name

PromotionPriceChange_OpsJob

Batch Job Parameters

<File name>

If not specified, then the data file in incoming directory are processed.

File Error Handling

The batch job will be marked as failed if the file staging fails. The staging process is all or none transaction so if an error occurs during the batch process, none of the transactions in the file will be staged. The user will need to rerun the same file again after resolving any errors.

Key Tables

Table 5-33 Key Tables for Promotion Price Change Batch

Tables Select Insert Update Delete

price_change_worksheet

Yes


Yes

Yes

item_price

Yes

Yes

Yes


config_store

Yes




item_ticket


Yes



ticket_format_hierarchy

Yes




item_uda

Yes




print_format_type

Yes




ticket_request

Yes

Yes




Regular Price Change Import

This batch imports the regular price changes from flat file into SIM item price table.

There are two phases involve in the batch process. The file load phase loads the file into price change worksheet table; the extract phase kicks off multiple threads to extract the approved worksheet records into item price table.

To optimize price change batch import process, admin user can change the SIM system configuration parameter 'DAYS_TO_HOLD_PRICE_CHANGE_WORKSHEET' value to 0, the completed staged worksheet records will be deleted after price change records are extracted into item_price table.

Batch Job Definition Name

RegularPriceChange_OpsJob

Batch Job Parameters

<File name>

If not specified, then the data file in incoming directory are processed.

File Error Handling

The batch job will be marked as failed if the file staging fails. The staging process is all or none transaction so if an error occurs during the batch process, none of the transactions in the file will be staged. The user will need to rerun the same file again after resolving any errors.

Key Tables

Table 5-34 Key Tables for Regular Price Change Batch

Tables Select Insert Update Delete

price_change_worksheet

Yes

Yes

Yes

Yes

item_price

Yes

Yes

Yes


config_store

Yes




item_ticket


Yes



ticket_format_hierarchy

Yes




item_uda

Yes




print_format_type

Yes




ticket_request

Yes

Yes



batch_execution

Yes

Yes

Yes



Retail Sale Audit Import

This batch program imports sales/order transaction data (SIM-ReSA File) that originated in Oracle Retail Xstore Point of Service. The external audit system will provide in its sales upload file a percentage or quantity that indicates how much the inventory needs to be reduced by, in addition to the sold quantity.

For example, meat will become lighter as fluids evaporate. Other items, for example cheese or ham, will only be reduced when of the outside layers are cut off to sell the item.

The batch process takes the sales transaction data to update the store item's inventory buckets. From the batch program, SIM learns about inventory movement (that is, what is sold, what is returned, what is reserved and what is fulfilled). Once SIM attains the data, SIM assumes that sales should be taken from the store's shelf-related inventory buckets. This assumption is important to SIM's shelf replenishment processing. Similarly, SIM assumes that returns should go to the backroom bucket; the system's logic is that returns must be inspected.

The batch takes the sales/order transaction data and stage them to the SIM database staging table from where they are picked up by the polling timer framework to update the store item's inventory buckets (for example, store item's total quantity, shop floor quantity), if applicable.

The file will contain both sales and order transactions. The batch job combines the transaction number and register number to form the transaction ID in SIM. Request IDs are assigned to the transactions in such a way that a single request ID will not contain more than MAX_SIZE=500 records with an exception that a single transaction ID should not span across multiple request IDs.

During processing staging records, batch also writes each failure record into a transaction log table.

Batch Job Definition Name

RetailSalesAuditImport_OpsJob

Batch Job Parameters

<File name>

If not specified, then the data file in incoming directory are processed.

File Error Handling

The batch job will be marked as failed if the file staging fails. The staging process is all or none transaction so if an error occurs during the batch process, none of the transactions in the file will be staged. The user will need to rerun the same file again after resolving any errors.

Key Tables

Table 5-35 Key Tables for Retail Sale Audit Import Batch

Table Select Insert Update Delete

pos_transaction


Yes



inv_adjust_reason

Yes





Store Sequence Import

This batch imports store sequencing information from a flat file. Before importing, the batch will delete the existing sequencing information including sequence items and sequence areas excluding no-location store area which is the default store sequence area.

Batch Job Definition Name

StoreSequenceImport_OpsJob

Batch Job Parameters

<File name>

If not specified, then the data file in incoming directory are processed.

File Error Handling

The file loading process is all or none transaction so if an error occurs during the batch process, none of the transactions in the file will be committed. The user will need to rerun the same file again after resolving any errors.

Key Tables

Table 5-36 Key Tables for Store Sequence Import Batch

Tables Select Insert Update Delete

store_sequence_area


Yes


Yes

store_sequence_item


Yes


Yes


Third Party Stock Count Import

This batch imports the stock count quantities which are setup in SIM and physical counting is conducted by a third party. The batch updates the store stock on hand quantities; invalid records are saved in the rejected item table.

When the stock count is set up as auto-authorize "Unit and Amount Stock Count", an Unit and Amount Stock Counts Export file is generated as a result of stock count auto authorization. See Appendix: Unit and Amount Stock Counts Export for details.

Batch Job Definition Name

ThirdPartyStockCountImport_OpsJob

Batch Job Parameters

<File name>

If not specified, then the data file in incoming directory are processed.

File Error Handling

The batch job will be marked as failed if the file staging fails. The staging process is all or none transaction so if an error occurs during the batch process, none of the transactions in the file will be staged. The user will need to rerun the same file again after resolving any errors.

Key Tables

Table 5-37 Key Tables for Third Party Stock Count Import Batch

Tables Select Insert Update Delete

stock_count_import

Yes


Yes


stock_count_rejected_item


Yes



stock_count

Yes


Yes


stock_count_child

Yes


Yes


stock_count_line_item

Yes


Yes


item_price

Yes




item

Yes




store_item

Yes




item_uin

Yes




stock_count_line_item_uin

Yes





Warehouse Item Stock Import

This batch imports the inventory of an items in a warehouse from flat files into warehouse item table. The batch updates the warehouse item total quantity.

Batch Job Definition Name

WarehouseItemStockImport_OpsJob

Batch Job Parameters

<File name>

If not specified, then the data file in incoming directory are processed.

File Error Handling

The import process is all or none transactions so if an error occurs during the batch process, the batch job will be marked as failed. The user will need to rerun the same file again after resolving any errors.

Key Tables

Table 5-38 Key Tables for Warehouse Item Stock Import Batch

Tables Select Insert Update Delete

warehouse_item


Yes


Yes


Nightly Batch File Uploads

The following is the file upload process. The Private/Public Keys must be generated and the public Key must be associated with your SFTP Account for the file uploads. The Adding Authorized Keys section describes the step-by-step method to generate the Keys (2048 bit RSA Keys).

Adding Authorized Keys

Use this process to generate a 2048 bit RSA key and add the same to the SFTP server. With Windows, use the WinSCP tool or with Linux, use ssh-keygen.

  1. Launch WinSCP and select Tools/Run PuttyGen.

  2. Select SSH-2 RSA for the type of key to generate and enter 2048 for the number of bits in a generated key field and click Generate.

    Figure 5-1 Key Generator

    Key Generator
  3. Move the mouse over the blank space in the window until the key is generated.

    Figure 5-2 Key Generator Progress

    Key Generator Progress
  4. Once the key is generated, click Save public key to save the public key to a file.

  5. Click Save private key to save the Private key to a file. Confirm to save it with or without a passphrase.

  6. Open an SR with Oracle Support, to associate the Public half of the Key with your SFTP account (attach the Key with the SR).

Login to WinSCP

These upload steps use the private key generated in section, Adding Authorized Keys.

  1. Launch WinSCP and connect to <SFTP Server> using port 22.

  2. Enter the username and then click Advanced.

  3. Click Authentication.

  4. In the Private Key File field, click Browse and select the private key created in the section, Adding Authorized Keys.

    Figure 5-3 Advanced Site Settings

    Advanced Site Settings
  5. After loading the private key file, click OK.

    Figure 5-4 Private Key File Loaded

    Private Key File Loaded
  6. Click Login. The window does not prompt for a password and logs into the SFTP server. Provide a passphrase if one has been set up.


    Note:

    Login can only be performed using the authorized keys. Login with username / password is not supported.

Uploading a Batch File

Login to the WinSCP by following the steps in Login to WinSCP.

  1. Transfer the file to be copied (for example, test) to /<SFTP User>.

    Figure 5-5 <SFTP User> Directory

    <SFTP User> Directory
  2. Transfer an empty file <filename>.complete (for example, test.complete) to the directory /<SFTP User>.

    Figure 5-6 Transferring Empty File

    Transferring Empty File
  3. If multiple files have to be transferred, copy all the files to /<SFTP_user>.

    Figure 5-7 Transferring Multiple Files

    Transferring Multiple Files
  4. Transfer all the corresponding <filename>.complete files to the /<SFTP_user> directory for the transfer to complete.

    Figure 5-8 Transferring .complete Files

    Transferring .complete Files

Export File Downloads

The following steps show the download file process.

  1. Login to the WinSCP by following the steps in Login to WinSCP.

  2. Change the directory to /<SFTP User>/EXPORT.

  3. Download all data files.

Purge Batches

Purge Adhoc Stock Count

PurgeAdHocStockCount batch does the following:

  • Deletes ad hoc stock counts with a status of in progress.

  • Any ad hoc stock count with a creation date/time stamp older than the Days to Hold In Progress Ad Hoc Counts parameter value will be deleted. For example, the default value is 1. If the batch program is run with the default value, the batch program would delete all in-progress counts more than 24 hours old.

This batch program deletes ad hoc stock counts with a status of in progress. Any ad hoc stock count with a creation date/time stamp older than the Days to Hold In Progress Ad Hoc Counts parameter value will be deleted. For example, the default value is 1. If the batch program is run with the default value, the batch program would delete all in-progress counts more than 24 hours old.

Batch Job Definition Name

AdhocStockCount_PurgeJob

Batch Job Parameters

N/A

Key Tables

Table 5-39 Key Tables for Purge AdHoc Stock Count Batch

Tables Select Insert Update Delete

config_system

Yes




stock_count

Yes



Yes

stock_count_rejected_item

Yes



Yes

stock_count_child

Yes



Yes

stock_count_line_item

Yes



Yes

stock_count_line_item_uin

Yes



Yes

stock_count_line_item_att

Yes



Yes


Restart/Recovery

This batch can be restarted/re-run from previous failures after the issues are resolved.

Purge Batch Log

Purge Batch Log batch does the following:

  • Deletes old batch log records.

  • Batch log record with an end date/timestamp older than the DAYS_TO_HOLD_BATCH_LOG system configuration value and with the Status value of 2 (COMPLETED) is deleted. For example, if the default value is 30 and the batch program is run with the default value, the batch program would delete all the records that are more than 30 days old and are in completed status.

  • Delete purge error logs.

Batch Job Definition Name

BatchLog_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-40 Key Tables for Purge Batch Log Batch

Tables Select Insert Update Delete

config_system

Yes




batch_data_error

Yes



Yes

batch_execution

Yes



Yes

purge_error_log

Yes



Yes

purge_error_log

Yes



Yes


Restart/Recovery

This batch can be re-run by starting a new batch job after the issues are resolved.

Purge Closed Transfers

Purge Closed Transfers batch does the following:

  • Deletes all the closed transfer which are in either cancelled or completed status and shipments related to them.Any closed transfer with a update date older than the Days to Hold Transfer Documents parameter value will be deleted. For example, the default value is 30. If the batch program is run with the default value, the batch program would delete all closed transfers, transfer requests and related shipments which are closed and was last updated 30 days ago.

Batch Job Definition Name

ClosedTransfers_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-41 Key Tables for Purge Closed Transfers Batch

Tables Select Insert Update Delete

config_system

Yes




tsf

Yes



Yes

tsf_line_item




Yes

tsf_ship

Yes



Yes

tsf_ship_carton




Yes

tsf_ship_line_item

Yes



Yes

tsf_ship_line_item_uin




Yes

tsf_ship_line_item_att




Yes

shipment_bol




Yes

tsf_delv

Yes




tsf_delv_line_item

Yes





Restart/Recovery

This batch can be re-run by starting a new batch job after the issues are resolved.

Purge Completed UIN Detail

Purge CompletedUINDetail batch does the following:

  • Deletes completed UIN Detail records. A completed UIN is any UIN with a status of Removed from Inventory, Missing, Sold, Shipped to Vendor, or Shipped to Warehouse.

  • Any UIN detail record with a complete status and update date at least X days in the past (where X is with system parameter DAYS_TO_HOLD_COMPLETED_UINS) will be deleted from ITEM_UIN and ITEM_UIN_PROBLEM table.

Batch Job Definition Name

CompletedUin_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-42 Key Tables for Purge Completed UIN Detail Batch

Tables Select Insert Update Delete

config_system

Yes




item_uin

Yes



Yes

item_uin_problem

Yes



Yes


Restart/Recovery

This batch can be restarted/re-run from previous failures after the issues are resolved.

Purge DSD and Purchase Orders

Purge DSD Receivings and Purge orders batch process does the following:

  • Deletes the Direct Store Delivery receivings.

  • Any DSD record which is in Closed/Cancelled status and which has a complete date older than Days to Hold Received Shipments is an eligible record for purge.

  • In effect, a DSD record can be purged only if its associated PO records can be purged.

Batch Job Definition Name

DsdAndPurchaseOrders_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-43 Key Tables for Purge DSD Receivings Batch

Tables Select Insert Update Delete

config_system

Yes




purchase_order

Yes



Yes

purchase_order_line_item

Yes



Yes

dsd

Yes



Yes

notes

Yes



Yes

dsd_adjustment

Yes



Yes

dsd_carton

Yes



Yes

dsd_line_item

Yes



Yes

dsd_line_item_uin

Yes



Yes

dsd_line_item_att

Yes



Yes

purchase_order

Yes



Yes

purchase_order_line_item




Yes


Restart/Recovery

This batch can be restarted/re-run from previous failures after the issues are resolved.

Purge Fulfillment Orders

Purge Fulfillment Orders Batch does the following:

  • Deletes all the fulfillment order records which are not in New or In Progress status and for which the update date has expired the purge_date by number of days more than Days to Hold Customer Order parameter value.

  • Additionally, only those fulfillment orders will be deleted for which customer order ID and fulfillment order ID combination does not exist for any Transfer, Return, Purchase Order, and Warehouse delivery transaction.

Batch Job Definition Name

FulfillmentOrders_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-44 Key Tables for Purge Fulfillment Orders Batch

Tables Select Insert Update Delete

config_system

Yes




tsf

Yes




purchase_order

Yes




tsf_delv_line_item

Yes




ful_ord

Yes



Yes

ful_ord_line_item

Yes



Yes

ful_ord_dlv

Yes



Yes

ful_ord_dlv_line_item

Yes



Yes

ful_ord_dlv_line_item_uin

Yes



Yes

ful_ord_dlv_line_item_att

Yes



Yes

ful_ord_rv_pick

Yes



Yes

ful_ord_rv_pick_line_item

Yes



Yes

ful_ord_pick

Yes



Yes

ful_ord_pick_line_item

Yes



Yes

ful_ord_bin

Yes



Yes


Restart/Recovery

This batch can be restarted/re-run from previous failures after the issues are resolved.

Purge Invalid Users

This job deletes invalid application users from data store for those usernames are not found in identity store.

Batch Job Definition Name

InvalidUser_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-45 Key Tables for Purge Invalid Users Batch

Tables Select Insert Update Delete

config_system

Yes




security_user

Yes




security_user_store

Yes




security_user_role

Yes



Yes


Restart/Recovery

This batch can be re-run by starting a new batch job after the issues are resolved.

Purge Invalid User Roles

PurgeInvalidUserRoles batch program does the following:

  • Removes all expired user roles and orphaned user roles (roles that were deleted by removing a store) from the SIM system.

  • The batch process finds user role assignments that have an end date that is at least X days in the past (where X is specified by the system parameter SECURITY_DAYS_TO_HOLD_EXPIRED_USER_ROLES), and deletes these expired role assignments.

  • The users (excluding super users) with role assignments that have no matching store assignments (orphaned role assignments) are also deleted from SECURITY_USER_ROLE table.

Batch Job Definition Name

InvalidUserRole_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-46 Key Tables for Purge Invalid User Roles Batch

Tables Select Insert Update Delete

config_system

Yes




security_user

Yes




security_user_store

Yes




security_user_role

Yes



Yes


Restart/Recovery

This batch can be restarted/re-run from previous failures after the issues are resolved.

Purge Inventory Adjustments

Deletes inventory adjustments records with a create date/timestamp older than Days To Hold Completed Inventory Adjustments parameter value will be deleted. For example, the default value is 30. If the batch program is run with the default value, the batch program would delete all the inventory adjustment records, which are more than 30 days old.

Batch Job Definition Name

InventoryAdjustment_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-47 Key Tables for Purge Inventory Adjustments Batch

Tables Select Insert Update Delete

config_system

Yes




inv_adjust

Yes



Yes

inv_adjust_line_item

Yes



Yes

inv_adjust_line_item_uin

Yes



Yes

inv_adjust_line_item_att

Yes



Yes


Restart/Recovery

This batch can be restarted/re-run from previous failures after the issues are resolved.

Purge Item

This batch program deletes items with a status of Delete (D).

There are two segments in the PurgeItem Batch which do the following different tasks:

  • Validate if the Item should be deleted.

  • Delete item from all associated tables if validation check is passed.

  • Validate if the item should be deleted. The Validations include:

    • If SOH of item, item parent and item grandparent is 0.

    • If any transfers exist for item, item parent and item grandparent.

    • If any RTV exists for item, item parent and item grandparent.

    • If any Inventory adjustment exists for item, item parent and item grandparent and so on.

    • If any Item Basket exists for the item.

    • If any Product Group exists for the item.

    • If any Stock Count exists for the item.

    • If any Store Order exists for the item.

    • If any Item Request exists for the item.

    • If any Direct Store Delivery exists for the item.

    • If any Warehouse Delivery exists for the item.

  • Delete item from all associated table. If the validations checks are met, the records related to the item which is marked for the purge action are deleted.

Batch Job Definition Name

Item_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-48 Key Tables for Purge Item Batch

Tables Select Insert Update Delete

item_componen

Yes



Yes

Item

Yes



Yes

store_item_stock

Yes




purchase_order_line_item

Yes




rtv_line_item

Yes




stock_count_line_item

Yes




tsf_line_item

Yes




rtv_ship_line_item

Yes




dsd_line_item

Yes




dsd_adjustment

Yes




stock_count_line_item_uin

Yes




tsf_ship_line_item

Yes




tsf_delv_line_item

Yes




item_basket_line_item

Yes




print_store_order_item

Yes




item_ticket

Yes




item_request_line_item

Yes




ful_ord_line_item

Yes




ful_ord_pick_line_item

Yes




inv_adjust_line_item

Yes




inv_adjust_template_item

Yes




shelf_adjust_line_item

Yes




shelf_replenish_line_item

Yes




tsf_allocation

Yes




item_uin

Yes



Yes

store_item

Yes



Yes

item_image

Yes



Yes

store_sequence_item

Yes



Yes

store_item_stock

Yes



Yes

store_item_stock_nonsell

Yes



Yes

supplier_item_manufacture

Yes



Yes

warehouse_item

Yes



Yes

partner_item

Yes



Yes

supplier_item_uom

Yes



Yes

supplier_item

Yes



Yes

supplier_item_country

Yes



Yes

supplier_item_country_dim

Yes



Yes

item_ticket

Yes



Yes

item_component

Yes



Yes

item_price

Yes



Yes

item_price_history

Yes



Yes

store_uin_admin_item

Yes



Yes

item_uda

Yes



Yes

product_group_item

Yes



Yes

related_item

Yes



Yes


Restart/Recovery

This batch can be restarted/re-run from previous failures after the issues are resolved.

Purge Item Price

Purge Item Price batch process does the following:

  • Purges records which were expired or were marked as deleted from ITEM_PRICE table based on the retention period. The retention period is specified by system configuration parameter DAYS_TO_HOLD_EXPIRED_ITEM_PRICE.

Following are the rules defining records to be purged:

  • Regular Price Change: Has status of completed or deleted, effective date was X number of days in the past (relative to the specified date if specified). At any given time, at least one completed latest regular price must be retained in ITEM_PRICE for a store item.

  • Promotion Change: Has status of completed or deleted, and end date is number of days in the past (relative to the specified date if specified).

  • Clearance Change: Has status of completed or deleted, and end date is number of days in the past (relative to the specified date if specified).

Batch Job Definition Name

ItemPrice_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-49 Key Tables for Purge Item Price Batch

Tables Select Insert Update Delete

item_price

Yes



Yes


Restart/Recovery

This batch can be restarted/re-run from previous failures after the issues are resolved.

Purge Item Hierarchy

Purges all Item Hierarchies that is in delete status. It also records from referencing tables such as STOCK_COUNT_ADHOC_CONFIG and ITEM_HIERARCHY_ATTRIB.

Batch Job Definition Name

ItemHierarchy_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-50 Key Tables for Purge Item Hierarchy Batch

Table Select Insert Update Delete

item

Yes




product_group_hierarchy

Yes




stock_count_adhoc_config

Yes



Yes

item_hierarchy_attrib

Yes



Yes

item_hierarchy

Yes



Yes


Restart/Recovery

This batch can be restarted/re-run from previous failures after the issues are resolved.

Purge Lockings

This batch process deletes lockings records from ACTIVITY_LOCK table. Any lock record with a lock date/timestamp older than Days to Hold Locking Records (DAYS_TO_HOLD__LOCKING_RECORDS) system configuration value will be deleted. For example, the default value is 30. If the batch program is run with the default value, the batch program would delete all the shelf replenishment records, which are more than 30 days old.

Batch Job Definition Name

Lockings_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-51 Key Tables for Purge Lockings Batch

Tables Select Insert Update Delete

config_system

Yes




activity_lock

Yes



Yes


Restart/Recovery

This batch can be restarted/re-run from previous failures after the issues are resolved.

Purge Notifications

This job deletes notifications. The retention period is specified by system configuration parameter "Days to Hold Notifications".

Batch Job Definition Name

Notifications_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-52 Key Tables for Purge Notifications Batch

Tables Select Insert Update Delete

config_system

Yes




notification

Yes



Yes


Restart/Recovery

This batch can be restarted/re-run after the issues are resolved.

Purge Price Change Worksheet

This batch process deletes price change worksheet records from the staging table which are in Rejected/Completed status. Any price change record with an effective date/timestamp older than Days To Hold Price Changes parameter value will be deleted. For example, the default value is 30. If the batch program is run with the default value, the batch program would delete all the price change records, which are more than 30 days old.

Batch Job Definition Name

PriceChangeWorksheet_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-53 Key Tables for Purge Price Change Worksheet Batch

Tables Select Insert Update Delete

config_system

Yes




price_change_worksheet

Yes



Yes

item_price




Yes


Restart/Recovery

This batch can be restarted/re-run from previous failures after the issues are resolved.

Purge Price Histories

This batch process deletes price histories. At least a minimum of 4 historical prices are maintained for an item/store. Days To Hold Price History will determine the number of days that price histories can be kept in the database.

Batch Job Definition Name

PriceHistories_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-54 Key Tables for Purge Price Histories Batch

Tables Select Insert Update Delete

config_system

Yes




item_price_history

Yes



Yes


Restart/Recovery

This batch can be restarted/re-run from previous failures after the issues are resolved.

Purge Related Items

This batch process deletes the related items for which the end date has expired for more than Days To Hold Related Items (DAYS_TO_HOLD_RELATED_ITEMS) system configuration value.

Batch Job Definition Name

RelatedItems_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-55 Key Tables for Purge Related Items Batch

Tables Select Insert Update Delete

config_system

Yes




related_item

Yes



Yes


Restart/Recovery

This batch can be restarted/re-run from previous failures after the issues are resolved.

Purge Resolved UIN Problems

Deletes resolved UIN exception records. UIN exception records with status of resolved and resolved date is at least X days in the past (where X is system parameter DAYS_TO_HOLD_RESOLVED_UIN_EXCEPTIONS) are deleted from ITEM_UIN_PROBLEM table.

Batch Job Definition Name

ResolvedUinProblem_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-56 Key Tables for Purge Resolved UIN Problems Batch

Table Select insert Update Delete

config_system

Yes




item_uin_problem

Yes



Yes


Restart/Recovery

This batch can be restarted/re-run from previous failures after the issues are resolved.

Purge RFID

This job deletes RFIDs which is not present in location. The retention period is specified by system configuration parameter "Days to Hold RFID".

Batch Job Definition Name

Rfid_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-57 Key Tables for Purge Notifications Batch

Tables Select Insert Update Delete

config_system

Yes




Rfid

Yes



Yes


Restart/Recovery

This batch can be restarted/re-run after the issues are resolved.

Purge Sales Posting

This batch process deletes the Point-of-Service transaction from the Oracle Retail Xstore Point of Service transaction staging table. It reads the Days to Hold Sales Posting and Days to Hold Failed Sales configuration parameters and all the transactions which are present beyond the configuration parameter are deleted. It also purges the POS transaction logs for the request IDs that are in processed status.

Batch Job Definition Name

SalesPosting_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-58 Key Tables for Purge Sales Posting Batch

Tables Select Insert Update Delete

config_system

Yes




pos_transaction

Yes




pos_transaction_log

Yes





Restart/Recovery

This batch can be restarted/re-run from previous failures after the issues are resolved.

Purge Shelf Replenishment

This batch process deletes shelf replenishment lists which are in Completed/Cancelled state. Any shelf replenishment list record with a status date/timestamp older than Days To Hold Shelf Replenishment parameter value will be deleted. For example, the default value is 1. If the batch program is run with the default value, the batch program would delete all the pick list records, which are more than a day old.

In addition, the batch will also delete shelf adjustment lists which are in Complete state. Any shelf adjustment record with an update date/timestamp older than Days to Hold Shelf Adjustment Lists parameter value will be deleted.

Batch Job Definition Name

ShelfAdjustments_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-59 Key Tables for Purge Shelf Replenishment Batch

Tables Select Insert Update Delete

config_system

Yes




shelf_adjust

Yes




product_group

Yes




shelf_replenish_line_item

Yes



Yes

shelf_replenish

Yes



Yes


Restart/Recovery

This batch can be restarted/re-run from previous failures after the issues are resolved.

Purge Staged Message

This batch finds integration staging records that are marked as processed or deleted, and update date is at least X days in the past (where X is the system parameter DAYS_TO_HOLD_COMPLETED_STAGING_RECORDS), the batch process deletes these records from MPS_STAGED_MESSAGE table.

Rebuilding the indexes on the MPS_STAGED_MESSAGE table each day is recommended after batch process completes.

Batch Job Definition Name

StagedMessage_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-60 Key Tables for Purge Staged Message Batch

Tables Select Insert Update Delete

config_system

Yes




mps_staged_message

Yes



Yes


Restart/Recovery

This batch can be restarted/re-run from previous failures after the issues are resolved.

Purge Stock Counts

This batch process deletes stock counts which are in Completed/Cancelled status. Any stock count with a schedule date/timestamp older than Days To Hold Completed Stock Counts parameter value will get deleted. For example, the default value is 30. If the batch program is run with the default value, the batch program would delete all the stock return records, which are more than 30 days old.

Batch Job Definition Name

StockCounts_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-61 Key Tables for Purge Stock Counts Batch

Table Select Insert Update Delete

config_system

Yes




stock_count

Yes



Yes

stock_count_child

Yes



Yes

stock_count_rejected_item

Yes



Yes

shelf_replenish_line_item

Yes



Yes


Restart/Recovery

This batch can be restarted/re-run from previous failures after the issues are resolved.

Purge Temporary UIN Detail

This batch process deletes temporary UIN detail records. UIN detail records with no status and update date is at least X days in the past (where X is system parameter DAYS_TO_HOLD_TEMPORARY_UINS) are deleted from ITEM_UIN table.

Batch Job Definition Name

TemporaryUin_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-62 Key Tables for Purge T emporary UIN Detail Batch

Table Select Insert Update Delete

Item_uin

Yes



Yes


Restart/Recovery

This batch can be restarted/re-run from previous failures after the issues are resolved.

Purge Vendor Returns

This batch process deletes vendor returns which are in closed or completed status. Any vendor return record with a closed date/timestamp older than DAYS_TO_HOLD_RTV system configuration value will be deleted. For example, the default value is 30. If the batch program is run with the default value, the batch program would delete all the vendor return records, which are more than 30 days old.

Batch Job Definition Name

VendorReturn_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-63 Key Tables for Purge Vendor Returns Batch

Tables Select Insert Update Delete

config_system

Yes




rtv_ship

Yes



Yes

rtv_ship_line_item




Yes

rtv_ship_line_item_att




Yes

rtv_ship_line_item_uin




Yes

rtv


Yes


Yes

rtv_line_item




Yes

notes




Yes


Restart/Recovery

This batch can be restarted/re-run from previous failures after the issues are resolved.

Data Purging Batches - BDI Staging Data

Purge BDI Inbound Price

This job deletes BDI pricing staging data. The retention period is default to 6 months.

Batch Job Definition Name

BdiTxPriceGrp_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-64 Key Tables for Purge BDI Warehouse Item Avail

Tables

EXT_PRICE_IN

PRICE_CHANGE_IN

CLERANCE_IN


Restart/Recovery

This batch can be re-run after the issues are resolved.

Purge BDI Item

This job deletes BDI item hierarchy and item staging data. The retention period is default to 6 months.

Batch Job Definition Name

BdiFndMerchItemGrp_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-65 Key Tables for Purge BDI Item

Tables

ITEM_HDR_IN

ITEM_IMAGE_IN

MERCH_HIER_IN

RELATED_ITEM_DTL_IN

RELATED_ITEM_IN

PACKITEM_BREAKOUT_IN


Restart/Recovery

This batch can be re-run after the issues are resolved.

Purge BDI Item Loc

This job deletes item location records from BDI inbound interface staging tables. The retention period is default to 6 months.

Batch Job Definition Name

BdiFndItemLocGrp_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-66 Key Tables for Purge BDI Item Loc

Tables

ITEM_LOC_IN

REPL_ITEM_LOC_IN


Restart/Recovery

This batch can be re-run after the issues are resolved.

Purge BDI Location

This job deletes BDI location entities and their addresses staging data. The retention period is default to 6 months.

Batch Job Definition Name

BdiFndLocationGrp_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-67 Key Tables for Purge BDI Location

Tables

PARTNER_IN

PARTNER_ADDR_IN

PARTNER_ORG_UNIT_IN

STORE_IN

STORE_ADDR_IN

SUPS_IN

SUPPLIER_ADDR_IN

SUPS_CFA_EXT_IN

WH_IN

WH_ADDR_IN


Restart/Recovery

This batch can be re-run after the issues are resolved.

Purge BDI Misc Group

This job deletes BDI code and UOM miscellaneous staging data. The retention period is default to 6 months.

Batch Job Definition Name

BdiFndMiscGrp_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-68 Key Tables for Purge BDI Misc Group

Tables

CODE_HEAD_IN

CODE_DETAIL_IN

DELIVERY_SLOT_IN

UOM_CONVERSION_IN

UOM_CLASS_IN


Restart/Recovery

This batch can be re-run after the issues are resolved.

Purge BDI Price Hist

This job deletes BDI price history staging data. The retention period is default to 6 months.

Batch Job Definition Name

BdiFndPriceHist_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-69 Key Tables for Purge BDI Price Hist

Tables

PRICE_HIST_IN


Restart/Recovery

This batch can be re-run after the issues are resolved.

Purge BDI Rfid

This job deletes BDI Rfid staging data. The retention period is default to 6 months.

Batch Job Definition Name

BdiTxRfid_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-70 Key Tables for Purge BDI Rfid

Tables

EXT_RFID_IN


Restart/Recovery

This batch can be re-run after the issues are resolved.

Purge BDI Store Inventory Avail

This job deletes BDI Available store inventory staging data. The retention period is default to 6 months.

Batch Job Definition Name

BdiTxInvAvailStore_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-71 Key Tables for Purge BDI Store Inventory Avail

Tables

INV_AVAIL_STORE_IN


Restart/Recovery

This batch can be re-run after the issues are resolved.

Purge BDI Supp Item

This job deletes BDI Supplier items staging data. The retention period is default to 6 months.

Batch Job Definition Name

BdiFndSupItemGrp_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-72 Key Tables for Purge BDI Supp Item

Tables

ITEM_SUPPLIER_IN

ITEM_SUP_CTY_DIM_IN

ITEM_SUPP_COUNTRY_IN

ITEM_SUP_MAN_CTY_IN

ITEM_SUPP_UOM_IN


Restart/Recovery

This batch can be re-run after the issues are resolved.

Purge BDI UDA

This job deletes BDI UDA staging data. The retention period is default to 6 months.

Batch Job Definition Name

BdiFndUdaGrp_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-73 Key Tables for Purge BDI UDA

Tables

UDA_IN

UDA_VALUES_IN

UDA_ITEM_DATE_IN


Restart/Recovery

This batch can be re-run after the issues are resolved.

Purge BDI Warehouse Item Avail

This job deletes BDI warehouse item available inventory staging data. The retention period is default to 6 months.

Batch Job Definition Name

BdiTxInvAvailWh_PurgeJob

Batch Job Parameters

<purge_date>

Where purge_date is optional and the date format must be yy-MM-dd if purge_date is specified.

Key Tables

Table 5-74 Key Tables for Purge BDI Warehouse Item Avail

Tables

INV_AVAIL_WH_IN


Restart/Recovery

This batch can be re-run after the issues are resolved.

Batch Admin Overview

This provides information about the processing and operating details of batch job administration and operations, and covers the following topics:

EICS provides an independent user interface for executing and scheduling of the batch jobs. These user interface screen will facilitate users to perform following operations:

  • Execute Ad hoc Jobs

  • Manual Data Seeding Importer Jobs

  • View the Job Execution Log

  • View the list of Jobs executed

  • Schedule Jobs for execution on specific intervals

The batch jobs are installed and configured by the EICS application installer. The batch processes are designed to process large volume of data. The batch jobs can be scheduled as per the retailer's choice to be executed on the specific intervals during the on EICS GUI.

The batch processed which are available for the retailer can be differentiated in following categories:

  1. Data Seeding Importer Jobs

    Data seeding jobs facilitates the retailer to load the foundation data for the application. These jobs process the specific data from BDI staging tables to the application tables.


    Note:

    System must be integrated with BDI for these jobs to perform the data seeding.

  2. Operational Jobs

    These jobs are mostly used to perform back ground operations on the transaction and includes such tasks as generation of a transaction, closing the transaction after a specified date is passed, auto confirmation of the transaction, and so on.

  3. Data Purge Jobs

    These jobs are used to perform the purge operation on the application table. Each job is designed to purge the data from specific functional database tables. The number for day to retain the records in database can be configured separately via System Administration parameters.

The following diagram illustrates the high level architecture of the current batch processing implemented for the EICS Application Server.

Figure 5-9 EICS Application Server Batch Processing Architecture

EICS Application Server Batch Processing Architecture
  • EICS Client - Server Communication

    EICS client provides an option to the retailer to run the batch jobs on demand. This call to the server is made via HTTP REST service call. The batch job selected and the parameter selected by the user are set on the request and sent to the server on this call. The server handles this request and invokes a start job on the batch engine for the respective job.

  • Job Engine

    The job engine manages the state of a running job and guarantees the execution of each step defined for the job. The call made from the client or job scheduler is passed onto the job engine to start a new instance of the batch job. Users also have an option to stop the running job or to restart any particular job which failed during the processing.

  • Job Scheduler

    This feature of EICS allows a retailer to schedule the batch jobs to run at a specific time interval. Each batch job will initially execute at a pre-configured schedule interval. Retailers will have an option to enable or disable specific batch job schedules as well. For more information please refer to Job Scheduler Section below.


    Note:

    A few of the jobs which are system required will not be available for the retailer to change the schedule interval or disable them. These jobs will always be enabled and can be managed only by cloud admin.

Batch Users

The EICS user setup and management are documented in the Oracle Retail Enterprise Inventory Cloud Service User Guide.

The following list shows the batch related users. For additional details, please see the Oracle Retail Enterprise Inventory Cloud Service User Guide.

Table 5-75 Batch Users and Roles

User Roles Description

BDI user

sim_integration_users

The EICS REST service users for inbound BDI REST service connections (for example, BDI importer). BDI user is setup in OID by Cloud Engineer manually.

Batch Administrator

sim_batch_users

The user can access EICS JET application and perform batch administration operations.


Configuration

To access the Job Admin screen, navigate Main Menu/Admin/Configuration/System Administration.

To view the Batch configuration, filter by Batch topic.

Figure 5-10 Batch System Administration Screen

Batch System Administration Screen

Table 5-76 Batch Admin System Configuration Options

Option Description

Batch Maximum Threads

Maximum number of threads to be instantiated for batch execution.

Batch data staging path

Base staging directory for the file processing.

Inventory outbound staging path

Staging directory for the inventory extract file.

Stock count outbound staging path

Staging directory for the U/A Stock Count export file.

POS transaction inbound staging path

Staging directory for the POS transaction import file processing.

Price Change inbound staging path

Staging directory for the Price change import file processing.

Retail sale audit inbound staging path

Staging directory for the Sales audit import file processing.

Stock count inbound staging path

Staging directory for the Third party stock count import file processing.

Store sequence inbound staging path

Staging directory for the Sequencing data import file processing.

Warehouse item stock inbound staging path

Staging directory for the Warehouse inventory import file processing.

Days to Hold Archived and Rejected Files

Number of day to hold the archived and rejected files after being processed.

POS transaction import file path

Incoming directory for POS transaction zip files.

Price change import file path

Incoming directory for Price change zip files.

Retail sale audit import file path

Incoming directory for Sales audit zip files.

Third party stock import file path

Incoming directory for Third party stock count zip files.

Store sequence import file path

Incoming directory for store sequencing zip files.

Warehouse item stock import file path

Incoming directory for warehouse inventory import zip files.

Inventory export file path

Outgoing directory for inventory extract zip files.

Stock count export file path

Outgoing directory for U/A Stock count extract zip files.

Search Limit Default for Batch Job Days

Default number of days search limit to load the job activity.

Batch Scheduler Enabled

Enables/Disables the job scheduler operations.

Maximum Job Instances Per Scheduler Execution

Maximum number of jobs execution per run.

Maximum Processing Hours For Scheduled Job

Maximum time to mark job execution as failed by scheduler.

Stock Count Import Chunk Limit

Chunk limit for stock import records.

Data seed by store

Enables/Disables data seeding per store.

Data seed chunk limit

Chunk limit for records processed in data seeding.

Data seed foundation data

Enables/Disables the foundation data seeding.

Data seed store data

Enables/Disables the store data seeding.

Batch Scheduler Execution Interval

Interval in seconds to run the scheduler instance.



Note:

For batch file related system configuration options, please see File Import/Export section.

Administration

EICS Job Admin is a web application that provides the runtime and GUI for managing batch jobs.

The key features of EICS Job Admin includes:

  • Batch Configuration

  • Batch Job Admin

  • View Batch Activities

  • Batch Security

The following diagrams show the Batch Admin and relevant GUI components:

Figure 5-11 Batch Admin and GUI Components

Batch Admin and GUI Components

Job Admin Screen

This screen view the list of the job that have been instantiated on the server. User can filter the list of the job loaded on screen on Job Status, Reviewed and Search Limit. The default filter will load the list of the failed job when the screen is initially loaded.

User requires appropriate permission to access this screen on EICS. Navigation path for the Job Admin screen is:

Admin/Technical Maintenance/Job Admin

Figure 5-12 Job Admin Screen

Job Admin Screen

Screen Options

  • Search

    Allows user to filter the list of the batch jobs instantiated by user and the scheduler.

  • Refresh

    This option refreshes the list loaded on the screen, calls is made to server to load the list of batch jobs with current state.

  • Ad hoc Job

    This option refreshes the list loaded on the screen, calls is made to server to load the list of batch jobs with current state.

  • Data Seed

    This option navigates user to Data Seed Job Launcher screen. User can start a new data seed job from this screen by setting the required parameters and data seeding options on the job. User will require appropriate access permission to view this option on the screen.

  • Stop Job

    This option allows user to stop a running job. This option is available only when selected job is in running state that is, STARTED and STARTING.

Table Information

  • Execution ID

    This column displays the job execution identifier generated by the job engine.

  • Job Name

    This column displays the name of the batch job.

  • Instance ID

    This column displays the job instance identifier generated by the job engine.

  • Status

    This column displays the current status of the batch job.

  • Start Time

    This column displays the time when job was started.

  • End Time

    This column display the time when job was completed. If the job is currently in running state the end time will not be available.

  • User

    This column displays the user name of the user who started the job. The job started by the scheduler will have server user name in this column.

  • Reviewed

    This column denote if user has review this job.

  • Parameter

    This column displays the parameter if entered while starting the batch job.

Job Execution Log Screen

This screen display the execution details for the batch job. Users can navigate to this screen by clicking Job Execution ID on the Job Admin screen. This screen is designed to view the error logs for the batch jobs and to mark the job as reviewed.

Review flag denotes the selected job has been reviewed by the user. By this user can keep a track which of the failed job are already been review and take necessary actions as required.

The execution detail table load the entries of the execution record if exist for the select batch job.

Figure 5-13 Job Execution Screen

Job Execution Screen

Screen Options

  • Mark Review

    This option allows user to mark the batch job as review. Once the job is marked as review user is navigated back to the Job Admin screen.

  • Cancel

    This option allows user to navigate back to the Job Admin screen.

Table Information

  • Detail ID

    This column displays the execution identifier generated by the job engine.

  • Processed

    This column denotes if the execution record for the job was successfully processed.

  • Failed

    This column denotes if the execution records was failed during the processing.

  • Message

    This columns displays the message from the server to viewing the further details on the job status. This column will be empty for the execution records which are been successfully processed.

  • Data File

    This column displays the file name for which the execution record was created. This column holds data only if the job details with file import processing for example, Retail Sales Audit Import Job.

  • Additional Info

    This column hold the addition info if any for the execution record.

Message Details

This section in non-editable and displays the detailed explanation for the job failure. This section will display respective data on selection job execution record. The log traces of the exact point of failure shall be printed on this section of the screen.

Job Launch Screen

This screen allow user to start a new instance for a job. Select the batch job and enter the parameter, if required, to start job.

The job launcher screen has the following categories:

Ad hoc Job

This screen allows user to run an ad hoc job. All the job which are either operational or purge job can be started from this screen. All the batch job will not support the execution date and store identifier parameters. The job for which store level processing can be performed will consider these parameter. User will not receive an error or confirmation if the parameters are not valid for the selected job.

User will required appropriate data permissions to select and run a particular job. Navigation to this screen is as follows:

Admin/Technical Maintenance/Job Admin /Ad hoc Job

Figure 5-14 Ad hoc Job Screen

Ad hoc Job Screen

Screen Options

  • Start Job

    This option allows user to start a new instance of the selected job. When the user select this option a call is made to server to start a selected batch job. Server internally makes a call to Batch Operator specifying the Job Name and the parameter if any.

  • Cancel

    This option navigates user back to Job Admin Screen.

Menu Options

  • Job Name

    Allows user to select the job to be started. This is a required field on this screen. The user will be able to view only those jobs in the drop down list which are permitted to the user via data permissions.

  • Store ID

    Allow user to enter the store identifier if the job is expected to be executed for specific store. Not all job accepts store identifier as parameter. For the jobs which doesn't take store identifier as parameter for execution shall ignore this parameter.

  • Execution Date

    Allows user to enter the execution date for the job, if not entered the job will consider the current date for the execution. Not all job accepts execution date as parameter. For the jobs which doesn't take execution date as parameter for execution shall ignore this parameter.

  • Data Set Id

    The Data Set Id is optional parameter for importer job to process the specified data set from bulk data interface table.

Data Seed Importer Job

This screen allows user to start data seeding importer specific jobs only. For additional details, please refer to Data Seeding.

User will need appropriate access privileges to navigate to this screen.

Navigation to this screen is as follows:

Admin /Technical Maintenance/Job Admin/Data Seed

Figure 5-15 Data Seed Screen

Data Seed Screen

Screen Options

  • Start Job

    This option allows user to start a new instance of the selected job. When the user select this option a call is made to server to start a selected batch job. Server internally makes a call to Batch Operator specifying the Job Name and the parameter if any.

  • Cancel

    This option navigates user back to Job Admin screen.

Menu Options

  • Job Name

    Allows user to select the job to be started. This is a required field on this screen. The user will be able to view only those jobs in the drop down list which are permitted to the user via data permissions.

  • Seed Option

    User can select one of the option available as per the operation to be performed. The seed options are more over job specific and are not applicable for all job. If the invalid seed option is selected for the job, server will ignore it and perform a normal seed operation.

    The options available are:

    1. Seed: Seeds the data from BDI integration tables to the application tables.

    2. Delete and Seed: Deletes the data from the application tables and reseed the available data in BDI integration tables.

    3. Delete Seeded: Deletes the data from the application tables.

    4. Delete In: Deletes the data from BDI integration tables.

    5. Disable Constraint: Disable the constraints for all the application tables.

    6. Enable Constraint: Enable the constraint for the application tables.

    For example, if user selects Disable Constraint Option for Store Job, this won't disable the constraint for store table. The server will simply ignore the seed option and continue this as not seed operation.

  • Store ID

    Allows user to perform store level data seeding. The store identifier is not applicable for all the job. For the job which does not support store level data processing for example, Item Header or Supplier will simply ignore the store identifier if entered.

  • Data Set Id

    The Data Set Id is optional parameter for importer job to process the specified data set from bulk data interface table.

Start an Ad hoc Job
  1. Login to EICS and navigate to Job Admin screen.

  2. Click on Ad hoc Job Menu to navigate to Ad hoc Job screen

  3. Select the required Job from the drop down menu.

  4. Set the required job parameter for the job, that is, Store ID and/or Execution Date.


    Note:

    Job Parameter doesn't apply to all available batch jobs, for the job which do not take any parameter input will simply ignore the value in case entered.

    Some of batch jobs belongs BDI TX (Transaction) category, see Appendix C, BDI Transaction (TX) Importer Jobs section for details.


  5. Click on Start Job to start the new instance of job.

  6. The new execution record will be populated on the Job Admin Screen List.

View Details for Job
  1. Login to EICS and navigate to Job Admin Screen.

  2. Click the Job Execution Id to navigate to details.

  3. To navigate back to Job Admin screen, click Cancel.

  4. To mark job execution reviewed, click Mark Reviewed.

Start a Data Seed Job
  1. Login to EICS and navigate to Job Admin Screen.

  2. Click on Data Seed Menu to navigate to Data Seed Screen.

  3. Select the required job populated in the drop down menu.

  4. Select required Seed Option from drop down.

  5. Enter Store ID if required.


    Note:

    Store ID is not supported by all job, will be applicable only for jobs which processed store level data

Stop a Running Job
  1. Login to EICS and navigate to Job Admin Screen.

  2. Select the job which is currently in running state that is, STARTED or STARTING.

  3. Click on Stop Job to stop the execution of the running job.

  4. Prompted to confirm if the job needs to be stopped. Click Yes to continue.

  5. Request is sent to job engine to stop the instance of the job. In case the job is already completed or stopped appropriate message shall be displayed to user.

  6. Refresh the list on the screen to view the changes.

Job Scheduler

EICS Job Scheduler allows user to schedule the job available to run under Ad hoc Job screen.

The key features of Job Scheduler are as follows:

  • Interval Based Schedule

    User can schedule the job to run on interval basis. User will be provided below specified interval to be set for each job for execution.

    Table 5-77 Interval Based Schedule

    Interval Detail Execution Hour

    30th Minute

    Job execution will be every 30th minute of the hour starting from 01:00.

    01:00, 01:30, 02:00, 02:30, 03:00, 03:00 … 23:00, 23:30, 00:00, 00:30.

    1 Hour

    Job execution will be every 1 hour starting from 01:00.

    01:00, 02:00, 03:00, 04:00, 05:00 … 22:00, 23:00, 00:00.

    2 Hours

    Job execution will be every 2nd hour of the day starting from 01:00.

    01:00, 03:00, 05:00, 07:00, 09:00 … 21:00, 23:00.

    3 Hours

    Job execution will be every 3rd hour of the day starting from 01:00.

    01:00, 04:00, 07:00, 10:00, 13:00, 16:00, 19:00, 22:00.

    4 Hours

    Job execution will be every 4th hour of the day starting from 01:00.

    01:00, 05:00, 09:00, 13:00, 17:00, 21:00.

    6 Hours

    Job execution will be every 6th hour of the day starting from 01:00.

    01:00, 07:00, 13:00, 19:00.

    8 Hours

    Job execution will be every 8th hour of the day starting from 01:00.

    01:00, 09:00, 17:00.

    12 Hours

    Job execution will be every 12th hour of the day starting from 01:00.

    01:00, 13:00.

    24 Hours

    Job execution will be every 24th hour of the day starting from 01:00.

    01:00.


  • Schedule Management

    User will have an option enabling or disabling the scheduler feature for a job at any given point of time. Once disabled the auto execution on the future scheduled interval will be stopped.

  • Scheduler Configuration

    User will have option of configuring the scheduler related configuration.

Job Scheduler Screen

This screen allows user to manage the schedules for the batch jobs. The list of job available to be scheduled will be sort by the enabled flag followed by Job Name alphabetically that is, the jobs for which the scheduling is enable will be on the top of the list sorted by the Job Names in alphabetical order.

User can edit the batch job and perform following operations:

  1. Enable / Disable a schedule.

  2. Setting the execution interval for a batch job.

User will require appropriate authorization to access this screen. Retailer will not be able to view or disable the batch jobs which are system required. This batch jobs will be accessible to Cloud Admin user will have a predefined schedule. Navigation to this screen is as follows: Admin/Technical Maintenance/Job Scheduler

Figure 5-16 Job Scheduler Screen

Job Scheduler Screen

Screen Options

  • Save

    This option allows user to save the changes made to the job schedules. User can make changes to multiple schedule in edit mode and apply the changes, however the changes will take affect only when the save operation is performed.

  • Refresh

    This option refreshes the list of values on the screen.

  • Edit

    This option will be enable only when a schedule is selected to be edited and user have privileges to edit the job schedule. This option takes user to the edit mode in which user can change the execution interval for the job and enable or disable the schedule.

  • Apply

    This option will only apply the changes which are been made during edit mode. This option does not save the changes, it only apply the changes for the job and exit the edit mode. Click the Save option to save the changes.

  • Cancel

    This option is enabled only when user is in edit mode. This option allows user to discard any changes made to the schedule on edit mode or to exit the edit mode.

Menu Options

  • Interval

    User have option to select the appropriate interval for the batch job execution. Depending on the selected interval, server calculates the execution time for the batch job and runs it according. The base time for calculating the execution time on basis of the interval is 01:00 AM. For the store based job this is as per the store time zone and for system jobs this is as per the server time zone.

    Option for selecting the execution interval are as follows:

    1. 30 Minutes - Runs every 30 minutes.

    2. 1 Hour - Runs every hour.

    3. 2 Hours - Runs every second hour of the day.

    4. 3 Hours - Runs every third hour of the day.

    5. 4 Hours - Runs every fourth hour of the day.

    6. 6 Hours - Runs every sixth hour of the day.

    7. 8 Hours - Runs every eight hour of the day.

    8. 12 Hours - Expected to be executed twice a day.

    9. 24 Hours - Expected to be executed only once a day.

  • Enabled

Table Information

  • Job Name

    This column displays the name of the job.

  • Enabled

    This column denotes whether a job is current scheduled.

  • Interval

    This column denotes the interval of the job execution.

  • Execution Time

    This column denote the next execution time for the batch job. This column will not contain data for the jobs which are been disabled.

Configuring a Job Schedule
  1. Login in EICS and navigate to the Job Scheduler screen.

  2. Select the desired job from the list.


    Note:

    If the Edit option is not available in the menu section, the user is not authorized to edit the batch job. Kindly assign appropriate user group or contact system admin for desired changes.

    Some of batch jobs belongs BDI TX (Transaction) category, see Appendix C, BDI Transaction (TX) Importer Jobs section for details.


  3. Edit the Job details on right panel.

  4. Set required interval for execution and Enabled to Yes.

  5. Click Apply to exit the edit mode.

  6. For configuring multiple jobs on a go, repeat Step 2 for each job.

  7. Click Save to save the current changes made on the screen.

Disabling a Job Schedule
  1. Login in EICS and navigate to Job Scheduler screen.

  2. Select the job from the list which needs to be disabled.

  3. Edit the Job details on right panel.

  4. Set Enabled as No.

  5. Click Apply to exit the edit mode.

  6. For disabling multiple jobs on a go, repeat Step 2 for each job.

  7. Click Save to save the current changes made on the screen.