Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

This section describes how to add, view, edit, test and delete connections.

Overview of Connections

The site administrator in VERA has the ability to configure and manage connecting VERA to source applications. This allows the admin to add, edit or delete connections, aliases, linked connection and test these connections on the web portal.

VERA connections would be added by default and can not be deleted, but can be edited.

Add a Connection

Follow the steps below to add a new connection

  1. Open Site Administration > Settings tab

  2. Click Connections tab

  3. Click Add Connection, select desired system, enter the required fields and click Add Connection

    1. All fields are required

    2. System selection would determine if additional fields are shown. For example, Tosca > Auth Mode, Jira > Linked Location, qTest > qTest Name.

    3. Field Validation is done on Name and URL fields.

      1. Name Field only supports alphanumeric, @, -, _, +, and .

    4. Admin can reset all updated fields (which include linked locations and aliases) when adding a connection by clicking reset fields.

View and Edit Connection Details

To view and edit a connection

  1. Click on the connection name from the connections table or the edit icon

  2. In the details area, you can view the added connection’s fields and edit all fields except the connection’s system.

  3. You can add more aliases to the connection

  4. For a Jira connection, you can delete the linked location and add a new one

  5. Click save changes to save your changes

  6. If you would like to reset the updated fields to previously filled data, click on reset fields.

Fields

Description

System

This is a dropdown field that shows the source system of the connection/integration

Name

Name of 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 Location

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.

Editing VERA Connection

To view and edit VERA connection

  1. Click on the connection name from the connections table or the edit icon

  2. Only the following details would be displayed and can be modified

    1. Name

    2. Server

    3. API URL

    4. Browser URL

  3. Click on save changes to save your changes.

Delete a Connection

If you delete a connection, it is removed from the connections table and deleted from the server.

To delete a connection,

On the connections table, click the delete icon on the same row as the connection.

Test Connections

To test if a connection works,

  1. Add a connection and click test connection

  2. View or edit a connection and click test connection

Linked Locations

VERA currently supports linked locations for only Jira connections.

To add a linked location,

  1. Add an Xray connection

  2. Add or edit a Jira connection and click on add linked location

    1. System is pre-filled as Xray

  3. Select name of a previously added Xray connection.

  4. Click save changes to save your changes

To edit a linked location

  1. When editing a connection, edit the linked location name

  2. Click save changes to save your changes

Linked location system can not be edited

To remove a linked location

  1. When adding or editing a Jira connection, click the delete icon by linked location

  2. Click save changes to save your changes

Aliases

Add Alias is available for Jira, qTest, Xray, and Tosca system connection. Site admins can add multiple aliases while adding a connection.

To add an alias to a connection

  1. When adding or editing a connection, click on add alias

  2. Enter alias name, there is no validation on this field

  3. Click save changes to save your changes

To edit an alias

  1. When editing a connection, edit the alias

  2. Click save changes to save your changes

To remove an alias from a connection

  1. When adding or editing a connection, click the delete icon by the alias

  2. Click save changes to save your changes

  • No labels