Skip to content

Configuration settings

Jump to bottom
Davide Benvegnù edited this page Nov 26, 2019 · 14 revisions

Configuration Settings

To configure the settings needed by the BugGuardian library, you have to assign them in the code

To do it, just can call the static Configuration Factory and assign all the values:

DBTek.BugGuardian.Factories.ConfigurationFactory.SetConfiguration("http://MY_TFS_SERVER:8080/Tfs", "MY_USERNAME", "MY_PASSWORD", "MY_PROJECT");

There is also a second overload where you can specify a team project collection name (default: DefaultCollection):

DBTek.BugGuardian.Factories.ConfigurationFactory.SetConfiguration("http://MY_TFS_SERVER:8080/Tfs", "MY_USERNAME", "MY_PASSWORD", "MY_COLLECTION", "MY_PROJECT");

It's better to place it in the very beginning of your application execution or, if you plan to call the library in a manual manner, just before to call it.

Parameters

These are the parameters format and meaning.

Url: url for the Azure DevOps service (https://dev.azure.com) or for your on-premises Azure DevOps Server or Team Foundation Server host (http(s)://yourhostname:port/tfs, default port is 8080)

Username:

  • for Azure DevOps, create a Personal Access token and use its value here
  • for Azure DevOps Server and TFS just use a "normal" username.

In either case, the user/PAT must have the permission to create work items on the project you want to interact with

Password:

  • for Azure DevOps, the value of the Personal Access Token
  • for Azure DevOps Server and TFS, the password for the user you want to use

CollectionName:

  • for Azure DevOps: the name of the organization (i.e. the XXX part of https://dev.azure.com/XXX)
  • for Azure DevOps Server and TFS: the name of the Team Project Collection which contains the Team Project you want to have the bugs created in. Default value is "DefaultCollection"

ProjectName: the name of the Team Project in which you want to create the bugs/tasks

AvoidMultipleReport: optional. When set to true, if the same exception is thrown multiple times it will be reported only once to AzDO/TFS and a counter will be increased (in the Bug title and in its history). When set to false, if the same exception is thrown more than once it will be reported every time as a new bug. Default value is true.

AssignToCurrentIteration: optional. When set to true, the task/bug created will be automatically assigned at the current iteration/sprint.

Clone this wiki locally