Oracle Retail Knowledge Base

3 Integration

6 min read

Mirror of Oracle documentation

Converted for search and offline reading. Authoritative source: Oracle. Diagrams and some complex tables are simplified — check the PDF when in doubt.

3

Integration

This chapter describes the various scenarios which involve configuring the Process Orchestration and Monitoring (POM) application and integrating it with external systems.

Setting Up a New Batch Schedule in POM

When POM is first installed for a specific customer, it does not include any application batch schedules out of the box such as Merchandising or Retail Intelligence, and so on. An Oracle administrator or a system integrator need to first configure those schedules before they get loaded with the scheduling data. Configuring a new schedule entails setting up schedule properties such as the schedule name and description, and customer environment information for callbacks. It also entails setting up the location of different components and services with which different POM components need to interact to function properly.

Refer to the section “Configure New Schedule” in the “System Configuration” section of the POM User Guide .

Also refer to the Customizing Batch Schedules chapter of this guide for setting up a new custom batch schedule.

Invoking POM Entities

Different SaaS customers operate in different models for running their batch. Some may choose to use the POM Scheduler to schedule the different entities such as Nightly, Recurring or Standalone. Refer to the POM User Guide for documentation on the POM Scheduler.

Others may choose to control the time and frequency of batch executions by invoking the provided ReST APIs. See the Batch Execution API section of the Invoking POM Services chapter of this guide for more details.

External Status Update (Callbacks)

The External Status Update feature provides the ability for external systems to optionally register with POM to receive the Job status notifications as a callback to their ReST interface.

While ReST service calls from external systems (customers) to POM are required to use the OAuth2 authentication standard, the ReST service call for External Status Update (Callback) allows both Basic Auth and OAuth2.

Retailers are responsible for using valid, certificate authority (CA) signed certificates for TLS for the APIs, such as the one associated with External Status Update. For more information, see My Oracle Support Doc ID 2710163.1

By default, manually run jobs (triggered from the UI) do not generate callbacks to external systems. However, this can be changed by enabling the Manual Run Callback toggle from the System Configuration screen for that schedule.

Implementation Guide G58508-01 Copyright© 2026, Oracle and/or its affiliates.

External Configuration for AIF APPS 24.1.202.20
External Configuration for AIF APPS 24.1.202.20

3. Set the External Status Update Mode to one of the following values:

  • ALL - POM will send a status update to the external system for this job’s execution

  • regardless of success or failure.

  • FAILED - POM will send a notification only when this job fails.

  • NONE - No status update will be sent by POM for this job.

Payload Specification

AttributeDescription
processNameName of the root process in a given cycle/fow
**Note:**Process names in the callback response are prefxed with the
name of the schedule. For instance, a callback response sent for Process
”P1” would haveprocessNameattribute asMERCH_P1on return.
processExecutionIdUnique identifer generated by POM to track the process executions.
activityNameName of the job for which the callback/status update is sent.
activityExecutionIdUnique identifer generated by POM to track the job run instance.
callerIdIdentifer provided by the caller to POM when submitting the invocation/
execution request. POM returns the same ID back to the caller.
correlationIdIdentifer provided by the caller to POM when submitting the invocation/
execution request. POM returns the same ID back to the caller
callBackServiceDataD
etail.		Key-value pairs supplied to POM when submitting the invocation/
execution request. They are returned back to the caller
failedActivityIn the case where the callback is for a failed job, this feld is populated
with the details of the failed Job.
statusStatus of the job execution:
•
COMPLETED
•
SKIPPED
•
ERROR
•
SKIPPED_ON_ERROR
activityStatusStatus of the job, and the derived activity state:
•
ERROR - ACTIVITY_FAILED
•
COMPLETED - ACTIVITY_COMPLETED
•
SKIPPED - ACTIVITY_COMPLETED
•
SKIPPED_ON_ERROR - ACTIVITY_COMPLETED
jobStartTimeJob start time
jobEndTimeJob end time
jobExecutionDurationDuration of job execution in seconds
jobLongRunningIndY or N depending on whether the Job was long running or not
activityProcessNameName of the Process that contains the Job. This may or may not be the
same as the Root Process name.
requestTypeContains a value indicating whether the job was started manually or via
scheduler/API.
Possible values are: MANUAL_RUN, SCHEDULER_REQUEST or
UI_PROCESS_INVOKE.
Payload Examples

Below are sample external status update payloads for the MERCH schedule.

Implementation Guide G58508-01 Copyright© 2026, Oracle and/or its affiliates.

Description Payload

Adhoc Job Callback { "processName": "MERCH_MERCHAPI_DELTA_EXT_ORG_HIER_ADHOC_PROCESS", "activityProcessName": "MERCHAPI_DELTA_EXT_ORG_HIER_ADHOC_PROCESS", "processExecutionId": "MERCH_MERCHAPI_DELTA_EXT_ORG_HIER_ADHOC_PROCESS~322665", "activityName": "MERCHAPI_EXT_ORG_HIER_ADHOC_JOB", "activityExecutionId": "3368196", "callBackServiceDataDetail.rootProcess": "MERCH_MERCHAPI_DELTA_EXT_ORG_HIER_ADHOC_PROCESS", "callBackServiceDataDetail.rootProcessExecId": "MERCH_MERCHAPI_DELTA_EXT_ORG_HIER_ADHOC_PROCESS~322665", "requestType": "SCHEDULER_REQUEST", "jobStartTime": "2026-07-10 16:27:55", "jobEndTime": "2026-07-10 17:43:51", "jobExecutionDuration": "4556", "jobLongRunningInd": "N", "status": "COMPLETED", "activityStatus": "ACTIVITY_COMPLETED" } Nightly Job Callback { "processName": "MERCH_DUMMY_START_NIGHT_BATCH_PROCESS", "activityProcessName": "DEALS_PROCESS", "processExecutionId": "MERCH_DUMMY_START_NIGHT_BATCH_PROCESS~322433", "activityName": "DEALACT_JOB", "activityExecutionId": "3369507", "callBackServiceDataDetail.rootProcess": "MERCH_DUMMY_START_NIGHT_BATCH_PROCESS", "callBackServiceDataDetail.rootProcessExecId": "MERCH_DUMMY_START_NIGHT_BATCH_PROCESS~322433", "requestType": "SCHEDULER_REQUEST", "jobStartTime": "2026-07-10 17:42:30", "jobEndTime": "2026-07-10 17:42:41", "jobExecutionDuration": "11", "jobLongRunningInd": "N", "status": "COMPLETED", "activityStatus": "ACTIVITY_COMPLETED" }

External Dependency

This feature allows customers to control the execution of a schedule running in POM by defining custom pre-dependencies on certain Jobs. POM pauses the schedule execution upon

Implementation Guide G58508-01 Copyright© 2026, Oracle and/or its affiliates.

Be

Setup the ReST service using PLSQL in RDS. Ensure the request payload for this endpoint conforms to this format. This would be the payload that is sent by POM.

Ensure the response from the RDS services conforms to the following specification

{
   "cycleName": "cycle1",
   "flowName": "flow1",
   "processName": "process1",
   "jobName": "job1",
   "agentExecutionId": "agentExecutionId1234",
   "parameters": ""
}

Ensure the response from the RDS services conforms to the following specification.

{
   "status":"success",
   "executionInfo":null,
   "executionId":"agentExecutionId1234",
   "notificationInfo":"Number of stock counts that have been open for more
than 7 days is 0."
}

Step 2:

Setup the RDS Job in POM as a Custom Job. Ensure the parameters to this job contain the following

  • notificationType - This is the Notification Type for the Application (e.g - MERCH) you wish to create a Notification for. The Notification Type must have been created previously using Retail Home.

  • restPath - This is the path that is appended to the RDS URL for the endpoint configured in Step 1.

Ensure both these keywords are separated by double pipes as shown below

notificationType=MerchStockAlert||restPath=mfcs/stockCheck

For a complete set of instructions on setting up a POM job with an RDS job type, refer to the “Notification-Based Monitoring” section of the “Extension” chapter of the Oracle Retail Data Store Implementation Guide .

Custom Job Types (Unlimited Run Time)

If it is estimated that the RDS PL-SQL packages being called are going to take longer than 5 minutes, then it is not recommended to use the default RDS Job Type. It is instead advisable to build out a Custom Job Type based on RDS endpoints.

Refer to the Generic ReST Jobs chapter of this guide and the “Custom RDS Job Types” section of the “Extension” chapter of the Oracle Retail Data Store Implementation Guide to learn more about Custom Job Types.

Implementation Guide G58508-01 Copyright© 2026, Oracle and/or its affiliates.

In this guide

  • 10 Invoking POM Services — POM Implementation Guide · shares MANUAL_RUN, SCHEDULER_REQUEST
  • 5 ReSTful Web Services — Inbound and Outbound Integration Guide · shares MERCHAPI_DELTA_EXT_ORG_HIER_ADHOC_PROCESS, MERCHAPI_EXT_ORG_HIER_ADHOC_JOB

Graph View

Backlinks