Настройки веб-инструментов

От настроек параметров, которые вы выберете при публикации инструмента в качестве веб-инструмента, будет зависеть то, как эти параметры будут использоваться клиентскими приложениями. Наиболее общие и часто изменяемые параметры инструмента могут быть заданы при его публикации. Специальные параметры могут быть изменены в ArcGIS Server Manager после публикации инструмента. Некоторые расширенные настройки можно задать только на ArcGIS Server Administrator REST API. Только для немногих инструментов (сервисов геообработки) когда-либо требуется изменять эти расширенные параметры.

Настройки

В подразделах ниже описаны настройки, которые можно использовать при публикации инструментов.

Общие

Доступны следующие общие настройки параметров:

Параметр	Описание
Имя	Имя веб-инструмента для публикации на вашем портале. Это имя должно быть уникальным на портале и не должно содержать пробелов или специальных символов. Этот параметр наследуется от метаданных инструмента.
Краткая информация	Краткая информация и теги, представляющие описание, которое делает веб-инструмент доступным для поиска. Эти параметры наследуются из метаданных инструмента. При публикации на ArcGIS Enterprise 10.9 или более ранний портал требуются краткая информации и тэги. Вы можете использовать максимум 128 тегов.
Теги
Версия	Версия ArcGIS Enterprise или ArcGIS Server, которая будет доступен для вас. Этот параметр доступен только если вы сохраняете автономное определение сервиса для веб-инструмента или сервиса геообработки.
Данные	Определяет, что произойдет с данными: Данные не по URL — задает, будут ли данные копироваться на сервер (становиться статичными), или инструмент будет к ним обращаться по ссылке как прежде. Совпадающая запись в серверном хранилище данных должна быть настроена для данных, чтобы использовалась опция Ссылаться на зарегистрированные данные. Если хранилище данных сервера не выполнит соответствующие настройки для данных, они будут скопированы во время публикации. Это применимо только при публикации в качестве веб-инструмента или при сохранении в качестве подключенного определения сервиса. Если вы сохраните результат как автономное определение сервиса, убедитесь, что на все данные параметра можно ссылаться, выбрав опцию Базовые данные, поскольку альтернативы копированию данных нет, если хранилище данных сервера не выполнит соответствующие настройки для данных. Данные по URL — задает, будут ли данные оставаться в виде URL или конвертироваться в другой тип данных при публикации. Данная опция доступна в ArcGIS Pro 3.2 10.5 и более поздних версий. Данные URL-адресов относятся к URL-адресам различных типов веб-слоев или сервисов. Можно настраивать только векторные слои, сервисы объектов или подслои объектов веб-слоев изображений. Если отметка Конвертировать векторный слой стоит, векторный слой или сервис из параметра или проекта преобразуются в класс объектов во время публикации. Если отметки нет, URL-адрес векторного слоя сохраняется. Нет возможности преобразовать URL веб-слоев изображений, так как URL всегда будет сохранен при публикации. По умолчанию эта опция включена. Подробнее о копировании, привязке и использовании данных URL.
Местоположение	Указывает, где будет создан элемент веб-инструмента: Папка – выберите или создайте папку портала, в которой будет создан элемент веб-инструмента. По умолчанию будет использоваться корневой каталог портала. Сервер и Папка – Для сервера, веб-инструменты должны быть опубликованы на портале с одним или несколькими интегрированными серверами. Если на портале имеется более одного интегрированного сервера, вы можете назначить сервер, на котором будет опубликован веб-инструмент. Для папки, можно либо выбрать имеющуюся папку, либо создать новую на сайте ArcGIS Server. По умолчанию будет использоваться корневой каталог сайта ArcGIS Server.
Общий доступ с помощью	Указывает, для кого и в каких группах будет опубликован веб-инструмент. Веб-инструмент будет всегда публиковаться в Моих ресурсах. Публикация веб-инструмента Для всех делает элемент публичным, любой, кто имеет доступ к веб-сайту портала, может найти и использовать его, а владельцы групп могут добавлять его в ресурсы своих групп. При публикации веб-инструмента на ArcGIS Enterprise он станет доступен для всех участников портала, имеющих доступ к элементу. Можно опубликовать его для любой группы, в которой вы состоите в настоящий момент.

Конфигурация

Доступны следующие настройки параметров конфигурации:

Параметр	Описание
Загрузка	Управляет тем, может ли клиент загрузить файл на ваш сервер, чтобы использовать его как входные данные для веб-инструмента. Операция загрузки используется, в основном, веб-клиентами, которые нуждаются в способе отправки файлов на сервер для обработки. Операции отправки возвращают уникальный идентификатор для файла после завершения загрузки, который веб-приложение потом может передать веб-инструменту. По умолчанию эта опция отключена. Разрешение загрузок на ваш сервис может поставить под удар безопасность. Включайте его только при необходимости.
Режим выполнения	Указывает, как клиент (приложение, использующее веб-инструмент) будет взаимодействовать с веб-инструментом и получать выходные данные. Когда веб-инструмент настроен на Синхронный, клиент ждет, пока задача будет завершена. Как правило, синхронный сервис выполняется быстро (за несколько секунд). При настройке Асинхронный сервис обычно выполняется медленнее, а клиент должен периодически запрашивать сервер, чтобы определить, выполнена ли задача, и если задача выполнена, получить результат. Веб-приложение, использующее асинхронный сервис, должно иметь реализованную логику для проверки статуса и обработки результата, когда выполнение будет завершено.
Просмотреть выходные данные в слое изображений карты	При публикации веб-инструмента вы можете выбрать просмотр выходных данных как изображения карты. Изображение карты создается на сервере с помощью сервиса, а затем отправляется обратно клиенту в виде изображения (файл .tiff с информацией стиля). Символы, надписи, прозрачность и другие свойства изображения карты соответствуют свойствам выходного слоя из сеанса ArcGIS Pro во время исходной публикации. Ниже приведены причины, по которым обычно используется опция Просматривать выходные данные в слое изображений карты: Если инструмент создает большое количество объектов, которым клиент должен присваивать символы, а затем отображать, будет быстрее, если клиент получит изображение карты. В целях распределения данных нет необходимости отправлять клиенту какие-либо объекты, а только изображение карты. Результатом работы инструмента является не подлежащий передаче набор данных, такой как сетевой набор данных или топология. Единственный способ передать выходные данные клиенту – это использовать изображение карты. Примечание: Выходное изображение карты может использоваться только в том случае, если для веб-инструмента установлено значение Асинхронный. Этот параметр не поддерживается при публикации веб-инструмента в Kubernetes.
Уровень сообщения	Можно возвращать следующие сообщения различных уровней клиенту, который запустил веб-инструмент: Нет – клиенту не возвращаются сообщения геообработки, только сообщение о том, что выполнение было завершено успешно или со сбоем. Используется по умолчанию. Ошибка – клиенту возвращаются только те сообщения инструмента, которые свидетельствуют об ошибке. Предупреждение – клиенту возвращаются все сообщения об ошибках и предупреждения инструмента. Информация – клиенту возвращаются все сообщения, касающиеся выполнения инструмента. Внимание: Все сообщения, независимо от уровня, могут содержать пути и имена наборов данных, что может представлять угрозу безопасности. Уровень Информация является самым подробным и, как правило, содержит ссылки на пути к наборам данным и их имена. В общем виде, следует возвращать сообщения во время разработки, но отключать их в производственной среде.
Максимальное число возвращаемых записей	Максимальное количество результатов, которое сервис может вернуть клиенту. Чем большее значение будет задано для этого параметра, тем большее число записей или объектов, направляемых клиенту, сможет обрабатывать ГИС-сервер. Если не нужно возвращать какие-либо объекты, установите для этого параметра значение 0 (нуль). Как правило, это значение равно нулю только при включенном параметре Просмотреть выходные данные в слое изображений карты.

Упомянутые выше настройки параметра могут быть изменены в ArcGIS Server Manager после того, как веб-инструмент будет опубликован. Исключение составляют только краткая информация и теги. Описательная информация может быть загружена на страницу элемента для публикуемого веб-инструмента на вашем портале.

Содержание

Следующие настройки могут быть изменены только в момент публикации веб-инструмента.

Добавить инструмент

Чтобы добавить к существующему веб-инструменту дополнительные инструменты из истории геообработки, щелкните кнопку Добавить инструмент на вкладке Содержание. Чтобы удалить инструмент, щелкните имя инструмента и выберите Удалить.

Настройка свойств инструмента

Чтобы настроить свойства инструмента, нажмите кнопку редактирования рядом с названием инструмента.

Свойство	Описание
Имя	Имя инструмента. Значение по умолчанию основано на метаданных инструмента.
Описание	Описание инструмента. Описание не наследуется из метаданных инструмента. Если поле пустое, предоставьте описание, и оно будет оставаться при каждой публикации из истории.

Для каждого из параметров можно настроить следующие свойства:

Свойство	Описание
Имя	Имя и описание параметра. Оба свойства наследуются от названия параметра и описания в метаданных инструмента. Здесь вы можете их изменить, не затрагивая исходные метаданные инструмента.
Описание
Тип	Тип параметра определяет, должен ли клиент передавать какое-либо значение для успешной работы инструмента. На вкладке Содержание можно только заменять необязательные параметры на обязательные. Чтобы изменить обязательный параметр на дополнительный, необходимо выйти из панели публикации, изменить свойства инструмента и повторно запустить его, чтобы получить новый результат.
Сохранять тип данных как Составной	Это свойство доступно только в том случае, если параметр является составным типом данных. Он указывает, будет ли параметр опубликован как составной тип данных (отмечено). По умолчанию не отмечен.
Режим ввода	Указывает, как клиенты будут вводить пространственные объекты в задачу. О разработке и использовании графического интерфейса см. Режим ввода параметра. Определяемое пользователем значение – значение для параметра предоставляет клиент. Список вариантов – представлен список строк (список вариантов), и клиент должен выбрать одну или несколько строк из этого списка. В зависимости от типа входных данных, строки могут быть именами слоев или простыми опциями ключевых слов. Постоянное значение – будет использовано значение, предоставленное вами для параметра при создании результата. Поскольку это значение является постоянным, клиент не может его изменить и, следовательно, оно не станет параметром задачи при публикации сервиса. Смешанный режим: заданный пользователем и список выбора — доступно только для составных параметров или параметров таблицы значений. Вы можете настроить режим ввода для каждого типа данных в составном типа или для каждого типа данных в каждом столбце таблицы значений. Если какой-либо тип данных не поддерживает список выбора, для настройки будет доступна только опция, определенная пользователем.
Преобразовать тип данных в Строку	Это свойство применимо только к типу данных "единица измерения площади". Оно указывает, будет ли единица измерения площади преобразована в строковый тип данных (отмечено) или опубликована как единица измерения площади (не отмечено). По умолчанию не отмечен.
Удалить значение по умолчанию	Если отмечено, начиная с ArcGIS Pro 3.3, значение по умолчанию, используемое при запуске инструмента, будет удалено в процессе публикации. По умолчанию не отмечен.
Значение по умолчанию	Значение по умолчанию для инструмента определяется значением параметра, указанным во время исполнения инструмента. Чтобы добавить или изменить значение параметра по умолчанию, снова запустите этот инструмент с соответствующим параметром.
Использовать только слои по умолчанию	Это свойство применимо только к режиму ввода списка вариантов. Оно указывает, будут ли отмечены только те опции, которые используются при запуске инструмента, в отображении списка под этой отметкой (отмечено). По умолчанию не отмечен.
Тип геометрии	Это свойство применяется только к объектам. Типы геометрии определяется входными и выходными объектами, которые использовались для получения результата. Его нельзя изменить на вкладке Содержание. Необходимо перезапустить инструмент, используя объекты с указанным типом геометрии, а затем опубликовать результат операции.
Схема	Это свойство применяется только к объектам и таблицам. Схема – это список полей (атрибутов), которые должны быть предоставлены клиентом при построении объектов для входных данных для этого инструмента. Этот список полей аналогичен тому слою или набору данных, которые использовались в качестве входных или выходных данных для инструмента, создавшего этот результат.

Следующие параметры конфигурации применимы ко всему инструменту в целом:

Параметр	Описание
Добавить дополнительный параметр выходного сервиса объектов	Дополнительный выходной параметр, который указывает, можно ли сохранять выходные данные в качестве сервиса объектов при использовании веб-инструмента (отмечено). Этот параметр поддерживается только при публикации в качестве веб-инструмента в асинхронном режиме. В противном случае он недоступен для настройки. Эта опция по умолчанию включена.
Удалить все значения по умолчанию	Если отмечено, начиная с ArcGIS Pro 3.3, значение по умолчанию, используемое при запуске инструмента, будет удалено, и флажок Удалить значение по умолчанию в приведенной выше конфигурации параметров инструмента будет автоматически установлен. По умолчанию не отмечен

Настройки ArcGIS Server Manager

Настройки параметра в подразделах, указанных ниже, могут изменяться только в ArcGIS Server Manager. Упомянутые выше настройки конфигурации могут быть также изменены в ArcGIS Server Manager после того, как сервис будет опубликован.

Примечание:

При изменении следующих настроек сервис потребуется перезапустить.

Параметры

Доступны следующие настройки параметров:

Параметр	Описание
Кластер	Кластер, в котором будет выполняться сервис. Эту настройку можно изменить только в том случае, если ArcGIS Server принимает участие в кластере.
Директории	Каталоги, используемые сервером для записи файлов при выполнении инструмента.

Функциональные возможности

В настоящее время доступны следующие настройки параметров функциональных возможностей:

Параметр	Описание
WPS	Включает возможности WPS в сервисах геообработки, позволяя другим клиентам подключаться и использовать инструменты через стандартные протоколы OGC. Подробнее о протоколе WPS

Слияние сервисов

Доступны следующие настройки параметров слияния:

Параметр	Описание
Число экземпляров	Минимальное и максимальное количество экземпляров сервиса. Значения по умолчанию: 1 (минимум) и 2 (максимум). Установка минимального значения, равного 0, сокращает системные ресурсы; экземпляр будет стартовать по запросу клиента.
Максимальное время использования сервиса клиентом	Максимальное время (в секундах) использования сервиса. Может понадобится увеличить значение по умолчанию, равное 600 секунд (10 мин), чтобы выполнять долгосрочные задачи геообработки. Кроме того, можно уменьшить это время, чтобы гарантировать, что клиент не будет злоупотреблять сервисами.
Максимальное время ожидания клиентом доступа к сервису	Максимальное время, в секундах, в течение которого клиент будет ждать подключения к экземпляру, прежде чем истечет срок ожидания. Когда все экземпляры заняты обработкой запросов, последующий запросы добавляются в очередь. Если срок ожидания истекает до того, как экземпляр станет доступным, задача завершится со сбоем. Значение по умолчанию – 60 секунд (1 минута).
Максимальное время работы простаивающего экземпляра	Максимальное время в секундах, в течение которого экземпляр будет оставаться активным до сжатия пула. Любые экземпляры, которые превышают минимальное количество неиспользованных экземпляров, будут закрыты после истечения максимального времени в состоянии простоя.

Процессы

В настоящее время доступны следующие настройки параметров процессов:

Параметр	Описание
Recycling	Задаёт, с какой периодичностью и когда выполнять повторный запуск сервиса. По умолчанию – один раз в 24 часа, начиная с полночи. Сервисы геообработки могут запускаться только при высокой изоляции, в отличие от других типов сервисов, которые могут запускаться при низкой и высокой изоляции.