Déployer le connecteur Microsoft SharePoint Online

Ce guide est destiné aux administrateurs du connecteur Google Cloud Search SharePoint Online, c'est-à-dire à toute personne chargée de télécharger, de configurer, d'exécuter et de surveiller ce connecteur.

Ce guide contient des instructions permettant de réaliser les principales tâches associées au déploiement du connecteur SharePoint Online :

  • Télécharger le logiciel du connecteur Google Cloud Search SharePoint Online
  • Configurer le connecteur pour son utilisation avec une source de données SharePoint Online spécifique
  • Déployer et exécuter le connecteur

Pour comprendre les concepts présentés dans ce document, vous devez connaître les principes fondamentaux de G Suite et de SharePoint sur site.

Présentation du connecteur Google Cloud Search SharePoint Online

Par défaut, Google Cloud Search peut explorer, indexer et diffuser du contenu à partir de données G Suite (Google Docs, Gmail, etc.). Grâce au connecteur SharePoint Online, vous pouvez étendre les fonctionnalités de Google Cloud Search à la diffusion de contenu SharePoint Online à vos utilisateurs.

Fichiers de propriétés de configuration

Pour pouvoir explorer le contenu de SharePoint Online et l'importer dans l'API d'indexation, le connecteur a besoin de paramètres. En tant qu'administrateur du connecteur, il vous appartient de lui transmettre ces paramètres dans un fichier de configuration que vous pouvez créer en suivant les étapes décrites dans cette section.

En plus des paramètres du connecteur SharePoint Online décrits dans ce document, il existe des paramètres de configuration utilisés par tous les connecteurs Cloud Search. Pour plus d'informations, consultez l'article Paramètres de connecteur fournis par Google.

Systèmes d'exploitation compatibles

Le connecteur Cloud Search SharePoint Online est compatible avec les systèmes d'exploitation suivants :

  • Windows Server 2016
  • Ubuntu
  • Red Hat Enterprise Linux 5.0
  • SUSE Enterprise Linux 10 (64 bits)

Indexation de documents non publiés

Le connecteur Cloud Search SharePoint Online respecte toujours le paramètre "Visibilité de recherche" défini dans SharePoint (vous ne pouvez pas ignorer ce paramètre). Pour les brouillons de documents, l'indexation dépend des autorisations accordées au compte de l'utilisateur du connecteur. Si l'utilisateur dispose uniquement des autorisations "Lecture totale", le connecteur respecte tous les paramètres de visibilité des éléments brouillons définis dans SharePoint.

Mécanismes d'authentification compatibles

Le connecteur Cloud Search SharePoint Online est compatible avec l'authentification Live.

Limitations connues relatives au connecteur

  • L'instance de connecteur ne peut indexer le contenu que d'une seule collection de sites. Vous devez créer plusieurs instances de connecteur distinctes pour indexer plusieurs collections de sites.
  • Le nombre d'utilisateurs et de groupes uniques utilisés dans les LCA de chaque collection de sites a une incidence sur la mémoire utilisée.
  • La version actuelle du connecteur ne génère pas de notifications de suppression instantanées.
  • Le connecteur repose sur la réindexation du contenu pour identifier les suppressions dans le dépôt source. Pour le contenu précédemment indexé, la latence de détection des suppressions peut être supérieure à 4 heures.

Conditions préalables

Le connecteur Google Cloud Search SharePoint Online peut être installé sous Linux ou sous Windows. Avant de déployer le connecteur Google Cloud Search SharePoint Online, assurez-vous que vous disposez de la configuration requise suivante :

  • Environnement SharePoint Online
  • Java JRE 1.8 installé sur un ordinateur qui exécute le connecteur Google Cloud Search SharePoint Online
  • Informations G Suite requises pour établir des relations entre Google Cloud Search et la source de données :

    L'administrateur G Suite du domaine est généralement en mesure de vous fournir ces identifiants.

  • Compte d'utilisateur pour le connecteur, avec droits d'administrateur sur la collection de sites à indexer.

Procédure de déploiement

Pour déployer le connecteur Google Cloud Search SharePoint Online, suivez les étapes ci-dessous :

  1. Installer le logiciel du connecteur Google Cloud Search SharePoint Online
  2. Spécifier la configuration du connecteur SharePoint Online
  3. Configurer l'accès à la source de données Google Cloud Search
  4. Configurer l'accès à SharePoint Online
  5. Configurer le mappage d'identité SharePoint sur Google Cloud Search
  6. Configurer la compatibilité avec la génération de contenu HTML et les données structurées pour les éléments de liste SharePoint
  7. Configurer le mappage d'identité O365 sur Google Cloud Search
  8. Activer la journalisation

1. Installer le logiciel du connecteur Google Cloud Search SharePoint Online

Google fournit le logiciel d'installation du connecteur dans les fichiers suivants :

google-cloudsearch-sharepoint-connector-v1-0.0.2.zip
google-cloudsearch-o365-identity-connector-v1-0.0.2.zip

Téléchargez et extrayez le connecteur Microsoft SharePoint On-Prem et le connecteur d'identité Microsoft Office 365, puis enregistrez-les dans le répertoire de travail local où l'exécution aura lieu. Ce répertoire peut également contenir tous les fichiers nécessaires à l'exécution du connecteur, y compris le fichier de configuration et le fichier contenant la clé du compte de service.

2. Spécifier la configuration du connecteur SharePoint Online

Pour permettre au connecteur d'accéder correctement à SharePoint Online et d'indexer le contenu, vous devez d'abord créer son fichier de configuration. Vous pouvez contrôler le comportement et les attributs du connecteur SharePoint Online à l'aide de paramètres définis dans son fichier de configuration. Des paramètres configurables permettent de contrôler les éléments suivants :

  • Accès à une source de données
  • Accès à SharePoint Online

Pour créer un fichier de configuration :

  1. Ouvrez l'éditeur de texte de votre choix, puis ajoutez des paires clé=valeur au contenu du fichier comme expliqué dans les sections suivantes.
  2. Attribuez un nom au fichier de configuration et enregistrez-le. Google vous recommande de nommer ce fichier connector-config.properties pour pouvoir exécuter le connecteur via la ligne de commande sans aucun paramètre supplémentaire.

3. Configurer l'accès à la source de données Google Cloud Search

Les premiers paramètres à spécifier dans chaque fichier de configuration sont les paramètres d'accès à la source de données Cloud Search, comme indiqué dans le tableau suivant. En règle générale, vous avez besoin de l'ID de la source de données, de l'ID du compte de service et du chemin d'accès au fichier contenant la clé privée du compte de service pour configurer l'accès du connecteur à Cloud Search. Les étapes de configuration d'une source de données sont décrites dans l'article Ajouter une source de données pour les recherches.

Élément Paramètre
ID de la source de données api.sourceId=1234567890abcdef Obligatoire. ID de la source Google Cloud Search créée par l'administrateur G Suite.
Chemin d'accès au fichier contenant la clé privée du compte de service api.serviceAccountPrivateKeyFile=./PrivateKey.json Obligatoire. Fichier contenant la clé du compte de service Google Cloud Search pour l'accessibilité du connecteur Google Cloud Search SharePoint Online.
ID de la source d'identité api.identitySourceId=x0987654321 Obligatoire. ID de la source d'identité Cloud Search créée par l'administrateur G Suite.

4. Configurer l'accès à SharePoint Online

Pour permettre au connecteur d'accéder à SharePoint Online et d'en extraire des données pour l'indexation, vous devez d'abord configurer l'accès à SharePoint Online. Les paramètres suivants permettent d'ajouter des informations d'accès dans le fichier de configuration.

Élément Paramètre
Nom de domaine complet de la collection de sites SharePoint sharepoint.server=http://yoursharepoint.example.com/ Obligatoire. Si le nom de domaine n'est pas complet, vous devez définir le remplacement DNS sur l'hôte du connecteur.
Mode Collection de sites uniquement sharepoint.siteCollectionOnly=true Obligatoire. Pour SharePoint Online, définissez toujours ce paramètre sur true.
Nom d'utilisateur SharePoint sharepoint.username=username Obligatoire. Nom d'utilisateur du compte donnant accès à SharePoint Online.
Mot de passe SharePoint sharepoint.password=user_password Obligatoire. Mot de passe du compte donnant accès à SharePoint Online.
Mode d'authentification sharepoint.formsAuthenticationMode=LIVE Obligatoire. Pour SharePoint Online, définissez ce paramètre sur LIVE.
Type de déploiement sharepoint.deploymentType=ONLINE Obligatoire. Pour SharePoint Online, définissez ce paramètre sur ONLINE.

5. Configurer le mappage d'identité SharePoint sur Google Cloud Search

Google Cloud Search permet à ses clients d'appliquer des filtrages de liste de contrôle d'accès aux résultats de recherche. Ces listes de contrôle d'accès peuvent être définies à l'aide de comptes principaux Google et externes.

Le connecteur SharePoint Online est compatible avec les identités suivantes :

  • Utilisateurs Office 365/Azure AD
  • Groupes de sécurité Office 365/Azure AD
  • Groupes locaux SharePoint (ayant comme membres des utilisateurs et des groupes O365)

Pour appliquer les filtrages de sécurité appropriés au contenu SharePoint, vous devez également synchroniser les identités externes suivantes avec Google :

  • Synchronisez les groupes locaux SharePoint à l'aide du connecteur d'identité SharePoint.
  • Synchronisez les identités O365 à l'aide du connecteur d'identité O365.

Pour établir la compatibilité avec cette configuration, vous devez créer deux sources d'identité :

  • une source d'identité pour la synchronisation des utilisateurs et des groupes O365 ;
  • une source d'identité pour les groupes locaux SharePoint.
Élément Paramètre
ID de la source d'identité api.identitySourceId=1234567890abcdef ID de source d'identité pour la synchronisation des groupes locaux SharePoint.

Obligatoire. ID de source Google Cloud Search défini par l'administrateur G Suite, comme décrit dans l'article Ajouter une source de données pour les recherches.

Sources d'identité de référence api.referenceIdentitySources=defaultIdentitySource Obligatoire. Pour SharePoint Online, utilisez la valeur fixe defaultIdentitySource.
ID de source d'identité de référence api.referenceIdentitySource.defaultIdentitySource.id=112233abcd Obligatoire. ID de source d'identité pour la synchronisation des identités O365.

6. Configurer la compatibilité avec la génération de contenu HTML et les données structurées pour les éléments de liste SharePoint

Pour indexer des métadonnées supplémentaires pour les éléments de liste SharePoint, configurez le connecteur de sorte qu'il soit compatible avec la génération de contenu HTML et/ou les données structurées.

Génération de contenu HTML

Les paramètres présentés dans le tableau suivant permettent de configurer la génération de contenu HTML.

Élément Paramètre
Champ de titre du modèle HTML contentTemplate.sharePointItem.title=Title Champ SharePoint à utiliser comme "Titre" pour le code HTML généré.
Champs de qualité de recherche de contenu HTML élevée contentTemplate.sharePointItem.quality.high=highField1,highField2… Champs à inclure dans le code HTML généré en tant que champs de qualité élevée. La correspondance avec les termes de requête de recherche figurant dans ces champs sera classée à un rang plus élevé.
Champs de qualité de recherche de contenu HTML moyenne contentTemplate.sharePointItem.quality.medium=mediumField1, mediumField2… Champs à inclure dans le code HTML généré en tant que champs de qualité moyenne.
Champs de qualité de recherche de contenu HTML faible contentTemplate.sharePointItem.quality.low=lowField1, lowField2… Champs à inclure dans le code HTML généré en tant que champs de qualité inférieure.
Colonnes non mappées de contenu HTML contentTemplate.sharepointItem.unmappedColumnsMode=APPEND La valeur par défaut de ce paramètre est APPEND. S'il est défini sur IGNORE, le connecteur génère du code HTML uniquement à l'aide de colonnes mappées. Définissez-le sur APPEND pour inclure des champs non mappés (ne faisant pas partie des configurations élevée, moyenne et faible) dans le contenu HTML généré.

Compatibilité avec les données structurées

Si vous définissez le schéma de la source de données à l'aide des instructions suivantes, le connecteur renseignera les données structurées pour les éléments de liste SharePoint :

  • Le connecteur mappe les noms de type de contenu SharePoint sur les définitions d'objet correspondantes en normalisant le nom du type de contenu SharePoint selon les spécifications définies par l'API Cloud Search. Cette dernière accepte uniquement les caractères A à Z, a à z et 0 à 9 pour les définitions d'objet. Le connecteur normalise les noms de type de contenu en excluant les caractères non acceptés. Par exemple, les annonces de type de contenu sont mappées sur la définition d'objet "Communiqués", tandis que le type de contenu "Article d'actualités" correspond à "Articled'actualités".

  • Le connecteur mappe les noms de propriété SharePoint sur les définitions de propriété.

7. Configurer le mappage d'identité O365 sur Google Cloud Search

Pour appliquer les filtrages de sécurité appropriés au contenu SharePoint en fonction des identités O365, vous devez configurer le connecteur d'identité O365 inclus dans le package du connecteur SharePoint Online.

Obtenir des identifiants O365

Pour pouvoir utiliser le connecteur d'identité O365, vous devez lui fournir des identifiants appropriés lui permettant de lire les utilisateurs et les groupes du compte O365. Reportez-vous au portail O365 pour créer une application Azure Active Directory et définir les identifiants d'accès à l'application pour votre instance de connecteur. Vous recevrez les éléments suivants lors de la création des identifiants d'application 0365 :

  • ID de l'application
  • Locataire
  • Code secret du client

Configuration du connecteur

Élément Paramètre
ID de la source d'identité api.identitySourceId=1234567890abcdef Obligatoire. ID de source d'identité pour la synchronisation des identités O365.

ID de source Google Cloud Search défini par l'administrateur G Suite, comme décrit dans l'article Ajouter une source de données pour les recherches. Cette valeur doit correspondre à la configuration "defaultIdentitySource" dans le connecteur SharePoint Online.

ID de client Google api.customerId=c1b1d1e1 Obligatoire. ID de client associé à votre domaine Google.

Pour obtenir l'ID de client, suivez les instructions disponibles sur cette page.

ID d'application O365 o365.clientId=a63c6eb3-29e7-486...

Obligatoire. ID d'application pour la configuration de l'application O365.

Locataire O365 o365.clientId=a63c6eb3-29e7-486...

Obligatoire. Locataire pour votre compte O365.

Code secret du client O365 o365.clientSecret=raHJN15vRLBKs...

Obligatoire. Secret des identifiants issus de la configuration de l'application O365.

Journaux du connecteur

Créez un dossier nommé **logs** dans le répertoire contenant le binaire du connecteur.

Créez un fichier ASCII ou UTF-8 nommé logging.properties dans le même répertoire et ajoutez le contenu suivant :

handlers = java.util.logging.ConsoleHandler,java.util.logging.FileHandler
# Default log level
.level = INFO
# uncomment line below to increase logging level for O365 APIs
#com.google.enterprise.cloudsearch.o365.level=FINE

# uncomment line below to increase logging level to enable Google API traces
#com.google.api.client.http.level = FINE
java.util.logging.ConsoleHandler.level = INFO
java.util.logging.FileHandler.pattern=logs/connector-sharepoint.%g.log
java.util.logging.FileHandler.limit=10485760
java.util.logging.FileHandler.count=10
java.util.logging.FileHandler.formatter=java.util.logging.SimpleFormatter

Exécuter le connecteur d'identité O365

Pour exécuter le connecteur, lancez la commande ci-dessous avec cmd.exe sur la machine hôte :

java -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-o365-identity-connector-v-withlib.jar

8. Activer la journalisation

Créez un dossier nommé **logs** dans le répertoire contenant le binaire du connecteur.

Créez un fichier ASCII ou UTF-8 nommé logging.properties dans le même répertoire et ajoutez le contenu suivant :

handlers = java.util.logging.ConsoleHandler,java.util.logging.FileHandler
# Default log level
.level = INFO
# uncomment line below to increase logging level for SharePoint APIsa
#com.google.enterprise.cloudsearch.sharepoint.level=FINE

# uncomment line below to increase logging level to enable API trace
#com.google.api.client.http.level = FINE
java.util.logging.ConsoleHandler.level = INFO
java.util.logging.FileHandler.pattern=logs/connector-sharepoint.%g.log
java.util.logging.FileHandler.limit=10485760
java.util.logging.FileHandler.count=10
java.util.logging.FileHandler.formatter=java.util.logging.SimpleFormatter

Exemple de fichier de configuration

L'exemple de fichier de configuration suivant indique les paires clé/valeur des paramètres définissant le comportement d'un connecteur.

api.sourceId=08ef8becd116faa4546b8ca2c84b2879
api.serviceAccountPrivateKeyFile=service_account.json
api.identitySourceId=08ef8becd116faa475de26d9b291fed9

# Optional
contentTemplate.sharepointItem.title=Title
contentTemplate.sharepointItem.unmappedColumnsMode=APPEND

sharepoint.server=https://mydomain.onmicrosoft.com
sharepoint.siteCollectionOnly=true
sharepoint.username=admin@mydomain.onmicrosoft.com
sharepoint.password=pa$sw0rd
sharepoint.formsAuthenticationMode=LIVE
sharepoint.deploymentType=ONLINE

api.referenceIdentitySources=defaultIdentitySource
api.referenceIdentitySource.defaultIdentitySource.id=08ef8becd116faa5d3783f8c5a80e5aa

Exécuter le connecteur d'identité SharePoint Online

Pour permettre aux utilisateurs d'obtenir des résultats dans Cloud Search pour le contenu SharePoint auquel ils ont accès, vous devez d'abord mapper les comptes principaux d'O365 et de la collection de sites SharePoint sur les identités du service Google Cloud Identity. Cette synchronisation est effectuée via le connecteur d'identité O365 et le connecteur d'identité SharePoint Online. Une fois les utilisateurs et les groupes synchronisés par le connecteur O365, exécutez le connecteur d'identité SharePoint Online, comme expliqué ci-dessous, pour synchroniser les groupes de la collection de sites SharePoint.

Le connecteur d'identité utilise un fichier de configuration semblable à celui utilisé pour indexer le contenu. En voici un exemple :

api.customerId=C05d3djk8
api.serviceAccountPrivateKeyFile=service_account.json
api.identitySourceId=08ef8becd116faa475de26d9b291fed9

sharepoint.server=https://mydomain.onmicrosoft.com
sharepoint.siteCollectionOnly=true
sharepoint.username=admin@mydomain.onmicrosoft.com
sharepoint.password=pa$sw0rd
sharepoint.formsAuthenticationMode=LIVE
sharepoint.deploymentType=ONLINE

api.referenceIdentitySources=defaultIdentitySource
api.referenceIdentitySource.defaultIdentitySource.id=08ef8becd116faa5d3783f8c5a80e5aa

Notez l'ajout de la propriété api.customerId. Pour obtenir le l'ID de client customerId, suivez les instructions disponibles sur cette page.

Le fichier JAR utilisé pour indexer le contenu comprend également le connecteur d'identité. Pour l'exécuter, lancez la commande suivante dans le répertoire contenant le fichier de configuration :

java -Djava.util.logging.config.file=logging.properties -cp "google-cloudsearch-sharepoint-connector-v<version>-withlib.jar" com.google.enterprise.cloudsearch.sharepoint.SharePointIdentityConnector

Exécuter le connecteur SharePoint Online

Pour exécuter le connecteur SharePoint Online, lancez la commande ci-dessous avec cmd.exe sur la machine hôte :

java -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-sharepoint-connector-v-withlib.jar

Sujet avancé

Les informations contenues dans cette section portent sur la configuration avancée du connecteur SharePoint.

Ignorer la balise Content-Type pour les fichiers MSG Microsoft Outlook

Si le connecteur rencontre des fichiers MSG Outlook lors de l'exploration du contenu, il ignore la balise Content-Type de ces fichiers et les indexe en tant que application/vnd.ms-outlook.