...

Exporting a space to another instance

Using Confluence's build-in XML export-import

When exporting a space, we don't include the requirements in the export. Therefore, the following information will be lost if you only use Confluence's built-in XML export-import:

• Baselines will be lost,
• Links from other spaces will be lost,
• Links from Jira will be lost. They will still appear on the Jira side, but will reach a 404 page in Confluence. They won't appear on the new requirements in Confluence.

After you reimport, please use Requirement Yogi's reindexation in the space administration.

If you need to keep baselines, links from other spaces and from Jira, then proceed to the next title.

Moving data manually to another Confluence instance

• Our requirement is that the following tables are correct:
  • AO_32F7CE_DBBASELINE
  • AO_32F7CE_DBREQUIREMENT - Simple import
  • AO_32F7CE_DBPROPERTY- Simple import (with foreign key to DBREQUIREMENT),
  • AO_32F7CE_DBLINK - Don't forget to change the Page IDs and the Jira Applink ID.
  • AO_32F7CE_DBDEPENDENCY - Import (with foreign key to DBREQUIREMENT) + references to DBLink.
  • Don't forget AO_32F7CE_DBBASELINE, AO_32F7CE_DBTRACEABILITYMATRIX, AO_32F7CE_DBISSUE_TEMPLATE.
• Our other requirement is that tables in Jira correctly match the tables of Confluence:
  • AO_42D05A_DBREMOTEREQUIREMENT
  • AO_42D05A_DBISSUELINK
  • AO_42D05A_DBAUDITTRAIL
• So, the process would be:
  1. Import a space to the new Confluence,
  2. Find a way to map old page IDs to new page IDs,
  3. Import all RY tables, keeping foreign keys,
  4. Change Applink IDs in DBLink,
  5. Change Page IDs in DBLink,
  6. Jira: Before exporting, ensure issue numbers match issue ids, in DBIssueLink,
  7. Jira: Import all RY tables,
  8. Jira: After importing, update issue ids to issue numbers in DBIssueLink,
  9. Jira: Update the Applink IDs in DBRemoteRequirement.

Renaming a space

If you rename a space, our records in the database still point to the older space. Therefore, requirements will appear as non-existing in the new space. You have two choices:

• Use the same method as above (reindexing after importing) but you will lose the same entities as above (baselines, links, Jira links).
• Otherwise, you will have to perform a lot of operations manually, see below.

Places where the space key is mentioned

...

Since version 3.5.0 (November 2022), things have improved greatly. Please see the history of this page for help on older versions.

How to proceed?

Simply use Import/export of Requirement Yogi data to a Confluence or Jira instance.

What are the limitations of the import/export tool?

If you have pages pointing from other spaces, then you will also have to modify the XML of those pages.

Why should the XML of pages be updated?

What happens is, all macros from other spaces point to a given { space key, requirement key, baseline }, and the space key needs to be updated.

Requirement Yogi can't do it automatically, because we don't have direct access to the DB, and API access will trigger all sorts of notifications (and slowness).

The impact of not doing it is, next time the page will be updated, Requirement Yogi will not find the requirement at { space key, requirement key, baseline }, and it will assume it's a link to a non-existing requirement.

Please edit the database yourself.

How to modify the XML of pages

...

To perform an accurate migration, you will have to write an XML parser.

Tables in the Confluence database

You will have to modify the following tables in the database, which contain the spaceKey parameter:

...

parser

...

The queue is a queue of messages between Confluence and Jira. As said above, one simple solution is to stop modifying pages, going to the Requirement Yogi administration, and clicking "Send all messages to Jira". This way, existing messages will be sent end messages above 1000 will be deleted.

Note that if you also change the Jira application, you will also have to change AO_32F7CE_AOINTEGRATION to update the Applink ID. This is also documented, in Admin - Changing Applinks.

Tables in the Jira database

• AO_42D05A_REMOTE_REQUIREMENT, change the spaceKey.
• AO_42D05A_AOQUEUE_MESSAGE (starting from version 2.6, not published at the time of writing), change the spaceKey inside of the JSON column. More simply, send all messages from the RY administration in Jira before starting.

If you also change the Applink to Confluence, you will have to change the Applink ID in:

• AO_42D05A_REMOTE_REQUIREMENT, change the spaceKey.
• The plugin settings table, check all keys starting with "com.playsql.requirementyogijira."

Summary

As a summary, there are 5 types of places where you will have to perform modifications:

...

.