Early Access: The content on this website is provided for informational purposes only in connection with pre-General Availability Qlik Products.
All content is subject to change and is provided without warranty.
Skip to main content Skip to complementary content

Setting a server notification

Notifications can be set for the following events:

  • Excessive disk space usage (Replicate servers only)
  • Excessive memory usage (Replicate servers only)
  • State changes/errors (Replicate and Compose servers)
Information note

Currently, it is not possible to configure notifications for individual servers. In other words, any notification that you define will apply to all current and future servers.

  1. Click the Notification bell icon toolbar button on the right of the console.

    The Notification Rules window opens.

  2. Click the Servers tab and then click New.

    The New Server Notification wizard opens.

  3. Provide a name for the notification.
  4. Select and define one of the following:

    In the Disk Space section, you can determine the disk usage event that triggers the notification.

    Select one of the following:

    • Disk usage reaches the high threshold: The notification will be triggered when disk usage reaches the percentage defined for the high threshold.
    • Disk usage reaches the critical threshold: The notification will be triggered when disk usage reaches the percentage defined for the critical threshold.
    • Disk usage returns to normal: The notification will be triggered when disk usage returns to normal percentage (i.e. not high or critical).
    • Disk usage reaches any of the defined thresholds or returns to normal: The notification will be triggered in any of the following scenarios:
      • Disk usage increases from normal to the high threshold
      • Disk usage increases from normal to the critical threshold
      • Disk usage increases from the high threshold to the critical threshold
      • Disk usage returns to normal from the high threshold
      • Disk usage returns to normal from the critical threshold
      • Disk usage returns to the high threshold from the critical threshold

    In the System Memory section, you can determine the system memory usage event that triggers the notification.

    Select one of the following:

    • System memory usage reaches the high threshold: The notification will be triggered when system memory usage reaches the percentage defined for the high threshold.
    • System memory usage reaches the critical threshold: The notification will be triggered when system memory usage reaches the percentage defined for the critical threshold.
    • System memory usage returns to normal: The notification will be triggered when system memory usage returns to normal percentage (i.e. not high or critical).
    • System memory usage reaches any of the defined thresholds or returns to normal: The notification will be triggered in any of the following scenarios:
      • System memory usage increases from normal to the high threshold
      • System memory usage increases from normal to the critical threshold
      • System memory usage increases from the high threshold to the critical threshold
      • System memory usage returns to normal from the high threshold
      • System memory usage returns to normal from the critical threshold
      • System memory usage returns to the high threshold from the critical threshold

    In the State/Errors section, select the Server state has changed notification to receive a notification whenever any of the following occurs:

    • Enterprise Manager starts monitoring a Compose/Replicate server
    • Enterprise Manager stops monitoring a Compose/Replicate server
    • A connection error to any of the monitored Compose/Replicate servers occurs
  5. Click Next.

    The Recipients screen is displayed.

  6. Notifications will always be displayed in the Message Center. If you also want the notification to sent to the Windows Event Log and/or specified Email Recipients, select their respective check boxes.

    For more information about Windows Event Log IDs, see Replicate Event IDs in Windows Event Log

    If you selected Email Recipients, specify a list of email recipients (separated by semi-colons) in the To, Cc and/or Bcc fields.

    Information note

    Sending notifications to email recipients requires your organization's outgoing mail server settings to be defined.

  7. Click Next.

    The Message screen displays a default email subject and email/Windows Event Log message for the selected notification. You can change the default subject and/or message and make use of any of the variables listed to the right of the message.

    Information note

    The message shown in the Message Center is system generated and cannot be edited.

  8. Click Finish to add the notification to Enterprise Manager.

    A summary of the notification settings will be displayed in the Servers tab in the Notification Rules window.

    Information note

    New notifications are always created as enabled and are active immediately without any need to stop/start monitoring servers.

Server notification variables

In addition to allowing you to edit the default messages, the Message window also provides a list of variables that you can insert into the notification message. These are described in the table below.

  1. Select the desired variable.
  2. Place the cursor in the message where you want the variable to be inserted.
  3. Click the arrow to the left of the variable list.
Information note

The table below describes all of the message variables. However, the variables available for selection in the Message window varies according to the notification event you select.

Variables related to Disk, Memory, Qlik CPU, and Machine CPU usage are not available for Compose servers. If defined, these variables will appear as -1 in the notification message.

Variables related to Qlik CPU and Machine CPU usage are only available for Replicate 6.2 or later. For earlier Replicate versions, these variables will appear as -1 in the notification message.

${ATTUNITY_CPU_USAGE_PERCENTAGE}

Total percentage of CPU utilized by the Replicate Server's services and tasks.

${MACHINE_CPU_USAGE_PERCENTAGE}

Total percentage of CPU utilized by the machine on which the server is installed.

${DISK_TOTAL_GB}

The total size of the disk on which the Replicate "Data" folder is installed.

${DISK_USAGE_GB}

The total amount of disk space(in GB) utilized by the Replicate "Data" folder.

${DISK_USAGE_MB}

The total amount of disk space(in MB) utilized by the Replicate "Data" folder.

${DISK_USAGE_PERCENTAGE}

The total percentage of disk space utilized by the Replicate "Data" folder.

${DISK_USAGE_PREV_STATE}

The previous disk usage state (Normal, High, or Critical)

${DISK_USAGE_STATE}

The current disk usage state (Normal, High, or Critical)

${ERROR_DETAILS}

Information about server connection errors.

${ERROR_TASKS_COUNT}

The total number or tasks in an "Error" state.

${EVENT_TIME}

When the notification event occurred.

${HOST_NAME}

The host name of the server machine.

${LAST_CONNECTION}

The last successful connection to the server.

${LICENSE_DAYS_TO_EXPIRATION}

The number of days left until the license expires.

${LICENSE_EXPIRATION}

When the license is due to expire.

${LICENSE_ISSUE_DATE}

When the license was issued.

${LICENSE_STATE}

The current license state.

${MEMORY_TOTAL_GB}

The total amount of memory available on the Replicate Server machine.

${MEMORY_USAGE_GB}

The amount of memory (in GB) consumed by Replicate tasks on the Replicate Server machine.

${MEMORY_USAGE_MB}

The amount of memory (in MB) consumed by Replicate tasks on the Replicate Server machine.

${MEMORY_USAGE_PERCENTAGE}

The percentage of total memory consumed by Replicate tasks on the Replicate Server machine.

${MEMORY_USAGE_PREV_STATE}

The previous memory state (Normal, High, or Critical)

${MEMORY_USAGE_STATE}

The current memory state (Normal, High, or Critical)

${PLATFORM}

The platform on which the server machine is installed (Linux or Windows)

${PORT}

The server port.

${RECOVERING_TASKS_COUNT}

The total number of tasks with a "Recovering" status.

${RUNNING_TASKS_COUNT}

The total number of tasks with a "Running" status.

${SERVER_DESCRIPTION}

The server description in Enterprise Manager.

${SERVER_NAME}

The server name in Enterprise Manager.

${SERVER_PREV_STATE}

The previous server state (Not Monitored, Monitored, or Error)

${SERVER_STATE}

The current server state (Not Monitored, Monitored, or Error)

${STOPPED_TASKS_COUNT}

The total number of tasks with a "Stopped" status.

${TASKS_TOTAL_COUNT}

The total number of tasks, regardless of state.

${USER_NAME}

The user name for accessing the server.

${VERSION}

The server version.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!