Custom Item Types
Reference of the custom item types feature in Ketryx
Ketryx enables the tracking of arbitrary item types using the Custom Item Types feature. These item types can be either long-lived or point-wise (explained here) and they will behave in the exact same way as the default item types (e.g. Requirement) would.
NOTES:
Adding custom item types should only be performed by your Ketryx organization owner and Jira instance admin.
After adding a custom item type, it is not recommended to change its lifecycle afterwards.
Getting started
The following will explain the full workflow for configuring a custom long-lived item type called Folder in both Ketryx and Jira. The steps assume that a project called Test Project exists in both systems.
Configuration in Ketryx
Navigate to Organization > Advanced
Add the Folder item type into the Custom item types setting:
Add the Folder item type into the Issue mapping setting (this can also be done in a specific project's advanced settings):
Click Save changes and confirm
At this point, every project in the Ketryx organization is ready to track Folder items from Jira. However, Ketryx does not assign any approval groups to custom item types by default. Therefore, it is recommended to configure the approval groups accordingly.
Navigate to Projects > Test Project > Settings > Approval rules
Add approval groups for the Folder item type
Configuration in Jira
It is considered a best practice to copy the default Ketryx schemes (Issue type scheme and Issue type screen scheme) into new ones instead of modifying the default ones.
NOTE: If the aforementioned Ketryx-specific schemes have already been copied for your project, you can directly edit them instead of copying them again.
Click the cogwheel button in the top right and navigate to Jira Settings > Issues
From the left-hand menu, navigate to Issue types
Click Add issue type
Name: Folder
Type: Standard Issue Type (Level 0)
Click Add
From the left-hand menu, navigate to Issue type schemes
Filter for "ketryx" and click the "..." button next to the scheme assigned to your project (in most cases, it will be Ketryx issue type scheme)
Click Copy
Give the scheme a descriptive name, such as "Ketryx issue type scheme (Test Project)"
Empty the Description field
Drag-and-drop the Folder issue type from Available Issue Types into Issue Types for Current Scheme
Click Save
From the left-hand menu, navigate to Screens
Filter for "ketryx task" and click the "..." button for Ketryx Task screen (the Task item type is a good default to base a new screen configuration on)
Click Copy
Give the screen a descriptive name, such as "Ketryx Folder screen"
Empty the Description field
Click Save
The following steps are only required for long-lived item types:
Filter for "ketryx folder" and click the "..." button for Ketryx Folder screen
Click Configure
Add the Obsolete in version field
From the left-hand menu, navigate to Screen schemes
Click Add screen scheme
Give the screen scheme a descriptive name, such as "Ketryx Folder screen scheme"
Default Screen: Ketryx Folder screen
Click Add
From the left-hand menu, navigate to Issue type screen schemes
Filter for "ketryx" and click the "..." button for Ketryx issue type screen scheme
Click Copy
Give the issue type screen scheme a descriptive name, such as "Ketryx issue type screen scheme (Test Project)"
Empty the Description field
Click Copy
Filter for "ketryx" and click the "..." button for Ketryx issue type screen scheme (Test Project)
Click Configure
Click Associate an issue type with a screen scheme
Issue Type: Folder
Screen Scheme: Ketryx Folder screen scheme
Click Add
Click the cogwheel button in the top right and navigate to Jira Settings > Projects
Click the "..." button for Test Project
Click Project settings
From the left-hand menu, navigate to Issues > Types
Click Actions > Use a different scheme
Select Ketryx issue type scheme (Test Project)
Click OK
From the left-hand menu, navigate to Issues > Screens
Click Actions > Use a different scheme
Select Ketryx issue type screen scheme (Test Project)
Click Associate
Now, both the Jira and Ketryx projects are configured to track Folder items.
Last updated