› KCS Administration › Users › User properties › Advance › Queue Length Alerting/Queue Page Alerting/ Queue Age Alerting

Queue Length Alerting/Queue Page Alerting/ Queue Age Alerting

Use these tabs to configure alerts in KCS Portal. By default, when you add an alert, one alert level is added. You can create multiple levels for each alert.

The message that needs to be sent when an alert is triggered is configured separately.

Create an alert

  1. On the Queue Length Alerting/Queue Page Alerting/Queue Age Alerting tab, click Add Alert.
    An alert is added to the list of existing alerts.
  2. Select the alert from the list.
  3. Configure the following parameters for the alert.
    Field Description
    Alert Name Name of the alert.
    Watch Select message folder to watch: Inbox or Outbox.
    From

    • If you are watching an inbox folder, select the User or Group and specify the user ID or group ID respectively.

    • If you are watching an outbox folder, select the User or Group and specify the user outbox or group outbox respectively.

    If the From field is left blank for outbox, it is set to outbox of the current user.

    To If you are watching an inbox folder, select the User or Group and specify the user inbox or group inbox respectively.

    In case of inbox, if To field is left blank, it is set to outbox of the current user.

    If you are watching an outbox folder, select the User or Group and specify the user ID or group ID respectively.

    State

    Only the messages with the selected states are considered for alerts. Following are the possible states:

    • A_deferred: Waiting for the intended time of sending.

    • B_wait for document conversion: Waiting to be picked up by the TCOSS document converter.

    • C_active: Being sent out or waiting for a send retry.

    • D_at next node: Already transferred but waiting for a confirmation.

    • E_terminated: Sending failed, no further send retries.

    Priority Select a range of message priority. Messages with priority in range of selected priority are included.

Create levels for an alert

For each alert, one level is created by default with predefined settings. You can add multiple levels for each alert.

  1. Select the alert from the grid, and click Add Level. A new level is added to the selected alert in the grid.
  2. Configure the properties of the new alert level.
    Field Description
    Alert Level Name Name of the level.
    Sub-Alert Ignores the configuration set in this level if another level exists with a higher Trigger Threshold.
    Active Sets this level as active. Only the active levels are used for generating alert messages.
    Periodic Repetition In case an alert is triggered and the alert condition persists, sends alert messages repeatedly after the specified time here. The minimum value is 10:00 minutes. A value less than 10 minutes signifies that alert messages must be sent only once.
    Trigger Threshold If the number of entries of the configured parameter in a message queue is more than the configured value, alert message is triggered. This value must be more than Re-activation threshold. Set this parameter for the type of alert needed:
    • Queue Length Alerting: Number of messages in a message queue.
    • Queue Page Alerting: Number of pages in a message queue.
    • Queue Age Alerting: Age of message queue in seconds

    Example: Trigger Threshold = 1000, Re-activation Threshold = 500.

    The alert warning message is sent if the queue length is more than 1000. If the queue length oscillates between 1000 and 500, no further alert messages are sent. When the queue length falls below 500, alert gets cleared and any further alert message is only sent if queue length is more than 1000.

    Re-activation threshold

    If the number of entries of the configured parameter in a message queue becomes less than the reactivation threshold, a message is sent specifying that alert is now cleared.

    Example: Trigger Threshold = 1000, Re-activation Threshold = 500.

    The alert warning message is sent if the queue length is more than 1000. If the queue length oscillates between 1000 and 500, no further alert messages are sent. When the queue length falls below 500, alert gets cleared and a respective message is sent.

    Folder name The folder where the alert message is saved.
    File Name The file name of the alert message.
    Template Text Variable The variables to use for alert message. When alert messages are sent, these variables are replaced with the configured values.