5 Batch Job Admin

Note:

This section is applicable only for non-POM integrated SIOCS environments. For POM-integrated environments, refer to the topic: POM Integration

Batch Scheduler

EICS provides a batch scheduler interface that allows customers to enable/disable batch jobs and schedule batches with specific intervals.

Please note this is part of EICS itself.

For more details, see the information on batches in the Oracle Retail Enterprise Inventory Cloud Service Administration Guide Batches Chapter- Job Scheduler.

Batch Activity

Admin users and system operator can view batch job activities via EICS Batch Job Admin Screen.

See Oracle Retail Enterprise Inventory Cloud Service Administration Guide Batch Job Admin Chapter- Job Admin screen.

Cleanup Batches

The scheduled batch jobs that perform cleanup of old data have been moved to systems operations. The scheduling and execution of these batch jobs is necessary for the functioning of the application. Each of these jobs will be scheduled to run by default on a cycle, often daily. As systems operations, these will not appear on the batch screen unless the user is an Oracle system operations account.

However, most of these cleanup batch jobs have a retention policy that is configurable in the systems configuration. The system configuration is available to standard customer accounts where they can set those configurations within specified range.

Cleanup Batch List

  • Activity Locks

  • Adhoc Stock Count

  • Batch Directories

  • Batch Log

  • Closed Transfers

  • Completed UINs

  • Customer Orders

  • DSD and Purchase Orders

  • Invalid Users

  • Invalid User Roles

  • Inventory Adjustments

  • Item

  • Item Baskets

  • Item Hierarchy

  • Item Price

  • Notifications

  • Price Change Worksheet

  • Price History

  • Related Items

  • Resolved UIN Problems

  • RFID

  • Sales Posting

  • Shelf Adjustments

  • Staged Messages

  • Starter Store

  • Stock Counts

  • Store Orders

  • Temporary UINs

  • Vendor Returns

POM Integration

Process Orchestration and Monitoring (POM) is a user interface which allows user to schedule, track and manage batch jobs. It uses REST APIs to trigger and get status of the batch jobs.

Refer to the Process Orchestration and Monitoring Guides for more details on using this tool.

Refer to Chapter:5 Batches in the EICS Administration Guide, for more details on batch jobs.

POM’s key features are:

  • POM provides comprehensive batch scheduling and monitoring capabilities for Oracle Retail SaaS Applications

  • Configurable Scheduler for time-based Invocation of Hourly, Ad-Hoc or Cyclic

  • Configurable Schedulerfor tailoring batch to specific customer needs such as enabling/disabling certain jobs

  • Configurable notifications with ability to send e-mail notifications

  • Provides the ability to Monitor and Control all aspects of Schedule Executions such as Re-Run, Skip, put a Job on Hold, etc

  • Easily identifies jobs that are failed, waiting for the dependencies and long-running jobs

ReST Jobs To Access SIOCS Batch Jobs configured in POM

These ReST jobs can be used to integrate with an external system and to invoke and track jobs run on that external system.

ReST Job Types Description
Job System Check API Provides the ability to check if the server is up and available.
Job Start API

Provides the ability to start a requested job and return a unique ID to track its execution.

If the Job can’t be started or does not exist, It throws an exception.
Job Status API Provides the ability to accept a unique execution ID and return the corresponding job status. If the execution ID is unknown, an exception is thrown.
Job Restart API Provides the ability to restart a job using the execution ID of a previously failed run. Upon restart, a new unique execution ID is returned to track the new execution.
Job Stop API Provides the ability to forcibly stop a running job. This is a hard stop, not a graceful shutdown or a request for the job to terminate at a convenient point.
Job Log API Provides the ability to retrieve runtime logs for a given execution ID.

Job System Check API

Note:

The <Region Name> and <Customer Subnamespace> part of the URL should be replaced with the one specific to your environment. This will be the same as your cloud service Application URL provided in the Welcome email.
Base URL https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>
REST Endpoint path /siocs-int-services/api/pombatches/ping
HTTP Method GET
Authentication OAuth System Credentials Grant
Response Payload (JSON)

A successful response with status code 200 or 204 indicates that the system is up and running.

Any other response from this endpoint should be interpreted as the system being unavailable.

Job Start API

Base URL https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>
REST Endpoint path /siocs-int-services/api/pombatches/v1/job/start
HTTP Method POST
Authentication OAuth System Credentials Grant
Request Payload (JSON)

jobName - POM Batch job name

parameters - Job Parameters (double-pipe delimited key value pairs). For more details, refer to the Oracle® Retail Enterprise Inventory Cloud Service Administration Guide, section "Batch Job Administration" > "Parameter Details" .
Request Payload Example

{

"jobName": "StockCounts_PurgeJob",

"parameters":"storeId=5000||date=25-07-08"

}
Response Payload (JSON) In case of a successful invocation, a success HTTP code (2xx) is returned with a payload.
Response Payload Example

{

"executionId": "112",

"status": "STARTED"

}

Job Status API

Base URL https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>
REST Endpoint path /siocs-int-services/api/pombatches/v1/job/status? executionId=<executionId>
HTTP Method GET
Authentication OAuth System Credentials Grant
Response Payload (JSON) In case of a successful invocation, a success HTTP code (2xx) is returned with a payload.
Response Payload Example

{

"executionId": "112",

"status": "COMPLETED"

}

Job Restart API

Base URL https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>
REST Endpoint path /siocs-int-services/api/pombatches/v1/job/restart
HTTP Method POST
Authentication OAuth System Credentials Grant
Request Payload (JSON) executionId - Unique Id of the previously failed execution returned by the start API
Request Payload Example

{

" executionId": "113"

}
Response Payload (JSON) In case of a successful invocation, a success HTTP code (2xx) is returned with a payload.
Response Payload Example

{

"executionId": "114",

"status": "RUNNING"

}

Job Stop API

Base URL https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>
REST Endpoint path /siocs-int-services/api/pombatches/v1/job/kill
HTTP Method POST
Authentication OAuth System Credentials Grant
Request Payload (JSON) executionId - Unique Id of the previous execution returned by the start API
Request Payload Example

{

" executionId": "115"

}
Response Payload (JSON) In case of a successful invocation, a success HTTP code (2xx) is returned with a payload.
Response Payload Example

{

"executionId": "115",

"status": "STOPPED"

}

Job Log API

Base URL https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>
REST Endpoint path /siocs-int-services/api/pombatches/v1/job/log? executionId=<executionId>
HTTP Method GET
Authentication OAuth System Credentials Grant
Response Payload (JSON) In case of a successful invocation, the response will contain the log data for the execution provided.
Response Payload Example

{

"executionId": "115",

"status": "FAILED",

"errorMessage": "xyz"

}