How do I create custom fields in Jira and Ketryx?

Lee Chickering
Lee Chickering
  • Updated

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

  1. Login to your Jira admin
  2. Navigate to your Project Settings.

  3. Click the gear icon (⚙️) → select  Work items.
    Note: In the latest versions of Jira “Issues” has been replaced with “Work Items”

  4. 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

  5. Click on the three dots on the right side of the item and create a copy of the Ketryx work items screen

  6. Navigate to Custom Fields in the left-hand menu

  7. Click Create Custom Field in the upper right of the screen

  8. Choose the field type that makes sense for the desired field

  9. Enter a name and description 

  10. Associate the field with the issue type that this field is related to > Click Update.

  11. Navigate to Field Configurations on the left-hand side menu

  12. Click the Default Field Configuration

  13. Search for the newly created custom field

  14. Click Renderers

  15. 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)

  1. Go back to Project Settings.

  2. Click Work itemsLayouts.

  3. Find the issue type → click Edit Issue layout

  4. Move the custom field to the desired position in the layout

  5. Click Save Changes.

Step 3: Associate the Custom Field to Screen Scheme

  1. If not already in the work items menu - Navigate back to your Project Settings. Click the gear icon (⚙️) → select Work items.

  2. Navigate to the custom field on the left-hand side

  3. Search the custom field that you created > click on the 'Associate to screen' option

  4.  Add to configure it to include the new custom field, removing the standard Ketryx field
  5. Navigate to Screen Schemes on the left-hand side
  6. Search for the relevant items scheme and create a copy, and name it something relevant
  7. Navigate to the work items screen schemes on the left-hand side
  8. Choose the  your project's scheme > click on the three dots on the right > click configure
  9. 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.

  1. 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
  2. Find the Extra Field Names setting.

  3. Add the appropriate JSON for the custom field you just created

  4. Click Save Changes



This video guides you through creating custom fields in Jira and performing advanced configurations in Ketryx. 

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Article is closed for comments.