Custom fields

Add your own fields to issues — text, numbers, dates, dropdowns, people, formulas and roll-ups.

Admin → Custom fields

Custom fields add your own questions to issues — a customer name, an environment, a cost estimate. They are defined once for the workspace and can be offered everywhere or in a single project.

Create a field

  1. Open Admin and choose the Custom fields tab.
  2. Choose New, then pick a Format.
  3. Enter a Name. The Key is generated from it; it is how formulas and the API refer to the field.
  4. Fill in the options for that format (below), choose where the field applies, and choose Create field.

Click a field in the list to edit it, then Save changes.

Formats

  • TEXT — free text, with optional Min length, Max length, a Regular expression the value must match, Text formatting (rich text) and a Default value.
  • NUMBER, DATE, BOOLEAN (yes/no) and USER (a member of the workspace).
  • SINGLE_SELECT and MULTI_SELECT — a list of choices, entered under Possible values (one per line).
  • FORMULA — a number worked out from the issue's other numbers.
  • ROLLUP — a number worked out from the issue's sub-issues.

Length, pattern and allowed-value rules are checked by the server, so they hold for the API and imports as well as the form.

Options that depend on another field

A select field can take its choices from another single-select field's answer, the way a category narrows a sub-category. Under Options depend on, pick the parent field; then, for each of its answers, list what this field should offer. An answer left blank offers nothing, and the field stays hidden when that answer is chosen.

Formulas and roll-ups

A Formula uses + - * /, brackets and min(), max(),round(x, places) and abs(), with field keys in braces — for example{story_points} * 8. The editor lists the numbers you can insert: story points, the estimate in hours, your number fields and roll-ups. If a number it reads is empty, so is the answer.

A Roll up takes the sum, average, lowest or highest of a number — or counts sub-issues — Across all, open or done sub-issues.

Nobody fills in a formula or roll-up, so they can never be required.

Where a field appears

  • Projects — leave For all projects ticked, or untick it and pick one project.
  • Project Schemes — a project's own Schemes page (in the project header, for people who can edit the project) chooses which of the workspace's fields that project offers, and can create fields scoped to it. A project that has never been configured there offers every field that applies to it.
The Visible (roles), Trackers, Used as a filter and Searchablesettings are saved with the field, but they do not yet change where it is shown. Use project scope and Schemes to control where a field appears.

Required fields

Tick Required under Behaviour and an issue cannot be created without a value — in projects that offer the field. It is checked when an issue is created, not on later edits, so issues that existed before the field became required are not locked. A dependent field is only required once it has something to offer.

Deleting a field

The bin icon next to a field deletes it straight away — there is no confirmation step, so check the name first. Managing fields needs the custom field create and update permissions (Owners and Admins).