Filters - Cloud Native

Filters overview

Synchronization filters further define the scope of issues or work items to be synchronized. Define which project in Jira and Azure DevOps to connect, then select all fields and field types from each project and map data values as needed. 

Filters is an optional feature that is not required to complete a synchronization profile.

Before Filters can be configured, General Settings, Item types, Fields, and Workflows must be complete. If these sections are not configured, Filters displays a message with links to the unfinished sections. Complete the required steps and return to Filters.

Filter Jira items uses Jira Query Language (JQL) to limit the scope of the sync. Refer to Advanced search with Jira Query Language for more information.

Filter Azure items uses Work Item Query Language (WIQL)to limit the scope of the sync. Refer to Azure DevOps (WIQL) syntax reference for more information.

Example Jira to Azure DevOps

This example describes how you can use filters to include specific items. In this case, items that contain a specific label are part of the sync.

In this example, we want to synchronize the items in Jira to Azure DevOps that contain the label document. Once complete, items containing the label are added to the sync, while items that don’t are excluded. 

  1. Click the Settings cog and select Apps. When the Apps page opens, select Cloud Native synchronizer from the Apps menu on the left.

  2. Click Configure.

  3. From the TFS4JIRA Synchronizer page, click Sync Profiles in the left side menu.

  4. When the Sync profiles page opens, select the profile where you want to define filters.

  5. Select Filters in the left side menu.

  6. On the Filters page, select Filter Jira items and define the filter.
    The filter shown below only includes items in the synchronization that have document in the label. Issues without document in the label are not sychronized.

  7. Click Test query. This tests the entire JQL and returns the execution results. Testing the filter query is run as a standard query without any impact on current or future synchronizations.

  8. Click Save settings.

Filters are additional parameters added to JQL. The project and item types are defined during configuration. The example above shows the query AND project = 'My Kanban Project' AND issuetype IN ('Task','Bug').

Example Azure DevOps to Jira

This example shows how to synchronize all items that contain the approved tag to Jira. 

  1. In Jira Apps, select TFS4JIRA -  Cloud Native Synchronizer.

  2. Click Configure.

  3. From the TFS4JIRA Synchronizer page, click Sync Profiles in the left side menu.

  4. When the Sync profiles page opens, select the profile where you want to define filters.

  5. Select Filters in the left side menu.

  6. On the Filters page, select Filter Azure items and define the filter.

  7. This example filters using [System.Tags] contains ‘approved', with any task or issue that contains the approved tag to be included in the sync.

  8. Click Test query. This tests the entire Wiql and returns execution results. Testing the filter query is run as a standard query without any impact on current or future synchronizations. 

  9. Click Save settings.