Define required fields

Tabs: Site or Workspace > Fields. Visible to Site or Workspace Administrators respectively.

Require users to define a value when first creating a user story, defect, theme, or feature. You can also Manage custom fields.

If you define in the Site > Fields tab that a field is required, the field is required in all workspaces and releases defined in the site. If you define in the Workspace > Fields that a field is required, the field is required in the current workspace only.

To define that a field is required:

  1. Do one of the following:

    • Add a custom field
    • Select an existing system or custom field and click Edit
  2. In the Add Field or Edit Field dialog box, select the Mark this field as required option.

Note:  

  • You cannot add, remove, or edit system fields, but you can define them as required.

  • If you define a field as required at the site level, you cannot change this at the workspace level. If a field is not required at the site level, you can mark it as required at the workspace level.

  • Attachment and Memo fields cannot be marked as required.

  • To mark the Application field as required, use the Workspace > Settings configuration tab (available to Workspace Administrators).

Required fields are indicated with a red asterisk (*), in the Add Item dialog box. Additionally, required fields are indicated on the Fields configuration page in the Required (in Add Item / Import) and Displayed in Add Dialog columns.

  • Field requirements are enforced only when adding items using the Add Item dialog box, importing backlog items, or converting a user story to a feature.

    They are not enforced when updating existing items in grids or on the Details page, when synchronizing items with ALM, or when adding items using Copy Item or the Agile Manager API.

  • Some system fields are always displayed in the Add Item dialog box. This is indicated in the Displayed in Add Dialog column and cannot be modified.

    You can specify whether this field requires the user to define a value.

    Example:  

    In this system (click the image):

    • The user story Description system field is always displayed, though it is not required.
    • The theme Description system field is displayed only because it is required.
    • The feature Description system field is not displayed or required.
    • You can also see how some custom fields are set up.

Maximum number of required fields

  • A maximum of 25 fields can be displayed in the Add Item dialog box for each entity type, including out-of-the-box fields that are always displayed.

    In each workspace, the maximum includes all relevant site-level fields, as well as fields that you defined as required in the current workspace.

    Once the maximum is reached, you cannot define any more fields as required for that entity type.

  • Setting a Backlog Item field as required counts towards the maximum for both user stories and defects.

Tip: When adding or editing a field, a note is displayed indicating the number of fields already included in the Add Item dialog box.

To see which fields are included in the Add Item dialog box, do one of the following:

  • On the Workspace > Fields tab, preview the dialog box as described below.

  • Filter the Fields configuration page:

    - In the Apply To column, select the relevant entity type.

    - In the Displayed in Add Dialog column, select Always displayed and Displayed when required.

Preview the updated Add Item dialog box

On the Workspace > Fields configuration tab, select a field and click Preview to view the Add Item dialog box for the relevant entity type, with all required fields included.

You may want to do this if you have many required fields and are concerned about crowding the Add Item dialog box for your users.

Caution: The preview dialog box includes your latest changes, but when you finish editing, you must log in again to see the changes in Agile Manager.

Importing items with required fields

If you import user stories or defects to Agile Manager, you must add additional columns to the import files for any fields marked as required, using the exact field names.

You may want to mark these extra columns as required by adding a comment to the column header, and save the file as a template for later use.

Note: When you import backlog items, field requirements for themes and features are not enforced. This enables you to import backlog items associated with new themes and features, which are created during the import.

For more details, see Import backlog items.