Configure default and custom fields

Standard
Enterprise

In Jira Align, you can customize field settings on most work items. You may specify what fields are visible and accessible to users from an item’s details panel, and what fields must be filled out to create a new work item. These settings can be unique for each work item type and have the option to be portfolio-specific*. 

You can also create custom fields to capture attributes specific to your organization. Each work item type supports multiple custom fields.

Details Panels Settings

Supported work items

The following work items allow you to create custom fields, modify field visibility, and set fields as required:

  • Themes*
  • Capabilities
  • Epics
  • Features
  • Stories
  • Tasks
  • Defects 
  • Test Cases
  • Objectives
  • Dependencies
  • Risks
  • Success Criteria

*Note: Theme field settings are global, instead of portfolio-specific. 

Display and require fields 

To manage field settings for a work item: 

  1. Select the Settings gear Gear in the top navigation bar.
  2. On the left side of the page, select Details Panels Settings in the Settings section.
  3. Select a portfolio from the Portfolio dropdown. 
  4. Select a work item type from the Work Item dropdown. The list of default and custom fields displays on the right side of the page. 
  5. If your work item type supports multiple tabs in its details panel, each tab will display on the right side of the page. Select the tab name to see the fields it contains.
  6. To display a field and make it accessible on Details panels, switch on its Active toggle Toggle_Switched_On.png. To hide a field from users, switch the toggle off Toggle_Switched_Off.png. Note that fields with light blue toggles Default_Toggle.png cannot be hidden. 
  7. To require that a field contain data when creating a new work item or saving edits to an existing work item, switch on the Required toggle Toggle_Switched_On.png. A field must be active to be required. 
  8. Select the Save button from the upper-right section of the page. 

To restore the default Active and Required settings for a work item and portfolio set, select the Restore Defaults button from the upper-right corner. 

Notes:

  • Access to the details panels settings page requires that the Details Panels Settings system permission toggle is switched on. Switching on the Details Panel Settings toggle will enable a set of child toggles that control access to field settings for each work item type. These permission toggles are all switched on by default for the Super Admin role. You may switch on the toggles for other system roles on the roles settings page.
  • When creating new work items, fields will display on the side panel using the default work item settings first. Once a program has been selected, the panel will update according to your saved settings for the portfolio. 

Create and manage custom fields

Custom fields are global. When you create a new custom field, any portfolio may use it. As with default fields, active and required status can be unique to each portfolio. Custom fields can be identified in the details panels settings page by the gear icon Gear_Icon.png to the right of their names. 

Custom_Fields.png

Supported field types

Each work item type supports a number of different custom fields:

  • Custom Text Input -- Up to 2 fields
    • A small text entry box, intended for words or short phrases. 
  • Custom Dropdown -- Up to 3 fields
    • A dropdown list of choices, where one selection can be made. 
  • Custom Text Area -- 1 field allowed
    • A larger text entry box with some Rich-Text Formatting abilities, intended for paragraphs.
  • Custom Multi Dropdown -- Up to 2 fields
    • A dropdown list of choices, where one or more selections can be made. 

Create custom fields

To create a new custom field:

  1. Select the Settings gear Gear in the top navigation bar.
  2. On the left side of the page, select Details Panels Settings in the Settings section.
  3. Select a portfolio from the Portfolio dropdown. 
  4. Select a work item type from the Work Item dropdown. The list of default and custom fields displays on the right side of the page. 
  5. Select the Add Custom Field button from the upper-right section of the page. The Customize Your Page Level Experience menu displays. 
  6. Select a field type for the new field from the Custom Field Type dropdown. 
  7. Enter a name for the custom field in the Custom Field Label text box. 
  8. Select Create at the bottom of the menu to create the custom field. 
  9. If you selected the dropdown or multi dropdown field type in step 3, you’ll need to add options for the field. Enter a name for the first field value in the Option 1 text box that displays. 
    1. Select Add Item to List to add another field value. An Option 2 text box will display. Repeat for as many field values as you need.
    2. Select Save to save the list of values.
  10. The new custom field displays on the details panels settings page, and can be set as active and required. 

To change an existing custom field’s name, select the gear icon Gear_Icon.png to the right of the field. You can also edit the field values for dropdown fields through this menu. You cannot change the field’s type after creation. 

Important: After a custom field has been created, it cannot be deleted.

Was this article helpful?
1 out of 1 found this helpful
Print Friendly Version of this pagePrint Get a PDF version of this webpagePDF

Join the Atlassian Community!

The Atlassian Community is a unique, highly collaborative space where customers and Atlassians come together. Ask questions and get answers, start discussions, and collaborate with thousands of other Jira Align customers. Visit the Jira Align Community Collection today.

Need to contact Jira Align Support? Please open a support request.