Documentation for Axxon PSIM 2.0. Documentation for other versions of PSIM is available too.

Previous page Next page


The Macro object is used to support the automatic execution of a predefined sequence of commands upon the occurrence of certain events registered by Axxon PSIM. The settings panel of the Macro object is shown in the figure.

The 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

The Identification number* 
field

Automatically

Displays the identification number of the Macro object in the video surveillance system

Numbers, letters, periods, hyphen, dash, and underscore

NA

A line containing numbers, letters, periods, hyphen, dash, and underscore

Depends on the number of the Macro objects in the video surveillance system with distributed architecture

2

The Name*
field

Enter the value in the field

Sets the name of the Macro object 

Latin, Cyrillic, numbers, 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

The Disable
checkbox

Set the checkbox

Disables the Macro object 

Boolean type

Clear

Setthe Macro object is disabled and isn't used

Clearthe Macro object is enabled and used

The Settings group

4

The State
drop-down list

Enter the value in 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, numbers, and service characters

NA

Standardno message is 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 charactersfrom 1 to 60

5

The Local
checkbox

Set the checkbox

Sets the computers, which will execute the given macro (on all computers of the video surveillance system with distributed architecture or only on the given computer).

Note. This checkbox doesn't apply for hiding and showing reactions of any Display. Regardless of the checkbox, when calling from the Server/RAW, the reactions are executed on the Server/RAW and all connected Clients; when calling on the Client, the reactions are executed only on the Client

Boolean type

Clear

Setthe macro is executed only on the given computer

Clearthe given macro is executed on all computers of the video surveillance system with distributed architecture

6

The Hidden
checkbox

Set the checkbox

Determines whether the name of this macro is displayed in the main control panel of Axxon PSIM to be started manually

Boolean type

Clear

Set—the name of the macro isn't displayed in the main control panel of Axxon PSIM

Clearthe name of the macro is displayed in the main control panel of Axxon PSIM

The Events subgroup

7

The Type
drop-down list

Select the value from the list

Sets the type of objects in the video surveillance system with distributed architecture, in which the event registration triggers a macro

Types of objects registered in the system

NA

Depends on the total number of the types of objects created in the video surveillance system with distributed architecture

8

The Number
drop-down list

Select the value from the list

Sets the identification number of the object in the video surveillance system with distributed architecture, in which the event registration triggers a macro

Sequence of numbers

NA

Depends on the total number of the objects of the specified type created in the video surveillance system with distributed architecture

9

The Name
field

Automatically

Displays the name of the selected object in the video surveillance system with distributed architecture

Names of the objects of the specified type registered in the system

NA

A line containing a sequence of any characters (letters, digits, service characters), case-insensitive.

Number of charactersfrom 1 to 60

10

The Event
drop-down list

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

NA

A list of events is created individually for each type of object

The Parameters subgroup

Note. The given subgroup isn't active for all types of objects

11

The Name
field

Automatically

Sets the name of the additional parameter for the selected type of object in the Events subgroup

Latin, Cyrillic, numbers, and service characters

NA

A line containing a sequence of any characters (letters, digits, service characters), case-insensitive.

Number of characters—from 1 to 60

12

The Value
field

Enter the value in the field

Sets the value for the parameter in the Name column

Latin, numbers, and service characters

NA

A line containing a sequence of any characters (letters, digits, service characters), case-insensitive.

Number of charactersfrom 1 to 250

The Action subgroup

13

The Type
drop-down list

Select the value from the list

Sets the type of objects in the 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

NA

Depends on the total number of the types of objects created in the video surveillance system with distributed architecture

14

The Number
drop-down list

Select the value from the list

Sets the identification number of the object in the 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

Empty field

Depends on the total number of the objects of the specified type in the video surveillance system with distributed architecture.

If the field is left blank, the reaction is 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 is 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 is blank, that is, the macro is executed for all objects of the selected type.
Example of using the # symbol: disarm the camera if the Detach event is received from it

15

The Name
field

Automatically

Displays the name of the selected object in the video surveillance system with distributed architecture

Names of the objects of the selected type registered in the system

NA

A line containing a sequence of any characters (letters, digits, service characters), case-insensitive.

Number of charactersfrom 1 to 60

16

The Action
drop-down list

Select the value from the list

Sets the action that 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

NA

A list of events is created individually for each type of object

The Parameters subgroup

Note. The given subgroup isn't active for all types of objects

17

The Name
field

Automatically

Sets the name of the additional parameter for the selected type of object in the Actions subgroup

Latin, numbers, and service characters

NA

A line containing a sequence of any characters (letters, digits, service characters), case-insensitive.

Number of characters—from 1 to 60

18

The Value
field

Enter the value in the field

Sets the value for the parameter in the Name column

Latin, numbers, and service characters

NA

A line containing a sequence of any characters (letters, digits, service characters), case-insensitive.

Number of charactersfrom 1 to 250

Out of the groups

19

The Response sending delay (s)
field

Enter the value in 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.


Note. If the events reoccur before the specified time period expires, the reaction execution waiting period is prolonged, that is, reactions are executed only once when events don't reoccur over the specified period

Sequence of numbers

NA

>0

20The Fast call
field

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, then when pressing a key combination, all of these macros will run

Key combinationsClearIndividual keys of the main or numeric keyboard, as well as the given keys in combination with Shift, Ctrl, and Alt
21The Icon type
drop-down list
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

Empty value
  • Empty value,
  • Macro 1Macro 7

*Name of the element isn't displayed in the settings panel of the given object

  • No labels