Custom Event Fields
Custom Event Fields is a standard configuration interface for adding, editing, and removing fields from the Event.Events table. Event fields that are provided out-of-the-box cannot be deleted, and indices may be added to fields that do not already have an index. See the Adding Custom Fields to Events DB guide for detailed information on how to use this UI and the ApplyEventSchema application.
Once a new field has been added, the field name cannot be modified. See the Adding Custom Fields to Events DB guide for additional information on how handle "renaming" a field.
Refer to the Standard Configuration Interface guide for details on interacting with the grid and form.
This user interface calls REST methods from api/event/customEventFields.
The UI path for this interface is Configuration -> Events -> Custom Event Fields.
Form Fields
-
Field Name - The name of the field to be added to the Events table.
-
Field Type - The database-specific field types.
-
Type Size - The maximum size of the field. This field will only be visible for some string-type fields. String-type fields such as CHAR have a maximum length that can be specified. If no value is provided, the database will determine the size.
-
Type Precision - The storage format that will be used for the field. This field will only be visible for some number-type fields. Number-type fields such as DECIMAL have a maximum length that can be specified.
-
Index Type - The index type to apply to the field. No index will be applied by default.
-
Default to NULL - Flag to indicate if the default value should be null. Not all fields allow a default value to be specified. It is highly recommended that a default value be specified if possible for consistency of filter comparisons.
-
Default Value - The value to insert into the field if no value is provided when a record is created. Some field types, such as LINESTRING, do not allow a default value to be specified.
Best Practice
- It is highly recommended that a default value be specified if possible for consistency of filter comparisons.