diff --git a/MicrosoftSearch/jira-connector.md b/MicrosoftSearch/jira-connector.md index 275ff744..1161c1d2 100644 --- a/MicrosoftSearch/jira-connector.md +++ b/MicrosoftSearch/jira-connector.md @@ -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 @@ -20,7 +20,7 @@ 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. @@ -28,7 +28,7 @@ This article is for Microsoft 365 administrators or anyone who configures, runs, ## 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. @@ -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://.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://.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 | | ------------ | ------------ | ------------ | @@ -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://.atlassian.net`. -### 3. Authentication Type +### 3. Authentication type To authenticate and sync issues from Jira, choose **one of the two** supported methods:
a. **Basic authentication**
- 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.
b. **Atlassian Jira OAuth 2.0 (Recommended)**
@@ -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| |:------------|:------------|:------------| @@ -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 | |----|---| @@ -137,7 +138,7 @@ 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. @@ -145,21 +146,21 @@ Custom setup is for those admins who want to edit the default values for setting [![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: @@ -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 @@ -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. @@ -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 | @@ -217,12 +218,12 @@ 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. @@ -230,16 +231,16 @@ Use the preview results button to verify the sample values of the selected prope [![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). diff --git a/MicrosoftSearch/servicenow-knowledge-connector.md b/MicrosoftSearch/servicenow-knowledge-connector.md index 19f3fa79..ca356b4f 100644 --- a/MicrosoftSearch/servicenow-knowledge-connector.md +++ b/MicrosoftSearch/servicenow-knowledge-connector.md @@ -37,7 +37,7 @@ This article is for Microsoft 365 administrators or anyone who configures, runs, ## Prerequisites - **ServiceNow Instance URL**: To connect to your ServiceNow data, you need your organization's ServiceNow instance URL. Your organization's ServiceNow instance URL typically looks like `https://your-organization-name.service-now.com`. (Don’t have one? [Check how to create a test instance](https://www.youtube.com/watch?v=OTdzVLqpFHY)) -- **Service Account**: To connect to ServiceNow and allow Microsoft Graph Connector to update knowledge articles regularly, you need a service account with read access to specific ServiceNow table records. The service account needs read access to the following **ServiceNow table records** to successfully crawl various entities. +- **Service Account**: To connect to ServiceNow and allow Microsoft Graph connector to update knowledge articles regularly, you need a service account with read access to specific ServiceNow table records. The service account needs read access to the following **ServiceNow table records** to successfully crawl various entities. Feature | Read access required tables | Description --- | --- | --- @@ -63,13 +63,11 @@ This article is for Microsoft 365 administrators or anyone who configures, runs, If you want to index properties from [extended tables](https://docs.servicenow.com/bundle/vancouver-platform-administration/page/administer/table-administration/concept/table-extension-and-classes.html) of *kb_knowledge*, provide read access to sys_dictionary and sys_db_object. The access to these tables is optional. You can index *kb_knowledge* table properties without access to the two additional tables. -## Get Started +## Get started -Check out our [YouTube video](https://www.youtube.com/watch?v=uS5JV-2M9kw) for a detailed, step-by-step guide on adding the Microsoft Graph Connector for ServiceNow Knowledge. +This video provides a step-by-step guide on adding the Microsoft Graph connector for ServiceNow Knowledge. -[Watch the video](https://www.youtube.com/watch?v=uS5JV-2M9kw) - -![Screenshot that shows Connection creation screen for Microsoft Graph Connector for ServiceNow Knowledge](media/servicenow-knowledge-create-page.png "Add Microsoft Graph Connector for ServiceNow Knowledge") +> [!VIDEO https://www.youtube-nocookie.com/embed/uS5JV-2M9kw] ### 1. Display name @@ -79,7 +77,7 @@ A display name is used to identify each reference in Copilot, helping users easi To connect to your ServiceNow data, you need your organization's ServiceNow instance URL. Your organization's ServiceNow instance URL typically looks like `https://your-organization-name.service-now.com`. -### 3. Authentication Type +### 3. Authentication type To authenticate and sync content from ServiceNow, choose **one of three** supported methods:
@@ -87,26 +85,26 @@ To authenticate and sync content from ServiceNow, choose **one of three** suppor Enter the username and password of ServiceNow account with **knowledge** role to authenticate to your instance.
- b. **ServiceNow OAuth (Recommended)** + b. **ServiceNow OAuth (recommended)**
[Click to expand]To use the ServiceNow OAuth for authentication, follow these steps.
- A ServiceNow admin needs to provision an endpoint in your ServiceNow instance, so that the Graph connector can access it. To learn more, see [Create an endpoint for clients to access the instance](https://docs.servicenow.com/bundle/vancouver-platform-security/page/administer/security/task/t_CreateEndpointforExternalClients.html) in the ServiceNow documentation. + A ServiceNow admin needs to provision an endpoint in your ServiceNow instance so that the Graph connector can access it. To learn more, see [Create an endpoint for clients to access the instance](https://docs.servicenow.com/bundle/vancouver-platform-security/page/administer/security/task/t_CreateEndpointforExternalClients.html) in the ServiceNow documentation. The following table provides guidance on how to fill out the endpoint creation form: - Field | Description | Recommended Value + Field | Description | Recommended value --- | --- | --- Name | Unique value that identifies the application that you require OAuth access for. | Microsoft Search - Client ID | A read-only, auto generated unique ID for the application. The instance uses the client ID when it requests an access token. | NA - Client secret | With this shared secret string, the ServiceNow instance and Microsoft Search authorize communications with each other. | Follow security best-practices by treating the secret as a password. + Client ID | A read-only, auto-generated unique ID for the application. The instance uses the client ID when it requests an access token. | NA + Client secret | With this shared secret string, the ServiceNow instance and Microsoft Search authorize communications with each other. | Follow security best practices by treating the secret as a password. Redirect URL | A required callback URL that the authorization server redirects to. | For **M365 Enterprise**: https://gcs.office.com/v1.0/admin/oauth/callback,
For **M365 Government**: https://gcsgcc.office.com/v1.0/admin/oauth/callback Logo URL | A URL that contains the image for the application logo. | NA Active | Select the check box to make the application registry active. | Set to active Refresh token lifespan | The number of seconds that a refresh token is valid. By default, refresh tokens expire in 100 days (8,640,000 seconds). | 31,536,000 (one year) Access token lifespan | The number of seconds that an access token is valid. | 43,200 (12 hours) - Enter the client id and client secret to connect to your instance. After connecting, use a ServiceNow account credential to authenticate permission to crawl. The account should at least have **knowledge** role. Refer to the table mentioned under Service account in the [Prerequisites](#prerequisites) section for providing read access to more ServiceNow table records and index user criteria permissions. + Enter the client ID and client secret to connect to your instance. After connecting, use a ServiceNow account credential to authenticate permission to crawl. The account should at least have **knowledge** role. Refer to the table mentioned under the Service account in the [Prerequisites](#prerequisites) section for providing read access to more ServiceNow table records and index user criteria permissions.

c. **Microsoft Entra ID OpenID Connect** @@ -160,7 +158,7 @@ To authenticate and sync content from ServiceNow, choose **one of three** suppor Client Secret | The secret key of the application (from step 3.b). Treat it like a password. Service Principal ID | An identity for the application running as a service. (from step 3.c) - 4. Register ServiceNow Application + 4. Register the ServiceNow Application The ServiceNow instance needs the following configuration: @@ -194,7 +192,7 @@ To authenticate and sync content from ServiceNow, choose **one of three** suppor 5. Create a ServiceNow account - Refer the instructions to create a ServiceNow account, [create a user in ServiceNow](https://docs.servicenow.com/bundle/vancouver-platform-administration/page/administer/users-and-groups/task/t_CreateAUser.html). + Refer to the instructions to create a ServiceNow account, [create a user in ServiceNow](https://docs.servicenow.com/bundle/vancouver-platform-administration/page/administer/users-and-groups/task/t_CreateAUser.html). The following table provides guidance on how to fill out the ServiceNow user account registration @@ -213,11 +211,11 @@ To authenticate and sync content from ServiceNow, choose **one of three** suppor -### 4. Rollout to limited audience +### 4. Rollout 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 know more about limited rollout, click [here](/MicrosoftSearch/staged-rollout-for-graph-connectors). -At this point, you are ready to create the connection for ServiceNow Knowledge. You can click on the "Create" button and the Microsoft Graph connector will start indexing articles from your ServiceNow account. +At this point, you are ready to create the connection for ServiceNow Knowledge. You can click the "Create" button and the Microsoft Graph connector starts indexing articles from your ServiceNow account. For other settings, like Access Permissions, Data inclusion rules, Schema, Crawl frequency etc., we have set defaults based on what works best with ServiceNow data. You can see the default values below: @@ -240,7 +238,7 @@ If you want to edit any of these values, you need to choose the "Custom Setup" o [Get started with Microsoft Graph Connector for ServiceNow Knowledge](https://admin.microsoft.com/adminportal/home#/MicrosoftSearch/Connectors/add?ms_search_referrer=MicrosoftSearchDocs_ServiceNowKB&type=ServiceNowKB) -## 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. @@ -248,21 +246,21 @@ Custom setup is for those admins who want to edit the default values for setting ![Screenshot that shows Users tab where you can configure access permissions and user mapping rules](media/servicenow-knowledge-users-tab.png "Configure settings related to Users") -**Access Permissions** +**Access permissions** The ServiceNow connector supports access permissions visible to "Everyone" or "Only people with access to content in data source". Indexed data appears in results and is visible to all users in the organization or users who have access to them via user criteria permission respectively. Choose the one that is most appropriate for your organization. -If a knowledge article isn't enabled with a user criterion, it appears in results of everyone in the organization. +If a knowledge article isn't enabled with a user criterion, it appears in the results of everyone in the organization. >[!IMPORTANT] > In ServiceNow, while assessing read permissions for a user, both article-level permissions and KB-level permissions are looked at. The Microsoft Graph connector for ServiceNow treats permissions differently: -> 1. If the article contains '_Can Read_' user criteria, then they are stamped on the article during ingestion and Knowledge Base '_Can Read_' / '_Can Contribute_' user criteria are ignored. +> 1. If the article contains '_Can Read_' user criteria, then they are stamped on the article during ingestion, and Knowledge Base '_Can Read_' / '_Can Contribute_' user criteria are ignored. > 2. If the article contains '_Cannot Read_' user criteria, and if the corresponding Knowledge base also contains '_Cannot Read_' user criteria, then both the user criteria are stamped on the article. >[!NOTE] -> If a user is part of the '_Can Read_' user criteria at the article level but not in the '_Can Read_' / '_Can Contribute_' user criteria at the Knowledge Base level, **then the user will not have access to the article in ServiceNow but will have access to the article in Microsoft Copilot, Microsoft Search and other M365 surfaces**. The workaround is to remove the user from the '_Can Read_' user criteria at the article level. +> If a user is part of the '_Can Read_' user criteria at the article level but not in the '_Can Read_' / '_Can Contribute_' user criteria at the Knowledge Base level, **then the user doesn't have access to the article in ServiceNow but does have access to the article in Microsoft Copilot, Microsoft Search, and other M365 surfaces**. The workaround is to remove the user from the '_Can Read_' user criteria at the article level. -**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 ServiceNow users is same as the UserPrincipalName (UPN), or Mail of the users in Microsoft Entra ID. If you believe the default mapping would not work for your organization, you can provide a custom mapping formula. To know more about, mapping Non-EntraID identities, click [here](/MicrosoftSearch/map-non-aad). @@ -270,13 +268,13 @@ The default method for mapping your data source identities with Microsoft Entra ![Screenshot that shows Content tab where you can configure Query string and Properties](media/servicenow-knowledge-content-tab.png "Configure settings related to your content") -**Query String** +**Query string** With a ServiceNow query string, you can specify conditions for syncing articles. It's like a **Where** clause in a **SQL Select** statement. For example, you can choose to index only articles that are published and active. To learn about creating your own query string, see [Generate an encoded query string using a filter](https://docs.servicenow.com/bundle/vancouver-platform-user-interface/page/use/using-lists/task/t_GenEncodQueryStringFilter.html). -**Manage Properties** +**Manage properties** -Here, you can add or remove available properties from your ServiceNow 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. +Here, you can add or remove available properties from your ServiceNow 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| |---|---|---|---| @@ -288,18 +286,18 @@ Here, you can add or remove available properties from your ServiceNow data sourc |CannotReadUserCriteria|||| |Content|||| |EntityType|||| -|IconURL|iconUrl|Icon url that represents the article's category or type.|Retrieve| +|IconURL|iconUrl|Icon URL that represents the article's category or type.|Retrieve| |KbKnowledgeBase|||| |Number|||Retrieve| |PreviewContent|||Retrieve| -|Short_description|title|The title of the item that you want shown in Copilot and other search experiences|Search, Retrieve| +|Short_description|title|The title of the item that you want to be shown in Copilot and other search experiences|Search, Retrieve| |SysCreatedBy|createdBy|Name of the person who created the item in the data source.|Retrieve| |SysCreatedOn|CreatedDateTime|Data and time that the item was created in the data source|Retrieve| |SysUpdatedBy|lastModifiedBy|Name of the person who most recently edited the item in the data source.|Retrieve| |SysUpdatedOn|lastModifiedDateTime|Date and time the item was last modified in the data source.|Retrieve| |WorkflowState|||Retrieve| -**Preview Data** +**Preview data** Use the preview results button to verify the sample values of the selected properties and query filter. @@ -311,17 +309,17 @@ Use the preview results button to verify the sample values of the selected prope 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, click [here](/MicrosoftSearch/configure-connector#step-8-refresh-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. -## Read and Deny Access to Knowledge Articles in Microsoft Graph Connector for ServiceNow +## Read and Deny Access to Knowledge Articles in Microsoft Graph connector for ServiceNow
[Click to expand] Here is a scenario-wise depiction of how the connector treats access permissions based on user criteria in ServiceNow Knowledge:
>[!NOTE] > Terms used in the table below: -> * **No criteria**: No user criteria is defined for the article or Knowledge base. (Different from empty criteria where a user criteria is defined but within the criteria all fields are empty) -> * **Default user criteria**: User criteria defined using ServiceNow fields like Users, Groups, Roles, Location, Department etc. ->* **Empty Criteria**: A User criteriion where all fields have empty values. +> * **No criteria**: No user criteria are defined for the article or Knowledge base. (Different from empty criteria where a user criteria is defined but within the criteria all fields are empty) +> * **Default user criteria**: User criteria defined using ServiceNow fields like Users, Groups, Roles, Location, Department, etc. +>* **Empty criteria**: A User criteria where all fields have empty values. ### How Read access is determined @@ -348,7 +346,7 @@ You can change the default values of refresh interval from here if you want to.
## 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). +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 [here](./troubleshoot-servicenow-knowledge-connector.md). If you have issues or want to provide feedback, contact [Microsoft Graph | Support](https://developer.microsoft.com/en-us/graph/support).