Alertes

Sur quel élément de patrimoine rattacher les alertes ?

Les données d'alertes seront rattachées à un élément du bâti à savoir au logement, au local, à l'immeuble ou encore à la partie commune.

Remplacement de compteur

Vous devez toujours conserver le même flux (stream). Si le compteur est remplacé, on ne crée pas de nouveau flux, on conserve le même.Le flux est donc lié à un "point de comptage" et non à un "équipement compteur" ⁠⁠Vocabulaire⁠ 

Comment transmettre les données ?

Pour transmettre les données, il vous faudra créer un stream de type events et l'alimenter en données.  ⁠⁠Evénements et alertes⁠ 
L'API à utiliser est l' API Data v1 .

Création du flux Alertes

Il vous faut créer un stream de type events, avec un dataType = alert et une activityKey = AlarmReport
La référence du stream est {RéférencePointdecomptage}-{activityKey}

POST api/data/v1/streams
{
  "reference": "449876543-AlarmReport",
  "label": "Alerte compteur d'eau froide du logement 213LO98",
  "type": "events",
  "tags": {
    "intent_assetReference": "213LO98",
    "intent_activityKey": "AlarmReport",
    "intent_dataType": "alert",
    "intent_contractReference": "CONTRACT-10",
    "point de comptage": "449876543",
    "numéro de série": "16A8986765",
    "référence client": "G46245"
  }
}

Caractéristique du stream

Toutes les caractéristiques :  doc api en ligne 
Title
Title
Champ
Description
intent_assetReference
référence de l'élément de patrimoine où la mesure est faite
point de comptage
référence du point de comptage (PCE/PRM/PDL)
numéro de série
numéro de série du compteur qui mesure la consommation
référence client
la référence du compteur côté client (si vous la connaissez)
Label : Le label doit être compréhensible par tous les utilisateurs.

Alimenter le stream Alertes en données

Une fois que votre stream est créé, vous pouvez l'alimenter en données au fil de l'eau.

POST api/data/v1/events
{
  "streamReference": "449876543-AlarmReport",
  "payload": [
    {
      "type": "Fuite",
      "status": "Anormale",
      "timestamp": 1504063834184
    }
  ]
}

POST api/data/v1/events
{
  "streamReference": "449876543-AlarmReport",
  "payload": [
    {
      "type": "Fuite",
      "status": "Fin",
      "timestamp": 1504063934184
    }
  ]
}


Type et status

Sur intentPlatform, une alerte est caractérisée par un événement de début et un événement de fin, de clôture. L'utilisateur va paramétrer des seuils d'alertes qui vont créer une alerte lorsque l'événement de début d'alerte est transmis. L'alerte viendra automatiquement se clôturer, se fermer lorsque l'événement de clôture sera transmis.

Quelques exemples de type et status
Title
Title
type
status
Fuite
Anormale / Critique / Fin
Compteur tourne à l'envers
Début / Fin
Compteur bloqué
Début / Fin
Fonctionnement
Hors service / En service
Si vous souhaitez transmettre d'autres type d'alertes, veuillez contacter votre interlocuteur intégration chez Intent Technologies pour valider les valeurs à transmettre.


Si une alerte anormale existe et que le prestataire publie un event d'alerte critique, on vient "mettre à jour" l'alerte, pour reclasser l'alerte. On a bien qu'une seule alerte en cours.
Dans l'historique, nous verrons bien le déclenchement des 2 alertes.