If you would like to add custom fields to Ketryx default item types, or custom item types, and have Ketryx read those fields, you can follow the below instructions. Note: you will need Jira Admin permissions to configure item fields and screens.
Step 1: Create a New Custom Field in Jira
- Login to your Jira admin
-
Navigate to your Project Settings.
-
Click the gear icon (⚙️) → select Work items.
Note: In the latest versions of Jira “Issues” has been replaced with “Work Items” -
Navigate to the work items screens in the left-hand menu > Search for the Ketryx item type that you would like to add a custom field to
-
Click on the three dots on the right side of the item and create a copy of the Ketryx work items screen
-
Navigate to Custom Fields in the left-hand menu
-
Click Create Custom Field in the upper right of the screen
-
Choose the field type that makes sense for the desired field
-
Enter a name and description
-
Associate the field with the issue type that this field is related to > Click Update.
-
Navigate to Field Configurations on the left-hand side menu
-
Click the Default Field Configuration
-
Search for the newly created custom field
-
Click Renderers
-
Change the renderer from the Default text renderer to the Wiki style renderer (this allows tables, bullet points, images, etc.).
Step 2: Edit the Issue Layout (Optional)
-
Go back to Project Settings.
-
Click Work items → Layouts.
-
Find the issue type → click Edit Issue layout
-
Move the custom field to the desired position in the layout
-
Click Save Changes.
Step 3: Associate the Custom Field to Screen Scheme
-
If not already in the work items menu - Navigate back to your Project Settings. Click the gear icon (⚙️) → select Work items.
-
Navigate to the custom field on the left-hand side
- Search the custom field that you created > click on the 'Associate to screen' option
- Add
to configure it to include the new custom field, removing the standard Ketryx field
- Navigate to Screen Schemes on the left-hand side
- Search for the relevant items scheme and create a copy, and name it something relevant
- Navigate to the work items screen schemes on the left-hand side
- Choose the your project's scheme > click on the three dots on the right > click configure
- Choose the new copy scheme that you created > click update
Step 4: Advanced Configuration in Ketryx
In this step, we tell Ketryx to read the newly created custom field in Jira.
-
In Ketryx, navigate to your project > Select Advanced Settings from the left-hand menu.
- Note: It is also possible to tell Ketryx to read this extra field at the Org-level
-
Find the Extra Field Names setting.
-
Add the appropriate JSON for the custom field you just created
-
Click Save Changes
This video guides you through creating custom fields in Jira and performing advanced configurations in Ketryx.
Comments
0 comments
Article is closed for comments.