Azure DevOps connector powered by Jitterbit
Use the BMC Helix iPaaS Azure DevOps Connector to easily integrate Azure DevOps with applications, to sync work item and manage pipelines. A specific Azure DevOps connection and its activities together are referred to as an Azure DevOps endpoint.
Use the connector to perform the following actions:
- Configure the connection to create an authenticated Azure DevOps connection by entering credentials.
- Configure associated Azure DevOps activities that interact with the connection to be used either as a source to provide data within an operation, or as a target to consume data within an operation.
- Use the connector activities to perform the following actions:
- Create, update, and query work items and work item comments
- Create, get, and run an Azure DevOps pipeline
- Add and get attachments
- Create a Webhook
Supported API versions
The Azure DevOps connector uses the following Azure DevOps REST API versions:
Important
Support for the Azure DevOps REST API version 6.1 is unavailable.
Refer to the API documentation for information on the schema fields.
The Azure DevOps connector requires the use of an agent version
10.1
or later. These agent versions automatically download the latest version of the connector when required.
Before you begin
You can use the OAuth2 or PAT authentication method for the Azure DevOps connector. If you use OAuth2, make sure you have the following items:
BMC Helix iPaaS, powered by Jitterbit API URL.
Create an API and then use the Service URL to generate tokens and to configure the connector. To learn how to create an API, see Create a custom API.
- Enable access to Azure DevOps via OAuth 2.0 for your organization by using the following URL:
https://dev.azure.com/%7Byour-org-name%7D/_settings/organizationPolicy
To register and authorize your application, and generate tokens
Generate an authorization code and authorize your application so that you do not have to provide user name and password repeatedly in your application.
For steps to register your application and authorize it, and then generate tokens, refer to
Authorize access to REST APIs with OAuth 2.0
in the Microsoft documentation.
Important
- While registering your application, select scopes based on the permissions you want to provide to your application users.
- The user who has access to the Azure DevOps organization and project specified in an integration template should register the application.
After you register and authorize your application, you get the following values that you provide while configuring the connector:
- Client ID
- Client Secret
- Authorization Scope
- Authorization Code
- Access token
- Refresh token
You can view the registered application at
Azure DevOps Organizations
.
To configure an Azure DevOps connection
An Azure DevOps connection is configured using the Azure DevOps connector, establishing access to the Azure DevOps endpoint. Once a connection is established, you can configure one or more Azure DevOps activities associated with that connection to be used either as a source to provide data to an operation or as a target to consume data in an operation.
To create or edit an Azure DevOps connection, complete the following steps:
- From the design canvas, open the Connectivity tab of the design component palette.
- To open the configuration screen, to configure an Azure DevOps connection:
- To configure a new Azure DevOps connection, use the Show dropdown to filter on Connectors, and then click the Azure DevOps connector block:
- To configure an existing Azure DevOps connection, use the Show dropdown to filter on Endpoints, and then double-click the Azure DevOps connector block:
- To configure a new Azure DevOps connection, use the Show dropdown to filter on Connectors, and then click the Azure DevOps connector block:
On the configuration screen for the Azure DevOps connection, enter the following configuration values:
Field with a variable icon global variables
support usingproject variables
, and Jitterbit variables
. Begin either by typing an open square bracket
[
into the field or by clicking the variable icon to display a list of the existing variables to choose from.Field name Action Connection Name
Enter a name to identify the Azure DevOps connection.
The name must be unique for each Azure DevOps connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the Azure DevOps endpoint, which refers to both a specific connection and its activities.
Organization Enter the name of the organization of the Azure DevOps instance. OAuth Authentication Select the checkbox to use OAuth authentication.
After you select the checkbox, the Client ID, Client Secret, Callback URL, Access Token, Refresh Token, and Authorized Scopes fields are enabled.
Personal Access Token Enter the personal access token generated for the Azure DevOps instance organization.
For more information about generating personal access tokens, see Use personal access tokens
.
Client ID
Enter the client ID that you received while registering your application in Visual Studio.
Client Secret
Enter the client secret that you received while registering your application in Visual Studio.
Callback URL
Enter the Service URL that you received after you created the custom API.
Access Token
Enter the token value that you received in the task to generate an authorization code.
Refresh Token
Enter the token value that you received in the task to generate an authorization code.
Authorized Scopes
Enter the authorization scope that you received while registering your application in Visual Studio.
Optional Settings Click to expand additional optional settings:
- URL—Enter the host URL for Azure DevOps.
- API Version—Enter the API version that Azure DevOps uses.
Click Save Changes.
After configuring an Azure DevOps connection, you can configure one or more Azure DevOps activities associated with that connection. For more information about creating an activity, see Creating an Azure DevOps activity.
To create an Azure DevOps activity
- From the design canvas, open the Connectivity tab of the design component palette.
To display activities that are available to be used with an Azure DevOps connection, use the Show dropdown to filter on Endpoints, and then click the Azure DevOps connection block :
The following activities are available. For more information about configuring these activities, see the specific activity sections.Activity name Description Query Work Item Finds work item details at an Azure DevOps endpoint and is intended to be used as a source in an operation. Query Work Item Comments Finds work item comments at an Azure DevOps endpoint and is intended to be used as a source in an operation. Create Comment on Work Item Places work item comment details into an Azure DevOps endpoint and is intended to be used as a target in an operation. Create Webhook Places webhook details into an Azure DevOps endpoint and is intended to be used as a target in an operation. Create Work Item Places work item details into an Azure DevOps endpoint and is intended to be used as a target in an operation. Pipeline Management Places information to create, update, or run a pipeline at an Azure DevOps endpoint and is intended to be used as a target in an operation. Update Work Item Places work item updates into an Azure DevOps endpoint and is intended to be used as a target in an operation. Add attachments Adds attachments to an existing work item in Azure DevOps and is intended to be used as a target in an operation.
Get attachments Retrieves attachments from an existing work item and is intended to be used as a source in an operation.
To create an activity that can be configured, drag the activity block
from the palette to the operation.
For more information about the parts of an operation and adding activities to operations, see
Operation Creation and Configuration
.
To configure an Azure DevOps Query Work Item activity
An Azure DevOps Query Work Item activity places finds item details at an Azure DevOps endpoint and is intended to be used as a source to provide data to an operation. After configuring an Azure DevOps connection, you can configure as many Azure DevOps activities as you like for each Azure DevOps connection.
To configure an Azure DevOps Query Work Item activity, complete the following steps:
After you add the activity to an operation, double-click the activity brick.
On the configuration screen, enter a name to identify the Azure DevOps Query Work Item activity. The name must be unique for each Azure DevOps Query Work Item activity and must not contain forward slashes (
Azure DevOps Query Work Item activity. The name must be unique for each Azure DevOps Query Work Item activity and must not contain forward slashes (/
) or colons (:
)./
) or colons (:
).Click Next.
Review the request and response data schemas.
The data schemas list the fields available for the Azure DevOps Query Work Item activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
For more information about transformations, see Transformations.
Click Finished.
After an Azure DevOps activity has been created, you can access menu actions for that activity from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu.
From the operation settings, you can chain operations from the same or different workflows.
Azure DevOps Query Work Item operation patterns
Azure DevOps Query Work Item activities can be used as a source with these operation patterns:
-
Two-Target Archive Pattern
(as the first source only)
-
Two-Transformation Pattern
(as the first or second source)
For more information on the validation patterns, see the
Operation Validity
page.
A typical use case is to use an Azure DevOps Query Work Item activity in the Two-Transformation Pattern. In this example, the first transformation (Azure DevOps Query Work Item Request) creates a request structure that is passed to the Azure DevOps Query Work Item activity. The second transformation (Azure DevOps Query Work Item Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Azure DevOps Query Work Item Response) and a message is then logged by the Write to Operation Log script:
Tip
To configure an Azure DevOps Query Work Item Comments activity
An Azure DevOps Query Work Item Comments activity finds work item communication details at an Azure DevOps endpoint and is intended to be used as a source to provide data to an operation. After configuring an Azure DevOps connection, you can configure as many Azure DevOps activities as you like for each Azure DevOps connection.
To configure an Azure DevOps Query Work Item Comments activity, complete the following steps:
After you add the activity to an operation, double-click the activity brick.
On the configuration screen, enter a name and specify the activity settings:
Field name Action Name Enter a name to identify the Azure DevOps Query Work Item Comments activity. The name must be unique for each Azure DevOps Query Work Item Comments activity and must not contain forward slashes ( /
) or colons (:
).Select a project This section displays the projects available in the Azure DevOps endpoint. When reopening an existing activity configuration, only the selected project is displayed instead of reloading the entire project list.
Selected Object: Lists the selected project.
Search: Enter a part of the project name to filter the project list for the project. The search is not case-sensitive. If the project is already displayed within the table, the results are filtered in real time with each keystroke. To reload projects from the endpoint for the search, enter the search criteria and then click refresh.
Refresh: Click the refresh icon
or the word Refresh to reload the projects from the Azure DevOps endpoint. This may be useful if you have recently added a project to the Azure DevOps endpoint. This action refreshes all the metadata used to build the project table for the organization displayed in the configuration.Selecting a project: Within the table, click on a row to select project. You can select only one project. The information available for each project for an organization is fetched from the Azure DevOps endpoint:
- Name: The name of the Azure DevOps project.
- Description: Short description or ID of the selected project.
Work Item ID Enter the Work Item ID or select the variable to get the value of the Work Item in which the comment has been created. Optional Settings Click to expand additional optional settings:
- Optional Parameters JSON input (This event definition overrides the prior selections): Enter the Key-Value pair for the alert fields. Use the
{"Key": "Value"}
or[{"Key": "Value"}]
format. The JSON format can be used to include any custom fields for which variables are not available.
Important: Fields with a variable icon support using global variables, project variables
, and Jitterbit variables
. Begin either by typing an open square bracket
[
into the field or by clicking the variable icon to display a list of the existing variables to choose from.
For example:
{
"top"
:
2
,
"continuationToken"
:
"DFkODYtNTYxYS087DiWJ"
,
"order"
:
"asc"
,
"includeDeleted"
:
true
}
Click Next.
Review the request and response data schemas.
The data schemas list the fields available for the Azure DevOps Query Work Item Comments activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
For more information about transformations, see Transformations.
- Click Finished.
After an Azure DevOps activity has been created, you can access menu actions for that activity from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu.
From the operation settings, you can chain operations from the same or different workflows.
Azure DevOps Query Work Item Comments operation patterns
Azure DevOps Query Work Item Comments activities can be used as a source with these operation patterns:
-
Two-Target Archive Pattern
(as the first source only)
-
Two-Transformation Pattern
(as the first or second source)
For more information on the validation patterns, see the
Operation Validity
page.
A typical use case is to use an Azure DevOps Query Work Item Comments activity in the Two-Transformation Pattern. In this example, the first transformation (Azure DevOps Query Work Item Comments Request) creates a request structure that is passed to the Azure DevOps Query Work Item Comments activity. The second transformation (Azure DevOps Query Work Item Comments Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Azure DevOps Query Work Item Comments Response) and a message is then logged by the Write to Operation Log script:
Tip
To configure an Azure DevOps Create Comment on Work Item activity
An Azure DevOps Create Comment on Work Item activity places work item comment details into an Azure DevOps endpoint and is intended to be used as a target to consume data in an operation. After configuring an Azure DevOps connection, you can configure as many Azure DevOps activities as you like for each Azure DevOps connection.
To configure an Azure DevOps Create Comment on Work Item activity complete the following steps:
After you add the activity to an operation, double-click the activity block.
On the configuration screen, enter a name and specify the activity settings:
Field name Action Name Enter a name to identify the Azure DevOps Create Comment on Work Item activity. The name must be unique for each Azure DevOps Create Comment on Work Item activity and must not contain forward slashes ( /
) or colons (:
).Select a project This section displays the projects available in the Azure DevOps endpoint. When reopening an existing activity configuration, only the selected project is displayed instead of reloading the entire project list.
Selected Object: Lists the selected project.
Search: Enter a part of the project name to filter the project list for the project. The search is not case-sensitive. If the project is already displayed within the table, the results are filtered in real time with each keystroke. To reload projects from the endpoint for the search, enter the search criteria and then click refresh.
Refresh: Click the refresh icon
or the word Refresh to reload the projects from the Azure DevOps endpoint. This may be useful if you have recently added a project to the Azure DevOps endpoint. This action refreshes all the metadata used to build the project table for the organization displayed in the configuration.Selecting a project: Within the table, click on a row to select project. You can select only one project. The information available for each project for an organization is fetched from the Azure DevOps endpoint:
- Name: The name of the Azure DevOps project.
- Description: Short description or ID of the selected project.
Important: If the table does not populate with available projects defined for the organization configured, the Azure DevOps connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.
Work Item ID Enter the Work Item ID or select the variable for the Work Item ID to which the comment is to be added. New Comment Enter the comment to be added. Click Next.
Review the request and response data schemas.
The data schemas list the field available for the Azure DevOps Create Comment on Work Item activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
For more information about transformations, see Transformations.
- Click Finished.
After an Azure DevOps activity has been created, you can access menu actions for that activity from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu.
From the operation settings, you can chain operations from the same or different workflows.
Azure DevOps Create Comment operation patterns
Azure DevOps Create Comment on Work Item activities can be used as a target with these operation patterns:
-
Two-Transformation Pattern
(as the first or second source)
For more information on the validation patterns, see the
Operation Validity
page.
A typical use case is to use an Azure DevOps Create Comment on Work Item activity in the Two-Transformation Pattern. In this example, the first transformation (Azure DevOps Create Comment on Work Item Request) creates a request structure that is passed to the Azure DevOps Create Comment on Work Item activity. The second transformation (Azure DevOps Create Comment on Work Item Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Azure DevOps Create Comment on Work Item Response) and a message is then logged by the Write to Operation Log script:
Tip
To configure an Azure DevOps Create Webhook activity
An Azure DevOps Create Webhook activity places Webhook details into an Azure DevOps endpoint and is intended to be used as a target to consume data in an operation. After configuring an Azure DevOps connection, you can configure as many Azure DevOps activities as you like for each Azure DevOps connection.
To configure an Azure DevOps Create Webhook activity, complete the following steps:
After you add the activity to an operation, double-click the activity block.
On the configuration screen, enter a name and specify the activity settings:
Field name Action Name Enter a name to identify the Azure DevOps Create Webhook activity. The name must be unique for each Azure DevOps Create Webhook activity and must not contain forward slashes ( /
) or colons (:
).Select a project This section displays the projects available in the Azure DevOps endpoint. When reopening an existing activity configuration, only the selected project is displayed instead of reloading the entire project list.
Selected Object: Lists the selected project.
Search: Enter a part of the project name to filter the project list for the project. The search is not case-sensitive. If the project is already displayed within the table, the results are filtered in real time with each keystroke. To reload projects from the endpoint for the search, enter the search criteria and then click refresh.
Refresh: Click the refresh icon
or the word Refresh to reload the projects from the Azure DevOps endpoint. This may be useful if you have recently added a project to the Azure DevOps endpoint. This action refreshes all the metadata used to build the project table for the organization displayed in the configuration.Selecting a project: Within the table, click on a row to select project. You can select only one project. The information available for each project for an organization is fetched from the Azure DevOps endpoint:
- Name: The name of the Azure DevOps project.
- Description: Short description or ID of the selected project.
Event Type Select the event for which you are creating the Webhook. You can select one of the following values:
- Work Item Created
- Work Item Updated
- Work Item Deleted
Optional Settings Click to expand additional optional settings.
Enter the Key-Value pair for the alert fields. Use the
{"Key": "Value"}
or[{"Key": "Value"}]
format.Important: Fields with a variable icon global variables
support using, project variables
, and Jitterbit variables
. Begin either by typing an open square bracket
[
into the field or by clicking the variable icon to display a list of the existing variables to choose from.Consumer JSON input: The event trigger that is posted to BMC Helix iPaaS. For example,
{
"url"
:
"https://jitterbit.com/"
,
"basicAuthUsername"
:
"userName"
,
"basicAuthPassword"
:
"password"
,
"resourceDetailsToSend"
:
"minimal"
,
"messagesToSend"
:
"html"
,
"detailedMessagesToSend"
:
"html"
,
"httpHeaders"
:
{"header1"
:
"value"
,
"header2"
:
"value"
}
}
- Publisher JSON input: The filters and Project ID for Azure DevOps. For example,
{
"areaPath"
:
"MCSM"
,
"workItemType"
:
"Bug"
,
"tag"
:
"test"
,
"projectId"
:
"fa43a21b-1d27-4672-9626-be4fb9985278"
}
Click Next.
Review the request and response data schemas.
The data schemas list the field available for the Azure DevOps Create Webhook activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
For more information about transformations, see Transformations.
- Click Finished.
After an Azure DevOps activity has been created, you can access menu actions for that activity from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu.
From the operation settings, you can chain operations from the same or different workflows.
Azure DevOps Create Webhook operation patterns
Azure DevOps Create Webhook activities can be used as a target with these operation patterns:
-
Two-Transformation Pattern
(as the first or second source)
For more information on the validation patterns, see the
Operation Validity
page.
A typical use case is to use an Azure DevOps Create Webhook activity in the Two-Transformation Pattern. In this example, the first transformation (Azure DevOps Create Webhook Request) creates a request structure that is passed to the Azure DevOps Create Webhook activity. The second transformation (Azure DevOps Create Webhook Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Azure DevOps Create Webhook Response) and a message is then logged by the Write to Operation Log script:
Tip
To configure an Azure DevOps Create Work Item activity
An Azure DevOps Create Work Item activity places a new work item into an Azure DevOps endpoint and is intended to be used as a target to consume data in an operation. After configuring an Azure DevOps connection, you can configure as many Azure DevOps activities as you like for each Azure DevOps connection.
To configure an Azure DevOps Create Work Item activity, complete the following steps:
After you add the activity to an operation, double-click the activity block.
On the configuration screen, enter a name and specify the activity settings:
Field name Action Name Enter a name to identify the Azure DevOps Create Work Item activity. The name must be unique for each Azure DevOps Create Work Item activity and must not contain forward slashes ( /
) or colons (:
).Select a project This section displays the projects available in the Azure DevOps endpoint. When reopening an existing activity configuration, only the selected project is displayed instead of reloading the entire project list.
Selected Object: Lists the selected project.
Search: Enter a part of the project name to filter the project list for the project. The search is not case-sensitive. If the project is already displayed within the table, the results are filtered in real time with each keystroke. To reload projects from the endpoint for the search, enter the search criteria and then click refresh.
Refresh: Click the refresh icon
or the word Refresh to reload the projects from the Azure DevOps endpoint. This may be useful if you have recently added a project to the Azure DevOps endpoint. This action refreshes all the metadata used to build the project table for the organization displayed in the configuration.Select a project: Within the table, click on a row to select project. You can select only one project. The information available for each project for an organization is fetched from the Azure DevOps endpoint:
- Name: The name of the Azure DevOps project.
- Description: Short description or ID of the selected project.
Important: If the table does not populate with available projects defined for the organization configured, the Azure DevOps connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.
Work Item Type Enter the type of Work Item which is to be created. For example, Bug, Epic, Feature, Issue, Task, Test Case, User Story. Click Next.
Review the request and response data schemas.
The data schemas list the field available for the Azure DevOps Create Work Item activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
For more information about transformations, see Transformations.
- Click Finished.
After an Azure DevOps activity has been created, you can access menu actions for that activity from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu.
From the operation settings, you can chain operations from the same or different workflows.
Azure DevOps Create Work Item operation patterns
Azure DevOps Create Work Item activities can be used as a target with these operation patterns:
-
Two-Transformation Pattern
(as the first or second source)
For more information on the validation patterns, see the
Operation Validity
page.
A typical use case is to use an Azure DevOps Create Work Item activity in the Two-Transformation Pattern. In this example, the first transformation (Azure DevOps Create Work Item Request) creates a request structure that is passed to the Azure DevOps Create Work Item activity. The second transformation (Azure DevOps Create Work Item Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Azure DevOps Create Work Item Response) and a message is then logged by the Write to Operation Log script:
Tip
To configure an Azure DevOps Pipeline Management activity
An Azure DevOps Pipeline Management activity places pipeline details into an Azure DevOps endpoint and is intended to be used as a target to consume data in an operation. After configuring an Azure DevOps connection, you can configure as many Azure DevOps activities as you like for each Azure DevOps connection. The Azure DevOps Pipeline Management activity enables you to create, get, and run an Azure DevOps pipeline.
To configure an Azure DevOps Pipeline Management activity, complete the following steps:
After you add the activity to an operation, double-click the activity block.
On the configuration screen, enter a name and specify the activity settings:
Field name Action Name Enter a name to identify the Azure DevOps Pipeline Management activity. The name must be unique for each Azure DevOps Pipeline Management activity and must not contain forward slashes ( /
) or colons (:
). You can create an activity to create, get, and run an Azure DevOps pipeline.Select a project This section displays the projects available in the Azure DevOps endpoint. When reopening an existing activity configuration, only the selected project is displayed instead of reloading the entire project list.
Selected Object: Lists the selected project.
Search: Enter a part of the project name to filter the project list for the project. The search is not case-sensitive. If the project is already displayed within the table, the results are filtered in real time with each keystroke. To reload projects from the endpoint for the search, enter the search criteria and then click refresh.
Refresh: Click the refresh icon
or the word Refresh to reload the projects from the Azure DevOps endpoint. This may be useful if you have recently added a project to the Azure DevOps endpoint. This action refreshes all the metadata used to build the project table for the organization displayed in the configuration.Selecting a project: Within the table, click on a row to select project. You can select only one project. The information available for each project for an organization is fetched from the Azure DevOps endpoint:
- Name: The name of the Azure DevOps project.
- Description: Short description or ID of the selected project.
Important: If the table does not populate with available projects defined for the organization configured, the Azure DevOps connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.
Operation Select the operation to be performed for the pipeline. You can perform a create, get, or run operation. Click Next.
Review the request and response data schemas.
The data schemas list the field available for the Azure DevOps Pipeline Management activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
For more information about transformations, see Transformations.
- Click Finished.
After an Azure DevOps activity has been created, you can access menu actions for that activity from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu.
From the operation settings, you can chain operations from the same or different workflows.
Azure DevOps Pipeline Management operation patterns
Azure DevOps Pipeline Management activities can be used as a target with these operation patterns:
-
Two-Transformation Pattern
(as the first or second source)
For more information on the validation patterns, see the
Operation Validity
page.
A typical use case is to use an Azure DevOps Create Work Item activity in the Two-Transformation Pattern. In this example, the first transformation (Azure DevOps Pipeline Management Request) creates a request structure that is passed to the Azure DevOps Pipeline Management activity. The second transformation (Azure DevOps Pipeline Management Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Azure DevOps Pipeline Management Response) and a message is then logged by the Write to Operation Log script:
Tip
To configure an Azure DevOps Update Work Item activity
An Azure DevOps Update Work Item activity places work item details into an Azure DevOps endpoint and is intended to be used as a target to consume data in an operation. After configuring an Azure DevOps connection, you can configure as many Azure DevOps activities as you like for each Azure DevOps connection.
To configure an Azure DevOps Update Work Item activity, complete the following steps:
After you add the activity to an operation, double-click the activity block.
On the configuration screen, enter a name and specify the activity settings:
Field name Action Name Enter a name to identify the Azure DevOps Update Work Item activity. The name must be unique for each Azure DevOps Update Work Item activity and must not contain forward slashes ( /
) or colons (:
).Select a project This section displays the projects available in the Azure DevOps endpoint. When reopening an existing activity configuration, only the selected project is displayed instead of reloading the entire project list.
Selected Object: Lists the selected project.
Search: Enter a part of the project name to filter the project list for the project. The search is not case-sensitive. If the project is already displayed within the table, the results are filtered in real time with each keystroke. To reload projects from the endpoint for the search, enter the search criteria and then click refresh.
Refresh: Click the refresh icon
or the word Refresh to reload the projects from the Azure DevOps endpoint. This may be useful if you have recently added a project to the Azure DevOps endpoint. This action refreshes all the metadata used to build the project table for the organization displayed in the configuration.Selecting a project: Within the table, click on a row to select project. You can select only one project. The information available for each project for an organization is fetched from the Azure DevOps endpoint:
- Name: The name of the Azure DevOps project.
- Description: Short description or ID of the selected project.
Work Item ID Enter the Work Item ID or select the variable of the work item to be updated. Click Next.
Review the request and response data schemas.
The data schemas list the field available for the Azure DevOps Update Work Item activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
For more information about transformations, see Transformations.
- Click Finished.
After an Azure DevOps activity has been created, you can access menu actions for that activity from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu.
From the operation settings, you can chain operations from the same or different workflows.
Azure DevOps Update Work Item operation patterns
Azure DevOps Update Work Item activities can be used as a target with these operation patterns:
-
Two-Transformation Pattern
(as the first or second source)
For more information on the validation patterns, see the
Operation Validity
page.
A typical use case is to use an Azure DevOps Update Work Item activity in the Two-Transformation Pattern. In this example, the first transformation (Azure DevOps Update Work Item Request) creates a request structure that is passed to the Azure DevOps Update Work Item activity. The second transformation (Azure DevOps Update Work Item Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Azure DevOps Update Work Item Response) and a message is then logged by the Write to Operation Log script:
Tip
To configure an Azure DevOps work item add attachments activity
An Azure DevOps Add Attachments activity adds attachments to existing work items. After configuring an Azure DevOps connection, you can configure as many Azure DevOps activities as you like for each Azure DevOps connection.
To configure an Azure DevOps Add Attachments activity, complete the following steps:
After you add the activity to an operation, double-click the activity block.
On the configuration screen, enter a name and specify the activity settings:
Field name
Action
Name
Enter a name to identify the Azure DevOps Add Attachments activity. The name must be unique for each Azure DevOps Add Attachments activity and must not contain forward slashes (/) or colons (:).
Project Options
Use any of the following options:
Select From List—Enter a specific project name and work item ID. To add multiple work item IDs, add comma-separated values; for example, WorkItem1, WorkItem2, WorkItem3.
You must enter values in the Select a project and Work Item ID fields to proceed.Input Manually—Select this option when you want the template to dynamically fetch the project name and work item ID.
When you select this option, you can keep the Project Name and Work Item ID fields empty. If you do not specify any values in the input transformation mapping for these fields, the template uses the default project name and work item ID that are fetched dynamically.
Click Next.
Review the request and response data schemas.
The data schemas list the fields available for the Add Attachments activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
For more information about transformations, see Transformations.
Click Finished.
After an Azure DevOps activity has been created, you can access menu actions for that activity from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu.
From the operation settings, you can chain operations from the same or different workflows.
Azure DevOps Add Attachments operation patterns
Azure DevOps Add Attachments activities can be used as a target with these operation patterns:
-
Two-Transformation Pattern
(as the first or second source)
For more information about the validation patterns, see the
Operation Validity
page.
A typical use case is to use an Azure DevOps Add Attachments activity in the Two-Transformation Pattern. In this example, the first transformation (Azure DevOps Add Attachments Request) creates a request structure that is passed to the Azure DevOps Add Attachments activity. The second transformation (Azure DevOps Add Attachments Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Azure DevOps Add Attachments Response) and a message is then logged by the Write to Operation Log script:
Tip
To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.
Important
In the Add Attachment Payload operation script, add the attachment details like file name, file path, content, and so on. If the size of an attachment exceeds 130 MB, specify uploadType as Chunked in the script.
When ready, deploy and run the operation and validate behavior by checking the
operation logs
.
To configure an Azure DevOps work item get attachments activity
An Azure DevOps Get Attachments activity fetches the available attachments from work items and is intended to be used as a source to consume data in an operation. After configuring an Azure DevOps connection, you can configure as many Azure DevOps activities as you like for each Azure DevOps connection.
To configure an Azure DevOps Get Attachments activity, complete the following steps:
After you add the activity to an operation, double-click the activity block.
On the configuration screen, enter a name and specify the activity settings:
Field name
Action
Name
Enter a name to identify the Azure DevOps Get Attachments activity. The name must be unique for each Azure DevOps Get Attachments activity and must not contain forward slashes (/) or colons (:).
Project Options
Use any of the following options:
Select From List—Enter a specific project name and work item ID.
You must enter values in the Select a project and Work Item ID fields to proceed. To add multiple work item IDs, add comma-separated values; for example, WorkItem1, WorkItem2, WorkItem3.Input Manually—Select this option when you want the template to dynamically fetch the project name and work item ID.
When you select this option, you can keep the Project Name and Work Item ID fields empty. If you do not specify any values in the input transformation mapping for these fields, the template uses the default project name and work item ID that are fetched dynamically.
Click Next.
Review the request and response data schemas.
The data schemas list the fields available for the Get Attachments activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
For more information about transformations, see Transformations.
Click Finished.
After an Azure DevOps activity has been created, you can access menu actions for that activity from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu.
From the operation settings, you can chain operations from the same or different workflows.
Azure DevOps Get Attachments operation patterns
Azure DevOps Get Attachments activities can be used as a target with these operation patterns:
-
Two-Transformation Pattern
(as the first or second source)
For more information about the validation patterns, see the
Operation Validity
page.
A typical use case is to use an Azure DevOps Get Attachments activity in the Two-Transformation Pattern. In this example, the first transformation (Azure DevOps Get Attachments Request) creates a request structure that is passed to the Azure DevOps Get Attachments activity. The second transformation (Azure DevOps Get Attachments Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Azure DevOps Get Attachments Response) and a message is then logged by the Write to Operation Log script:
Tip
To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.
When ready, deploy and run the operation and validate behavior by checking the
operation logs
.
To configure an Azure DevOps Create Work Item activity
An Azure DevOps Create Work Item activity places a new work item into an Azure DevOps endpoint and is intended to be used as a target to consume data in an operation. After configuring an Azure DevOps connection, you can configure as many Azure DevOps activities as you like for each Azure DevOps connection.
To configure an Azure DevOps Create Work Item activity, complete the following steps:
After you add the activity to an operation, double-click the activity block.
On the configuration screen, enter a name and specify the activity settings:
Field name Action Name Enter a name to identify the Azure DevOps Create Work Item activity. The name must be unique for each Azure DevOps Create Work Item activity and must not contain forward slashes ( /
) or colons (:
).Select a project This section displays the projects available in the Azure DevOps endpoint. When reopening an existing activity configuration, only the selected project is displayed instead of reloading the entire project list.
Selected Object: Lists the selected project.
Search: Enter a part of the project name to filter the project list for the project. The search is not case-sensitive. If the project is already displayed within the table, the results are filtered in real time with each keystroke. To reload projects from the endpoint for the search, enter the search criteria and then click refresh.
Refresh: Click the refresh icon
or the word Refresh to reload the projects from the Azure DevOps endpoint. This may be useful if you have recently added a project to the Azure DevOps endpoint. This action refreshes all the metadata used to build the project table for the organization displayed in the configuration.Select a project: Within the table, click on a row to select project. You can select only one project. The information available for each project for an organization is fetched from the Azure DevOps endpoint:
- Name: The name of the Azure DevOps project.
- Description: Short description or ID of the selected project.
Important: If the table does not populate with available projects defined for the organization configured, the Azure DevOps connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.
Work Item Type Enter the type of Work Item which is to be created. For example, Bug, Epic, Feature, Issue, Task, Test Case, User Story. Click Next.
Review the request and response data schemas.
The data schemas list the field available for the Azure DevOps Create Work Item activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
For more information about transformations, see Transformations.
- Click Finished.
After an Azure DevOps activity has been created, you can access menu actions for that activity from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu.
From the operation settings, you can chain operations from the same or different workflows.
Azure DevOps Create Work Item operation patterns
Azure DevOps Create Work Item activities can be used as a target with these operation patterns:
-
Two-Transformation Pattern
(as the first or second source)
For more information on the validation patterns, see the
Operation Validity
page.
A typical use case is to use an Azure DevOps Create Work Item activity in the Two-Transformation Pattern. In this example, the first transformation (Azure DevOps Create Work Item Request) creates a request structure that is passed to the Azure DevOps Create Work Item activity. The second transformation (Azure DevOps Create Work Item Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Azure DevOps Create Work Item Response) and a message is then logged by the Write to Operation Log script:
Tip
To configure an Azure DevOps Pipeline Management activity
An Azure DevOps Pipeline Management activity places pipeline details into an Azure DevOps endpoint and is intended to be used as a target to consume data in an operation. After configuring an Azure DevOps connection, you can configure as many Azure DevOps activities as you like for each Azure DevOps connection. The Azure DevOps Pipeline Management activity enables you to create, get, and run an Azure DevOps pipeline.
To configure an Azure DevOps Pipeline Management activity, complete the following steps:
After you add the activity to an operation, double-click the activity block.
On the configuration screen, enter a name and specify the activity settings:
Field name Action Name Enter a name to identify the Azure DevOps Pipeline Management activity. The name must be unique for each Azure DevOps Pipeline Management activity and must not contain forward slashes ( /
) or colons (:
). You can create an activity to create, get, and run an Azure DevOps pipeline.Select a project This section displays the projects available in the Azure DevOps endpoint. When reopening an existing activity configuration, only the selected project is displayed instead of reloading the entire project list.
Selected Object: Lists the selected project.
Search: Enter a part of the project name to filter the project list for the project. The search is not case-sensitive. If the project is already displayed within the table, the results are filtered in real time with each keystroke. To reload projects from the endpoint for the search, enter the search criteria and then click refresh.
Refresh: Click the refresh icon
or the word Refresh to reload the projects from the Azure DevOps endpoint. This may be useful if you have recently added a project to the Azure DevOps endpoint. This action refreshes all the metadata used to build the project table for the organization displayed in the configuration.Selecting a project: Within the table, click on a row to select project. You can select only one project. The information available for each project for an organization is fetched from the Azure DevOps endpoint:
- Name: The name of the Azure DevOps project.
- Description: Short description or ID of the selected project.
Important: If the table does not populate with available projects defined for the organization configured, the Azure DevOps connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.
Operation Select the operation to be performed for the pipeline. You can perform a create, get, or run operation. Click Next.
Review the request and response data schemas.
The data schemas list the field available for the Azure DevOps Pipeline Management activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
For more information about transformations, see Transformations.
- Click Finished.
After an Azure DevOps activity has been created, you can access menu actions for that activity from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu.
From the operation settings, you can chain operations from the same or different workflows.
Azure DevOps Pipeline Management operation patterns
Azure DevOps Pipeline Management activities can be used as a target with these operation patterns:
-
Two-Transformation Pattern
(as the first or second source)
For more information on the validation patterns, see the
Operation Validity
page.
A typical use case is to use an Azure DevOps Create Work Item activity in the Two-Transformation Pattern. In this example, the first transformation (Azure DevOps Pipeline Management Request) creates a request structure that is passed to the Azure DevOps Pipeline Management activity. The second transformation (Azure DevOps Pipeline Management Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Azure DevOps Pipeline Management Response) and a message is then logged by the Write to Operation Log script:
Tip
To configure an Azure DevOps Update Work Item activity
An Azure DevOps Update Work Item activity places work item details into an Azure DevOps endpoint and is intended to be used as a target to consume data in an operation. After configuring an Azure DevOps connection, you can configure as many Azure DevOps activities as you like for each Azure DevOps connection.
To configure an Azure DevOps Update Work Item activity, complete the following steps:
After you add the activity to an operation, double-click the activity block.
On the configuration screen, enter a name and specify the activity settings:
Field name Action Name Enter a name to identify the Azure DevOps Update Work Item activity. The name must be unique for each Azure DevOps Update Work Item activity and must not contain forward slashes ( /
) or colons (:
).Select a project This section displays the projects available in the Azure DevOps endpoint. When reopening an existing activity configuration, only the selected project is displayed instead of reloading the entire project list.
Selected Object: Lists the selected project.
Search: Enter a part of the project name to filter the project list for the project. The search is not case-sensitive. If the project is already displayed within the table, the results are filtered in real time with each keystroke. To reload projects from the endpoint for the search, enter the search criteria and then click refresh.
Refresh: Click the refresh icon
or the word Refresh to reload the projects from the Azure DevOps endpoint. This may be useful if you have recently added a project to the Azure DevOps endpoint. This action refreshes all the metadata used to build the project table for the organization displayed in the configuration.Selecting a project: Within the table, click on a row to select project. You can select only one project. The information available for each project for an organization is fetched from the Azure DevOps endpoint:
- Name: The name of the Azure DevOps project.
- Description: Short description or ID of the selected project.
Work Item ID Enter the Work Item ID or select the variable of the work item to be updated. Click Next.
Review the request and response data schemas.
The data schemas list the field available for the Azure DevOps Update Work Item activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
For more information about transformations, see Transformations.
- Click Finished.
After an Azure DevOps activity has been created, you can access menu actions for that activity from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu.
From the operation settings, you can chain operations from the same or different workflows.
Azure DevOps Update Work Item operation patterns
Azure DevOps Update Work Item activities can be used as a target with these operation patterns:
-
Two-Transformation Pattern
(as the first or second source)
For more information on the validation patterns, see the
Operation Validity
page.
A typical use case is to use an Azure DevOps Update Work Item activity in the Two-Transformation Pattern. In this example, the first transformation (Azure DevOps Update Work Item Request) creates a request structure that is passed to the Azure DevOps Update Work Item activity. The second transformation (Azure DevOps Update Work Item Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Azure DevOps Update Work Item Response) and a message is then logged by the Write to Operation Log script:
Tip
To configure an Azure DevOps work item add attachments activity
An Azure DevOps Add Attachments activity adds attachments to existing work items. After configuring an Azure DevOps connection, you can configure as many Azure DevOps activities as you like for each Azure DevOps connection.
To configure an Azure DevOps Add Attachments activity, complete the following steps:
After you add the activity to an operation, double-click the activity block.
On the configuration screen, enter a name and specify the activity settings:
Field name
Action
Name
Enter a name to identify the Azure DevOps Add Attachments activity. The name must be unique for each Azure DevOps Add Attachments activity and must not contain forward slashes (/) or colons (:).
Project Options
Use any of the following options:
Select From List—Enter a specific project name and work item ID. To add multiple work item IDs, add comma-separated values; for example, WorkItem1, WorkItem2, WorkItem3.
You must enter values in the Select a project and Work Item ID fields to proceed.Input Manually—Select this option when you want the template to dynamically fetch the project name and work item ID.
When you select this option, you can keep the Project Name and Work Item ID fields empty. If you do not specify any values in the input transformation mapping for these fields, the template uses the default project name and work item ID that are fetched dynamically.
Click Next.
Review the request and response data schemas.
The data schemas list the fields available for the Add Attachments activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
For more information about transformations, see Transformations.
Click Finished.
After an Azure DevOps activity has been created, you can access menu actions for that activity from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu.
From the operation settings, you can chain operations from the same or different workflows.
Azure DevOps Add Attachments operation patterns
Azure DevOps Add Attachments activities can be used as a target with these operation patterns:
-
Two-Transformation Pattern
(as the first or second source)
For more information about the validation patterns, see the
Operation Validity
page.
A typical use case is to use an Azure DevOps Add Attachments activity in the Two-Transformation Pattern. In this example, the first transformation (Azure DevOps Add Attachments Request) creates a request structure that is passed to the Azure DevOps Add Attachments activity. The second transformation (Azure DevOps Add Attachments Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Azure DevOps Add Attachments Response) and a message is then logged by the Write to Operation Log script:
Tip
To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.
Important
In the Add Attachment Payload operation script, add the attachment details like file name, file path, content, and so on. If the size of an attachment exceeds 130 MB, specify uploadType as Chunked in the script.
When ready, deploy and run the operation and validate behavior by checking the
operation logs
.
To configure an Azure DevOps work item get attachments activity
An Azure DevOps Get Attachments activity fetches the available attachments from work items and is intended to be used as a source to consume data in an operation. After configuring an Azure DevOps connection, you can configure as many Azure DevOps activities as you like for each Azure DevOps connection.
To configure an Azure DevOps Get Attachments activity, complete the following steps:
After you add the activity to an operation, double-click the activity block.
On the configuration screen, enter a name and specify the activity settings:
Field name
Action
Name
Enter a name to identify the Azure DevOps Get Attachments activity. The name must be unique for each Azure DevOps Get Attachments activity and must not contain forward slashes (/) or colons (:).
Project Options
Use any of the following options:
Select From List—Enter a specific project name and work item ID.
You must enter values in the Select a project and Work Item ID fields to proceed. To add multiple work item IDs, add comma-separated values; for example, WorkItem1, WorkItem2, WorkItem3.Input Manually—Select this option when you want the template to dynamically fetch the project name and work item ID.
When you select this option, you can keep the Project Name and Work Item ID fields empty. If you do not specify any values in the input transformation mapping for these fields, the template uses the default project name and work item ID that are fetched dynamically.
Click Next.
Review the request and response data schemas.
The data schemas list the fields available for the Get Attachments activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
For more information about transformations, see Transformations.
Click Finished.
After an Azure DevOps activity has been created, you can access menu actions for that activity from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu.
From the operation settings, you can chain operations from the same or different workflows.
Azure DevOps Get Attachments operation patterns
Azure DevOps Get Attachments activities can be used as a target with these operation patterns:
-
Two-Transformation Pattern
(as the first or second source)
For more information about the validation patterns, see the
Operation Validity
page.
A typical use case is to use an Azure DevOps Get Attachments activity in the Two-Transformation Pattern. In this example, the first transformation (Azure DevOps Get Attachments Request) creates a request structure that is passed to the Azure DevOps Get Attachments activity. The second transformation (Azure DevOps Get Attachments Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Azure DevOps Get Attachments Response) and a message is then logged by the Write to Operation Log script:
Tip
To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.
When ready, deploy and run the operation and validate behavior by checking the
operation logs
.
Comments
Log in or register to comment.