Samsara

Le type de flux Samsara dans ArcGIS Velocity envoie des demandes HTTPS à une URL d’API Samsara spécifiée avec les paramètres pertinents.

Exemples

Les exemples suivants illustrent des cas d’utilisation du flux :

  • L’API Samsara avec l’URL https://api.samsara.com/fleet/vehicles/stats?types=gps est demandée toutes les cinq secondes pour extraire l’emplacement actuel des véhicules et les statistiques correspondantes.
  • L’API Samsara avec l’URL https://api.samsara.com/fleet/equipment/locations est demandée toutes les minutes pour extraire l’emplacement actuel de l’équipement.
  • Un point d’extrémité de demande GET à partir de l’API Samsara (v2) qui renvoie un objet de données et de pagination dans la réponse JSON.

Remarques sur l’utilisation

Gardez les points suivants à l’esprit lorsque vous utilisez le flux :

  • Le flux Samsara interroge l’URL d’API Samsara indiquée pour charger les données à la vitesse spécifiée dans Feed Polling Interval (Intervalle d’interrogation de flux) de l’assistant de configuration.
    Remarque :

    Le flux ne doit pas être configuré pour s’exécuter plus souvent que l’API Samsara ne peut renvoyer d’entités.

  • Lorsqu’un intervalle d’interrogation est défini, les interrogations ont lieu à intervalles réguliers à partir de l’heure de démarrage du flux. Par exemple, si un flux est configuré pour interroger les données toutes les cinq minutes, et qu’il démarre à 8:03, la première demande de données a lieu à 8:05, la suivante à 8:10, et ainsi de suite.
  • Les niveaux de licence de l’abonnement Velocity présentent des limites quant au volume de données pouvant être ingéré par un flux, comme synthétisé ci-dessous. Si des flux excèdent la limite d’ingestion de votre niveau de licence, un message est écrit dans les journaux et un e-mail est envoyé pour vous informer que la limite a été atteinte. Si l’ingestion des données demeure supérieure à la limite pendant plus d’une heure, le flux s’arrête. Le cas échéant, contactez votre représentant Esri ou le Support technique Esri pour découvrir les niveaux de licence Velocity prenant en charge vos processus. Les niveaux de licence sont les suivants :
    • Standard : ingestion et traitement des données à 25 Ko/seconde (environ 100 événements par seconde).
    • Avancé : ingestion et traitement des données à 250 Ko/seconde (environ 1 000 événements par seconde).
    • Dédié : ingestion et traitement des données à 2 500 Ko/seconde (environ 10 000 événements par seconde).
  • Le paramètre URL parameters (Paramètres URL) prend en charge les variables globales de flux. Par défaut, les variables globales de flux sont converties en heure epoch (millisecondes depuis le 1er janvier 1970 UTC). Vous pouvez également convertir ces variables en secondes epoch (secondes depuis le 1er janvier 1970 UTC) dans une chaîne au format de date et heure. Vous trouverez ci-après les variables d’analyse de flux et leur signification. À la première exécution du flux après le démarrage ou le redémarrage, $feed.FeedLastScheduledStartTime est égal à $feed.FeedScheduledStartTime moins la valeur de l’étape Feed Polling Interval (Intervalle d’interrogation de flux). Cela permet au flux de recevoir des données entre l’heure de démarrage ajusté et l’heure actuelle, ce qui empêche l’ingestion d’un important volume de données d’historique.
    • $feed.FeedStartTime : heure à laquelle le flux a démarré.
    • $feed.FeedScheduledStartTime : heure à laquelle la prochaine récurrence du flux est planifiée.
    • $feed.FeedLastScheduledStartTime : heure à laquelle la dernière récurrence du flux était planifiée.
  • Le flux Samsara traite automatiquement la réponse JSON à partir de l’API Samsara dans l’objet data renvoyé, puis aplatit le JSON.
  • Vous pouvez aplatir les matrices et indiquer des exemptions d’aplatissement de matrice spécifiques. Séparez plusieurs exemptions d’aplatissement de matrice par des virgules.
  • Velocity gère automatiquement les réponses paginées à partir de l’API Samsara pour traiter toutes les entités.
  • Après avoir configuré les paramètres de connexion au flux, définissez la structure et les paramètres de champs clés.

Paramètres

Les paramètres du flux sont les suivants :

ParamètreDescriptionType de données
URL

URL de l’API Samsara. Il doit s’agir d’un point d’extrémité de demande GET de l’API Samsara, car le flux extrait les données pour l’ingestion.

L’URL, ainsi que les paramètres d’URL fournis, contrôlent les données renvoyées par l’API Samsara.

Pour trouver l’URL de point d’extrémité de l’API Samsara, reportez-vous à la page Samsara API Overview (Présentation de l’API Samsara).

Chaîne

Clé d’API

Clé d’API Samsara. Indiquez la clé d’API au format suivant : samsara_api_<yourAPIKey>.

Chaîne

Paramètres URL

Paramètres URL facultatifs à inclure dans l’URL de la demande HTTP envoyée à l’URL Samsara spécifiée.

Les paramètres peuvent également être définis dans le paramètre URL, les paramètres URL saisis ici écrasant tout paramètre correspondant spécifié pour le paramètre URL. Les paramètres définis ici sont toujours codés par URL.

Ce paramètre prend en charge les variables globales de flux.

Paire clé-valeur

Paramètres URL

(facultatif)

Convertissez les variables globales de flux au format date et heure personnalisé.

En savoir plus sur la définition d’un format de date (millisecondes epoch, secondes epoch et format de type chaîne).

Chaîne

Journalisation supplémentaire

(facultatif)

Activez le paramètre Additional logging (Journalisation supplémentaire) pour indiquer si vous pouvez activer la journalisation des requêtes et réponses HTTP au format brut envoyées par Velocity à l’URL Samsara.

Remarque :

Activez ce paramètre à des fins de dépannage et désactivez-le à l’issue du dépannage. Une fois le paramètre activé, démarrez le flux. Les journaux de niveau Debug (Débogage) sont disponibles sur la page des journaux du flux. Le cas échéant, contactez le Support technique Esri pour obtenir de l’aide dans le cadre du dépannage.

Booléen

Considérations et limitations

Tenez compte des points suivants lorsque vous utilisez le flux :

  • Un abonnement et une clé d’API Samsara sont indispensables à l’utilisation de ce type de flux.
  • La génération actuelle d’API Samsara utilise le format RFC 3339 pour les horodatages. Pour configurer, définissez le paramètre Start Time (Heure de début) sur le champ avec cette date/heure de chaîne et indiquez le format de date/heure de chaîne de yyyy-MM-dd'T'HH:mm:ss'Z'.
  • L’API Samsara peut être interrogée toutes les cinq secondes.