Command Data

For each command, it is necessary to specify the following data:

Data

Use

Description

CommandType

Mandatory

Name of the command type for the selected property (for example, BACnetAnalogWithPriority).

NOTE: The command type must exist in the project.

Name

Mandatory

Name of the command.

NOTE: This name must be unique for the current property (for example, WritePrio08, ReleasePrio08).

Label

Optional

List of values used as descriptions of the command (for example, descriptive text for the button in the Status and Commands window). Each value must contain the following data:

  • Culture: culture of the text (for example, “en-US”).
  • Text: label

If the list is empty (“Label”: [ ]), the command name is assumed as default label.

Guid

Optional

A string that identifies the command.

NOTES:

  • The value of this string is automatically assigned by the system when the command is created for the first time. The value must not be set manually.
  • When an object model is imported for the first time, all the commands specified for its properties do not have the Guid or the Guid must be declared but empty (“Guid”: “”). In this case, the importer creates a new command.
  • If an object model is exported, the Guid contains the value automatically assigned by the system. This value must not be changed, otherwise the command can no longer be recognized in case of re-import.
  • In case of re-import:
    • If the Guid is not specified or it is empty (“Guid”: “”), the command is created or re-created.
    • If the Guid is specified and matches the one of an existing command, the existing command is updated.
    • If the Guid is specified and it does not match the one of an existing command, the command is ignored.
    • All the commands already existing but not updated, using the matching Guid mechanism, are removed.
    • If it is necessary to remove a command previously created, the command must be removed from the command list.

Dependencies

Optional

List of dependencies.

For details about the definition of a dependency (that is, a condition based on a property specified in one of the Dependency<X> fields), see Dependency Data.

Alias

Optional

Alias identifier. The value 0 is the default one (corresponding to “n/a”).

NOTES:

  • The alias must be unique for all the properties of an object model.
  • The identifier that must be specified is the value of the corresponding alias in the Command Macro text group (TxG_CommandMacro). The identifier must be present in the text group before the import is carried out.
  • The Command Macro text group is not managed by this importer. If it is added in the JSON file, this text group is ignored.

Group

Optional

String that defines the Command Groups configuration in the Scope Rights expander of the security definition used to execute the command. Possible settings are:

  • Standard (Sta.)
  • Event (Eve.)
  • Advanced (Adv.)
  • Ownership (Own.)

If not specified, the Standard setting is taken by default.

Control

Optional

Type of control that must be used in the user interface. Possible settings are:

  • Default
  • Expander

If not specified, the Default setting is taken.

Combined

Optional

True, if a command can be selected from a drop-down list in case of multiple commands.

The default value is False.

Display

Optional

String that defines where the command is used. Possible settings are:

  • SOFTWARE
  • GENERIC_DISPLAY
  • GENERIC_DISPLAY_SOFTWARE
  • RESERVED

If not specified, the GENERIC_DISPLAY_SOFTWARE setting is taken by default.

TargetedProperty

Optional

Name of the target property affected by this command.

If not specified, the current property is taken by default.

If the string is empty (“TargetedProperty”: “”), the current property is taken.

If the targeted property is part of a structure or a reference, the complete name must be specified (<name of structure>.<name of property> - for example: “Struct_Value.Int_Value”).

If the target property is an element of a set, the name must be composed by the set name and the property index (<set name>[<index>] – for example: “SetChar_Value[1]”). Note that the index starts with “1”.

Logging

Optional

String that defines when values are written into the History Database. Possible settings are:

  • ALWAYS
  • NEVER
  • ON_FAILURE

If not specified, the ALWAYS value is taken by default.

Parameters

Optional

List of parameters. For details about the definition of a parameter, see Parameter Data.

In case of re-import, all the required parameters must be specified. In fact, the list of parameters is re-created at each import.