Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

This page describes how to migrate Requirement Yogi data to Confluence and Jira Cloud, using the official CCMA* and JCMA**.

* CCMA: Confluence Cloud Migration Assistant
** JCMA: Jira Cloud Migration Assistant

Info

Using an old version of Requirement Yogi?

Please head to Migrating to the Cloud (before RY 3.5). Or better: Upgrade and use the easy guide below!

It’s quite simple!

Requirement Yogi Confluence migration is not necessary.

The transformation of Confluence pages after can be made after the migration, since all data is stored in the contents of Confluence pages.

As a result, please ignore Requirement Yogi when migrating.

To transform pages after the migration, follow our migration process (cf doc). If you need further assistance, you can also contact our support team.

This page describes how to migrate Requirement Yogi data to Confluence and Jira Cloud, using the official CCMA (Confluence Cloud Migration Assistant) and JCMA (Jira Cloud Migration Assistant).

Basically, you mostly need to trigger the CCMA / JMCA migrations and see what happens. This document is mostly a checklist to ensure the task will be successful.

...

Due to technical difficulties with the APIs, we have only just published the Phase 1 and 2 of CCMA. It will allow you to migrate:

Requirements on pages

(tick) Ready

Requirements links on Jira issues + relationship

(tick) Ready

Traceability Matrices

(error) No, and we’ve stopped working on it*

Baselines

(error) No, and we’ve stopped working on it*

Data is not migrated. In the Cloud we have variants, see the difference here.

Other entities (

reports, etc

Report macros and RY properties macro.)

(error) No, and we’ve stopped working on it*

  • For reports, you’ll have to remove old macros and replace them with the RY Report.

  • RY property, you’ll have to remove those macros, and use the RY Configuration instead.

Limitations

  • On the Cloud, pages containing requirements must be migrated to the new editor experience, since we only have transformers for the new JSON/ADF storage backend, and not for the XML one. The migration will be triggered when we apply the transformation.

  • This “Phase 1 and 2” doesn’t import the RY Property, test macros, baselines, existing reports, and report macros to the Cloud.

...

  1. On the Server/DC side, upgrade the CCMA plugin to the latest version;

  2. Same for the JCMA plugin in Jira;

  3. Update Requirement Yogi Server to the latest version, (minimum 3.5.1 for Confluence, and 3.5.2 for Jira);

  4. Install Requirement Yogi on Confluence cloud, and on Jira Cloud;

  5. The app automatically creates a Requirement Yogi user. Here are the steps to check the user can view and create pages in your spaces:

    • In Confluence Cloud → Settings → Security → Global Permissions:

      • Requirement Yogi Core (Spring Boot) for Confluence Cloud is expected to be in a user group in the User groups tab,

      • Requirement Yogi Core (Spring Boot) for Confluence Cloud is expected to be listed in the Apps tab,

      • If you need help, see the screenshots in Section 1.

    • In Confluence Cloud → Settings → Security → Space Permissions:

      • The user group assigned to Requirement Yogi is expected to be listed in the Default Space Permissions, with permissions to view and add Pages (Confluence doesn’t distinguish between add and edit permissions).

      • Individual spaces where you want to use Requirement Yogi are not expected to override the default space permissions for the RY user group.

      • If you need help, see the screenshots in Section 2.

  6. Check page restrictions. If there are page-level restrictions, then the app can’t view/edit the pages with requirements. Two solutions:

    • Either you manually include Requirement Yogi in those page restrictions to edit those pages, but that requires that you edit each page restriction,

    • Either you just let the migration fail, then use our Pages tab, searching for type=page AND macro=requirement AND ryc_isMigrated != true in CQL, and migrate all those pages manually in the future.

...

  1. Do it again for the Jira part.

    1. If you are using multiple relationships for requirement-issue links in Server, make sure you create the same relationships in the RY for Jira Cloud administration as well. (See docs for more information: https://requirementyogi.atlassian.net/wiki/spaces/RYC/pages/1804764144/Requirement+Yogi+for+Jira#Administrate-Requirement-Issue-relationships )

Starting the migration

If you have both Jira and Confluence, you will have to start both migrations. We recommend doing the Confluence migration first. We will still create links to requirements that were not yet migrated, but show a warning that the requirement was not found.

...