Intégration personnalisée

Officevibe vous offre la possibilité de créer votre propre intégration entre votre Système RH et votre compte Officevibe. C'est la solution qui vous donne le plus de flexibilité quant à la gestion de vos utilisateurs et leur segmentation en échange du travail supplémentaire qui vous sera nécessaire pour la développer. C'est également la solution qui convient généralement le mieux pour gérer une organisation complexe. 

Préavis

  • Avant d'implémenter une intégration personnalisée, nous vous recommandons de contacter notre support à support@officevibe.com.
  • Si vous cherchez uniquement une façon d'exporter de l'information d'Officevibe, visitez api.officevibe.com.

L'intégration personnalisée est un script qui fonctionne dans votre infrastructure. Elle requiert 3 fichiers CSV qui seront interprétés par l'outil fourni, validez, puis envoyez vers Officevibe de façon sécuritaire par le biais de notre API. Cela vous permet de configurer vos membres, vos équipes et vos permissions dans un même processus. Même si elle peut être utilisée manuellement, l'intégration permet une automatisation du process de synchronisation des membres.  

Cette intégration nécessite des connaissances techniques incluant la programmation. La personne en charge devra également avoir le rôle d'administrateur au sein de votre compte Officevibe. 

Ci-dessous se trouve un guide pour vous aider à mettre en place cette intégration avec Officevibe.

Guide

Étape #1: Activer l'API.

Vous devez aller dans la section intégrations de l'écran d'administration. Sélectionner l'onglet Approvisionnement, puis l'option API. 

Cela vous mènera à un écran où vous pourrez générer une clé API à utiliser avec l'outil Enterprise Sync qui activera le point de terminaison de l'API pour la synchronisation et désactivera simultanément les autres méthodes de provisionnement actives.

Toute tentative de lancement de la synchronisation, même avec une clé d'API valide, sera rejetée si l'API n'est pas activé parmi les options d'approvisionnements.

 

Étape #2: Création et configuration de l'environnement

Afin de pouvoir exécuter le script, il est nécessairement d'avoir une instance Windows qui peut exécuter un script Powershell et d'atteindre le domaine app.officevibe.com sur le port sécurisé HTTP (443). Vous pouvez extraire OV_EnterpriseSyncTool.zip dans un dossier de votre choix, mais pour besoin de simplification, nous utiliserons C:\OV_Sync dans les exemples suivants.

Contenus du dossier compressé: 

  • config.json
  • sandbox-config.json
  • sync.ps1
  • prepare-package.ps1
  • Data
    • users.csv
    • groups-mapping.csv
    • groups.csv
  • Modules
    • PS.SyncSDK.psd1
    • PS.SyncSDK.psm1
Pour pouvoir utiliser Officevibe, tous les membres d'une organisation doivent être inclus dans le "document des utilisateurs" et pas seulement les membres d'équipe. Cela dit, en plus des membres d'équipe, ceci inclut les administrateurs et les gestionnaires exécutifs.

 

Étape #3: Configuration de l'outil Enterprise Script

La configuration du processus de synchronisation est faite au travers du fichier config.json à la racine du dossier (C:\OV_Sync\config.json). Les paramètres importants dans le fichier sont ceux-ci:

Sandbox Production

{
"Configuration": {
"ApiUrl": "https://sandbox.officevibe.com",
"ApiKey": "",
"UsersCsv": "./Data/users.csv",
"GroupsCsv": "./Data/groups.csv",
"MappingCsv": "./Data/groups-mapping.csv",
"SyncManagerEmail": "",
"InviteNewUsers": false
}
}

{
"Configuration": {
"ApiUrl": "https://app.officevibe.com",
"ApiKey": "",
"UsersCsv": "./Data/users.csv",
"GroupsCsv": "./Data/groups.csv",
"MappingCsv": "./Data/groups-mapping.csv",
"SyncManagerEmail": "",
"InviteNewUsers": false
}
}

 

a. "ApiUrl": Il s'agit de l'environnement Officevibe avec lequel vous souhaitez faire le sync. Pour l'environnement de production, utilisez app.officevibe.com. Pour l'environnement Sandbox utilisez sandbox.officevibe.com. 

b. "ApiKey": Il s'agit de la clé d'API que vous aurez généré à l'étape précédente. Si vous générez une nouvelle clé par la suite, vous devrez la remplacer ici également, Officevibe ne supportant qu'une seule clé active à la fois.

c. "SyncManagerEmail": Ce paramètre optionnel vous permet de spécifier une adresse courriel où une notification sera envoyé en cas d'erreur lors de la synchronisation. N'importe quel courriel peut être inscrit ici, il n'est pas nécessaire qu'il soit lié à un utilisateur Officevibe.

d. Les fichiers à synchroniser (davantage d'information à l'étape #4)

"UsersCsv": "./Data/users.csv",

"GroupsCsv": "./Data/groups.csv",

"MappingCsv": "./Data/groups-mapping.csv"

e. "InviteNewUsers": Si la valeur est true, les employés nouvellement créés lors de la synchronisation seront automatiquement invités à se joindre à Officevibe, au lieu de devoir les sélectionner manuellement au sein de l'application pour les inviter après leur création. Faites attention lorsque ce paramètre est à TRUE, car vous pourriez involontairement envoyé des centaines ou des milliers d'invitation sur vos premières synchronisations.

 

Étape #4: Exporter les données de votre SGRH vers les fichiers CSV

Vous pouvez maintenant consulter les 3 fichiers Sample joints à la fin de ce guide. Vos fichiers CSV devrait être séparés par des virgule, avec une ligne d'entête et encoder en UTF-8. Les entêtes doivent être identiques à celles fournies. Vous devrez générez ces fichiers à partir des données de votre SGRH et déposer vos fichiers résultants en accordance avec votre fichier de configuration.

Tous les IDs spécifiés ci-bas peuvent être alphanumérique. Ils doivent également être unique et persister dans le temps. Nous ne recommendons pas d'utiliser le nom du gestionnaire comme GroupID, car le gestionnaire de l'équipe pourrait être appelé à changer. 

Les fichiers contiennent les informations suivantes:

  • users.csv:  Ce fichier contiens les informations de base des membres. L'identifiant primaire au sein d'Officevibe est l'adresse courriel. C'est également ici que vous définirez le prénom, le nom de famille, le titre d'emploi et la langue des membres. Créer un nouveau membre est fait en ajoutant une ligne à ce fichier et le désactiver est fait en retirant la ligne correspondante. L'ID doit être unique et, après la première synchronisation, sera utilisé d'une synchronisation à l'autre pour identifier l'utilisateur. Cela permet de modifier l'adresse courriel d'un utilisateur par le biais de la synchronisation. Les valeurs possible pour la langue sont:
    • English
    • Français
    • Español
    • Português
    • Deutsche
si vous avez configuré les propriétés de vos membres dans Officevibe, vous pouvez remplir les valeurs des propriétés pour chaque membre en ajoutant des colonnes au fichier CSV, une pour chacun des segments. L'en-tête de colonne devra contenir le nom de la propriété, et chaque ligne indiquera la valeur pour chaque membre. Vous devrez configurer les propriétés dans Officevibe avant d'attribuer des valeurs via la plateforme d'intégration personnalisée et vous devrez vous assurer que les noms des propriétés correspondent parfaitement. Voici un guide sur la façon de créer des propriétés : Créer des propriétés.
  • groups.csv:  Ce fichier contient l'information de base pour une équipe, son nom et son ID. Cela permet de renommer l'équipe sans conséquence en préservant l'ID. Les sous-équipes doivent également être définies dans ce fichier puisqu'elles sont également des équipes.

Assurez-vous de créer les deux niveaux de segmentation dont auront besoin les gestionnaires: 

Relevants Directs de chaque gestionnaire (équipe du gestionnaire). 
La hierarchie complète d'un gestionnaire (fonction, département, unité)

  • groups-mapping.csv: Ce fichier permet de faire la correspondance entre les membres et les équipes, de même que leur permission en assignant les gestionnaires d'équipe. Il est également possible de créer une structure avec des sous-équipes dans ce fichier. Chaque ligne devrait correspondre à un membre et une équipe ou une équipe et une sous-équipe.

Nous recommendons de commencer avec le plus petit niveau de segmentation, c-à-d les relevants directs de chaque gestionnaires dans votre organisation. Ensuite, vous pouvez combiner ces équipes afin de répliquer votre structure organisationnelle. 

Un gestionnaire d'équipe aura automatiquement accès à toutes les sous-équipes. 
Structure_Inte_gration_Personalise_e_.jpg

Exemple

  • L'équipe de John inclut 3 membres. John est le gestionnaire d'équipe. 
  • L'équipe de Steph inclut 5 membres. 
  • Le département Customer Service inclut Équipe de Steph, Équipe de John, Équipe de Steve, Équipe de Charles, Équipe de Peter, Équipe d'Angie. Steph est la gestionnaire d'équipe. 

Steph aura automatiquement accès à toute sa hierarchie et aux sous-équipes. 

Le département Customer Service n'inclut aucun membre direct. Il inclut seulement des sous-équipes. 

 

Étape #5: Exécuter le script au travers d'une tâche programmée

Chaque sync écrasera le précédant. Il est important de pousser toute l'information à toutes les fois. Si un employé n'est pas le fichier il sera désactivé. Si une équipe n'est pas dans le fichier elle sera effacée. 

Lorsque vos fichiers sont prêts, vous pouvez ensuite les envoyer vers Officevibe. Pour essayer ce processus manuellement, vous vouvez simplement ouvrir une fenêtre Powershell et inscrire la ligne suivante à l'invite de commande. Assurez-vous d'être au même endroits que sync.ps1.  

 

Sandbox

./sync.ps1 -ConfigPath ./sandbox-config.json -Verbose -DumpFormattedRequest

Production:

./sync.ps1 -ConfigPath ./config.json -Verbose -DumpFormattedRequest

 

Comme vous pouvez le voir sur la ligne ci-dessus, il est possible d'ajouter les paramètres -Verbose et -DumpFormattedRequest à la commande pour aider au débuggage. Verbose permert de visualiser davantage d'informations à l'écran DumpFormattedRequest génère un fichier dump.json à la racine qui contient la requête JSON qui sera envoyée à l'API.

Une fois que vous aurez validé le processus manuellement, vous pourrez automatiser son exécution avec le Task Scheduler de Windows.

Comme vous avez le contrôle total sur l'exécution du script, vous pouvez l'exécuter quotidiennement, hebdomadairement, mensuellement ou seulement au besoin. Nous suggérons fortement de prévoir l'exécution les jours de semaine entre minuit et 5h00 EST, ou la fin de semaine. 

Le sscript ne retirera pas les membres avec un accès Administrateur. Vous devrez le faire manuellement dans l'application. 

 

Étape #6: Visualiser l'historique de synchronisation

Après l'exécution d'une synchronisation, vous pourrez visualiser son historique en allant dans l'onglet Approvisionnement de la section intégrations et en sélectionnèrent Voir l'historique. Il y a trois statuts possibles:

  1. Succès- La synchronisation s'est déroulée sans problème.
  2. Avertissement- La synchronisation s'est terminée correctement, par contre certaines informations ont probablement été ignorées - ex: une équipe existe déjà ou un courriel est déjà utilisé. Nous vous recommandons de contrevérifier ces avertissements avec le contenu de vos fichiers pour adresser leur cause.
  3. Erreur-  La synchronisation s'est arrêtée à cause d'une erreur interne. Typiquement, cela va arriver si une intégration expire ou s'il y a eu un problème lors du transfert. Dans ces cas, nous vous recommandons de contacter support@officevibe.com pour que nous puissons vous aider à résoudre la situation.
Partager