Substitution variables

<< Click to Display Table of Contents >>

Core Announcement >

Substitution variables

Variables to be used when creating or modifying templates:

 

Variable

Description

$SUBSCRIPTION_ID

The ID of the customer facility.

$SUBSCRIPTION_ADDRESS

The address of the customer facility.

$SUBSCRIPTION_ZIPCODE

The postal code of the customer facility.

$SUBSCRIPTION_EAN

The customer facility EAN.

$CUSTOMER_NAME

The full name of the connected recipient.

$CUSTOMER_FIRST_NAME

The first name of the connected recipient.

$CUSTOMER_SURNAME

The surname of the connected recipient.

$CUSTOMER_ID

The connected recipient's ID.

$CUSTOMER_ADDRESS

The address of the connected recipient.

$CUSTOMER_ZIPCODE

The postal code of the connected recipient.

$CUSTOMER_CITY

The name of the city for the connected recipient.

$CUSTOMER_ORG_ID

The connected recipient's registration number.

$EMAIL_ADDRESS

The email address of the connected recipient.

$MOBILE_NUMBER

The mobile phone number of the connected recipient.

$TIMESPANS

The timespans for the announcement in question.

$RESTORED_TIME

The end time of the outage/disturbance.

$RESTORED_DATE

The end date of the outage/disturbance.

$EXTERNAL_NOTE

The 'External note' of the outage/disturbance.

$INTERNAL_NOTE

The 'Internal note' of the outage/disturbance.

$PLANNED_OCCURRED_TIME

The planned start time of the outage/disturbance.

$PLANNED_OCCURRED_DATE

The planned start date of the outage/disturbance.

$PLANNED_RESTORED_TIME

The planned end time of the outage/disturbance.

$PLANNED_RESTORED_DATE

The planned end date of the outage/disturbance.

$OCCURRED_TIME

The start time of the outage/disturbance.

$OCCURRED_DATE

The start date of the outage/disturbance.

$OUTAGE_ID

The ID of the outage/disturbance.

$OUTAGE_PRIMARY_SUBSTATION

Primary substation of the outage/disturbance.

$OUTAGE_PRIMARY_FEEDER

Primary feeder of the outage/disturbance.

$OUTAGE_SECONDARY_SUBSTATION

Secondary substation of the outage/disturbance.

$OUTAGE_SECONDARY_FEEDER

Secondary feeder of the outage/disturbance.

$OUTAGE_DEVICE_ID

Switch device of the outage/disturbance.

$CURRENTLY_AFFECTED_AREAS

Currently affected areas.

$OUTAGE_ID_PUBLISHED

For customers with the Outage Map module. The variable is substituted with the ID of the outage and allows for announcing only if the connected outage is published on Outage Map.

 

Substitution variables for resource announcements

Variable

Description

$CURRENTLY_AFFECTED_AREAS

Currently affected areas.

$CUSTOMERS

The number of affected customers.

$INTERNAL_NOTE

The 'Internal note' of the outage/disturbance.

$EXTERNAL_NOTE

The 'External note' of the outage/disturbance.

$OCCURRED_TIME

The start time of the outage/disturbance.

$OCCURRED_DATE

The start date of the outage/disturbance.

$OUTAGE_DEVICE_ID

Switch device of the outage/disturbance.

$OUTAGE_ID

The ID of the outage/disturbance.

$OUTAGE_ID_PUBLISHED

For customers with the Outage Map module. The variable is substituted with the ID of the outage and allows for announcing only if the connected outage is published on Outage Map.

$OUTAGE_ORIGIN

The origin of the outage/disturbance.

$OUTAGE_PRIMARY_SUBSTATION

Primary substation of the outage/disturbance.

$OUTAGE_PRIMARY_FEEDER

Primary feeder of the outage/disturbance.

$OUTAGE_SECONDARY_SUBSTATION

Secondary substation of the outage/disturbance.

$OUTAGE_SECONDARY_FEEDER

Secondary feeder of the outage/disturbance.

$PLANNED_OCCURRED_TIME

The start time of the outage/disturbance.

$PLANNED_OCCURRED_DATE

The start date of the outage/disturbance.

$PLANNED_RESTORED_TIME

The planned end time of the outage/disturbance.

$PLANNED_RESTORED_DATE

The planned end date of the outage/disturbance.

$RESTORED_TIME

The end time of the outage/disturbance.

$RESTORED_DATE

The end date of the outage/disturbance.

$TIMESPANS

The timespans for the announcement in question.

$WORK_REQUEST_ID

The ID of the work request.

$WORK_REQUEST_STATUS

The state of the work request.