Skip to main content

Documentation technique Olfeo SaaS

Exploiter l'Agent

Modifier les paramètres de connexion à votre annuaire et les requêtes LDAP

L'onglet annuaire pilote les informations permettant à l'Agent de se connecter à votre annuaire ainsi que les requêtes LDAP qui seront effectuées pour récupérer les éléments de votre AD à synchroniser.

App1-Home.png

Après un changement, pensez à effectuer une vérification en utilisant la commande "Vérifier". Celle ci teste :

  1. la connexion à votre annuaire

  2. les requêtes paramétrées en retournant le nombre d'objets (groupes ou utilisateurs)concernés

Suite à une vérification, les résultats sont affichés

App1c-HomeCheck.png

N'oubliez pas de cliquer sur "Sauvegarder" pour enregistrer vos modifications.

Avertissement

[Versions antérieures à 1.8.5] En cas de changement du scope de vos requêtes, si ce scope est plus réduit que celui déjà synchronisé, pensez à lancer manuellement une synchronisation complète pour que la suppression des utilisateurs/groupes qui ne sont plus concernés soit prise en compte sans attendre la prochaine synchronisation complète.

Modifier les associations des propriétés synchronisées (Groupes, Utilisateurs)
1.8.5 et supérieures

La modification de ces associations peut être utile dans certains cas d'usages où les noms des champs de l'annuaire diffèrent du standard d'Active Directory, ou dans le cas où l'on souhaite synchroniser une propriété métier (un matricule par exemple) pour les utilisateurs afin de simplifier les recherches et l'exploitation au quotidien d'Olfeo SaaS

Pour modifier une association, sélectionnez dans la liste déroulante le champ de votre annuaire que vous souhaitez associer à l'une ou l'autre des propriétés des utilisateurs dans Olfeo SaaS.

App2-Users.png

NB : la propriété email est limitée au champs où la saisie d'un email valide est requise dans votre annuaire.

N'oubliez pas de cliquer sur "Sauvegarder" pour enregistrer vos modifications.

Avertissement

Une fois configurée, vous ne pouvez pas modifier la propriété identifiante (userName) utilisée pour l'identification de vos utilisateurs lors de l'authentification SAML (en savoir plus sur l'authentification).

Si vous souhaitez malgré tout modifier cette propriété, il vous faut créer un nouvel annuaire.

Changer d'annuaire de destination sur Olfeo SaaS

Vous pourrez modifier ici l'annuaire de destination sur Olfeo SaaS et le token de connexion associé.

App3-OlfeoDir.png

N'oubliez pas de cliquer sur "Sauvegarder" pour enregistrer vos modifications.

Lors de la sauvegarde, avant d'enregistrer les nouvelles valeurs, une vérification de l'existence de l'annuaire et de la validité du jeton est faite.

Attention

Si vous modifiez l'annuaire de destination sur Olfeo SaaS, pensez bien :

  • à ajuster votre configuration en conséquence sur votre compte Olfeo SaaS,

  • à lancer une synchronisation complète (les synchronisations incrémentales risquent sinon de ne pas donner un résultat satisfaisant).

Modifier la fréquence de synchronisation

La fréquence de synchronisation incrémentale est modifiable ici.

App4-Freq.png

N'oubliez pas de cliquer sur "Sauvegarder" pour enregistrer vos modifications.

Synchronisation incrémentale ?

Ce paramètre définit la fréquence de synchronisation incrémentale : seules les différences (nouveaux utilisateurs, changements de groupes, modifications sur vos utilisateurs, désactivation d'utilisateurs) identifiées entre le résultat de la requête faite sur votre annuaire Active Directory et le cache conservé par l'Agent au moment de la requête seront synchronisés vers Agent de synchronisation d'annuaires.

NB : les utilisateurs (ou les groupes) ayant été supprimés de votre Active Directory (ou ayant été exclus de la synchronisation suite à une modification des requêtes de filtre) ne sont supprimés de l'annuaire Olfeo SaaS que lors des synchronisations complètes.

Une synchronisation complète est réalisée au moins une fois sur une période d'une semaine.

Suite à la modification, si vous souhaitez lancer immédiatement une synchronisation incrémentale (ou complète), rendez vous sur l'onglet "Statut du service"

Lancer manuellement une synchronisation

Pour visualiser ces informations et lancer manuellement une synchronisation :

  1. Ouvrez l'interface de Agent de synchronisation d'annuaires

  2. Dans le volet de gauche, les informations relatives aux dernières synchronisations sont affichées (date de la dernière synchro complète et incrémentale.

    App1-HomeSyncInfo.png
  3. Cliquez sur la commande de synchronisation puis sélectionnez le type de synchronisation à effectuer ("Synchronisation complète" ou “Synchronisation incrémentale”).

    App1b-HomeSync.png
Consulter et comprendre les rapports de synchronisation
Où trouver le rapport de synchronisation

L’Agent de synchronisation d'annuaires génère automatiquement un rapport de synchronisation à chaque synchronisation manuelle ou automatique, partielle ou totale.

Ces rapports sont accessibles depuis C:\ProgramData\OlfeoAdSync\SyncReport

Interpréter un rapport de synchronisation

Le rapport de synchronisation est divisé en 3 parties:

  • Les informations de synchronisation Vous retrouverez ici les éléments génériques de la synchronisation:

    • Tenant url : Url de l’annuaire Olfeo SaaS

    • Synchronisation start : Date de démarrage de la synchronisation au format UTC

    • Synchronisation type : Type de synchronisation (Totale ou incrémentale)

    • Synchronisation time duration : La durée de lecture des informations de l’AD

    • Synchronisation result : Le résultat de la synchronisation

  • Les résultats de la synchronisation Le rapport détaille ici les deux étapes de la synchronisation à savoir la lecture des informations de l’AD et la synchronisation avec l’annuaire Olfeo SaaS:

    • AD Data : Les informations récupérées depuis l’AD

    • Sync to Olfeo: L’action de synchronisation effectuée vers l’annuaire Olfeo SaaS pour les utilisateurs et groupes avec leurs identifiants (Création, Modification, Suppression)

  • Le détail des erreurs
Le rapport vient donner le détail des erreurs de synchronisation:

    • Invalid AD Data: c’est la liste des utilisateurs ou groupe qui n’ont pas pu être récupérés depuis l’AD ainsi que la raison de l’erreur (format invalide, champ vide…)
Ces erreurs ne bloquent pas l’achèvement de la synchronisation mais les éléments seront omis

    • Invalid Synchronization to Olfeo: on liste ici le dernier utilisateur ou groupe pour avant lequel il y a eu une erreur bloquante de synchronisation. L’erreur peut venir d’un mauvais formatage des éléments ou d’un problème de connexion.

Gestion des rapports

Pour éviter la sturation accidentelle de l'espace disque du serveur, Agent de synchronisation d'annuaires supprime automatiquement les rapports de synchronisation de plus de 7j.

Activer le mode Debug

Par défaut, l'Agent de synchronisation d'annuaires journalise les erreurs qu'il rencontre dans son fonctionnement lorsqu'elles sont de niveau Avertissement, Erreur ou Critique.

Le mode Débug permet d'étendre cette journalisation en incluant les évènements de niveau Information et peut donc être très utile pour savoir précisément quelles actions sont réalisées par l'Agent de synchronisation d'annuaires(requêtes sur l'AD, requêtes vers l'Olfeo SaaS, erreurs éventuelles...) pour valider une modification ou pour résoudre des problèmes.

En mode debug :

  • L'Agent journalise alors tous les évènements de synchronisation dans le journal d'évènements de WIndows, rendez-vous dans l'Observateur d'évènements de WIndows pour consulter les journaux générés.

    Avertissement

    Le volume de journaux généré peut rapidement être important (selon la fréquence des synchronisations et le volume de données synchronisées) ! Veillez à surveiller la taille de disque et la vitesse de remplissage et à ne laisser ce mode activé que pour une période limitée.

  • Si vous exportez la configuration courante -(voir ci-dessous), l'export contiendra diverses informations relatives à l'environnement (version de l'OS, version du framework .Net etc.)

Pour activer le mode debug :

  1. Ouvrez l'interface de l' Agent de synchronisation d'annuaires

  2. Dans le volet de gauche, utiliser l'interrupteur pour activer ou désactiver le mode de debug.

App1-HomDebug.png
Exporter la configuration courante

L'export de la configuration courante est recommandé avant une mise à jour ou en cas de problème à soumettre à votre Support (dans ce cas, activez le mode Debug pour avoir un export exhaustif).

Pour exporter la configuration courante :

  1. Ouvrez l'interface de configuration de l'Agent de synchronisation d'annuaires

  2. Dans le volet de gauche, dans la section Configuration, utilisez la commande de téléchargement afin-de télécharger le fichier de configuration

    App1-HomeDL.png
  3. Choisissez ensuite l'emplacement pour sauvegarder votre configuration

Mettre à jour votre Agent de synchronisation

Pour vérifier si une mise à jour est disponible :

  1. Ouvrez l'interface de configuration de l'Agent de synchronisation d'annuaires

  2. Dans le volet de gauche, l'information de la version est visible. Si la chips est verte, votre agent est à jour, si elle est orange une nouvelle version est disponible.

  3. Si une mise à jour est disponible, rendez-vous dans votre interface d'administration de Olfeo SaaS à l'onglet "Synchronisation" de votre annuaire dans la section Configuration > Annuaires et téléchargez la dernière version disponible.

    Les release notes de Agent de synchronisation d'annuaires sont consultables ici

  4. Exportez la configuration actuelle de votre Agent

  5. Installez la mise à jour et importez votre configuration. N'oubliez pas de resaisir le mot de passe de connexion à votre AD

[<1.8.5] Modifier les propriétés synchronisées (Groupes, Utilisateurs)

Avertissement

Cette fonctionnalité a été profondément revue et améliorée à compter de la 1.8.5. Si l'interface de votre Agent de synchronisation présente l'écran ci-dessous, vous êtes dans une version antérieure et devez procéder à la mise à jour dès que possible.

Vous pouvez modifier -le cas échéant- les attributs des groupes et des utilisateurs synchronisés sur Olfeo SaaS en cochant ou décochant les attributs concernés.

modif_attributs_pre1-8.png

Soyez cependant vigilant(e), certaines propriétés peuvent avoir du sens selon votre contexte d'usage d'Olfeo SaaS.

N'oubliez pas de cliquer sur "Sauvegarder" pour enregistrer vos modifications.