Operations

This section allows you to set an Operation to an entity.

This section is only available to users with operation execution permissions.

Only users with manage operations permissions can create, edit and delete operations.

operations light
operations dark

Manage existing operations

You can manage existing operations with the set of buttons next to corresponding operation:

  • – execute operation;

  • – edit operation;

  • – delete operation.

Edit and delete buttons are only available in the edit mode, which you can enter by pressing button in the top right corner of the sections. To exit edit mode, press the button.

Create operations

To create a new operation for an object, press the Add operation button.

There are two types of operations available in the system. Parameter fields depend on the selected type.

You can use variables in the topic and message of operations of type MQTT message, and in the body of the script of the operation of type Program/script execution – Script with text.

Program/script execution

Settings of this type of operation are identical to the settings of the Program / script execution sensor.
script light
script dark

Operations of this type has the following set of parameters:

Name Description

Name

Operation name displayed in the web interface.

Type

Dropdown list with available operation types.

Subtype

Dropdown list with available subtypes:

  • Program/script in file system – previously created file stored on the server.

    • The name or the full path to the script is specified.

  • Script from repository - script created and added to the system repository earlier.

    • The script can be selected from the drop-down list.

  • Script with text - manual script input.

    • The script text must be entered.

Arguments

Dropdown list where arguments the script will be executed with are specified.

Description

Explanation to the operation. Explanation to the operation. Description is displayed next to the operation in the Operations section.

Show results in popup message

If the toggle is set to YES, the execution result will be displayed in a popup. The following is specified in the message:

  • operation name,

  • path to the object in the hierarchy,

  • result of the execution.

image

Click the button or refresh the page to close the popup.

The popup window is available only for those operations that are executed manually. Results of operations, performed by triggers, are not displayed.

MQTT message

mqtt light
mqtt dark

Operations of this type has the following set of parameters:

Name Description

Name

Operation name displayed in the web interface.

Type

Dropdown list with available operation types.

Topic

MQTT topic to send message.

Message

MQTT message text.

Description

Explanation to the operation. Description is displayed next to the operation in the Operations section.

Show results in popup message

If the toggle is set to YES, the execution result will be displayed in a popup. The following is specified in the message:

  • operation name,

  • path to the object in the hierarchy,

  • result of the execution.

image

Click the button or refresh the page to close the popup.

The popup window is available only for those operations that are executed manually. Results of operations, performed by triggers, are not displayed.