Release 2.5 – Public API, ReqIF and queue in Jira

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

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

https://developer.requirementyogi.com

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)

RY 2.5.1 (Confluence and Jira)

  •  Added support for renamed, moved and deleted issues, to update their issue title in Confluence.

  •  Fix an error in Jira Data Center by removing a cache which wasn't used often.

RY 2.5.2 (Confluence only)

  •  Redirect to the search after renaming issues,

  • Add a "Status" field in the traceability matrix for Jira issues

  • RY-554 Issue not public yet.

RY 2.5.3 (Confluence only)

  •  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!

  •  Traceability matrix: A column for the description of requirements,

  •  Traceability matrix: A column for the name of the original page of the requirement.

  •  In the RTE, display the full details of the properties when clicking on a requirement macro,

  •  Small bug about the Diff screen.

  •  Disable the search box in the RY Report macro, since no-one uses it.

  •  Display the lozenge when displaying dependencies in the search.

  •  Sort the links by alphabetical order - in the popup, in the search, in the reports etc.

  •  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.

  •  Upgrade the "refreeze baseline" experience. Use drag'n'drop, support UTF-8 requirements,

  •  In the popup, display the status of Jira issues,

  •  For the popup, let the administrators configure whether the popup should be displayed immediately or upon click,

  •  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.

  •  Entirely remove the code that used to notify administrators when the communication queue with Jira failed,

  •  Decouple the global limit, let the users set the limit for the pages, import, and so on.

RY 2.5.7 (Confluence and Jira)

  •  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.

  •  Confluence administration: The administrator can check whether they are reaching a high number of used IDs in the database.

  •  Confluence administration: An "Uninstall" screen helps customers leave Requirement Yogi by uninstalling all the macros.

  •  Space administration: Ability to purge trashed requirements.

  •  Diff: PDF exports should contain the strikethrough when elements are removed.

  •  Jira: Users are warned when using the JQL function with too many requirements.

  •  Jira (8.0 and above, and non-Data Center only): We have a new syntax to search for requirements.

RY 2.5.8 (Confluence)

  •  Add logging for an error that is displayed in the traceability matrix,

  •  Display a tab in the administration with a few usage statistics.

RY 2.5.9 (Confluence and Jira)

  •  We've noticed that baseline numbers could collide in certain circumstances. Introduce a cluster-wide lock to avoid this.

  •  Jira bulk issue creation: Support for the Epic field.

  •  Traceability matrix: Description column didn't display when the report was inserted in Confluence pages.

  •  Diff: Include reverse dependencies when doing a diff on dependencies.

  •  Ability to clean up broken links (Go to space administration → RY Reindex),

  •  Error in the editor when inserting requirements (interference with another app).

RY 2.5.10 (Confluence)

  •  Traceability matrix - 1. Better "save" menu, 2. They can be cross-space, 3. They can be made visible to the whole space.

  •  Traceability matrix: The expand/collapse box works on pages.

  •  Display the results of the last queue job, in the administration.