Renaming requirement keys


To change a requirement key:

  • Go to the search, select one, several or all requirements, click Actions -> Rename.

  • It will update the requirements, it will update places where the requirement is referenced, and it will update JIRA (provided RY 1.7.0+ is installed),

  • Be aware that it won't keep a permalink of the old requirement, so if you've linked to it from other systems, the link will be orphan.






Norbert Nemec
August 3, 2017, 12:18 PM

I just sent it via mail

Norbert Nemec
August 3, 2017, 9:28 AM

I just noticed one interesting detail: The RY links that were not found for replacing are those that were previously moved from another space. These still carry the cross-space marker in the macro (i.e. after the "| link", there is another "| BKTC" appended when looking at the macro in edit mode).
This is even though the definition and the link are both on the same page which was moved from the other space as a whole.
The "| BKTC" is not present for newly created references that look otherwise identically except for the failure to follow the rename.

Adrien Ragot (Old account)
August 3, 2017, 9:17 AM

Would you agree to send us the storage format of the page?

  • I understand if you can't for confidentiality reasons. You can also send it directly to to avoid showing it in public.

  • The "View storage format" is an option in the "..." menu on the top-right of the page.

Alternatively, can you at least tell us what keyword you're using?

Norbert Nemec
August 3, 2017, 9:07 AM

Sorry, still not fully working in version 1.8.1.
I cannot reproduce the problem with newly introduced RY macros, but for macros that we have on the page (page moved from a different space in the past) renaming still does not find any links located on the same page. The new info on the rename task status page also states that only 1 macro was found and replaced on this page (i.e. the original definition), even though there are two or more references to the same keyword on that same page.

User known
July 10, 2017, 7:48 AM

Hello Norbert,

We've released RY 1.7.2, which should resolve your problem. Plus, we've added in the rename task status page an information about the number of pages the rename task has visited, the number of Requirement macro seen, and modified. Thus, if there's still a problem, you can easily see if this is caused by pages not parsed by the task, or macro which are not modified.

Can you check if your problem still happens?



Adrien Ragot (Play SQL / Requirement Yogi)


Adrien Ragot (Old account)





Story Points





Fix versions