Migration from Server/Data Center to Cloud with Rich Filters for Jira Dashboard versions lower than 1.27.0 is deprecated. Please use the latest Rich Filters for the Jira Dashboards version to perform your migration.
Contents:
Introduction
Before migrating Rich Filters for Jira Dashboards app data from the Jira Server or Data Center to Jira Cloud, please first check the Feature Parity—Server/Data Center vs. Cloud comparison documentation page.
The Rich Filters for Jira Dashboards app uses two different types of data that need to be migrated:
The configuration of the rich filters defined on your Jira instance
The configuration of the rich filter gadgets used in dashboards on your Jira instance
Migrating rich filters
For the migration of the rich filters, you have two possible options:
Migrate your rich filters automatically using the Jira Cloud Migration Assistant (JCMA); the next documentation section describes this migration path in detail;
You must migrate your rich filters manually, recreating them manually from the Server/Data Center instance on your Cloud instance.
Migrating rich filter configuration automatically using JCMA
The Jira Cloud Migration Assistant (JCMA) allows you to automate the migration of your rich filters from the Jira Server/Data Center to Jira Cloud. More precisely, JCMA migrates your Jira data and orchestrates the migration process for 3rd party apps that have added specific support for JCMA.
Migrating your data from Jira Server/Data Center to Jira Cloud using JCMA requires detailed planning and several configuration steps. For more details, see Use the Jira Cloud Migration Assistant to migrate. Below, we refer only to the configuration steps for migrating the rich filters.
I) Before launching the JCMA migration
Step #1 - Make sure you have the appropriate software installed on your Jira instances
On your source Jira Server/Data Center instance, make sure you have installed the following:
Rich Filters for Jira Dashboards version 1.27.0 or above
Jira Cloud Migration Assistant (JCMA) latest version
On your destination, Jira Cloud instance, ensure you have installed and licensed the Rich Filters for the Jira Dashboards Cloud app.
Step #2 - Assess your apps
The first step in configuring JCMA before launching a migration is "1. ASSESS YOUR APPS" on the Migration Assistant home screen—more information is available here. In this step, you must choose which apps to migrate to the Cloud.
You need to mark Rich Filters for Jira Dashboards as Needed in cloud. Note that all the rich filters will be migrated.
If you also use rich filter extension apps, you must mark them all as Not needed in cloud.
On Cloud, the functionality provided by Rich Filters::Service Management Dashboards is available as part of the main Rich Filters for the Jira Dashboards app. Hence, when migrating the main rich filters app, the data provided by this rich filters extension is also migrated.
Currently, the functionality provided by Rich Filters::Time Tracking Dashboards is not supported on the Cloud.
II) After completing the JCMA migration
After the JCMA migration, the following steps must be completed on the destination Jira Cloud instance.
Step #3 - Check the saved base Jira filters
Rich filters are based on (have a reference to) saved Jira filters. It is important that all the Jira filters that are referenced in rich filters be migrated before the rich filters are migrated (see the section Migration best practice below). JCMA allows you to migrate all Jira filters, and that is the option we recommend – you need to select the option All filters and cross-project boards in the setting Migrate boards and filters. For details see What gets migrated with the Jira Cloud Migration Assistant and How dashboards, boards and filters are migrated.
In this step, you need to check that all the migrated rich filters have a base Jira filter.
If any migrated rich filter doesn’t have a base Jira filter (i.e. the base Jira filter is NOT SET), you need to find out whether the corresponding Jira filter has been migrated prior to the migration of the rich filter. More precisely, the Jira filter must have been migrated in the same migration run as the rich filter, or in a previous but recent migration run. If these conditions are met, yet the reference is broken, please create a support ticket so that our team can investigate the issue. If these conditions are not met, you will need either to identify the cause and fix the problem, and then run the migration again from scratch, or to manually create the missing Jira filter and set it as a base filter in the configuration of the rich filter. We remind you that only administrators can edit rich filters (for more details, see the Rights and Permissions documentation page).
If you wish to obtain a flat list of rich filters together with their base Jira filters on the source Jira Server/Data Center instance, you can run the following SELECT SQL query on Jira's database:
SELECT rf.ID as rich_filter_id, rf.NAME as rich_filter_name, jf.id as jira_filter_id, jf.filtername as jira_filter_name, jf.authorname as jira_filter_owner, jf.reqcontent as jira_filter_jql FROM AO_24D977_QRFRFE0 rf INNER JOIN searchrequest jf ON rf.JIRA_FILTER_ID=jf.ID ORDER BY jira_filter_id, rich_filter_id;
If your database server is PostgreSQL, then you might need to add double quotes around the upper-case identifiers – see below:
PostgreSQL
SELECT rf."ID" as rich_filter_id, rf."NAME" as rich_filter_name, jf.id as jira_filter_id, jf.filtername as jira_filter_name, jf.authorname as jira_filter_owner, jf.reqcontent as jira_filter_jql FROM "AO_24D977_QRFRFE0" rf INNER JOIN searchrequest jf ON rf."JIRA_FILTER_ID"=jf.id ORDER BY jira_filter_id, rich_filter_id;
The SQL query above will return the list of rich filters (id and name) and the Jira filters they are based on (id and name), the author of those filters, and their JQL.
Step #4 - Review and update JQL clauses in the configuration of your rich filters
Update custom field ID references in JQL.
Moreover, if any of your JQL clauses referred to a custom field using its cf[id]
form, that reference is not automatically updated either. For example, if on your Jira Server/Data Center you used the JQL query cf[...] is not empty, then the reference to the custom field ID is not translated when migrating to the
Cloud. The JQL clause is migrated as-is, but the ID of the migrated custom field might be different on Cloud. Hence, if you used any such custom field references in your JQL, you must manually update them on the Cloud.
We have asked Atlassian to help us automate this step. Please watch and vote for MIG-1021 – Provide API to convert all JQL from Server to Cloud.
Migration best practice
JCMA allows you to run migrations from the same Jira Server/DC instance to the same Jira Cloud instance multiple times (for example, to migrate your projects gradually if this is useful to you). We recommend you migrate your Rich Filters for Jira Dashboards app data only once, after you have migrated all your Jira data. If you migrate your rich filter data before you have migrated all your Jira data, then references to missing Jira data will not be migrated, and your rich filters might not be completely migrated.
If you migrate the rich filter data multiple times, the already migrated rich filters will not be migrated a second time. Nevertheless, if you migrate a rich filter to the Cloud and then delete it, if you migrate the rich filters again, then the deleted rich filters will be migrated again. We don't recommend migrating rich filters multiple times unless it's absolutely necessary.
Migrating rich filter configuration manually
Alternatively, instead of using JCMA, you also have the option to migrate your rich filters manually—i.e., recreate the same rich filter configurations on your Cloud instance. One advantage of this approach is that you can decide not to migrate rich filters that are no longer used.
The SELECT SQL query provided in Step #3 above can be useful to obtain a flat list of rich filters on your Jira Server/Data Center instance.
3. Migrating rich filter gadgets
Unfortunately, Atlassian does not currently provide support for the automatic migration of third-party gadgets from Jira Server/Data Center to Jira Cloud. For this reason, at least for now, you can only manually migrate your rich filter gadgets. You need to recreate the same dashboards as on the Jira Server/Data Center instance, using the migrated rich filters, as described above.
We hope Atlassian will soon provide the necessary technical framework so that we can automatically migrate the rich filter gadgets too. Please watch and vote for MIG-1937 – Support Third-Party Gadgets in JCMA Dashboards
Meanwhile, if you wish to obtain a flat list of dashboards that use rich filter gadgets on the source Jira Server/Data Center instance, then you can run the following SELECT SQL query on Jira's database:
SELECT distinct d.id as dashboard_id, d.pagename as dashboard_name, d.username as dashboard_owner_username, p.userprefvalue as rf_id, rf.NAME as rf_name FROM portalpage d, portletconfiguration g, gadgetuserpreference p, AO_24D977_QRFRFE0 rf WHERE d.id = g.portalpage AND g.id = p.portletconfiguration AND p.userprefkey = 'rf' AND p.userprefvalue = rf.ID ORDER BY dashboard_id;
If your database server is PostgreSQL, then you might need to add double quotes around the upper-case identifiers and match the types of ID columns – see below:
PostgreSQL
SELECT distinct d.id as dashboard_id, d.pagename as dashboard_name, d.username as dashboard_owner_username, p.userprefvalue as rf_id, rf."NAME" as rf_name FROM portalpage d, portletconfiguration g, gadgetuserpreference p, "AO_24D977_QRFRFE0" rf WHERE d.id = g.portalpage AND g.id = p.portletconfiguration AND p.userprefkey = 'rf' AND p.userprefvalue = cast(rf."ID" as varchar) ORDER BY dashboard_id;
The SQL query above will return a list of dashboards that use at least one rich filter gadget. For each dashboard, the query returns the dashboard ID, dashboard name, dashboard owner, and the ID and name of the rich filter used in that dashboard. The same rich filter can be used in multiple dashboards, and each dashboard can use multiple rich filters. There is an n-to-n relationship between dashboards and rich filters.