Les variables prédéfinies d'un projet Self Help


Chaque nouveau projet Self Help contient automatiquement une liste de variables génériques.

  • Ces variables permettent de récupérer des informations sur l'étape / la procédure en cours d'exécution, ainsi que sur l'utilisateur connecté. 
  • Elles peuvent être utilisées :

Exemple

Récupérer et afficher l'adresse e-mail de l'utilisateur qui exécute l'étape en cours ==> utiliser la variable prédéfinie executionContext.user.email

Remarques

  • Les variables prédéfinies sont fournies par EasyVista. Vous ne pouvez pas les modifier ni les supprimer.
  • Elles sont disponibles dans le dossier Librairie de chaque projet Self Help.
             Predefined variables list.png
  • Ne confondez pas les variables prédéfinies qui sont natives à tout projet Self Help avec les variables projets qui sont créées manuellement par chaque client en fonction de ses besoins pour son projet Self Help, ou livrées avec le modèle Projet standard.

Liste des variables

Variable Type de données Contenu

currentNode : Informations liées à l'étape en cours d'exécution

currentNode.automatic Booléen Nature de l'étape
  • Étape invisible : Sans interaction avec l'utilisateur
  • Étape visible
currentNode.id Texte Identifiant de l'étape
currentNode.name Texte Titre de l'étape
currentNode.resourcesTab Tableau Liste des ressources liées à l'étape (tableau indiquant l'identifiant, le nom et l'URL de chaque ressource)
currentNode.textId Texte Identifiant de la ressource Texte dans laquelle est stocké le contenu de l'étape
currentNode.type Texte Type d'étape (Action, Page de choix, ...)

executionContext : Informations liées à la procédure en cours d’exécution

executionContext.channel Texte Canal d'exécution de la procédure
  • PORTAL : procédure appelée dans le portail
  • APICONTENT : procédure appelée via l'API Contenu
  • MSTEAMS : procédure appelée via MS Teams
  • SERVICEBOTS : procédure appelée via un agent virtuel
  • AUTOMATIC : procédure appelée via l'API Portail
  • PREVIEW : procédure appelée en mode Test (le rédacteur génère un lien direct depuis le studio et clique sur Lancer la procédure)
  • DEBUG : procédure appelée en mode Debug
executionContext.contextId Texte Identifiant de la procédure
executionContext.country Chaîne de caractères figée Code du pays auquel est rattachée la langue d'exécution de la procédure (ex : FR, GB, ...)
executionContext.currentNodeTimeOnEnter Nombre entier Heure d’exécution de l'étape courante
executionContext.expertSessionId Texte Identifiant de session expert quand le rédacteur génère un lien direct depuis le studio et clique sur Lancer la procédure
executionContext.instanceId Texte Identifiant de la procédure
executionContext.isDebug Texte Mode d'exécution de la procédure
  • True : Lancement de la procédure en mode Debug
  • False : Exécution standard de la procédure (le rédacteur génère un lien direct depuis le studio et clique sur Lancer la procédure)
executionContext.isMobile Booléen Procédure lancée depuis un thème destiné à l'affichage sur mobile
  • True : Lancement de la procédure en mode Debug
  • False : Exécution standard de la procédure (le rédacteur génère un lien direct depuis le studio et clique sur Lancer la procédure)
executionContext.lang Chaîne de caractères figée Langue d'exécution de la procédure (ex : EN, FR)
executionContext.lastNodeDuration Nombre entier Heure de consultation de la dernière étape (= heure de fin d’exécution de la procédure)
executionContext.log Texte Contenu du rapport d'exécution

Note : Le rapport se crée au fur et à mesure du parcours de l'utilisateur dans la procédure. Il peut être paramétré étape par étape - Open url.png voir onglet Rapport du volet Description dans le studio en mode Édition

executionContext.referrer Texte URL dexécution de la procédure (lancée depuis un site, le portail, ...)
executionContext.sessionLess Booléen Accès à la procédure en s’identifiant / générant un lien direct
executionContext.startScenarioTime Nombre entier Heure de début de l’exécution de la procédure
executionContext.userAgent Texte Informations sur le navigateur sur lequel est déroulée la procédure
executionContext.userSessionId Texte Identifiant de session utilisateur dans le cas d’une connexion depuis le portail
executionContext.versionId Texte Identifiant de la version de la procédure en cours d'exécution

executionContext.user : Informations sur l'utilisateur qui exécute la procédure courante

executionContext.user.email Texte Adresse e-mail de l’utilisateur
executionContext.user.firstName Texte Prénom de l’utilisateur
executionContext.user.groups Tableau de texte Liste des groupes auxquels appartient l’utilisateur
executionContext.user.id Texte Identifiant de l’utilisateur
executionContext.user.lastName Texte Nom de l’utilisateur
executionContext.user.login Texte Login de l’utilisateur (saisi lors de l’identification)
executionContext.user.title Texte Civilité de l’identifiant (M / Mme / Mlle)

Autres variables

custom Texte Variable globale générique

Notes :

  • Variable vide par défaut.
  • Variable utilisée dans les versions antérieures à la version 2.6, pour lesquelles le dossier Librairie n'est pas créé automatiquement.
stopMessage Texte Variable dont le contenu s'affiche dans la colonne Message des statistiques disponibles dans le studio en mode Publication

Note : Variable vide par défaut.

Procédure : Comment afficher une variable dans une étape

Étape 1 : Affichage de l'étape de la procédure

1. Sélectionnez le projet Self Help dans l'arborescence du volet Explorateur.

2. Double-cliquez sur la procédure.
La procédure est affichée dans le volet Conception.

3. Cliquez sur l'étape affichée dans le diagramme.
Le contenu de l'étape est affiché dans le volet Description.

Étape 2 : Insertion de la variable générique dans le contenu de l'étape

2. Ouvrez l'arborescence du dossier Librairie > Variables prédéfinies via Tree expand icon.png.

3. Cliquez-glissez la variable depuis le volet Explorateur vers le contenu de l'étape dans le volet Description.
La variable est insérée sous la forme d'un cadre gris.
         Predefined variable insertion.png

Étape 3 : Test de l'affichage de la variable lors de l'exécution de la procédure

1. Cliquez sur Launch procedure dropdown list.png dans la barre d'outils puis sur Launch procedure icon.png Lancer la procédure.
L'étape est affichée dans votre navigateur internet.

2. Vérifiez que la variable a été remplacée par son contenu.
         Predefined variable insertion - Result.png

Tags:
Modifié par Utilisateur inconnu le 2020/03/24 13:21
Créé par Administrator XWiki le 2020/03/24 12:28

Raccourcis

L'actualité mensuelle
•  Newsletter

Tous les changements
•  Service Manager
•  Service Apps
•  Self Help

Glossaire

Powered by XWiki ©, EasyVista 2020