Connections management
A system administrator in Vera has the ability to configure and manage Vera connections to source applications. This allows the admin to add, edit, or delete connections, aliases, and test these connections on the web portal.
Note: Vera system connections are added by default and can't be deleted, but only edited.
Add a connection
To add a connection in Vera, follow these steps:
-
Open Site Administration > Settings tab.
-
Navigate to Connections > Add Connection, select desired system, enter the required fields:
-
All fields are required.
-
System selection would determine if additional fields are shown.
Tosca > Auth Mode
Jira > Linked Connection
qTest > qTest Name
-
Field validation applies to Name and URL fields. Note that the Name field only supports alphanumeric, @, -, _, +, and .
-
Admin can reset all updated fields which include linked locations and aliases when adding a connection by selecting Reset Fields.
-
View and edit connection details
To view and edit connection details in Vera, follow these steps:
-
Select the connection name from the connections table or the edit icon.
-
Go to the Details area, to view and edit connections:
-
You can edit all fields except the connection’s system.
-
You can add more aliases to the connection.
-
For a Jira connection, you can delete the linked location and add a new one.
-
-
To save your changes, select Save changes.
-
To reset the updated fields to previously filled data, select Cancel changes.
| Fields | Description |
|---|---|
|
System |
This is a dropdown field that shows the source system of the connection/integration. |
|
Name |
Name of the connection. |
|
Server |
URL of the source system’s server. |
|
Service Account |
Set up a service account for the source system with administrator access. |
|
Password |
Service account password. |
|
Browser URL |
Browser URL for the source system. |
|
API URL |
API URL for the source system. |
|
Alias |
One or more aliases can be added per connection. |
|
qTest Name |
This is a required field for qTest system connections only. |
|
Linked Connection |
This is an optional button for Jira system connections. Please see linked locations section for more info. |
|
Auth Mode |
This is a required field for Tosca system connections and there are only two options: none and client credentials. |
Edit Vera connection
To edit a Vera connection, follow these steps:
-
Click on the connection name from the connections table or the edit icon.
-
Edit the following details:
-
Name
-
Server
-
API URL
-
Browser URL
-
-
To save your changes, select Save changes.
Delete a connection
To delete a connection, go to the connections table and click the delete icon on the same row as the connection.
When you delete a connection, it is removed from the connections table and deleted from the server. Connections that have records associated to a domain cannot be deleted.
Test connections
You can test the following connections in Vera:
To test if a Jira connection works, follow these steps:
-
Add or view a connection and click Test Connection.
-
Modify the GET call with required information for the target system with known data.
Replace {Issue ID} with an Issue ID of a record in a Jira project that is integrated with Vera.
-
Select Test Connection.
If the connection test was unsuccessful, an error will appear. Contact Tricentis Support if needed.
To test if a qTest test case or test run connection works, follow these steps:
-
Add or view a connection and select Test Connection.
-
Modify the GET call with required information for the target system with known data.
-
Replace {Project ID} with a qTest project ID that is integrated with Vera.
-
For test cases, replace the {Item Type} with test-cases.
-
For test runs, replace the {Item Type} with test-runs.
-
For test cases, replace the {Entity ID} with the test case number.
-
For test runs, replace the {Entity ID} with the test run number.
-
-
Select Test Connection.
If the connection test was unsuccessful, an error will appear. Contact Tricentis Support if needed.
To test if a Tosca connection works, follow these steps:
-
Add or view a connection and select Test Connection.
-
Modify the GET call with required information for the target system with known data.
For example:
-
After “toscacommander/” input the workspace name, such as tosca-vera-qtest-mssq.
Note that this workspace must be a Tricentis Servicer Repository type.
-
Input the treeview (this is static).
-
Input the unique ID, such as 3a092628-2031-3aec-297d-b0ae7c635eb9.
-
-
Select Test Connection.
If the connection test was unsuccessful, an error will appear. Contact Tricentis Support if needed.
To test if an Xray connection works, follow these steps:
-
Add or view a connection and select Test Connection.
-
Modify the GET call with required information for the target system with known data.
Example: We module authenticate as the specific entity.
Source system specific fields
Certain source systems support or require specific location information, such as:
Linked locations
Vera supports linked connections for only Jira connections.
To add a linked connection, follow these steps:
-
Add an Xray connection.
-
Add or edit a Jira connection and select Linked Connection.
System is pre-filled as Xray.
-
Select name of a previously added Xray connection.
-
To save your changes, select Save changes.
To edit a linked location, follow these steps:
-
Edit the linked connection name.
-
To save your changes and select Save changes.
Note: The system of a linked connection can not be changed or edited.
To remove a linked connection, follow these steps:
-
Select the Delete icon by linked connection.
-
To save your changes, select Save changes.
Alias
Alias support is available for Jira, qTest, Xray, and Tosca system connections. System administrators can add multiple aliases while adding a connection if needed.
To add an alias to a connection, follow these steps:
-
Select Add alias and enter an alias name.
-
To save your changes, select Save changes.
To edit an alias, follow these steps:
-
Select Edit alias.
-
To save your changes, select Save changes.
To remove an alias from a connection, follow these steps:
-
Select the Delete icon by the alias.
-
To save your changes, select Save changes.