Skip To Content

接收 WebSocket 上的 JSON

“接收 WebSocket 上的 JSON”输入连接器可用于在由 ArcGIS GeoEvent Server 托管的 WebSocket 上接收和改编格式为通用 JSON 的事件数据。 给定一个标准 GeoEvent Server 配置时,客户端应期望订阅数据并将其发送到格式为 wss://<machine_name>.<domain>:6143/path 的端点,其中 path 是指定为输入连接器 URL 路径参数的值。

此输入连接器作为服务器运行,旨在使客户端应用程序可以订阅数据并将其发送到 GeoEvent Server。 如果您正在寻找一个可作为客户端运行并可订阅服务器的 WebSocket 数据广播的输入连接器,请考虑使用订阅外部 WebSocket 以获取 JSON

事件数据以 JSON 数组的形式组织。

用法说明

使用“接收 WebSocket 上的 JSON”输入连接器时,应记住以下事项:

  • 使用此输入连接器可通过 GeoEvent Server 托管的 WebSocket 接收格式为通用 JSON 的数据。
  • 此输入连接器可将通用 JSON 入站适配器与 WebSocket 入站传输进行配对。
  • 此输入连接器作为服务器运行并为客户端应用程序提供可订阅以将数据发送到 GeoEvent Server 的 WebSocket。
  • 适配器将对通用 JSON(而不是要素 JSONGeoJSON)进行解释。 请注意,GeoJSON 和要素 JSON 均为通用 JSON 的变体;不同 GeoEvent Server 适配器可用于处理这些特定格式。
  • 有关 JSON 结构的其他信息,请参阅 Esri Community 博客 JSON 数据结构 - 使用层次结构和多基数关系
  • 以 JSON 数组形式组织的典型事件数据如上图所示。
  • 适配器将对组织在一个数组中的单个 JSON 记录和 JSON 记录进行处理。
  • 通用 JSON 记录无需包含表示几何的数据。
  • 适配器支持根据 x、y 和 z 属性值构造点几何的功能。
  • 此连接器支持 WebSocket (ws) 和 WebSocket Secure (wss) 协议。
  • 希望将数据发送到 WebSocket 端点的客户端应使用 ws://<machine_name>.<domain>:6180/path
  • 此输入连接器包括学习模式参数,您可以使用此参数允许输入连接器修改其构造的 GeoEvent 定义。 此参数的目的是暂时接受所接收的事件数据将具有变量方案或数据结构。 输入连接器将使用所接收数据记录的样本来了解有关变量数据结构的详细信息,并将先前未发现的新属性字段追加到现有 GeoEvent 定义中。

    允许动态更改 GeoEvent 定义会对 GeoEvent 服务中的实时分析设计产生负面影响。 最佳做法是,如果入站事件数据中预期存在方案差异,建议您在尽可能短的时间内使用学习模式,以生成支持入站数据所有预期变体的 GeoEvent 定义。 然后,可以关闭学习模式,自动生成的 GeoEvent 定义将进行复制和定制以用于生产部署。

参数

以下是“接收 WebSocket 上的 JSON”输入连接器的参数:

参数描述

名称

用于在 GeoEvent Manager 中引用的输入连接器的描述性名称。

URL 路径

完整的 URL 端点包括协议、主机名或 IP 地址、端口和路径。 此连接器仅需要指定 URL 的路径。 默认值为 /ws

客户端将用于订阅的完整 URL 将类似于:ws://<machine_name>.<domain>:6180/pathwss://<machine_name>.<domain>:6143/path

例如,如果 URL 路径被指定为 /SampleRecords,则客户端将数据发送到 WebSocket 安全 URL 时将使用 wss://PS000123.esri.com:6143/SampleRecords(表示 esri.com 域中名为 PS000123 的计算机)。

创建 GeoEvent 定义

指定是否应将新的或现有的 GeoEvent 定义用于入站事件数据。 GeoEvent Server 需要 GeoEvent 定义,以了解入站事件数据属性字段和数据类型。

  • - 将根据收到的第一个事件记录的模式创建新的 GeoEvent 定义。
  • - 不会创建新的 GeoEvent 定义。 选择与入站事件数据的方案匹配的现有 GeoEvent 定义。

GeoEvent 定义名称(新)

(条件分析)

分配给新 GeoEvent 定义的名称。 如果已存在具有指定名称的 GeoEvent 定义,则会使用现有的 GeoEvent 定义。 收到的第一个数据记录将用于确定后续数据记录的预期方案,将根据第一个数据记录的方案创建新的 GeoEvent 定义。

此参数在创建 GeoEvent 定义设置为时显示,设置为时隐藏。

GeoEvent 定义名称(现有)

(条件分析)

在调整接收数据以创建事件数据以供 GeoEvent 服务处理时使用的现有 GeoEvent 定义的名称。

此参数在创建 GeoEvent 定义设置为时显示,设置为时隐藏。

默认空间参考

当从坐标不是假定的 WGS84 地理坐标系的纬度和经度值的属性字段值构造几何时使用的空间参考的熟知 ID (WKID),或接收的不包含空间参考的几何字符串。 还可以指定熟知文本 (WKT) 值或包含 WKID 或 WKT 的属性字段的名称。

JSON 对象名称

JSON 元素的名称,可用作接收的 JSON 数据中子结构的根结点。 当 JSON 对象名称用于按名称指定 JSON 元素时,适配器将搜索对象名称与指定元素名称匹配的子结构。 仅考虑所识别的子结构内的数据。 如果保留为空(默认值),则最上面的 JSON 对象将用作整个 JSON 结构的根。

预期日期格式

该模式用于匹配日期/时间值的预期字符串表示形式,并将它们转换为 Java 日期值。 模式的格式遵循 Java SimpleDateFormat 类约定。

GeoEvent Server 更偏好以 ISO 8601 标准表示的日期/时间值,通常被识别为日期值的日期/时间值的多个字符串表示可以转换为 Java 日期值,且无需指定预期日期格式模式。 其中包括:

  • “2019-12-31T23:59:59”- ISO 8601 标准格式
  • 1577836799000 - Java 日期(时间长整型;UTC)
  • “Tue Dec 31 23:59:59 -0000 2019”- 常见的 web 服务字符串格式
  • “12/31/2019 11:59:59 PM”- 美国使用的通用格式(12 小时制)
  • “12/31/2019 23:59:59”- 美国使用的通用格式(24 小时制)

如果收到的日期/时间值使用并非上述五种之一的约定表示,则必须指定一个预期日期格式模式以便 GeoEvent Server 了解如何调整日期/时间值。

从字段构建几何

指定输入连接器是否应使用作为属性接收的坐标值构造点几何。 默认为

  • - 来自指定事件属性字段的值将用于构造点几何。
  • - 不会构造点几何。 假定属性字段包含可以解释为几何的值,或者事件记录为非空间记录(不具有几何)。

X 几何字段

(条件分析)

入站事件数据中包含点位置 x 坐标部分(例如水平或经度)的属性字段。

此参数在从字段构建几何设置为时显示,设置为时隐藏。

Y 几何字段

(条件分析)

入站事件数据中包含点位置 y 坐标部分(例如垂直或纬度)的属性字段。

此参数在从字段构建几何设置为时显示,设置为时隐藏。

Z 几何字段

(条件分析)

入站事件数据中包含点位置 z 坐标部分(例如深度或高度)的字段的名称。 如果留空,则将省略 z 值,并将构建 2D 点几何。

此参数在从字段构建几何设置为时显示,设置为时隐藏。

学习模式

指定学习模式为活动还是禁用状态。 学习模式设置为时,入站适配器会将新字段追加到其已创建和正在维护的 GeoEvent 定义中。

  • - 将启用学习模式。 将使用共享不同方案的事件记录中的新字段更新 GeoEvent 定义。
  • - 不会启用学习模式。 不会修改 GeoEvent 定义。

当您需要允许输入连接器修改它构建的 GeoEvent 定义时,学习模式会很有用。 此参数的目的是暂时接受所接收的事件数据将具有变量方案或数据结构。 输入连接器将使用所接收数据记录的样本来了解有关变量数据结构的详细信息,并将先前未发现的新属性字段追加到现有 GeoEvent 定义中。

允许在运行中更改 GeoEvent 定义会对 GeoEvent 服务中的实时分析设计产生负面影响。 如果入站事件数据中预期存在方案差异,建议您在尽可能短的时间内使用学习模式,以生成支持入站数据所有预期变体的 GeoEvent 定义。 然后,可以关闭学习模式并为生产部署复制和定制自动生成的 GeoEvent 定义。


在本主题中
  1. 用法说明
  2. 参数