SAYMON Documentation
Page tree

SAYMON документация

Skip to end of metadata
Go to start of metadata

In this window there are two tabs that allow you to manage existing objects classes and create new ones, also you can change the list of colunms displayed in the Table View.

In this window there are two tabs that allow you to create new and manage existing objects classes, their properties and operations, and also change the columns list displayed in Table view.

General

This section consists of a list of the existing classes, for which it is possible to change:

  • name;
  • description;
  • view that will be used by default for selected class;
  • display mode in tree.

The new class creation is done by pressing the button .

Properties

The section includes two fields for filling:

  • name;
  • value.

The field "Value" is not required. A property will be created with an empty value.

Operations

There are two opeations types, depending on the choice of which the fields number and content to be filled in vary:

  • MQTT message sends a message using the MQTT protocol.


Fields description:

FieldDescription in program / scriptDescription in MQTT
NameOperation name displayed in web interface
Type

Drop-down list with available operationss types.

Subtype

Drop-down list with available subtypes:

  • Program/script in file system - previously created file stored in the server file system.
    Specify binary name or script full path.
  • Script from repository - script created and added to system repository earlier.
    The script saved in repository is selected from the drop-down list.
  • Script with text - manual script introduction.
    The script text is entered.

Topic
MQTT topic for message sending.
Message

MQTT message text.
ArgumentsArguments with which script is run. The field is filled as necessary.
DescriptionExplanation a created operation.

Table

The following columns are available by default:

  • ID — unique object ID;

  • Name —name of the object with icon according to this class;

  • State — status of the object

  • Widgets — graphic display of the widgets configured for the object (counter, ring, circle, chart, button)

  • Time — date and time when the object get the current state;

  • Duration — time during which the object is in the current state.


If it is necessary you can add your colunms using the panel:

where:

  • metric name — the metric name which value is taken from the table of agent data displayed in the objects table, for example «percentageUsage.combined» (case-sensitive);

  • colunm name — an arbitrary name displayed in the table header instead of the metric name, for example «CPU Download,%» insted of «percentageUsage.combined».

  • No labels