Plugin providing relationships in reviews and baselines

Options
Harald Hotz-Behofsits
Harald Hotz-Behofsits Member Posts: 159
edited November 2016 in
In order to gain visibility on traceability and relationships in jama reviews and capture that in baselines we have implemented a jama plugin to bypass known restrictions.

The concept to get visibility in jama-review is based on an
idea described here:

https://community.jamasoftware.com/jama/topics/how-to-get-relationsship-into-excel-and-import-them-back-into-jama-as-text-for-usage-in-review

To make relationship data visible in review, it must be materialized in an attribute of the reviewed jama item. We have added 2 fields, upstream and downstream. We used for that purpose the fields text8 and text9 which were available due to a jama configuration issue. See also https://community.jamasoftware.com/jama/topics/not-all-textxx-fields-can-be-adapted-for-itemtype

We inserted the missing configuration data with a homemade sql script. We also created the upstream and downstream fields in the existing itemtypes with a sql script.

The plugin is event based. Any change of relationship data results in the update of the rich text fields upstream and downstream of the involved items. Up/Downstream cases with more than 200 relationships are handled different, the text "too many relationships" is placed in that case in the text field.

For setting the initial value for already existing data or repairing data after creation of a project, a velocity report called "Refresh Relationships" has been created. This report actually updates data and is started context sensitive with the result of a filter as working set.

Here should be a short video showing the plugin during use, but it was not possible to add that.

Nice Side Effects are:

- relationships also get visible in list views and excel exports

- searching for a key value in full-text-search, also delivers all items being related

Known restrictions:

- bulk import of traces is not accompanied with events, therefore not handled by plugin

- restore of a deleted item is not accompanied with relationship events, therefore not handled by plugin

in both cases the "Refresh Relationships" tool helps to fix that.

Screenhots:

image

image

Comments

  • [Deleted User]
    [Deleted User] Posts: 911
    edited June 2016
    Options
    Harald, thanks for walking us through how you addressed the need for traceability in reviews and baselines. I'm hoping we'll have a better way of sharing this sort of thing in the near future. (Slowly but surely working on it!) Your clever workarounds never fail to impress!
  • Pankaj Trivedi
    Pankaj Trivedi Member Posts: 2
    edited November 2016
    Options
     Kristina King, I am wondering about the outcome as I have not heard anything from JAMA channel about when this feature is coming? Any idea?
  • [Deleted User]
    [Deleted User] Posts: 911
    edited June 2016
    Options
    Having relationships in the review center natively is on the road map for 2016, but we don't have any release dates set.
  • Rich Mann
    Rich Mann Member Posts: 14
    edited November 2016
    Options
    Kristina, being able to review relationships in Jama Review Center is critical for my organization.  In our former requirements management tool, we frequently rejected requirements based on relationships not being established or for incorrect relationships being established.  In fact, for us, establishing relationships is a prerequisite for entry into peer review and not doing so is automatic grounds for rejection even if all else about the requirement is 100% correct.

    We are currently requiring reviewers to verify relationships externally to Jama Review Center.  We are receiving a lot of very negative feedback from users complaining that the process to review relationships outside of Jama Review Center is burdensome and the users are asking why Jama cannot allow them to review such in Review Center.

    Therefore, it is critical for us that relationships be reviewable within Jama Review Center.  Such review would include being able to open the related items from Review Center.
  • [Deleted User]
    [Deleted User] Posts: 911
    edited April 2018
    Options
    On-premises customers can now download this Velocity report and plugin created by Harald: https://community.jamasoftware.com/blogs/kristina-king/2016/11/11/report-templates-and-other-files-made-by-community-members-for-community-members
  • [Deleted User]
    [Deleted User] Posts: 160
    edited February 2016
    Options
    What about hosted customers? Do we have any possibility of getting this nice functionality? 
  • [Deleted User]
    [Deleted User] Posts: 911
    edited June 2016
    Options
    At this point, no, because we don't allow custom reports or plugins to be added to the hosted environment. Because this wasn't created by a Jama employee, we can't upload it. Are you hoping to have this so that you can see relationships in the review center, baselines, or both?
  • [Deleted User]
    [Deleted User] Posts: 160
    edited February 2016
    Options
    I'm asking because several users in my company has asked for visibility for relationships in reviews. This would be a highly appreciated feature.
  • Harald Hotz-Behofsits
    Harald Hotz-Behofsits Member Posts: 159
    edited April 2016
    Options
    I missed to include the relationship refresh velocity script. This script works only when plugin is installed. Is added here below:

    Refresh Relationships - Started
    ##
    #set($rlshpDao = $applicationContext.getBean("relationshipDao"))
    #set($fju = $applicationContext.getBean("frequentisJamaUtils"))
    #foreach($vDoc in $documentList)
    #if($vDoc.document.documentType.display != "Folder" &&
    $vDoc.document.documentType.display != "Set")
    ##$vDoc.document.documentKey
    $fju.UpdateRelations($vDoc.document.id,$applicationContext)
    #end
    #end
    Refresh Relationships - Finished

Categories