Custom Event Fields
Custom Event Fields is a standard configuration interface for adding, editing, and removing fields from the Event.Events table. You cannot delete the default event fields, and you can add indexes to fields that do not already have an index. See Adding Custom Fields to the Event Database in Unified Assurance Implementation Guide for detailed information about how to use this UI and apply changes by running the ApplyEventSchema application.
After a new field has been added, you cannot modify the field name. See the Best Practices for Adding Custom Fields in Unified Assurance Implementation Guide for additional information about how to handle renaming a field.
For information about interacting with the grid and form, see Standard Configuration Interface in Unified Assurance Concepts.
This user interface calls REST methods from the api/event/customEventFields endpoints. See REST API for Unified Assurance Core for details.
To open this interface, from the main navigation menu, select Configuration, then Events, and then 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. This can be a literal value or a SQL function. See About Default Values for Custom Event Fields for more information.
-
Default is Expression: Whether the default value is a literal value, such as a string or integer, depending on the Field Type, or a SQL function.
About Default Values for Custom Event Fields
Oracle highly recommends specifying default values, if possible, for consistency of filter comparisons.
The default values can be literal values or SQL functions.
About Using Literal Default Values
For literal values, some field types, such as LINESTRING, do not allow a default value to be specified. Others like FLOAT and DOUBLE only allow very specific default values. DECIMAL fields will always default to the specified precision. For example, DECIMAL(13,3) with a default of 0 will insert 0.000 into the database. The following table lists the minimum and maximum values and notes about default values.
| Field Type | Minimum Value | Maximum Value | Default Value Notes |
|---|---|---|---|
| BIG INT | -9,223,372,036,854,775,808 | 9,223,372,036,854,775,807 | N/A |
| BIG INT UNSIGNED | 0 | 18,446,744,073,709,551,615 | 0 or 1 only |
| DATE | 1000-01-01 | 9999-12-31 | N/A |
| DATETIME | 1000-01-01 00:00:00.000000 | 9999-12-31 23:59:59.499999 | N/A |
| DECIMAL | N/A | 64 digits of precision, 30 digits may be decimal | 8 digits of precision |
| DOUBLE | N/A | 53 digits of precision | 0 or 1 only |
| FLOAT | N/A | 23 digits of precision | 0 or 1 only |
| INT | -2,147,483,648 | 2,147,483,647 | N/A |
| INT UNSIGNED | 0 | 4,294,967,295 | N/A |
| LINESTRING | N/A | N/A | No Default Allowed |
| LONGTEXT | N/A | 4,294,967,295 characters | No Default Allowed |
| MEDIUMINT | -8,388,608 | 8,388,607 | N/A |
| MEDIUMINT UNSIGNED | 0 | 16,777,215 | N/A |
| MEDIUMTEXT | N/A | 16,777,215 characters | No Default Allowed |
| POINT | N/A | N/A | No Default Allowed |
| SMALLINT | -32,768 | 32,767 | N/A |
| SMALLINT UNSIGNED | 0 | 65,535 | N/A |
| TEXT | N/A | 65,535 characters | No Default Allowed |
| TIMESTAMP | 1970-01-01 00:00:01 UTC | 2038-01-19 03:14:07 UTC | N/A |
| TINYINT | -128 | 127 | N/A |
| TINYINT UNSIGNED | 0 | 255 | N/A |
| TINYTEXT | N/A | 255 characters | No Default Allowed |
| VARCHAR | N/A | 65,535 characters | N/A |
About Using SQL Functions for Default Values
For all field types other than VARCHAR, you can use standard SQL functions to resolve the default value.
For example, use CURRENT_TIMESTAMP to set the default value to the current timestamp or (now()+interval 1 hour) to set the default value to a range between the current time and an hour from then.
When using SQL functions, except when you use the CURRENT_TIMESTAMP function:
-
Enclose the function in parentheses.
-
Use lowercase letters. For example, (round(2.6,0)) instead of (ROUND(2.6,0)).
When you use the CURRENT_TIMESTAMP function, with or without the ON UPDATE clause, do not enclose it in parentheses.