Microsoft TFS/VSTS AddOn Configuration

TFS Addon communicates with TFS - Team 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 TFS/VSTS system, e.g. MYTFS. 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

Enable TFS AddOn for Models

Each model that needs to access TFS/VSTS for requirement or defects must also be configured:

Requirements Setting

  • PROJECT=project name, required, it tells the ALM plugin which project in TFS/VSTS to search for the requirements.
  • TEAM=team name, optional, to instruct addon to pull requirement items for the specified team if REQ_WIQL has not been specified.
  • QUERY_ID=query-id, from tfs/vsts that retrieves a list of requirements to be tested by the model

Defect Setting

  • PROJECT=project name, required, it tells the ALM plugin which project in TFS/VSTS to search for the defects.
  • TEAM=team name, optional.
  • QUERY_ID=query-id, from TFS/VSTS that retrieves a list of defect raised by this model
  • ITERATION=iteration name - optional. if specified, it will set bug item's IterationPath accordingly

AddOn Settings

AddOn Settings are defined in file www/config/config.properties:

  • 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
  • ADDON.MYTFS.REQ_WIQL=optional, WIQL to retrieve requirement items, default to pull items of type of REQ_ITEMTYPES with states of REQ_ITEMSTATES
  • ADDON.MYTFS.BUG_WIQL=optional, WIQL to retrieve bug items, default to pull items of type of BUG_ITEMTYPES with states of BUG_ITEMSTATES
  • ADDON.MYTFS.REQ_ITEMTYPES=optional, comma separated item types for requirement, default to Task,Requirement
  • ADDON.MYTFS.BUG_ITEMTYPES=optional, comma separated item types for defect, default to Bug
  • ADDON.MYTFS.REQ_ITEMSTATES=optional, comma separated item states for requirement, default to Active,In Progress
  • ADDON.MYTFS.BUG_ITEMSTATES=optional, comma separated item states for defect, default to Active,New,In Progress
  • ADDON.MYTFS.BUG_NEWSTATE=optional, states for new bug, default to the default state in your VSTS for new Bug items

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

Requirement/Defect Queries

TestOptimal uses WIQL to pull the requirements and defects from TFS/VSTS. There are four ways to specify the queries to be used to pull the requirements/defects from TFS/VSTS:

  • Default WIQL - pull requirements and defect in Active,In Progress.
  • Custom item types and item state - similar to Default WIQL option except that you set the item types and item states
  • Custom WIQL - you specify WIQL queries to pull requirements and defects by setting REQ_WIQL and BUG_WIQL
  • Stored Query - have TestOptimal execute your stored queries in TFS/VSTS by setting REQ_QUERY_ID and BUG_QUERY_ID in the model's ALM Config.

The last option is specific to each model (set in IDE ALM_Config) while the rest are set for all models (set in config.properties file).

There are three types of Store Queries, TestOptimal supports all of the three query types, but Flat Query works the best giving the best performance.

Print/export
QR Code
QR Code tfs_addon (generated for current page)