Métadonnées d'un projet Self Help


Les projets Self Help possèdent des propriétés définies au travers de métadonnées. Ces propriétés s'appliquent à l'ensemble des procédures du projet Self Help, et peuvent être :

  • des métadonnées standard créées par EasyVista.

    exemple  Nom de la procédure ; Catégorie de la procédure

  • des métadonnées spécifiques créées par chaque client selon ses besoins.

    exemple  Mots clés associés à une procédure destinée à un agent virtuel

     

Les métadonnées peuvent être exportées dans un fichier .csv, afin de les retravailler plus facilement sous Excel. Une fois mis à jour, le fichier est importé dans le projet Self Help via le menu Projets > Import d'attributs du Studio Online : automatiquement, chaque métadonnée est réattribuée aux procédures concernées.

Elles peuvent être remontées lors d'une extraction de statistiques. Elles permettent ainsi de marquer un lot de procédures ayant besoin d'une analyse statistique particulière.

Métadonnées particulières

  • Métadonnées localisables en fonction de la langue d'un projet Self Help multilingue
  • Métadonnées propres au déploiement d'un agent virtuel  - Open url.png voir Description
  • Métadonnée gérant l'accès aux procédures du portail client selon les groupes auxquels l'utilisateur appartient  - Open url.png voir Exemple et Procédure

Remarques

  • Les métadonnées sont accessibles via la vue Propriétés du Studio Desktop en mode Édition.
  • Les métadonnées standard définie par EasyVista ne peuvent pas être désactivées ni supprimées.
  • Les métadonnées désactivées d'un projet Self Help ne sont pas prises en compte au niveau des procédures, ni exportées.
  • Lors de la copie d'une procédure dans un autre projet Self Help, toutes les métadonnées du projet Self Help d'origine sont automatiquement copiées.
  • Pour supprimer une métadonnée ajoutée manuellement, il est nécessaire de la désactiver au préalable.
  • Les extractions de statistiques se font via les profils d'extraction.

Attention

  • Ne modifiez pas le projet Self Help pendant la phase de modification des métadonnées : l'ajout ou la suppression d’une procédure rendrait le fichier caduc.
  • N'ajoutez aucune ligne dans le fichier. De même, ne supprimez aucune ligne.
  • Ne modifiez pas la ligne d'entête.
  • Ne modifiez pas les colonnes A à I. Ces colonnes décrivent les informations générales de chaque procédure, et sont maintenues automatiquement par l'application Self Help.

Bonnes pratiques

  • Définissez des conventions d'écriture pour l'ensemble des métadonnées de votre projet Self Help et pour les valeurs qui ne sont pas localisables : noms écrits en minuscules, commençant par une majuscule, ...

    exemple  catégorie = ChangeCatalog ou change_catalog

  • Les champs Texte étant sensibles à la case, effectuez des copier / coller pour éviter les erreurs de frappe.
  • Effectuez l'export des métadonnées après avoir créé toutes les procédures du projet Self Help.

Description des métadonnées

Métadonnées spécifiques

        Specific metadata.png

Accès

  • mode Édition du Studio Desktop > sélection du projet Self Help dans l'arborescence du volet Explorateur > vue Propriétés > onglet Définition des métadonnées  - Open url.png voir Description
  • L'ajout d'une métadonnée s'effectue via Add metadata icon.png dans la barre d'outils de la vue Propriétés.
     

Clé : Identifiant unique de la métadonnée. Note : Lorsque la métadonnée est localisable, la clé est la même pour chaque langue.

Le nom et les valeurs par défaut doivent être localisés : Indique si un nom / valeur doit être saisi pour chaque langue (case cochée) ou si le même nom / valeur est appliqué quelle que soit la langue (case non cochée).

Nom : Nom de la métadonnée. Note : Une ligne est affichée pour chaque langue si la métadonnée est localisable.

S'applique à : Indique le type de composant auquel s'applique la métadonnée.

Type de données : Indique la nature de la métadonnée.

Valeur par défaut : Valeur par défaut de la métadonnée. Note : Une ligne est affichée pour chaque langue si la métadonnée est localisable.

Indexable : Indique si la métadonnée est indexable pour la recherche (valeur = 1), ou non (valeur = 0).

Save icon.png : Sauvegarde la métadonnée.

Activate metadata icon.png : Désactive la métadonnée. Celle-ci est automatiquement déplacée dans l'onglet Métadonnées désactivées.

Métadonnées standard

Ces métadonnées sont disponibles sur chaque procédure, quel que soit le projet Self Help.

    Open url.png voir Description
        Standard metadata.png

Export des métadonnées

Opération d'export

  • L'export s'effectue au niveau du projet Self Help.
    • Il peut être effectué par tout rédacteur ayant accès au domaine du projet Self Help.
    • Les métadonnées sont exportées dans la langue sélectionnée dans le volet Explorateur.
  • Nom du fichier exporté : <Nom_du_projet>_metadata_<langue>.csv

    exemple  Wiki_metadata_en_US.csv

  • Le fichier .csv comporte :
    • une ligne par procédure du projet Self Help ;
    • une colonne pour chaque métadonnée de procédure (propriétés générales et spécifiques), plus une colonne pour chaque métadonnée active du projet Self Help.

        Excel file example.png

Contenu du fichier d'export Excel

Les métadonnées sont regroupées suivant 3 types d'informations.

Métadonnée Description

Colonnes A à I : Informations sur les procédures

Attention : Ces colonnes ne doivent pas être modifiées dans le fichier.

Locale Langue de rédaction

exemple Anglais américain : en_US ; Français : fr_FR

Name Nom de la procédure
Description Texte descriptif de la procédure
Status Statut de la procédure dans le workflow de validation des contenus

exemple Brouillon, Approuvé

Alias Alias attribué à la procédure
Id Identifiant unique (GUID) de la procédure
ScenarioId Identifiant unique (GUID) du scénéria auquel appartient la procédure
Path Emplacement de la procédure dans l'arborescence du projet Self Help
EntryPoint Indique si la procédure est un point d'entrée, et donc exécutable par les utilisateurs (valeur 1), ou si elle n'est pas exécutable directement (valeur 0)

exemple

  • Procédure Quels sont mes biens ? : exécutable ==> valeur 1
  • Sous-procédure Recherche des biens : non exécutable ==> valeur 0

Colonnes J à O : Métadonnées générales des procédures

Note : Les valeurs de ces colonnes sont modifiables.

Category Catégorie à laquelle appartient la procédure
Category description Texte descriptif de la catégorie à laquelle appartient la procédure

Note : Donnée localisable par langue.

MetaDescription Balises méta Html associées à la procédure

Note : Donnée localisable par langue.

Sub Category Sous-catégorie à laquelle appartient la procédure
Sub Category description Description de la sous-catégorie

Note : Donnée localisable par langue.

Viewable Indique que la procédure doit être indexée ou non par le moteur de recherche

Colonnes P à S : Métadonnées spécifiques pour les procédures destinées à un agent virtuel

Note : Les valeurs de ces colonnes sont modifiables.

agentFlag Mode d'exécution de la procédure

Open url.png voir Description

exemple Welcome : Lancement de la procédure à l'ouverture du panneau conversationnel de l'agent virtuel

dialogFriendly Indique si la procédure doit s'ouvrir dans le panneau conversationnel de l'agent virtuel (valeur Vrai) ou dans le panneau latéral (valeur Faux)

Open url.png voir Description

intentAlt Liste des formulations de la demande à l'agent virtuel qui permettent d'ouvrir la procédure

Open url.png voir Description

exemple (demandes de l'utilisateur) Qu’est-ce que le logiciel X ? / A quoi sert le logiciel X ? / Que puis-je faire avec le logiciel X ?

tags Liste des mots clés associés à la procédure, affichés dans le nuage de tags (chaque mot clé renvoie vers une ou plusieurs nouvelles procédures Self Help de guidage ou d'aide)

Open url.png voir Description

Procédures

Comment gérer les métadonnées d'un projet Self Help

MetadataManagement_Procedure

Étape 1 : Export des métadonnées

1. Ouvrez le Studio Desktop en mode Édition.

2. Affichez le volet Explorateur.

3. Sélectionnez la langue de l'export, via Select language drop down.png dans la barre d'outils du volet Explorateur.

  • Pour traiter les métadonnées non localisables, sélectionnez la langue d'origine du projet Self Help.
  • Pour traiter les métadonnées localisables, sélectionnez la première langue du projet Self Help. Vous devrez ensuite répéter les mêmes actions pour chacune des langues du projet Self Help.

4. Cliquez droit sur le projet Self Help dans l'arborescence et sélectionnez l'option Exporter > Exporter les métadonnées.

5. Sauvegardez le fichier dans un répertoire.

  • Les métadonnées sont exportées dans un fichier au format .csv, dans la langue sélectionnée.
    Excel file example.png
  • Le nom du fichier indique le nom du projet Self Help et la langue utilisée.

    exemple  Wiki_metadata_fr_FR  ==> projet Wiki en langue française

 

Étape 2 : Ajustement des métadonnées dans le fichier .csv

Note : Le fichier .csv contient les métadonnées pour une langue donnée.

1. Ouvrez le fichier .csv dans Excel.

2. Effectuez les corrections nécessaires.

3. Sauvegardez le fichier au format .csv.

Étape 3 : Import des métadonnées dans le projet Self Help

Note : L'import s'effectue automatiquement dans la langue du fichier .csv.

1. Ouvrez le Studio Online.

2. Allez sur le menu Projets > Import d'attributs.

3. Cliquez sur + Importer des attributs.

4. Sélectionnez le fichier .csv et cliquez sur Importer.

  • Une tâche en cours apparaît.
  • Une fois la tâche terminée, le statut indique si l'import s'est déroulé correctement, ou non.

5. Corrigez le fichier si le statut indique Error. Relancez ensuite l'import.
         Open url.png voir Gestion des erreurs

Étape 4 : Contrôle de la prise en compte des nouvelles métadonnées

1. Cliquez sur le nom du fichier importé et vérifiez le nombre de lignes traitées.

2. Ouvrez le Studio Desktop en mode Édition.

  • Ouvrez le projet Self Help.
  • Affichez le volet Propriétés.
  • Vérifiez que les métadonnées modifiées ont bien été réattribuées à l'ensemble des procédures concernées du projet Self Help.
  • Les métadonnées non localisables sont réattribuées aux procédures sans tenir compte de la langue.
  • Les métadonnées localisables sont réattribuées aux procédures dans la langue du fichier .csv.

Étape 5 (optionnelle) : Traitement des métadonnées localisables pour un projet Self Help multilingue

1. Sélectionnez chacune des langues du projet Self Help, via Select language drop down.png dans le volet Explorateur.

2. Répétez les étapes 1, 2, 3.

EndMetadataManagement_Procedure

Comment filtrer les procédures du portail client selon les groupes

FilterProceduresViaGroups

    Open url.png voir Exemple

Étape 1 : Ajout d'une métadonnée dédiée au niveau du projet Self Help associé au portail client

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

2. Cliquez sur la vue Propriétés.
Les propriétés du projet Self Help sont affichées.

3. Cliquez sur l'onglet Définition des métadonnées.

4. Cliquez sur Add metadata icon.png dans la barre d'outils pour créer une nouvelle métadonnée.

5. Renseignez la nouvelle métadonnée authorizedGroups.
         Add authorizedGroups metadata - To project.png

Étape 2 : Ajout des groupes d'utilisateurs autorisés au niveau de chaque procédure

1. Ouvrez l'arborescence du projet Self Help via Tree expand icon.png.

2. Sélectionnez la procédure à filtrer selon les groupes dans le volet Explorateur.

3. Cliquez sur la vue Propriétés.
Les propriétés de la procédure sont affichées. La nouvelle métadonnée authorizedGroups est affichée en bas de la liste.

4. Renseignez les groupes autorisés à accéder à la procédure dans la propriété authorizedGroups.
Notes

  • Séparez chaque groupe par l'un des caractères , ; | /.
  • Vous pouvez utiliser la fonction de gestion des attributs.

         Add authorizedGroups metadata - To procedure.png

5. Répétez les mêmes actions pour chaque procédure à filtrer selon les groupes.

Étape 3 : Test du filtrage des informations selon les groupes

    Open url.png voir Exemple : Filtrer les procédures du portail client

1. Allez sur le portail client.

2. Cochez l'un des groupes auxquels vous avez accès.
         Authorized groups list.png

3. Vérifiez que seules les procédures associées à ce groupe sont disponibles.

Tags:
Modifié par Christine Daussac le 2021/06/23 13:36
Créé par Administrator XWiki le 2020/01/17 15:48

Raccourcis

L'actualité mensuelle
•  Newsletter

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

Powered by XWiki ©, EasyVista 2021