Job Queue Notification Setup

Prev Next

Welcome to our ‘Job Queue Notification Setup’ manual.

The following steps will get your Job Queue notifications set up within your EliteParks or EliteMarinas environment.

Follow the steps in order to ensure the setup is completed correctly.


Step 1 - Job Monitor Setup

In this step we will be enabling the feature and setting up the Job Queue Monitor to work in your environment.

  1. Search for ‘Job Queue Monitor Setup’

  2. Select the option from the list menu that appears.

  3. Enable the feature, and select ‘Start Job Queue Monitor' from the ribbon.


Step 2 - Job Queue Monitor Alert Actions

In this step we will be creating the Alert Actions to use with your Job Queue Monitor Entries to help direct the notifications to your chosen recipients. This part will be used later in the process so ensure you set at least one Alert Action up.

  1. Search for ‘Job Queue Monitor Alert Actions’.

  2. Select the option from the list menu that appears.

  3. On the now opened screen, select ‘+New’ from the ribbon.

  4. You’ll need to enter the following on the line:

    1. Code - This is a 20 character code to identify the relevant Action, for example ‘EMAIL SUP’.

    2. Description - Enter a brief description of what the action is for, for example ‘Email Super Users’.

    3. Action Type - Ensure E-mail is set as the available option.

    4. Alert E-mails - Enter the email address or addresses you want to alert as part of this action. Multiple email addresses can be entered using ';’ as a separator.

  5. You can add as many Action codes as required for the notifications you want to send.


Step 3 - Job Queue Monitor Alert Condition

In this step we will be creating the Alert Conditions to use with your Job Queue Monitor Entries to set the conditions on when the notification is sent. This part will be used later in the process so ensure you set at least one Alert Condition up.

  1. Search for ‘Job Queue Monitor Alert Condition’.

  2. Select the option from the list menu that appears.

  3. On the now opened screen, select ‘+New’ from the ribbon.

  4. You’ll need to enter the following on the line:

    1. Code - This is a 20 character code to identify the relevant Condition, for example ‘FAILED’.

    2. Description - Enter a brief description of what the condition is, for example ‘The job queue has failed’.

    3. Tag - Enter a tag identity that will appear on the email notification, for example ‘JQ-001’.

    4. Since Last Run (minutes) - If the Condition used is for when a Job Queue has been stuck in progress, you can specify the number of minutes to wait until you want to flag a potential problem. (This will vary depending on the Job Queue you are monitoring and how often it is set to run)

    5. Alert Condition Filter - Select a relevant filter for the Job Queue, i.e. Status, selecting ‘ERROR’.

  5. You can add as many Alert Conditions as required as the trigger point for when notifications are made.


Step 4 - Job Queue Monitor Entries

This is the final step, where we will be creating the Job Queue Monitor Entry, which will act as the trigger to send the notification when the Conditions are met to the relevant parties associated with the created Action.

  1. Search for ‘Job Queue Monitor Entries’.

  2. Select the option from the list menu that appears.

  3. On the now opened screen, select ‘+New’ from the ribbon.

  4. A Job Queue Monitor Entry Card will open and you’ll need to fill out details in the following sections and fields:

    1. General

      1. Tag - This is an ID for the Monitor Entry to make it easy to keep on top of your Job Queue Monitor Entries.

      2. Enabled - This must be flagged as true in order for the cards process to run, this is enabled from the ribbon on the page. NOTE: Do this last as you cannot edit an enabled monitor entry card.

      3. Next Run Date/Time - You can specify the next run date and time for the monitoring to start.

    2. Job Queue

      1. Job Queue Entry Id - Select the relevant Job queue you want to monitor, this could be a booking feed or your booking inventory job queue.

    3. Configuration

      1. Alert Action Code - Enter a brief description of what the condition is, for example ‘The job queue has failed’

      2. Alert Frequency (Minutes) - Enter a tag identity that will appear on the email notification, for example ‘JQ-001’.

      3. Recurrence Type - You can choose between interval or daily, interval will allow multiple send outs based on the configuration set in the below field.

      4. No. of Minutes between Intervals - Specify the number of minutes between notification sends outs for when the entry card will trigger. (Not required if using ‘Daily’)

    4. Conditions (From Ribbon)

      1. Conditions - On the ribbon, select conditions and then choose the appropriate Job Queue Monitor Alert Condition setup in the previous step.

  5. You can create as many Job Queue Monitor Entry Cards as needed to keep track on as many Job Queues as you require.

  6. Once you complete these steps, on the previous screen, select ‘Start Job Queue Monitor’ from the notification ribbon.