5 Batches
This section information describes the following topics:
Overview
The batch processes are designed to process large volume of data.
These jobs are mostly used to perform background 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.
Please see the Cleanup Batches section for details on clean up batches.
Batch Admin Users
The following list shows the batch related users. For additional details, please see the Oracle Retail Enterprise Inventory Cloud Service User Guide.
Table 5-1 Batch Users and Roles
Job Duties | SIOCS Application Role | IDCS or OCI IAM Application Role |
---|---|---|
Manage Batch System Configuration |
ADMINISTRATOR |
admin_users |
Access SIOCS Job Admin UI |
ADMINISTRATOR |
admin_users |
Manage SIOCS Adhoc Job |
ADMINISTRATOR |
batch_users |
Batch Configuration
To access the System Configuration screen, navigate Main Menu/Admin /Configuration /System Administration. To view the Batch configuration, filter by Batch topic.
Operational Batches
Operational batches are used to perform background 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.
Auto Inventory Adjustment
Auto inventory adjustment is the process through which inventory is reduced/increased over time via automatic inventory adjustments.
This functionality helps retailers to do automatic adjustment either to increment or decrement the available inventory for various reasons like wastage for fresh produce which has a short shelf life.
To maintain more accurate inventory values, EICS auto adjustment functionality provides users the ability to create product group type of Auto Inventory Adjustment. Adjustment percentage or standard UOM amounts can be setup on the product group detail and assigned to individual items and/or the item hierarchy.
A user can schedule the date when the auto adjustment batch process must run and when inventory adjustments are automatically made based upon the reason code and its corresponding disposition, and adjustment quantities setup on the product group.
The batch program fetches the auto inventory adjustment product groups that are scheduled and open to be run for the current date and apply the Auto Adjustment percentage or SUOM amount to each item in the product group.
When setting up a product group, the adjustment SUOM and or adjustment % may be entered.
If a percentage and SUOM exist on the product group, the batch program will apply the least amount of the two.
The batch program considers the reason code attached to the product group and its corresponding disposition to adjust the inventory.
The system supports the following adjustment dispositions that can be attached to the product group.
Out to ATS: the system will increment the available inventory.
ATS to out: the system will decrement the available inventory.
The system adjusts the inventory and creates transaction history records using the adjustment reason attached to the product group. Actual inventory adjustment records do not get created. The adjustments will then be sent over the RIB to the merchandising system.
Batch Job Definition Name
AutoInventoryAdjustment_OpsJob
Batch Job Parameters
<input_date>input_dateinput date parameter is defaulted to current timestamp if not specified. System batch input date format is used for parsing input date if specified.
Key Tables
Table 5-2 Key Tables for Auto Inventory Adjustment
Table | Select | Insert | Update | Delete |
---|---|---|---|---|
inv_adjust_reason |
Yes |
|||
product_group_item |
Yes |
|||
product_group_hierarchy |
Yes |
|||
product_group_sched_store |
Yes |
Yes |
||
product_group_schedule |
Yes |
|||
product_group |
Yes |
|||
store_item |
Yes |
|||
store_item_stock |
Yes |
Yes |
||
store_item_stock_history |
Yes |
Yes |
||
mps_staged_message |
Yes |
Restart/Recovery
This batch can be re-run by starting a new batch job after the issues are resolved.
Auto Replenish Capacity
This job automatically updates the shopfloor to capacity for certain items based on a product group.
Batch Job Definition Name
AutoReplenishCapacity_OpsJob
Batch Job Parameters
<input_date>input_dateinput date parameter is defaulted to current timestamp if not specified. System batch input date format is used for parsing input date if specified.
<store id>
Where store id is store identifier. If store id is not specified, then data for all managed stores will be processed in parallel processing.
Key Tables
Table 5-3 Key Tables for Auto Replenish Capacity Batch
Table | Select | Insert | Update | Delete |
---|---|---|---|---|
config_system |
Yes |
|||
shelf_replenish |
Yes |
Yes |
Yes |
Yes |
shelf_replenish_line_item |
Yes |
Yes |
Yes |
Yes |
Restart/Recovery
This batch can be re-run by starting a new batch job after the issues are resolved.
Auto Ticket Generate
This job automatically generates the item tickets and labels depending on the store parameters for events which are subscribed. The events are price changes, clearance event, promotions, and item description changes.
The batch also generates tickets for future price change events based on Auto Ticket Generate Future Days store parameter value that indicates how many days of future price events are considered to generate the tickets when the price events are coming to SIOCS.
Batch Job Definition Name
TicketAutoGenerateFromEvent_OpsJob
Batch Job Parameters
<input_date>input_dateinput date parameter is defaulted to current timestamp if not specified. System batch input date format is used for parsing input date if specified.
<store id>
Where store id is store identifier. If store id is not specified, then data for all managed stores will be processed in parallel processing.
Key Tables
Table 5-4 Key Tables for Auto Ticket Generate Batch
Table | Select | Insert | Update | Delete |
---|---|---|---|---|
config_system |
Yes |
|||
ticket_event |
Yes |
Yes |
Yes |
|
ticket |
Yes |
Yes |
Yes |
Yes |
ticket_format |
Yes |
Restart/Recovery
This batch can be re-run by starting a new batch job after the issues are resolved.
Auto Ticket Print
This batch sends the tickets generated to the 3rd party printing service. The tickets/labels generated for the items identified in the product group will be automatically sent to the 3rd party printing service.
Batch Job Definition Name
TicketAutoPrint_OpsJob
Batch Job Parameters
<input_date>input_dateinput date parameter is defaulted to current timestamp if not specified. System batch input date format is used for parsing input date if specified.
<store id>
Where store id is store identifier. If store id is not specified, then data for all managed stores will be processed in parallel processing.
Key Tables
Table 5-5 Key Tables for Auto Ticket Print Batch
Table | Select | Insert | Update | Delete |
---|---|---|---|---|
config_system |
Yes |
|||
Store_printer |
Yes |
|||
ticket |
Yes |
Yes |
Yes |
Yes |
ticket_format |
Yes |
Restart/Recovery
This batch can be re-run by starting a new batch job after the issues are resolved.
Clearance File Import
This batch imports the RPCS (Retail Pricing Cloud Service) clearance records via the flat file. The batch processes the records for items ranged in stores (regardless managed or non-managed stores). If the record type is delete, the matching record in the database will be deleted. For a record type of insert/replace/update, the import is UPSERT. If the record does not exist in the database, it will be inserted; if the data already exists in the database, it will be updated.
The price records merge/upsert the data from the staging tables into the application master table ITEM_PRICE on the combination of store/item/pricetype/ ext_price_event_id.
On processing the clearance reset record (reset indicator is 1), all active clearances for that store/item which does not have an end date, that end date will be set to the clearance reset effective date.
File Handling Details
-
File provider application uploads the relevant data files to the import’s location in Object Storage via FTS. See Upload Import Data Files to Object Storage for details.
Note:
For files from Retail Pricing Cloud Service (RPCS) in legacy cloud services, RPCS price transactions will be sent via BDI File Creator Process flow from RPCS (legacy cloud services) to SIOCS Next Gen Cloud Services object storage import’s location.
-
The Import Batch job will download the relevant data files from Object Storage, parse the files and insert the data into staging tables, merge/upsert the data from staging tables into SIOCS master tables, and upload any failed files/ records to the rejects folder to Object Storage.
-
On completion, the data files are moved to archive file locations and will be purged after configured days.
-
On failures, the failed records are written to reject files, and the reject files are sent to object storage reject’s location. The error will be visible in by drilling down from the Job Admin screen on the failed job execution to display the batch detail. Drill down on the failed batch details to see the error message.
-
To re-run the corrected data files, repeat step 1 and 2.
File Layout
See Appendix: Batch File Layout Specifications for details.
Batch Job Definition Name
ClearanceFileImport_OpsJob
Batch Job Parameters
N/A
Key Tables
Table 5-6 Key Tables for Clearance File Import
Tables | Select | Insert | Update | Delete |
---|---|---|---|---|
Item_price |
Yes |
Yes |
Yes |
Yes |
ICL_CLEARANCE |
Yes |
Yes |
Yes |
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
<input_date>
Where input date parameter is defaulted to current timestamp if not specified. System batch input date format is used for parsing input date if specified.
<store id> Where store id is store identifier. If store id is not specified, then data for all managed stores will be processed in parallel processing.
Key Tables
Table 5-7 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 Unit Amount 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
<input_date>Where input date parameter is defaulted to current timestamp if not specified. System batch input date format is used for parsing input date if specified.
<store id>
Where store id is store identifier. If store id is not specified, then data for all managed stores will be processed in parallel processing.
Key Tables
Table 5-8 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
<input_date>
Where input date parameter is defaulted to current timestamp if not specified. System batch input date format is used for parsing input date if specified.
<store id> Where store id is store identifier. If store id is not specified, then data for all managed stores will be processed in parallel processing.
Key Tables
Table 5-9 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 |
Initial Foundation Data File Import
This batch imports initial foundation seed data files from external system. See Standalone Data Seeding in the Batches chapter for details.
Batch Job Definition Name
StandaloneIdlFileImport_OpsJob
Batch Job Parameters
N/A
Restart/Recovery
This batch can be re-run by starting a new batch job after the issues are resolved.
Initial Inventory Import
The Initial Inventory Import batch is used to wipe out the existing SOH data for items in a store and override it with the new SOH data from the third-party/non-Oracle/legacy systems.
This batch is meant to be used ONLY during implementation. It is designed for optimal upload to rewrite SOH.
It should not be used after the one-time inventory upload.
Note:
UINs must be uploaded only once. Unlike stock on hand, UINs are state driven and control the stock on hand. Only new UINs in the flat file will be considered for stock on hand update. As such, if UINs already exist, they will not reflect into the new SOH.
Batch Job Definition Name
InitialInventoryImport_OpsJob
Batch Job Parameters
N/A
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-10 Key Tables for Initial Inventory Import Batch
Table | Select | Insert | Update | Delete |
---|---|---|---|---|
store_item_stock |
Yes |
Yes |
||
item_uin |
Yes |
Yes |
Yes |
Initial Store Data File Import
This batch imports initial store seed data files from external system. See Standalone Data Seeding in the Batches chapter for details.
Batch Job Definition Name
StandaloneIdlStoreFileImport_OpsJob
Batch Job Parameters
<store id> Where store id is store identifier.
Restart/Recovery
This batch can be re-run by starting a new batch job after the issues are resolved.
Inventory Extract Export
This batch extracts the inventory to a file that has been altered on or after the specified date for the specified store and uploads the file to FTS. The type of upload files is based on system parameter configuration value Compress inventory extract files into zip file.The system supports only exporting inventory records for managed stores that support OMNI channel orders.
File Layout
See Inventory Extract Export File Specification.
Batch Job Definition Name
InventoryExtract_OpsJob
Batch Job Parameters
<input_date>
input_dateinput date parameter is defaulted to current timestamp if not specified. System batch input date format is used for parsing input date if specified.
<store id>
Where store id is store identifier. If store id is not specified, then data for all managed stores will be processed in parallel processing.
Key Tables
Table 5-11 Key Tables for Inventory Extract Batch
Table | Select | Insert | Update | Delete |
---|---|---|---|---|
STOCK_ITEM_V |
Yes |
Item Basket Maintenance
This batch updates the item basket status cancelled when the item basket has expired.
Batch Job Definition Name
ItemBasketMaintenance_OpsJob
Batch Job Parameters
<input_date>Where input_date is defaulted to current timestamp if not specified. It is used for comparing if a record date is a configured number of days prior to the input date. System batch input date format is used for parsing input date if specified.
Key Tables
Table 5-12 Key Tables for Item Basket Maintenance Batch
Table | Select | Insert | Update | Delete |
---|---|---|---|---|
config_system |
Yes |
|||
Item_basket |
Yes |
Yes |
Restart/Recovery
This batch can be re-run by starting a new batch job after the issues are resolved.
Item Price ICL Import Batch
This batch program searches the integration pricing event log records from the sourcing system and stage the price change and clearance change log records into SIOCS Integration Change Log Staging tables. The staged change log records will be processed by MPS Worker (DcsPrice) to import staging data into application tables.
Batch Job Definition Name
ItemPriceIclImport_OpsJob
Batch Job Parameters
N/A
Key Tables
Table 5-13 Key Table for Item Price ICL Import Batch
Table | Select | Insert | Update | Delete |
---|---|---|---|---|
ICLS_PRICE_CHANGE |
Yes |
Yes |
Yes |
|
ICLS_CLEARANCE |
Yes |
Yes |
Yes |
|
ITEM_PRICE |
Yes |
Yes |
Yes |
Yes |
Restart/Recovery
This batch can be re-run by starting a new batch job after the issues are resolved.
POS Transaction Import
This batch imports POS transaction records from the flat file (SIMT-LOG file) that came from Pont of Sale System.
The batch process takes the sales/order transaction data and stages them to the database staging table (POS_TRANSACTION) from where they are picked up by the MPS worker 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.
The customer can set the job scheduler to be run multiple times per day by changing the schedule intervals.
File Handling Details
-
File provider application uploads the relevant data files to the import’s location in Object Storage via FTS. See: Upload Import Data Files to Object Storage for details.
-
The Import Batch job will download the relevant data files from Object Storage, parse the files and insert the data into POS_TRANSACTION staging tables, to the rejects folder to Object Storage. If validation errors occurred during loading process, e.g invalid store, or duplicate the extended transaction id exists in POS_TRANSACTION table, then the entire file will be rejected.
-
On completion, the data files are moved to archive file locations and will be purged after configured days.
-
On failures, the reject files are sent to object storage reject’s location. The error will be visible in by drilling down from the Job Admin screen on the failed job execution to display the batch detail. Drill down on the failed batch details to see the error message.
-
To re-run the corrected data files, repeat step 1 and 2.
File Specification
File Name format: SIMTLOG _<date in YYYYMMDDHH24MISS format>_>loc id>.dat (where loc id is the store identifier)’
File Layout: See: POS Sale Transaction Import File Specification.
Batch Job Definition Name
PosTransactionImport_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 loading file to staging table fail. 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 re-upload the data file after resolving any errors for processing.
Key Tables
Table 5-14 Key Tables for POS Transaction Import Batch
Table |
Select |
Insert |
Update |
Delete |
pos_transaction |
Yes |
Yes |
||
item |
Yes |
|||
inv_adjust_reason |
Yes |
Price Change File Import
This batch imports the regular price change records via flat files for hybrid pricing integration between price changes on legacy cloud services and SIOCS Next Gen Cloud Services.
The batch processes the records for items ranged in stores (regardless managed or non-managed stores). If the record type is delete, the matching record in the database will be deleted. For a record type of insert/replace/update, the import is UPSERT. If the record does not exist in the database, it will be inserted; if the data already exists in the database, it will be updated.
File Handling Details
-
File provider application uploads the relevant data files to the import’s location in Object Storage via FTS. See Upload Import Data Files to Object Storage for details.
Note:
For files from Retail Pricing Cloud Service (RPCS) in legacy cloud services, RPCS price transactions will be sent via BDI File Creator Process flow from RPCS (legacy cloud services) to SIOCS Next Gen Cloud Services object storage imports location.
-
The Import Batch job will download the relevant data files from Object Storage, parse the files and insert the data into staging tables, merge/upsert the data from staging tables into SIOCS master tables, and upload any failed files/ records to the reject’s folder to Object Storage.
-
On completion, the data files are moved to archive file locations and will be purged after configured days.
-
On failures, the failed records are written to reject files, and the reject files are sent to object storage rejects location. The error will be visible by drilling down from the Job Admin screen on the failed job execution to display the batch detail. Drill down on the failed batch details to see the error message.
-
To re-run the corrected data files, repeat step 1 and 2.
File Layout
See Appendix: Batch File Layout Specifications for details.
Batch Job Definition Name
PriceChangeFileImport_OpsJob
Batch Job Parameters
N/A
Key Tables
Table 5-15 Key Tables for Price Change File Import
Tables | Select | Insert | Update | Delete |
---|---|---|---|---|
item_price |
Yes |
Yes |
Yes |
Yes |
ICL_PRICE_CHANGE |
Yes |
Yes |
Yes |
Yes |
Retail Sale Audit Import Batch
This batch program imports sales/order transaction data (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, SIOCS learns about inventory movement (that is, what is sold, what is returned, what is reserved and what is fulfilled). Once SIOCS attains the data, SIOCS assumes that sales should be taken from the store's shelf-related inventory buckets. This assumption is important to SIOCS's shelf replenishment processing. SIOCS 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 SIOCS 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 SIOCS. 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.
Each job run will pick number of files (defined by Maximum Job Instances Per Batch) in system configuration and process them in multi-threads. The number of files to be processed is default to 20, the value can be configured via system configuration screen.
Customer can set the job scheduler to be run multiple times per day by changing the schedule intervals.
File Specification
File Name format: SIMT_<date in YYYYMMDDHH24MISS format>_<loc id>
Where <loc id> is store id.
File Layout: See Retail Sale Audit Import File Specification.
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-16 Key Tables for Retail Sale Audit Import Batch
Tables | Select | Insert | Update | Delete |
---|---|---|---|---|
pos_transaction |
Yes |
|||
inv_adjust_reason |
Yes |
Shelf Replenishment Closure
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
input_date>input_dateinput date parameter is defaulted to current timestamp if not specified. System batch input date format is used for parsing input date if specified.
Key Tables
Table 5-17 Key Tables for Cleanup Shelf Replenishment Batch
Table | Select | Insert | Update | Delete |
---|---|---|---|---|
shelf_replenish |
Yes |
|||
stock_item_stock |
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
<input_date>Where input date parameter is defaulted to current timestamp if not specified. System batch input date format is used for parsing input date if specified.
Key Tables
Table 5-18 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 Auto Cancel
This batch finds the stock counts which are not completed or un-executed based on the “Days To Hold Before Auto Canceling Stock Counts”, updates the stock count status as canceled (status = 20), for those stock count in progress and not completed, the open stock counts field in store item stock table will be decremented.
For unit amount stock count, the canceled stock count schedule id/store will be published via MPS Staged Messages (Message Family: StkCountSch, MessageType: StkCountSchDtlDel).
It is recommended to run this batch prior running the “Cleanup Stock Counts” batch.
Batch Job Definition Name
StockCountCancel_OpsJob
Batch Job Parameters
<input_date>
Where input_date is the date parameter to be used to find the matching records, if not specified, it is defaulted to current system timestamp. System batch input date format is used for parsing input date if specified.
Key Tables
Table 5-19 Key Tables for Stock Count Auto Cancel
Table |
Select |
Insert |
Update |
Delete |
STOCK_COUNT |
Yes |
Yes |
||
STORE_ITEM_STOCK |
Yes |
Yes |
||
STOCK_COUNT_CANCEL |
Yes |
Yes |
Yes |
Yes |
Restart/Recovery
This batch can be re-run by starting a new batch job after the issues are resolved.
Stock Count Export
This batch process looks for a stock count that is stuck in approval authorized state during authorizing a unit amount stock count process. This is a unique state that appears when an error occurs during the final processing of a unit amount stock count. The batch attempts to generate stock count export file and set stock count status to authorize complete state. Errors that occur during the batch process are logged to the server error logs and will indicate the reason for any further processing failures.
File Layout
See Appendix: Batch File Layout Specifications for details.
Batch Job Definition Name
StockCountExport_OpsJob
Batch Job Parameters
<stock_count_id>
Where the stock_count_id is the stock count identifier
Key Tables
Table 5-20 Key Tables for Stock Count Export Batch
Table | 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 |
|||
stock_count_export |
Yes |
Yes |
Yes |
Stock Count Unit and Amount Snapshot
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> Where store id is store identifier. If store id is not specified, then data for all managed stores will be processed in parallel processing.
Key Tables
Table 5-21 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 |
Store Order Auto Approve
This batch processes looks for store orders which requested date is X hours of old than the number of hours after create date in SIOCS to approve store orders.
Batch Job Definition Name
StoreOrderAutoApprove_OpsJob
Batch Job Parameters
N/A
Key Tables
Table 5-22 Key Tables for Store Order Auto Approve Batch
Table | Select | Insert | Update | Delete |
---|---|---|---|---|
store_order |
Yes |
Yes |
||
store_order_line_item |
Yes |
Yes |
Store Order Auto Cancel
This batch processes looks for store orders which requested date is X days of old than the system defined Days to hold before Auto Canceling Store Orders, and the process attempts to set those store orders to cancel state when applicable.
Batch Job Definition Name
StoreOrderAutoCancel_OpsJob
Batch Job Parameters
N/A
Key Tables
Table 5-23 Key Tables for Store Order Auto Cancel Batch
Table | Select | Insert | Update | Delete |
---|---|---|---|---|
store_order |
Yes |
Yes |
||
store_order_line_item |
Yes |
Yes |
Store Order Auto Generate
This batch processes generate store order records for store order product group schedules.
Batch Job Definition Name
StoreOrderAutoGenerate_OpsJob
Batch Job Parameters
N/A
Key Tables
Table 5-24 Key Tables for Store Order Auto Generate Batch
Table | Select | Insert | Update | Delete |
---|---|---|---|---|
store_order |
Yes |
Yes |
Yes |
|
store_order_line_item |
Yes |
Yes |
Yes |
|
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 |
Store Sequence Import
This batch imports store sequencing information from a flat file via the File Transfer Service (FTS). Each job run will pick number of files (defined by Maximum Job Instances Per Batch) in system configuration and process them in multi-threads. The number of files to be processed is default to 20, the value can be configured via system configuration screen.
The action of the import depends on the optional DELETEALL value in the header record. If DELETEALL is present, the existing records for the store are deleted from the store_sequence_area and store_sequence_item tables. The contents of the import are inserted into the database after the deletion. If DELETEALL is not present, the contents of the import file are merged into the existing data and inserted for new data.
The import validates the store and item ids during the processing. The import will fail if both the specified store and item are not in the store and item table.
Customer can set the job scheduler to be run multiple times per day by changing the schedule intervals.
File Layout
See Appendix: Batch File Layout Specifications for details.
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. The error will be visible in by drilling down from the Job Admin screen on the failed job execution to display the batch detail. Drill down on the failed batch details to see the error message.
Key Tables
Table 5-25 Key Tables for Store Sequence Import Batch
Tables | Select | Insert | Update | Delete |
---|---|---|---|---|
store_sequence_area |
Yes |
Yes |
Yes |
Yes |
store_sequence_item |
Yes |
Yes |
Yes |
Yes |
Third Party Price Import Batch
This batch imports pricing data (regular price, clearance, and promotion prices) from a third party uploaded pricing data files into SIOCS.
The price records merge/upsert the data from staging tables into the application master table ITEM_PRICE on the combination of store/item/pricetype/ ext_price_event_id.
File Handling Details
-
File provider application uploads the relevant data files to the import’s location in Object Storage via FTS. See Upload Import Data Files to Object Storage for details.
-
The Import Batch job will download the relevant data files from Object Storage, parse the files and insert the data into staging tables, merge/upsert the data from staging tables into SIOCS master tables, and upload any failed files/ records to the rejects folder to Object Storage.
-
On completion, the data files are moved to archive file locations and will be purged after configured days.
-
On failures, the failed records are written to reject files, and the reject files are sent to object storage reject’s location. The error will be visible in by drilling down from the Job Admin screen on the failed job execution to display the batch detail. Drill down on the failed batch details to see the error message.
-
To re-run the corrected data files, repeat step 1 and 2.
File Layout
See Appendix: Batch File Layout Specifications for details.
Batch Job Definition Name
ExtPriceImport_OpsJob
Batch Job Parameters
N/A
Key Tables
Table 5-26 Key Tables for Third Party Price Import Batch
Table | Select | Insert | Update | Delete |
---|---|---|---|---|
item_price |
Yes |
Yes |
Yes |
Yes |
Third Party RFID File Import Batch
This batch process imports bulk amount of RFID information from batch files which are uploaded by customers.
The RFID importer first sets the present attribute to 'N' for all existing RFID tags at the location thereby removing them from inventory. It then set the present attribute to 'Y' (yes) for each RFID tag in the import.
CREATE and DELETE are the only two valid actions for RFID, CREATE indicates "present in store" and DELETE indicates "absent from store", the only states an EPC has.
If an EPC in the data file has DELETE type, and exists in database, the process marks the EPC as not present.
If an EPC in the data file has CREATE type, the process inserts or updates in RFID table and mark as present.
Each file contains RFID information for a single store, store/item/action date uniquely identify a RFID record.
File Handling Details
-
Customer uploads the relevant data files to the imports folder in Object Storage via FTS. See Upload Import Data Files to Object Storage for details.
-
The Import Batch job will download the relevant data files from Object Storage, parse the files and insert the data into staging tables, merge/upsert the data from staging tables into SIOCS master tables, upload any failed files/ records to the rejects folder to Object Storage.
-
On completion, the data files are moved to archive file locations and will be purged after configured days.
-
File Error Handling. The import process writes the erroneous records into reject files and uploads to the rejects folder to Object Storage. The error will be visible in by drilling down from the Job Admin screen on the failed job execution to display the batch detail. Drill down on the failed batch details to see the error message.
-
After errors are resolved, to process the corrected data file, repeat steps 1 to 2.
File Layout
See Appendix: Batch File Layout Specifications for details.
Batch Job Definition Name
ExtRfidImport_OpsJob
Batch Job Parameters
N/A
Key Tables
Table 5-27 Key Tables for Third Party RFID File Import Batch
Table | Select | Insert | Update | Delete |
---|---|---|---|---|
RFID |
Yes |
Yes |
Yes |
|
RFID_HISTORY |
Yes |
Yes |
Yes |
|
RFID_ZONE |
Yes |
|||
DLS_RFID |
Yes |
Yes |
Yes |
Yes |
Third Party Stock Count Import
This batch imports the stock count quantities when a stock count is setup in SIOCS, and physical counting is conducted by a third party. The batch updates the stock count counted or recounted quantities. Invalid records during the import are saved in the rejected item table.
When the stock count is set up as Auto-authorize Unit and Amount Stock Count, the rejected items are processed, and attempts are resolution are taken (such as ranging items and adding them to the stock count). In addition, the authorization process occurs and the stock on hand quantities for the items are updated. In addition, a Unit and Amount Stock Counts Export file is generated because of stock count auto authorization.
Each job run will pick number of files (defined by Maximum Job Instances Per Batch) in system configuration and process them in multi-threads. The number of files to be processed is default to 20. The value can be configured via system configuration screen.
Customer can set the job scheduler to be run multiple times per day by changing the schedule intervals.
File Layout
See Appendix: Batch File Layout Specifications for details.
Batch Job Definition Name
ThirdPartyStockCountImport_OpsJob
Batch Job Parameters
N/A
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-28 Key Tables for Third Party Stock Count Import Batch
Table | 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 Available Inventory Import
This batch imports warehouse available inventory from a CSV file. The batch updates the warehouse item available quantity. This is calculated by subtracting transfer reserved qty, customer reserved qty, non-sellable inventory and RTV from stock on hand. Available inventory is in the standard unit of measure.
File Handling Details
-
Customer uploads the relevant data files to the imports folder in Object Storage via FTS. See Upload Import Data Files to Object Storage for details.
-
The Import Batch job will download the relevant data files from Object Storage, parse the files and insert the data into staging tables, merge/upsert the data from staging tables into SIOCS master tables, upload any failed files/ records to the rejects folder to Object Storage.
-
On completion, the data files are moved to archive file locations and will be purged after 7 days.
-
File Error Handling. The import process writes the erroneous records into reject files and uploads to the rejects folder to Object Storage. The error will be visible in by drilling down from the Job Admin screen on the failed job execution to display the batch detail. Drill down on the failed batch details to see the error message.
-
After errors are resolved, to process the corrected data file, repeat steps 1 to 2.
File Layout
See Appendix: Batch File Layout Specifications for details.
Batch Job Definition Name
WarehouseAvailInvFileImport_OpsJob
Batch Job Parameters
N/A
Key Tables
Table 5-29 Key Tables for Warehouse Available Inventory Import
Tables | Select | Insert | Update | Delete |
---|---|---|---|---|
WAREHOUSE_ITEM |
Yes |
Yes |
Yes |
|
DLS_WAREHOUSE_ITEM |
Yes |
Yes |
Yes |
Cleanup Batches
Removal of temporary, staged, non-essential data is critical for smooth running of business. If this data is not purged at frequent interval, then these tables can grow to such an extent that normal business operations would get impacted; backup and disaster recovery will take enormous amount of time. Since purge process locks database records, cleanup/purge must be done at short intervals.
Some of these clean-up jobs are restricted and enabled by default.
Customers can configure number for day to retain the records in database via System Admin Parameters.
Table 5-30 Cleanup Batches
Batch Name | Description | Default | Minimum Value | Maximum Value |
---|---|---|---|---|
Cleanup Activity Locks |
Deletes activity lock records from ACTIVITY_LOCK table. Any lock record with a lock date/timestamp older than Days to Hold Locking Records system configuration value will be deleted |
1 hour |
30 minutes |
24 hours |
Cleanup Adhoc Stock Count |
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. |
24 hours |
30 minutes |
24 hours |
Cleanup Activity History |
Deletes activity history records from ACTIVITY_HISTORYtable. Record with create date older than Days to Hold Audit Records system configuration value will be deleted. |
24 hours |
30 minutes |
24 hours |
Cleanup Batch Job Repo |
Deletes batch job repository records from JOBINSTANCEDATA table and associated tables. Records with create time older than Days to Hold Batch Repository Records system configuration value will be deleted. |
24 hours |
30 minutes |
24 hours |
Cleanup Item UIN History |
Deletes Item UIN history records from ITEM UIN HISTORY table. Records with create date older than Days to Hold UIN Audit Information system configuration value will be deleted. |
24 hours |
30 minutes |
24 hours |
Cleanup Recently Edited |
Deletes recently edited security user history records from SECURITY_USER_HISTORY table. Record with update date older than Days to Hold Recently Edited system configuration value will be deleted. |
24 hours |
30 minutes |
24 hours |
Cleanup RFID History |
Deletes RFID history records from RFID_HISTORY table. Records with event date older than Days to Hold RFID History system configuration value will be deleted |
24 hours |
30 minutes |
24 hours |
Cleanup Store Order |
Deletes canceled or approved Store Order records from STORE_ORDER table and associated tables. Records with update date older than Days to Hold Store Orders system configuration value will be deleted |
24 hours |
30 minutes |
24 hours |
Cleanup Tickets |
Deletes ticket records from TICKET table. Records with create date older than Days to Hold Ticket system configuration value will be deleted. |
24 hours |
30 minutes |
24 hours |
Cleanup Ticket Histories |
Deletes ticket history records from TICKET table. Records with printed date older than Days to Hold Ticket history system configuration value will be deleted. |
24 hours |
30 minutes |
24 hours |
Cleanup Batch Activity |
This job deletes the activity records that are no longer needed after the default time specified and if such records have a status different than COMPLETED. |
30 minutes |
30 minutes |
24 hours |
Cleanup Batch Data Error |
Deletes the batch data errors records that are no longer needed after the default time specified. |
30 minutes |
30 minutes |
24 hours |
Cleanup Batch Directories |
Deletes the processed files from batch archive folder and failed files from reject folder of the respective job's directory. |
24 hours |
30 minutes |
24 hours |
Cleanup Batch Log |
Deletes old batch log records. Batch log record with an end date/timestamp older than the Days To Hold Batch Logs 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. Deletes purge error logs. |
24 hours |
30 minutes |
24 hours |
Cleanup Batch Schedule |
Deletes the batch schedule records that are no longer needed after the default time specified. |
30 minutes |
30 minutes |
24 hours |
Cleanup Closed Transfers |
Deletes all the closed transfer which are in either cancelled or completed status, and shipments related to them. Any closed transfer with an update date older than the Days to Hold Transfer Documents parameter value will be deleted. |
24 hours |
30 minutes |
24 hours |
Cleanup Completed UINs |
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. |
24 hours |
30 minutes |
24 hours |
Cleanup Customer Orders |
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. |
24 hours |
30 minutes |
24 hours |
Cleanup DSD and Purchase Orders |
Deletes the Direct Store Delivery receiving. 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. |
24 hours |
30 Minutes |
24 hours |
Cleanup Invalid Users |
Deletes invalid application users from data store for those user names that are not found in identity store. |
12 Hours |
30 Minutes |
24 hours |
Cleanup Invalid User Roles |
Removes all expired user roles and orphaned user roles (roles that were deleted by removing a store) from the SIOCS 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 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. |
24 hours |
30 Minutes |
24 hours |
Cleanup Inventory Adjustments |
Deletes inventory adjustments records with a create date/timestamp older than Days To Hold Completed Inventory Adjustments parameter value. |
24 hours |
30 Minutes |
24 hours |
Cleanup Item Baskets |
Purges item basket records (with status of cancelled or completed) based on the retention period. The retention period is specified by system configuration parameter- Days to Hold Item Basket. |
24 hours |
30 Minutes |
24 hours |
Cleanup Item Hierarchy |
Purges all Item Hierarchies that are in deleted status. |
24 hours |
30 Minutes |
24 hours |
Cleanup Item Prices |
Purges records which were expired or were marked as deleted 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:
|
24 hours |
30 minutes |
24 hours |
Cleanup Items |
This batch program deletes items with a status of Delete (D). There are two segments which do the following different tasks:
If the validations checks are met, the records related to the item which is marked for the purge action are deleted. |
24 hours |
30 minutes |
24 hours |
Cleanup Notifications |
Deletes notifications. The retention period is specified by system configuration parameter Days to Hold Notifications. |
24 hours |
30 minutes |
24 hours |
Cleanup 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. |
24 hours |
30 minutes |
24 hours |
Cleanup Price History |
This batch process deletes price histories. At least a minimum set of historical prices are maintained for an item/store. |
24 hours |
30 minutes |
24 hours |
Cleanup Product Areas |
Deletes the product areas records that are no longer required if the status is CANCELED(3) and the basked id is not into the picks for store fulfillment orders table. Days to Hold Areas will determinate the number of days that product areas can be kept in the database. |
24 hours |
30 minutes |
24 hours |
Cleanup Related Items |
Deletes the related items for which the end date has expired for more than Days To Hold Related Items system configuration value. |
24 hours |
30 minutes |
24 hours |
Cleanup 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. |
24 hours |
30 minutes |
24 hours |
Cleanup RFID |
Deletes RFIDs which is not present in location. The retention period is specified by system configuration parameter Days to Hold RFID. |
24 hours |
30 minutes |
24 hours |
Cleanup 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. |
24 hours |
30 minutes |
24 hours |
Cleanup Shelf Adjustments |
Purges shelf adjustment records (with status of completed) based on the retention period. The retention period is specified by system configuration parameter- Days to Hold Shelf Adjustment List. |
24 Hours |
30 minutes |
24 Hours |
Cleanup Shelf Replenishment |
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. |
24 Hours |
30 minutes |
24 Hours |
Cleanup Staged Messages |
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). |
24 Hours |
30 minutes |
24 Hours |
Cleanup Staged Initial Data Load |
This batch will purge data from all “IDLS” and “ERR_IDLS” tables. This batch is designed to be run as ad-hoc only, therefore a schedule is not available for this batch. |
|||
Cleanup 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. |
24 Hours |
30 minutes |
24 Hours |
Cleanup Store Item Stock History |
Deletes store item stock history records from STORE_ITEM_STOCK_HISTORY table. Records with printed date older than Days to Hold Transaction History system configuration value will be deleted. |
24 Hours |
||
Cleanup Temporary UINs |
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). |
24 Hours |
30 minutes |
24 Hours |
Cleanup 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. |
24 Hours |
30 minutes |
24 Hours |
Cleanup Closed Warehouse Containers |
This batch job deletes fully received warehouse to store deliveries (a fully received delivery is one where all cartons are in received status and not marked as damaged or missing) whose received date of delivery is older than X days (Specified in Days to hold closed warehouse containers system configuration parameter) |
Cleanup Closed Warehouse Containers
This batch job deletes fully received warehouse to store deliveries (a fully received delivery is one where all cartons are in received status and not marked as damaged or missing) whose received date of delivery is older than X days ( Specified in Days to hold closed warehouse containers system configuration parameter).
This batch job can only be run in Adhoc Mode either via the EICS Job Admin screen or by calling the Execute Batch REST API to run the batch execution at any desired time.
In order to delete the closed containers and the associated delivery for a particular data set id on the EICS Job Admin screen, user must enter the transfer delivery id as the Data Set ID.
Batch Job Definition Name
WarehouseClosedContainers_PurgeJob
Batch Job Parameters
<input_date> Optional, if not specified defaulted to current timestamp. System batch input date format is used for parsing input date if specified.
<Data Set Id> Optional, if specified, the batch looks for the data set id (transfer delivery id) for processing.
Key Tables
Table 5-31 Key Tables for Delete Closed Warehouse Containers Batch
Table |
Select |
Insert |
Update |
Delete |
CONFIG_SYSTEM |
x |
|||
TSF_DELV |
x |
x |
||
TSF_DELV_CARTON |
x |
x |
||
TSF_DELV_LINE_ITEM |
x |
x |
||
TSF_DELV_LINE_ITEM_UIN |
x |
x |
||
TSF_DELV_CFA |
x |
x |
||
TSF_DELV_CDA |
x |
x |
||
TSF_DELV_CARTON_CFA |
x |
x |
||
TSF_DELV_CARTON_CDA |
x |
x |
||
TSF_DELV_LINE_ITEM_ATT |
x |
x |
Restart/Recovery
This batch can be re-run by restart batch job after any issues are resolved.
To Invoke the batch job using the Execute Batch Rest Service, refer to the REST Service Batch section of this guide.
Table 5-32 Execute Batch REST Request Example
API URL |
Operation |
Description |
Example Request Payload |
https://<siocs-lb> /siocs-int-services/api/ batches |
POST |
Submit batch job for immediate execution. |
{ "batchName": "WarehouseClosedContainers_PurgeJob” } |
https://<siocs-lb> /siocs-int-services/api/ batches |
POST |
Submit batch job for immediate execution for the particular data set id (TSF_DELIVERY_ID) |
{ "batchName": "WarehouseClosedContainers_PurgeJob", "parameterId": 9999 } |
System Process Batches
Processing of critical alerts, data migration for storage, and closure of old records is critical for the continued efficient and normal processing of the system.
These clean-up jobs are restricted and enabled by default.
Customers can configure number for day to retain information prior to closure in database via System Admin Parameters.
Table 5-33 System Process Batches
Batch Name | Description | Default | Minimum Value | Maximum Value |
---|---|---|---|---|
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. |
24 hours |
30 minutes |
24 hours |
Fulfillment Order Pick Reminders |
This batch process generates notifications for fulfillment order picks for which status is new or in progress and create date has expired by X number of minutes (specified in system configuration “Minutes To Hold Open Customer Order Pick Before Sending Notification”). |
24 hours |
30 minutes |
24 hours |
Fulfillment Order Reminders |
This batch process generates notifications for fulfillment orders for which create date has expired by X number of minutes (specified in system configuration “Minutes To Hold New Customer Order Before Sending Notification”). |
24 hours |
30 minutes |
24 hours |
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. |
24 hours |
30 minutes |
24 hours |
Product Group Schedule Closure |
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. |
24 hours |
30 minutes |
24 hours |
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. |
24 hours |
30 minutes |
24 hours |
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. |
24 hours |
30 minutes |
24 hours |
Transfer Delivery Auto Receive |
This batch auto receives the transfer deliveries to stores if delivery option is defined as date driven in store configuration. 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 whose Ship Date added to the Auto Receive Number of Days is less than the current date. |
24 hours |
30 minutes |
24 hours |
Transfer Delivery Close |
This batch program looks for all the open transfer deliveries and auto con-firms 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 starting from today. |
24 hours |
30 minutes |
24 hours |
Transfer Not After Date Alert |
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". |
12 hours |
30 minutes |
24 hours |
Transfer Overdue |
This batch process generates notification for dispatched transfers which have not been received after X number of days (specified in system configuration “Days Shipped Delivery Overdue Notification”). |
24 hours |
30 minutes |
24 hours |
Vendor Return Closure |
This batch program looks for all the open vendor returns which are in valid state (Closed /Rejected) for closure. |
24 hours |
30 minutes |
24 hours |
Batch Job Administration
This provides information about the processing and operating details of batch job administration and operations, and covers the following topics:
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 specific intervals on the SIOCS GUI.
The following diagram illustrates the high-level architecture of the current batch processing implemented for the EICS Application Server.
Figure 5-1 EICS Application Server Batch Processing Architecture
![EICS Application Server Batch Processing Architecture EICS Application Server Batch Processing Architecture](img/b_batchprocessingarchhl.png)
-
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.
Job Administration
SIOCS Job Admin is a web application that provides the runtime and GUI for managing batch jobs.
SIOCS 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 following diagrams show the Batch Admin and relevant GUI components:
Figure 5-2 Batch Admin and GUI Components
![Batch Admin and GUI Components Batch Admin and GUI Components](img/b_guicomp.png)
Job Admin Screen
This screen views 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 SIOCS. Navigation path for the Job Admin screen is:
Admin/Technical Maintenance/Job Admin
Figure 5-3 Job Admin Screen
![Job Admin Screen Job Admin Screen](img/b_jobadmin.png)
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; call 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; call 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 displays 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 denotes if user has reviewed this job.
-
Parameter
This column displays the parameter if entered while starting the batch job.
Job Execution Log Screen
This screen displays 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 using this, the user can keep a track of which of the failed jobs have already been reviewed 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-4 Job Execution Screen
![Job Execution Screen Job Execution Screen](img/b_jobexecution.png)
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 column 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 holds 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 parameters. User will not receive an error or confirmation if the parameters are not valid for the selected job.
User will require 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-5 Ad hoc Job Screen
![Ad hoc Job Screen Ad hoc Job Screen](img/b_adhocjob.png)
Screen Options
-
Start Job
This option allows user to start a new instance of the selected job. When the user selects 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 batch job to process the specified data set id.
Start an Ad hoc Job
-
Login to SIOCS and navigate to Job Admin screen.
-
Click on Ad hoc Job Menu to navigate to Ad hoc Job screen
-
Select the required Job from the drop-down menu.
-
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.
-
Click on Start Job to start the new instance of job.
-
The new execution record will be populated on the Job Admin Screen List.
View Details for Job
-
Login to SIOCS and navigate to Job Admin screen.
-
Click the Job Execution Id to navigate to details.
-
To navigate back to Job Admin screen, click Cancel.
-
To mark job execution reviewed, click Mark Reviewed.
Stop a Running Job
-
Login to SIOCS and navigate to Job Admin screen.
-
Select the job which is currently in running state that is, STARTED or STARTING.
-
Click on Stop Job to stop the execution of the running job.
-
Prompted to confirm if the job needs to be stopped. Click Yes to continue.
-
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.
-
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-34 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.
1 Week
Job execution will be every Monday at 1AM.
2 Weeks
Job execution will be every other Monday at 1AM starting on the 2nd Monday of the year.
-
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.
Table 5-35 Batch Job Schedules
Batch Job Interval Auto Replenish Capacity
24 hours
Auto Ticket Generate
24 hours
Auto Ticket Print
24 hours
Generate Problem Line Stock Count
24 hours
Generate Unit Amount Stock Count
24 hours
Generate Unit Stock Count
24 hours
Item Basket Maintenance
24 hours
Item Price ICL Import Job
30 minutes
Retail Sales Audit Import
24 hours
Shelf Replenishment Closure
24 hours
Stock Count Unit And Amount Snapshot
24 hours
Store Order Auto Approve
12 hours
Store Order Auto Cancel
24 hours
Store Order Auto Generate
24 hours
Third Party Pricing Import
30 minutes
Third Party RFID Import
30 minutes
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:
-
Enable / Disable a schedule.
-
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-6 Job Scheduler Screen
![Job Scheduler Screen Job Scheduler Screen](img/b_jobscheduler.png)
Screen Options
-
Save
This option allows user to save the changes made to the job schedules. User can make changes to multiple schedules 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 enabled 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 applies 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
Users have the 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:
-
30 Minutes - Runs every 30 minutes.
-
1 Hour - Runs every hour.
-
2 Hours - Runs every second hour of the day.
-
3 Hours - Runs every third hour of the day.
-
4 Hours - Runs every fourth hour of the day.
-
6 Hours - Runs every sixth hour of the day.
-
8 Hours - Runs every eighth hour of the day.
-
12 Hours - Expected to be executed twice a day.
-
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 denotes 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
-
Login in SIOCS and navigate to the Job Scheduler screen.
-
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.
-
Edit the Job details on right panel.
-
Set required interval for execution and Enabled to Yes.
-
Click Apply to exit the edit mode.
-
For configuring multiple jobs on a go, repeat Step 2 for each job.
-
Click Save to save the current changes made on the screen.
Disabling a Job Schedule
-
Login in SIOCS and navigate to Job Scheduler screen.
-
Select the job from the list which needs to be disabled.
-
Edit the Job details on right panel.
-
Set Enabled as No.
-
Click Apply to exit the edit mode.
-
For disabling multiple jobs on a go, repeat Step 2 for each job.
-
Click Save to save the current changes made on the screen.