Aim of this article | This section shows how to set up notifications which inform you if and when jobs/tasks at a partition or a route in integration reach a certain status. |
|---|---|
Related sections |
|
Required permissions | Alerts - edit |
In this section:
Options differ depending on whether it is a Job/Task Notification = PARTITION_JOB, Integration Notification = ROUTE_CHECK, or Event Orchestration Notification = WORKFLOW (for more details on EO Notifications, refer to How to Create Event Orchestration Notification).
Edit Notification Rule
Go to Account > Notifications > Notification Rules.
In the row menu of a particular notification select Edit.
Work with the following options:
Type: Select PARTITION_JOB (Job/Task Notification), ROUTE_CHECK (Integration Notification), or WORKFLOW (Event Orchestration Notification).
Name – Name of your choice. (Will also be used as email subject if email notifications are sent.)
Account – Name of your account.
Partition – Name of your partition (or all of the partitions for the account).
or
Integration Instance – Name of your IM (or all of the partitions for the account).Target Type – Shows the type of task. It can be Analytics Data Load, CFS, Datamart etc. For integrations it is a route. This value cannot be edited; all you can do is to create a new notification.
Target Name – Based on the name from partition Job/Task.
Here you can select the option Target all which enables you to monitor all objects which meet the specified conditions.Target Object – Shows for which object the notification is defined. This value cannot be edited; all you can do is to create a new notification.
Trigger by – Allows you to define what job status should trigger the notification. You can, for example set the Error state for a workflow, to receive a notification every time a workflow fails.
State:
For partition jobs/tasks the options are: All, Pending, Scheduled, Processing, Error, Ready, Cancelled, Interrupted, Did not run.
The option Did not run is available only when a scheduled time is selected (not in Real Time Monitoring).For integration routes the options are: All, Success, Error, Warning, Did not run.
For Event Orchestration Notifications the options are: All, Success, Error
The value All includes all existing states (also those which might be added in the future).
Max running time: Allows you to set the maximum time for a route to be running. If it is longer, the notification is triggered. This feature is supported since IntegrationManager 1.8.
As for frequency of the monitoring, you can choose between:
Real time monitoring – Checks every 5 minutes if the specified object reached the trigger state and notifies you immediately.
Scheduled time & Lookback interval – Allows you to define a custom interval at which PlatformManager checks if the specified object reached the trigger state. You can define a specific date and time and have this repeated daily, weekly, monthly or yearly. The Lookback option defines what portion of the log should be scanned. For example, if your job is scheduled to run every Monday at 9 am and typically runs for 5 minutes, it makes sense to set up the monitoring frequency to Mondays at 9:30 and set the Look back option to 30 minutes.
Email – Enter emails of people who should get the notification.
Receive email with detailed information – If selected, the email will contain an attachment with various technical details, such as the account name, instance, partition, Pricefx version, IM name, TypedId, UUID, processing node, number of alert occurrences and in the attachment the message that the Pricefx application issued for the job.
Webhook – Enter MS Teams or Slack webhook URL, so that you receive the notification in one of these channels. For details see How to Get Webhook URL.
Confirm the changes.
 |  |
Create New Notification Rule
New notifications are created either for a specific object of a given type (job/task or route) or using a blank form.
Blank Form
Go to Account > Notifications > Notification Rules.
Click the New Rule button.
Fill in the definition (the options are described above in the Edit Notification Rule section).
Prefilled Form for Specific Object
The starting point differs depending on whether you are creating a notification for a job/task or route.
Go to Account > Partitions > Partition Overview > Job/Task Tracking.
or
Go to Account > Integrations > Routes.Among the existing jobs/tasks/routes select the one whose status you want to monitor.
Select Create Notification from the row menu.
Fill in the definition (the options are described above in the Edit Notification Rule section).
Job/Task Notification creation:
Integration Notification creation:
