Alertes

Fonctionnel

En tant que fournisseur, je transmets l’état de fonctionnement de l’équipement en créant un flux de données de type “events” et en y publiant les événements correspondant à son état

Technique

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

Le stream est associé à l’équipement qui le concerne par le champ “assetReference”. 1 flux par équipement.
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érenceEquipement}-{activityKey}
POST api/data/v1/streams
{
  "reference": "449876543-AlarmReport",
  "label": "Etat de fonctionnement de l'équipement {famille_equipement} 449876543",
  "type": "events",
  "tags": {
    "intent_assetReference": "BAT-001",
    "intent_activityKey": "AlarmReport",
    "intent_dataType": "alert",
    "intent_contractReference": "CONTRACT-10",
    "numéro de série": "16A8986765"
  }
}

Caractéristique du stream

Toutes les caractéristiques :  doc api en ligne 
Champ
Description
Standard intentReady
intent_assetReference
référence de l'élément de patrimoine où la mesure est faite
oui
numéro de série
numéro de série de l'équipement
oui
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": "Etat de fonctionnement",
      "status": "Hors service",
      "timestamp": 1504063834184
    }
  ]
}

POST api/data/v1/events
{
  "streamReference": "449876543-AlarmReport",
  "payload": [
    {
      "type": "Etat de fonctionnement",
      "status": "En service",
      "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.
type
status
Standard intentReady
Etat de fonctionnement
A surveiller
Hors service
En service
Oui

Critères de validation

Test
Résultat attendu
Création d'un flux d'alerte
Stream créé avec l'ensemble des caractéristiques attendues
Alimentation d'un flux d'alerte
Transmission des événements d'ouverture et fermeture d'une alerte sur un stream