Добавление и настройка шага Запустить инструмент геообработки Pro

Шаг Запустить инструмент Pro GP запускает настроенный инструмент, скрипт Python или модель ModelBuilder в ArcGIS Pro.

После выполнения шага в листе задания появляется значок Запуск . Когда инструмент запускается, появляется значок Выполняется , указывающий на то, что инструмент работает.

Если какой-либо из параметров шага сконфигурирован с выражением ArcGIS Arcade, эти параметры преобразуются в соответствующие значения перед запуском сервиса геообработки.

Если опция Видимый в момент выполнения включена, инструмент, настроенный на шаге, открывается на панели Геообработка и позволяет определять значения параметров перед запуском инструмента. Если значения параметров по умолчанию были настроены, они появляются при запуске шага и могут быть переопределены. Если значения Подсказка пользователя и Справка по шагам не были настроены для шага, шаг завершится автоматически при запуске.

Примечание:

Если значение параметра, полученное из выражения Arcade, несовместимо с инструментом, шаг не выполняется.

Когда шаг запущен, могут быть выполнены следующие действия:

• Если включена опция Видимый в момент выполнения, можно указать значения параметров и запустить шаг, щелкнув Запустить на панели Геообработка.
• Шаг можно отменить, щелкнув кнопку Отмена.

  Примечание:

  В некоторых случаях вы не сможете отменить этот шаг после его запуска.

Настройка шага

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

1. Создайте или отредактируйте схему рабочего процесса, чтобы получить доступ к панели Библиотека шагов.
2. Перетащите Запустить инструмент Pro GP из панели Библиотека шагов на стрелку соединения шага на канве рабочего процесса.

   Более подробно о добавлении шагов к схеме рабочего процесса

   Появится панель Подробная информация о шаге.

3. Укажите имя шага в текстовом окне Имя шага.
4. Дополнительно, добавьте сообщение, которое хотите отобразить при выполнении шага, в текстовое окно Подсказка пользователя.

   Если подсказка пользователя содержит обычный текст и выражения ArcGIS Arcade, отформатируйте текст следующим образом:

   'This job is currently assigned to ' + JobOwner($Job) + '.'

   Подсказка:

   Нажмите Этот входной параметр поддерживает выражения Arcade и выберите выражение Arcade, чтобы добавить его в соответствующее текстовое поле.

5. Выберите тип инструмента, который вы хотите запустить, в разделе Аргументы:
   • Системный набор инструментов - Инструменты геообработки, включенные в ArcGIS Pro, или наборы инструментов, импортированные в проект ArcGIS Pro.
   • Другой набор инструментов - Пользовательские инструменты геообработки и скрипты.
6. Если вы выбрали Системный набор инструментов, выберите псевдоним набора инструментов в ниспадающем меню Псевдоним набора инструментов.

   Для ссылки на псевдоним панели инструментов с помощью выражения Arcade щелкните стрелку ниспадающего меню Изменить тип входных данных и щелкните Arcade.

7. Если у вас нет набора инструментов, связанного со схемой рабочего процесса, добавьте ссылку на данные ArcGIS Pro:
   1. Щелкните Добавить ссылку на данные ArcGIS Pro в ниспадающем меню Псевдоним набора инструментов.

      Откроется диалоговое окно Добавить ссылку на данные ArcGIS Pro в котором в поле Тип элемента Pro установлено значение Системный набор инструментов.

   2. Укажите псевдоним системного набора инструментов или набора инструментов, импортированного в проект ArcGIS Pro, содержащий инструмент, который вы хотите запустить, в текстовом поле Псевдоним набора инструментов Pro.

      Псевдоним набора инструментов системного набора инструментов можно найти на вкладке Python на странице справки инструмента в документации ArcGIS Pro.

      Чтобы просмотреть псевдоним набора инструментов, импортированного в проект ArcGIS Pro, щелкните его правой кнопкой мыши на панели Каталог и щелкните Свойства.

   3. Щелкните OK, чтобы сохранить ссылки на данные ArcGIS Pro, или щелкните Отмена, чтобы выйти.

      Псевдоним набора инструментов отображается в ниспадающем меню Псевдоним набора инструментов.

      Более подробно об управлении ссылками на данные

8. Если вы выбрали Другой набор инструментов, укажите полный путь к набору инструментов в текстовом поле Путь набора инструментов.

   Путь к набору инструментов может ссылаться на наборы инструментов, хранящиеся в файловой базе геоданных или многопользовательская база геоданных. Путь должен быть доступен в ArcGIS Pro.

9. Укажите имя инструмента, который вы хотите запустить, в текстовом окне Имя инструмента.

   Имя инструмента можно найти на вкладке Python на странице справки инструмента в документации ArcGIS Pro.

   Для ссылки на имя инструмента с помощью выражения Arcade щелкните стрелку ниспадающего меню Изменить тип входных данных и щелкните Arcade.

   Примечание:

   Если имя инструмента геообработки в текстовом поле Имя инструмента совпадает с названием функции Arcade, например Буфер или Вырезать, заключите имя инструмента в одинарные или двойные кавычки, чтобы оно не оценивалось как выражение Arcade.

   Подробнее об именах инструментов геообработки, которые совпадают с выражениями Arcade

10. При желании отметьте Видимый в момент выполнения, чтобы разрешить установку значений параметров при выполнении шага в ArcGIS Pro.
11. Щелкните Добавить новый параметр.
12. Укажите имя параметра в текстовом окне Имя параметра.

    Имена параметров инструментов можно найти на вкладке Python на странице справки инструмента геообработки в документации ArcGIS Pro.

13. Дополнительно, при желании, щелкните Показать значение по умолчанию , чтобы определить значение параметра по умолчанию при запуске шага и указать значение по умолчанию для свойства в текстовом поле Значение или выражение Arcade.
    • Значение - укажите статическое значение.
    • Выражение Arcade - введите динамическое значение с помощью выражения Arcade.
14. При желании повторите шаги с 11 по 13, чтобы добавить больше параметров.
15. При желании укажите в текстовом окне Возвращаемое значение имя производного выходного параметра, которое вы хотите использовать в качестве выходного значения, когда инструмент завершит работу.

    Производные выходные параметры инструмента можно найти на вкладке Python на странице справки инструмента в документации ArcGIS Pro.

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

    Примечание:

    Если опция Прикрепить журнал геообработки отмечена, ID вложения журнала истории инструмента включается в выходные значения шага.

17. При желании в текстовом окне Папка укажите имя папки, в которой будут храниться журналы.

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

    Примечание:

    Папка содержится в элементе рабочего процесса и не является путем к файловой системе.

18. Перейдите на вкладку Опции.
19. При необходимости настройте Опции шага.
    • Вручную - запустить шаг вручную.
      • Дополнительно - позволяет завершить шаг без запуска.
    • Автоматически - Запускает шаг, как только он становится активным.

      Примечание:

      Если для схемы рабочего процесса настроен автоматический запуск последовательности шагов, включая шаг Запустить сервис GP, то после истечения срока действия токена пользователя запускаемые шаги не будут выполняться автоматически. Для выполнения дополнительных автоматизированных шагов без ручного вмешательства требуется Дополнительный модуль организации ArcGIS Workflow Manager Advanced.

    • Запуск по расписанию - запуск шага по заданному расписанию.

      Более подробно об опциях расписания

20. При желании выберите один из следующих вариантов настройки справки на этом шаге:
    • Нет - настройте шаг без пошаговой справки.
    • Текст - настройте текст справки для шага в текстовом поле Текст.

      Вы можете использовать выражения ArcGIS Arcade для предоставления динамического значения справки по шагу. Если справка по шагу содержит обычный текст и выражения Arcade, выполните форматирование текста следующим образом:

      
      'For further assistance, please contact' + JobCreator($Job) + '.'

    • URL - настройте шаг, указав ссылку на справочный ресурс в текстовом поле URL.

      Примечание:

      Шаги, выполняемые в веб-приложении, поддерживают только форматы HTTP и HTTPS URL. Шаги, выполняемые в ArcGIS Pro, поддерживают HTTP, HTTPS и форматы файлов.

      Вы также можете использовать выражения Arcade для предоставления динамического значения. Если URL-адрес содержит обычный текст и выражения Arcade, выполните форматирование текста следующим образом:

      
      'https://pro.arcgis.com/en/pro-app/latest/tool-reference/' + JobExtendedProperty($Job, 'tools', 'toolbox') + '/' + jobExtendedProperty($job, 'tools', 'alias') + '.htm'

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

      • Если выражение Arcade возвращает специальные символы, которых нужно избегать при конвертировании в URL, например, пробел или прямой слэш, убедитесь, что опция Автоматически кодировать результат Arcade включена.
      • Если для формирования базового URL-адреса используется выражение Arcade, отключите опцию Автоматически кодировать результат Arcade.

21. Дополнительно, щелкните вкладку Стиль, чтобы изменить форму и цвет шага.
22. Дополнительно, щелкните вкладку Описание и введите описание шага в текстовом поле Описание шага.

    Подсказка:

    Вкладка Описание также содержит идентификатор шага, который можно использовать с динамическими свойствами задания для получения выходных данных шага. Щелкните Копировать ID шага , чтобы скопировать идентификатор шага в буфер обмена.

Возвращаемое значение

Когда шаг завершен, его возвращаемое значение сохраняется, чтобы указать результат шага. Возвращаемое значение может быть немедленно оценено с использованием путей для определения следующих шагов рабочего процесса. Вы также можете получить возвращаемое значение для завершенных шагов рабочего процесса с помощью выражений ArcGIS Arcade. В следующей таблице перечислены возвращаемые значения шага:

Возвращаемое значение	Описание
S000001	Шаг завершен успешно.
F000001	Шаг не удалось завершить успешно.

Выходное значение

Когда шаг завершен, его выходное значение сохраняется и может использоваться для определения пути, по которому следует рабочий процесс, или может использоваться в качестве входных данных для других шагов рабочего процесса. В следующей таблице перечислено выходное значение шага:

Выходные данные	Описание
<DerivedOutputParameterValue>	Возвращает сконфигурированное производное выходное значение, полученное от инструмента.
attachmentId	Возвращает массив ID вложений, добавленных к шагу.