Renaming or exporting a space (Before RY 3.5)

Help document

This page is provided for help. It is not normally part of the installation.

When to use this page?

This is a help document in case you are renaming the key of a space, or when attempting to export-then-import a space.

Exporting a space to another instance

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

There is no "clean" way of doing that, you will have to issue SQL instructions.

Requirement macros are as follow:

CODE

<ac:structured-macro ac:name="requirement" ac:schema-version="1">
    <ac:parameter ac:name="type">LINK</ac:parameter>
    <ac:parameter ac:name="spaceKey">ds</ac:parameter> <!-- spaceKey is optional, only present if the macro is in another space -->
    <ac:parameter ac:name="key">REQ-001</ac:parameter>
    <ac:parameter ac:name="baseline">3</ac:parameter>
</ac:structured-macro>

Don't forget the requirement-report macros:

CODE

<ac:structured-macro ac:name="requirement-report" ac:schema-version="1">
    <ac:parameter ac:name="query">@MyProperty = 'Something' AND space = 'ds'</ac:parameter>
    ... some other parameters ...
</ac:structured-macro>

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