Package de connexion Service Manager - Cas d'utilisation


À partir de : Service Manager versions Oxygène 2.0 et supérieures

  Pour vous aider à mettre en oeuvre ce cas d'utilisation, vous pouvez télécharger la documentation et le projet Exemple  - Open url.png voir Liste des fichiers à télécharger

Ce cas d'utilisation permet de créer un ticket dans Service Manager depuis une procédure Self Help. Il utilise le point de terminaison createTicket du package de connexion Service Manager.

Vue d'ensemble

La mise en oeuvre du cas d'utilisation s'effectue en plusieurs phases.

  • Phase 4 : Traitement du résultat du test de création du ticket (4)
    • Création d'une étape de type Page pour traiter le résultat Échec de la création du ticket (condition d'échec réalisée)
    • Création d'une étape de type Page pour traiter le résultat Succès de la création du ticket (condition d'échec non réalisée)

          Use case - Create a ticket procedure.png

Prérequis

1. Installez et configurez le package de connexion Service Manager.

     Open url.png voir Procédure

2. Créez un nouvelle procédure dans votre projet Self Help.

     Open url.png voir Comment créer une procédure Self Help

Phase 1 : Collecte des informations nécessaires à la création du ticket

     Open url.png voir Description du point de terminaison Créer un ticket

     Informations à collecter :

  • Code catalogue du ticket, qui peut être obtenu de 3 façons :
    • via la métadonnée Catégorie de la procédure ;
    • via le code du sujet du ticket correspondant à Sujet à qualifier ;
    • via un formulaire renseigné par l'utilisateur.
  • E-mail du demandeur / bénéficiaire, qui est l'e-mail de l’utilisateur connecté.
  • Description du ticket, obtenue via un formulaire renseigné par l'utilisateur.
     

Étape 1 : Création d'une étape Collecte des données

1. Insérez une étape de type Page dans votre procédure Self Help.

2. Nommez-la Collecte des données.

Étape 2 : Récupération du code catalogue du ticket

Note : Utilisez l'une des 3 méthodes ci-dessous pour récupérer le code catalogue.

1. Vous souhaitez utiliser la métadonnée Catégorie de la procédure.

  • Affichez les métadonnées de votre nouvelle procédure via la vue Propriétés.
  • Saisissez le code catalogue du nouveau ticket dans la métadonnée Catégorie.
             Use case - Create a ticket procedure - Category metadata.png
     

2. Vous souhaitez utiliser le code catalogue des tickets appliqué par défaut.

Notes

  • Le code catalogue par défaut est automatiquement appliqué lors de la création d'un ticket qui ne possède pas de code catalogue. 
  • Le package de connexion est livré avec le code catalogue par défaut 58, qui correspond au sujet Assistance Service Desk.
  • Vous pouvez modifier ce code par défaut via la macro ezvGetRequestCatCode dans la librairie du projet.

Modification du code catalogue par défaut

  • Ouvrez l'arborescence du package de connexion.
  • Allez sur la section Macros Projet du dossier Librairie.
  • Cliquez droit sur la macro ezvGetRequestCatCode et sélectionnez l'option Modifier.
             Use case - Create a ticket procedure - Update default ticket code.png
  • Saisissez le nouveau code catalogue par défaut.
  • Cliquez sur Terminer.
             Use case - Create a ticket procedure - Enter default ticket code.png
     

3. Vous souhaitez demander à l'utilisateur de renseigner le code catalogue, via un formulaire.

  • Créez un nouveau formulaire dans votre projet Self Help.
  • Nommez-le fTicketCreation.
  • Ajoutez un champ de type Liste de valeurs à choix unique.
             Use case - Create a ticket procedure - Create form for ticket code.png
  • Cliquez sur Créer la liste.
             Use case - Create a ticket procedure - Create form for ticket code - Enter values.png
  • Renseignez les valeurs des codes catalogue proposées à l'utilisateur.
    • Cliquez sur Ajouter Libellé/Valeur.
    • Saisissez la description du code catalogue dans le champ Libellé.
    • Saisissez la valeur du code catalogue dans le champ Valeur.
  • Cliquez sur Terminer.
     

Étape 3 : Récupération de l'e-mail du demandeur / bénéficiaire

L'e-mail est récupéré automatiquement à partir de l'e-mail de l’utilisateur connecté.

Attention : Assurez-vous que l'e-mail renseigné dans Self Help est identique à celui renseigné dans Service Manager.

Étape 4 : Récupération de la description du ticket

1. Créez un formulaire si vous n'en avez pas créé un pour la saisie du code catalogue. Nommez-le fTicketCreation.

ou

Utilisez le formulaire fTicketCreation créé pour la saisie du code catalogue.

2. Ajoutez une zone de saisie de texte multiligne permettant à l'utilisateur de décrire sa demande.

          Use case - Create a ticket procedure - Create form for ticket description.png

Étape 5 : Association du formulaire à l'étape Collecte des données

1. Cliquez-glissez le formulaire fTicketCreation du volet Explorateur vers l'étape Collecte des données.

Phase 2 : Appel du point de terminaison createTicket

Étape 1 : Création d'une étape pour appeler le point de terminaison

1. Insérez une étape de type Sous-procédure dans la procédure Self Help. 

2. Double-cliquez sur l'étape.
La fenêtre de propriétés de la procédure est ouverte.

3. Sélectionnez l'option Lier à un alias de procédure.
La liste des alias disponibles est affichée.
         Use case - Create a ticket procedure - Alias list.png

4. Sélectionnez l'alias du point de terminaison createTicket.

5. Cliquez sur Suivant.
La fenêtre de configuration des paramètres en entrée et en sortie est affichée.
         Use case - Create a ticket procedure - Alias parameters.png

Étape 2 : Saisie des valeurs des paramètres en entrée du point de terminaison

     Notes :

  • Renseignez les valeurs dans la colonne Valeurs d'entrée ==> Les champs sont affichés en vert.
  • Les paramètres sans correspondance sont ignorés.
  • Vous pouvez associer des valeurs brutes aux variables d'entrée.
    • Attention : Saisissez la valeur entre guillemets.
    • La valeur s'affiche en bleu.

      exemple  Example input parameters - pInRequestor via email.png

1. Renseignez la variable pInCatCode permettant de stocker le code catalogue, suivant la façon dont vous récupérez le code catalogue.

  • Vous avez renseigné le code catalogue via la métadonnée Catégorie de la procédure : laissez cette variable vide.
             Example input parameters - pInCatCode via metadata or catalog code.png
  • Vous avez utilisé le code catalogue par défaut : laissez cette variable vide.
    Attention : Assurez-vous que la métadonnée Catégorie de la procédure n'est pas renseignée.
             Example input parameters - pInCatCode via metadata or catalog code.png
  • Vous avez créé un formulaire pour la saisie du code catalogue par l’utilisateur : associez la variable de formulaire correspondante.
             Example input parameters - pInCatCode via formulaire.png

2. Renseignez les variables pInRequestor et pInRecepient permettant de stocker l'e-mail du demandeur / bénéficiaire.

  • Associez l’e-mail de l’utilisateur connecté à Self Help, qui est contenu dans la variable prédéfinie executionContext.user.email.

              Example input parameters - pInRequestor via variable.png
             Example input parameters - pInRecepient via variable.png

3. Renseignez la variable pInDescription permettant de stocker la description du ticket.

  • Associez la variable de formulaire correspondante.
             exemple  Example input parameters - pInDescription.png
     

Étape 3 : Saisie des valeurs des paramètres en sortie du point de terminaison

     Notes

  • Renseignez les valeurs dans la colonne Valeurs de sortie ==> Les champs sont affichés en rouge.
  • Les variables sont spécifiques à la procédure en cours.

1. Cochez le paramètre en sortie.

     Open url.png voir Description des paramètres en sortie

2. Saisissez le nom de la variable de sortie associée.

          Use case - Create a ticket procedure - Alias parameters - Output parameters.png

Étape 4 : Sauvegarde de l'étape appelant le point de terminaison

1. Cliquez sur Terminer.

L'étape est automatiquement renommée en createTicket.

Phase 3 : Définition des conditions de création du ticket

Étape 1 : Création d'une étape pour ajouter les conditions de création

1. Cliquez droit sur l'étape createTicket et sélectionnez Insérer une Étape > Insérer une Action avec conditions dans le menu contextuel.

2. Nommez l'étape Test.
2 branches sont créées.

  •  La branche du haut <Condition> traite la réponse à apporter en cas d'échec de la création du ticket.
  •  La branche du bas Par défaut traite la réponse à apporter en cas de succès de la création du ticket.

Étape 2 : Saisie de la condition d'échec de la création du ticket

1. Double-cliquez sur la zone <Condition> de la branche du haut.
La fenêtre de saisie de la condition est ouverte.

2. Renseignez la condition permettant d'indiquer qu'un échec de création est signalé par un statut négatif de la requête.

  • Sélectionnez la variable de sortie CreateStatus, qui stocke le statut de la requête.
  • Sélectionnez l'opérateur inférieur à et saisissez la valeur 0.
        Open url.png voir Description des codes retour

          Use case - Create a ticket procedure - Output parameters test.png

  • Cliquez sur Terminer.
    La condition est mise à jour.

Phase 4 : Traitement du résultat du test de création du ticket

Étape 1 : Traitement en cas d'échec

1. Insérez une étape de type Page à la suite de la branche du haut (branche qui est appelée en cas d'erreur).

2. Nommez l'étape Erreur.

3. Renseignez le contenu de l'étape.

Best Practice icon.png  Récupérez la valeur des variables en cliquant sur Insérer une expression et en saisissant le nom de la variable.
Use case - Create a ticket procedure - Display value of a variable.png

  • Saisissez un message indiquant à l'utilisateur qu'une erreur a eu lieu.
  • Affichez le message d'erreur via la variable de sortie CreateMessage.
    Attention : Le nom de la variable est sensible à la casse.
     
Self HelpExemple
Use case - Create a ticket procedure - Error.pngUse case - Create a ticket procedure - Error - Example.png

Étape 2 : Traitement en cas de succès

1. Insérez une étape de type Page à la suite de la branche du bas (branche qui est appelée en cas de succès).

2. Nommez l'étape Succès.

3. Renseignez le contenu de l'étape.

  • Saisissez un message indiquant à l'utilisateur que la procédure s'est déroulée correctement.
  • Affichez le numéro du nouveau ticket via la variable de sortie CreateResult.ID.
    Attention : Le nom de la variable est sensible à la casse.
     
Self HelpExemple
Use case - Create a ticket procedure - Success.pngUse case - Create a ticket procedure - Success - Example.png

Liste des fichiers à télécharger

Tags :
Powered by XWiki © EasyVista 2022