Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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 Data Center 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.

Follow each steps

  1. Before the Migration

  2. Starting the migration

  3. Ending the migration

  4. Troubleshooting

...

Table of Contents
minLevel1
maxLevel3
outlinefalse
styledefault
typelist
printabletrue

What will be migrated?

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, external properties and Jira links.

  • Requirements

    • As they are defined on Confluence pages, they will always be migrated, as well as their properties and dependencies.

  • External Properties.

(tick) Ready

  • Requirements links

on
  • to Jira issues + relationship

(tick) Ready

Traceability Matrices

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

Baselines

🟡 In progress
  • Baselines

(tick) Ready with manual export/import.

Not within the CCMA but

you can

it is possible to manually export Baselines from Server and import them back to the Cloud

.

(Note that this is still BETA, and even though Baselines are imported, it is not possible to see them yet. We are still working on the Baselines feature on the Cloud, that will allow you to see them.)

Other entities (Report macros and RY properties macro.)

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

For reports,

(since 4.2.14)

  • Traceability Matrices

(error)

  • Other RY macros on pages

  • Requirement Types

(error)

  • For reports (requirement-report, requirement-report-pages), you’ll have to remove old macros and replace them with the RY Report.

RY

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.

*We’ve stopped working on the migration of baselines and other reports, despite the demand for it, because it was outstandingly difficult and it was draining the resources of the company.

  • requirement-baseline macros will not get migrated either.

Overview of the migration process

  1. Perform the prerequisite steps,

  2. Open up the migration endpoint in Requirement Yogi Cloud (both Confluence and Jira),

  3. Migrate the Confluence data,

  4. Check and acknowledge the warnings and errors in Requirement Yogi for Confluence Cloud,

  5. Migrate the Jira data,

  6. Check and acknowledge the warnings and errors in Requirement Yogi for Jira Cloud,

  7. The migration is done.

Before migrating

...

1. Required steps before migrating

RY for Confluence

RY for Jira

1

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

...

On the Server/DC side, upgrade the JCMA plugin

...

to the latest version;

...

2

Upgrade Requirement Yogi for Confluence Server to the latest version

...

(minimum 3.5.1

...

)

Upgrade Requirement Yogi for Jira Server to the latest version (minimum 3.5.2

...

)

...

...

...

.

4

Once the installation is complete, make sure you link your RY for Confluence and RY for Jira instances together, see docs.

5

Make sure permissions are set up so we can view and create pages in your spaces:

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

    • Requirement Yogi for Confluence Cloud is expected to be in a user group in the User groups tab,

    • Requirement Yogi 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.

...

  • More information in the FAQ.

6

Make sure pages with requirements on your Server / Data Center instance are not restricted.

  • If there are page-level restrictions, then the app

...

  • will not be able to view/edit

...

  • pages with requirements.

...

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

Panel
bgColor#DEEBFF

You can also use the Rest API to do a search on the whole space using this query:

https://your-domain.atlassian.net/wiki/rest/api/content/search?cql=type=page AND macro=requirement AND ryc_isMigrated !=true

NB: We only need to edit pages during the migration. Once the migration is over, you can remove the pages permission for the app. Requirement Yogi uses the user’s permissions to transform the pages in the Transformation Wizard.

  1. Open the migration endpoint:

...

  • See possible solutions in the FAQ.

7

Open the migration endpoints:

  • In Confluence Cloud > Manage Apps > Requirement Yogi Administration > Support > Activate the Server / Cloud migration for this instance.

  • This enables Requirement Yogi to receive notifications from the server migration assistant. You can close it once the migration is over.

Open the migration endpoints:

  • In Jira Cloud > Manage Apps > Requirement Yogi Administration > Support > Activate the Server / Cloud migration for this instance.

  • This enables Requirement Yogi to receive notifications from the server migration assistant. You can close it once the migration is over.

Image Removed

Image Removed

Do it again for the Jira part.

8

If you are using multiple relationships for requirement-issue links in Server / Data Center, make sure you create the same relationships in the RY for Jira Cloud administration as well.

...

...

2. Starting the migration

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

Note

In Jira, ensure you click “Choose what to migrate” (see screen below). In our trialstests, if you import everything at once, it… removes everything from the Jira instance, reimports something and forgets to install apps again, therefore Jira isn’t aware that it kicked Requirement Yogi out. In summary, select what you import, do not tick “Migrate all data”.

...

Go to the Migration Assistant

In your Confluence server, under Server / Data Center instance, go to the General Configuration > Migration Assistant

...

.

  • In the section ‘Assess your apps’, mark Requirement Yogi as “Needed in cloud (App assessment approval by Atlassian pending)

  • Proceed to the rest of the migration steps required by Atlassian.

  • Wait for Keep track of the progress of the migration and wait for it to be complete.

💡 App migration can take a long time to run, especially if you have thousands of pages. On our test instance, the migration took 20s per 1000 requirements (1h30 for a sample of 220k requirements spread on 2000 pages).

...

3. Ending the Migration

How to check progress of the migration?

You can check the migration notifications in the cloud by:

  • Clicking on the link in the app migration details in CCMA (Confluence Server),

  • Or in the cloud, in Requirement Yogi configuration :

  • By clicking the link in the support tab,

  • By going in the queue tab and clicking on the migration job,

  • Image Removed

    > Support > View the migration notifications.

How to check and acknowledge the warnings and errors?

  • Errors and warnings are listed on the

...

  • Requirement Yogi Migration Notification page (Admin access is required).

  • Errors on pages have a link to the page that generated an error. You can

...

  • navigate to

...

  • said page and

...

  • manually verify if the migration was a success. If the migration wasn’t successful (ex: Requirement Yogi macros are shown as ‘Unknown macros’), you can manually transform those macros and mark the notification as “Resolved.

Please do feel free to open a ticket to notify us of errors generated by the migration tool by raising a support ticket.

Acknowledge the migration task

In the end, ensure you acknowledge the Requirement Yogi migration task on the Cloud side

...

. It is important, so that the migration task on the server side knows that Requirement Yogi is done.

See typical warnings in the Troubleshooting page.

...

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.

Frequently Asked Questions

Info

Using an old version of Requirement Yogi?

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

...