Skip to main content

Jama Connect User Guide

Add and edit item types

You can create a new item type, add or delete fields in an existing item type, or change the item type details. Once an item type is created, users can add it to their project.

Note

You must have organization admin permissions to complete this task.

Important considerations

  • Changes to an item type affect that item type in all projects. Item types can't be customized for individual projects.

  • Jama Connect comes with a core set of item types that can't be deleted. When you select Admin > Organization > Item types, core item types don't include a Delete option.

  • You can see a list of core item type fields in Admin > Organization > Item Types > Core > Views > Projects List View - Mixed Item Types. Custom fields can't be selected for visibility in mixed item type views.

    Image shows the list of core item type fields: Item type, Locked, Locked by, Last locked, Release, Assigned to, Created by, Created date, Modified by, Modified date, Project, # of comments, # of upstream relationships, # of downstream relationships, Relationship status, Last activity date, ID, Name, Description, Connected users, Risk

  • Before a new item type can be used in a project, it must be added to that project by a project or organization admin.

Tip

The fewer item types that your organization creates, the easier it is to manage items and to report on the sets based on those item types.

To add or edit an item type:

  1. Select Admin > Organization, then select Item types.

  2. To add a new item type, click Add item type. To edit an existing item type, click Edit for the item type you want to modify. 

    add_edit_item_type_annotated.png

  3. In the Add item type window that opens, select or modify the following options:

    Add item type window shows the following fields: Display, Display plural, Description, Type key, Use as, Widgets and Image.

    • Display — (Required) Name for a single item of this item type.

    • Display plural — (Required) Name for multiple items of this item type.

    • Description — Explanation for how this item type is used or how it is distinguished from other item types.

    • Type key — (Required) The default ID Prefix that is shown when creating a set using the item type. It can be overwritten.

    • Use as — Option if you are using this item type for special use for test. (If you're using the REST API to create an item type, it refers to this as a Category).

    • Widgets — Small embedded applications that add functionality to item types. Read more about widgets or how to enable or disable them.

    • Image — (Required) The icon displayed for this item types. Icons are used as the set icon, the list view icon, and the icon at the upper-left of the item view.

    • Library icon and Custom icon — (Required) The icon for the item type you're editing. Icons are used for set (container), List View, and in the upper left corner in Single Item View.

      Admins can use default icons or upload their own custom 16x16 pixel icon. Custom icons can’t be reused and must be uploaded for each item type.

      Note

      A custom icon must be deleted by an admin to revert to a library icon.

      library_or_custom_icon.png

    • API ID — A reference ID that is automatically assigned to an item type for API reporting purposes. You can see this ID by selecting Admin > Item types, but it cannot be specified or changed.

  4. Click Save.

Important

You can delete an item type but you are prompted to delete any existing items of that type before you delete it. To delete, select the item type you want to delete and click Delete.

In this section: