Custom Fields for Events
Custom Fields are a common component in the iiQ platform. They allow districts to customize what fields appear on specific objects, such as Tickets and Assets, to provide a tailored, informative experience. Events also have the ability to associate Custom Fields with targeted Events based on a set of filter criteria.
Creating new Custom Fields in Events is exactly the same as in existing iiQ products. First, the Custom Field must be created, and then the Custom Field must be associated with the Events component, with or without filters to determine which Custom Fields appear on which Events.
Custom Field Definitions
The first step in creating a custom field involves setting up a field definition. These determine the custom field that is created and the type of data that the user would like to capture.
To create a new Custom Field, navigate to Administration > Custom Fields, click the Field Definitions tab, and + New Custom Field
The required and optional fields for a New Custom Field Definition are listed below.
Name | Required | Display name of the field |
Description | Optional | Short description for added context |
Field Type | Required | Type of field to be displayed such as text, number, or on/off |
Contains Sensitive Info | Optional | This field is not used for Events |
Required | Optional | Identifies if the field must be filled out for the Event to be saved |
Requestor Visible | Optional | This field is not used for Events |
Number of Instances | Required | This field is not used for Events but will default to one |
Pagination and Search are available on all tabs on the Custom Fields page. Search makes created fields easier to locate—you can search for anything in a field definition name. For Pagination, the default number of fields per page is 100, but you can choose 10, 20, 50, 100, 200, or 1000 in the dropdown.
Examples of Custom Fields for Events:
Creating Field Definition Groups
Once a field definition is created, it will need to be enabled. Currently, Incident IQ supports seven types of custom fields:
Tickets: Applied to the ticket submission process to capture relevant data for agents or relay pertinent information to requestors
Assets: Applied to an asset’s details page and are editable by any user with the appropriate level of permissions
Users: Found in the profile section of a user’s profile page
Parts: Applied to any of the parts in the part list
Events: Applied to the Event Registration Ticket to capture relevant data for Approvers and to pass on for work order creation.
Locations: Applied to the Locations page to capture relevant information for the Room.
Rooms: Applied to the Room page to capture relevant information for the Room.
To enable a Custom Field to an Event, navigate to Administration > Custom Fields click on the Events tab, and select Add Field with New Conditions. A new window will be displayed, allowing the user to select the definition to be enabled.
The definition field will appear in a new section underneath the Custom Fields column. One or more definitions can be added as a group that shares the same conditions by clicking Add Field.
To narrow down where this custom field appears, add a condition(s). Click Add Condition, select a filter category, and narrow it down to the condition for that group. Click Save Filter, and the new condition will appear under the Conditions column.
Select the Custom Field to add to Events
If required, click Add Condition
Select which filters to apply to the Custom Field
Save Filter
Additionally, a new field group will appear every time Add Field with New Conditions is selected. Using this method, a user can create sets of custom fields and conditions that can be quickly and easily refined as needed.
By default, Custom Fields will apply to all Events. To select specific Event attributes, the Custom Field must have conditions set.
Here is an example of some custom fields added to a new Event Details page.
---
Hannah Bailey - Director, Customer Engagement