Package de connexion Service Manager


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

Ce package intègre un projet Self Help fournissant un ensemble de procédures, ou points de terminaison, pour échanger des informations avec Service Manager.

  • Les points de terminaison permettent à des utilisateurs métier de rechercher, créer, modifier et supprimer des objets dans Service Manager.
  • Ils sont basés sur les méthodes de l'API REST Service Manager.
  • Ils sont utilisables uniquement par le biais des procédures parentes situées dans n'importe quel autre projet Self Help du domaine  - Open url.png voir Utilisation avancée du package
     

Le package est livré sous la forme d'une archive à importer dans un domaine Self Help

  • Une fois installé, l'explorateur du Studio Desktop en mode Édition affiche un ensemble d'objets globaux, des procédures de bas niveau et les points de terminaison regroupés par objet métier : Biens, Employés, Tickets, ...

Remarques

  • Le package de connexion peut être utilisé avec tout projet Self Help.
  • Il n'est pas utilisable en lui-même. L'appel des points de terminaison par les procédures parentes se fait via un alias  - Open url.png voir Liste des points de terminaison
  • Chaque point de terminaison possède des paramètres en entrée / sortie  - Open url.png voir Utilisation avancée du package
  • Le nom de l'archive du package de connexion indique la date et l'environnement.
        exemple  EV|Integration|SM 201908|UAP

Composition du package de connexion

         Service Manager connexion package tree.png

(1) : Objets globaux utilisés pour configurer le package de connexion  - Open url.png voir Procédure

(2) : Procédures de bas niveau utilisées par les points de terminaison pour échanger des informations avec Service Manager.

(3) : Procédures d’aide et de test de configuration, ainsi que plusieurs cas d’usage utilisant les points de terminaison. Ce dossier peut être importé et utilisé séparément par n’importe quel projet du même domaine.

(4) : Ensemble de dossiers par objet métier (Actions, Biens, CI, ...), regroupant les points de terminaison utilisés pour échanger des informations avec les procédures parentes Service Manager situées dans tout autre projet du domaine. Chaque dossier comporte un sous-dossier Boîte à outils contenant des méthodes avancées de procédures métier utilisables sans configuration. 

Liste des points de terminaison du package de connexion

Actions

Procédure Alias Documentation REST Usage avancé
Modifier une action updateAction Open url.png   voir Méthode Open url.png   Paramètres en entrée / sortie
Terminer une action liée à un ticket finishAction Open url.png   voir Méthode
Voir une liste d'actions listActions Open url.png   voir Méthode
Boîte à outils
Liste des actions à valider d’un employé actionsToValidateByEmployee (méthode avancée) Open url.png   Paramètres en entrée / sortie
Voir la liste des actions d’un employé rattaché à un e-mail getActionsbyEmail (méthode avancée)

Biens

Note : Le terme Biens englobe les matériels / licences / contrats.

Procédure Alias Documentation REST Usage avancé
Créer un bien createAsset Open url.png   voir Méthode Open url.png   Paramètres en entrée / sortie
Modifier un bien updateAsset Open url.png   voir Méthode
Voir un bien getAsset Open url.png   voir Méthode
Voir une liste de biens listAssets Open url.png   voir Méthode
Boîte à outils
Rechercher des biens searchAssets (méthode avancée) Open url.png   Paramètres en entrée / sortie
Rechercher des biens par nom ou tag SearchAssetsByNameOrTags (méthode avancée)
Voir la liste des biens d’un employé listAssetsEmployee (méthode avancée)

Éléments de configuration (CI)

Procédure Alias Documentation REST Usage avancé
Créer un CI createCI Open url.png   voir Méthode Open url.png   Paramètres en entrée / sortie
Modifier un CI updateCI Open url.png   voir Méthode
Voir un CI getCI Open url.png   voir Méthode
Voir une liste de CI listCIs Open url.png   voir Méthode
Boîte à outils
Rechercher un CI searchCI (méthode avancée) Open url.png   Paramètres en entrée / sortie
Voir la liste des CI d’un employé getEmployeeCIByEmployeeID (méthode avancée)

Employés

Procédure Alias Documentation REST Usage avancé
Créer un employé createEmployee Open url.png   voir Méthode Open url.png   Paramètres en entrée / sortie
Modifier un employé updateEmployee Open url.png   voir Méthode
Voir un employé getEmployee Open url.png   voir Méthode
Voir une liste d’employés listEmployees Open url.png   voir Méthode
Boîte à outils
Rechercher des employés searchEmployees (méthode avancée) Open url.png   Paramètres en entrée / sortie
Rechercher un employé par e-mail ou nom searchEmployeeByEmailOrName (méthode avancée)
Voir la liste des employés d'une entité getEmployeesByDepartment (méthode avancée)
Voir un employé rattaché à un identifiant getEmployeeByID (méthode avancée)

Entités

Procédure Alias Documentation REST Usage avancé
Voir une entité getDepartment Open url.png   voir Méthode Open url.png   Paramètres en entrée / sortie
Voir une liste d’entités listDepartements Open url.png   voir Méthode
Boîte à outils
Rechercher des entités searchDepartments (méthode avancée) Open url.png   Paramètres en entrée / sortie

Erreurs connues

Procédure Alias Documentation REST Usage avancé
Voir une erreur connue getKnownError Open url.png   voir Méthode Open url.png   Paramètres en entrée / sortie
Voir une liste d’erreurs connues listKnownErrors Open url.png   voir Méthode
Boîte à outils
Rechercher des erreurs connues searchKnownErrors (méthode avancée) Open url.png   Paramètres en entrée / sortie

Localisations

Procédure Alias Documentation REST Usage avancé
Voir une localisation getLocation Open url.png   voir Méthode Open url.png   Paramètres en entrée / sortie
Voir une liste de localisations listLocations Open url.png   voir Méthode
Boîte à outils
Rechercher des localisations searchLocations (méthode avancée) Open url.png   Paramètres en entrée / sortie

Marques

Procédure Alias Documentation REST Usage avancé
Voir une marque getManufacturer Open url.png   voir Méthode Open url.png   Paramètres en entrée / sortie
Voir une liste de marques listManufacturers Open url.png   voir Méthode
Boîte à outils
Rechercher des marques searchManufacturers (méthode avancée) Open url.png   Paramètres en entrée / sortie

Problèmes

Procédure Alias Documentation REST Usage avancé
Voir un problème getProblems Open url.png   voir Méthode Open url.png   Paramètres en entrée / sortie
Voir une liste de problèmes listProblems Open url.png   voir Méthode
Boîte à outils
Rechercher des problèmes searchProblems (méthode avancée) Open url.png   Paramètres en entrée / sortie

Requête interne

Procédure Alias Documentation REST Usage avancé
Requête interne InternalQuery Open url.png   voir Méthode Open url.png   Paramètres en entrée / sortie

SLA

Procédure Alias Documentation REST Usage avancé
Voir un SLA getSla Open url.png   voir Méthode Open url.png   Paramètres en entrée / sortie
Voir une liste de SLA listSlas Open url.png   voir Méthode
Boîte à outils
Rechercher des SLA searchSlas (méthode avancée) Open url.png   Paramètres en entrée / sortie

Tickets

Note : Le terme Tickets englobe les incidents / demandes (service, changement, investissement).

Procédure Alias Documentation REST Usage avancé
Attacher un document à un ticket uploadDocuments Open url.png   voir Méthode Open url.png   Paramètres en entrée / sortie
Créer un ticket createTicket Open url.png   voir Méthode
Créer une action liée à un ticket createActionLinkToTicket Open url.png   voir Méthode
Créer une tâche pour un ticket createTaskLinkToTicket Open url.png   voir Méthode
Modifier un ticket updateTicket Open url.png   voir Méthode
Reprendre un ticket restartTicket Open url.png   voir Méthode
Suspendre un ticket suspendTicket Open url.png   voir Méthode
Terminer un ticket closeTicket Open url.png   voir Méthode
Voir la justification (comment) d’un ticket getComment Open url.png   voir Méthode
Voir un ticket getTicket Open url.png   voir Méthode
Voir une liste de tickets listTickets Open url.png   voir Méthode
Boîte à outils
Rechercher des tickets searchTickets (méthode avancée) Open url.png   Paramètres en entrée / sortie
Voir la liste des tickets d’un bien listTicketsAsset (méthode avancée)
Voir la liste des tickets d’un employé listTicketsEmployee (méthode avancée)
Voir le ticket rattaché à un identifiant getTicketByNumber (méthode avancée)
Voir la liste des tickets rattachés à un e-mail getTicketsbyEmail (méthode avancée)

Procédures

Comment installer le package de connexion Service Manager

Étape 1 : Installation du package de connexion

1. Téléchargez le fichier ci-dessous sur votre ordinateur.
         Download icon.png  Package de connexion Service Manager

2. Allez sur le Studio Desktop en mode Édition et importez le fichier dans un domaine.
Un nouveau projet Service Manager est créé. Toutes les procédures sont automatiquement ajoutées dans l'arborescence.

Étape 2 : Configuration du package de connexion

    Open url.png voir Procédure

Étape 3 : Test du package de connexion

1. Copiez le dossier Examples and Help dans le projet dédié.

2. Lancez quelques procédures pour vous assurer de leur bon fonctionnement.

Comment configurer le package de connexion Service Manager

1. Renseignez tous les paramètres de la variable oSetup indiqués ci-dessous, nécessaires pour effectuer un appel de l'API REST Service Manager.

  • La variable oSetup est située dans la librairie du projet, section Variables Projet.
  • Pour modifier un paramètre, clic droit > option Modifier.
        Configuration OSetup variable.png

auth : Objet contenant toutes les informations requises pour l'authentification.

  • password() : Mot de passe associé au compte.
  • type : Type d'authentification.
    • Sélectionnez la valeur BasicPre.
       

isActive : Permet d'autoriser les appels à l'API REST Service Manager

  • Sélectionnez la valeur true.
  • La valeur false bloque les appels.

url : Objet contenant tous les paramètres du serveur.

  • account : Segment de l'URL pour le compte de l'instance Service Manager à intégrer.
    • Renseignez le compte du serveur Service Manager à intégrer.
          exemple  Compte 50005 pour la Sandbox.
  • api : Segment de l'URL pour l'API de l'instance à intégrer.
    • Ne modifiez pas la valeur proposée.
  • segment : Segments de l'URL pour les objets métier.
    • Ne modifiez pas la valeur proposée.
  • server : Segment de l'URL pour le serveur à intégrer.
    • Renseignez l'adresse du serveur Service Manager à intégrer.
  • version : Segment de l'URL pour la version d'API de l'instance à intégrer.
    • Ne modifiez pas la valeur proposée.

Cas d'utilisation : Comment créer un ticket dans Service Manager

    Open url.png voir Procédure détaillée
         Use case - Create a ticket procedure.png

Liste des fichiers à télécharger

Tags:
Modifié par Christine Daussac le 2021/08/09 14:24
Créé par Administrator XWiki le 2019/12/10 17:21

Raccourcis

L'actualité mensuelle
•  Newsletter

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

Powered by XWiki ©, EasyVista 2021