Concevoir des événements personnalisés avec des schémas dans EarthRanger

Les utilisateurs EarthRanger enregistrent et suivent les incidents et activités dans leurs zones protégées sous forme d'événements . Ces événements peuvent être des incendies, des observations d'animaux sauvages ou des emplacements de pièges.

  • Les événements reflètent des situations qui se produisent sur le terrain
  • Les événements peuvent être créés par un utilisateur ou par un service connecté
  • Les événements peuvent être autonomes, associés à des patrouilles ( voir : Patrouilles ) ou regroupés dans des incidents (voir : Comment utiliser les incidents )

Les administrateurs EarthRanger sont chargés de créer la structure (y compris les champs obligatoires), la conception et la gestion de tout événement pouvant être créé depuis la vue cartographique EarthRanger . Ces structures modèles pour les événements sont appelées « types d'événements » .

  • Les événements sont les incidents enregistrés et avec lesquels les utilisateurs interagissent dans les applications web et mobiles EarthRanger . Chaque événement repose sur une structure fixe définie par le type d'événement configuré.
  • Les types d'événements sont les modèles / formats prédéfinis d' événements qui peuvent être configurés et gérés par un administrateur via le portail d'administration EarthRanger et sont placés dans des groupes appelés catégories d'événements :
  • Les catégories d'événements sont des groupes dans lesquels les types d'événements peuvent être placés. Par exemple, tous les types d'événements écologiques, tels que « Observations d'animaux sauvages », « Incendie » et « Espèces envahissantes » peuvent être classés dans une catégorie d'événements « Écologie ».

Remarque : EarthRanger a introduit un nouvel éditeur de formulaires d'événements (EFE). Ce générateur de formulaires par glisser-déposer permet aux administrateurs de créer et de gérer des types d'événements sans avoir à modifier manuellement les schémas . Cette interface intuitive est actuellement en version bêta et devrait devenir la méthode par défaut à l'avenir.

Cet article explique comment créer des types d'événements à l'aide de l' approche traditionnelle basée sur un schéma , qui reste entièrement prise en charge et est toujours requise pour les configurations héritées ou pour les configurations avancées qui ne sont pas encore disponibles dans l'EFE.

Pour obtenir des instructions étape par étape sur l'utilisation du nouveau générateur de formulaires, consultez : Créer des formulaires d'événements personnalisés avec l'éditeur de formulaires d'événements .

Configuration du type d'événement

Les types d'événements peuvent être configurés pour les utilisateurs EarthRanger via le site d'administration. Une méthode consiste à utiliser une approche basée sur un schéma, qui comprend les étapes suivantes :

  • Configurer un nouveau type d'événement
  • Créer la structure du type d'événement (définir les étiquettes, les champs et la disposition des champs via le schéma d'événement)

Configurer un nouveau type d'événement (méthode basée sur un schéma)

Remarque : Pour cette méthode, un type d'événement doit disposer d'un schéma valide avant de pouvoir être enregistré. Si vous utilisez l'éditeur de formulaires d'événement, le schéma est créé visuellement lors de la création du formulaire.

  1. Accédez à votre site Web d'administration EarthRanger ( https://yourorganization.pamdas.org ) et accédez à Accueil > Activité > Types d'événements .
  2. Sélectionnez « Ajouter un type d'événement » en haut à droite de l'écran. La page « Ajouter un type d'événement » s'affiche.
  3. Affichage : saisissez un nom accessible à l'utilisateur pour le nouveau type d'événement (par exemple, « Observation d'animaux sauvages »).
  4. Valeur : saisissez une valeur ou une clé interne unique pour ce type de rapport, généralement une chaîne de texte suivie de « _rep » (par exemple, « wildlife_sighting_rep »).

    Remarque : il est recommandé de saisir la chaîne de valeur en lettres minuscules et sans espaces. Lorsque deux mots ou plus sont utilisés pour la valeur, remplacez l'espace par un trait de soulignement (_) ou un tiret (-).
  5. Catégorie , sélectionnez la catégorie appropriée pour le type d'événement (par exemple, sécurité, surveillance, écologie, logistique, maintenance, etc.).

    Cette catégorie détermine le groupe dans lequel le type d'événement apparaît. Elle détermine également les autorisations dont un utilisateur doit disposer pour interagir avec les types d'événements de cette catégorie (création, modification, consultation, etc.).

    Vous pouvez créer une nouvelle catégorie d'événement en cliquant sur le signe plus + vert.

Remarque sur les autorisations et les catégories d'événements

Dans EarthRanger , les autorisations sont attribuées au niveau du groupe. Cela signifie que pour qu'un utilisateur ait accès aux événements d'une catégorie d'événements , l'administrateur doit lui attribuer les autorisations liées à cette catégorie .

Par exemple, lorsqu'une catégorie d'événement appelée « Écologie » est créée, le système EarthRanger crée automatiquement un ensemble d'autorisations lié à cette catégorie d'événement appelé « Afficher les autorisations d'événement écologique » , qui aura les autorisations standard suivantes ;

  • Peut créer des événements écologiques
  • Peut supprimer les événements écologiques
  • Peut lire les événements écologiques
  • Peut mettre à jour les événements écologiques

Par conséquent, l'administrateur du site EarthRanger attribuera cet ensemble d'autorisations à tout utilisateur ayant accès à tous les événements de la catégorie Écologie. Ces utilisateurs pourront alors créer, lire et mettre à jour tous les événements enregistrés via EarthRanger Web et Mobile, quel que soit le type d'événement de la catégorie Écologie. L'autorisation standard de suppression ne prendra effet que si l'utilisateur a accès au site d'administration, car la suppression d'événements ne peut être effectuée que depuis le site d'administration d'une instance EarthRanger .

  1. Est-ce une collection : laissez décoché.
  2. Remplacement d'icône : cliquez sur le signe vert « + » à côté de et choisissez une icône qui correspond le mieux au type d'événement (utilisez Ctrl + F (Windows) / Cmd + F (Mac) pour rechercher des icônes par mot-clé)

    Remarque : Il n'est pas possible de télécharger de nouvelles icônes via le site d'administration. Si vous avez besoin d'une nouvelle icône , contactez support@earthranger.com.
  3. Le champ « Numéro d'ordre » détermine l'ordre des types d'événements dans la catégorie (les numéros les plus bas apparaissent en premier). Ce champ peut être laissé vide ; une valeur lui sera automatiquement attribuée.
  4. Définissez la priorité par défaut pour l' événement : gris (par défaut), vert, orange ou rouge.
    Les couleurs donnent une description visuelle / en un coup d'œil de la priorité d'un événement : Élevé (rouge), Moyen (ambre), Normal (vert) et Faible (gris).
    Remarque : la classification de ces couleurs dépend de vos préférences ou de vos exigences opérationnelles.
  5. Définissez l' état par défaut : Nouveau (par défaut), Actif ou Résolu.

    Remarque : les états Nouveau et Actif entraîneront l'apparition de tous les événements créés à l'aide de ce type d'événement dans le flux d'événements et sur la carte s'ils ont un emplacement associé par défaut.
    Les événements résolus n'apparaîtront pas automatiquement sur le flux et la carte par défaut. Un filtre doivent être appliqués sur l'interface utilisateur Web si un utilisateur souhaite les voir.
  6. Saisissez un schéma valide pour définir les champs qui apparaîtront dans l'événement.
    • Pour plus d’informations, reportez-vous à la section suivante : Création d’un schéma pour un type d’événement.
    • Si vous n'êtes pas familier avec la configuration du schéma, vous pouvez travailler avec l'équipe d'assistance et une feuille de calcul de modèle de données .
  7. Cliquez sur Enregistrer .

Création d'un schéma pour un type d'événement (méthode manuelle)

Si vous utilisez la méthode traditionnelle (saisie manuelle d'un schéma), le schéma définit les étiquettes, la structure et les champs qui apparaissent dans le formulaire de type d'événement résultant.

Vous avez un contrôle total sur la disposition des types d'événements , et le schéma peut être créé manuellement de A à Z. Cependant, il est plus courant d'utiliser un schéma existant comme point de départ et de le modifier selon vos besoins.

Ajout d'un schéma à un type d'événement

Dans la section ci-dessous, vous trouverez un schéma qui peut être copié et collé directement dans la zone Schéma d'un type d'événement (voir Exemple de schéma annoté à utiliser dans un type d'événement ).

Cet exemple de schéma générera des formulaires d'événement avec des zones de texte et des étiquettes, ainsi que des annotations qui aident à illustrer la relation entre les paramètres de schéma et la disposition d'événement résultante.

Avant de passer au schéma, la section suivante fournit une brève description du fonctionnement des schémas dans les types d'événements :

À propos des schémas pour les types d'événements

Les schémas des types d'événements sont écrits au format JSON. Chaque schéma se compose de deux sections principales :

  • Propriétés : Définit les attributs des champs, tels que stockés dans la base de données.
  • Définition : Détermine la manière dont le formulaire Type d’événement apparaît aux utilisateurs dans l’interface EarthRanger .

Propriétés du schéma

Chaque propriété du schéma doit inclure au moins une clé , un type et un titre :

  • clé : Un identifiant unique pour le champ, utilisé à la fois dans la base de données et dans la section de définition.
  • type : définit le type de données (par exemple, chaîne, nombre, liste de choix).
  • titre : L'étiquette de texte affichée dans l'interface EarthRanger .

Les propriétés facultatives peuvent également inclure :

  • minimum : définit la valeur minimale pour un champ numérique (par exemple, « 0 » pour un champ de comptage).
  • maximum : définit la valeur maximale pour un champ numérique (par exemple, « 360 » pour un champ de relèvement).
  • obligatoire : marque le champ comme obligatoire pour permettre qu'un événement puisse être enregistré sur les applications Web et mobiles EarthRanger .
  • enum : définit des valeurs qui génèrent une liste déroulante dans l'événement.
    • enum___xxx___values : options déroulantes de la table CHOICES.
    • query___xxx___values : options déroulantes de la table SUBJECT, définies dans la table DYNAMIC CHOICES.

Définitions de schéma

La section de définition définit comment les champs apparaissent dans l'interface utilisateur EarthRanger :

  • clé : correspond à une clé de la section des propriétés et définit l'ordre dans lequel les champs sont affichés.
  • htmlClass : Définit la disposition d'affichage globale (actuellement, « col-lg-6 » est utilisé pour créer deux colonnes).
  • fieldHtmlClass : Affecte l'affichage du champ (par exemple, « date-time-picker json-schema » affiche un sélecteur de calendrier/heure). Cela détermine également la taille des champs en utilisant « col-lg-6 » (texte court) ou « col-lg-12 » (texte long).
  • type : Les champs tels que « textarea » s'étendent sur deux lignes, permettant ainsi l'habillage et le défilement du texte.

D'autres définitions de champs peuvent être prises en charge dans les futures mises à jour.

Exemple de schéma annoté à utiliser dans un type d'événement

Voici un exemple de schéma qui peut être utilisé pour créer un type d’événement :

{
 "schema": {
 "$schema": "http://json-schema.org/draft-04/schema#",
 "title": "DAS JSON Schema Reference List",
 "type": "object",
 "properties": {
 "string_field": {
 "type": "string",
 "title": "String Field (2 Col by using col-lg-6)"
 },
 "number_field": {
 "type": "number",
 "title": "Number Field 0<>360 (2 Col)",
 "minimum": 0,
 "maximum": 360
 },
 "time_field": {
 "type": "string",
 "title": "This is a time field. Look below in the Definition section to get date-time-picker"
 },
 "textarea_field": {
 "type": "string",
 "title": "String with text area, word wrap and scroll. 2 lines max"
 },
 "enum_field": {
 "type": "string",
 "title": "This is a drop down list populated from the Choices table where Field = yesno",
 "enum": {{enum___yesno___values}},
 "enumNames": {{enum___yesno___names}}
 },
 "query_field": {
 "type": "string",
 "title": "This is a drop down populated with Subjects defined by a query in Dynamic Choices table",
 "enum": {{query___blackRhinos___values}},
 "enumNames": {{query___blackRhinos___names}}
 },
 "multi_select_field": {
 "key": "multi_select_field"
 },
 "table_field": {
 "type": "string",
 "title": "(DEPRECATED) This is a drop down list populated from a Table",
 "enum": {{table___TrafficType___values}},
 "enumNames": {{table___TrafficType___names}}
 }
 }
 },
 "definition": [
 {
 "key": "string_field",
 "htmlClass": "col-lg-6"
 },
 {
 "key": "number_field",
 "htmlClass": "col-lg-6"
 },
 {
 "key": "time_field",
 "fieldHtmlClass": "date-time-picker json-schema",
 "readonly": false
 },
 {
 "key": "textarea_field",
 "type": "textarea"
 },
 {
 "key": "enum_field"
 },
 {
 "key": "query_field"
 },
 {
 "key": "multi_select_field",
 "type": "checkboxes",
 "title": "Multiple Selection from Choices Table - BUGS on Display and Export",
 "titleMap": {{enum___carcassrep_species___map}}
 },
 {
 "key": "table_field"
 } ]
 
}

Avertissement important : ne supprimez pas les types d’événements

Important : Ne supprimez pas les types d'événements , car cela pourrait affecter votre capacité à récupérer les événements existants. Suivez plutôt les étapes suivantes pour masquer les types d'événements auxquels vous ne souhaitez plus que les utilisateurs accèdent sur les applications EarthRanger Mobile et Web.

Pour masquer un type d’événement :

  1. Depuis votre portail d'administration EarthRanger (https://your_organization.pamdas.org), accédez à Activité > Types d'événements .
  2. Dans la colonne Affichage de la page Types d'événements , cliquez sur le nom d'affichage du type d'événement à masquer. La page des paramètres du type d'événement s'ouvre.
  3. Dans la liste déroulante Catégorie , sélectionnez CACHÉ .
    • Si une catégorie CACHÉE n’existe pas, suivez ces étapes pour en créer une :
      1. Sélectionnez le signe plus vert à côté du champ Catégorie . La page « Ajouter une catégorie d'événement » s'affiche.
      2. Id : Laissez l'ID unique par défaut inchangé.
      3. Valeur : Saisissez « caché ».
      4. Affichage : Saisissez « HIDDEN ».
      5. Numéro de commande : Laissez ce champ vide.
      6. Drapeau : Sélectionnez Système.
      7. Sélectionnez Enregistrer pour créer la catégorie.
  1. Vous pouvez également cocher la case « Actif » dans la section « Valeurs par défaut » de la page de détails du type d'événement . Si cette case est décochée, le type d'événement restera dans sa catégorie d'origine, mais sera supprimé de la liste des événements .
  1. Sélectionnez Enregistrer sur la page des paramètres du type d’événement .

Une fois enregistré, le type d'événement ne sera plus visible pour les utilisateurs ni disponible dans la liste des types d'événements , mais les administrateurs y auront toujours accès ainsi qu'à tous les événements enregistrés à l'aide de ce type d'événement (si nécessaire).

À suivre : Créez des types d'événements personnalisés avec l'éditeur de formulaires d'événements



Cet article vous a-t-il été utile ?