Introduction

What kind of extensions can we create?

• Read-only access to the Java API: See Java API,
• Write access to requirments (to import Excel files, XML files, network app, etc): See ReqIF,
• But first, prepare your development environment (see the menu on the left).

What is going to change soon?

• Version 2.4 was our alpha release. It still comes with a mistake we’ve done long ago: Some beans are defined in com.playsql.requirementyogi.ao.
• Version 2.5 will be the public beta. The beans will be in com.playsql.requirementyogi.api.beans, so the upgrade process will be to change the package names for those beans (Their implementation won’t change).

For extensions, do requirements have to come from an imported file?

No. They can come from another database, from a network connection, from another website, etc. Requirement Yogi only requires a ‘Document ID’ and sends the user to the URL that you provide.

How does versioning work?

If you don’t manage versioning, then when a user creates a baseline, Requirement Yogi copies the requirements and has a UI to display them. All requirements with the same Document ID will be displayed in the same screen.

If you manage versioning, then RY will redirect users to your UI, providing a Document ID (generated by you) and a documentVersionId (generated by you, string). When freezing a baseline, RY copies requirements and calls your plugin to generate a documentVersionId for this version of the document.

It is explained in ExternalAPI’s javadoc.