Rename requirements

If you want to rename some requirements because you were testing the app, or because the project has changed: You are now able to select requirements and rename them.

How to rename requirements

Go to the search and look for the requirements you want to rename.
Use the checkboxes to select requirements, and click on ‘Rename’.
We’ll detect the common prefix and suffix of the requirement, and you will be free to override them according to your needs. The preview lets you see what the requirement will look like once renamed.
1. Note: The keys need to be similar for us to detect the prefix and suffix. If you select all keys in your space you won’t be able to replace the key, only add a prefix or suffix to the existing key.
Click on Validate, and click on Rename.
Then your requirements will be renamed, definition macros and links will be updated in Confluence pages as well.

Frequently Asked Questions

Can I select keys which have different prefixes?

If you select keys that have different patterns, it will not be possible to rename both patterns so they have the same, you only be able to add a prefix before, or a suffix after.

For example: your query is key ~ 'BR%' or key ~ 'FN%', and you select them all:
- Replacing BR and FN by OTHER will not be possible,
- Adding a prefix before those keys is possible, your keys will now be renamed with OTHER-BR% and OTHER-FN%
- Adding a suffix after those keys is also possible, your keys will be renamed with BR%OTHER and FN%OTHER

Does the rename of keys also transforms Confluence pages?

Yes. When you apply a rename, we also apply a transformation on the pages where those requirements are defined on, and linked on.

Are my traceability matrices, requirement types and other items renamed as well?

Only requirement keys, links, and external properties will be updated during renaming. Other elements such as requirement types, saved matrices, and other components will remain unchanged.

Also, we do not rename requirements created with the Linear documents configuration (see: Linear documents: Manage requirements outside of tables ).

How many requirements can I rename at once?

We limit the rename to 10 000 requirements, and 50 pages.

How do I know if my rename is finished?

You can go into the Champion Center > Queue, to see the rename job and its completion. Based on the number of requirements you are renaming, it can take some time.

The rename triggers a ‘move’ event, a ‘rename’ event, an ‘update’ event where the Requirement Yogi for Confluence user updates pages. If your requirements belong to a requirement type, then there will probably be an ‘Apply rule’ event.

Who can rename requirements?

We use the edit permissions on pages where requirements are defined on, and linked on to know if a user can rename requirements. Any user who has edit permission on a page can rename requirements on said page.