ServiceNow-ConnectorServiceNow connector

Mit dem ServiceNow-Connector kann Ihre Organisation Knowledge Base-Artikel indizieren, die für alle Benutzer sichtbar sind oder mit Berechtigungen für benutzerkriterien in Ihrer Organisation eingeschränkt sind.With the ServiceNow connector, your organization can index knowledge-base articles that are visible to all users or restricted with user criteria permissions within your organization. Nachdem Sie den Connector-und den Index Inhalt von ServiceNow konfiguriert haben, können Endbenutzer nach diesen Artikeln von einem beliebigen Microsoft Search-Client aus suchen.After you configure the connector and index content from ServiceNow, end users can search for those articles from any Microsoft Search client.

Dieser Artikel richtet sich an Microsoft 365-Administratoren oder Personen, die einen ServiceNow-Connector konfigurieren, ausführen und überwachen.This article is for Microsoft 365 administrators or anyone who configures, runs, and monitors a ServiceNow connector. Es wird erläutert, wie Sie die Connector-und connectorfunktionen, Einschränkungen und Techniken zur Problembehandlung konfigurieren.It explains how to configure your connector and connector capabilities, limitations, and troubleshooting techniques.

Informationen zum Zugriff auf von Microsoft erstellte Connectors finden Sie unter Einrichten Ihres von Microsoft erstellten Connectors für Microsoft Search.Learn how to access Microsoft built connectors from Set up your Microsoft-built connector for Microsoft Search. ServiceNow Connector Specific Configuration wird im folgenden Artikel erläutert.ServiceNow connector specific configuration is explained in the article below.

VerbindungseinstellungenConnection Settings

Zum Herstellen einer Verbindung mit ihren ServiceNow-Daten benötigen Sie die ServiceNow-Instanz-URL Ihrer Organisation, Anmeldeinformationen für dieses Konto sowie die Client-ID und den geheimen Client Schlüssel für die OAuth-Authentifizierung.To connect to your ServiceNow data, you need your organization's ServiceNow instance URL, credentials for this account, and the Client ID and Client Secret for OAuth authentication.

Die ServiceNow- Instanz-URL Ihrer Organisation sieht in der Regel wie https:// < ihrer-Organisations-Domain>. Service-now.com aus.Your organization’s ServiceNow instance URL typically looks like https://<your-organization-domain>.service-now.com. Zusammen mit dieser URL benötigen Sie ein Konto zum Einrichten der Verbindung mit ServiceNow sowie dazu, dass Microsoft Search die Artikel aus ServiceNow regelmäßig basierend auf dem Aktualisierungszeitplan aktualisieren kann.Along with this URL, you will need an account for setting up the connection to ServiceNow as well as for allowing Microsoft Search to periodically update the articles from ServiceNow based on the refresh schedule. Das Konto sollte mindestens über eine Wissens Rolle verfügen.The account should at least have knowledge role. Erfahren Sie, wie Sie der Rolle für ServiceNow-Konten zuweisen.Learn how to assign role for ServiceNow accounts.

Hinweis

Wenn Sie Benutzer-und Gruppenidentitäten durchforsten möchten, um die Zugriffsberechtigungen von Knowledge Articles in Microsoft-Suchergebnissen zu honorieren, sollte das Konto über Zugriff verfügen, um die folgenden Tabelleneinträge in ServiceNow lesen zu können:If you want to crawl user and group identities to honor access permissions of knowledge articles in Microsoft Search results, the account should have access to read the following table records in ServiceNow:

  • kb_uc_can_contribute_mtomkb_uc_can_contribute_mtom
  • kb_uc_can_read_mtomkb_uc_can_read_mtom
  • kb_uc_cannot_read_mtomkb_uc_cannot_read_mtom
  • kb_uc_cannot_contribute_mtomkb_uc_cannot_contribute_mtom
  • sys_usersys_user
  • sys_user_has_rolesys_user_has_role
  • sys_user_grmembersys_user_grmember
  • user_criteriauser_criteria
  • kb_knowledge_basekb_knowledge_base
    Sie können eine Rolle für das Konto erstellen und zuweisen, das Sie für die Verbindung mit der Microsoft-Suche verwenden.You can create and assign a role for the account you use to connect with Microsoft Search. Lesezugriff auf die Tabellen kann für diese Rolle zugewiesen werden.Read access to the tables can be assigned on that role. Informationen zum Festlegen des Lesezugriffs auf Tabellendatensätze finden Sie unter Sichern von Tabellendatensätzen.To learn about setting read access to table records, see Securing Table Records.

Wählen Sie eine der drei unterstützten Methoden aus, um Inhalte von ServiceNow zu authentifizieren und zu synchronisieren:To authenticate and sync content from ServiceNow, choose one of three supported methods:

  1. StandardauthentifizierungBasic authentication
  2. ServiceNow OAuth (empfohlen)ServiceNow OAuth (recommended)
  3. Azure AD OpenID ConnectAzure AD OpenID Connect

StandardauthentifizierungBasic authentication

Geben Sie den Benutzernamen und das Kennwort des ServiceNow-Kontos mit der Wissens Rolle ein, die bei Ihrer Instanz authentifiziert werden soll.Enter the username and password of ServiceNow account with knowledge role to authenticate to your instance.

ServiceNow OAuthServiceNow OAuth

Um ServiceNow OAuth für die Authentifizierung zu verwenden, muss ein ServiceNow-Administrator einen Endpunkt in der ServiceNow-Instanz bereitstellen, damit die Microsoft Search-App auf die Instanz zugreifen kann.To use ServiceNow OAuth for authentication, a ServiceNow admin needs to provision an endpoint in your ServiceNow instance, so that the Microsoft Search app can access the instance. Weitere Informationen finden Sie unter Erstellen eines Endpunkts für Clients für den Zugriff auf die Instanz in der ServiceNow-Dokumentation.To learn more, see Create an endpoint for clients to access the instance in the ServiceNow documentation.

Die folgende Tabelle enthält Anleitungen zum Ausfüllen des Endpunkts-erstellungsformulars:The following table provides guidance on how to fill out the endpoint creation form:

FieldField BeschreibungDescription Empfohlener WertRecommended Value
NameName Dieser eindeutige Wert identifiziert die Anwendung, für die Sie OAuth-Zugriff benötigen.This unique value identifies the application that you require OAuth access for. Microsoft SearchMicrosoft Search
Client-IDClient ID Eine schreibgeschützte, automatisch generierte eindeutige ID für die Anwendung.A read-only, auto-generated unique ID for the application. Die Instanz verwendet die Client-ID, wenn Sie ein Zugriffstoken anfordert.The instance uses the client ID when it requests an access token. NANA
Geheimer Client SchlüsselClient secret Mit dieser freigegebenen geheimen Zeichenfolge autorisieren die ServiceNow-Instanz und die Microsoft Search die Kommunikation miteinander.With this shared secret string, the ServiceNow instance and Microsoft Search authorize communications with each other. Beachten Sie bewährte Methoden für die Sicherheit, indem Sie dies als Kennwort behandeln.Follow security best-practices by treating this as a password.
Umleitungs-URLRedirect URL Eine erforderliche Rückruf-URL, an die der autorisierungsserver umgeleitet wird.A required callback URL that the authorization server redirects to. https://gcs.office.com/v1.0/admin/oauth/callback
Logo-URLLogo URL Eine URL, die das Bild für das Anwendungslogo enthält.A URL that contains the image for the application logo. NANA
AktivActive Aktivieren Sie das Kontrollkästchen, um die Anwendungsregistrierung aktiv zu machen.Select the check box to make the application registry active. Auf aktiv festlegenSet to active
Lebensdauer des Aktualisierungs TokensRefresh token lifespan Die Anzahl der Sekunden, die ein Aktualisierungstoken gültig ist.The number of seconds that a refresh token is valid. Standardmäßig laufen Aktualisierungstoken in 100 Tagen (8640000 Sekunden) ab.By default, refresh tokens expire in 100 days (8640000 seconds). 31.536.000 (1 Jahr)31,536,000 (1 year)
Lebensdauer des ZugriffstokensAccess token lifespan Die Anzahl der Sekunden, die ein Zugriffstoken gültig ist.The number of seconds that an access token is valid. 43.200 (12 Stunden)43,200 (12 hours)

Geben Sie die Client-ID und den geheimen Client Schlüssel für die Verbindung mit Ihrer Instanz ein.Enter the client id and client secret to connect to your instance. Verwenden Sie nach dem Herstellen einer Verbindung eine ServiceNow-Kontoanmeldeinformationen, um die Berechtigung zum durchforsten zu authentifizieren.After connecting, use a ServiceNow account credential to authenticate permission to crawl. Das Konto sollte mindestens über eine Wissens Rolle verfügen.The account should at least have knowledge role.

Azure AD OpenID ConnectAzure AD OpenID Connect

Führen Sie die folgenden Schritte aus, um Azure AD OpenID Connect für die Authentifizierung zu verwenden.To use Azure AD OpenID Connect for authentication, follow the steps below.

Schritt 1: Registrieren einer neuen Anwendung in Azure Active DirectoryStep 1: Register a new application in Azure Active Directory

Informationen zum Registrieren einer neuen Anwendung in Azure Active Directory finden Sie unter Registrieren einer Anwendung.To learn about registering a new application in Azure Active Directory, see Register an application. Wählen Sie ein Organisations Verzeichnis für einzelne Mandanten aus.Select single tenant organizational directory. Umleitungs-URI ist nicht erforderlich.Redirect URI is not needed. Notieren Sie nach der Registrierung die ID des Anwendungsclients (Client) und die Verzeichnis (Mandanten-ID).After registration, note down the Application (client) ID and Directory (tenant) ID.

Schritt 2: Erstellen eines geheimen Client SchlüsselsStep 2: Create a client secret

Informationen zum Erstellen eines geheimen Client Schlüssels finden Sie unter Erstellen eines geheimen Client Schlüssels.To learn about creating a client secret, see Creating a client secret. Notieren Sie sich den geheimen Client Schlüssel.Take a note of client secret.

Schritt 3: Abrufen der Dienstprinzipal Objekt-IDStep 3: Retrieve Service Principal Object Identifier

Führen Sie die Schritte zum Abrufen der Dienstprinzipal Objekt-ID aus.Follow the steps to retrieve Service Principal Object Identifier

  1. Ausführen von PowerShellRun PowerShell
  2. Installieren von Azure PowerShell mit dem folgenden BefehlInstall Azure PowerShell using the following command
   Install-Module -Name Az -AllowClobber -Scope CurrentUser
  1. Herstellen einer Verbindung mit AzureConnect to Azure
    Connect-AzAccount
  1. Dienstprinzipal Objekt-ID abrufenGet Service Principal Object Identifier
   Get-AzADServicePrincipal -ApplicationId "Application-ID"

Ersetzen Sie "Application-ID" durch die Application (Client)-ID (ohne Anführungszeichen) der Anwendung, die Sie in Schritt 1 registriert haben.Replace "Application-ID" with Application (client) ID (without quotes) of the application you registered in step 1. Notieren Sie sich den Wert des ID-Objekts aus der PowerShell-Ausgabe.Note the value of ID object from PowerShell output. Es handelt sich um die Dienstprinzipal-ID.It is the Service Principal ID.

Jetzt haben Sie alle erforderlichen Informationen aus dem Azure-Portal.Now you have all the information required from Azure portal. Eine kurze Zusammenfassung der Informationen finden Sie in der folgenden Tabelle.A quick summary of the information is given in the table below.

EigenschaftProperty BeschreibungDescription
Verzeichnis-ID (Mandanten-ID)Directory ID (Tenant ID) Dies ist eine eindeutige ID, die den Azure Active Directory-Mandanten (aus Schritt 1) verweist.This is a unique ID referring the Azure Active Directory tenant (from step 1).
Anwendungs-ID (Client-ID)Application ID (Client ID) Hierbei handelt es sich um eine eindeutige ID, die die in Schritt 1 registrierte Anwendung referenziert.This is a unique ID referring the application registered in step 1.
Geheimer ClientschlüsselClient Secret Dies ist der geheime Schlüssel der Anwendung (aus Schritt 2).This is the secret key of the application (from step 2). Behandeln Sie es wie ein Kennwort.Treat it like a password.
Dienstprinzipal-IDService Principal ID Eine Identität für die Anwendung, die als Dienst gestartet wird.An identity for the application running as a service. (aus Schritt 3)(from step 3)
Schritt 4: Registrieren der ServiceNow-AnwendungStep 4: Register ServiceNow Application

Die folgende Konfiguration muss in der ServiceNow-Instanz ausgeführt werden.The following configuration need to be done in the ServiceNow instance.

  1. Registrieren einer neuen OAuth OIDC-Entität.Register a new OAuth OIDC entity. Weitere Informationen finden Sie unter Create an OAuth OIDC Provider.To learn, see Create an OAuth OIDC provider.
  2. In der folgenden Tabelle finden Sie Anleitungen zum Ausfüllen des OIDC-Anbieter Registrierungsformulars.The following table provides guidance on how to fill out OIDC provider registration form
FieldField BeschreibungDescription Empfohlener WertRecommended Value
NameName Ein eindeutiger Name, der die OAuth OIDC-Entität identifiziert.A unique name that identifies the OAuth OIDC entity. Azure ADAzure AD
Client-IDClient ID Die Client-ID der Anwendung, die im OAuth OIDC-Server des Drittanbieters registriert ist.The client ID of the application registered in the third-party OAuth OIDC server. Die Instanz verwendet die Client-ID beim Anfordern eines Zugriffstokens.The instance uses the client ID when requesting an access token. Anwendungs-ID (Client) aus Schritt 1Application (Client) ID from step 1
Geheimer ClientschlüsselClient Secret Der geheime Client Schlüssel der Anwendung, die im OAuth OIDC-Server von Drittanbietern registriert ist.The client secret of the application registered in the third-party OAuth OIDC server. Geheimer Client Schlüssel aus Schritt 2Client Secret from step 2

Alle anderen Werte können Standard sein.All other values can be default.

  1. Im OIDC-Anbieter Registrierungsformular müssen Sie eine neue OIDC-Anbieterkonfiguration hinzufügen.In the OIDC provider registration form, you need to add a new OIDC provider configuration. Klicken Sie auf das Suchsymbol für OAuth OIDC-Anbieter Konfigurations Feld, um die Datensätze der OIDC-Konfigurationen zu öffnen.Click the search icon against OAuth OIDC Provider Configuration field to open the records of OIDC configurations. Klicken Sie auf Neu.Click New.
  2. In der folgenden Tabelle finden Sie Anleitungen zum Ausfüllen des OIDC-Anbieter Konfigurations Formulars.The following table provides guidance on how to fill out OIDC provider configuration form
FieldField Empfohlener WertRecommended Value
OIDC-AnbieterOIDC Provider Azure ADAzure AD
OIDC-Metadaten-URLOIDC Metadata URL Dies muss das Format https : //Login.microsoftonline.com/"tenandId"/.well-known/OpenID-ConfigurationThis must be in the form https://login.microsoftonline.com/"tenandId"/.well-known/openid-configuration
Ersetzen Sie "Mandantenkennung" durch die Verzeichnis (Mandanten-ID) aus Schritt 1 (ohne Anführungszeichen).Replace "tenantID" with Directory (tenant) ID from step 1 (without quotes).
Lebensdauer des OIDC-Konfigurations CacheOIDC Configuration Cache Life Span 120120
AnwendungApplication GlobalGlobal
Benutzer ForderungUser Claim subsub
BenutzerfeldUser Field Benutzer-IDUser ID
Aktivieren der Überprüfung der Überprüfung der ForderungEnable JTI claim verification DeaktiviertDisabled
  1. Klicken Sie auf Submit, und aktualisieren Sie das entitätsformular OAuth OIDC.Click Submit and Update the OAuth OIDC Entity form.
Schritt 5: Erstellen eines ServiceNow-KontosStep 5: Create a ServiceNow account

Lesen Sie die Anweisungen zum Erstellen eines ServiceNow-Kontos, Erstellen Sie einen Benutzer in ServiceNow.Refer the instructions to create a ServiceNow account, create a user in ServiceNow.

Die folgende Tabelle enthält Anleitungen zum Ausfüllen der ServiceNow-Benutzerkonto Registrierung.The following table provides guidance on how to fill out the ServiceNow user account registration

FieldField Empfohlener WertRecommended Value
Benutzer-IDUser ID Dienstprinzipal-ID aus Schritt 3Service Principal ID from step 3
Nur-WebdienstzugriffWeb service access only CheckedChecked

Alle anderen Werte können als Standard beibehalten werden.All other values can be left to default.

Schritt 6: Aktivieren der Wissens Rolle für das ServiceNow-KontoStep 6: Enable Knowledge role for the ServiceNow account

Greifen Sie auf das ServiceNow-Konto zu, das Sie mit ServiceNow Principal ID als Benutzer-ID erstellt haben, und weisen Sie die Wissens Rolle zu.Access the ServiceNow account you created with ServiceNow Principal ID as User ID and assign the knowledge role. Anweisungen zum Zuweisen einer Rolle zu einem ServiceNow-Konto finden Sie hier, Zuweisen einer Rolle zu einem Benutzer.Instructions to assigning a role to a ServiceNow account can be found here, assign a role to a user.

Verwenden Sie die Anwendungs-ID als Client-ID (aus Schritt 1) und den geheimen Client Schlüssel (ab Schritt 2) im Admin Center-Konfigurations-Assistenten, um sich bei ihrer ServiceNow-Instanz mit Azure AD OpenID Connect zu authentifizieren.Use Application ID as Client ID (from step 1), and Client secret (from step 2) in admin center configuration wizard to authenticate to your ServiceNow instance using Azure AD OpenID Connect.

Filtern von DatenFilter data

Mit einer ServiceNow-Abfragezeichenfolge können Sie Bedingungen für die Synchronisierung von Artikeln angeben.With a ServiceNow query string, you can specify conditions for syncing articles. Es ist wie eine Where -Klausel in einer SQL-SELECT -Anweisung.It's like a Where clause in a SQL Select statement. Beispielsweise können Sie auswählen, nur veröffentlichte und aktive Artikel zu indizieren.For example, you can choose to index only articles that are published and active. Weitere Informationen zum Erstellen einer eigenen Abfragezeichenfolge finden Sie unter Generieren einer codierten Abfragezeichenfolge mithilfe eines Filters.To learn about creating your own query string, see Generate an encoded query string using a filter.

Verwalten von SuchberechtigungenManage search permissions

Der ServiceNow-Connector unterstützt Suchberechtigungen, die für alle Benutzer oder nur für Personen mit Zugriff auf diese Datenquelle sichtbar sind.The ServiceNow connector supports search permissions visible to Everyone or Only people with access to this data source. Indizierte Daten werden in den Suchergebnissen angezeigt und sind für alle Benutzer in der Organisation oder für Benutzer sichtbar, die Zugriff auf diese haben.Indexed data appears in the search results and is visible to all users in the organization or users who have access to them respectively. ServiceNow Connector unterstützt Standardbenutzer Kriterien-Berechtigungen ohne erweiterte Skripts.ServiceNow Connector supports default user criteria permissions without advanced scripts. Wenn der Connector auf ein Benutzer Kriterium mit erweitertem Skript stößt, werden alle Daten, die diese benutzerkriterien verwenden, nicht in den Suchergebnissen angezeigt.When the connector encounters a user criteria with advanced script, all data using that user criteria will not be showed in search results.

Wenn Sie nur Personen mit Zugriff auf diese Datenquelle auswählen, müssen Sie entscheiden, ob Ihre ServiceNow-Instanz Azure-Active Directory (AAD)-Benutzer oder nicht-Aad-Benutzer enthält.If you choose Only people with access to this data source, you need to further choose whether your ServiceNow instance has Azure Active Directory (AAD) provisioned users or Non-AAD users.

Hinweis

Der ServiceNow-Connector befindet sich in der Vorschau , wenn Sie nur Personen mit Zugriff auf diese Datenquelle auswählen.The ServiceNow connector is in preview if you choose Only people with access to this data source.

Hinweis

Wenn Sie Aad als Typ der Identitäts Quelle auswählen, müssen Sie sicherstellen, dass Sie die UPN-Quelleigenschaft für die e-Mail-Zieleigenschaft in ServiceNow zuweisen.If you choose AAD as the type of identity source, make sure you are assigning UPN source property to email targeted property in ServiceNow. Informationen zum Überprüfen oder Ändern ihrer Zuordnungen finden Sie unter Customizing User Provisioning Attribut-Mappings for Saas Applications in Azure Active Directory.To verify or change your mappings, see Customizing user provisioning attribute-mappings for SaaS applications in Azure Active Directory.

Wenn Sie eine ACL aus ihrer ServiceNow-Instanz aufnehmen und "nicht-Aad" für den Identitätstyp ausgewählt haben, finden Sie Anweisungen zum Zuordnen der Identitäten unter Zuordnen der nicht Azure AD Identitäten .If you chose to ingest an ACL from your ServiceNow instance and selected "non-AAD" for the identity type see Map your non-Azure AD Identities for instructions on mapping the identities.

Zuweisen von Eigenschaften BezeichnungenAssign property labels

Sie können jeder Beschriftung eine Source-Eigenschaft zuweisen, indem Sie in einem Menü mit Optionen auswählen.You can assign a source property to each label by choosing from a menu of options. Dieser Schritt ist zwar nicht zwingend erforderlich, aber einige Eigenschaften Bezeichnungen verbessern die Suchrelevanz und stellen genauere Suchergebnisse für Endbenutzer sicher.While this step is not mandatory, having some property labels will improve the search relevance and ensure more accurate search results for end users.

Schema verwaltenManage schema

Auf dem Bildschirm " Schema verwalten " haben Sie die Möglichkeit, die den Eigenschaften zugeordneten Schema Attribute ( abfragbar, durchsuchbar, abrufbar und verfeinernd) zu ändern, optionale Aliase hinzuzufügen und die Content -Eigenschaft auszuwählen.On the Manage Schema screen, you have the option to change the schema attributes (queryable, searchable, retrievable, and refinable) associated with the properties, add optional aliases, and choose the Content property.

Festlegen des AktualisierungszeitplansSet the refresh schedule

Der ServiceNow-Connector unterstützt Aktualisierungs Zeitpläne für vollständige und inkrementelle Crawls.The ServiceNow connector supports refresh schedules for both full and incremental crawls. Es wird empfohlen, beides festzulegen.We recommend that you set both.

Ein vollständiger durchforstungszeitplan findet gelöschte Artikel, die zuvor mit dem Microsoft-Suchindex synchronisiert wurden, sowie alle Artikel, die aus dem Synchronisierungsfilter verschoben wurden.A full crawl schedule finds deleted articles that were previously synced to the Microsoft Search index and any articles that moved out of the sync filter. Wenn Sie zum ersten Mal eine Verbindung mit ServiceNow herstellen, wird eine vollständige Durchforstung ausgeführt, um alle Knowledge Base-Artikel zu synchronisieren.When you first connect to ServiceNow, a full crawl runs to sync all the knowledge-base articles. Sie müssen inkrementelle Crawls planen, um neue Elemente zu synchronisieren und Aktualisierungen vorzunehmen.To sync new items and make updates, you need to schedule incremental crawls.

Der empfohlene Standardwert ist ein Tag für eine vollständige Durchforstung und vier Stunden für eine inkrementelle Durchforstung.The recommended default is one day for a full crawl and four hours for an incremental crawl.

Hinweis

Für Identitäten wird nur die vollständige Durchforstung geplant angewendet.For identities, only full crawl scheduled will be applied.

Überprüfen und veröffentlichenReview and publish

Nachdem Sie den Connector konfiguriert haben, können Sie die Verbindung überprüfen und veröffentlichen.After you configure your connector, you can review and publish the connection.

Nächste SchritteNext steps

Nachdem Sie die Verbindung veröffentlicht haben, müssen Sie die Suchergebnisseite anpassen.After publishing the connection, you need to customize the search results page. Informationen zum Anpassen von Suchergebnissen finden Sie unter Anpassen der Suchergebnisseite.To learn about customizing search results, see Customize the search results page.