Microsoft Azure DevOps (Team Foundation Server)

Technical requirements

The following requirements must be met to integrate Microsoft Azure DevOps with SD Elements.

  • Team Foundation Server version 2018 and later.

  • NTLM or Basic Authentication must be enabled

  • The user configured for the connection should:

    • Be a member of the project

    • Have permission to create, tag, transition and close work items.

    • Specific permissions:

      • Edit project-level information - Allow

      • Create tag definition - Allow

Default assigned fields

The following fields are set by default:

  • Title

  • Description

  • Priority

Behavior

The integration supports the following:

Connection details

Enter the connection details for the server.

Protocol

Select the protocol for the connection (HTTPS or HTTP) (Default: HTTPS)

Server

The domain name or IP address of the server

Context Root

Top-level location where Microsoft Azure DevOps is installed on a server. The value for this may be dependent on the configuration of an internal corporate proxy or where an administrator has installed Microsoft Azure DevOps.

Collection name

The name of a project collection in Microsoft Azure DevOps (Default: DefaultCollection)

Credentials

Enter the credentials needed to authenticate to the server.

Username

Username authorized to connect with the server and create/edit issues in anticipated projects.

Password/Personal Access Token (PAT)

The password or the Personal Access Token used to authenticate to the server.

Tasks to Synchronize

Select tasks to synchronize.

Sync all tasks

Synchronize all tasks from SD Elements.

Sync Risk Policy tasks

Synchronize only tasks that fall under the risk policy.

Project details

Enter the project-level details.

Azure DevOps (TFS) Project

The name of the project where issues should be created.

Advanced Microsoft Azure DevOps configuration

Enter advanced configuration options.

Issue Type

Type of issue that SD Elements will create when creating a task in Azure DevOps. (Default: User Story)

Map an Azure DevOps (TFS) status to an SD Elements status

This mapping determines the status to assign an SD Elements task based on its corresponding Azure DevOps issue status.

See Status Mapping for more information.

Map an SD Elements status to an Azure DevOps (TFS) status

This mapping determines the status to assign an Azure DevOps issue based on its corresponding SD Elements task status. All Azure DevOps statuses in this mapping should be a single transition away from every other status in the mapping, as well as from the default status for new issues in your Azure DevOps project workflow. For example, an item in an "In Progress" state cannot be transitioned to an item in a "Completed" state. It must transition to a "Resolved" state first, then "Completed".

 'Incomplete', 'Complete', and 'Not Applicable' SD Elements statuses must have a mapping. Any unmapped custom SD Elements statuses will use these mappings based on their meaning.

See Status Mapping for more information.

Unmapped Status Fallback (Optional)

The SDE status to map to when encountering an unmapped Azure DevOps status (Default: Incomplete)

Closed Issue Status

The name of a status in Azure DevOps to use when its corresponding SDE task is removed from the project.

Iteration Path

Name of the iteration (Example: Iteration\ABC)

 If you create a new release and select the “Carry over ALM connections” option, you must manually edit the iteration path to ensure synchronization does not overwrite tasks in your previous Microsoft Azure DevOps iteration.*

Area Path

Name of the Area Path (Default: Project name)

Synchronization

Enter settings for synchronizing SD Elements tasks.

Authoritative Source

Select the tool that will be the authoritative system of record: Microsoft Azure DevOps or SD Elements. This field is used in case of conflicting statuses between the Microsoft Azure DevOps issue and the SD Elements task. When you first synchronize a TODO task in SD Elements with an issue in Microsoft Azure DevOps, they will have the same status. If you then change the status in one tool, for example by closing the issue in Microsoft Azure DevOps, they will have conflicting statuses. This conflict is resolved when the projects are synchronized. There are two options:

  • ALM (default): The SD Elements task will be updated to match the status in Microsoft Azure DevOps. This is relevant to most workflows.

  • SD Elements: The Microsoft Azure DevOps status will be updated to match the SD Elements status.

Include code sample How-To’s in task descriptions

Whether or not to include detailed code samples and How-To’s in the Microsoft Azure DevOps issue.

This ALM server is hosted within a private network and cannot be reached directly by SD Elements.

Select this option if SD Elements does not have direct network access to the Microsoft Azure DevOps server.

For example, if you are using a hosted SD Elements instance but you want to integrate with an internal/protected Microsoft Azure DevOps system, choose this option and run the Remote Integration Agent to perform integration.

Filter tasks

Select SD Elements tasks to synchronize with the Microsoft Azure DevOps project.

Tasks having a minimum priority

Only synchronize tasks with a minimum priority, such as 7 or above. This is useful if you want to limit the amount of work for users. (Default: 1)

Tasks with status meaning

Only synchronize tasks with certain statuses, such as TODO or DONE. (Default: TODO)

Limit to tasks having these phases

Only synchronize tasks in certain phases, such as Requirements or Development. (Default: none selected, meaning tasks from all phases will be synchronized)

Tasks having all of the following tags

Only synchronize tasks containing certain SD Elements task tags. (Optional)

Tasks with verification status

Only synchronize tasks with a specific verification status, such as Pass or Fail. (Default: none selected, meaning tasks with any verification status will be synchronized)

Advanced ALM options

Enter advanced configuration options.

ALM context

Bind a set of tasks using a cetain value. This is applicable only when custom titles are selected having the entry "Context"

ALM parent issue

The issue identifier of a parent issue. SD Elements tasks will be created as children of this issue.

Custom Priority Mapping

If the standard Microsoft Azure DevOps priorities have been customized, you must map the customized priority names in Microsoft Azure DevOps to their corresponding SD Elements numeric priorities.

 This is a common option that will need to be set.

For example, map "1" issues to priority 10 in SD Elements, "2" to priorities 7-9, and so on.

Custom Fields Mapping

In addition to the default-assigned fields, you can map additional SD Elements fields to Microsoft Azure DevOps fields.

 Fields that are not required or have default values do not need to be set.

For example, you may have a required field in your Microsoft Azure DevOps project that is not set by default. Custom field mappings can be set at both the system connection and project connection levels, and the mappings set in a project connection will override mappings set in the system connection.

For more details refer to section Advanced field support.

Sync frequency

Select how frequently the SD Elements and Microsoft Azure DevOps projects are synchronized. You can choose from the following options. The more frequently you run synchronization, the greater the performance impact on both the SD Elements and Microsoft Azure DevOps servers. This is generally only a concern for large organizations running many synchronizations at once.

Hourly, Daily, Weekly, or Monthly

The projects will synchronize automatically every hour, day, week or month. Daily synchronization is typically sufficient. However, you may want to select a more frequent interval if development moves quickly in your organization.

Manually

You must click the Sync button on the ALM Integrations page in order to synchronize the projects. This is the default value.

results matching ""

    No results matching ""