| Excerpt | ||||
|---|---|---|---|---|
| ||||
With the page transformation wizard and video tutorial, learn how to transform your existing documents and create requirement yogi macros in bulk. |
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Transform your existing documents This wizard helps you format documents and insert Requirement Yogi macros in bulk. |
You can watch the quick tutorial for an overview:
https://www.youtube.com/watch?v=8PpbWZ5nYeIWhen 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.
When you have a company policy for requirement keys, and you want everyone to apply the same formatting to their documents.
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),
If you would like to insert macros in bulk, use the generate requirement keys transformation;
If you have imported your requirements, or already wrote keys in your tables. Transform the text into requirements keys;
If your reference and links to other requirements are written in text, transform them into requirement links macros;
If you want to transform your requirement macros back to text, because you are uninstalling the app, or because you have applied a transformation to the wrong table, use the Reverse transformation;
If you have copied and pasted definition macros but want them to be links, the reverse transformation will also allow you to do that;
If you notice your requirements do not have any properties, it might be because your table headers are not actual headers (just grey cells). Use the rule to transform all your table headers into actual headers;
If your requirements are written in vertical tables, you won’t be able to use the transformations above, unless you use the /wiki/spaces/MBRDemo/pages/1893597210;
If you want to add a configuration macro from the view mode, there is a transformation for that;
If you have requirement links macro and either want to point them all to another space or variant, use the Change variant or space rule;
If you have manually migrated your Server pages to the Cloud, you can transform Server macros into Cloud macros;
These simple operations already fit 90% of our observed usecases. If you need other operations, please don't hesitate to submit a support ticket.
AccessingHow to use the Transformation
WizardYou can accesswizard?
Access the wizard in
two ways :From the page menu :
3 ways
On your Confluence page, from the page menu: |  |
On your Confluence page, click on the byline at the top of the page: |  |
From the Pages tab, click "Transform" : |
 |
Using the Transformation Wizard
Wizard features :
Transform text in requirement yogi macros
Automatically find requirement keys and convert them to link macros
Automatically generate unique keys
Add, or rename table headers used to generate requirement properties
and more to come (handle vertical tables, generate requirements from paragraphs, ... )
Go with the flow and let us analyse your document
On the left, you'll see a preview of the page you'll be transforming |
. On the right, you’ll be able to create a new transformation, or reuse a saved transformation. |
|  |
Let's |
click on Next The Transformation Wizard will ask you in which tables you want to create requirement macros, allowing you to select tables, using multiple criteria (and even regular expressions), or manually exclude single requirements. Click here if you need more information on Transforming Keys. |
 |
Next comes the |
dependencies and links. |
Find more information on the links transformation here. The Transformation Wizard will scan the table cells for text matching requirement macros already created, or that are in the process of being transformed, and convert them to requirement yogi link macros. |
Once this is done, you will be taken to the summary screen, allowing you to edit the rules you defined, or add more.
Before transforming the page, let's save this transformation. You will be able to reuse it later on other pages.
 | |
In the end, you’ll see a summary of the rules.
|  |
And voilà ! Your page is now transformed. |
 |
Reuse a saved transformation.
anchorOnce a transformation is saved, you can reuse it on another page by accessing the transformation wizard again. 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. |
 |
Transform multiple pages at once.
If you need to apply a transformation to multiple pages at once |
. Go to the Pages tab. Generating hundreds of requirements has never been this easy ! |
 |
Share your transformations
Everyone can share their transformations, and administrators can override them. Use the "Administration" tab in the Requirement Yogi search screen |
. Admins have access to all transformations in the space, while simple users can only manage their own transformations. |
 |
Sharing
Edit a transformation and click on the "Share" checkbox: |
 |