Commands: Difference between revisions
Telcredstaff (talk | contribs) |
Telcredstaff (talk | contribs) |
||
Line 17: | Line 17: | ||
* ''Door action''. Performs an action on one or more doors. The actions available are the same that the administrator can perform from the [[Doors|door detail page]]. |
* ''Door action''. Performs an action on one or more doors. The actions available are the same that the administrator can perform from the [[Doors|door detail page]]. |
||
* ''External''. Will make an http request to an external system. It is possible to specify the URL, http method and body. |
* ''External''. Will make an http request to an external system. It is possible to specify the URL, http method and body. |
||
* ''Compound''. Includes commands already defined, which can be either ''door action'' or ''external''. This allows the administrator to create a command which both affects doors and can interact with an external system (e.g. block all doors in one building and make an http request to |
* ''Compound''. Includes commands already defined, which can be either ''door action'' or ''external''. This allows the administrator to create a command which both affects doors and can interact with an external system (e.g. block all doors in one building and make an http request to an alarm center). |
||
Line 27: | Line 27: | ||
[[File:perform-command.png|Perform command]] |
[[File:perform-command.png|Perform command]] |
||
=== Triggers === |
=== Triggers === |
Revision as of 12:59, 14 November 2019
Overview
A command is defined as a set of one or more predefined actions that can either be performed by an administrator or as a result of a predefined trigger event. Commands and triggers are found under the Configuration section in the main menu.
Some use cases for commands and triggers include:
- Perform an action simultaneously on a number of doors, a door group, or a combination (e.g. block all doors in a section of the building to achieve a "lockdown").
- Interact with an external system (e.g. arm or disarm an intrusion detection system)
- Allow end users to perform an action normally only available to administrators (e.g. unlock a door or return it to schedule)
Commands
When creating a new command, you need to give it a name and define which type it is:
- Door action. Performs an action on one or more doors. The actions available are the same that the administrator can perform from the door detail page.
- External. Will make an http request to an external system. It is possible to specify the URL, http method and body.
- Compound. Includes commands already defined, which can be either door action or external. This allows the administrator to create a command which both affects doors and can interact with an external system (e.g. block all doors in one building and make an http request to an alarm center).
It is possible to perform (or "run") the command straight from its detail page:
Triggers
Setting up a trigger
Triggers are a way to start one or more commands from an access control reader. To define a trigger, it is necessary to give it a name and specify which command(s) it should start.
Both user defined commands and native door actions are available. The latter will be applied only to the door where the trigger is activated.
The next step is to define the PIN code for this specific trigger. Trigger PIN codes always start with a * followed by one or more digits. It is recommended to use the same number of digits as for normal user PIN codes.
It is also necessary to define the required authentication credential, which can be card or PIN (note that in this case, it is the user's personal PIN and have nothing to do with the trigger PIN).
Finally, it is possible to define limitations on on the trigger:
- When it can be entered (schedule)
- On which doors it can be entered (doors and/or door groups)
- Who is allowed to enter it (roles)
Using a trigger on a reader
As all readers behave a bit differently, there is not one way to describe exactly what using a trigger on any particular reader will look like. However, the general process will look like this:
- Enter the trigger PIN (e.g. *111)
- Wait for the reader to start blinking (can take a few seconds). This means that the reader has been temporarily blocked and is ready to receive the authentication credential (card or personal PIN) without granting access.
- Wait for a blinking "success indicator" (will blink for approx two seconds). The success indicator indicates that the command completed successfully, and will look different on different readers. If the success indicator is not displayed, the command failed to complete all of its actions.