Import your Jira components into Compass via Python script

[#1]

Hi everyone, 

I'm back with another update on how to get started with Compass components. 

For more information about the feature, please read Compass Components in Jira Software are coming! and Addressing feedback about Compass components in JSW + a new admin control. 

A common request we've received is for the ability to import your existing Jira components into Compass. In the interest of getting the feature out quickly, we've written a Python script that allows you to export your Jira components to CSV. Compass then accepts CSV imports, so it's a two step process. 

Instructions below.

---

1. Export Jira components to CSV 

Follow the instructions on the ReadMe file for this script:Export Jira Components to CSV script.

You will end up with a .csv file with results that look like this, for projects "Hello" and "Test Project" in our example: 

While you're there, be sure to check out the other scripts we have available if you need them (here's the link again.) 

2. Import your Jira components CSV into Compass

Compass has an existing CSV importer that you can use to not only get a list of Components in Compass, but also add information about them. You can get to the CSV importer by clicking "Create" in the top nav bar and selecting "Import" and scrolling until you see the CSV importer option. 

There is one important step you need to take in order to ensure the information is accurately added: make sure you follow the formatting instructions in our documentation.

Voila - you now have your full list of existing Jira components in Compass. You can now start using Compass components free of charge and get all the additional benefits that Compass has to offer. 

---

Let me know what you think about this in the comments. Are you comfortable running scripts, or do you have a preference for an in-app importer? What other features or scripts might help you adopt Compass components in Jira Software? 

[Luka Hummel - codefortynine]

Hi @Katie Silver

We might want to try Compass components, but how can we replace the existing Jira components with the new equivalent compass components in all our issues?

[Katie Silver]

 Hi @Luka Hummel - codefortynine - sorry for the delay, I've been out of office. 

Can I ask why you want to update the issues? Only reason I ask is that you can still search and query for issues with both Jira and Compass components as long as the name matches. 

If the name doesn't match and you do need to update it, the best way to change it is by following the bulk update steps in this post: https://community.atlassian.com/t5/Compass-articles/Deprecating-the-Jira-Software-Compass-custom-field-on-May-31st/ba-p/2621465

The above post is talking about migrating values from the Compass custom field to the Components field, but the same process applies if you are moving Jira component values to Compass component values in the same field. 

[Luka Hummel - codefortynine]

Hi @Katie Silver

No worries.

I will test Compass components. It makes a lot of sense for us as we are using the same components across a lot of different projects.

[TJ Downes]

Hi there, thanks for this tutorial, it's super useful. However, there's the case where we want to map existing components to new Compass components, which were imported via GitHub. For example

Jira Component: ACME
Compass Component: acme-repo

We want to map ACME to acme-repo so that all existing work items will now point to acme-repo. Is this possible? Otherwise this seems to be a massive, manual undertaking.