Alert Types

Alert types categorize different types of notifications or warnings that are triggered within a system. These can range from informational alerts to critical error warnings, each serving a specific purpose. Properly defining and managing alert types ensures users receive timely and relevant information based on the severity of the situation.

Create an alert type

Main

Field Description
Alert Type Type of the alert.
Name Name of the alert.
Description Description of the alert.
Alert Template Select from the list of all available alert templates.
Email Template Select from the list of all available email templates.
Allow User Preferences Enables you to customize your alert preferences.

Criteria

To create a criterion, follow these steps:

  1. Click Add Criterion.
  2. Enter a valid name in the Criteria field.
  3. Select a type from the Field Type dropdown list.
  • Date — sets the Data Type to Date.
  • Lookup — sets the Data Type to String. If you selected Lookup, additional fields are displayed. See Lookup field type.
  • Autocomplete — sets the Data Type to String. If you selected Autocomplete, additional fields are displayed. See Autocomplete field type.
  • Boolean — sets the Data Type to String.
  1. Select a single or multiple operators in the Operator(s) dropdown list.
  2. Click the icon to close the criteria window.

Lookup field type

When creating a criterion for a Lookup field type, you can configure the following fields:

Field Description
View as Autocomplete

Enables the lookup field type to be viewed as an autocomplete field.

Default: Disabled

Mandatory: No
Lookup Code

Code of the lookup.

Mandatory: Yes

Autocomplete field type

When creating a criterion for an Autocomplete field type, you can configure the following fields:

Field Description
HTTP Method

Dropdown list of supported HTTP methods for API calls.

  • POST
  • GET
Search URL URL that is accessible to the Ocular, from which it calls the API to retrieve the necessary data.
Autocomplete Code Unique code used to identify the autocomplete configuration in the system.
Autocomplete Description Description of the autocomplete field.
Autocomplete Code Override Overrides the default autocomplete code with a custom one if needed.

After creating, click the button to close the criterion window and return to the list of criteria.

To view the criteria details again, click on any field on the list.

To delete a criteria, click .

Entries

To create an entry, follow these steps:

  1. Enable the Criteria specific templates toggle.
  2. Click Add Entry.
  3. Select a template from the Email Template dropdown list.
  4. Select a template from the Alert Template dropdown list.
  5. If you have added criteria in the Criteria tab, ensure that you fill these out with valid data.
  6. Click to save.

To edit an entry, click .

To cancel the edit, click .

To delete an entry, click .

Views

List View

The alert types and their details are displayed in a tabular format.

Field Description
Type Type of the alert. Under it, the alert name is displayed.
Alert Template Template code of the alert. Under it, the alert template description is displayed.
Email Template Template code of the email. Under it, the email template description is displayed.
Criteria Count Indicates the number of criteria added to the alert.
Actions

Displays the following icons:

  • — Edit icon that allows you to edit the selected alert type. You can edit any field except the Alert Type.
  • — Delete icon that allows you to delete the selected alert type.

For example, if you input a keyword or the full name of an alert type, only the matching items are displayed.

Sort

The following columns on the list view can be sorted:

  • Type
  • Alert Template
  • Email Template