| Panel | ||
|---|---|---|
| ||
Transform your existing documentsThis wizard helps you format documents and insert Requirement Yogi macros in bulk. |
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.
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),
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 :
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, ... )
In the wizard, you'll see a preview of the page you'll be transforming and a screen allowing you to create a new transformation, or reuse a saved transformation.
Let's create a new one.
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.
Next comes the requirement links.
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.
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
Reuse a saved transformation.
| Anchor | ||||
|---|---|---|---|---|
|
Once 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.
| Anchor | ||||
|---|---|---|---|---|
|
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 !
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:
