Adding a Repository

Owned by Ambarish Ganesh (Unlicensed)
Last updated: Apr 04, 2022 by Lonnie VanZandt

In order to make model-based connections to elements in a repository, the user must first add and connect to the repository using the Repository Manager. To connect to a repository, right-click on the appropriate Repository type (such as MySQL repositories) in the Repository Manager tab and select Add. The following figures show this for a MySQL repository.

Generally for each repository, except the local file system repository, you will need to fill out the following information:

  • Repository Name: Unique name (alias) assigned to a repository by the user. 
  • URL: URL to access the repository. Check with the repository administrator about links, firewalls, and other issues that may affect access. The user must already have credentials to access the desired repository, with a username and password assigned by the repository administrator.
  • User: Username to access the repository
  • Password: Password to access the repository


Aras

For Aras repositories, the URL field should be populated by the base URL of your Aras Innovator server.

The following additional information is required:

  • Grant type - password (default)

  • Scope - Innovator (default)

  • Client Id - ID of the Syndeia Cloud app registered by your admin on the Aras Innovator server. See the Pre-Requisites section on this page: Aras Innovator Repositories | Pre-Requisites.

  • Database - Aras Innovator database. Enter the same database that you select on the Aras Innovator web client during sign-in.

Artifactory

For Artifactory repositories, the default URL is of the format
https://<myOrgServer.myOrg.com>:8081/artifactory

Bitbucket

For Bitbucket repositories, the URL field should be populated by the base URL of your Bitbucket server

Username can be either your Bitbucket username or the email address associated with your Bitbucket account

  1. If you have entered your Bitbucket username in the Username field, the Password can be

    1. Either the password you use to sign in to the Bitbucket web client, or

    2. Personal Access Token. To create a Personal Access Token, refer here - https://docs.Bitbucket.com/en/Bitbucket/authenticating-to-Bitbucket/keeping-your-account-and-data-secure/creating-a-personal-access-token

  2. If you have entered the email address associated with your Bitbucket account in the Username field, enter the Password you use to sign in to the Bitbucket web client

Confluence

For Confluence repositories, the default URL is of the format https://<myJiraURL>/wiki

  1. If you are using Confluence Server (installed on-premise or virtual private cloud), enter the same username and password that you use on the Confluence web client.

  2. If you are using Confluence Cloud (hosted by Atlassian), User = E-mail and Password = API Token. Refer to the following page to create an API token: https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/.


DOORS-NG

For DOORS-NG repositories, the URL field should be populated by the URL of your DOORS-NG server followed by the port number and the requirements management service (default = rm).


To verify your URL, append /web to it and try opening it in a web browser. For example, try opening https://server.myComp.com:9443/rm/web for the example shown here.


GitHub

The URL and Password depend on your GitHub deployment:

  1. For GitHub cloud (www.github.com):

    1. URL = https://api.github.com.

    2. Password = Personal Access Token. To create a Personal Access Token, refer here - https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token

  2. For GitHub Enterprise deployed in your organization:

    1. Use the URL http(s)://<hostname>/api/v3
      1. The <hostname> is the host address of your GitHub Enterprise server. This should be provided to you by your GitHub administrator.
      2. Refer to this page for details: https://docs.github.com/en/enterprise-server@3.0/rest/guides/getting-started-with-the-rest-api
    2. Use the same password you use to sign in to GitHub web client.

GitLab

The URL depends on your GitLab deployment:

  1. For GitLab cloud (gitlab.com), use https://gitlab.com.

    1. Username is not needed and can be any string. 
    2. For Password enter a Personal Access Token. To create a Personal Access Token, refer here - https://docs.GitLab.com/en/GitLab/authenticating-to-GitLab/keeping-your-account-and-data-secure/creating-a-personal-access-token

  2. For GitLab Enterprise deployed in your organization, check the URL from your GitLab Enterprise administrator.

    1. Use the username and password (credentials) provided by your GitLab administrator.


Jama

For Jama repositories, the URL field should be populated by the URL of your Jama server followed by the port number (if required).

  1. For Basic Authentication username and password should be used
  2. For Oauth see Adding Jama Repository using OAuth

JIRA

For JIRA repositories, the URL field should be populated by the URL of your JIRA server followed by the port number (if required). If you have a JIRA subscription from Atlassian, then your JIRA server is cloud hosted by them and the URL would follow the pattern: https://myGroup.atlassian.net.

  1. For Basic Authentication:
    1. Username and password should be used for Jira server instances
    2. Jira cloud instances (e.g. https://myGroup.atlassian.net) require User = E-mail and Password = API Token. Refer to the following page to create an API token: https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/.
  2. For Oauth see Adding Jira Repository using OAuth

Local File System

For Local File System repositories, specify a unique name and location of a folder on your local file system (or a shared drive). Alternatively, use the Browse button to locate it. Press OK to complete.

MySQL

For MySQL repositories, the URL should not include the protocol (http or https) but should be in the following format. The default port number is 3306. <server.mycompany.com>:<portNumber>.

Teamcenter

For Teamcenter repositories, the default URL is of the format
http://<server.mycompany.com>:7001/tc

Teamwork Cloud (TWC)

For Teamwork Cloud repositories, use the Base URL of the REST API available for your TWC repository. By default, the REST API is available at port 8111 and osmc path, e.g. https://twc.myOrg.com:8111/osmc.

TestRail

For TestRail repositories, use the base URL of your TestRail repository.

Windchill

For Windchill repositories, the default URL is of the format
http://server.mycompany.com:8080/Windchill

It assumes that the default app is Windchill and it is available on port 8080. If that is not the case for your organization, the more general format is: http://<server.company.com>:<PortNumber>/<AppName>.



Zephyr Scale

TM4J, now known as Zephyr Scale, is a Test Management app deployed on JIRA repositories. See instructions for Jira repositories above.