API 1.12

Software version: API 1.12

Publication date:  

This file provides information about the VERA API Server:

  • Version Information
  • Resolved Issues
  • New Features
  • Docker Image Information
  • Known Issues and Limitations

Version Information

High-level VERA Version2022.2
API VersionAPI 1.12

Software Build

(Can be verified on the "Versions" screen in the web portal.)



Resolved Issues

VS-2150Entering a duplicate domain name results in unexpected behaviorCorrected the error message when user enters domain name that already exists.

VERA confuses qTest Test Runs and Test Cases with matching projectId and artifactId pairs.

Fixed record corruption issue when a qTest Test Case and a qTest Test Run have the same qTest artifactId.

VS-2125User Cannot Approve/Reject Record when Author field is populatedUsers can approve or reject records when there is no author user match between the integrated system (Jira, qTest) and VERA

Author sees the issue he routed in the approval queue when author exclusion is enabled

Fixed bug when Prevent Author Approval is set to true in the approval policy JSON but Author value is set to null in the RMP, then author still sees the task in the approval queue.
VS-2049Jira Record displays author as Unknown - Author field should not be displayed if unknown on Jira recordsRemoved author's field when there is no author and system is different from qTest
VS-2039Create a single static MongoClient to be used in the VERA instanceUse a single instance of the MongoDB driver according to best practices.

Add Jira Webhook Call tracking to allow more retries from Jira

Added handling of Jira Webhook Retries so that VERA will handle retries that had previously not been received.
VS-2033Add Get Domain by Name API call to Domains moduleOptimized retrieval of domain by name.
VS-1963Password Policy throws 500 error when user attempts to save with incorrect data typeHandle exceptions due to bad data being passed in for the Password Policy

XRay attachments are not being attached correctly

Fix attachments on Xray for Jira records.
VS-1911Jira records attachments are not displaying/downloading from in VERAThis defect only solves the first of the two attachment problems. The first problem, where the download URL was pointing to the source system instead of VERA, was resolved by nulling the URL on the attachment itself during the import of the file from Jira to VERA so that VERA can apply the correct VERA URL at a later time. The second one, accessing files led to a 404 error, is handled in CCR-142.
VS-1889Remove HTTP Client Retries and make Timeouts configurableRemoved HTTP retries from internal HTTP requests.
Add configurable HTTP timeouts to handle longer running requests.
VS-1861Base Record Type element is missing in Uploaded Records Management PolicyAdded base record type property to policies module. This was only done on the develop branch because the bug was introduced in the policy management stories.
VS-1700Cannot re-verify failed signatures

Fixed unexpected error in reverifying failed signatures.

VS-1696The test author is duplicated when the author VERA username and email address is the sameFixed an issue when authors were matched with the same VERA user twice.
VS-1691Delete User from domain when they are deleted from User ManagementWhen deleting a user, user is also being removed from the domains it was assigned.

Jira Cloud user custom fields shows as null in VERA

Adopted user fields for Jira cloud.

Jira service account cannot authenticate against server if it has no roles

The Jira service account used for the Jira App access updated:

  • Develop branch 1.12 - Jira Service account can access approval routes with a System Service Account role
VS-1583Slash characters in approval group names cause the Routes Module to failFixed support for approval groups containing slash characters in urls.
VS-1391Revision Number is blank in qTest Run Record Details for History entriesFixed an issue where the Revision Number field was not captured in the first history entry for certain record types.
VS-1235Approval Queue Project filter does not return records based on filter selectionqueryParameters.FieldValuesContain repositioned because of Projections. Domain/Project filter in FieldGroupsBuilder removed

New Features

VS-1823Filter component improvements
VS-1793Support intermediate states when revising records

View available projects, record types and record status in record filters

VS-1751Add filter to Domain Management table
VS-1720Support intermediate states when withdrawing routes
VS-1719Support error state when an error occurs during routing
VS-1718Support intermediate state when routing for approval

Viewing Record Details

VS-1686Prevent user from accessing an approval task page if they are not a member of a domain
VS-1645Policy Module Reads from policies from database
VS-1287Admin can import policy files via the Web Portal
VS-1286Import Approval, Records Management, Sync Policies from the File System to the database

Docker Image Information

  • 2022.2
  • 1.12
How to UpgradeSee Upgrade the VERA Server Applications for instructions

Known Issues and Limitations



Known Issue Details

VS-139"Pending Tasks" field refreshes too slowly after route withdrawal.The Pending Tasks field in qTest and Jira is not immediately updated when the record is approved or rejected in VERA.  The cached values are updated when the user invokes a browser refresh,
VS-163Rejection Reason can be submitted with only a space (no text) enteredRejection Reason can be submitted with only a space (no text) entered. 
VS-323VERA Server needs a reboot to fully read new Sync Policy entriesChanges to the VERA Synchronization Policy will not take affect until the VERA Application service is restarted.
VS-447User Administrator role can see Signature Verification Failure Report and Re-verifyA User Administrator can access the Signature Verification reporting section of the Administration Portal.  This feature should be limited to System Administrators.
VS-606Error while sorting approval queue with large quantity of tasksUsers may encounter errors while sorting an approval queue with a large (thousands) quantity of tasks.
VS-668Sorting shows all values beginning with a capital letter before lowercase valuesWhen sorting data (users, records, etc.) alphabetically, the system erroneously alphabetizes capital letters independently from lower-case letters.  For example:  Apple, Cat, ball -- instead of: Apple, ball, Cat
VS-692JSON Attachment download returns 500 errorA Jira issue had the approval policy.jason file attached; an error was displayed when downloading the attachment.
VS-698VERA cannot create a qTest record if two fields in the record have the same nameThe VERA-qTest integration does not support importing records from qTest where the record has two fields with the same name.  If such a record is routed for approval from qTest, then an error will occur.
VS-700User sees duplicate approval tasks for the same record in approval queueIf an approval route contains two pending tasks for the same role (e.g. two Technical approvals) then an eligible approver will see both tasks in their queue.
VS-962Approval Queue user filter uses RegEx can match different usersDue to regular expression matching, a record that has been signed by one user may cause another user's approval queue to exclude the record when it should be available.
VS-988VERA DevOps does not apply a default approval routeIf a record is routed for approval that does not satisfy any configured route templates, the user will see "VERA is trying to start the approval route" rather than a descriptive error containing the reason why the route was not started.
VS-1060If user has a null value for a role in their claims list the user module fails to add or remove them from a roleIf a user has a claim that has a type of role and a value of null (not just a blank string), the user module will throw an exception when trying to add or remove the user from a role.
VS-1065A misleading error message is displayed when VERA cannot apply a final approvalVERA will display a misleading error message when it fails to transition a Jira issue in the workflow.  The error message displayed to the user will indicate that there is a connectivity problem, even if it's actually a configuration problem. 

Invalid Approval Group error log should indicate with group or line number the error is on

Currently error log does not display approval group details when invalid approval group is logged. 

VERA returns an HTTP 500 status code to Jira webhooks when it cannot access the Sync ID field

With Jira Cloud, the HTTP 500 status code will prompt Jira to retry the same webhook a few minutes later.  This is undesirable, because a) there is no reasonable expectation that it will succeed, and b) the user will have very likely tried rerouting the record again anyway.

Therefore, the Jira module should return a different status code that will not trigger a retry from Jira Cloud.


VERA does not handle concurrent start route requests for the same record

The VERA API does not have proper handling for concurrent start approval route requests for the same record.  If it is a new record, then the end result could be the record receiving two different Sync IDs each with its own approval route.
VS-1293Final approval fails when Jira projects are configured with a Signatures fieldVERA will attempt to write the entire approval route to the Jira Signatures field if the field is present in the Jira project. If the approval route contains over 255 characters the Approval will fail since VERA is attempting to write over 255 characters to the field.
VS-1303Jira and qTest Modules use the Server property from the Sync Policy as the Base URLThe Jira and qTest modules both use the Server property for a location for the baseurl when connecting to Jira or qTest. This is normally fine, but can cause an issue where a client has a gateway or proxy in between VERA and their Jira/qTest servers. Modules should use the API Server url defined in the policy file.
VS-1391Revision is blank in qTest Run Record Details for History entriesThe Revision field is blank for qTest Test Run records in the Record Details for a History entry.
VS-1419Routing records for approval - errors in logsIn the users module, when GET /users/{userId} endpoint is being called with a userId different from the request owner's userId, then users module responses with 403 Forbidden status code.
VS-1591Password content can break qTest integrationUsing a colon character (":") in the qTest Service Account password causes the qTest integration to fail. The colon character (":") is not supported and should not be used in service account passwords.