Déployer WalkMe en utilisant un Snippet JavaScript

Download as PDF

Aperçu général

Le snippet WalkMe est ce qui permet à WalkMe de fonctionner sur votre site. Les pages ou les navigateurs qui comprennent le snippet peuvent accéder aux fichiers WalkMe publiés sur un serveur, permettant ainsi aux utilisateurs finaux d’accéder et de lire ce que vous créez pour eux dans l’éditeur WalkMe.

Le snippet est un élément de code JavaScript qui doit s’exécuter dans le navigateur d’un utilisateur final pour que WalkMe fonctionne sur la page. Chaque snippet est lié à un compte spécifique de l’éditeur WalkMe. Lorsque les éléments sont publiés dans l’éditeur WalkMe, ils sont accessibles aux utilisateurs finaux qui ont le snippet associé intégré à leur navigateur.

Environnements

Si vous disposez d’un site de test, vous pouvez choisir de publier d’abord vos éléments WalkMe sur ce site avant de les publier pour vos utilisateurs finaux sur votre site de production. Chaque environnement utilise un snippet différent, vous devrez donc le déployer séparément pour chacun d’entre eux.

Lorsque vous déployez le snippet de test pour votre site de test (sandbox ou staging), les éléments publiés dans l’environnement de test dans l’éditeur WalkMe apparaîtront sur votre site de test. De même, déployez le snippet de production pour votre site afin que les éléments publiés dans l’environnement de production apparaissent sur votre site de production.

IIl est également possible de créer des environnements personnalisés adaptés aux besoins de votre entreprise. En savoir plus sur les environnements personnalisés.

Où trouver le snippet

1. Sélectionnez Snippet dans le Menu de l’Éditeur
2. Sélectionnez un environnement
   • Chaque environnement a un code Snippet (fragment) légèrement différent. Si vous avez un site test/sandbox/staging, copiez le snippet (fragment) pour le test. Si vous souhaitez que le snippet (fragment) puisse publier pour vos utilisateurs finaux, copiez le snippet pour la production.
     
3. Copiez le code Snippet (fragment) :
   
4. Commutateur WalkMe Enabled
   • En cas d’urgence, si vous devez désactiver WalkMe dans n’importe quel environnement, vous n’aurez qu’à cliquer sur le commutateur WalkMe Enabled (activé). Une fois que le commutateur est en position OFF, le Snippet WalkMe sera désactivé.

Méthodes pour déployer le Snippet

Le déploiement est une tâche unique et simple effectuée par votre équipe informatique.

Il existe plusieurs façons de déployer le Snippet WalkMe. Le choix de la bonne solution dépend des spécificités de votre application :

1. Si vous avez accès au code HTML de votre application, collez le snippet dans la balise de tête de chaque page sur laquelle vous voulez que le contenu de WalkMe apparaisse
   • Lorsque le snippet est en place, WalkMe sera disponible pour tous les utilisateurs à chaque chargement de page. C’est l’option préférée pour les applications tournées vers l’extérieur, car les utilisateurs finaux n’ont pas besoin de télécharger ou d’installer quoi que ce soit pour que WalkMe apparaisse
   • Pour déployer le snippet, il suffit de copier le snippet depuis votre compte WalkMe Editor et de coller ce code entre les balises de tête de votre site web ou de votre application
   • Pour que WalkMe se charge dans une iframe, le snippet doit également être injecté dans l’iframe elle-même
2. Si vous n’avez pas accès au code HTML de votre application (ou si vous ne voulez pas le modifier pour une raison quelconque), insérez l’extrait en déployant en masse l’extension du navigateur. Plus d’informations ici.
3. Une troisième option pour accélérer le processus d’insertion du snippet (fragment) est l’utilisation de Google Tag Manager (gestionnaire d’étiquettes). En savoir plus ici.

Après avoir ajouté le Snippet, effectuez une publication des paramètres (Paramètres > Paramètres de publication) dans tous les environnements pertinents de l’éditeur WalkMe pour générer les fichiers et permettre à WalkMe de se charger correctement sur le site. Sans publication des paramètres, les fichiers WalkMe ne se chargeront pas correctement et une erreur 403 s’affichera dans les demandes de réseau du code.

Que prendre en compte lors de l’utilisation d’un snippet

• Le snippet WalkMe doit être placé dans le HTML de chaque page sur laquelle vous souhaitez que WalkMe charge
• WalkMe vérifie un ID d’utilisateur unique (UUID) lors du chargement de la page

• L’UUID n’est pas disponible tant que l’utilisateur n’est pas connecté. Si l’UUID souhaité n’est pas disponible, un ID de session généré aléatoirement sera créé.
• Si un contenu spécifique doit être créé sur la page d’identification, veuillez vérifier qu’il y a un identifiant de poste de chargement de la page complète afin que l’UUID puisse être capturé
• Pour les applications à une seule page : si WalkMe charge sur la page d’identification, il faudra une actualisation de la page après l’ouverture de session institutionnalisée pour s’assurer que l’UUID est en mesure de charger

Comment puis-je tester que le snippet fonctionne ?

Une fois que le snippet (fragment) est en place, vous serez en mesure de voir votre contenu publié depuis l’Éditeur. Pour tester le Snippet pour vous assurer qu’il est configuré correctement :

1. Ouvrez votre site
2. Faites un clic droit et sélectionnez Inspecter la page
3. Ouvrez la console
4. Saisissez la requête de texte suivante : _walkMe.getEnvId()
   • Cette commande retournera une valeur indiquant quel environnement s’est chargé :
     0 = Production
     1 =Aperçu
     2 = Lecture
     3 = Test
   • S’il revient indéfini, le Snippet n’est pas correctement configuré et vous pouvez contacter l’Assistance pour obtenir de l’aide