The current Openpath Jira and Confluence instances will be migrated to the MSI On-Premise solution from August 9th-11th, the current platform will be set to read-only and all future usage will be in the Avigilon Instance. Please ensure access to MSI Jira & MSI Confluence, both are accessible through OKTA. For additional information and details please refer to the Atlassian migration page

Creating a rule with the Rules Engine

 

The Rules Engine allows you to create conditional rules that trigger actions based on Avigilon Alta events.

Steps to create a new rule

  1. Log In:

  2. Navigate to Rules:

    • Go to Configurations > Rules and click the plus (+) sign in the top right corner to create a new rule.

  3. Set up your rule:

    • Name and Description: Enter a name and description for the rule.

    • Trigger Type: Select a trigger type from the dropdown. Options include:

      • Input Triggers: Events like input state changes.

      • Entry Triggers: Events like entry unlocks, ajar doors, and unlock failures.

      • Reader Triggers: Reader fault state changes, for monitoring and action when a reader loses or regains power.

      • Relay Triggers: Relay fault state changes, for monitoring and action when a relay is short or overcurrent.

      • Lockdown Triggers: Lockdown plan triggers and reverts, as well as trigger and revert authorizations.

      • Video Reader Triggers: Events like tamper detection, QR code detection, and motion detection specific to the Video Reader.

      • Video Intercom Reader Triggers: Events like intercom direct connect session requests, button pressed, SIP DTMF digits heard, QR code detection, tamper detection, sound detection, motion detection, and video voicemail notifications.

      • Event Forwarder Triggers: Includes events from previous categories, billing activity, user creation, deletion, and identity provider sync issues. For detailed guidance, refer to "How to Create Event Forwarder Rules in Avigilon Alta."

  4. Configure event forwarder (if selected):

    • Enter the Target URL.

  5. Set conditions (Optional):

    • Use conditions to limit when the rule will occur. Available conditions depend on the selected trigger type:

      • Input Trigger: Input state, ACU port filter, or ACU filter.

      • Entry Trigger: Entry filter, zone filter, or site filter.

      • Reader or Relay Trigger: ACU port filter or ACU filter.

      • Lockdown Trigger: Lockdown plan filter or user filter.

  6. Apply time constraints (Optional):

    • Choose from a one-time schedule event or a repeating schedule event, then enter the date and time information.

  7. Define actions:

    • Relay Actions: Provide the ACU relay port number to trigger. For example:

      • Single Door Controller: 1 or 2.

      • 4 Door Controller: 1, 2, 3, or 4.

      • Core Series expansion boards: (Expansion number x 10000) + Relay number.

      • Auxiliary relays: (Expansion number x 10000) + (Max port number + AUX number). For example, AUX Relay 2 on expansion board 3 (an 8-port board) would be 30010.

      • These port IDs can also be found using the API.

    • Notification Actions: Enter the subject and body of the notification and the recipient’s email or phone number.

    • Webhook Actions: Enter the URL and specify the HTTP method (GET or POST).

    • Lockdown Actions: Specify the lockdown plan and select whether to trigger or revert the plan.

  8. Use JSON editor (Optional):

  9. Save the rule:

    • Click Save.

Note: Enter phone numbers using the following format: +15556667777 (no hyphens and a +1 before the number).

Note: The Basic package only includes the graphical interface for Input and Event Forwarder trigger types, but you can still use the JSON editor to create other rules.