Leçon 1 : Définition d'un indicateur personnalisé#

Céez une définition d'indicateur que vous allez charger vers HCL™ Accelerate.

Avant de commencer

Avant de commencer cette leçon, assurez-vous de configurer votre environnement de tutoriel.

Description de la tâche

Une définition d'indicateur est un objet SON, qui est une collection de paires nom-valeur. Pour plus d'informations sur la structure des définitions d'indicateur, voir Mise en œuvre d'indicateurs personnalisés. Pour obtenir des informations sur JSON lui-même, reportez-vous à l'organisation JSON.

Pour une définition d'indicateur, vous fixez les valeurs par défaut du graphique et indiquez un ID que HCL Accelerate peut utiliser pour associer des enregistrements d'indicateur au type d'indicateur. Lorsque vous avez terminé, vous allez utiliser la définition dans une demande curl qui la charge dans le produit.

Pour créer une définition d'indicateur, procédez comme suit :

Procédure

  1. Ouvrez un éditeur de texte et enregistrez le fichier vierge en tant que fichier de type JSON, par exemple myMetricDefinition.json.

  2. Dans myMetricDefinition.json, définissez l'ID correspondant à la définition d'indicateur : "id": "TUTORIAL_DEFINITION",...

    L'ID peut contenir n'importe quelle valeur de chaîne.

  3. Sur la seconde ligne, saisissez un nom à donner à la définition de l'indicateur : "name": "Tutorial definition",...

    La propriété de nom peut contenir n'importe quelle valeur de chaîne. Des enregistrements d'indicateur peuvent être associés à des définitions d'indicateur à l'aide de propriétés de nom ou d'ID.

  4. Spécifiez la catégorie d'indicateur : "category": "quality",...

    Cette propriété de type chaîne sert à définir la catégorie à laquelle appartient la définition de l'indicateur. Les catégories sont répertoriées dans la zone Ajouter des graphiques de la page Tableaux de bord. Les valeurs acceptées sont les suivantes : quality, deliveryFlow, risk, team et effort. Le graphique que nous créons dans ce tutoriel va être ajouté à la liste de graphiques Qualité.

  5. Spécifiez l'ID titulaire : tenantId":"my_UCV_TenantID.

    Cette propriété identifie votre installation HCL Accelerate. Utilisez la valeur que vous avez extraite dans la rubrique sur la configuration.

  6. Spécifiez les propriétés par défaut du graphique.

    Cet objet JSON définit le type du graphique et détermine la manière dont les données sont regroupées. Le graphique du tutoriel agrège les données par résultat. D'autres regroupements, par équipe, par statut ou par nom, peuvent s'avérer utiles pour d'autres types de données. Actuellement, HCL Accelerate propose des graphiques de type à barres et à lignes. Définissez le type de graphique par défaut sur à barres, mais les utilisateurs peuvent modifier cette option après que vous avez ajouté le graphique au tableau de bord.

    "chartDefaults":{ "groupBy":"result", "chartType":"bar", "barMode": "stack" },

  7. Définissez la propriété d'opération d'agrégation.

    "aggregation":{ "operation":"sum" }

    Cette propriété définit la logique d'agrégation par défaut utilisée lorsque plusieurs enregistrements sont chargés.

  8. Enregistrez la définition d'indicateur.

résultats

La définition d'indicateur que vous avez créée va être appliquée à l'enregistrement de données envoyé vers HCL Accelerate dans une leçon ultérieure.

Le fragment de code suivant montre la définition d'indicateur que nous avons créée dans cette leçon.

{
        "id": "TUTORIAL_DEFINITION",
        "name":"Tutorial Definition",
        "category": "quality",
        "tenantId":"my_tenant_id",
        "chartDefaults":{
          "groupBy":"result",
          "chartType":"bar",
          "barMode": "stack"
        },
        "aggregation":{
          "operation":"sum"
        }
      }

Que faire ensuite

Lors de la première leçon, nous avons créé une requête curl à l'aide de la définition d'indicateur et nous avons chargé la définition dans HCL Accelerate.

Sujet parent : Mise en œuvre d'indicateurs personnalisés