- Create a user in Azure DevOps Server (TFS) / Azure DevOps Services (VSTS) that is dedicated for OpsHub Integration Manager. This user shouldn’t perform any other action from the system’s user interface.
- User must have administrator privileges in Project Administrators user group for workitem integration.For Meta entities like Group, User entities, integration user must have administrator privileges in Project Collection Administrators user group.
- Refer section How to Add User in Group to learn how to add user in Collection/ Project Administration group. For Azure DevOps Services (VSTS).
- User can use Basic Authentication or Personal Access Token authentication method to communicate with API for Azure DevOps Services (VSTS). In case of Personal Access Token authentication, please check Personal Access Token section for the required permission details.
- If your Team Foundation Server/ Azure DevOps is configured with SSO, then the above mentioned privileges and permissions are sufficient.
Note: In case user wants to synchronize User type fields of Azure DevOps systems with any other system with default OpsHub Integration Manager generated mapping, it is necessary that all users have their preferred e-mail address set in the Azure DevOps systems.
Personal Access Token Minimum Required Permission
Refer Create Personal Access Token section to learn about how to create Personal Access Token.
Personal Access Token should be created with Full access scope for entities such as Test Result, Test Suite, Test Run, Build, Team, User, Group & Permission. For other entities, user can create a Personal Access Token with Full access scope if possible, otherwise user can create Personal Access Token with Custom defined scope with essential permissions specified below.
Least required permissions for all work item types
|Permission Types||Required Permission Value|
|Identity||Read & Manage|
|Member Entitlement Management||Read & Write|
|Project and Team||Read, Write & Manage|
|Service Connections||Read, Write & Manage|
|Work Items||Read, Write & Manage|
Additional permissions for specific entities
|Entity Types||Permission Types||Required Permission Value|
|Source control and Git||Code||Full|
|Test Case, Shared Parameters & Shared Step||Test Management||Read & Write|
OpsHub Integration Manager requires this service to communicate with Azure DevOps Server (TFS) / Azure DevOps Services (VSTS). It acts as a translation layer between Azure DevOps Server (TFS) / Azure DevOps Services (VSTS) and OpsHub Integration Manager and must be configured for the Azure DevOps Server (TFS) / Azure DevOps Services (VSTS) system to work.
- Operating System (Tested On): Windows Server 2008 R2, Windows Server 2012, Windows Server 2012 R2, Windows 7, Windows 8, Windows 8.1, Windows 10.
- It is recommended to install Service on a machine having quad-core processor and minimum 4 GB RAM.
- Required disk space for the service depends upon the data size of the source control data. It is recommended to have disk space greater than the total data size of source control.
- It is recommended to install Service on different machine where Azure DevOps Server (TFS) is not installed.
- The OpsHub Integration Manager Service requires the machine to have TFS Object Model 2012 and .NET framework 4.7.2 or higher installed on it. Follow given link to download TFS Object Model 2012.
This pre-requisite is mandatory, regardless of the version of Azure DevOps systems you are trying to integrate. For troubleshooting, refer Service Troubleshooting
Follow the steps given below for installation:
- Navigate to the path < OPSHUB_INSTALLATION_PATH >\Other_Resources\Resources.
- Extract the OpsHubTFSService.zip package.
- Service will be installed on port 9090, so check the availability of the port 9090.
- Open the command prompt as Run As Administrator and navigate to the extracted folder in which the “registerTFSWCFService.bat” is placed and execute “registerTFSWCFService.bat”.
- Once the command is executed, go to Windows Services, and look for a service with the name “OpsHubTFSService”. Check if the service has started or not. If it has not started, then start the service.
- Test the web service by opening this URL in browser: http://:<9090>/TFSService. E.g. http://localhost:9090/TFSService. For Troubleshooting, refer Service Troubleshooting section.
It is also required to configure the proxy settings for OpsHub Integration Manager Service, refer to Proxy settings for the Service in appendix section for the OpsHub Integration Manager service to learn the configuration steps.
In case the machine on which OpsHub Integration Manager installed is behind the proxy (network proxy), then perform the steps mentioned in the Proxy settings.
It is also required to configure the proxy settings for OpsHub Integration Manager Service, refer to Proxy settings in appendix section for the OpsHub Integration Manager Service to learn the configuration steps.
Enable Alternate Authentication Credentials
- Log in with the integration user in AzureDevOps server.
- Click on your username at right top corner, and select Security option.
- Select Alternate Credentials and enable check box for Enable alternate authentication credentials.
- Enter the details for secondary name and password and click on the save button.
Create Personal Access Token
- Log in with the integration user in AzureDevOps server.
- Click on your username of right top corner, and select Security option.
- Select Personal Access Tokens and click on New Token option.
- Provide the name for the token and select All accessible organizations option for the Organization.
- Choose the scope for the Personal Access Token. And click on the create button.
- Copy the token value.
Proxy settings for the TFS Service
After configuring the proxy settings in OpsHub Integration Manager, please follow given steps.
- Click Proxy Setting to see step by step details about how to configure proxy in OpsHub Integration Manager. After configuring the proxy in OpsHub Integration Manager, please follow given steps.
- Open file explorer and navigate to the service installation folder (Ex: \Other_Resources\Resources\OpsHubTFSService) and open file named OpsHubTFSService.exe.config in any text editor. Un-comment the following code from OpsHubTFSService.exe.config file.
- Open run in machine (You can open it by pressing Windows + R button)
- Type services.msc and click ok.
- Find service name OpsHubTFSService and click on Restart.
- Test the proxy by opening service URL http://:/TFSService in browser.