Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Need help? Contact us:

 

 

The Iguana X notifications component is designed to work with the Notifications System to process and send out messages when notification rules are triggered.

This component is configured by default to send notification messages via email, however can easily be adapted to deliver notifications via other mechanisms (ex. Slack, Microsoft Teams, etc.).

Component Setup:

 STEP 1: Import the Iguana X Notifications component

See Create a Component if this is your first time!

 STEP 2: Configure the component's Custom Fields according to your email server and start the component

Enter the following custom fields into the component card:

  • MailServer - by default is set to send from a Gmail smtp server (smtp.gmail.com:587).

  • Username - set to your smtp server username/email.

  • Password - set to your smtp server password. For Gmail, with two-factor authentication enabled, the password is required to be an App Password.

  • Sender - add an email to use for the sender.

  • Recipients - add the email addresses of one or more recipients. If you want multiple recipients, they must be provided as a comma-separated string.

  • LinkHostName - set to your Iguana X instance hostname, by default this will be localhost (127.0.0.1)

Don't forget to start the component once you’ve finished setting the custom fields!

 STEP 3: Go to Settings > Notifications and configure the notifications system to use the component

Click Edit, then choose the Iguana X Notifications component to send alerts.

 STEP 4: Use the testing links to test your notifications

See Using Notifications if you need to learn how to create and test your notification rules.

How it works:

 When a notification rule is triggered the log is processed into an informative alert and sent out via email

When a notification rule is triggered, a log is generated and sent to the Iguana X Notifications Component.

NOTIprocess.lua is used to process each type of condition triggered, forming an email notification message to be sent, containing:

  • The Component GUID.

  • The condition that was triggered (ie. error, inactivity, queue threshold, or log contains).

  • A link to the component logs to view more details.

For example, your email may contain information such as:

 This component can be adapted to alert via other mechanisms besides email

This component is designed to be able to be adapted to send notifications via any mechanism as the notification processing logic is all contained in NOTIprocess.lua.

  • No labels