¶ The Interface
¶ Basics
In this section we can create rules which will trigger certain actions, e.g. activate an alarm output when someone force opens door or send an e-mail to manager when one of the devices goes offline.
This feature is licensed and requires purchase of additional module.
¶ Trigger filters
Basically filters are the events or entities in CredoID that will act as a triggers.
A few examples of filters:
- If user X from company Y department Z on schedule W gets access granted on door D then...
- If input X is triggered on schedule Z then...
- If doors are forcefully open or held open then...
¶ Creating a filter for the trigger
Click Add or select one of created rules from the list to open trigger configuration menu.
To create a new trigger filter click Create filter button which is located in Trigger section, top right side of the screen.
If any filter is selected there will be Edit filter button available instead.
Enter filter name and then select events or entitites to act as a trigger, click ‘>’ to move it to Selected field and click Save.
In this example it's Door forced open event from Event types.
Filter is created and can be selected from the list.
¶ Actions
Action selection menu is shown after clicking Add button in “Actions” section.
Actions can be selected by using Search function or by navigating through menu.
¶ DigiFort
- Attach DigiFort camera video - Attach a camera video clip from DigiFort VMS to any event.
- Attach DigiFort camera image - Attach a camera image from DigiFort VMS to any event.
¶ Devices
- Change door mode - Change door mode to locked, unlocked or secure.
- Trigger door strike relay - Activate door strike relay on the controller.
- Turn off output - Turn off HID or Mercury device output. Output must be added in "Outputs" menu.
- Turn on output - Turn on HID or Mercury device output. Output must be added in "Outputs" menu.
- Toggle output - Toggle HID or Mercury device output. Output must be added in "Outputs" menu.
¶ CredoID
- Send e-mail - Send an e-mail with event details when some event occurs.
- Trigger script - Execute script when an event takes place.
- HTTP Request - Send custom http request when specific event is triggered.
¶ ASB Security Musdo
- Arm group (area) - Arm group (area) on ASB Musdo security panel.
- Disarm group (area) - Disarm group (area) on ASB Musdo security panel.
- Toggle group (area) - Toggle between arm and disarm group (area) on ASB Musdo security panel.
¶ Adding an action
First of all - add a new rule or select an existing one from the list, rule configuration menu will open on the right side of the screen.
In Trigger section enter name of the trigger, select filter from the list and then you can add an action to your rule by clicking Add in Actions section.
Select desired actions. In this example we will use Turn on output action.
To filter which output or outputs are used in the action, click Create filter button.
Enter filter name i.e., "op1" and then select output or outputs, click ‘>’ to move it to Selected field and click Save.
Filter for the action is created and can be selected from the list.
Apply your created filter and click Save.
¶ Creating a rule to send e-mail
To create a new rule, click Add.
Create a new trigger filter or select existing one.
Add action "Send e-mail". In the “Actions” section click Add → CredoID → Send e-mail.
Fields will use global configuration of your e-mail if you have set them in "Settings → General → Notifications". Otherwise, fields will be empty.
You can also use individual e-mail settings for each action i.e, if you want to send e-mail for certain action from different e-mail provider.
Fill in required fields.
- Filters - Create or select existing filter. This filter can contain users, departments, companies and access levels, e.g. You can make a filter so that everyone with certain access level will get e-mails during events selected in trigger filter (selected users must have valid e-mail address in their user details).
- Mail server & Port - Your e-mail providers SMTP server address and port for outgoing mail.
- Username - Your full e-mail address.
- Password - Your e-mail password.
- From email - Address that will be shown in recipients mailbox.
- Template - Message, that will be sent to filtered users. CredoID variables can be used.
- Subject - Subject line for e-mail. CredoID variables can be used.
¶ Global e-mail settings
Global e-mail configuration can be done in "Settings → General → Notifications"
Outgoing e-mail configuration like SMTP and SSL/TLS is provided by your e-mail provider.
¶ Variables
You can add variables to e-mail template or to a subject line - click icon in bottom right corner of “Send e-mail” section.
Variables are also used in HTTP Triggers.
Variables can be used to pass various information such as device name, timestamp, first&last name, event type etc.
In example, rule where e-mail is sent when doors are forced open - in the e-mail template, using variables, you can specify which doors was it, exact time when it happened etc.
¶ Using rules to send HTTP request
To send a custom HTTP request when specific event is triggered firstly you need to create a trigger filter.
After creating filter you need to add HTTP Request as an action.
Select "CredoID" and then "HTTP request".
Now you need to configure HTTP request that will be sent when specific event is triggered.
Select Method, enter Endpoint URL and add needed Parameter/Header keys(arguments) and their values. Also, Body can be added as well.
Required details for HTTP Requests, if not publicly available, should be obtained through authorized sources.
In this example I'm using GET method to trigger a global event with attached message in "Digifort surveillance client". This HTTP Request will be triggered everytime "Door forced open" event is generated in "CredoID". This request also requires authentication, so I've added "AuthUser" and "AuthPass" keys.