Placeholders

When creating notification and building http request to channel, placeholders can be used. These placeholders are replaced at the time of notification with configured/computed values.

In addition to list of fixed placeholders described below also channel settings, that are not encrypted, can be substituted. To use channel setting as a placeholder simply use {{Setting’s System Name}}.

These are placeholders available for all Channels:

  • {{AlertGeneratedAt_CalculationTimeZone}}
    DateTime
    Not available for deescalation messages
    The time email was sent (calculation’s time zone).

  • {{AlertGeneratedAt_UtcTimeZone}}
    DateTime
    Not available for deescalation messages
    The time email was sent (UTC time zone).

  • {{BaseUrl}}
    Text
    URL where DW application is deployed.

  • {{BusinessUnit}}
    Text
    The name of Business Unit from which notification originates.

  • {{BusinessUnitId}}
    Text
    The ID of the Business Unit from which notification originates.

  • {{ColumnName}}
    Text
    The name of the column associated with the notification.

  • {{CompareValue}}
    Format depends on the calculation above which the rule is used
    Notification rule compare value. The value the KPI is compared to.

  • {{Condition}}
    Text
    The condition that triggers the notification.

  • {{ConditionMetAt_CalculationTimeZone}}
    DateTime
    Not available for deescalation messages
    The time condition first became true (calculation’s time zone).

  • {{ConditionMetAt_UtcTimeZone}}
    DateTime
    Not available for deescalation messages
    The time condition first became true (UTC time zone).

  • {{CurrentValue}}
    Format depends on the type of calculation associated with notification rule
    Last known KPI value before the email is sent.

  • {{DeescalationGeneratedAt_CalculationTimeZone}}
    DateTime
    Not available for escalation messages
    The time deescalation notification was sent (calculation’s time zone).

  • {{DeescalationGeneratedAt_UtcTimeZone}}
    DateTime
    Not available for escalation messages
    The time deescalation notification was sent (UTC time zone).

  • {{Duration}}
    Timespan
    Not available for deescalation messages
    Number of minutes the condition has been true.

  • {{EditUrl}}
    Text
    The URL of the notification rule.

  • {{FirstValueInSequence}}
    Format depends on the type of calculation associated with notification rule
    Not available for deescalation messages
    First KPI value in sequence of values which cause notification to be sent.

  • {{SourceId}}
    Text
    The ID of the source from which the notification originates.

  • {{LastValueInSequence}}
    Format depends on the type of calculation associated with notification rule
    Not available for deescalation messages
    Last KPI value in sequence of values which cause notification to be sent.

  • {{LayoutUrl}}
    Text
    The URL of the Layout from which notification originates.

  • {{LayoutName}}
    Text
    The name of the Layout from which notification originates.

  • {{LayoutPublicId}}
    Text
    The public ID of the Layout from which notification originates.

  • {{MaxValueInSequence}}
    Format depends on the type of calculation associated with notification rule
    Not available for deescalation messages
    Maximum KPI value in sequence of values which cause notification to be sent.

  • {{MinValueInSequence}}
    Format depends on the type of calculation associated with notification rule
    Not available for deescalation messages
    Minimum KPI value in sequence of values which cause notification to be sent.

  • {{RecipientAddress}}
    Text
    Address where the notification should be sent. In case of email channel recipient address is email address.

  • {{Recipients}}
    Text
    List of recipients for the notification.

  • {{Operator}}
    Text
    Comparison operation (in mathematical form) used in notification rule.

  • {{OperatorText}}
    Text
    Comparison operation (in text form) used in notification rule.

    RuleOperator

    OperatorText

    >

    greater than

    <

    less than

    >=

    greater than or equal to

    <=

    less than or equal to

    <>

    not equal to

    =

    equal to

  • {{SourcePublicId}}
    Text
    The public ID of the source from which the notification originates.

  • {{RowIdentifier}}
    Text
    A unique identifier for the row associated with the notification.

  • {{Title}}
    Text
    Title of KPI containing notification rule.

  • {{TimeZoneName}}
    Text
    The name of the Calculation’s time zone.

  • {{UtcOffset}}
    Numeric
    The offset of the Calculation’s time zone.

  • {{UtcOffsetFormatted}}
    String
    The formatted offset of the Calculation’s time zone.

For more information about supported formats of the placeholders, see following documentation:

DateTime

TimeSpan

Numeric

Format of the placeholder has to be placed at the end of the placeholder after the : symbol. For example:

{{AlertGeneratedAt_UtcTimeZone:R}}