Dictionary for monitoring

Dictionaries for monitoring – special dictionary type for storing data used to configure monitoring sensors. Functionally, such dictionaries are identical to the normal dictionaries.

Dictionaries for monitoring are configured using a separate configuration menu and have their own REST API methods.

Dictionaries for monitoring can be grouped together using Dictionary groups for monitoring.

Named fields

Every value of the dictionary can be assigned a name. For example, the dictionary that stores the information about water meters could look like this:

named fields
Example of a dictionary with named fields

Named fields can be used when using dictionary values as variables. You can find out more in the Use property values as variables section.

You can assign names to fields only when importing a dictionary from an Excel file. In the current version of SAYMON UI you cannot rename columns.

To import named field, the table should have a format like this:

Name

Serial number

Commissioning

SDM630CT

MKL68JLASKH8

24.03.2021

EMLITE ECA2

GRY9RK635VQM

16.09.2023

SDM120CT

AA8RQPVD3JL8

03.11.2024

Encrypted fields

Fields in the dictionaries can be encrypted. To do this, field name must contain the word password (case insensitive). To change the value of encrypted fields, you must reenter its value in the corresponding field. These values can only be read and used on the server.

encrypted

Internally, encrypted fields look like this:

{
    "content": "{\"john.doe\":\"<<crypt:8D0E4E0C1EFC3D4533005804379270C8:96CB2385E0E693D391DD69A156088C46ACAEBEF2C7266993509723F7ECA7DE42>>\",\"jane.doe\":\"<<crypt:280B6896DECF67A730AC1AE011B254FF:0BF81AAF0B206712967008CA9BC9367C>>\"}",
}
To use encrypted field, you must enable encryption in the server configuration. Without this configuration, the values will not be encrypted, just hidden in the web interface.

Indexing fields

You can access dictionary fields the same way you would access elements of an array. This is used when changing how dictionary values are displayed in property classes and when substituting dictionary values ​​as variables in notification templates, monitoring parameters, state change conditions, and other places in the system.

Dictionaries use the following indexing:

Element index Value

0

Key

1 .. N

Dictionary values. N – number of entries in a dictionary.

N + 1, negative values

undefined.

System dictionaries

The system has special dictionaries for monitoring used for authentication in some built-in sensors.

These dictionaries are in the "System group" group with the ID system. You can’t rename or change the ID of this group.

This group has the following dictionaries:

System group and dictionaries are created by default.

Connection credentials

This dictionary contains credentials that can be used for authentication in the following checks:

This dictionary has the following fields:

  • id

  • name

  • description

  • comment

  • domain

  • user

  • password

  • privateKey

SNMP connection credentials

This dictionary contains credentials that can be used for authentication in the SNMP checks.

This dictionary has the following fields:

  • id

  • name

  • description

  • comment

  • communityRead

  • communityWrite

  • domain

  • user

  • authPassword

  • authType

  • privPassword

  • privType

Login format

This dictionary contains login formats for various checks.

This dictionary has the following fields:

  • id

  • login_format

  • description

  • comment

Dictionary for monitoring model

Field Type Description

columns

Object

Names of key and values of a dictionary. Only included in the dictionaries with named columns.

Defined as a JSON object in the following format:

"columns": {
    "0": {
        "name": "key_name"
    },
    "1": {
        "name": "value 1 name"
    },
    "2": {
        "name": "value 2 name"
    },
    ...
},
You can skip values in this parameter and leave columns unnamed.

content

String

Dictionary’s key-value or key-array pair in the JSON format.

contentType

String

String containing data type of dictionary’s value. In the current implementation, always contains object.

comment

String

User-defined note about the dictionary.

description

String

Dictionary’s description.

id

String

Dictionary’s ID.

name

String

Dictionary’s name.