Snippet Smart Bot

Intégration

L'installation de la solution Smart Bot sur le site du client s'effectue en intégrant un snippet de code javascript au sein de la page souhaitée.

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('STBOTLoaded', function (e) {
    e.detail.init({
      kbId: 0,
      locale: 'fr',
      cookieOptin: false,
      relativeRestPath: 'xxx',
    });
  });
</script>
<script
  type="text/javascript"
  async
  src="https://assets.app.smart-tribune.com/smart-tribune/BOT/bot.main.js"
></script>

L'intégration du snippet de code ci-dessus suffit à permettre l'affichage partiel du BOT au sein de la page. Il faut également communiquer votre nom de domaine à votre point de contact Smart Tribune pour que nous autorisions le produit à s'afficher complètement sur votre environnement.

Attention, le lien vers bot.main.js est une démonstration du produit, le dossier smart-tribune dans l'url sera à remplacer par celui qui vous sera communiqué. L'url change complètement lors du passage de la pre-production (public) à la production. L'url complète est communiquée par votre point de contact Smart Tribune en charge de votre dossier.

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.

Environnement de pré-production

attention

Le chemin d'accès au fichier bot.main.js évolue en fonction de l'environnement : public ou production. Cette url diffère selon l'environnement sur lequel le dispositif doit être installé sur le site client. Il est d'usage d'utiliser PUBLIC pour la pré-production et d'utiliser PRODUCTION pour la production chez le client. Toutes ces informations sont communiquées par Smart Tribune après la phase de développement.

Script de PRODUCTION

<script
  type="text/javascript"
  async
  src="https://assets.app.smart-tribune.com/smart-tribune/BOT/bot.main.js"
></script>

Script de PRE-PRODUCTION

<script
  type="text/javascript"
  async
  src="https://assets.app.smart-tribune.com/smart-tribune/BOT/public/bot.main.js"
></script>

Liste des variables

Variable	Type	Condition	Exemple	Description
kbId	int	requis	kbId : 0	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. 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.
cookieOptin	bool	requis	cookieOptin : false	Elle permet d'empêcher ou non l'activation du cookie d'analyse des statistiques (valeur possible : true ou false). En désactivant cette fonctionnalité, il ne sera plus possible d'envoyer des informations dans le fournisseur d'analyse des statistiques pour votre FAQ. La valeur par défaut est false.
relativeRestPath	string	requis	relativeRestPath: "chemin/xx/..."	Cette variable de configuration permet de spécifier le chemin pour venir connecter le bot. Elle vous sera communiquée par l'Account Manager en charge de votre projet.

Les fonctions optionnelles

Utilisation la fonction show()

La fonction show() va vous permettre d'ouvrir la box.

Depuis un...	Description
bouton	Appelez simplement la fonction show() sur votre bouton.

<button onclick="detail.show()">Btn</button>

Depuis un...	Description
timer	Placez un setTimeout dans une balise <script> après initialisation de Smart Bot.

<script type="text/javascript">
  window.addEventListener('STBOTLoaded', function (e) {
    var stBot = e.detail;
    stBot.init({
      kbId: 0,
      locale: 'fr',
      cookieOptin: false,
      relativeRestPath: 'xxx',
    });
    setTimeout(() => {
      stBot.show();
    }, 3000);
  });
</script>
<script
  type="text/javascript"
  async
  src="https://assets.app.smart-tribune.com/smart-tribune/BOT/bot.main.js"
></script>

Depuis un...	Description
scroll	Placez un écouteur après initialisation de Smart Bot.

<script type="text/javascript">
  window.addEventListener('STBOTLoaded', function (e) {
    var stBot = e.detail;
    stBot.init({
      kbId: 0,
      locale: 'fr',
      cookieOptin: false,
      relativeRestPath: 'xxx',
    });
    window.addEventListener(
      'scroll',
      function (e) {
        stBot.show();
      },
      false,
    );
  });
</script>
<script
  type="text/javascript"
  async
  src="https://assets.app.smart-tribune.com/smart-tribune/BOT/bot.main.js"
></script>

Si vous avez besoin d'utiliser ces fonctions en dehors du script (sur un bouton par exemple), vous aurez besoin de stocker stBot à l'interieur de window qui est une variable globale :

<script type="text/javascript">
  window.addEventListener('STBOTLoaded', function (e) {
    window.stBot = e.detail;
    window.stBot.init({
      kbId: 0,
      locale: 'fr',
      cookieOptin: false,
      relativeRestPath: 'xxx',
    });
  });
</script>
<script
  type="text/javascript"
  async
  src="https://assets.app.smart-tribune.com/smart-tribune/BOT/bot.main.js"
></script>

Utilisation de la fonction hide()

La fonction hide() va vous permettre de fermer la box.

Depuis un...	Description
button	Appelez simplement la fonction hide() sur votre bouton.

<button onclick="window.stBot.hide()">Btn</button>

Utilisation de la fonction off()

La fonction off() va vous permettre de faire disparaitre la box de la page.

Depuis un...	Description
button	Appelez simplement la fonction off() sur votre bouton.

<button onclick="window.stBot.off()">Btn</button>

Utilisation de la fonction on()

La fonction on() va vous permettre de faire apparaitre la box sur la page.

Depuis un...	Description
bouton	Appelez simplement la fonction on() sur votre bouton.

<button onclick="window.stBot.on()">Btn</button>