ReviewHub Listener 2.0.0

ReviewHub Listener 2.0.0

ReviewHub User required role Permissions:

In the the project, ensure the review hub service role has the permission to view members and roles. Navigate to the project, then Admin > Members > ReviewHubService and make sure Members - View and Role - View is checked.



Role/User conflicts

To ensure that and invalid review is not created, at the time of creation, an algorithm verifies that given the roles and users specified, it is possible for at least one member per role. If such a configuration is not possible, it will throw an error at time of creation stating that the roles/users specified make the review impossible to complete. The error looks like this:


A similar error is thrown for an open review that is no longer possible to complete due to role/user/review configuration changes.

It is too complex to explain what roles are in conflict as we would have to keep track of all of the invalid permutations. Here are some simple examples:

This is the role setup for a user named jwood for both scenarios. For demonstration purposes, jwood is the only user with these roles.


Scenario 1

A review is created that names jwood as a moderator and requires a software engineer to view.


Since jwood cannot act both in his capacity as a Software Engineer and a named user, it will not be possible to complete the review. At least one other user who cannot also be named must have the role Software Engineer in order to complete the review.

Scenario 2

A review is created that requires a Software Engineer and a Design Quality Engineer to review.


Since jwood cannot act both in his capacity as a Software Engineer and Design Quality Engineer, it will not be possible to complete the review. At least one other user who cannot also be named must have the role Software Engineer or Design Quality Engineer in order to complete the review.

Codebeamer limitations

At the time of writing, codebeamer stores the originally assigned roles with the review even if the review is modified and roles are removed. Because we cannot enforce that if user and role configurations change while a review is open, we cannot guarantee said review will remain possible to complete. Also, if a review is edited from the review hub page, in the background a Project Admin role is assigned to the review even though this is not reflected in the UI. This could also lead to issues completing a review.

As such, the recommended best practice is to ensure user/role configurations do not change while there are open reviews and that a review is set up correctly from the start so that editing is unnecessary. 


    • Related Articles

    • ORRE-BRA Tracker: Adding Risk Assessment Elements

      The ORRE-BRA listener now supports adding unlimited risk assessment elements. Each element must follow the same JSON structure for the listener to function properly. This guide explains how to configure a new risk assessment element to appear on ...
    • Review Hub

      This process aims to automate placing items into their "Approved or Draft" state upon review completion for the Streamlined Review Process. These items must be in the "In Review" state when users send items to Review HUB for review. In the Review Hub ...
    • Use Case - 10

      In this process, the “Validation Questionnaire” table in any “Validation Activity” item will need to include the surgeon names from the “Surgeon Table” in its upstream “Validation” item counterparts. If there are multiple upstream counterparts the ...