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

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

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

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

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

Примечание:

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

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

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

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

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

Выполните следующие действия, чтобы настроить этот шаг:

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

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

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

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

    'This job is currently assigned to ' + JobOwner($Job) + '.'
    Подсказка:

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

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

    Инструменты в системных наборах инструментов

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

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

    Инструменты, импортированные в проект ArcGIS Pro

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

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

    Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.

  7. Введите имя инструмента, который вы хотите запустить, в текстовое окно Имя инструмента.
    Примечание:

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

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

    Вы также можете использовать выражения ArcGIS Arcade для предоставления динамического значения.

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

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

  11. При желании щелкните кнопку Показать значение по умолчанию Show Default Value, чтобы определить значение параметра по умолчанию при выполнении шага.
    1. Выберите одну из следующих опций:
      • Значение - Предоставьте статическое значение.
      • Выражение Arcade - Предоставьте динамическое значение с помощью выражения Arcade.
    2. Укажите значение по умолчанию для свойства в текстовом окне Значение или Выражение Arcade.
  12. Повторите шаги с 9 по 11, чтобы добавить больше параметров.
  13. При желании введите имя производного выходного параметра, которое вы хотите использовать в качестве выходного значения, когда инструмент завершит работу.

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

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

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

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

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

    Примечание:

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

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

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

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

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

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

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

      Поддерживаются только форматы URL-адресов 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.

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

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

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

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

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

S000001

Шаг завершен успешно.

F000001

Шаг не удалось завершить успешно.

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

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

Выходные данныеОписание

<DerivedOutputParameterValue>

Возвращает сконфигурированное производное выходное значение, полученное от инструмента.

attachmentId

Возвращает массив ID вложений, добавленных к шагу.

Связанные разделы