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 Jira 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 Fields in the left-hand menu

5. Click Create new field in the upper right of the screen

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

7. Enter a name and description 

Step 2: Configure the Screen

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

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

3. On the copy you just created, click on the three dots on the right side of the item and click configure

4. Select the Custom field you created to add it to the screen

Step 3: Configure the Screen Scheme

1. Navigate to the Screens schemes in the left-hand menu >  Search for the Ketryx work item screen scheme that you would like to add a custom field to

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

3. On the copy you just created, click on the three dots on the right side of the item and click configure

4. Click Edit under actions

5. Once on the Edit Screen Scheme Item page, select the screen you made in the steps above and click updateNote: If you want to associate a specifc issue operation with a screen, you can click Associate a work item operation with a screen instead of edit. This will allow you to map specific operations (create issue, edit issue, view issue) for the screen you created, and have the default be used for all unmapped operations. 
    

Step 4: Configure Work type Screen Scheme

1. Navigate to the Work type screens schemes in the left-hand menu > create a copy of the Ketryx issue type screen scheme 
2. On the copy you just created, click on the three dots on the right side of the item and click configure
3. Find the work type you want to associate with your new screen scheme and under actions click Edit
4. Change the screen scheme used by the work type to be the screen scheme you created, click update when done

Step 5: Assign the New Scheme to Your Project

Step 6: Edit the Work Item Layout (Optional)

1. In the left-hand menu, Click Work items → Layouts.

2. Find the work item type → click Edit work item layout
   

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

    

4. Click Save Changes. 

   Step 7: Advance Settings in Ketryx

Option 1: Read Only

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
   

Option 2: Editable 

1. In ketryx, navigate to your project > Select Advance Settings from the left-hand menu
   1. Note: It is also possible to do this at the Org-level
2. Find the Custom items field configuration and item fields settings. 
3. Add the appropriate JSON for the custom field you just created

Instructions on how to add custom fields to configuration items that are also editable in Ketryx can be found in our documentation here. The types of fields that you are able to create include: rich text fields, short text fields, single select fields, multi-select fields, date fields, and date and time fields.