Understand Jama Connect® Item IDs: Project ID, Global ID, and What You Can Modify

Published Date: April 20, 2024
Validated: Yes
Audience: Everyone

Products and Versions Covered

• Jama Connect® All supported versions
  • Cloud/CVC
  • Self-hosted:

Summary

An item ID is a unique identifier assigned to an item in Jama Connect®. Item IDs help identify and track items within projects and across synchronized projects.

This article explains:

• The difference between Project IDs and Global IDs
• How Jama Connect® generates item IDs
• The components that make up each identifier
• Which parts of an item ID can be modified
• How changing a Set Key impacts existing and future item IDs

Resolution

Each item in Jama Connect® has two identifier fields:

• Project ID
• Global ID

Understanding the difference between these identifiers is important when managing projects, synchronizing items, or updating item numbering conventions.

Project ID

A Project ID identifies an item within a specific project. Each item has a unique Project ID based on three components:

1. Project Key

   The Project Key identifies the project where the item exists.

   • Project Keys must be unique across your organization.
   • Project Keys can contain letters, numbers, and underscores.
   • Project Keys can be 1–16 characters long.
   • A project or organization administrator can update the Project Key.
   • Changing the Project Key does not reset item numbering.

2. Set Key

   The Set Key identifies the item set within a project.

   • The same Set Key can be used across different projects.
   • A project or organization administrator can update the Set Key.
   • Changing the Set Key can affect how new item IDs are generated.

3. Set Counter

   The Set Counter is the sequential number automatically assigned to each item.

   • The counter increases as new items are created.
   • Unlike the Global ID counter, the Set Counter can be reset when the Set Key is changed.

Example:

Project Key - Set Key - Set Counter

LUIS2022-Defect_2022-001

Global ID

The Global ID identifies items that are synchronized between projects.

A Global ID contains the following components:

1. Project Key
2. Set Key
3. Global ID Counter

The Global ID Counter provides a unique identifier for synchronized items.

When an item is synchronized between projects:

• The Project ID changes based on the destination project.
• The Global ID remains unchanged.
• Synchronized items share the same Global ID.

This allows Jama Connect® to maintain relationships between synchronized items across projects.

What Can Be Modified in a Project ID?

The only component of an existing Project ID that can be modified is the Set Key.

Administrators can use the Set Key Change option to update the Set Key.



Example:

Current Set Key:

Project Key: LUIS2022
Set Key: Defect_2022

New Set Key:

DEF_2023

Option 1: Change the Set Key Only

Selecting only New Set Key updates the Set Key for newly created items.

• Only new items created in this set (using Add New or Duplicate) will use the new Set Key.
• All pre-existing items will keep the original Set Key in their existing item IDs.
• Existing item IDs are not changed.

Option 2: Change the Set Key and Regenerate Item IDs

Selecting Regenerate Item IDs updates all item IDs within the set using the new Set Key.

This updates both new and pre-existing item IDs within the set to use the New Set Key.

Type Key Changes

Changing the Type Key does not update existing item IDs.

The Type Key only determines the default Set Key value when creating a new component set.

Example:

When creating a new Defect component set:

Default Set Key:

BUG

The administrator can update the default value:

BUG2022

This change only affects newly created component sets and does not modify existing item IDs.

Limitations

The following cannot be modified:

• The Item ID counter
• The Global ID
• Existing Global ID relationships created through synchronization

These identifiers are managed by Jama Connect® to maintain item uniqueness and synchronization relationships.

Additional Resources 

• Success Programs
• Success Catalog
• Datasheets
• Request a Solution Offering or Training from the Success Catalog

Feedback:
We welcome your input! Please sign in to leave any comments, suggestions, or ideas for improvement below.