Skip to content

Commit

Permalink
Merge pull request #1686 from MicrosoftDocs/Danielabom-patch-2-1
Browse files Browse the repository at this point in the history
Update servicenow-knowledge-connector.md
  • Loading branch information
Ruchika-mittal01 authored Jan 16, 2025
2 parents fc62d46 + ee21ba9 commit 04c4831
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 70 deletions.
71 changes: 36 additions & 35 deletions MicrosoftSearch/jira-connector.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Atlassian Jira cloud Graph connector for Microsoft Search and Copilot"
title: "Atlassian Jira Cloud Microsoft Graph connector"
ms.author: vivg
author: vivg
manager: harshkum
Expand All @@ -20,15 +20,15 @@ ms.date: 07/22/2021

The Atlassian Jira Cloud Microsoft Graph connector allows your organization to index Jira issues. After you configure the connector and index content from the Jira site, end users can search for those items in Microsoft Search and Microsoft 365 Copilot.

This article is for Microsoft 365 administrators or anyone who configures, runs, and monitors a Jira cloud Graph connector.
This article is for Microsoft 365 administrators or anyone who configures, runs, and monitors an Atlassian Jira Cloud Microsoft Graph connector.

>[!IMPORTANT]
>The Atlassian Jira Cloud Microsoft Graph connector supports only Jira cloud-hosted instances. Jira Server and Jira Data Center versions are not supported by this connector.
## Capabilities
- Index issues (or tickets) from Jira cloud
- Enable your end users to ask questions related to project tracking, support queries, or task execution in Copilot.
- Find the issue with mobile app not loading.
- Find the issue with the mobile app not loading.
- Look for Jira tasks reported by John to update documentation about API migration.
- Summarize CP-1234.
- Use [Semantic search in Copilot](semantic-index-for-copilot.md) to enable users to find relevant content based on keywords, personal preferences, and social connections.
Expand All @@ -39,8 +39,8 @@ This article is for Microsoft 365 administrators or anyone who configures, runs,

## Prerequisites
- You must be the **search admin** for your organization's Microsoft 365 tenant.
- **Jira cloud instance URL**: To connect to your Jira data, you need your organization's Jira instance URL. Your organization's Jira instance URL typically looks like `https://<your-organization-domain>.atlassian.net`. If you don't have an instance already, refer the [page](https://www.atlassian.com/software/jira) to create a test instance.
- **Service Account**: To connect to Jira and allow the Microsoft Graph Connector to update issues regularly, you need a service account with the following permissions granted to it.
- **Jira cloud instance URL**: To connect to your Jira data, you need your organization's Jira instance URL. Your organization's Jira instance URL typically looks like `https://<your-organization-domain>.atlassian.net`. If you don't have an instance already, refer to the [page](https://www.atlassian.com/software/jira) to create a test instance.
- **Service Account**: To connect to Jira and allow the Atlassian Jira Cloud Microsoft Graph connector to update issues regularly, you need a service account with the following permissions granted to it.

| Permission name | Permission type | Required for |
| ------------ | ------------ | ------------ |
Expand All @@ -49,21 +49,22 @@ This article is for Microsoft 365 administrators or anyone who configures, runs,
| Browse users and groups | [Global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/) | Security trimming based on access permissions of search results. This permission is **optional** and is required to select `Only people with access to this data source` option in step 4 below. |
| Administer Jira | [Global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/) | Security trimming based on access permissions of search results. This permission is **optional** and is required to select `Only people with access to this data source` option in step 4 below. |

## Get Started
## Get started
This video provides a step-by-step guide on adding the Atlassian Jira Cloud Microsoft Graph connector.

[![Screenshot that shows connection creation screen for Microsoft Graph Connector for Jira cloud.](media/jira-cloud-create-page.png)](media/jira-cloud-create-page.png#lightbox)
> [!VIDEO https://www.youtube-nocookie.com/embed/SzNui9dK4oU]
### 1. Display name
A display name is used to identify each citation in Copilot, helping users easily recognize the associated file or item. Display name also signifies trusted content. Display name is also used as a [content source filter](/MicrosoftSearch/custom-filters#content-source-filters). A default value is present for this field, but you can customize it to a name that users in your organization recognize.
A display name is used to identify each citation in Copilot, helping users easily recognize the associated file or item. Display name also signifies trusted content. The display name is also used as a [content source filter](/MicrosoftSearch/custom-filters#content-source-filters). A default value is present for this field, but you can customize it to a name that users in your organization recognize.

### 2. Jira cloud URL
To connect to your Jira cloud data, you need your organization's Jira instance URL. Your organization's Jira instance URL typically looks like `https://<your-organization-domain>.atlassian.net`.

### 3. Authentication Type
### 3. Authentication type
To authenticate and sync issues from Jira, choose **one of the two** supported methods:<br>

a. **Basic authentication** <br>
Enter your account's username (usually email ID) and API token to authenticate using basic auth. Refer Atlassian's documentation on how to [manage API tokens for your Atlassian account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/) to learn more about generating an API token.
Enter your account's username (usually email ID) and API token to authenticate using basic auth. Refer to Atlassian's documentation on how to [manage API tokens for your Atlassian account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/) to learn more about generating an API token.
<br>

b. **Atlassian Jira OAuth 2.0 (Recommended)** <br>
Expand All @@ -76,7 +77,7 @@ The following steps provide guidance on how to register the app:
1. Sign in to [Atlassian Developer console](https://developer.atlassian.com/console/myapps/) with your Atlassian Jira admin account.
2. Select on `Create` and select `OAuth 2.0 integration`.
3. Provide an appropriate name for the application and create the new app.
4. Navigate to `Permissions` from the navigation pane on left. Select `Add` for `Jira API` and click on `Configure`. Under the 'Granular Permissions' header, add the following scopes.
4. Navigate to `Permissions` from the navigation pane on the left. Select `Add` for `Jira API` and click on `Configure`. Under the 'Granular Permissions' header, add the following scopes.

|#|Scope name|Code|
|:------------|:------------|:------------|
Expand Down Expand Up @@ -110,14 +111,14 @@ Complete the connection settings step using the **Client ID** and **Secret**.
> [!NOTE]
>
> * Refer to the [list of scopes](https://developer.atlassian.com/cloud/jira/platform/scopes-for-oauth-2-3LO-and-forge-apps/#list-of-scopes) for OAuth 2.0 apps to learn more about Jira permissions.
> * The original (Classic) OAuth permissions are being deprecated for the Jira cloud. Refer the [changelog announcement](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-517) to learn more.
> * The original (Classic) OAuth permissions are being deprecated for the Jira cloud. Refer to the [changelog announcement](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-517) to learn more.
### 4. Roll out to limited audience
Deploy this connection to a limited user base if you want to validate it in Copilot and other Search surfaces before expanding the rollout to a broader audience. To know more about limited rollout, see [staged rollout](staged-rollout-for-graph-connectors.md).
### 4. Roll out to a limited audience
Deploy this connection to a limited user base if you want to validate it in Copilot and other Search surfaces before expanding the rollout to a broader audience. To learn more about limited rollout, see [staged rollout](staged-rollout-for-graph-connectors.md).

At this point, you're ready to create the connection for Jira cloud. You can click **Create** to publish your connection and index issues from your Jira account.
At this point, you're ready to create the connection for the Jira cloud. You can click **Create** to publish your connection and index issues from your Jira account.

For other settings, like **Access Permissions**, **Data Inclusion Rules**, **Schema**, **Crawl frequency**, etc., we have defaults based on what works best with Jira data. You can see the default values below:
For other settings, like **Access permissions**, **Data inclusion rules**, **Schema**, **Crawl frequency**, etc., we have default values based on what works best with Jira data.

| Users | Description |
|----|---|
Expand All @@ -137,29 +138,29 @@ For other settings, like **Access Permissions**, **Data Inclusion Rules**, **Sch

If you want to edit any of these values, you need to choose the "Custom Setup" option.

## Custom Setup
## Custom setup

Custom setup is for those admins who want to edit the default values for settings listed in the above table. Once you click on the "Custom Setup" option, you see three more tabs - Users, Content, and Sync.

### Users

[![Screenshot that shows Users tab where you can configure access permissions and user mapping rules.](media/jira-cloud-users-tab.png)](media/jira-cloud-users-tab.png#lightbox)

**Access Permissions**
**Access permissions**

The Atlassian Jira connector supports search permissions visible to **Everyone** or **Only people with access to this data source**. If you choose **Everyone**, indexed data will appear in the search results for all users. If you choose **Only people with access to this data source**, indexed data will appear in the search results for users who have access to them. In Atlassian Jira, security permissions are defined using project permission schemes containing site-level groups and project roles. Issue-level security can also be defined using issue-level permission schemes.
The Atlassian Jira Cloud Microsoft Graph connector supports search permissions visible to **Everyone** or **Only people with access to this data source**. If you choose **Everyone**, indexed data appears in the search results for all users. If you choose **Only people with access to this data source**, indexed data appears in the search results for users who have access to them. In Atlassian Jira, security permissions are defined using project permission schemes containing site-level groups and project roles. Issue-level security can also be defined using issue-level permission schemes.

>[!IMPORTANT]
>The Jira cloud Microsoft Graph connector must be able to read a user’s email ID in Jira to appropriately assign security permissions in Microsoft Search and Microsoft 365 Copilot. This requires you to ensure either of the following:
>The Atlassian Jira Cloud Microsoft Graph connector must be able to read a user’s email ID in Jira to appropriately assign security permissions in Microsoft Search and Microsoft 365 Copilot. This requires you to ensure either of the following:
- All users should have selected the ‘Anyone’ option for their profile visibility settings. To learn more about profile visibility settings, refer to the [documentation by Atlassian](https://support.atlassian.com/atlassian-account/docs/update-your-profile-and-visibility-settings/).
- For organizations using ‘Managed accounts’ (All the Atlassian accounts with email addresses from your verified domain become managed accounts. Refer [this documentation](https://support.atlassian.com/user-management/docs/what-are-managed-accounts/) for more information) -
> * All users, who are part of managed accounts, must have the managed account setting selected in profile visibility settings.
> * Users who are not part of the managed account (same as crawling account), need to have ‘Anyone’ selected in their profile visibility settings.
> * The crawling account used during connection configuration must have the managed account domain.
**Mapping Identities**
**Mapping identities**

The default method for mapping your data source identities with Microsoft Entra ID is by checking whether the Email ID of Jira users is same as the UserPrincipalName (UPN), or Mail of the users in Microsoft Entra. If you believe the default mapping wouldn't work for your organization, you can provide a custom mapping formula. To know more about, mapping Non-Microsoft Entra ID identities, see [Map your non-Azure AD Identities](map-non-aad.md).
The default method for mapping your data source identities with Microsoft Entra ID is by checking whether the email ID of Jira users is the same as the UserPrincipalName (UPN), or Mail of the users in Microsoft Entra. If you believe the default mapping wouldn't work for your organization, you can provide a custom mapping formula. To know more about, mapping Non-Microsoft Entra ID identities, see [Map your non-Azure AD Identities](map-non-aad.md).

To identify which option is suitable for your organization:

Expand All @@ -168,7 +169,7 @@ To identify which option is suitable for your organization:

>[!NOTE]
>
> Updates to groups governing access permissions are synced in full crawls only. Incremental crawls don't support processing of updates to permissions.
> Updates to groups governing access permissions are synced in full crawls only. Incremental crawls don't support the processing of updates to permissions.
### Content

Expand All @@ -178,7 +179,7 @@ To identify which option is suitable for your organization:

You can choose for the connection to index either the entire Jira site or specific projects only.

* If you choose to index the entire Jira site, Jira issues in all projects in the site are indexed. New projects and issues are indexed during the next crawl after they're created.
* If you choose to index the entire Jira site, Jira issues in all projects on the site are indexed. New projects and issues are indexed during the next crawl after they're created.

* If you choose individual projects, only Jira issues in the selected projects are indexed.

Expand All @@ -189,16 +190,16 @@ To identify which option is suitable for your organization:

You may further choose to filter the Jira issues that are indexed in two ways.

* Specify the **issue modified time period**. This option will only index the Jira issues that are created or modified in the time period selected on a **rolling basis** based on current crawl.
* Specify the **issue modified time period**. This option only indexes the Jira issues that are created or modified in the time period selected on a **rolling basis** based on the current crawl.

> [!TIP]
> You may use the JQL filter to index only specific Jira issue types using "*issueType in (Bug, Improvement)*"
**Manage Properties**
**Manage properties**

Here, you can add or remove available properties from your Jira data source, assign a schema to the property (define whether a property is searchable, queryable, retrievable, or refinable), change the semantic label and add an alias to the property. Properties that are selected by default are listed below.

|Source Property|Label|Description|Schema|
|Source property|Label|Description|Schema|
|---|---|---|---|
| Authors | Authors | Name all the people who participated/collaborated on the item in the data source | Retrieve |
| Created | Created date time | Data and time that the item was created in the data source | Query, Retrieve |
Expand All @@ -217,29 +218,29 @@ Here, you can add or remove available properties from your Jira data source, ass


> [!NOTE]
> - The Atlassian Jira connector can index both default issue fields and custom created issue fields.
> - If a selected custom created field is not present in some Jira issue type(s), the field will be ingested as *NULL* (blank).
> - The Atlassian Jira Cloud Microsoft Graph connector can index both default issue fields and custom-created issue fields.
> - If a selected custom-created field is not present in some Jira issue type(s), the field is ingested as *NULL* (blank).
*The list of properties that you select here, can impact how you can filter, search and view your results in Copilot for Microsoft 365.*
*The list of properties that you select here, can impact how you can filter, search, and view your results in Copilot for Microsoft 365.*

**Preview Data**
**Preview data**

Use the preview results button to verify the sample values of the selected properties and query filter.

### Sync

[![Screenshot that shows Sync tab where you can configure crawl frequency.](media/jira-cloud-sync-tab.png)](media/jira-cloud-sync-tab.png#lightbox)

The refresh interval determines how often your data is synced between the data source and the Graph connector index. There are two types of refresh intervals - full crawl and incremental crawl. For more details, see [refresh settings](configure-connector.md#guidelines-for-sync-settings).
The refresh interval determines how often your data is synced between the data source and the Atlassian Jira Cloud Microsoft Graph connector index. There are two types of refresh intervals - full crawl and incremental crawl. For more details, see [refresh settings](configure-connector.md#guidelines-for-sync-settings).

You can change the default values of refresh interval from here if you want to.
You can change the default values of the refresh interval from here if you want to.

### Set up search result page

After creating the connection, you need to customize the search results page with verticals and result types. To learn about customizing search results, review how to [manage verticals](manage-verticals.md) and [result types](manage-result-types.md).
You may also use the [sample result layout](jira-connector-result-layout.md) for the Jira connector. Copy-paste the result layout JSON to get started after reviewing the schema of the connection with required schema for the sample layout.
You may also use the [sample result layout](jira-connector-result-layout.md) for the Atlassian Jira Cloud Microsoft Graph connector. Copy-paste the result layout JSON to get started after reviewing the schema of the connection with required schema for the sample layout.

## Troubleshooting
After publishing your connection, you can review the status under the **Data Sources** tab in the [admin center](https://admin.microsoft.com). To learn how to make updates and deletions, see [Manage your connector](manage-connector.md). You can find troubleshooting steps for commonly seen issues in [Troubleshooting guide for Atlassian Jira Cloud Microsoft Graph connector](troubleshoot-jira-cloud-connector.md).
After publishing your connection, you can review the status under the **Data sources** tab in the [admin center](https://admin.microsoft.com). To learn how to make updates and deletions, see [Manage your connector](manage-connector.md). You can find troubleshooting steps for commonly seen issues in [Troubleshooting guide for Atlassian Jira Cloud Microsoft Graph connector](troubleshoot-jira-cloud-connector.md).

If you have issues or want to provide feedback, contact [Microsoft Graph | Support](https://developer.microsoft.com/en-us/graph/support).
Loading

0 comments on commit 04c4831

Please sign in to comment.