Configuring job sequence notifications

Job sequence email notifications enable you to get notified about the progress of your job sequences without logging into Oracle Unity.

Note: See the Oracle Unity Help Center for more Job sequence notification examples.

In this topic:

Getting email notifications

To receive email notifications for a job sequence, when creating the job sequence, specify email notifications using the notification parameter. For example:

{
  "flowName": "ExampleJobSequence",
  "flowId": "ExampleJobSequence",
  "description": "This is an example job sequence. Note the notification parameter below.",
  "active": true,
  "jobs": [
    {
      "jobId": "CXU_JOB_1604904383636",
      "id": "Ingest job",
      "type": "INGEST",
      "depends": [
        
      ]
    },
    {
      "jobId": "Dw",
      "id": "Data warehouse job",
      "type": "DW",
      "depends": [
        "Ingest job"
      ]
    }
  ],
  "notification": {
    "list": [
      "api.user@oracle.com",
      "api.second.user@oracle.com"
    ],
    "onlyFailure": false,
    "onlySummary": false
  }
}

About the notification parameter

The following table provides more information about the parameters contained within the notification object.

Name

Type

Description

Possible values
list array Array of email addresses. The email addresses specified here will receive email notifications when individual jobs succeed and fail, and also when the entire job sequence succeeds and fails. <email>@domain.com
onlyFailure boolean Flag to enable sending email notifications for failure notifications only. If set to true, the email addresses specified will be notified when individual jobs in the sequence fail, and when the entire sequence fails. The default is false.

  • true

  • false

onlySummary boolean Flag to enable sending email notifications for job sequence summary notifications only. If set to true, the email addresses specified will be notified when the entire job sequence succeeds and fails. The default is false.

  • true

  • false

Getting email notifications for specific events

You can get emails for two types of events:

  1. Job events

    When an individual job in the job sequence succeeds or fails.

  2. Job sequence events

    When the entire job sequence succeeds or fails.

The following table outlines the type of email notifications you will receive when each notification parameter is specified (list, onlyFailure, and onlySummary).

onlyFailure onlySummary Job Event Email Sent? Job Sequence Event Email Sent?
Success  Failure Success  Failure
false false Yes Yes Yes Yes
false true N/A N/A Yes Yes
true false N/A Yes N/A Yes
true true N/A N/A N/A Yes

Next steps

Creating job sequence conditions

Configuring job sequence notifications