Jama Connect User Guide

Add, edit, and delete fields

When editing an item type, you can add, edit, and delete fields.

Note

You must have organization administrator permissions to complete this task.

  1. Select Admin > Organization > Item types

  2. Select Fields for the item type you’d like to change to open an Item type fields panel on the right.

  3. You see a list of existing fields with information about each one. Here you can select a row to highlight it in blue, then select one of the icons in the top toolbar:

    itemtypefields.png
    • Edit a field

      Select the pencil icon to open the Edit field window.

    • Reorder fields

      Use the green up and down arrow buttons.

    • Delete a field

      Caution

      Please consider the following before deleting a field:

      • Once a field is deleted, all values related to that field will be deleted from the database and cannot be recovered.

      • If the field was used to relate synced items (JIRA KEY, proxy, etc.), a duplicate item will be created if you try to create the sync again.

      • If the field is mapped in an integration, that field will no longer update and could cause errors in your integration tool.

      • If filters used the field, filter results will become inaccurate. The filter should be updated before removing the field.

      • If the deleted field raised suspect links, relationships will be affected. Because the field no longer exists, users will not be able to see the changes that created the suspect link.

      • If you attempt to restore a previous version of an item that still contains the deleted field, the field's contents will not be restored. Even if you recreate the field prior to the version rollback, data will not be restored.

      • If you still want to delete a custom field, consider exporting a copy of those field values via a report or the API.

      To delete a field select the field then select the red x icon.

    • Add a field

      Select the green Add field icon to open the Add field window. 

  4. If you selected Add or Edit, a window will open where you can select the following options:

    add_edit_field_window.png
    • Select a field type

      If you are adding a new field, you must first indicate what type of field. Select either a predefined field or custom field. Both field types can be used in the same item type. (This section does not appear when editing fields). 

      Important

      You can only use the system predefined Release field to show items in the Releases tab. If you use a custom Release field to designate an item to a release, that item will not appear in the Releases tab. 

    • Field label

      This is the field name that users will see.

      Caution

      When creating a new field, the application automatically uses the field label that you enter to name the unique field name in the database. Once it has been saved, even though you can change the field label, you can't change the unique field name in the database.

      Avoid leading with an underscore when naming fields. There are some unique field names that may conflict with Elasticsearch fields (like "_source" and "_ID") and prevent proper functioning.

    • Unique field name

      This is the name of the field in the database.

    • Read only

      Select this box to prevent users from editing the field. 

    • Allow API overwrite

      Fields that are configured to be read-only have the option to be editable via the REST API. System fields like modifiedDate or rollup do not allow the option to overwrite.

    • Is required

      Required fields are string, text or date fields that are configured so that the user must enter data into the field before saving an item.

    • Use to trigger suspect

      Suspect links is triggered when specific fields update in an item. This option lets you determine which field changes will flag an item as suspect.

    • Synchronize

      When items are synchronized to other items, a change in a field with this checkbox will flag this item as out of sync in the synced items window and in Single Item View.

    • Text components

      If you chose to add a text box field, you will need to choose if you want it to have rich-text capabilities.

      enable_rich_text.png
    • Pick list

      If you choose to add a field that controls user input with a lookup or pick list, you must select the pick list from the drop-down menu. If you have not already created a pick list, close the window and add a pick list before making the field.

  5. Select Save. By default, new fields are added to the bottom of the item type fields list, but you can reorder using the green arrows.