The email variable in the CONFIGURATION archive contains the settings used to generate daily email reports.

The configuration for the email reports is divided into various sub-components. Each sub-component has a section of the configuration it uses to generate the parts of the email it is responsible for. The sub-components also accept a profile specification which determines how they generate the message.

In most cases, the profile is inherited from the master "email_send" component, which is responsible for assembling and sending the email. The sub-components receive the profile setting and generate their contents based on that.

General Settings

/DataTrigger
Description

Email data triggered message configuration

Keys

The keys immediately below this are profile names that are selected by the application. For example, aerosol is the commonly used default profile. However, any non-empty name is acceptable and can be used to create customized configurations that can be selected at run time. In general, profile names should be all lower case to preserve case insensitivity. In the paths listed <PROFILE> is used as a placeholder to real profile name (e.g. replace <PROFILE> with aerosol for the default profile).

/DataTrigger/<PROFILE>
Description

Email data trigger profile configuration

Keys

The keys immediately below this are unique names selected by the user. These names can be any non-empty text and are generally used to designate different components to be configured. In the paths listed <IDENTIFIER> is used as a placeholder to real name selected during configuration.

/DataTrigger/<PROFILE>/<IDENTIFIER>/After
Description

Message contents generated after any condition or global messages when any trigger is met

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Heading/DefaultOpen
Description

Display the contents of the heading in full by default

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Heading/Priority
Description

Sort priority of the heading, with lower priorities appearing first

Type

Integer

Undefined values

Not permitted

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Heading/Text
Description

Text displayed by the heading

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/HeadingUnique
Description

Exclusion key allowing only a single message with the same key in same heading

Type

Text

Undefined values

Disabled

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/MessageUnique
Description

Exclusion key allowing only a single message with the same key in the entire email

Type

Text

Undefined values

Disabled

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type
Description

The type of the message entry in the email

Type

Enumeration

Values

This is an enumeration value. It accepts a single string (not case sensitive) from a list of possible choices. Possible values:

  • Text, Message, or String - A simple text message in the email

  • Image or PNG - An image displayed in the email

  • List - An list of text messages

  • Table - A table of text messages

  • Break - An explict break between components of the message

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Image
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = Image

Description

Raw PNG format image data

Type

Binary, data are raw bytes

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Border
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = Table

Description

Display a border around the table

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Color
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = Table

Description

Color code of all text in the table

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/ColumnHeadingColor
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = Table

Description

Column headings font color

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/ColumnHeadingColor/#0
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = Table

Description

Column heading color

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/ColumnHeadingSize
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = Table

Description

Column headings font size

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/ColumnHeadingSize/#0
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = Table

Description

Column heading point size

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/ColumnHeadings
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = Table

Description

Column headings text

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/ColumnHeadings/#0
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = Table

Description

Column heading

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Columns
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = Table

Description

Table data, by column

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Columns/#0
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = Table

Description

Table column data

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Columns/#0/#0
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = Table

Description

Table row data

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Size
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = Table

Description

Point size of all text in the table

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Items
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = List

Description

List item data

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Items/#0/Color
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = List

Description

Color code of the displayed text

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Items/#0/Link
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = List

Description

Link URL of the list item text

Type

Text

Undefined values

No link

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Items/#0/Size
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = List

Description

Point size of the displayed text

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Items/#0/Text
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = List

Description

List item text

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Always
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = Break

Description

Always add the break, even if it is the first item in the heading or message

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Color
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = Text

Description

Color code of the displayed text

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Continue
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = Text

Description

Continue text display, instead of adding an implied line break

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Link
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = Text

Description

Link URL of the displayed text

Type

Text

Undefined values

No link

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Size
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = Text

Description

Point size of the displayed text

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Text
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/After/#0/Type = Text

Description

Displayed text

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before
Description

Message contents generated before any condition or global messages when any trigger is met

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Heading/DefaultOpen
Description

Display the contents of the heading in full by default

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Heading/Priority
Description

Sort priority of the heading, with lower priorities appearing first

Type

Integer

Undefined values

Not permitted

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Heading/Text
Description

Text displayed by the heading

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/HeadingUnique
Description

Exclusion key allowing only a single message with the same key in same heading

Type

Text

Undefined values

Disabled

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/MessageUnique
Description

Exclusion key allowing only a single message with the same key in the entire email

Type

Text

Undefined values

Disabled

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type
Description

The type of the message entry in the email

Type

Enumeration

Values

This is an enumeration value. It accepts a single string (not case sensitive) from a list of possible choices. Possible values:

  • Text, Message, or String - A simple text message in the email

  • Image or PNG - An image displayed in the email

  • List - An list of text messages

  • Table - A table of text messages

  • Break - An explict break between components of the message

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Image
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = Image

Description

Raw PNG format image data

Type

Binary, data are raw bytes

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Border
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = Table

Description

Display a border around the table

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Color
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = Table

Description

Color code of all text in the table

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/ColumnHeadingColor
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = Table

Description

Column headings font color

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/ColumnHeadingColor/#0
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = Table

Description

Column heading color

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/ColumnHeadingSize
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = Table

Description

Column headings font size

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/ColumnHeadingSize/#0
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = Table

Description

Column heading point size

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/ColumnHeadings
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = Table

Description

Column headings text

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/ColumnHeadings/#0
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = Table

Description

Column heading

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Columns
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = Table

Description

Table data, by column

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Columns/#0
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = Table

Description

Table column data

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Columns/#0/#0
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = Table

Description

Table row data

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Size
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = Table

Description

Point size of all text in the table

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Items
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = List

Description

List item data

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Items/#0/Color
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = List

Description

Color code of the displayed text

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Items/#0/Link
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = List

Description

Link URL of the list item text

Type

Text

Undefined values

No link

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Items/#0/Size
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = List

Description

Point size of the displayed text

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Items/#0/Text
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = List

Description

List item text

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Always
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = Break

Description

Always add the break, even if it is the first item in the heading or message

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Color
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = Text

Description

Color code of the displayed text

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Continue
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = Text

Description

Continue text display, instead of adding an implied line break

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Link
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = Text

Description

Link URL of the displayed text

Type

Text

Undefined values

No link

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Size
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = Text

Description

Point size of the displayed text

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Text
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Before/#0/Type = Text

Description

Displayed text

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Input
Description

Input data to the whole trigger

Type

Sequence Selection

Structure

A sequence selection is a means of selecting a sequence of values in the data. The specification consists of selections for the various components of the sequence name.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Heading/DefaultOpen
Description

Display the contents of the heading in full by default

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Heading/Priority
Description

Sort priority of the heading, with lower priorities appearing first

Type

Integer

Undefined values

Not permitted

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Heading/Text
Description

Text displayed by the heading

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/HeadingUnique
Description

Exclusion key allowing only a single message with the same key in same heading

Type

Text

Undefined values

Disabled

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/MessageUnique
Description

Exclusion key allowing only a single message with the same key in the entire email

Type

Text

Undefined values

Disabled

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type
Description

The type of the message entry in the email

Type

Enumeration

Values

This is an enumeration value. It accepts a single string (not case sensitive) from a list of possible choices. Possible values:

  • Text, Message, or String - A simple text message in the email

  • Image or PNG - An image displayed in the email

  • List - An list of text messages

  • Table - A table of text messages

  • Break - An explict break between components of the message

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Image
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = Image

Description

Raw PNG format image data

Type

Binary, data are raw bytes

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Border
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = Table

Description

Display a border around the table

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Color
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = Table

Description

Color code of all text in the table

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/ColumnHeadingColor
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = Table

Description

Column headings font color

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/ColumnHeadingColor/#0
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = Table

Description

Column heading color

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/ColumnHeadingSize
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = Table

Description

Column headings font size

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/ColumnHeadingSize/#0
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = Table

Description

Column heading point size

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/ColumnHeadings
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = Table

Description

Column headings text

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/ColumnHeadings/#0
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = Table

Description

Column heading

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Columns
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = Table

Description

Table data, by column

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Columns/#0
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = Table

Description

Table column data

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Columns/#0/#0
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = Table

Description

Table row data

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Size
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = Table

Description

Point size of all text in the table

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Items
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = List

Description

List item data

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Items/#0/Color
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = List

Description

Color code of the displayed text

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Items/#0/Link
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = List

Description

Link URL of the list item text

Type

Text

Undefined values

No link

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Items/#0/Size
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = List

Description

Point size of the displayed text

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Items/#0/Text
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = List

Description

List item text

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Always
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = Break

Description

Always add the break, even if it is the first item in the heading or message

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Color
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = Text

Description

Color code of the displayed text

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Continue
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = Text

Description

Continue text display, instead of adding an implied line break

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Link
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = Text

Description

Link URL of the displayed text

Type

Text

Undefined values

No link

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Size
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = Text

Description

Point size of the displayed text

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Text
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Message/Type = Text

Description

Displayed text

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Output
Description

The output message when any condition is met

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters
Description

Trigger instance parameters

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Data
Description

Output data selection for trigger presence information

Type

Sequence Selection

Structure

A sequence selection is a means of selecting a sequence of values in the data. The specification consists of selections for the various components of the sequence name.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Heading/DefaultOpen
Description

Display the contents of the heading in full by default

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Heading/Priority
Description

Sort priority of the heading, with lower priorities appearing first

Type

Integer

Undefined values

Not permitted

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Heading/Text
Description

Text displayed by the heading

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/HeadingUnique
Description

Exclusion key allowing only a single message with the same key in same heading

Type

Text

Undefined values

Disabled

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/MessageUnique
Description

Exclusion key allowing only a single message with the same key in the entire email

Type

Text

Undefined values

Disabled

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type
Description

The type of the message entry in the email

Type

Enumeration

Values

This is an enumeration value. It accepts a single string (not case sensitive) from a list of possible choices. Possible values:

  • Text, Message, or String - A simple text message in the email

  • Image or PNG - An image displayed in the email

  • List - An list of text messages

  • Table - A table of text messages

  • Break - An explict break between components of the message

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Image
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = Image

Description

Raw PNG format image data

Type

Binary, data are raw bytes

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Border
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = Table

Description

Display a border around the table

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Color
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = Table

Description

Color code of all text in the table

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/ColumnHeadingColor
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = Table

Description

Column headings font color

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/ColumnHeadingColor/#0
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = Table

Description

Column heading color

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/ColumnHeadingSize
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = Table

Description

Column headings font size

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/ColumnHeadingSize/#0
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = Table

Description

Column heading point size

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/ColumnHeadings
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = Table

Description

Column headings text

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/ColumnHeadings/#0
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = Table

Description

Column heading

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Columns
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = Table

Description

Table data, by column

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Columns/#0
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = Table

Description

Table column data

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Columns/#0/#0
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = Table

Description

Table row data

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Size
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = Table

Description

Point size of all text in the table

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Items
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = List

Description

List item data

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Items/#0/Color
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = List

Description

Color code of the displayed text

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Items/#0/Link
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = List

Description

Link URL of the list item text

Type

Text

Undefined values

No link

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Items/#0/Size
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = List

Description

Point size of the displayed text

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Items/#0/Text
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = List

Description

List item text

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Always
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = Break

Description

Always add the break, even if it is the first item in the heading or message

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Color
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = Text

Description

Color code of the displayed text

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Continue
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = Text

Description

Continue text display, instead of adding an implied line break

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Link
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = Text

Description

Link URL of the displayed text

Type

Text

Undefined values

No link

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Size
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = Text

Description

Point size of the displayed text

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Text
Required conditions
  • /DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Message/Type = Text

Description

Displayed text

Type

Text

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Output
Description

The output message when the specific condition is met

Type

Text

Undefined values

Only the global message is generated

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/RequireLatest
Description

Require the condition to be present in the latest data

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Threshold/Count
Description

The minimum number of events (data values) required for the trigger to be considered active

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Threshold/Time
Description

The minimum covered amount of time required for the trigger to be considered active

Type

Real number

Valid range

0.0 ≤ value

Units

s

Undefined values

Any amount of time

/DataTrigger/<PROFILE>/<IDENTIFIER>/Parameters/#0/Trigger
Description

Message trigger condition

Type

Trigger

Structure

An edit trigger is a means of detecting a condition in the data stream. For example, it can compare a value to a threshold and only take action when the value exceeds the threshold.

/Events
Description

Email event summary message configuration

Keys

The keys immediately below this are profile names that are selected by the application. For example, aerosol is the commonly used default profile. However, any non-empty name is acceptable and can be used to create customized configurations that can be selected at run time. In general, profile names should be all lower case to preserve case insensitivity. In the paths listed <PROFILE> is used as a placeholder to real profile name (e.g. replace <PROFILE> with aerosol for the default profile).

/Events/<PROFILE>/Messages
Description

Matched messages added to the email

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/Events/<PROFILE>/Messages/#0/CaseSensitive
Description

Use case sensitive matching for the text and source

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/Events/<PROFILE>/Messages/#0/Output
Description

Output text in the email

Type

Text

Undefined values

The matched event text

/Events/<PROFILE>/Messages/#0/Source
Description

Event source code to match

Type

Text

/Events/<PROFILE>/Messages/#0/Text
Description

Event text to match, with captures provided to the output substitutions

Type

Text

/Events/<PROFILE>/Summary
Description

Summary count messages added to the email

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/Events/<PROFILE>/Summary/#0/CaseSensitive
Description

Use case sensitive matching for the text and source

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/Events/<PROFILE>/Summary/#0/Output
Description

Output text in the email

Type

Text

Undefined values

The matched event text

/Events/<PROFILE>/Summary/#0/Source
Description

Event source code to match

Type

Text

/Events/<PROFILE>/Summary/#0/Text
Description

Event text to match, with captures provided to the output substitutions

Type

Text

/HasUpdated
Description

Email updated incoming data check configuration

Keys

The keys immediately below this are profile names that are selected by the application. For example, aerosol is the commonly used default profile. However, any non-empty name is acceptable and can be used to create customized configurations that can be selected at run time. In general, profile names should be all lower case to preserve case insensitivity. In the paths listed <PROFILE> is used as a placeholder to real profile name (e.g. replace <PROFILE> with aerosol for the default profile).

/HasUpdated/<PROFILE>/AcceptAny
Description

Accept any present data, even undefined values

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/HasUpdated/<PROFILE>/Input
Description

Input data to check for updates on

Type

Sequence Selection

Structure

A sequence selection is a means of selecting a sequence of values in the data. The specification consists of selections for the various components of the sequence name.

/HasUpdated/<PROFILE>/Maximum
Description

The maximum time behind the email time to check before assuming that the station is down

Type

Time Interval

Structure

A time interval consists of a time unit, a number of units to apply, and an alignment setting.

Undefined values

30 days

/HasUpdated/<PROFILE>/Maximum/Units
Description

A logical time unit

Type

Enumeration

Values

This is an enumeration value. It accepts a single string (not case sensitive) from a list of possible choices. Possible values:

  • Millisecond or Milliseconds

  • Second, Sec, Seconds, Secs, or s

  • Minute, Min, Mins, Minutes, m, or mi

  • Hour, Hours, or h

  • Day, Days, or d

  • Week, Weeks, or w

  • Month, Mon, Mons, Months, or mo

  • Quarter, Qtr, Qtrs, Quarters, or q

  • Year, Years, or y

/HasUpdated/<PROFILE>/Maximum/Count
Description

The number of units to apply in time

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/HasUpdated/<PROFILE>/Maximum/Align
Description

Align units in logical time

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/HasUpdated/<PROFILE>/Output
Description

The warning text generated in the email

Type

Text

/HasUpdated/<PROFILE>/Warning
Description

The time behind the email time to output the warning message

Type

Time Interval

Structure

A time interval consists of a time unit, a number of units to apply, and an alignment setting.

Undefined values

17 hours

/HasUpdated/<PROFILE>/Warning/Units
Description

A logical time unit

Type

Enumeration

Values

This is an enumeration value. It accepts a single string (not case sensitive) from a list of possible choices. Possible values:

  • Millisecond or Milliseconds

  • Second, Sec, Seconds, Secs, or s

  • Minute, Min, Mins, Minutes, m, or mi

  • Hour, Hours, or h

  • Day, Days, or d

  • Week, Weeks, or w

  • Month, Mon, Mons, Months, or mo

  • Quarter, Qtr, Qtrs, Quarters, or q

  • Year, Years, or y

/HasUpdated/<PROFILE>/Warning/Count
Description

The number of units to apply in time

Type

Integer

Valid range

0 ≤ value

Undefined values

Not permitted

/HasUpdated/<PROFILE>/Warning/Align
Description

Align units in logical time

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/NewValues
Description

Email new value triggered message configuration

Keys

The keys immediately below this are profile names that are selected by the application. For example, aerosol is the commonly used default profile. However, any non-empty name is acceptable and can be used to create customized configurations that can be selected at run time. In general, profile names should be all lower case to preserve case insensitivity. In the paths listed <PROFILE> is used as a placeholder to real profile name (e.g. replace <PROFILE> with aerosol for the default profile).

/NewValues/<PROFILE>
Description

Email value trigger profile configuration

Keys

The keys immediately below this are unique names selected by the user. These names can be any non-empty text and are generally used to designate different components to be configured. In the paths listed <IDENTIFIER> is used as a placeholder to real name selected during configuration.

/NewValues/<PROFILE>/<IDENTIFIER>/AlwaysBreak
Description

Unconditionally generate a break between detected events

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/NewValues/<PROFILE>/<IDENTIFIER>/ForceBreak
Description

Always generate a break in the email even if this is the first detected event

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/NewValues/<PROFILE>/<IDENTIFIER>/LatestOnly
Description

Only trigger once, on the latest updated value

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/NewValues/<PROFILE>/<IDENTIFIER>/Output
Description

Output text generated for each updated value, script substitution is available with the value on the "data" global, returning the text to replace

Type

Text

/NewValues/<PROFILE>/<IDENTIFIER>/Read
Description

The set of data to read

Type

Sequence Selection

Structure

A sequence selection is a means of selecting a sequence of values in the data. The specification consists of selections for the various components of the sequence name.

/NewValues/<PROFILE>/<IDENTIFIER>/Selection
Description

The selected data to trigger on

Type

Sequence Selection

Structure

A sequence selection is a means of selecting a sequence of values in the data. The specification consists of selections for the various components of the sequence name.

/Send
Description

Email send configuration

Keys

The keys immediately below this are profile names that are selected by the application. For example, aerosol is the commonly used default profile. However, any non-empty name is acceptable and can be used to create customized configurations that can be selected at run time. In general, profile names should be all lower case to preserve case insensitivity. In the paths listed <PROFILE> is used as a placeholder to real profile name (e.g. replace <PROFILE> with aerosol for the default profile).

/Send/<PROFILE>/Actions
Description

Actions to invoke to create the email contents

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/Send/<PROFILE>/DataExtend
Description

Extend the amount of time inspected based on any data matched

Type

Sequence Selection

Structure

A sequence selection is a means of selecting a sequence of values in the data. The specification consists of selections for the various components of the sequence name.

/Send/<PROFILE>/Headings
Description

Override contents for the headings in the email, keyed on the text

Keys

The keys immediately below this are unique names selected by the user. These names can be any non-empty text and are generally used to designate different components to be configured. In the paths listed <IDENTIFIER> is used as a placeholder to real name selected during configuration.

/Send/<PROFILE>/Headings/<IDENTIFIER>/DefaultOpen
Description

Default the heading to be non-collapsed

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/Send/<PROFILE>/Headings/<IDENTIFIER>/Priority
Description

The sort priority of the heading

Type

Integer

Undefined values

Not permitted

/Send/<PROFILE>/MaximumAge
Description

The maximum age back from the current time to inspect for data based time extension

Type

Time Interval

Structure

A time interval consists of a time unit, a number of units to apply, and an alignment setting.

/Send/<PROFILE>/MaximumAge/Units
Description

A logical time unit

Type

Enumeration

Values

This is an enumeration value. It accepts a single string (not case sensitive) from a list of possible choices. Possible values:

  • Millisecond or Milliseconds

  • Second, Sec, Seconds, Secs, or s

  • Minute, Min, Mins, Minutes, m, or mi

  • Hour, Hours, or h

  • Day, Days, or d

  • Week, Weeks, or w

  • Month, Mon, Mons, Months, or mo

  • Quarter, Qtr, Qtrs, Quarters, or q

  • Year, Years, or y

/Send/<PROFILE>/MaximumAge/Count
Description

The number of units to apply in time

Type

Integer

Undefined values

Not permitted

/Send/<PROFILE>/MaximumAge/Align
Description

Align units in logical time

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/Send/<PROFILE>/ProcessingLog/Disable
Description

Do not output or clear the log of incoming files processed

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/Send/<PROFILE>/ProcessingLog/Preserve
Description

Preserve the log of files processed instead of clearing it

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/Send/<PROFILE>/Recipients
Description

The recipients of the email, with the keys as the address

Keys

The keys immediately below this are unique names selected by the user. These names can be any non-empty text and are generally used to designate different components to be configured. In the paths listed <IDENTIFIER> is used as a placeholder to real name selected during configuration.

/Send/<PROFILE>/Recipients/<IDENTIFIER>
Description

A recipient of the email

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/Send/<PROFILE>/RecipientsFile
Description

A file to load recipients from, each line is an address and a comma separated list of regular expressions to match stations

Type

Text

/Send/<PROFILE>/Relay/From
Description

Address to list as in the "From:" header

Type

Text

Undefined values

Filled by the server

/Send/<PROFILE>/Relay/Hostname
Description

Hostname to use as the SMTP relay

Type

Text

Undefined values

Local program, then direct SMTP connection

/Send/<PROFILE>/Relay/Password
Description

Password presented to the relay server

Type

Text

/Send/<PROFILE>/Relay/PasswordFile
Description

A file to read the SMTP relay password from

Type

Text

/Send/<PROFILE>/Relay/Port
Description

SMTP relay connection port

Type

Integer

Valid range

1 ≤ value ≤ 65535

Undefined values

Not permitted

/Send/<PROFILE>/Relay/Program
Description

Local program used to send an email

Type

Text

Undefined values

Direct connection if no relay is present

/Send/<PROFILE>/Relay/TLS
Description

Use a secured SSL/TLS connection

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/Send/<PROFILE>/Relay/Username
Description

Username presented to the relay server

Type

Text

/Send/<PROFILE>/Subject
Description

The subject line of the email

Type

Text

/TimeCheck
Description

Time synchronization checking configuration

Keys

The keys immediately below this are profile names that are selected by the application. For example, aerosol is the commonly used default profile. However, any non-empty name is acceptable and can be used to create customized configurations that can be selected at run time. In general, profile names should be all lower case to preserve case insensitivity. In the paths listed <PROFILE> is used as a placeholder to real profile name (e.g. replace <PROFILE> with aerosol for the default profile).

/TimeCheck/<PROFILE>/AheadMessage
Description

Email message text generated when the remote time is ahead of the local time

Type

Text

Undefined values

The general warning text

/TimeCheck/<PROFILE>/BehindMessage
Description

Email message text generated when the remote time is behind of the local time

Type

Text

Undefined values

The general warning text

/TimeCheck/<PROFILE>/Heartbeat/Extract
Description

Contents extracted for time assembly from the file

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/TimeCheck/<PROFILE>/Heartbeat/Extract/#0/CaseSensitive
Description

Match the line contents in case sensitive mode

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/TimeCheck/<PROFILE>/Heartbeat/Extract/#0/Line
Description

The line number (from one) in the file to evaluate the match on

Type

Integer

Valid range

1 ≤ value

Undefined values

Any line

/TimeCheck/<PROFILE>/Heartbeat/Extract/#0/Match
Description

Line contents to match

Type

Text

/TimeCheck/<PROFILE>/Heartbeat/Path
Description

Path of the heartbeat file

Type

Text

/TimeCheck/<PROFILE>/Heartbeat/ReferenceModified
Description

Use the file modified time as the reference for time extraction in the file contents

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/TimeCheck/<PROFILE>/Heartbeat/Require
Description

Required match lines before the file is considered valid

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/TimeCheck/<PROFILE>/Heartbeat/Require/#0/Below
Description

Require the captured value to be below the threshold

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/TimeCheck/<PROFILE>/Heartbeat/Require/#0/CaseSensitive
Description

Match the line contents in case sensitive mode

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/TimeCheck/<PROFILE>/Heartbeat/Require/#0/Line
Description

The line number (from one) in the file to evaluate the match on

Type

Integer

Valid range

1 ≤ value

Undefined values

Any line

/TimeCheck/<PROFILE>/Heartbeat/Require/#0/Match
Description

Line contents to match

Type

Text

/TimeCheck/<PROFILE>/Heartbeat/Require/#0/Threshold
Description

A required threshold for the first capture of the match

Type

Real number

Undefined values

Not permitted

/TimeCheck/<PROFILE>/Latest/Contents/Extract
Description

Contents extracted for time assembly from the file

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/TimeCheck/<PROFILE>/Latest/Contents/Extract/#0/CaseSensitive
Description

Match the line contents in case sensitive mode

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/TimeCheck/<PROFILE>/Latest/Contents/Extract/#0/Line
Description

The line number (from one) in the file to evaluate the match on

Type

Integer

Valid range

1 ≤ value

Undefined values

Any line

/TimeCheck/<PROFILE>/Latest/Contents/Extract/#0/Match
Description

Line contents to match

Type

Text

/TimeCheck/<PROFILE>/Latest/Contents/ReferenceModified
Description

Use the file modified time as the reference for time extraction in the file contents

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/TimeCheck/<PROFILE>/Latest/Contents/Require
Description

Required match lines before the file is considered valid

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/TimeCheck/<PROFILE>/Latest/Contents/Require/#0/Below
Description

Require the captured value to be below the threshold

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/TimeCheck/<PROFILE>/Latest/Contents/Require/#0/CaseSensitive
Description

Match the line contents in case sensitive mode

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/TimeCheck/<PROFILE>/Latest/Contents/Require/#0/Line
Description

The line number (from one) in the file to evaluate the match on

Type

Integer

Valid range

1 ≤ value

Undefined values

Any line

/TimeCheck/<PROFILE>/Latest/Contents/Require/#0/Match
Description

Line contents to match

Type

Text

/TimeCheck/<PROFILE>/Latest/Contents/Require/#0/Threshold
Description

A required threshold for the first capture of the match

Type

Real number

Undefined values

Not permitted

/TimeCheck/<PROFILE>/Latest/Filter
Description

File within the path to match

Type

Text

/TimeCheck/<PROFILE>/Latest/Path
Description

Path of incoming files to inspect

Type

Text

/TimeCheck/<PROFILE>/Latest/ReferenceModified
Description

Use the file modified time as the reference for time extraction in the filename

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/TimeCheck/<PROFILE>/Loss
Description

The maximum time behind the current time before assuming that data is not being received

Type

Time Interval

Structure

A time interval consists of a time unit, a number of units to apply, and an alignment setting.

Undefined values

18 hours

/TimeCheck/<PROFILE>/Loss/Units
Description

A logical time unit

Type

Enumeration

Values

This is an enumeration value. It accepts a single string (not case sensitive) from a list of possible choices. Possible values:

  • Millisecond or Milliseconds

  • Second, Sec, Seconds, Secs, or s

  • Minute, Min, Mins, Minutes, m, or mi

  • Hour, Hours, or h

  • Day, Days, or d

  • Week, Weeks, or w

  • Month, Mon, Mons, Months, or mo

  • Quarter, Qtr, Qtrs, Quarters, or q

  • Year, Years, or y

/TimeCheck/<PROFILE>/Loss/Count
Description

The number of units to apply in time

Type

Integer

Valid range

0 ≤ value

Undefined values

Not permitted

/TimeCheck/<PROFILE>/Loss/Align
Description

Align units in logical time

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/TimeCheck/<PROFILE>/LossMessage
Description

Email message text generated when data is not being received

Type

Text

Undefined values

The general warning text

/TimeCheck/<PROFILE>/Message/Heading/DefaultOpen
Description

Display the contents of the heading in full by default

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/TimeCheck/<PROFILE>/Message/Heading/Priority
Description

Sort priority of the heading, with lower priorities appearing first

Type

Integer

Undefined values

Not permitted

/TimeCheck/<PROFILE>/Message/Heading/Text
Description

Text displayed by the heading

Type

Text

/TimeCheck/<PROFILE>/Message/HeadingUnique
Description

Exclusion key allowing only a single message with the same key in same heading

Type

Text

Undefined values

Disabled

/TimeCheck/<PROFILE>/Message/MessageUnique
Description

Exclusion key allowing only a single message with the same key in the entire email

Type

Text

Undefined values

Disabled

/TimeCheck/<PROFILE>/Message/Type
Description

The type of the message entry in the email

Type

Enumeration

Values

This is an enumeration value. It accepts a single string (not case sensitive) from a list of possible choices. Possible values:

  • Text, Message, or String - A simple text message in the email

  • Image or PNG - An image displayed in the email

  • List - An list of text messages

  • Table - A table of text messages

  • Break - An explict break between components of the message

/TimeCheck/<PROFILE>/Message/Image
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = Image

Description

Raw PNG format image data

Type

Binary, data are raw bytes

/TimeCheck/<PROFILE>/Message/Border
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = Table

Description

Display a border around the table

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/TimeCheck/<PROFILE>/Message/Color
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = Table

Description

Color code of all text in the table

Type

Text

/TimeCheck/<PROFILE>/Message/ColumnHeadingColor
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = Table

Description

Column headings font color

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/TimeCheck/<PROFILE>/Message/ColumnHeadingColor/#0
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = Table

Description

Column heading color

Type

Text

/TimeCheck/<PROFILE>/Message/ColumnHeadingSize
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = Table

Description

Column headings font size

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/TimeCheck/<PROFILE>/Message/ColumnHeadingSize/#0
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = Table

Description

Column heading point size

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/TimeCheck/<PROFILE>/Message/ColumnHeadings
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = Table

Description

Column headings text

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/TimeCheck/<PROFILE>/Message/ColumnHeadings/#0
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = Table

Description

Column heading

Type

Text

/TimeCheck/<PROFILE>/Message/Columns
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = Table

Description

Table data, by column

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/TimeCheck/<PROFILE>/Message/Columns/#0
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = Table

Description

Table column data

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/TimeCheck/<PROFILE>/Message/Columns/#0/#0
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = Table

Description

Table row data

Type

Text

/TimeCheck/<PROFILE>/Message/Size
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = Table

Description

Point size of all text in the table

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/TimeCheck/<PROFILE>/Message/Items
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = List

Description

List item data

Keys

The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example, #0 is the first element of the array. The paths represented here use #0 as a placeholder for all indices.

/TimeCheck/<PROFILE>/Message/Items/#0/Color
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = List

Description

Color code of the displayed text

Type

Text

/TimeCheck/<PROFILE>/Message/Items/#0/Link
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = List

Description

Link URL of the list item text

Type

Text

Undefined values

No link

/TimeCheck/<PROFILE>/Message/Items/#0/Size
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = List

Description

Point size of the displayed text

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/TimeCheck/<PROFILE>/Message/Items/#0/Text
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = List

Description

List item text

Type

Text

/TimeCheck/<PROFILE>/Message/Always
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = Break

Description

Always add the break, even if it is the first item in the heading or message

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/TimeCheck/<PROFILE>/Message/Color
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = Text

Description

Color code of the displayed text

Type

Text

/TimeCheck/<PROFILE>/Message/Continue
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = Text

Description

Continue text display, instead of adding an implied line break

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/TimeCheck/<PROFILE>/Message/Link
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = Text

Description

Link URL of the displayed text

Type

Text

Undefined values

No link

/TimeCheck/<PROFILE>/Message/Size
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = Text

Description

Point size of the displayed text

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/TimeCheck/<PROFILE>/Message/Text
Required conditions
  • /TimeCheck/<PROFILE>/Message/Type = Text

Description

Displayed text

Type

Text

/TimeCheck/<PROFILE>/NoTimeMessage
Description

Email message text generated when no time information is available

Type

Text

/TimeCheck/<PROFILE>/StationDown
Description

The maximum time behind the email time to check before assuming that the station is down

Type

Time Interval

Structure

A time interval consists of a time unit, a number of units to apply, and an alignment setting.

Undefined values

31 days

/TimeCheck/<PROFILE>/StationDown/Units
Description

A logical time unit

Type

Enumeration

Values

This is an enumeration value. It accepts a single string (not case sensitive) from a list of possible choices. Possible values:

  • Millisecond or Milliseconds

  • Second, Sec, Seconds, Secs, or s

  • Minute, Min, Mins, Minutes, m, or mi

  • Hour, Hours, or h

  • Day, Days, or d

  • Week, Weeks, or w

  • Month, Mon, Mons, Months, or mo

  • Quarter, Qtr, Qtrs, Quarters, or q

  • Year, Years, or y

/TimeCheck/<PROFILE>/StationDown/Count
Description

The number of units to apply in time

Type

Integer

Valid range

1 ≤ value

Undefined values

Not permitted

/TimeCheck/<PROFILE>/StationDown/Align
Description

Align units in logical time

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/TimeCheck/<PROFILE>/Threshold
Description

The maximum difference between the local and remote times before generating a difference warning

Type

Time Interval

Structure

A time interval consists of a time unit, a number of units to apply, and an alignment setting.

Undefined values

2 minutes

/TimeCheck/<PROFILE>/Threshold/Units
Description

A logical time unit

Type

Enumeration

Values

This is an enumeration value. It accepts a single string (not case sensitive) from a list of possible choices. Possible values:

  • Millisecond or Milliseconds

  • Second, Sec, Seconds, Secs, or s

  • Minute, Min, Mins, Minutes, m, or mi

  • Hour, Hours, or h

  • Day, Days, or d

  • Week, Weeks, or w

  • Month, Mon, Mons, Months, or mo

  • Quarter, Qtr, Qtrs, Quarters, or q

  • Year, Years, or y

/TimeCheck/<PROFILE>/Threshold/Count
Description

The number of units to apply in time

Type

Integer

Valid range

0 ≤ value

Undefined values

Not permitted

/TimeCheck/<PROFILE>/Threshold/Align
Description

Align units in logical time

Type

Boolean, values are TRUE or FALSE and defaults to FALSE

/TimeCheck/<PROFILE>/WarningMessage
Description

Email message text generated when there is an anomoly in the remote time

Type

Text