This is an old revision of the document!

Microsoft TFS/VSTS AddOn Configuration

TFS Addon communicates with TFS - The Foundation Server and VSTS - Visual Studio Team Services using REST API. Configuration settings are defined in config.properties file located in /www/config/ folder.

You may use any text editor to add/update settings.

Minimum Configuration

First pick a unique name for your JIRA system, e.g. MYJIRA. The name must be in uppercase.

Copy and paste following settings into config.properties and adjust the values to yours: 

ADDON.MYTFS.CLASS=com.webmbt.alm.addon.AddOnTFS
ADDON.MYTFS.URL=https://myvsts.visualstudio.com
ADDON.MYTFS.AUTH.TYPE=Basic
ADDON.MYTFS.AUTH.USERNAME=userid
ADDON.MYTFS.AUTH.PASSWORD=password/access token
ADDON.MYTFS.BUG.ENABLED=true
ADDON.MYTFS.REQ.ENABLED=true

AddOn Settings

  • ADDON.MYTFS.CLASS=com.webmbt.alm.addon.AddOnTFS
  • ADDON.MYTFS.URL=host and port pointing to your tfs/vsts server
  • ADDON.MYTFS.AUTH.TYPE=Basic
  • ADDON.MYTFS.AUTH.USERNAME=userid
  • ADDON.MYTFS.AUTH.PASSWORD=either password or access token generated from TFS/VSTS.
  • ADDON.MYTFS.BUG.ENABLED=true/false, if to enable defect interface, default false
  • ADDON.MYTFS.REQ.ENABLED=true/false, if to enable requirement iterface, default false

Additional AUTH_.* fields supported for OAuth and OAuth2: * ADDON.MYJIRA.AUTH.OAUTH.CONSUMER.KEY * ADDON.MYJIRA.AUTH.OAUTH.CONSUMER.SECRET * ADDON.MYJIRA.AUTH.OAUTH.ACCESS.TOKEN * ADDON.MYJIRA.AUTH.OAUTH.SECRET.TOKEN * ADDON.MYJIRA.AUTH.OAUTH2.SECURITY.TOKEN * ADDON.MYJIRA.AUTH.OAUTH2.SIGNATURE

Enable TFS AddOn for Models

Each model that needs to access JIRA for requirement or defects must also be configured:

ALM Config Settings:

  • PROJECT=project key, it tells the ALM plugin which project in TFS/VSTS to search for the requirements and defects.
  • REQ_QUERY_ID= id of TFS/VSTS query that retrieves the list of requirements of interest
  • BUG_QUERY_ID= id of TFS/VSTS query that retrieves the list of defects of interest.
  • BUT_ITERATION=optional. if specified, it will set bug item's IterationPath accordingly. example “Iteration 0”.