Les propriétés exposées d'une application


Les propriétés exposées sont des paramètres passés dans l'URL d'une application. Elles s'appliquent à certains types de datasources de la catégorie Applications et permettent au lancement de l'application de :

  • limiter les enregistrements à afficher en appliquant un filtre particulier ;
  • afficher les enregistrements à partir d'une vue particulière ;
  • cibler la recherche sur des enregistrements précis de Service Manager ou d'une base de connaissance Self Help.

Exemples

Application ciblant la recherche des employés à partir de la valeur du login
    Open url.png  voir Cas d'utilisation

  • Les employés sont affichés via un widget Data Viewer pointant sur un datasource EasyVista.
  • Pour afficher uniquement les employés dont le login contient la valeur ALBERS, la propriété exposée SearchValue du datasource est passée en paramètre de l'URL.
             Apps - Exposed properties - Example Employee directory.png
     

Application renvoyant vers le détail d'un incident

  • Un e-mail automatique est envoyé à l'utilisateur avec un lien d'accès direct à la fiche Incident.
  • Pour passer le numéro d'incident, la propriété exposée SearchValue du datasource EasyVista est passée en paramètre de l'URL.
     

Application ciblant la recherche des informations dans une base de connaissance Self Help à partir du titre d'un ticket
    Open url.png  voir Cas d'utilisation

  • Un projet Self Help est implémenté dans l'application via un widget Self Help pointant vers un datasource EasyVista Self Help.
  • Pour permettre la recherche d'informations dans ce projet Self Help, la propriété exposée SearchValue du datasource EasyVista est passée en paramètre de l'URL.
  • L'application est liée à la fiche Incident de Service Manager.
  • La valeur à rechercher dans le datasource est déterminée dynamiquement dans Service Manager à partir du titre du ticket courant.
             Apps - Exposed properties - Example Self Help search.png

Remarques

  • La liste des objets possédant des propriétés exposées et les propriétés qu'ils peuvent utiliser sont définies par EasyVista. Vous ne pouvez pas en ajouter.
  • Les paramètres passés dans l'URL s'appliquent à tous les widgets de l'application pointant vers un datasource dont l'une des propriétés exposées est renseignée.
  • Prise en compte des propriétés exposées :
    • Les raccourcis tiennent compte des propriétés exposées des applications sur lesquelles ils pointent.
    • Le QR Code ne tient pas compte des propriétés exposées afin d'être valide en permanence.

Liste des propriétés exposées prédéfinies

Les objets peuvent posséder plusieurs propriétés exposées. 

  • Propriété Filter :
    • Permet d'appliquer un filtre particulier pour limiter les enregistrements
    • S'applique à un datasource EasyVista et un datasource EasyVista Discussions
    • Correspond à la propriété Content > Filter du datasource
    • La valeur recherchée correspond au filtre sélectionné dans la liste déroulante.
  • Propriété View :
    • Permet d'afficher les enregistrements à partir d'une vue particulière
    • S'applique à un datasource EasyVista
    • Correspond à la propriété Content > View du datasource
    • La valeur recherchée correspond à la vue sélectionnée dans la liste déroulante.
  • Propriété Search Value :
    • Permet de rechercher une valeur particulière parmi les enregistrements
    • S'applique à un datasource EasyVista, un datasource EasyVista Self Help, un datasource EasyVista Virtual Agent
    • Correspond à la propriété Search > Search Field du datasource
    • La valeur recherchée correspond à la propriété Search > Search Value du datasource.

Attention

  • Les alias associés aux paramètres ont uniquement des valeurs informatives. Ils n'ont pas d'incidence sur la recherche des valeurs.
  • La colonne à utiliser pour une propriété exposée Search Value doit être sélectionnée via la section Search du datasource  - Open url.png voir Cas d'utilisation
  • L'URL de l'application étant visible des utilisateurs, les paramètres sont passés sous la forme d'alias. Pour des raisons de sécurité, utilisez des alias anonymes, tels Param1, Param2.
  • Pour une application contextuelle implémentée dans une fiche Service Manager, une correspondance doit être faite entre la propriété exposée dans Service Apps et l'un des champs de la fiche Service Manager  - Open url.png voir Cas d'utilisation
    Seuls les champs de la fiche Service Manager possédant un alias et présents sur la représentation principale sont disponibles pour faire cette correspondance  - Open url.png voir Procédure si le champ souhaité n'est pas proposé

Bonnes pratiques

  • Pour retrouver l'identifiant d'un filtre ou d'une vue, sélectionnez le filtre ou la vue souhaité via la section Content du datasource. Automatiquement le GUID est reporté comme valeur par défaut dans les propriétés exposées.
  • Renommez les valeurs par défaut des alias des paramètres pour retrouver facilement leur fonction.

    exemple  Valeur par défaut SearchValue ==> Alias Phone

  • Génération de l'URL :
    • Par défaut, aucune propriété exposée n'est sélectionnée lorsque vous ouvrez la boîte de dialogue. Sélectionnez les propriétés souhaitées avant de générer l'URL.
    • Si vous modifiez l'une des propriétés exposées, regénérez l'URL pour prendre en compte les nouveaux critères.

Description de l'écran

         Apps - Exposed properties - Selected.png

Accès : via les propriétés générales Apps - Application properties icon.png ou via la boîte de dialogue de partage de l'application EVApps - GUI - Share icon.png

Note : À la première utilisation des propriétés exposées, la boîte de dialogue affiche l'ensemble des propriétés disponibles pour l'application. Cochez celles à passer dans l'URL pour définir leur valeur.

Widget name : Objet de l'application possédant des propriétés exposées.

Property name : Nom de la propriété exposée s'appliquant à l'objet  - Open url.png voir Liste

URL parameter alias : Alias permettant d'identifier la fonction du paramètre. 

  • Double-cliquez sur la cellule pour modifier le nom proposé par défaut.

Content/Value : Valeur du paramètre à passer dans l'URL.

  • Double-cliquez sur la cellule pour modifier la valeur.
    • Paramètres Filter / View : Identifiant (GUID) du filtre / vue.
    • Paramètre SearchValue : Chaîne de caractères se rapportant à la colonne sélectionnée dans la propriété Search > Search Field du datasource.
  • Les valeurs renseignées au niveau du datasource sont affichées comme valeur par défaut.

    exemple  Datasource DS EasyVista Employee utilisant la vue List ==> Valeur de la propriété exposée View = {42CEA486-C6CD-4146-AFB6-8830D59E0A86}

     

Add Properties : Permet d'ajouter de nouvelles propriétés exposées à partir de celles qui ne sont pas encore utilisées.

  • Cochez les propriétés que vous souhaitez passer dans l'URL pour définir leur valeur.
             Apps - Exposed properties - List.png
     

Delete Properties : Permet de supprimer de la liste les propriétés exposées sélectionnées. Celles-ci ne sont alors plus passées en paramètres dans l'URL, et redeviennent disponibles dans la boîte de dialogue Add properties.

Generate URL : Permet de générer l'URL à partir des propriétés exposées sélectionnées. Un lien hypertexte permet d'exécuter l'application dans un nouvel onglet du navigateur via l'URL contenant les propriétés exposées.

  • Les paramètres sont passés via les alias.
  • Les propriétés sont séparées par le caractère &.
https://....&param1=value1&param2=value2&param3=value3...

Cas d'utilisation

Cibler la recherche des employés à partir de la valeur du login

exemple  Générer une URL affichant la liste des employés de Service Manager dont le login contient la valeur ALBERS ==> Cela nécessite de définir la propriété exposée Search Value liée au datasource affichant les employés.

Étape 1 : Création du datasource pointant sur la liste des employés

1. Créez un datasource EasyVista, et nommez-le DS Easyvista Employee.

2. Renseignez les propriétés suivantes.

3. Renseignez les informations nécessaires aux propriétés exposées.

  • Propriété Search > Search Field : Login
     

Étape 2 : Création du widget affichant la liste des employés

1. Créez un widget Data Viewer.

2. Faites-le pointer sur le datasource DS Easyvista Employee, en mode Grid.
Tous les enregistrements du datasource sont affichés en mode Liste.
         Apps - Exposed properties - Example Employee directory - All.png
 

Étape 3 : Paramétrage de la propriété exposée Search Value du datasource

1. Ouvrez la boîte de dialogue Exposed properties via Apps - Application properties icon.png ou EVApps - GUI - Share icon.png, puis cliquez sur Exposed properties.

2. Ajoutez la propriété exposée Search Value du datasource permettant de rechercher une valeur particulière parmi les enregistrements.

  • Cliquez sur Add Properties.

         Apps - Exposed properties - Example Employee directory - Add properties.png

  • Sélectionnez la propriété Search Value du datasource DS Easyvista Employee, puis cliquez sur OK.
    La propriété exposée du datasource est ajoutée à la liste des propriétés déjà utilisées dans l'application.
             Apps - Exposed properties - Example Employee directory - Define properties.png

3. (optionnel) Modifiez la valeur par défaut SearchValue de l'alias pour donner un nom explicite à la propriété exposée.

  • Double-cliquez sur la cellule URL parameter alias.
  • Renommez l'alias de paramètre par Login.

4. Indiquez la valeur à rechercher dans le datasource.

  • Double-cliquez sur la cellule Content/Value.
  • Saisissez la valeur recherchée ALBERS.
     

Étape 4 : Lancement de l'application avec la propriété exposée

1. Cochez la propriété exposée Login du datasource DS Easyvista Employee.

2. Cliquez sur Generate URL.

L'URL d'accès direct à l'application est générée et affichée en bas de la boîte de dialogue.
         Apps - Exposed properties - Example Employee directory - Generate URL.png

3. Lancez l'application depuis cette URL.

  • Cliquez sur le lien Execute url application.

    ou 

  • Copiez le lien en cliquant dessus.
  • Exécutez-le via votre navigateur Internet.

La liste des employés dont le login contient la valeur ALBERS est affichée.
         Apps - Exposed properties - Example Employee directory - Search value applied.png

Rechercher dans Self Help des informations contextuelles au titre d'un ticket

    Open url.png voir Les fiches - Applications contextuelles > Cas d'utilisation

Tags:
Modifié par Utilisateur inconnu le 2021/02/19 18:19
Créé par Administrator XWiki le 2019/04/01 20:07

Raccourcis

L'actualité mensuelle
•  Newsletter

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

Powered by XWiki ©, EasyVista 2021