Les vues


Definition

Une vue permet de consulter des données et d'agir sur la présentation des informations (regroupement des données, mise en page).

EndDefinition
  • Elle est bâtie sur une requête parent permettant de travailler sur un ensemble d'informations homogènes des bases de données.
  • Elle peut contenir des ruptures (i.e. des critères de regroupement).
    • Les données sont regroupées et triées par niveaux agissant comme une hiérarchie de filtres.
    • Les informations finales de la vue sont affichées sous forme d'une grille (une ligne par enregistrement).
  • Elle peut contenir des alertes graphiques permettant la mise en évidence d'un champ lorsque sa valeur répond à certaines conditions  - Open url.png voir Exemple
  • Elle peut utiliser le service Google Maps de géolocalisation permettant de positionner des marqueurs Google map icon.png sur une carte à partir d'éléments informatifs de l'adresse (libellé, adresse, ville, pays, ...).

Nature des vues

Vues positionnées sur une grille en mode Liste

  • Eles fonctionnent au travers des entrées de menu.

    exemple  Vue Matériels par localisation rattachée à l'entrée de menu Inventaire des matériels  - Open url.png voir Exemple détaillé

  • Elles sont accessibles aux utilisateurs via la liste déroulante Vue du bandeau d'options.
        View via list.png
     

Vues rattachées aux alertes et aux reportings

  • Elles font partie intégrante de l'objet et ne peuvent pas être utilisées hors de celui-ci.
  • Elles n'apparaissent pas dans les vues positionnées sur une grille en mode Liste, ni sur les autres alertes et reportings.

    exemple  Vue du reporting Nb d'incidents en retard cette semaine

Exemples

1. La vue Matériels est rattachée à l'entrée de menu Inventaire des matériels (vue positionnée sur une grille en mode Liste). Elle est définie avec les critères suivants :

  • 2 niveaux de rupture : Modèle > Localisation (dernier niveau)
  • 3 informations finales à afficher : Catégorie ; Matériel ; Statut

Comment s'effectue la navigation dans la vue ? (fonctionnalité de drill down)

  • Sélection de la vue ==> affichage du 1er niveau de rupture = tous les modèles
             View - Final presentation - drilldown level 1.png
  • Sélection d'un modèle ==> affichage du 2ème niveau de rupture = toutes les localisations dans lesquelles le modèle est disponible
             View - Final presentation - drilldown level 2.png
  • Sélection d'une localisation de dernier niveau ==> affichage des informations finales sous forme d'une grille = tous les matériels rattachés au modèle disponible dans la localisation
     

Représentation finale de la vue (dernier niveau de rupture - mode Liste)
         View - Final presentation without visual alerts.png


2. Des alertes graphiques sont définies sur le champ Statut :

  • Alerte pour le statut En panne :
         condition = En panne  ;  police = Arial  ;  style = Bold  ;  couleur de la pastille = rouge Red bullet.png
  • Alerte pour le statut En stock :
         condition = En stock  ;  police = Arial  ;  style = Normal  ;  couleur de la pastille = vert Green bullet.png

Représentation finale de la vue : Des pastilles de couleur sont affichées devant chaque statut répondant aux conditions
         View - Final presentation with visual alerts.png

Remarques

  • Droits suivant la nature de la vue :
    • Vues positionnées sur une grille en mode Liste :
      • Seul un profil ayant les droits d'édition des vues peut créer / modifier ces vues  - Open url.png voir Profils utilisateurs > Droits d'édition et d'affichage
      • Les droits d'édition des vues sont attribués pour l'ensemble des menus.
    • Vues rattachées aux alertes et aux reportings :
      • La création / modification de ces vues est autorisée sans condition de droits.
  • Des champs peuvent être ajoutés manuellement à la requête parent d'une vue (quelle que soit sa nature), sous réserve de disposer des droits d'édition des affichages  - Open url.png voir Profils utilisateurs > Droits d'édition et d'affichage
    • Les champs sont affichés sous leur nom d'alias (ou nom logique).
    • Si l'alias n'est pas renseigné, le nom physique du champ est affiché.

      exemple  

      • Nom d'alias : Téléphone  ;  Nom physique : PHONE_NUMBER
      • Nom d'alias : N° de série  ;  Nom physique : AM_ASSET.SERIAL_NUMBER
  • Vues positionnées sur une grille en mode Liste :
    • Chaque entrée de menu possède une vue Liste : elle permet de visualiser la totalité des enregistrements sans rupture.
    • Chaque vue possède un mode d'affichage par défaut.
    • Les vues avec ruptures peuvent être affichées sous forme de graphiques via la liste déroulante Affichage accolée à la liste Vue.
          View via list - Display tools.png
    • La mise en forme via des alertes graphiques n'est pas visible sur les impressions.
    • Pour les champs arborescents (ex. : Localisation, Entité), seul le dernier niveau peut être défini comme niveau de rupture.

Attention

  • Ne confondez pas les vues SQL (utilisées comme des tables virtuelles au niveau des requêtes parents pour ajouter des champs) avec les vues Service Manager.

Bonnes pratiques

  • Pour qu'un regroupement ait un sens, sélectionnez comme niveaux de rupture des champs susceptibles de fédérer plus d'une valeur.

    exemple  Utiliser le code matériel comme rupture sur une liste d'équipements a peu de sens puisqu'il s'agit d'un code unique

  • Nom de la vue :
    • Donnez un nom "parlant" à la vue permettant de repérer facilement la hiérarchie des niveaux de rupture.
    • Demandez la génération automatique du nom après avoir défini les niveaux de rupture.
    • Lorsque vous modifiez les niveaux, modifiez le nom de la vue ou régénérez-le de façon automatique.
  • Alertes graphiques :* Utilisez les polices les plus courantes (Arial, Courrier, Verdana, Times) du fait de la grande disparité d’affichage des navigateurs Internet.

    • Dans les conditions :
      • Saisissez les valeurs exactes des champs, en respectant la casse et les accents.
      • Si la valeur contient un tiret, encadrez-la d'apostrophes.

        exemple  Condition sur la priorité : '1 - Haute'

    • Dans un contexte multilingue, définissez autant d'alertes qu'il y a de valeurs possibles pour le champ selon la langue utilisée.

      exemple  Champ Statut : définition des valeurs Out of order (EN) et En panne (FR) au sein d'une même alerte

Spécificités des versions 2016 et antérieures

L'éditeur de vue des versions 2016 et antérieures présente certaines différences.

  • Vues positionnées sur une grille en mode Liste : Les droits d'édition sont accordés par profil au niveau du module auquel est rattachée l'entrée de menu utilisant la vue  - Open url.png voir Profils utilisateur

Accès

  • Vues positionnées sur une grille en mode Liste : sur tous les écrans en mode Liste, option Éditer la vue Edit icon.png en bas de la liste déroulante Vue du bandeau d'options (Note : Sous réserve de disposer des droits d'édition des vues)
             Edit rights - View.png
  • Vues rattachées aux alertes et aux reportings : via la fiche de l'objet (Note : Sans condition de droits)

Description des écrans

          View.png

(1) Barre d'outils

Add icon.png : Crée une nouvelle vue.

Save icon.png : Sauvegarde la vue.

Duplicate icon.png : Duplique la vue et la sauvegarde sous un autre nom. Toute la présentation de la vue est dupliquée.

Trash icon.png : Supprime la vue.

Nom de la vue : Libellé identifiant la vue. 

  • View - Multilingual labels icon.png : Saisie manuelle des libellés multilingues du nom de la vue.
  • Generate name icon.png : Génération automatique du nom d'après la hiérarchie des niveaux de rupture, à partir des règles de nommage suivantes :
    • Vue sans rupture ==> Liste
    • Vue avec un seul niveau de rupture ==> Nom de la rupture
    • Vue avec plusieurs niveaux de rupture ==> Concaténation des noms de rupture séparés par des virgules (ex. : Marque, Modèle)

Vue par défaut : Indique si la la vue est celle proposée par défaut lorsqu'une entrée de menu est sélectionnée (case cochée) ou non (case non cochée)
    exemple  Vue Localisation pour l'entrée de menu Inventaire des matériels

Modes d'affichage (Note : Uniquement pour une vue avec ruptures) : Liste de tous les modes d’affichage des données définis pour l'entrée de menu. Le mode affiché est celui appliqué par défaut lorsque la vue est sélectionnée : secteurs, histogrammes, ...

Password close icon.png : Définit les droits de visualisation de la vue par profil.

Vues existantes : Liste de toutes les vues définies pour l'entrée de menu. Pour afficher l'une d'entre elles, sélectionnez-la dans la liste déroulante et cliquez sur Select ok icon.png.

 

(2) Champs disponibles : Liste des champs issus de la requête parent associée à la vue, et des éventuels champs supplémentaires ajoutés manuellement, qui ne sont pas placés sur la vue.

(3) Prévisualisation : Liste des champs utilisés au niveau de la vue.

  • Cliquez-glissez les champs pour les basculer de la liste Champs disponibles vers la section Drilldown ou la section Mode Liste.
  • Section Drilldown : Liste des champs définissant la hiérarchie des niveaux de rupture.
    Note : La fonctionnalité de drill down permet de zoomer sur chaque niveau de rupture de la vue, jusqu'au détail de l'information finale.

    exemple  Affichage par Statut, puis Marque, puis Modèle, puis Matériel (dernier niveau)

    • La section est accessible uniquement après avoir positionné un champ dans la section Mode Liste.
    • Les niveaux peuvent être ordonnés via un cliquer-glisser des champs à l'intérieur de la section Drilldown.
      • Le champ en haut de liste définit le niveau le plus haut. 
      • Le champ en bas de liste définit le dernier niveau. 
    • Si aucun niveau n'est défini, la vue est de type Liste.
    • Pour les champs arborescents (ex. : Localisation, Entité), seul le dernier niveau peut être défini comme niveau de rupture.
       
  • Section Mode Liste : Liste des champs identifiant les colonnes de la représentation finale de la vue.
    • Les colonnes peuvent être ordonnées via un cliquer-glisser des champs à l'intérieur de la section Mode Liste.
  • Tools icon.png en regard d'un champ : Permet de définir une mise en forme particulière sur la représentation finale de la vue lorsque la valeur du champ répond à certaines conditions  - Open url.png voir Exemple et Description

Configuration de l'affichage d'un champ

Notes

  • Le nom du champ configuré est affiché dans la barre de titre.
  • Des options supplémentaires sont affichées suivant la nature du champ sélectionné (champ de type Date, champ arborescent, ...)  - Open url.png voir Procédure

          View - Alert.png

  • Condition : Expression interprétée lors de l'exécution de la vue, permettant d'évaluer si l'alerte doit être appliquée au champ.
    Une condition se décompose en :
    • un opérateur : =, <, <=, >, >=, <>
    • une expression texte correspondant à l'une des valeurs du champ à tester et/ou une variable d'environnement :
      • Variables disponibles : today = Aujourd'hui ; now = Maintenant (date/heure courante).
      • Les variables peuvent être combinées avec des valeurs et des opérateurs.
      • Les valeurs à tester doivent être encadrées d'apostrophes ('...').

exemple

  • Champ Statut : condition ='En panne'
  • Champ Priorité : condition >='3'
  • Champ Urgence : condition '1 - Haute'
  • Champ Incident - Enregistré le : condition today ==> rechercher les incidents créés aujourd'hui
  • Champ Matériel - Date d'installation : condition today-20 ==> rechercher les matériels installés 20 jours avant aujourd'hui
  • Champ Action - Début prévu le : condition >now ==> rechercher les actions planifiées après maintenant 
  • Couleur de fond : Couleur de la pastille Green bullet.png positionnée devant la valeur du champ sélectionnée à partir d'une palette de couleurs ou du code hexadécimal.
  • Police : Police de caractères appliquée à la valeur du champ.
    • Par défaut, il s'agit de la police du navigateur Internet. 
    • Toutes les polices gérées par le navigateur sont disponibles.
    • Vous pouvez cumuler le nom et la taille de la police, en les séparant par une virgule.
               exemple  Arial, 10
  • Style : Style de la police de caractères appliqué à la valeur du champ (gras, italique, ...).
    • Vous pouvez appliquer plusieurs styles.
  • Aperçu : Aperçu de la mise en forme du champ sur la représentation finale de la vue lorsque la condition est vérifiée.
  • Delete icon.png : Permet de supprimer la condition de l'alerte.

Procédures

Comment créer une vue positionnée sur une grille en mode Liste

Note : Vous devez être rattaché à un profil ayant les droits d'édition des vues  - Open url.png voir Profils utilisateurs > Droits d'édition et d'affichage

Étape 1 (optionnelle) : Ajout de champs dans la requête parent de la vue

Note : Vous devez être attaché à un profil ayant les droits d'édition des affichages.

1. Allez sur l'entrée de menu pour laquelle vous souhaitez créer la nouvelle vue.
L'écran en ouvert en mode Liste.

2. Cliquez sur Tools icon.png dans la barre de titre > option Éditer.
La liste de tous les champs issus de la requête parent associée à l'entrée de menu et les champs supplémentaires ajoutés manuellement est affichée.

3. Ajoutez les champs souhaités  - Open url.png voir procédure Comment modifier une requête parent

Étape 2 : Création de la nouvelle vue

     Note : Vous pouvez initialiser la nouvelle vue à partir d'une vue modèle  - Open url.png voir Procédure

1. Allez sur l'entrée de menu pour laquelle vous souhaitez créer la nouvelle vue.
L'écran en ouvert en mode Liste.

2. Cliquez sur l'option Éditer la vue Edit icon.png en bas de la liste déroulante Vue du bandeau d'options.
         Edit rights - View.png

  • L'éditeur de vue est ouvert. 
  • La vue courante est affichée.

3. Cliquez sur Add icon.png dans la barre d'outils.

  • Une nouvelle vue est initialisée.
  • Tous les champs issus de la requête parent associée à l'entrée de menu et les champs supplémentaires ajoutés manuellement sont affichés dans la liste Champs disponibles.

          New view procedure - Initialization.png


Étape 3 : Définition de la structure de la nouvelle vue

Représentation finale de la vue

1. Cliquez-glissez tous les champs visibles sur la représentation finale de la vue de la liste Champs disponibles vers la section Prévisualisation > Mode Liste.

2. Cliquez-glissez les champs dans la section Prévisualisation > Mode Liste pour ordonner les colonnes sur la représentation finale de la vue.

Niveaux de rupture

Note : Vous devez avoir positionné un premier champ dans la section Prévisualisation > Mode Liste.

1. Cliquez-glissez tous les champs identifiant les niveaux de la liste Champs disponibles vers la section Prévisualisation > Drilldown.

2. Cliquez-glissez les champs dans la section Prévisualisation > Drilldown pour ordonner les niveaux de rupture.


Étape 4 : Mise en forme des alertes graphiques des champs sur la représentation finale de la vue

1. Cliquez sur Tools icon.png en regard du champ à configurer dans la section Prévisualisation.
La fenêtre de configuration des alertes graphiques est affichée.

2. Renseignez les options suivant la nature du champ.

  • Regroupement (Note : Uniquement pour un champ de type Date) : Sélectionnez le mode de regroupement des enregistrements.
             View - Alert - Grouping.png

exemple  Pour visualiser rapidement tous les matériels arrivant à échéance en 2021 :

  • Champ Date de fin de garantie = 01/09/2021
  • Regroupement Par année = 2021
  • Début du chemin / Fin du chemin (Note : Uniquement pour un champ arborescent qui n'est pas de dernier niveau) : Indiquez le premier niveau et le dernier niveau de l'arborescence à afficher.
    • La valeur 0 permet l’affichage de tous les niveaux de l’arborescence.
               View - Alert - Path level.png

exemple  Affichage du champ arborescent Localisation = Amérique du nord/USA/New-York/Manhattan/Broadway

  • Début = 0, fin = 0 ==> Amérique du nord/USA/New-York/Manhattan/Broadway
  • Début = 1, fin = 3 ==> USA/New-York/Manhattan
  • Début = 4, fin = 5 ==> Manhattan/Broadway
  • Valeur Localisation (dernier niveau) = Broadway

3. Définissez la mise en forme graphique des valeurs du champ à mettre en évidence sur la représentation finale de la vue.

  • Cliquez sur Ajouter une condition.
    Une ligne de saisie d'une condition est affichée.
             View - Alert - Condition.png
  • Renseignez les attributs de mise en forme à appliquer lorsque la condition est vérifiée pour le champ.
    La zone Aperçu Preview area.png affiche automatiquement la mise en forme.
  • Répétez les opérations pour chaque valeur du champ à mettre en évidence  - Open url.png voir Exemple
  • Cliquez sur Enregistrer.
    Vous revenez sur l'éditeur de vue.
  • Effectuez les mêmes actions pour tous les champs à mettre en évidence sur la représentation finale de la vue.
     

Étape 5 : Sélection des profils devant avoir accès à la vue

Note : Vous pouvez également les définir via l'écran des profils utilisateurs.

1. Cliquez sur Password close icon.png dans la barre d'outils.
Par défaut, tous les profils sont autorisés.

2. Cliquez-glissez de la colonne Visible vers la colonne Invisible les profils pour lesquels vous ne souhaitez pas autoriser l'accès à la vue.

3. Cliquez-glissez de la colonne Invisible vers la colonne Visible les profils pour lesquels vous souhaitez redonner l'accès à la vue.

4. Cliquez sur Enregistrer.
         Profiles - Selection.png

Étape 6 : Sauvegarde et test de la nouvelle vue

1. Saisissez le nom de la nouvelle vue.

Best Practice icon.png  Nommez la vue selon la hiérarchie des niveaux de rupture (champs disponibles dans la section Prévisualisation > Drilldown) via Generate name icon.png dans la barre d'outils.

2. Renseignez les libellés multilingues via View - Multilingual labels icon.png.

3. Sauvegardez la vue via Save icon.png.

4. Cliquez sur Fermer la fenêtre.

  • L'éditeur de vue est fermé.
  • La vue est automatiquement appliquée sur l'écran en mode Liste.
  • Elle est ajoutée dans la liste déroulante Vue du bandeau d'options et devient accessible pour les profils autorisés.

5. Vérifiez l'affichage des résultats.

6. Vérifiez que seuls les profils autorisés ont accès à la vue.

Comment créer une vue rattachée à une alerte ou un reporting

Étape 1 : Création de la nouvelle vue

1. Allez sur l'alerte ou le reporting pour lequel vous souhaitez créer une vue.

2. Créez la vue.

  • Alerte : Allez sur la dernière étape puis cliquez sur Ajouter une vue (Note : Uniquement pour une alerte de type Standard)
  • Reporting : Ajoutez une vue via Add icon.png et saisissez son nom. Puis cliquez sur Display popup icon.png.

L'éditeur de vue est ouvert.
         View - Alert and Reporting.png

Étape 2 : Configuration de la nouvelle vue

1. (Note : Uniquement pour une alerte de type Standard) Sélectionnez le menu auquel est rattaché l'alerte, via le champ Thème.
Seuls les destinataires de la notification d'alerte ayant accès à ce menu peuvent consulter cette vue.

CreateViewAlertReporting_Procedure

2. Définissez l'ordre des colonnes sur la vue.

  • Cochez la case Ordre en regard du champ à déplacer.
  • Cliquez sur le lien Insérez ici en regard du champ au-dessus duquel vous souhaitez déplacer le champ sélectionné.
             View - Alert and Reporting - Insert here link.png

3. Renseignez les options suivant la nature du champ.

  • Uniquement pour un champ de type Date : Sélectionnez le mode de regroupement des enregistrements via la liste Regroupement.

    exemple  Pour visualiser rapidement tous les matériels arrivant à échéance en 2021 :

    • Champ Date de fin de garantie = 01/09/2021
    • Regroupement Par année = 2021
  • Uniquement pour un champ arborescent qui n'est pas de dernier niveau : Indiquez le premier niveau et le dernier niveau de l'arborescence à afficher.
    • La valeur 0 permet l’affichage de tous les niveaux de l’arborescence.

      exemple  Affichage du champ arborescent Localisation = Amérique du nord/USA/New-York/Manhattan/Broadway

      • Début = 0, fin = 0 ==> Amérique du nord/USA/New-York/Manhattan/Broadway
      • Début = 1, fin = 3 ==> USA/New-York/Manhattan
      • Début = 4, fin = 5 ==> Manhattan/Broadway
      • Valeur Localisation (dernier niveau) = Broadway
  • Cochez les opérations de comptage souhaitées (Nombre d'enregistrements par Comptage / Comptage groupé, Somme, Moyenne).

4. Sélectionnez le niveau de rupture de la vue via la colonne Rupture.

Tous les champs jusqu'a ce niveau sont marqués Visible.

5. Cochez les champs à afficher sur la vue.

EndCreateViewAlertReporting_Procedure

Étape 3 : Sauvegarde et test de la nouvelle vue

1. Fermez la vue.

  • Alerte : Cliquez sur Terminer.
  • Reporting : Cliquez sur OK.

2. Testez l'alerte ou le reporting et vérifiez que la vue comprend les informations souhaitées.

Comment créer une vue à partir d'un modèle

Note : Uniquement pour les vues positionnées sur une grille en mode Liste

Étape 1 : Sélection de la vue modèle

1. Allez sur l'entrée de menu pour laquelle vous souhaitez créer la nouvelle vue.

2. Cliquez sur l'option Éditer la vue Edit icon.png en bas de la liste déroulante Vue du bandeau d'options.

  • L'éditeur de vue est ouvert. 
  • La vue par défaut de l'entrée de menu est affichée.

3. Sélectionnez la vue modèle dans la liste déroulante Vues existantes et cliquez sur Select ok icon.png.
La configuration de la vue est affichée.

Étape 2 : Création de la nouvelle vue

1. Modifiez les informations souhaitées de la vue modèle  - Open url.png voir Procédure détaillée

2. Renommez la vue.

3 Cliquez sur Duplicate icon.png pour ne pas écraser le modèle.

4. Cliquez sur Fermer la fenêtre.

  • L'éditeur de vue est fermé.
  • La vue est automatiquement appliquée sur l'écran en mode Liste.

La géolocalisation via Google Maps

Dans une vue par localisation affichée sur une carte, le marqueur Google map icon.png permet de géolocaliser chaque site automatiquement via le libellé de la localisation, l'adresse, la ville et le pays. Ces informations sont géolocalisées via une API Google Maps nécessitant de disposer d'une clé d'API.

          Google Maps Geocoding API - Schema.png

Remarques

  • La géolocalisation utilise une API Google Maps nécessitant de disposer d'une clé d'API  - Open url.png voir Procédure
    • Vous devez disposer d'un compte Google et d'un abonnement à Google Maps Platform pour créer un clé d'API   - Open url.png voir Tarifs
    • Toute version de Service Manager postérieure au fix 2015.201 utilise une clé API v3 de Google Maps. Pour les versions antérieures, recherchez une clé API v2 de Google Maps.
    • Pour les clients On Premise, la configuration de la clé d'API s'effectue dans le fichier Config/smo_config.php sur le serveur Apache. Pour les clients SaaS, vous devez effectuer une demande auprès de l'équipe CMC EasyVista.
  • Si vous utilisez un proxy pour appeler le service Google Maps de géolocalisation, vous devez renseigner le paramètre divers {ADMIN} Port du proxy pour Google Maps.
  • Le service de Google Maps permet uniquement le géocodage d'adresses statiques (i.e. connues à l'avance).
  • Pour minimiser les allers-retours entre le poste client et les serveurs Google Maps, les informations de géodécodage sont stockées dans la base une fois obtenues. Elles ne sont redemandées qu’en cas de changement d’adresse.
  • Limitation pour les utilisateurs de l'API Google Maps standard : 2 500 requêtes gratuites par jour ; 10 requêtes par seconde. Au-delà, vous devez activer la facturation à l'utilisation pour déverrouiller les quotas  - Open url.png voir Limites d'utilisation de Google Maps Geocoding API 

Attention

  • Veillez à ne pas divulguer votre clé d'API Google Maps. C'est en effet à partir de son utilisation que sont déclenchées et décomptées le nombre de requêtes de géolocalisation autorisées sur votre compte.
  • Si le fichier Config/smo_config.php n'est pas configuré, la vue par localisation n'apparaît pas dans la liste des affichages graphiques  - Open url.png voir Procédure
             View via list - Display tools.png

Bonnes pratiques

  • À tout moment, vous pouvez vérifier si vous avez atteint votre quota de requêtes journalier  - Open url.png  voir Procédure

Procédures

Comment obtenir une clé d'API Google Maps

     Open url.png voir Documentation Microsoft

Étape 1 : Enregistrement de l'application Service Manager dans la console des API Google

1. Allez sur la console des API Google Google Maps Geocoding API.

2. Connectez-vous à votre compte Google.

3. Cliquez sur la liste Sélectionnez un projet en haut de l'écran.

  • Vous utilisez déjà des API Google : sélectionnez le projet depuis lequel vous gérez vos applications dans la console.
  • Vous n'utilisez pas d'API Google : cliquez sur Nouveau projet et créez le projet.
     

Étape 2 : Génération de la clé d'API

1. Sélectionnez l'option APIs & Services > Identifiants dans le panneau latéral.
         Google Maps Geocoding API - Credentials.png

2. Cliquez sur + Créer des identifiants puis sur Clé API.

La clé générée est affichée.
         Google Maps Geocoding API - New key.png

3. Cliquez sur Restreindre la clé.

  • Définissez les restrictions (sites web, adresses IP ou applications) pour éviter toute utilisation abusive votre clé d'API.
  • Renommez la clé avec un nom propre à votre serveur.
  • Cliquez sur Enregistrer.

La page Identifiants est réactualisée.
         Google Maps Geocoding API - Credentials with api key.png

Étape 3 : Ajout de la clé d'API Google Maps dans le fichier de configuration du serveur Apache

1. Copiez la clé via Google Maps Geocoding API - Copy icon.png.

2. Ouvrez le fichier /Config/smo_config.php sur le serveur Apache.

3. Modifiez la ligne ci-dessous en remplaçant la valeur en jaune.

  • <Your GoogleMaps key value> : la nouvelle clé d'API copiée précédemment
    Attention : N'omettez pas les caractères ' '.

define ('GOOGLE_MAPS_KEY', '<Your GoogleMaps key value>');

      exemple

define ('GOOGLE_MAPS_KEY', 'AIzaCyDq6C6oa93gvZHKNbABAf4dyIjfdjz4h7WL');

Étape 4 : Test du bon fonctionnement de la clé d'API Google Maps

1. Exécutez l'URL ci-dessous en remplaçant les valeurs en jaune.

  • <Your GoogleMaps key value> : la nouvelle clé d'API copiée précédemment
  • <Location to geolocate> : la localisation à tester
     

https://maps.googleapis.com/maps/api/geocode/json?sensor=false&address=<Location to geolocate>&key=<Your GoogleMaps key value>

      exemple  Tester le bon fonctionnement pour la localisation Boston

https://maps.googleapis.com/maps/api/geocode/json?sensor=false&address=Boston&key=AIzaCyDq6C6oa93gvZHKNbABAf4dyIjfdjz4h7WL

2. Vérifiez que le statut retourné par la requête de géocodage, indiqué à la fin de la page, est OK.
         Google Maps Geocoding API - Status OK.png

     Liste des statuts possibles :

  • OK : aucune erreur n'est survenue, l'adresse a été analysée et au moins un géocode a été trouvé.
  • ZERO_RESULTS : le géocode a réussi mais n'a renvoyé aucun résultat. Cela peut se produire si le géocodeur a reçu un paramètre address inexistant.
  • OVER_QUERY_LIMIT : vous avez dépassé votre quota.
  • REQUEST_DENIED : votre requête a été rejetée.
  • INVALID_REQUEST : il manque un élément dans la requête.
  • UNKNOWN_ERROR : la requête n'a pas pu être traitée en raison d'une erreur de serveur. Si vous essayez à nouveau, la requête pourrait aboutir.

Comment vérifier les quotas

1. Allez sur la console des API Google.

2. Connectez-vous à votre compte Google.

3. Cliquez sur le menu Open menu icon.png et sélectionnez l'option IAM et Administration > Quotas dans le panneau latéral.
Le nombre de requêtes autorisées est affiché en regard de la ligne du service Google Maps Geocoding API.
         Google Maps Geocoding API - Quotas.png

4. Cliquez sur Edit icon.png sur la ligne du service.
Le nombre de requêtes exécutées dans la journée est affiché.
         Google Maps Geocoding API - Quotas - Update.png

Tags :

Raccourcis

Portail client

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

Powered by XWiki © EasyVista 2022