Alert Types and Alert Field Reference#

For alert codes also see:

Error Messages and SNMP Traps in the Platform Guide.

Database Maintenance Alerts#

If database maintenance schedules have not been set up from the Command Line Interface (CLI), alerts are shown at the provider level hierarchy for each required schedule.

The schedules are required to periodically:

  • Archive or delete database transaction logs (CLI: voss transaction archive or voss transaction delete)

Refer to the Platform Guide topic “Enable Database Scheduling ” for details.

The format of the alert is:

  • ID: A generated identifier:

    • TRANSACTION_DATABASE-<hostname>

    Note

    The <hostname> will be a primary unified node. These are where alerts are generated.

  • Code: An error or warning code associated with the alert. (-1)

  • Alert category: Database Maintenance

  • Severity: Warning

  • Message:

    • TRANSACTION DATABASE MAINTENANCE NOT SCHEDULED

  • Count: Displays the number of times the alert has occurred.

  • Latest Alert: Displays the last time this alert occurred.

Alert Code

Alert ID

Alert Category

-1

TRANSACTION_DATABASE-<hostname>

Database Maintenance

-1

CACHE_DATABASE-<hostname>

Database Maintenance

Licensing#

Alert Code

Alert ID

Alert Category

36200

Hierarchy Resolution Failure

Licensing

36100

License Audit File Transfer or data/SmtpDestination, data/HttpDestination, etc.

License Audit File Transfer

Change Notification#

Alert Code

Alert ID

Alert Category

calling exception code: 40000-40006, 40008

device pkid OR business key

Device Change Notification Collector <model type>

Number Inventory Alerts#

If alerts have been enabled on available number inventory numbers in global settings, alerts are raised when the availability threshold is exceeded. See: Global Settings.

Alert Code

Alert ID

Alert Category

110000

Number Inventory Threshold of {{ pwf.INI_ALERT_THRESHOLD }}% Exceeded …

Number Inventory

In the GUI, the alert Message field also provides details on the INI threshold, availability, hierarchy, count and a CSV list of nodes and numbers, as shown in the alert message template below. (Long message strings are truncated). For details on macro references, refer to Email HTML Templates:

{{ pwf.INI_ALERT_HIERARCHY_NODE_TYPE }} [{{ pwf.INI_ALERT_HIERARCHY_NAME }}].
Hierarchy full path = {{ pwf.INI_ALERT_HIERARCHY }}
Total INI Available = {{ pwf.INI_ALERT_TOTAL_INI_AVAILABLE }}
Total INI count = {{ pwf.INI_ALERT_TOTAL_INI_COUNT }}
Total percent available = {{ fn.as_string pwf.INI_ALERT_TOTAL_PERCENT_AVAILABLE }}%

{{ pwf.INI_ALERT_NODES_EXCEEDED_THRESHOLD_DATA_ALERT }}

Important

  • If alerts have been enabled, a schedule called “InternalNumberInventoryAlert” is also created that is by default set to run daily if the availability threshold in the global settings is exceeded. For schedule management, see Scheduling.

Alert Field Reference#

  • The field Title is indicated in bold. An asterisk * indicates the field is mandatory.

  • If the field Type is an array, its the Field Name has a .[n] suffix, where n is the array index placeholder.

  • Object and array names are listed to provide the context of fields.

  • If a field belongs to an object or an array, the full name is in dot separated notation.

  • Where cardinality is shown, the range is [MinItems..MaxItems].

  • If a field has a Default value, the value is shown.

  • If a field has a Pattern, the regular expression pattern is shown.

ID *

Field Name

alert_id

Description

The unique ID of the alert

Type

String

Code *

Field Name

alert_code

Description

The code of the alert

Type

String

Category *

Field Name

alert_category

Description

The category of the alert

Type

String

Severity

Field Name

alert_severity

Description

The severity of the alert

Type

String

Choices

[“Error”, “Warning”, “Info”]

Message

Field Name

alert_message

Description

The message describing the alert

Type

String

Count

Field Name

alert_count

Description

The number of times this alert has occurred

Type

Integer

Latest Alert

Field Name

alert_timestamp

Description

The last time this alert occurred

Type

String

Format

date-time