Snippet Guide Standalone

Cette solution a pour but d’afficher un guide depuis une base de connaissance (KbId) spécifiée.

Un guide est une typologie de contenu de base de connaissance (comme une question) où l’utilisateur peut trouver une réponse grâce à un arbre de décision.

Integration

HTML

Ajouter dans votre code HTML un conteneur avec un identifiant qui permettra d’afficher le widget à l’endroit de votre choix sur la page <div id="containerId_DE_VOTRE_CHOIX"></div>. Il faudra indiquer cet identifiant dans l’étape suivante (1.2) au niveau de containerId.

<div id="st-guide-standalone"></div>

JS

Intégrer le snippet Javascript juste avant la fermeture de la balise </body>. Le script Smart Tribune doit être chargé le plus en aval possible dans la chaîne de chargement des scripts afin d’éviter d’éventuels conflits avec les scripts présents sur la page client.

<script type="text/javascript">
  window.addEventListener('STGuideStandaloneLoaded', function (e) {
    e.detail.init({
      kbId: 2,
      locale: 'fr',
      slug: 'mon-guide',
      containerId: 'st-guide-standalone',
    });
  });
</script>
<script
  type="text/javascript"
  async
  src="https://assets.app.smart-tribune.com/smart-tribune/GuideStandalone/guidestandalone.main.js"
></script>

info

Les domaines faisant appel à la base de connaissances spécifiée devront être préalablement déclarés directement dans la configuration de la base de connaissances dans Smart Dashboard.

Liste des variables

Variable	Type	Condition	Exemple	Description
kbId	int	requis	kbId : 2	Variable spécifique à chaque client, elle correspond à l'identifiant (identifiant système) de la base de connaissances à utiliser. Celle-ci est disponible dans Smart Dashboard, l'interface d'administration de contenus. La base de connaissances intégrant déjà du contenu de test est identifié par la valeur : 2. Vous pouvez retrouver votre kbId sur la page d'accueil du Dashboard dans le cadre "Sélectionner une base de connaissances" puis "identifiant système".
locale	string	requis	locale : "fr"	Elle permet au client de spécifier dans quelle langue le dispositif doit être affiché. Cela est valable uniquement pour les bases de connaissances multilingues.
slug	string	requis	slug: "mon-guide"	Le slug du guide à afficher.
containerId	string	requis	containerId: "containerId_OF_YOUR_CHOICE"	Il s’agit de l’identifiant du container qui va afficher le widget.
customResponses	arr	optionnel	customResponses : [ "tag" ]	Cette variable permet de spécifier la contextualisation de la réponse personnalisée à appliquer en utilisant l'identifiant système des tags. Note : Cette variable est un tableau (array) de chaîne de caractères (string).