6.8.3. Manage Custom Fields

⁠6.8.3. Manage Custom Fields

This page is the base point for managing custom fields. It lists the custom fields defined in the system. There is also a place to enter a new field name to create a new field.The "Edit" links take you to a page where you can define the details of a custom field. These include it's name, type, value, and display information. On the edit page, the following information is defined to control the custom field:

name
type. Possible values are listed below.
Value constraints (Possible values, default value, regular expression, minimum length, maximum length).
Access (who can read and write the field based on their access level).
Display control (where the field will show up and must be filled in

All fields are compared in length to be greater than or equal to the minimum length, and less than or equal to the minimum length, unless these values are 0. If the values are 0, the check is skipped. All fields are also compared against the regular expression. If the value matches the expression, then the value is stored. For example, the expression "^-?([0-9])*$" can be used to constrain an integer.The table below describes the field types and the value constraints.

Type	Field Contents	Value Constraints
String	text string up to 255 characters
Numeric	an integer
Float	a floating point number
Enumeration	one of a list of text strings	Enter the list of text strings separated by "\|" (pipe character) in the Possible Values field. The Default value should match one of these strings as well. This will be displayed as a dropdown menu.
Email	an email address string up to 255 characters	When displayed, the value will also be encapsulated in a mailto: reference.
Checkbox	zero or more of a list of text strings	Enter the list of text strings separated by "\|" (pipe character) in the Possible Values field. The Default value should match one of these strings as well. This will be displayed as a list of text strings with a checkbox beside them.
List	one of a list of text strings	Enter the list of text strings separated by "\|" (pipe character) in the Possible Values field. The Default value should match one of these strings as well. This will be displayed as a multi-line dropdown menu.
Multiselection List	zero or more of a list of text strings	Enter the list of text strings separated by "\|" (pipe character) in the Possible Values field. The Default value should match one of these strings as well. This will be displayed as a multi-line dropdown menu.
Date	text string defining a date	This is displayed as a set of dropdown menus for day, month, and year. Defaults should be defined in yyyy-mm-dd format.

The display entries are used as follows:

Entry	Meaning
Display Only On Advanced Page	If checked, the field will NOT be shown on the simple issue displays
Display When Reporting Issues	If checked, the field will be shown on the report issues displays
Display When Updating Issues	If checked, the field will NOT be shown on the update issue and change status displays
Display When Resolving Issues	If checked, the field will NOT be shown on the update issue displays and change status displays, if the new status is resolved.
Display When Closing Issues	If checked, the field will NOT be shown on the update issue displays and change status displays, if the new status is closed.
Required On Report	If checked, the field must be filled in on the issue reports.
Required On Update	If checked, the field must be filled in on the update issue and change status displays.
Required On Resolve	If checked, the field must be filled in on the update issue and change status displays, if the new status is resolved.
Required On Close	If checked, the field must be filled in on the update issue and change status displays, if the new status is closed.

Notes on Display

Be careful not to set both a required attribute and show only on advanced display. It may be possible to trigger a validation error that the user cannot recover from (i.e., field is not filled in).