Versions Compared

Key

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

...

Tip
titleTransform your existing documents

This wizard helps you format documents and insert Requirement Yogi macros in bulk.

Image Added

When to use it?

  • When you've imported a Word document into Confluence and you need to clean up the formatting for Requirement Yogi,
  • When you are writing requirement pages and you need to assign requirement keys in bulk.

What operations are available?

  • Transform the first column into requirements keys, or insert generated requirement keys,
  • Transform other columns into requirement links, if they reference other requirements (It transforms text such as REQ-001 into the Requirement Yogi Link macro),
  • Transform table headers into actual headers (When importing from Word, table headers are oftentimes just normal cells mistaken for headers because of their gray background),
  • Those 3 simple operations already fit 90% of our observed usecases. If you need other operations, please don't hesitate to submit a support ticket.


Accessing the Transformation Wizard

You can access the wizard in two ways :

From the page menu :

Image RemovedImage Added


From the Pages tab, click "Transform" :

 Image RemovedImage Added


Using the Transformation Wizard.

...

Once this is done, you will be taken to the summary screen, allowing you to edit the rules you defined, or add more.

Image RemovedImage Added

Before transforming the page, let's save this transformation. You will be able to reuse it later on other pages.

Image RemovedImage Added

And voilà ! Your page is now transformed. Just click on the link or close the modal and refresh the page, and your changes should be visible

Image RemovedImage Added

Reuse a saved transformation.

Once a transformation is saved, you can reuse it on another page by accessing the transformation wizard again.

Image RemovedImage Added

Notice the padlocks : They indicate a transformation only accessible to some users. By default, all transformations are private, and we'll see how to share them later.

...

It would be tedious to repeat this process multiple times. You can easily apply a transformation to multiple pages at once by accessing the Pages tab. Generating hundreds of requirements has never been this easy !

Image RemovedImage Added


Manage saved transformations

You can edit transformation names, description, visibility or delete saved transformations by accessing the Administration tab on the right of the Requirement Yogi page.

Image RemovedImage Added

Admins have access to all transformations in the space, while simple users can only manage their own transformations.

...

Simply click on the edit icon and check the box

Image RemovedImage Added