Skip to content

Setting up Queue Watchdog

Define watchdogs, according to which the system will create notifications for Job Queue Entries statuses. Each watchdog, can produce notifications for a single job queue entry status or for all statuses. You can create as many watchdogs as you want, on each of them applying different notification rules and different notification recipients.

TIP

One of the watchdogs can be set as the default, so that it will automatically run for each newly created job queue entry - also for those that are created automatically by the BC, as well as run as background tasks.

You can use a generic setup and set the email for notifications, directly at the watchdog level. If such a simplified notification setup is sufficient, then you do not need to set notification recipients. Just put email address in the Email for Notifications field and you're done!

Queue-Watchdogs

Setting up notification recipients

To tailor notifications for multiple recipients or receive them directly on the Role Center, configure notification recipients.

Specify recipients for notifications individually for each watchdog.

QW-Notification-Recipients

Setting up notification channels

For each notification recipient, decide what channel they should receive alerts through. You can choose a different notification channel for each recipient:

  • Email only
  • Role Center only
  • both channels simultaneously

QW-Notification-Channels

Setting up alternative email for recipient

Once you have created notification recipients, you can use their default Contact Email pulled from the User Card, or set a custom email to which notifications will be sent. When you set the Email field, then notifications will only be sent to that email, as it has a higher priority.

QW-Alternative-Email

Setting up email account to send notifications

If you have multiple email accounts defined in BC and do not want to use the default email account to send notifications, assign the Queue Watchdog email scenario to the email account from which notifications are to be sent.

Search for Email Scenario Assignment, select the relevant email account and use Assign scenarios action.

QW-EmailScenario1

Search for Queue Watchdog on the Email scenario list, select and confirm.

QW-EmailScenario2

The scenario for sending notifications has been assigned to the indicated email account.

QW-EmailScenario3

Setting up job queue entry

You can set a different watchdog on each job queue entry. If you want the default watchdog to work for the job queue entry, then do not select a watchdog on the job queue entry card, just leave the field blank.

JQE_Setup

Setting up job queue categories

If you frequently create new job queue entries and use job queue categories, you can streamline the setup of a new job queue entry by assigning a default watchdog to the job queue category.

JQ_Categories

Assign job queue category to job queue entry

When assigning a job queue category to a job queue entry, the system will automatically complete the watchdog code, based on the assignment of the default watchdog to the job queue category (described in the previous step).

JQE_Assign_Category_and_QWcode

Setting up job queue entry Supervisor

The Job Queue Supervisor is exclusively designed to manage Auto-Recovery mode for job queue entries. Easily establish the supervisor by utilizing the Register Queue Watchdog Supervisor assisted setup, a fully automated process for seamless configuration.

Open Assisted Setup, search for Register Queue Watchdog Supervisor assisted setup guide, run it and just register. You can leave the default option to run every 15 minutes, or set your own schedule by specifying a different value.

Register_QW_Supervisor

Once the setup is complete, a job queue entry is created responsible for overseeing other tasks. You don't have to set anything on thisjob queue entry.

JQE_QW_Supervisor

Setting up job queue entry auto-recovery

With this feature, the system monitors the selected job queue entries and automatically restarts them if they stop with an error.

Important

The previous step is required to handle auto-recoverty mode (Restart on Error).

JQE_RestartOnError