**As** an admin migrating from Jira to OpenProject
**I want to** migrate custom fields of my Jira Issues to custom fields in OpenProject
**so that** I have a more complete work package description

**Acceptance criteria**

* Custom fields for custom field types OpenProject has a corresponding field type are migrated Begin of the deletion


**Technical notes**

Plan outline:

1. For the selected projects scan the issue payloads, collect only the \`customfield\_XXXXX\` IDs that have non-null values in the selected projects, store field definitions in \`jira\_fields\`End of the deletion

Begin of the insertion* SupportEnd of the insertion Begin of the deletion 2. Map and create customEnd of the deletion fields Begin of the insertionare (Jira UIEnd of the insertion Begin of the deletion

1. Re-use CFs which have the correctEnd of the deletion type Begin of the insertionnames):

* Text Field (single line)End of the insertion

Begin of the insertion* Text Field (multi-line)End of the insertion Begin of the deletion 2. Create new CFs with the same name but mismatching typeEnd of the deletion

Begin of the insertion* Date PickerEnd of the insertion Begin of the deletion 3. Create new CFs not foundEnd of the deletion

Begin of the insertion* Checkboxes
_as a multi-select list or single boolean custom field_

* Radio Buttons
_as a single select list_

* URL Field

* Number Field

* Select List (single choice)

* Select List (multiple choice)

* Select List (cascading)

* User Picker (single user)
_project members only_

* User Picker (multiple users)
_project members only_End of the insertion Begin of the deletion 4. Prepare special CFs like "Field context" listsEnd of the deletion

Begin of the insertion* For Jira custom fieldsEnd of the insertion Begin of the deletion 3. Associated the CFsEnd of the deletion with Begin of the insertion"Field context" (different content per projects/issuetypes), multiple custom fields will be createdEnd of the insertion Begin of the deletion each work package type encountered during import, add to work package form

4. Set CF values on work packages at creation time, populate hierarchy items as neededEnd of the deletion


Begin of the insertion**Technical notes and limitations**End of the insertion Begin of the deletion Caveats:
As with other data, a flag is set so existing CFs are not deleted on revert.End of the deletion

Begin of the deletion <br>

**Supported custom field types**

End of the deletion <figure class="table op-uc-figure_align-center op-uc-figure"><table class="op-uc-table"><thead class="op-uc-table--head"><tr class="op-uc-table--row"><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">Jira field type</p></th><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">Jira CF schema</p></th><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">OP target</p></th><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">Notes</p></th></tr></thead><tbody><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p Begin of the insertionclass="op-uc-p">Text Field (single line)</p></td><tdEnd of the insertion Begin of the deletion class="op-uc-p"><code class="op-uc-code">string</code></p></td><tdEnd of the deletion class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">"type": "string"</code><br><code class="op-uc-code">"custom": "com.atlassian.jira.plugin.system.customfieldtypes:textfield"</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">string</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><br data-cke-filler="true"></p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p Begin of the insertionclass="op-uc-p">Date Picker</p></td><tdEnd of the insertion Begin of the deletion class="op-uc-p"><code class="op-uc-code">date</code></p></td><tdEnd of the deletion class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">"type": "date"</code><br><code class="op-uc-code">"custom": "com.atlassian.jira.plugin.system.customfieldtypes:datepicker"</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">date</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><br data-cke-filler="true"></p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p Begin of the insertionclass="op-uc-p">Checkboxes</p></td><tdEnd of the insertion Begin of the deletion class="op-uc-p"><code class="op-uc-code">checkboxes</code></p></td><tdEnd of the deletion class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">"type": "array"</code><br><code class="op-uc-code">"items": "option"</code><br><code class="op-uc-code">"custom": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes"</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code Begin of the insertionclass="op-uc-code">bool</code>/<code class="op-uc-code">list</code></p></td><tdEnd of the insertion Begin of the deletion class="op-uc-code">bool</code></p></td><tdEnd of the deletion class="op-uc-table--cell"><p class="op-uc-p"><mention class="mention" data-id="73933" data-type="work_package" data-text="#73933">#73933</mention>&nbsp;<br>- Begin of the insertionif there is only one entry,&nbsp;<br>&nbsp; &nbsp;oneEnd of the insertion Begin of the deletion for each option of a checkbox list,&nbsp;<br>oneEnd of the deletion dedicated boolean custom field is created<br>- Begin of the insertionif there are multiple entries,&nbsp;<br>&nbsp; &nbsp;a multiselect list field is created<br>- checkbox listEnd of the insertion Begin of the deletion ListEnd of the deletion entries can be "disabled" in Jira,<br>OP does not support this</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p Begin of the insertionclass="op-uc-p">Radio Buttons</p></td><td class="op-uc-table--cell"><pEnd of the insertion class="op-uc-p"><code Begin of the insertionclass="op-uc-code">"type": "option"</code><br><code class="op-uc-code">"custom": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons"</code></p></td><tdEnd of the insertion Begin of the deletion class="op-uc-code">string</code> with <code class="op-uc-code">url</code></p></td><tdEnd of the deletion class="op-uc-table--cell"><p class="op-uc-p"><code Begin of the insertionclass="op-uc-code">list</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><mention class="mention" data-id="73956" data-type="work_package" data-text="#73956">#73956</mention>&nbsp;<br>- imported as a single select list</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p">URL Field</p></td><td class="op-uc-table--cell"><p class="op-uc-p"><codeEnd of the insertion class="op-uc-code">"type": "string"</code><br><code class="op-uc-code">"custom": "com.atlassian.jira.plugin.system.customfieldtypes:url"</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">link</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><br data-cke-filler="true"></p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p Begin of the insertionclass="op-uc-p">Text Field (multi-line)</p></td><tdEnd of the insertion Begin of the deletion class="op-uc-p"><code class="op-uc-code">text</code></p></td><tdEnd of the deletion class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">"type": "string"</code><br><code class="op-uc-code">"custom": "com.atlassian.jira.plugin.system.customfieldtypes:textarea"</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">longtext</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><mention class="mention" data-id="73944" data-type="work_package" data-text="#73944">#73944</mention>&nbsp;<br>- Text is converted into Markdown as Wiki markup,&nbsp;<br>which may result in unexpected formatting.</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p Begin of the insertionclass="op-uc-p">Number Field</p></td><tdEnd of the insertion Begin of the deletion class="op-uc-p"><code class="op-uc-code">number</code></p></td><tdEnd of the deletion class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">"type": "number"</code><br><code class="op-uc-code">"custom": "com.atlassian.jira.plugin.system.customfieldtypes:float"</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">float</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><br data-cke-filler="true"></p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p Begin of the insertionclass="op-uc-p">Select List (single choice)</p><p class="op-uc-p">Select List (multiple choice)</p></td><tdEnd of the insertion Begin of the deletion class="op-uc-p"><code class="op-uc-code">array</code> of <code class="op-uc-code">string</code></p></td><tdEnd of the deletion class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">"type": "option"</code><br><code class="op-uc-code">"custom": "com.atlassian.jira.plugin.system.customfieldtypes:select"</code>,</p><p class="op-uc-p">and</p><p class="op-uc-p"><code class="op-uc-code">"type": "array"</code><br><code class="op-uc-code">"items": "option"</code><br><code class="op-uc-code">"custom": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect"</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">list</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p">- If a "Field context" is used on Jira side for&nbsp;<br>different list options per project and issue type,&nbsp;<br>multiple OP custom fields are created<br>As these contexts are not available via the API&nbsp;<br>their names cannot be used, the field names are<br>suffixed with <code class="op-uc-code">(project_identifier)</code><br>- List entries can be "disabled" in Jira,&nbsp;<br>OP does not support this</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p Begin of the insertionclass="op-uc-p">Select List (cascading)</p></td><tdEnd of the insertion Begin of the deletion class="op-uc-p"><code class="op-uc-code">cascadingselect</code></p></td><tdEnd of the deletion class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">"type": "option-with-child"</code><br><code class="op-uc-code">"custom": "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselect"</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">hierarchy</code> (Enterprise)</p></td><td class="op-uc-table--cell"><p class="op-uc-p">- If a "Field context" is used on Jira side for&nbsp;<br>different list options per project and issue type,&nbsp;<br>multiple OP custom fields are created<br>As these contexts are not available via the API&nbsp;<br>their names cannot be used, the field names are<br>suffixed with <code Begin of the insertionclass="op-uc-code">(project_identifier)</code></p></td></tr><trEnd of the insertion Begin of the deletion class="op-uc-code">(project_identifier)</code></p></td></tr></tbody></table></figure>

**Partial data migration / To discuss**:

<figure class="table op-uc-figure_align-center op-uc-figure"><table class="op-uc-table"><thead class="op-uc-table--head"><tr class="op-uc-table--row"><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">Jira field type</p></th><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">Jira CF schema</p></th><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">Possible OP target</p></th><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">Notes</p></th></tr></thead><tbody><trEnd of the deletion class="op-uc-table--row"><td class="op-uc-table--cell"><p Begin of the insertionclass="op-uc-p">User Picker (single user)</p></td><tdEnd of the insertion Begin of the deletion class="op-uc-p"><code class="op-uc-code">datetime</code></p></td><tdEnd of the deletion class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">"type": Begin of the deletion "datetime"</code><br><code class="op-uc-code">"custom": "com.atlassian.jira.plugin.system.customfieldtypes:datetime"</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">date</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p">#32646&nbsp;<br>- Time-of-day and timezone lost</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">user</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">"type":End of the deletion "user"</code><br><code class="op-uc-code">"custom": "com.atlassian.jira.plugin.system.customfieldtypes:userpicker"</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">user</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p">- OP requires users in the select to be members of the project<br>to not change visibility, non-member users are left out</p></td></tr><tr class="op-uc-table--row"><td Begin of the insertionclass="op-uc-table--cell" style="border-bottom:1px solid rgba(9, 30, 66, 0.14);padding:7px 10px;vertical-align:top;"><p class="op-uc-p">User Picker (multiple users)</p></td><td class="op-uc-table--cell" style="border-bottom:1px solid rgba(9, 30, 66, 0.14);padding:7px 10px;vertical-align:top;"><pEnd of the insertion Begin of the deletion class="op-uc-table--cell"><pEnd of the deletion class="op-uc-p"><code Begin of the deletion class="op-uc-code">array</code> of <code class="op-uc-code">user</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><codeEnd of the deletion class="op-uc-code">"type": "array"</code><br><code class="op-uc-code">"items": "user"</code><br><code class="op-uc-code">"custom": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker"</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">user</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p">- OP requires users in the select to be members of the project<br>to not change visibility, non-member users are left Begin of the insertionout</p></td></tr></tbody></table></figure><br>End of the insertion Begin of the deletion out</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">array</code> of <code class="op-uc-code">label</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">"type": "array"</code><br><code class="op-uc-code">"items": "string"</code><br><code class="op-uc-code">"custom": "com.atlassian.jira.plugin.system.customfieldtypes:labels"</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">list</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p">Currently imported as a list custom field</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">cascadingselect</code> on Community Edition</p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">"type": "option-with-child"</code><br><code class="op-uc-code">"custom": "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselect"</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">string</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p">e.g. "Animals - Cat"</p></td></tr></tbody></table></figure>

**Out of scope:**

When creating CFs with different names as in the origin Jira, the names in the issue history are not changed.

<figure class="table op-uc-figure_align-center op-uc-figure"><table class="op-uc-table"><thead class="op-uc-table--head"><tr class="op-uc-table--row"><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">Jira field type</p></th><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">Example Jira CF</p></th><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">Notes</p></th></tr></thead><tbody><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">array</code> of <code class="op-uc-code">options</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">"type": "option"</code><br><code class="op-uc-code">"custom": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons"</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><mention class="mention" data-id="73956" data-type="work_package" data-text="#73956">#73956</mention>&nbsp;</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p">Customer Request Type</p><p class="op-uc-p"><br data-cke-filler="true"></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">"type": "sd-customerrequesttype"</code><br><code class="op-uc-code">"custom": "com.atlassian.servicedesk:vp-origin"</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><br data-cke-filler="true"></p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p">Template Type</p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">"type": "any"</code><br><code class="op-uc-code">"custom": "com.intenso.jira.issue-templates:issue-templates-customfield"</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><br data-cke-filler="true"></p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p">Epic Link</p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">"type": "any"</code><br><code class="op-uc-code">"custom": "com.pyxis.greenhopper.jira:gh-epic-link"</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><br data-cke-filler="true"></p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p">Rank</p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">"type": "any"</code><br><code class="op-uc-code">"custom": "com.pyxis.greenhopper.jira:gh-lexo-rank"</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><br data-cke-filler="true"></p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">array</code> of <code class="op-uc-code">component</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">coomponents</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><br data-cke-filler="true"></p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">array</code> of <code class="op-uc-code">string</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">multi-grouppicker</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><br data-cke-filler="true"></p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">version</code> single</p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">version-picker</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p">Do we create versions? Those will be global</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">array</code> of <code class="op-uc-code">version</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">array</code> of <code class="op-uc-code">version</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><br data-cke-filler="true"></p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">array</code> of <code class="op-uc-code">issuelink</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">issuelinks</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p"><br data-cke-filler="true"></p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">any</code> — sprint</p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">gh-sprint</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p">State, board, date info</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">any</code> — epic link</p></td><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">gh-epic-link</code></p></td><td class="op-uc-table--cell"><p class="op-uc-p">(issue key, e.g. <code class="op-uc-code">PROJ-42</code>)</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell"><p class="op-uc-p"><code class="op-uc-code">any</code> — unknown plugins</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Various Atlassian plugins</p></td><td class="op-uc-table--cell"><p class="op-uc-p">Produces raw JSON string dump</p></td></tr></tbody></table></figure><br>End of the deletion

<br>