Alerts page in Jitterbit Management Console

Overview

Introduction

The Alerts page is a table listing alerts set up to be sent to registered Harmony users and external recipients when certain events occur:

On the Alerts page, you can do the following:

• View alerts in a table.
• Add, edit, pause, resume, and delete alerts.

All organizations have a default SSO Status Changed alert set to monitor for both the enabling and disabling of SSO. All organizations that use Jitterbit EDI have a default EDI AI monitor (Beta) alert with its status set to Paused indefinitely. Both default alerts can be edited to fit the needs of your organization.

Alerts table

The Alerts table lists the alerts added and configured for your organization. It contains these fields:

• Alert (event): The tracked event for the alert.
• Context: The specific contexts that trigger the SSO status changed alert.
• Trigger: The time relative to the event that triggers the alert.
• Type: The type of alert that is sent out. Currently fixed to Email and cannot be changed.
• Recipients: The registered Harmony users and external recipients to alert. External recipients are email addresses entered manually that are not associated with a Harmony user account. External recipients receive only the alert email notification. Adding an external recipient does not grant them a Harmony user account or any platform access, and they do not receive an account activation or password-reset email.
• Status: The status of the alert, one of Active, Scheduled pause, Paused until a specific date, or Paused indefinitely. See Pause an alert and Resume an alert for more information.
• Actions: Hover over the alert's row to reveal its Edit and Delete icons. See Edit an alert and Delete an alert for more information.

You can sort the table, resize column widths, and rearrange columns:

• To sort a table in ascending order, click a column heading. Click again to reverse the sort order.

• To resize a column, drag a column's Resize bar.

• To rearrange columns, click the Filter Columns icon. The Columns drawer opens with the following controls:

  • Search: Filter the list of columns. The search is not case-sensitive and excludes the Actions column.

  • Show all: Click to show all columns. By default, all columns are shown.

  • Hide: The column is visible. Click to hide it.

  • Show: The column is hidden. Click to show it.

  • Move: Click and drag to adjust the order the column appears in.

  • Save: Click to save any changes.

  • Cancel: Click to discard any changes.

Add an alert

To add an alert, follow these steps:

1. Click the New Alert button. The New alert drawer opens.

2. In the New alert drawer, set values for the fields depending on the selected event.

3. Click the Save button.

Edit an alert

To edit an alert, follow these steps:

1. Hover on an alert, then click the Edit icon in the Actions column. The Edit alert drawer opens.

2. In the Edit alert drawer, you can change the values present depending on the event set for Event.

3. Click the Save button. (Unless you make changes, the Save button remains inactive.)

Pause an alert

Pausing an alert stops it from sending notifications without deleting it. You can pause an alert for a specific period or indefinitely, and resume it at any time.

To pause an alert, follow these steps:

1. Hover on an alert's Status column, then click the Pause icon that appears for an active alert. The Pause alert drawer opens:

   

2. Set values for the following fields:

   • Start date: Enter when to start pausing the alert. Defaults to Now.

   • End date: Enter when to resume the alert. Defaults to Indefinitely, pausing the alert until you manually resume it.

3. Click the Save button.

When an alert has an upcoming pause period, its Status column shows Scheduled pause. While an alert is paused, its Status column shows Paused until if an end date is set, or Paused indefinitely if not. An alert with an end date automatically reactivates to Active when its pause period expires.

Resume an alert

To resume a paused alert, follow these steps:

1. Hover on the alert's Status column, then click the Resume icon. The alert immediately reactivates, and its Status column changes to Active.

Delete an alert

To delete an alert, follow these steps:

1. Hover on an alert, then click the Delete icon in the Actions column. The Delete alert dialog opens:

   Dialog text

   Delete alert
   Are you sure you want to delete the alert alertName?

   Please type "DELETE" to confirm.

2. To continue the action, enter the word DELETE where indicated in the dialog, then click the Delete button.

Events

These events are available for alert configuration:

• Agent down
• API request ended with status code
• Cloud logging status changed
• EDI AI monitor
• New agent version released
• Operation ended in terminal status
• Operation status duration threshold exceeded
• Password expiry warning
• SSO status changed

Agent down

Alert selected users when a private agent is down for a specified duration.

• Event: Select Agent down.

• Agent: Open the menu, then select the private agent to monitor. (To monitor additional agents, create individual alerts for them.)

• Alert after: Enter how many minutes (from 6 to 1440) the agent is down before an alert is sent. If the agent remains down after the first alert, one or two additional alerts are sent at the same interval, for a maximum of three alerts in sequence.

• Recipients: Open the menu to select registered Harmony users, or manually enter an email address to add an external recipient. Up to 10 recipients total, including any external recipients, can receive the alert.

API request ended with status code (Beta)

Alert selected users when an API request ends with a selected HTTP status code.

• Event: Select API request ended with status code (Beta).

• APIs: Open the menu, then select one or more APIs to monitor. Only Custom API, Proxy API, and OData API types are shown. All services and endpoints under each selected API are included in scope. When more than one item is selected, this field displays a count instead of listing each item (for example, 3 APIs). When exactly one item is selected, the field displays that item's name instead.

• Status: Open the menu, then select one or more HTTP status codes to monitor for. When more than one item is selected, this field displays a count instead of listing each item (for example, 4 statuses). When exactly one item is selected, the field displays that item's name instead.

• Recipients: Open the menu to select registered Harmony users, or manually enter an email address to add an external recipient. Up to 10 recipients total, including any external recipients, can receive the alert.

Cloud logging status changed

Alert selected users when Cloud logging is enabled or disabled for a private agent group.

• Event: Select Cloud logging status changed.

• Agent groups: Open the menu, then select which private agent groups to monitor.

• Status changes to: Select which Cloud logging status changes to monitor for the selected private agent groups:

  • Enabled: Select to send an alert when Cloud logging is enabled.

  • Disabled: Select to send an alert when Cloud logging is disabled.

• Recipients: Open the menu to select registered Harmony users, or manually enter an email address to add an external recipient. Up to 10 recipients total, including any external recipients, can receive the alert.

EDI AI monitor (Beta)

Alert selected users when an EDI transaction, FTP, or AS2 anomaly is detected. For more information, see Jitterbit EDI AI Monitor (Beta).

• Event: Select EDI AI monitor (Beta).

• Recipients: Open the menu to select registered Harmony users, or manually enter an email address to add an external recipient. Up to 10 recipients total, including any external recipients, can receive the alert.

New agent version released

Alert selected users when a new version of the private agent software is available for download on the Harmony Downloads page. (The alert is sent regardless of which private agent versions you have running on your systems.) The check for a new available version is made every 24 hours.

• Event: Select New agent version released.

• Recipients: Open the menu to select registered Harmony users, or manually enter an email address to add an external recipient. Up to 10 recipients total, including any external recipients, can receive the alert.

Operation ended in terminal status (Beta)

Alert selected users when an operation ends in a selected terminal status. One notification is sent per matching operation occurrence; a later run of the same operation that also ends in a selected terminal status triggers a new notification.

• Event: Select Operation ended in terminal status (Beta).

• Operations: Open the menu, then select one or more operations to monitor. When more than one item is selected, this field displays a count instead of listing each item (for example, 3 operations). When exactly one item is selected, the field displays that item's name instead.

• Status: Open the menu, then select one or more terminal statuses to monitor: Canceled, Success, Success With Info, Success With Warning, Success With Child Error, Error, or Soap Fault. When more than one item is selected, this field displays a count instead of listing each item (for example, 2 statuses). When exactly one item is selected, the field displays that item's name instead.

  Note

  When an operation nested two or more levels below a monitored operation ends in Error, the alert email reports the monitored operation as Success With Child Error. The status shown for that operation on the Runtime page may differ, such as Success With Info.

• Recipients: Open the menu to select registered Harmony users, or manually enter an email address to add an external recipient. Up to 10 recipients total, including any external recipients, can receive the alert.

Operation status duration threshold exceeded (Beta)

Alert selected users when an operation remains in a selected non-terminal status longer than a configured threshold.

• Event: Select Operation status duration threshold exceeded (Beta).

• Operations: Open the menu, then select one or more operations to monitor. When more than one item is selected, this field displays a count instead of listing each item (for example, 3 operations). When exactly one item is selected, the field displays that item's name instead.

• Status: Open the menu, then select one or more non-terminal statuses to monitor: Submitted, Received, Pending, Running, or Cancel Requested. When more than one item is selected, this field displays a count instead of listing each item (for example, 4 statuses). When exactly one item is selected, the field displays that item's name instead.

• Alert after: Enter how long (in hours and minutes, with a 30 minute minimum) an operation can remain in any of the selected statuses before an alert is sent. The duration is tracked separately for each status; time spent in different statuses is not combined.

• Recipients: Open the menu to select registered Harmony users, or manually enter an email address to add an external recipient. Up to 10 recipients total, including any external recipients, can receive the alert.

Password expiry warning

Alert any user in the currently selected Organization when their Harmony password is set to expire within a defined number of days. (Users are not alerted if they are already inactive or have expired passwords at the time the alert is added.)

• Event: Select Password expiry warning.

• Alert before: Enter how many days before password expiry to send the alert. The number of days is a minimum of 1 day, and a maximum of 90 days or the value for Expire user passwords in the User Management tab of the Management Console's Organizations page, whichever is smaller.

SSO status changed

Alert users with Admin role permission when Single Sign-On (SSO) is enabled or disabled for the organization. This alert is present by default for every organization, so no setup is required to start receiving these notifications.

• Event: Select SSO status changed.

• SSO status: Open the menu, then select the SSO status changes to monitor:

  • SSO disable: Select to send an alert when SSO is disabled for the organization.

  • SSO enable: Select to send an alert when SSO is enabled for the organization.

• Recipients: Open the menu to select registered Harmony users, or manually enter an email address to add an external recipient. Up to 10 recipients total, including any external recipients, can receive the alert. If no recipients are selected, the alert is sent to all users with Admin role permission in the organization.