Skip to main content
Version: 3.2.0

Overview of Field Definitions

Field definitions in ASI involve configuring and managing custom alert fields to enhance data organization and integration. This process allows you to define new user fields and map them to corresponding BES alert fields. Field definitions are critical for ensuring seamless interaction between ASI and BES, supporting custom data handling, and enabling tailored alert management.

View Existing User Fields

To view a table of all defined user fields and their mapping in ASI:

Navigate to the Event Management then from the index on the left, select Field Definitions

Field Definitions Page

If you would like to see System Fields, switch on the Show System Fields toggle

Field Definitions Page With System Fields

Creating New User Fields

Navigate to the Event Management then from the index on the left, select Field Definitions

Click the Create button, displayed at the top of the page

Field Definition Page | Create Button

The Field Definitions - Create Field page displays, which will allow the user to input a new custom alert field.

Create Field Definition Page

The following fields are required:

  • Field: Name of the User Field
  • ASI Field: Name of the User Field in ASI
  • Label: Label for the field
danger

Do not use the reserved word entity as the name of any new field. This will cause issues in the AID

  • Type: Select the relevant Data Type of the field from the dropdown
Create Field Definition Page | Field Types

Once the new field has been defined, click Create at the bottom of the page.

Editing User Fields

Navigate to the Event Management then from the index on the left, select Field Definitions

Field Definition Page | Field Options

For the relevant field that requires editing, click the three vertical dots on the right (box 1) Then select Edit from the option list.

You will then be presented with the Field Definitions - Edit Field page

Field Definition | Edit Field Page

Modify the field and then click Save.

Delete User Fields

Navigate to the Event Management then from the index on the left, select Fields Definitions

Field Definition Page | Field Options

For the field that you wish to delete, click the three vertical dots on the right (box 1) Then select Delete from the option list.

You will then be presented with a delete confirmation window. If you would like to go ahead with the deletion, click Confirm

Field Definition Page | Delete Field Confirmation Modal

Default Close Relationships

To display and amend alert fields that are automatically assigned in a close alerts statement, perform the following:

Navigate to the Event Management then from the index on the left, select Field Definitions

Field Definition Page | Edit Relationships Options

Click Edit at the top of the page (box 1) then select Default Relationships from the options list.

You will then be presented with the Default Close Relationships page

Default Close Relationships Page

You will see a list of available Fields on the left and the defined Default Close Relationships fields on the right.

To add a new field to the list:

  1. Click the checkbox for the relevant field
  2. Click the > button between the two lists

To remove a new field from the list:

  1. Click the checkbox for the relevant field
  2. Click the < button between the two lists

Ignore Fields for Recurring Alerts

To display and amend alert fields that are ignored in recurring alerts, perform the following:

Navigate to the Event Management then from the index on the left, select Field Definitions

Field Definition Page | Ignore Recurring Option

Click Edit at the top of the page (box 1) then select Ignore Recurring from the options list.

You will then be presented with the Ignore Recurring page

Ignore Recurring Page

You will see a list of available Fields on the left and the defined Ignored Recurring Fields on the right.

To add a new field to the list:

  1. Click the checkbox for the relevant field
  2. Click the > button between the two lists

To remove a new field from the list:

  1. Click the checkbox for the relevant field
  2. Click the < button between the two lists