Go to documentation repository
The Macro object is used to support the automatic execution of a pre-defined sequence of commands upon occurrence of certain events, registered by Axxon PSIM.
The settings panel of the Macro object is shown in the figure.
Table describes the setting parameters corresponding to the elements of the settings panel of the Macro object.
№ | Parameter | Method for setting the parameter value | Parameter description | Representation | Default value | Value range |
1 | Identification number* | Automatically | Displays the identification number of the Macro object in the digital video surveillance system | Numbers, letters, periods, hyphen, dash and underscore | - | Depends on the number of the Macro objects in the digital video surveillance system with distributed architecture |
2 | Name* | Enter the value into the field | Sets the Macro object name. | Latin, Cyrillic and service characters | Macro | A line containing a sequence of any characters (letters, digits, service characters except > and < characters), case-insensitive. Number of characters—from 1 to 60 |
3 | Disable | Set the checkbox | Sets the state (enabled or disabled) of the Macro object | Boolean type | Clear | Set—the Macro object is disabled and isn't used Clear—the Macro object is enabled and used |
The Settings group | ||||||
4 | State | Enter the value into the field | Sets the message displayed in the information board of the main menu of Axxon PSIM, when the given macro is running | Latin, Cyrillic and service characters | Not defined | Standard—no message will be displayed in the information board of the main menu of Axxon PSIM. A line containing a sequence of any characters (letters, digits, service characters), case-insensitive. Number of characters—from 1 to 60 |
5 | Local | Set the checkbox | Sets the computers, which will execute the given macro (all computers of the digital video surveillance system with distributed architecture or only the given computer). Note. This checkbox does not apply to hide and show reactions of any Display. Regardless of the checkbox, when called from the Server/RAW, the reactions are executed on the Server/RAW and all connected Clients; when called on the Client, the reactions are executed only on the Client | Boolean type | Clear | Set—the macro will be executed only on the given computer Clear—the given macro will be executed on all computers of the digital video surveillance system with distributed architecture |
6 | Hidden | Set the checkbox | Determines, whether or not the name of this macro will be displayed in the main control panel of Axxon PSIM to be started manually | Boolean type | Clear | Set— the name of the macro will not be displayed in the main control panel of Axxon PSIM Clear—the name of the macro will be displayed in the main control panel of Axxon PSIM |
The Events subgroup | ||||||
7 | Type | Select the value from the list | Sets the type of objects in the digital video surveillance system with distributed architecture, in which the event registration triggers a macro | Types of objects registered in the system | - | Depends on the total number of the types of objects created in the digital video surveillance system with distributed architecture |
8 | Number | Select the value from the list | Sets the identification number of the object in the digital video surveillance system with distributed architecture, in which the event registration triggers a macro | Sequence of numbers | - | Depends on the total number of the objects of the specified type created in the digital video surveillance system with distributed architecture |
9 | Name | Automatically | Displays the name of the selected object in the digital video surveillance system with distributed architecture | Names of the objects of the specified type registered in the system | - | A line containing a sequence of any characters (letters, digits, service characters), case-insensitive. Number of characters—from 1 to 60 |
10 | Event | Select the value from the list | Sets the event that triggers a macro for the specified object | Names of the events available for the given type of objects | - | List of events is created individually for each type of object |
The Parameters subgroup Note. The given subgroup is not active for all types of objects | ||||||
11 | Name | Automatically | Sets the name of the additional parameter for the selected type of object in the Events subgroup | Latin and service characters, digits | Not defined | A line containing a sequence of any characters (letters, digits, service characters), case-insensitive. Number of characters—from 1 to 60 |
12 | Value | Enter the value into the field | Sets the value for the parameter in the Name column | Latin and service characters, digits | Empty field | A line containing a sequence of any characters (letters, digits, service characters), case-insensitive. Number of characters—from 1 to 250 |
The Action subgroup | ||||||
13 | Type | Select the value from the list | Sets the type of objects in the digital video surveillance system with distributed architecture, to which the command is forwarded, when the conditions set in the Events subgroup to trigger a macro are met | Names of the types of objects registered in the system | - | Depends on the total number of the types of objects created in the digital video surveillance system with distributed architecture |
14 | Number | Select the value from the list | Sets the identification number of the object in the digital video surveillance system with distributed architecture, to which the command is forwarded, when the conditions set in the Events subgroup to trigger a macro are met | Sequence of numbers | - | Depends on the total number of the objects of the specified type in the digital video surveillance system with distributed architecture. If the field is left blank, the reaction will be performed for all objects of the selected type. If you enter the # symbol in the field, the identifier of the object from which the event was received will be substituted into the reaction. The object types in the Events and Actions tables may differ. When the macro is run manually from the main control panel, the # symbol is treated as if the field was blank, i.e. the macro is executed for all objects of the selected type. |
15 | Name | Automatically | Displays the name of the selected object in the digital video surveillance system with distributed architecture | Names of the objects of the selected type registered in the system | - | A line containing a sequence of any characters (letters, digits, service characters), case-insensitive. Number of characters—from 1 to 60 |
16 | Action | Select the value from the list | Sets the action, which the given device performs, when the conditions to trigger the given macro are met | Names of the actions, available in the system for the objects of the specified type | - | List of events is created individually for each type of object |
The Parameters subgroup Note. The given subgroup is not active for all types of objects | ||||||
17 | Name | Automatically | Sets the name of the additional parameter for the selected type of object in the Actions subgroup | Latin and service characters, digits | Not defined | A line containing a sequence of any characters (letters, digits, service characters), case-insensitive. Number of characters—from 1 to 60 |
18 | Value | Enter the value into the field | Sets the value for the parameter in the Name column | Latin and service characters, digits | - | A line containing a sequence of any characters (letters, digits, service characters), case-insensitive. Number of characters—from 1 to 250 |
Outside the groups | ||||||
19 | Response sending delay (s) | Enter the value into the field | Sets the time period (in seconds) that must pass after the events specified in the Events column occur and before executing the reactions specified in the Actions column.
| Sequence of numbers | - | >0 |
| 20 | Fast call | Left-click in the field and press the required key combination | Sets a keyboard shortcut for a macro. Note. If the same combination of keys is set for several macros, when pressing a key combination, all of these macros will run | Key combinations | - | Individual keys of the main or numeric keyboard, as well as these keys in combination with Shift, Ctrl and Alt |
| 21 | Icon type | Select the value from the list | Sets a set of icons for displaying a macro on the map. By default, an empty value is set for all macros which corresponds to the "Macro 1" icon. Note. Changing the icon type will take effect after restarting the map interface. To restart the interface, restart Axxon PSIM or log in once again under the corresponding Operator account | Available icon types on the map | - | Macro 1–Macro 7, empty value |
*Name of the element isn't displayed in the settings panel of the given object.
Overview
Content Tools