- 24 Jul 2024
- 2 Minutes to read
- Print
- PDF
Rules
- Updated on 24 Jul 2024
- 2 Minutes to read
- Print
- PDF
Rule configuration enables users to establish detailed notification rules based on specific events like License Usage and License Expiry. Users define each rule with a unique Rule Name and Description, specifying the Gateway Type and Gateway Name for email communication. The Notification Type categorizes alerts, directing them to designated recipients listed in the To and CC fields.
Configure Rules
To configure a new rule, perform the following steps:
On the Rules List page, click the New Rule + icon to configure a new rule.
Figure: Rules List page - New Rule icon
On the New Rule configuration page, enter the required details as shown below and click Save.
Figure: New Rule configuration
Figure: Success message
Let’s understand the fields and their significance.
Field | Description |
---|---|
Rule Name * | Enter a unique and descriptive name for the notification rule. |
Description | Provide a brief explanation of the notification rule. |
Active | Use this toggle to enable or disable the notification rule. |
Gateway Type * | The gateway type determines the protocol and method used for routing notifications. Currently, SMTP (Simple Mail Transfer Protocol) is the available option, which is used for sending email notifications. |
Gateway Name * | Select the configured SMTP gateway that will be used to send the notifications. The gateway name identifies the specific server settings through which emails will be routed. |
Notification Type * | Select the type of notification that this rule will apply to. This categorizes the rule based on specific events or conditions. Options include: |
Notification Trigger Options * | The trigger options are dependent on the type of notification selected. Let’s check the two available options:
|
To | Enter the email addresses of the primary recipients who should receive the notifications.
|
Cc | Enter the email addresses of the secondary recipients who should receive a copy of the notifications. Separate multiple email addresses with commas. |
The saved rule will be displayed on the Rules List page.
Figure: Rules List page - Saved rule
Note
To modify rule details, click the Rule Name hyperlink. This will open the Edit Rule page, where you can make the necessary changes.
Process to trigger rules and notifications
Once all conditions are defined, a trigger must be set to initiate the execution of rules and notifications. This is managed through Schedulers.
By default, the following standard schedulers will be available in the system:
License Usage
License Expiry
Notification Queue
These scheduler jobs run continuously with the following execution times:
License Usage: Every 5 minutes from 00:00 to 23:59 daily
License Expiry: Every 5 minutes from 00:00 to 23:59 daily
Notification Queue: Every 1 minute from 00:00 to 23:59 daily
To view these schedulers, navigate to Schedulers > Scheduler List. Select the Action Type as Standard.
Figure: Schedulers List page - Standard Schedulers
Note
These standard schedulers are pre-configured in the system by default and cannot be edited or modified.