ArcGIS Velocity 中的 Samsara 源类型用于通过相关参数将 HTTPS 请求发送到指定 Samsara API URL。
示例
以下是 Samsara 源的用例:
- 将每五秒查询一次 URL 为 https://api.samsara.com/fleet/vehicles/stats?types=gps 的 Samsara API,以检索车辆的当前位置和相关统计数据。
- 将每分钟查询一次 URL 为 https://api.samsara.com/fleet/equipment/locations 的 Samsara API,以检索设备的当前位置。
- 来自 Samsara API (v2) 的任何 GET 请求端点,用于在 JSON 响应中返回数据和分页对象。
用法说明
使用 Samsara 源时,请谨记以下内容:
- Samsara 源将按照配置向导的源轮询间隔步骤中指定的速率轮询指定的 Samsara API URL 以加载数据。
注:
不应将源的运行频率配置为高于 Samsara API 可以返回的要素数。
- 设置轮询间隔后,轮询将以规常规时间间隔进行,而不依据源的开始时间。 例如,如果将源设置为每 5 分钟轮询一次数据,并且在 8:03 a.m. 开始,则第一个数据请求将在 8:05 a.m. 发生,下一个在 8:10 a.m. 发生,依此类推。
- Velocity 订阅许可级别对源可以获取的数据量有限制,具体如下所述。 如果源超过许可级别的获取限制,则会向日志写入一条消息,并向用户发送一封电子邮件,通知已达到限制。 如果数据获取量超限的持续时间超过一个小时,源会停止。 如有必要,请与您的 Esri 代表或 Esri 技术支持人员合作,以了解支持您的工作流的 Velocity 许可级别。 许可级别如下所示:
- Standard - 以 25 KB/秒的速度获取和处理数据(每秒约 100 个事件)。
- Advanced - 以 250 KB/秒的速度获取和处理数据(每秒约 1,000 个事件)。
- Dedicated - 以 2,500 KB/秒的速度获取和处理数据(每秒约 10,000 个事件)。
- URL 参数参数支持源全局变量。 默认情况下,源全局变量将转换为新纪元时间(自 1970 年 1 月 1 日 (UTC) 以来的毫秒数)。 或者,可以将源全局变量转换为新纪元秒(自 1970 年 1 月 1 日以来的秒数)和字符串日期时间格式。 以下概述了源分析变量及其表示的时间。 源在启动或重启后首次运行,$feed.FeedLastScheduledStart 时间 = 当前运行时间 - 5 分钟。
- $feed.FeedStartTime - 开始源的时间
- $feed.FeedScheduledStartTime - 计划下次源循环的时间
- $feed.FeedLastScheduledStartTime - 计划的源上次循环的时间
- Samsara 源将自动处理返回的 data 对象中来自 Samsara API 的 JSON 响应,它将展平 JSON。
- 您可以展平数组并提供特定的数组扁平化免除。 以逗号分隔多个数组展平免除。
- Velocity 将自动处理来自 Samsara API 的分页响应,以处理所有要素。
- 在配置数据源连接参数后,定义模式和关键字段参数。
参数
以下是 Samsara 源的参数:
参数 | 描述 | 数据类型 |
---|---|---|
URL | Samsara API URL。 这应当是 Samsara API 的 GET 请求端点,因为源正在获取数据进行后续处理。 URL 以及提供的 URL 参数共同控制 Samsara API 返回的数据。 要查找 Samsara API 端点 URL,请访问 Samsara API 概述。 | 字符串 |
API 密钥 | Samsara API 密钥。 按以下格式提供 API 密钥:samsara_api_<yourAPIKey>。 | 字符串 |
URL 参数 | 要包含在发送到指定 Samsara URL 的 HTTP 请求 URL 中的可选 URL 参数。 虽然也可以在 URL 参数中设置参数,但是在此处输入的 URL 参数将覆盖为 URL 参数提供的任何匹配参数。 在此处定义的参数将始终使用 URL 编码。 此参数支持源全局变量。 | 键值对 |
全局变量 | 将源全局变量转换为自定义日期时间格式。 设置此参数属于可选操作。 | 字符串 |
其他日志记录 | 指定是否对 Velocity 发送到 Samsara URL 的原始 HTTP 请求和响应进行日志记录。 设置此参数属于可选操作。 注:仅启用此参数以进行故障排除,并在完成故障排除时禁用。 在启用参数后启动源,调试级别日志即会出现在源日志页面上。 如有必要,请联系 Esri 技术 支持 以获得故障排除方面的帮助。 | 布尔 |
注意事项和限制
下面是使用 Samsara 源时的注意事项和限制:
- 要使用此源类型,需要 Samsara 订阅和 API 密钥。
- 当前生成的 Samsara API 使用 RFC 3339 时间戳格式。 要进行配置,将开始时间参数设置为具有此字符串日期时间的字段,并提供 yyyy-MM-dd'T'HH:mm:ss'Z' 的字符串日期时间格式。
- Samsara API 的轮询频率可以为每 5 秒。