Входной коннектор Опрос внешнего веб-сайта на наличие JSON может использоваться для извлечения и адаптации записей данных событий, отформатированных как JSON, с внешнего веб-сайта. Примеры иллюстраций того, в каком виде ArcGIS GeoEvent Server ожидает формат стандартных записей JSON, см. в блоге Esri Community JSON Data Structures - Working with Hierarchy and Multicardinality.
Когда с веб-сервера или веб-сервиса пакетно возвращается множество записей данных событий, они должны быть организованы в массив, как показано ниже. Входящий адаптер универсального файла JSON будет обрабатывать каждый объект в массиве как отдельную запись события.
Примечания по использованию
При работе с входным коннектором Опрос внешнего веб-сайта на наличие JSON имейте в виду следующее:
- Используйте этот входной коннектор для запроса с веб-сервера или веб-сервиса данных, форматированных как JSON, и их адаптации для создания записей данных событий для обработки.
- Этот входной коннектор соединяет в пару Входящий адаптер Generic JSON с Входящим транспортом HTTP.
- Адаптер интерпретирует стандартный JSON, в отличие от объекта JSON или GeoJSON.
- Запись исходного файла JSON не обязательно должна содержать данные, представляющие геометрию.
- Типичные данные о событиях, организованные как массив JSON, показаны выше.
- Адаптер будет управлять как отдельными записями JSON, так и записями JSON, организованными в виде массива.
- Параметр Метод HTTP задает тип запроса HTTP, использующегося для запроса данных с веб-сервиса. По умолчанию применяется запрос HTTP/GET.
- Адаптер поддерживает возможность построения точечной геометрии из атрибутивных значений x, y и z
- Параметры запросы можно настроить с помощью свойства Параметры, чтобы более точно отобрать интересующие данные.
- Настройка параметров запроса как части запроса HTTP/GET может повысить производительность, т.к. уменьшит число возвращаемых элементов.
- Имя и значения определенного параметра запроса зависит от поддержки запросов внешним веб-сервисом.
- Для этого входного коннектора предполагается, что внешний веб-сервер или веб-сервис принимают запросы HTTP/GET, не требуя аутентификации. Если внешние веб-сайты требуют аутентификацию, можно создать собственный входной коннектор, который соединяет в пару Generic JSON Inbound Adapter и HTTP Inbound Transport, поддерживающий базовую, сертифицированную или OAuth аутентификацию.
- Параметр Получать только новые данные используется, чтобы при запросе лента возвращала только ранее не просмотренные или только что обновленные данные. Эта возможность зависит от правильности включения потоком параметра Last-Modified в заголовок ответа на запрос HTTP. Если в заголовке ответа не указывается дата или время последнего обновления, GeoEvent Server предполагает, что данные в ответе представляют новые или обновленные данные. Более подробно об использовании Last-Modified в заголовках ответов в спецификации RFC 7232 HTTP.
- Этот входной коннектор включает параметр Режим обучения, который может быть полезен, если необходимо разрешить входному коннектору изменять построенное им определение GeoEvent. Цель этого параметра состоит в том, чтобы временно принять те полученные данные о событиях, у которых переменная схема или структура данных. Входной коннектор будет использовать образец полученных записей данных, чтобы узнать больше о переменной структуре данных и добавить новые, ранее не наблюдаемые поля атрибутов к существующему определению GeoEvent.
Возможность изменения определения GeoEvent "на лету" может отрицательно повлиять на проект анализа в режиме реального времени в сервисе GeoEvent. Если во входных данных событий ожидается изменение схемы, рекомендуется использовать режим обучения максимально непродолжительное время, чтобы создать определение GeoEvent Definition, которое поддерживает все ожидаемые варианты входных данных. Затем режим обучения можно отключить, а автоматически созданное определение GeoEvent скопировать и адаптировать для производственного развертывания.
Параметры
Ниже приведены параметры для входного коннектора Опрос внешнего веб-сайта на наличие JSON:
| Параметр | Описание |
|---|---|
Имя | Описательное имя входного коннектора, используемое для ссылки в GeoEvent Manager. |
URL | Базовый URL внешнего веб-сайта, содержащего данные JSON. GeoEvent Server отправляет запрос на URL-адрес для извлечения данных JSON. |
Создать определение GeoEvent | Указывает, используется ли новое или существующее определение GeoEvent для данных входящих событий. Определение GeoEvent требуется GeoEvent Server, чтобы понимать поля атрибутов и типы данных входящих событий.
|
Имя определения GeoEvent (новое) (Условия) | Имя, которое присваивается для нового Определения GeoEvent. Если определение GeoEvent с указанным именем уже существует, используется существующее определение GeoEvent. Первая полученная запись данных используется для определения ожидаемой схемы последующих записей данных, на основе которой создается новое определение GeoEvent. Этот параметр показывается, когда для свойства Создать определение GeoEvent задано значение Да, и скрыто, если задано значение Нет. |
Имя определения GeoEvent (существующее) (Условия) | Имя существующего определения GeoEvent для использования при адаптации полученных данных для создания данных событий для обработки сервисом GeoEvent. Этот параметр показывается, когда для свойства Создать определение GeoEvent задано значение Нет, и скрыто, если задано значение Да. |
Метод HTTP | Указывает метод HTTP-запроса, который применяется, когда GeoEvent Server опрашивает внешний сервер, предоставляющий поток данных. По умолчанию применяется запрос HTTP/GET.
Технически, в запросе всегда должен использоваться HTTP/GET при обращении к данным веб-сервера или веб-сервиса. Изменение этого параметра на POST или PUT открывает другие параметры, которые не относятся к данному входному коннектору |
Запрос Post от Тело запроса Post Тип MIME тела сообщения Параметры запроса Post (Условия) | Эти параметры скрыты по умолчанию, когда для свойства Метод HTTP задано Get. Подробнее см. раздел ниже Советы и ограничения. |
Пространственная привязка по умолчанию | Известный идентификатор (WKID) пространственной привязки, используемый при построении геометрии из значений полей атрибутов, координаты которых не являются значениями широты и долготы для предполагаемой географической системы координат WGS84, или когда получены строки геометрии, не содержащие пространственной привязки. Также может быть указано известное текстовое значение (WKT) или имя поля атрибута, содержащего WKID или WKT. |
Получать только новые данные | Указывает, выполняет ли адаптер поиск последнего измененного значения в заголовке ответа канала данных и пытается ли использовать это значение, чтобы избежать обработки данных, которые уже были получены, но не обновлены. Название этого параметра может ввести в заблуждение. Транспорт всегда получает любые данные, которые канал включает в свой ответ на запрос коннектора. Однако, если указано значение Получать только новые данные, транспорт кэширует дату и время последнего запроса и ретранслирует полученные данные адаптеру только в том случае, если ответ из канала данных содержит последнее измененное значение, которое больше, чем кэшированное значение транспорта. Указание последнего измененного значения необязательно. На практике не многие каналы данных включают его в свои ответы. Значение по умолчанию для этого параметра — Да, но если последнее измененное значение не найдено, параметр игнорируется, поскольку дата/время, необходимые для определения того, являются ли данные в ответе новыми или обновленными, недоступны.
Подробнее об использовании Последнего измененного значения в заголовке ответов см. спецификацию RFC 7232 HTTP. |
Частота (в секундах) | Интервал (в секундах), по истечении которого внешний веб-сервер или веб-сервис опрашивается для получения данных. Значение по умолчанию — 10 секунд (один запрос опроса выполняется каждые 10 секунд). |
Имя параметра заголовка:Список значений | Параметры, включаемые в HTTP-заголовок запроса при опросе внешнего веб-сервера или веб-сервиса. Параметры заголовка должны быть заданы с помощью пар Имя: Значение (включая двоеточие), разделенных запятыми. |
Построить геометрию из полей | Указывает, будет ли входной коннектор создавать геометрию точки, используя значения координат, полученные в качестве атрибутов. По умолчанию Нет.
|
Поле геометрии X (Условия) | Поле атрибута в данных входящего события, содержащее координатную часть X (например, горизонталь или долготу) местоположения точки. Этот параметр показывается, когда для Построить геометрию из полей задано значение Да, и скрыто, если задано значение Нет. |
Поле геометрии Y (Условия) | Поле атрибута в данных входящего события, содержащее координатную часть Y (например, вертикаль или широту) местоположения точки. Этот параметр показывается, когда для Построить геометрию из полей задано значение Да, и скрыто, если задано значение Нет. |
Поле геометрии Z (Условия) | Поле атрибута в данных входящего события, содержащего координатную часть Z (например, глубина или высота) местоположения точки. Если значение не предоставлено, значение z опускается и строится 2D геометрия точки. Этот параметр показывается, когда для Построить геометрию из полей задано значение Да, и скрыто, если задано значение Нет. |
Имя объекта JSON | Имя элемента JSON, который может использоваться в качестве корневого узла подструктуры в пределах полученных данных JSON. Когда Имя объекта JSON используется для указания элемента JSON по имени, адаптер ищет подструктуры, имя объекта которых соответствует указанному имени элемента. Рассматриваются только данные в пределах идентифицированной подструктуры. Если оставить пустым, что является значением по умолчанию, верхний объект JSON используется в качестве корня всей структуры JSON. |
Параметры | Параметр запроса (или несколько параметров запроса), присоединяемые к базовому URL. Параметры запроса будут разными для каждого веб-сервиса и поддерживаются не всеми сервисами. Если поддерживаются, параметры запроса помогают указать данные, представляющие особый интерес. У этого параметра нет значения по умолчанию. Параметры запроса обычно включены в параметр URL. |
Использовать URL-адрес прокси | Указывает, использует ли GeoEvent Server URL-адрес прокси при выполнении HTTP-запросов. По умолчанию Нет.
|
URL-адрес прокси (Условия) | URL-адрес прокси, который используется во время запроса HTTP. Этот параметр показывается, когда для свойства Использовать URL-адрес прокси задано значение Да, и скрыто, если задано значение Нет. |
Ожидаемый формат данных | Шаблон, используемый для соответствия ожидаемым строковым представлениям значений даты/времени и преобразования их в значения даты Java. Формат шаблона следует нормам для класса Java SimpleDateFormat. Хотя предпочтительным шаблоном для значений даты/времени в GeoEvent Server является стандарт ISO 8601, несколько строковых представлений значений даты/времени, обычно распознаваемых как значения даты, могут быть преобразованы в значения даты Java без указания значения Ожидаемого формата даты. К ним относятся:
Если полученные значения даты/времени используют соглашение, отличное от перечисленных выше, необходимо указать ожидаемый шаблон формата даты, чтобы GeoEvent Server мог адаптировать значения даты/времени. |
Допустимые типы MIME (режим клиента) (Условия) | Указывает типы MIME, которые принимает этот коннектор при получении ответа на запрос к каналу данных. Ответ внешнего веб-сервиса указывает фактический тип(ы) MIME для любых данных, отправленных на GeoEvent Server. Этот коннектор поддерживает следующие типы MIME, которые принимаются по умолчанию для этого параметра: text/json,application/json Подробнее об официальных типах MIME см. Internet Assigned Numbers Authority (IANA). Подробнее о типах MIME, которые не используются ArcGIS Server, см. Типы MIME, не используемые ArcGIS Server. Этот параметр показывается, когда для Метода HTTP задано значение Get, и скрыто, если задано значение Post или Put. |
Допустимые типы MIME (режим Server) (Условия) | Определяет типы MIME, которые принимает входной коннектор. Используйте запятые для разделения значений, например text/plain,application/xml,text/xml. Типы MIME обычно состоят из структуры типа и подтипа и используются, когда сервер должен указать типы интернет-медиа данных, которые он получает от клиентов. По умолчанию используется application/json, который является официальным типом MIME для обмена JSON между клиентом и сервером. Подробнее об официальных типах MIME см. Internet Assigned Numbers Authority (IANA). Подробнее о типах MIME, которые не используются ArcGIS Server, см. Типы MIME, не используемые ArcGIS Server. Примечание:Этот параметр доступен только в том случае, если коннектор настроен в режиме сервера. |
Ожидание HTTP (в секундах) | Максимальное время ожидания (в секундах) входным коннектором ответа от внешнего веб-сервиса, к которому он отправил запрос. Указанное значение должно быть задано целым числом от 1 до 2147483. Значение по умолчанию – 30 секунд (HTTP-запрос останавливается через 30 секунд, если ответ не получен). |
Режим Обучение | Указывает активен или недоступен Режим обучения. Если для Режим обучения задано значение Да, входящий адаптер добавляет новые поля к определению GeoEvent, которое он создал и поддерживает.
Режим обучения может быть полезен, если необходимо разрешить входному коннектору изменять построенное им определение GeoEvent. Цель этого параметра состоит в том, чтобы временно принять те полученные данные событий, у которых переменная схема или структура данных. Входной коннектор использует образец полученных записей данных, чтобы определить дополнительную информацию о переменной структуре данных и добавить новые, ранее не наблюдаемые поля атрибутов к существующему определению GeoEvent. Возможность изменить определение GeoEvent на лету может негативно повлиять на дизайн аналитики в режиме реального времени в сервисе GeoEvent. Если во входных данных события ожидается изменение схемы, рекомендуется, по возможности, использовать Режим обучения непродолжительное время, чтобы создать определение GeoEvent, которое поддерживает все ожидаемые варианты входящих данных. Затем Режим обучения можно отключить, а автоматически созданное определение GeoEvent скопировать и адаптировать для производственного развертывания. |
Советы и ограничения
Всегда используйте запрос HTTP/GET, который не включает тело содержимого, и используйте параметры запроса для указания интересующих данных. Приведенные ниже параметры применимы только к выходным коннекторам, которые отправляют данные на внешний веб-сервер или веб-сервис. Оставьте для параметра Метод HTTP значение по умолчанию HTTP/GET, и эти параметры останутся скрытыми.
| Параметр | Описание |
|---|---|
Запрос Post от (Условия) | Указывает, использует ли этот коннектор запрос HTTP/POST или HTTP/PUT.
Этот параметр показывается, когда для свойства Метод HTTP задано значение Post или Put, и скрыто, если задано значение Get. |
Тело запроса Post (Условия) | Данные, которые включаются в тело содержимого запроса HTTP/POST или HTTP/PUT. Этот параметр показывается, когда для свойства Запрос Post от задано значение Тело содержимого, и скрыто, если задано значение Параметры. |
Тип MIME тела сообщения (Условия) | Тип MIME данных которые включаются в тело содержимого HTTP-запроса. Типы MIME обычно состоят из структуры типа и подтипа и используются для указания типов интернет-носителей, используемых и принимаемых HTTP-клиентом и сервером. Этот параметр показывается, когда для свойства Запрос Post от задано значение Тело содержимого, и скрыто, если задано значение Параметры. |
Параметры запроса Post (Условия) | Параметры, которые включаются в HTTP-запрос. Укажите значение Параметров, используя пары Имя:Значение (включая двоеточие), разделенные запятыми. У этого параметра нет значения по умолчанию. Этот параметр показывается, когда для свойства Запрос Post от задано значение Параметры, и скрыто, если задано значение Тело содержимого. |