Release 2.5 – Public API, ReqIF and queue in Jira
- Adrien Ragot
- Mileva Briand
Mostly a technical release
2.5.0 is a major version because there are major changes in terms of internal package names and build process, but it has few immediately-visible features. Our performance tests for Data Center show no visible impact for our changes, neither for Confluence nor Jira, so in theory all should go well.
Important
Please configure an administrator username in Jira for the queue.
Set your credentials in Confluence | Set your credentials in Jira |
|---|---|
 |  |
What are those credentials used for? See Requirement Yogi for Jira - Basically it was required for the best performance, to ensure we support multinode environments and the Data Center requirements. | |
A new, public API
You are now able to program extensions to integrate Requirement Yogi with other systems!
Public API | |
|---|---|
REST API | https://developer.requirementyogi.com/restapis/restapis-com.playsql.requirementyogi-2.5.0/ |
Exemple of implementation | See our ReqIF addon, Source: https://bitbucket.org/requirementyogi/extensions-reqif Will be published soon on the Atlassian Marketplace |
Unofficial support for ReqIF and other formats
In the next few weeks following RY 2.5.0, we'll publish a plugin which uses our Public API and imports 80% of a ReqIF document.
Note: We won't officially "support ReqIF" because it would require us to support 100% of the ReqIF specification, and most documents exist in other formats than ReqIF. The goal of the plugin is to show how external documents can be supported, and thus make it possible for you to import your own document and do the mappings yourself.
Queue in Jira (a username is required)
Since we've implemented the Jira bulk issue creation for requirements, we've seen issues for users who create more than 2,000 issues and want to keep them in sync.
A queue in Jira will allow us to reliably notify Confluence of changes (issue rename, issue move, etc).
The drawback is that it requires a username in Jira's administration.
Minor versions
RY 2.5.0 (both Confluence and Jira)
https://requirementyogi.atlassian.net/browse/RY-518 (and RY-562) – This is the change which requires a username in Jira.
https://requirementyogi.atlassian.net/browse/RY-616 - We've changed the internal storage for saved traceability matrixes. They should be transferred automatically using a background job that runs 3 minutes after the plugin is installed; If they are not migrated automatically, you can click "Migrate now" in the traceability matrix dropdown.
https://requirementyogi.atlassian.net/browse/RY-592 - We've rerun the Data Center tests for Jira after adding the queue.
https://requirementyogi.atlassian.net/browse/RY-603 - In Jira, we've changed the storage we store connection information to Confluence (API version, username and whether we auto-upgrade).
https://requirementyogi.atlassian.net/browse/RY-599 - In Jira, we've made it easier to set the username for the authentication to Confluence. The ticket will remain "open" until we do the same in Confluence.
https://requirementyogi.atlassian.net/browse/RY-604 - In Jira, support values sent by RY Confluence for the "Components", "Labels", "Assignee" and similar complex fields, and support when they are "templated" (when a component is "{@a_property}", meaning the user wants to use a property of the requirements as a component name).
https://requirementyogi.atlassian.net/browse/RY-553 - In Jira, stop displaying the popup when hovering over a requirement key. Instead, display it when we click on the requirement, to avoid flashes of popups when a user is browsing the screen with their mouse.
https://requirementyogi.atlassian.net/browse/RY-623 - We've improved the in-code documentation so the REST API documentation displays nicely.
RY 2.5.1 (Confluence and Jira)
https://requirementyogi.atlassian.net/browse/RY-587 Added support for renamed, moved and deleted issues, to update their issue title in Confluence.
https://requirementyogi.atlassian.net/browse/RY-626 Fix an error in Jira Data Center by removing a cache which wasn't used often.
RY 2.5.2 (Confluence only)
https://requirementyogi.atlassian.net/browse/RY-568 Redirect to the search after renaming issues,
https://requirementyogi.atlassian.net/browse/RY-609Add a "Status" field in the traceability matrix for Jira issues
RY-554 Issue not public yet.
RY 2.5.3 (Confluence only)
https://requirementyogi.atlassian.net/browse/RY-531 Traceability matrix: A tree view for the first column, and a button to display all properties in one click – See our new screenshots of the Traceability matrix!
https://requirementyogi.atlassian.net/browse/RY-634 Traceability matrix: A column for the description of requirements,
https://requirementyogi.atlassian.net/browse/RY-633 Traceability matrix: A column for the name of the original page of the requirement.
https://requirementyogi.atlassian.net/browse/RY-630 In the RTE, display the full details of the properties when clicking on a requirement macro,
https://requirementyogi.atlassian.net/browse/RY-628 Small bug about the Diff screen.
https://requirementyogi.atlassian.net/browse/RY-643 Disable the search box in the RY Report macro, since no-one uses it.
https://requirementyogi.atlassian.net/browse/RY-642 Display the lozenge when displaying dependencies in the search.
https://requirementyogi.atlassian.net/browse/RY-641 Sort the links by alphabetical order - in the popup, in the search, in the reports etc.
https://requirementyogi.atlassian.net/browse/RY-635 Display the space name when searching for requirements in Confluence's Quick Search.
RY 2.5.4 (Confluence only)
RY-554 (Unofficial) Support for the UTF-8 keys in the rename and the refreeze.
https://requirementyogi.atlassian.net/browse/RY-600 Upgrade the "refreeze baseline" experience. Use drag'n'drop, support UTF-8 requirements,
https://requirementyogi.atlassian.net/browse/RY-621 In the popup, display the status of Jira issues,
https://requirementyogi.atlassian.net/browse/RY-645 For the popup, let the administrators configure whether the popup should be displayed immediately or upon click,
https://requirementyogi.atlassian.net/browse/RY-647 When exporting a page to PDF, if there was an RY Report macro displaying a diff, the diff wouldn't be coloured. Added the colour.
https://requirementyogi.atlassian.net/browse/RY-646 Entirely remove the code that used to notify administrators when the communication queue with Jira failed,
https://requirementyogi.atlassian.net/browse/RY-584 Decouple the global limit, let the users set the limit for the pages, import, and so on.
RY 2.5.7 (Confluence and Jira)
https://requirementyogi.atlassian.net/browse/RY-595 Personal queue. There are messages between Confluence and Jira which can sometimes fail (authentication, etc). The user who modified the requirement page gets notified (randomly once every 50 views) and they can retry messages.
https://requirementyogi.atlassian.net/browse/RY-650 Confluence administration: The administrator can check whether they are reaching a high number of used IDs in the database.
https://requirementyogi.atlassian.net/browse/RY-472 Confluence administration: An "Uninstall" screen helps customers leave Requirement Yogi by uninstalling all the macros.
https://requirementyogi.atlassian.net/browse/RY-607 Space administration: Ability to purge trashed requirements.
https://requirementyogi.atlassian.net/browse/RY-636 Diff: PDF exports should contain the strikethrough when elements are removed.
https://requirementyogi.atlassian.net/browse/RY-488 Jira: Users are warned when using the JQL function with too many requirements.
https://requirementyogi.atlassian.net/browse/RY-652 Jira (8.0 and above, and non-Data Center only): We have a new syntax to search for requirements.
RY 2.5.8 (Confluence)
https://requirementyogi.atlassian.net/browse/RY-657 Add logging for an error that is displayed in the traceability matrix,
https://requirementyogi.atlassian.net/browse/RY-655 Display a tab in the administration with a few usage statistics.
RY 2.5.9 (Confluence and Jira)
https://requirementyogi.atlassian.net/browse/RY-662 We've noticed that baseline numbers could collide in certain circumstances. Introduce a cluster-wide lock to avoid this.
https://requirementyogi.atlassian.net/browse/RY-661 Jira bulk issue creation: Support for the Epic field.
https://requirementyogi.atlassian.net/browse/RY-658 Traceability matrix: Description column didn't display when the report was inserted in Confluence pages.
https://requirementyogi.atlassian.net/browse/RY-654 Diff: Include reverse dependencies when doing a diff on dependencies.
https://requirementyogi.atlassian.net/browse/RY-664 Ability to clean up broken links (Go to space administration → RY Reindex),
https://requirementyogi.atlassian.net/browse/RY-665 Error in the editor when inserting requirements (interference with another app).
RY 2.5.10 (Confluence)
https://requirementyogi.atlassian.net/browse/RY-589 Traceability matrix - 1. Better "save" menu, 2. They can be cross-space, 3. They can be made visible to the whole space.
https://requirementyogi.atlassian.net/browse/RY-663 Traceability matrix: The expand/collapse box works on pages.
https://requirementyogi.atlassian.net/browse/RY-668 Display the results of the last queue job, in the administration.