ScreenChoicesField

Describes an available built-in field available as a search results field on a management screen.

default_labelstring

The default label for the field.

Example: Accrual Name

default_tooltipstring

The default tooltip for the field shown when hovering over the field label.

Example: The name of the Accrual.

field_typestring

The type of the field. Direct fields are fields that are directly on the main table. Extended fields are fields that are on a related table.

Possible values: [direct, extended]

Example: direct

idstring

The hardcoded identifier for the field within the screen. These are unique within the screen, but not across different screens. (Same as id_field.)

Example: pname

id_fieldstring

The hardcoded identifier for the field within the screen. These are unique within the screen, but not across different screens. (Same as id.)

Example: pname

id_screenstring

The unique identifier for the screen that this field is on.

Example: accruals

is_booleanboolean

Whether the field is a boolean field, which will be displayed as a "Yes" or "No" value in the column.

Example: false

is_percentboolean

Whether the field is a percentage field, which will be displayed as a formatted percentage value in the column.

Example: false

is_truncatedboolean

Whether the field is automatically truncated when displayed in the search results; the full value can be seen in the tooltip.

Example: false

is_urlboolean

Whether the field is a URL field, which will be displayed as a clickable link in the column.

Example: false

mod_labelstring

The description to show for this field in the Field Modification screen (the UI adjustment screen). This does not appear on the actual management screen.

Example: Accrual Name

mod_label_tooltipstring

The tooltip to show for this field in the Field Modification screen (the UI adjustment screen). This does not appear on the actual management screen.

Example: The name of the Accrual.

numericboolean

Whether the field is a numeric field, which will be displayed as a formatted number in the column.

Example: false

requiredboolean

Whether the field is required to be present on the management screen.

Example: false

searchableboolean

Whether the field is searchable in the search panel area on the management screen.

Example: true

sort_by_fieldstring

If set, this is an alternate field to use for sorting the search results when this field is selected for sorting.

sortableboolean

Whether the field is sortable in the search results.

Example: true

ScreenChoicesField

{
  "default_label": "Accrual Name",
  "default_tooltip": "The name of the Accrual.",
  "field_type": "direct",
  "id": "pname",
  "id_field": "pname",
  "id_screen": "accruals",
  "is_boolean": false,
  "is_percent": false,
  "is_truncated": false,
  "is_url": false,
  "mod_label": "Accrual Name",
  "mod_label_tooltip": "The name of the Accrual.",
  "numeric": false,
  "required": false,
  "searchable": true,
  "sort_by_field": "string",
  "sortable": true
}