Доступно с лицензией Standard или Advanced.
Доступно с лицензией Workflow Manager.
ArcGIS Workflow Manager (Classic) Desktop предоставляет несколько настраиваемых шагов. Исходный код для каждого из них предоставляется как часть комплекта разработчика. В таблице ниже описаны шаги и их функции.
Библиотека Все платформы
Библиотека All Platforms содержит шаги, которые можно выполнять в ArcMap, ArcCatalog, ArcGIS Pro и ArcGIS Server. В следующих разделах описаны шаги, их аргументы и коды возврата
AddJobHold—JTXSteps.AddJobHold
Добавляет удержание к текущему заданию.
Аргументы
Следующая таблица содержит список аргументов шагов:
Аргумент | Описание | Тип аргумента |
---|---|---|
/holdType:<hold type> | Имя типа удержания | Обязательный |
/holdComment:<string> | Комментарий для добавления к типу удержания | Дополнительный |
Коды возврата
Список кодов возврата:
- 1 = Успешное завершение
- 0 = Неудачное завершение
CheckAOI—JTXSteps.CheckAOI
Проверяет, существует ли представляющее интерес местоположение (LOI) для текущего задания.
Аргументы
Для этого шага никакие аргументы не требуются.
Коды возврата
Список кодов возврата шага:
- 1 = у задания есть LOI.
- 2 = у задания нет LOI.
CleanUp—JTXSteps.CleanUp
Очистка задания на основе аргументов. Включите Системные настройки администрирования, чтобы разрешить пользователям удалять версии, принадлежащие другим пользователям. Появится запрос имени пользователя и пароля.
Аргументы
Следующая таблица содержит список аргументов шагов:
Аргумент | Описание | Тип аргумента |
---|---|---|
/version|v | Очищает версии | Дополнительный |
/mxd|m | Очищает MXD | Дополнительный |
/attachments|a | Очищает вложения | Дополнительный |
Коды возврата
Этот шаг возвращает 0, если шаг выполнен успешно.
CloseJob—JTXSteps.CloseJob
Закрытие задания как шага, в противоположность процессу, выполняемому вручную при завершении рабочего процесса.
Аргументы
Для этого шага никакие аргументы не требуются.
Коды возврата
Этот шаг возвращает 0, если шаг выполнен успешно.
CreateJob—JTXSteps.CreateJob
Создание дочернего задания на основе аргументов.
Аргументы
Следующая таблица содержит список аргументов шагов:
Аргумент | Описание | Тип аргумента |
---|---|---|
/jobtypename:<job type name> | Имя типа задания | Обязательный |
/assigngroup:<group to assign to> | Группа, которой будет назначено задание | Дополнительный |
/assignuser:<user to assign to> | Пользователь, которому будет назначено задание | Дополнительный |
Коды возврата
Этот шаг возвращает 0, если шаг выполнен успешно.
CreatePDF—JTXSteps.CreatePDF
Создание PDF-документа базовой карты задания и добавление его к заданию в виде вложения.
Аргументы
Следующая таблица содержит список аргументов шагов:
Аргумент | Описание | Тип аргумента |
---|---|---|
/initdir:<initial directory> | Местоположение, в котором будет создан PDF. | Дополнительный |
/noattach | Не вкладывайте PDF в задание. | Дополнительный |
/resolution:<dpi> | Разрешение PDF. | Дополнительный |
Коды возврата
Этот шаг возвращает 0, если шаг выполнен успешно.
CreateVersion—JTXSteps.CreateVersion
Создание версии для задания. Уровень защиты версии определяется одним из следующих аргументов: Version, Access или Scope. Этап поддерживает традиционную рабочую область с данными и рабочую область данных сервиса объектов.
Аргументы
Следующая таблица содержит список аргументов шагов:
Аргумент | Описание | Тип аргумента |
---|---|---|
/scope:<public|private|protected> | Уровень защиты версии. По умолчанию – private. | Дополнительный |
Коды возврата
Этот шаг возвращает 0, если шаг выполнен успешно.
ExecuteGPTool—JTXSteps.ExecuteGPTool
Запускает инструмент геообработки, модель или скрипт без отображения диалогового окна геообработки. Целочисленные выходные данные инструмента могут быть использованы в качестве кода возврата для определения направления пути рабочего процесса после завершения инструмента.
Аргументы
Следующая таблица содержит список аргументов шагов:
Аргумент | Описание | Тип аргумента |
---|---|---|
/toolboxpath:<toolboxpath> | Полный путь к файлу набора инструментов .tbx и имя инструмента | Обязательный |
/tool:<tool> | Отображаемое имя инструмента в наборе | Обязательный |
/param:<ParamName>:<ParamValue> | Параметр для замещения в инструменте (можно указывать несколько раз) | Дополнительный |
/attach | Вкладывает файл журнала к заданию после выполнения инструмента | Дополнительный |
/outParam:<parameter name> | Выходной параметр для использования в качестве значения возврата | Дополнительный |
Коды возврата
Список кодов возврата шага:
- 0 = Успешное завершение
- 1 = Отмена
ExecuteSQL—JTXSteps.ExecuteSQL
Запускает выражение SQL.
Аргументы
Следующая таблица содержит список аргументов шагов:
Аргумент | Описание | Тип аргумента |
---|---|---|
/database:<jtxsystem|data> | База данных, в которую будет отправлен запрос | Обязательный |
/sql:<sql command> | SQL-запрос для отправки в базу данных | Обязательный |
Коды возврата
Этот шаг возвращает 0, если шаг выполнен успешно.
ExecuteURL—JTXSteps.ExecuteURL
Открывает URL-адрес без отображения браузера, чтобы показать ответ. Например, вы можете запустить сервис геообработки или любой другой веб-сервис, как шаг рабочего процесса.
Аргументы
Следующая таблица содержит список аргументов шагов:
Аргумент | Описание | Тип аргумента |
---|---|---|
/url:<url> | URL-адрес, на который надо перейти | Обязательный |
/timeout:<timeout in seconds> | Время ожидания запроса, в секундах | Дополнительный |
/proxy:<proxy> | Используемый прокси-сервер | Дополнительный |
/addjobcomment | Добавляет комментарий к заданию с ответом | Дополнительный |
/postdata:<data to post> | Данные для отправки, когда будет открыт URL-адрес | Дополнительный |
Коды возврата
Этот шаг возвращает 200, если шаг выполнен успешно.
ExecuteWorkflow—JTXSteps.ExecuteWorkflow
Запускает другой рабочий процесс, связанный с типом задания.
Аргументы
Следующая таблица содержит список аргументов шагов:
Аргумент | Описание | Тип аргумента |
---|---|---|
/jobtype:<job type name> | Имя типа задания. | Обязательный |
/donotuseaoi | Не использует AOI задания. | Обязательный |
/donotuseversion | Не использует версию задания. | Дополнительный |
/donotcopyactivities | Не копирует действия в историю родительского задания. | Дополнительный |
Коды возврата
Этот шаг возвращает 0, если шаг выполнен успешно.
ReturnValue—JTXSteps.ReturnValue
Извлечение значения расширенного свойства или переданного токена, которое является кодом возврата для следующего пути в рабочем процессе.
Аргументы
Следующая таблица содержит список аргументов шагов:
Аргумент | Описание | Тип аргумента |
---|---|---|
/value:<extended properties field> | Расширенное поле свойств, из которого вы хотите получите значение возврата | Обязательный |
Коды возврата
Шаг возвращает значение указанного расширенного поля свойства.
ReassignJob—JTXSteps.ReassignJob
Переназначение задания.
Аргументы
Следующая таблица содержит список аргументов шагов:
Аргумент | Описание | Тип аргумента |
---|---|---|
/assignType:<user|group> | Переназначение задания пользователю или группе. | Обязательный |
/assignTo:<user or group name> | Пользователь или группа, которому будет назначено задание | Обязательный |
Коды возврата
Этот шаг возвращает 0, если шаг выполнен успешно.
SendNotification—JTXSteps.SendNotification
Отправляет уведомления типа, определяемого аргументам.
Аргументы
Следующая таблица содержит список аргументов шагов:
Аргумент | Описание | Тип аргумента |
---|---|---|
/notifType:<type> | Тип уведомления для отправки | Обязательный |
Коды возврата
Этот шаг возвращает 0, если шаг выполнен успешно.
SetVersion—JTXSteps.SetVersion
Устанавливает версию задания по поименованной версии. Например, установите версию задания “Quality Control version” для проверки изменений, опубликованных в этой версии. Если аргумент шага не задан, версия задания будет возвращена к изначальной. Этап поддерживает традиционную рабочую область с данными и рабочую область данных сервиса объектов.
Аргументы
Следующая таблица содержит список аргументов шагов:
Аргумент | Описание | Тип аргумента |
---|---|---|
/version:<versionName> | Версия, используемая как версия задания | Дополнительный |
Коды возврата
Этот шаг возвращает 0, если шаг выполнен успешно.
UpdateExtentFeatureClass—JTXSteps.UpdateExtentFeatureClass
Обновляет класс пространственных объектов информацией о задании для обеспечения статуса видимости.
Аргументы
Следующая таблица содержит список аргументов шагов:
Аргумент | Описание | Тип аргумента |
---|---|---|
/fclass:<fully qualified feature class name> | Класс объектов для обновления (должен быть в базе геоданных) | Обязательный |
/jobfield:<field name> | Поле, в котором хранится ID задания | Дополнительный |
/datefield:<field name> | Поле, в котором хранится дата и время | Дополнительный |
Коды возврата
Этот шаг возвращает 0, если шаг выполнен успешно.
VersionExists—JTXSteps.VersionExists
Проверяет, присвоена ли заданию версия базы геоданных. Этап поддерживает традиционную рабочую область с данными и рабочую область данных сервиса объектов.
Аргументы
Для этого шага никакие аргументы не требуются.
Коды возврата
Список кодов возврата шага:
- 1 = Версия существует
- 2 = Версия не существует
- 3 = Рабочая область данных не выбрана
Библиотека Только ArcGIS Pro и ArcGIS Desktop
Библиотека Только ArcGIS Pro и ArcGIS Desktop содержит шаги, которые можно выполнить только в ArcGIS Pro, ArcMap и ArcCatalog. В следующих разделах описаны шаги, их аргументы и коды возврата
AddAttachments—JTXDesktopSteps.AddAttachments
Добавляет в задание встроенное, связанное и URL вложения.
Аргументы
Для этого шага никакие аргументы не требуются.
Коды возврата
Список кодов возврата:
- 1 = Успешное завершение
- 0 = Неудачное завершение
CreateJobAdvanced—JTXDesktopSteps.CreateJobAdvanced
Создаёт задание и предоставляет вам возможность определить отношение родительское/дочернее для зависимостей в задании. При создании дочернего задания дата начала, дата окончания и рабочая область данных приоритетно копируются из родительского задания, а присвоение задания копируется из свойств типа задания, если значение не указано в аргументах шага. Этот шаг поддерживает создание версий для работы с традиционной рабочей областью данных и рабочей областью данных сервиса объектов. Если дочернее задание установлено с рабочей областью сервиса векторных данных, родительская версия может быть только sde.Default.
Аргументы
Следующая таблица содержит список аргументов шагов:
Аргумент | Описание | Тип аргумента |
---|---|---|
/jobtypename:<job type name> | Имя типа задания. | Обязательный |
/assigngroup:<group to assign to> | Группа, которой будет назначено задание. | Дополнительный |
/assignuser:<username to assign to> | Пользователь, которому будет назначено задание. | Дополнительный |
/dependThisStep | Создаёт зависимость и удерживает текущее задание на этом шаге. | Дополнительный |
/dependNextStep | Создаёт зависимость и удерживает текущее задание на следующем шаге рабочего процесса. | Дополнительный |
/dependStatus:<Status Type Name> | Имя типа статуса зависимости (текущее задание удерживается, пока новое задание не достигнет этого статуса). | Дополнительный |
/useparentaoi | Использовать область интереса (AOI) текущего задания в качестве AOI нового задания. | Дополнительный |
/aoiOverlapFeatureClassName:<fully qualified feature class name > | Создаёт новые задания на основании перекрытия между AOI текущего задания и указанного класс пространственных объектов. | Дополнительный |
/numberJobs:<number of jobs to create> | Число создаваемых заданий по умолчанию. | Дополнительный |
/createVersionSetting:<the version to use as the parent version> | Используемая версия при создании новых заданий. | Дополнительный |
/assignVersionSetting:<the existing version the job will be assigned to> | Существующая версия при создании новых заданий. | Дополнительный |
/setExtendedProps:<ChildJobFullyQualifiedExtendedPropertiesTableName.FieldName=[JOBEX:ParentJobFullyQualifiedExtendedPropertiesTableName.FieldName]>; <ChildJobFullyQualifiedExtendedPropertiesTableName.FieldName=[JOBEX:ParentJobFullyQualifiedExtendedPropertiesTableName.FieldName]>;... | Значение расширенных свойств нового задания будет задано для одного из значений (заданное маркером JTX) или для заданного значения строки при создании новых заданий. Чтобы установить несколько расширенных значений свойств, отделяйте каждый ввод точкой с запятой. | Дополнительный |
/dueDate:<due date of the new job> | Дата сроков выполнения для новых заданий. | Дополнительный |
/jobDuration:<duration of the new job> | Длительность для новых заданий. | Дополнительный |
/child | Создаёт новое задание как дочернее для текущего задания. | Дополнительный |
Коды возврата
Список кодов возврата:
- 0 = Успешное завершение
- 1 = Неудачное завершение
DefineAOI—JTXDesktopSteps.DefineAOI
Отображение инструмента, с помощью которого пользователь может определить местоположение интереса.
Аргументы
Для этого шага никакие аргументы не требуются.
Коды возврата
Список кодов возврата:
- 1 = Успешное завершение
- 0 = Неудачное завершение
EditExtendedProperties—JTXDesktopSteps.EditExtendedProperties
Отображает дополнительные свойства один-к-одному (1-1) задания в форме всплывающего окна, позволяя задать требуемые свойства. Данный шаг может быть включен в рабочий процесс множество раз с различными расширенными свойствами для открытия на разных стадиях процесса. Это предоставляет вам возможность выбрать только некоторые расширенные свойства, настроенные для типа задания, для отображения во всплывающем окне. Расширенные свойства могут быть выбраны посредством открытия редактора аргументов или посредством ввода в поле аргументов. Все выбранные свойства наследуют свойства, установленные в типе задания – видимость, редактируемость и т.д. Если аргументы не указаны, то все выбранные по типу задания расширенные свойства будут отображаться при выполнении шагов. Редактор аргументов отображает все таблицы и поля, настроенные для всех типов заданий в репозитории; тем не менее, если выбраны не настроенные для типа задания свойства, то они не будут отображаться во всплывающем окне. Аргумент составлен из имени таблицы расширенных свойств и имени поля. Например, если вы хотите отобразить поле RequestorName<fieldName> из таблицы RequestorInformation, аргументом будет /Property: RequestorInformation.RequestorName.
Аргументы
Следующая таблица содержит список аргументов шагов:
Аргумент | Описание | Тип аргумента |
---|---|---|
/Property:<Property Name> | Расширенное свойство имени таблицы и имени поля | Обязательный |
Коды возврата
Этот шаг возвращает 1, если шаг выполнен успешно.
Импортировать/Запустить элементы картографии - JTXDesktopSteps.LaunchArcMap
Запускает ArcGIS Pro или ArcMap, размещает слои ресурсов в версии задания и масштабирует карту в соответствии с представляющим интерес местоположением задания.
Аргументы
Обратитесь к разделу Импортировать/Запустить элементы картографии для получения дополнительной информации об аргументах шага.
Коды возврата
Этот шаг возвращает 0, если шаг выполнен успешно.
LaunchGPTool—JTXDesktopSteps.LaunchGPTool
Запускает инструменты геообработки из рабочих процессов. Целочисленные выходные данные инструмента могут быть использованы в качестве кода возврата для определения направления пути рабочего процесса после завершения инструмента.
Аргументы
Следующая таблица содержит список аргументов шагов:
Аргумент | Описание | Тип аргумента |
---|---|---|
/toolboxpath:<toolboxpath> | Полный путь к файлу набора инструментов .tbx и имя инструмента | Дополнительный |
/toolbox:<toolbox> | Имя набора инструментов, если это в системных наборах инструментов | Дополнительный |
/tool:<tool> | Отображаемое имя инструмента в наборе | Обязательный |
/param:<ParamName>:<ParamValue> | Параметр для замещения в инструменте (можно указывать несколько раз) | Дополнительный |
/attach | Вкладывает файл журнала к заданию после выполнения инструмента | Дополнительный |
/license:<enum value> | Код лицензии на все дополнительные лицензии, которые следует использовать для запуска инструмента | Дополнительный |
/outParam:<parameter name> | Выходной параметр для использования в качестве значения возврата | Дополнительный |
Коды возврата
Список кодов возврата шага:
- 0 = Успешное завершение
- 1 = Отмена
SelectDataWorkspace—JTXDesktopSteps.SelectDataWorkspace
Отображает форму, которая позволяет вам выбрать рабочую область данных для вашего задания из списка предварительно настроенных рабочих областей данных.
Аргументы
Для этого шага никакие аргументы не требуются.
Коды возврата
Список кодов возврата:
- 1 = Успешное завершение
- 0 = Неудачное завершение
Библиотека Только ArcGIS Desktop
Библиотека Только ArcGIS Desktop содержит шаги, которые могут быть запущены только из ArcMap и ArcCatalog. В следующих разделах описаны шаги, их аргументы и коды возврата
CopyFile—JTXDesktopSteps.CopyFile
Копирование файла из одного местоположения в другое.
Аргументы
Следующая таблица содержит список аргументов шагов:
Аргумент | Описание | Тип аргумента |
---|---|---|
/src:<source file path> | Файл для копирования | Дополнительный |
/dest:<destination file path> | Место назначения для файла, который копируется | Дополнительный |
/title:<file title> | Название копируемого файла | Дополнительный |
Коды возврата
Этот шаг возвращает 0, если шаг выполнен успешно.
Шаг Импортировать/Запустить элементы картографии
Ожидаемое поведение шага Импортировать/Запустить элементы картографии без аргументов подробно описано в таблице ниже.
Определен ли документ карты типа задания? | Запуск элементов картографии с рабочей областью данных и версией | Запуск элементов картографии с рабочей областью данных, но без версии | Запуск элементов картографии без рабочей области данных |
---|---|---|---|
Да | ArcMap открывается, используя определенный документ карты. Слои будут использовать в качестве источника версию задания на основе краткого имени класса объектов. Карта приближается к области интереса (AOI). | Это работает так же, как и в сценарии, когда версия существует, за исключением того, что в качестве источников слоев используется версия по умолчанию для рабочей области данных. | Никаких изменений в источниках слоев не производится. Карта приближается к области интереса (LOI). |
Нет | ArcMap открывается с пустым документом карты. В этом случае, поскольку карты не существует, слои не предоставляются. Как только слои добавлены на карту, пользователь может напрямую перейти к определенной для задания версии или к версии по умолчанию для выбранной рабочей области данных с помощью кнопки Добавить данные на панели инструментов Workflow Manager. | Поведение аналогично сценарию, когда версия существует. | ArcMap открывается с пустым документом карты. Кнопка Добавить данные на панели инструментов Workflow Manager недоступна. Если для задания существует местоположение интереса, можно использовать инструмент Приблизить к LOI. |
Слои базовой карты не изменяются на карте, открытой с помощью Workflow Manager (Classic).
Описания аргументов
Шаг Импортировать/Запустить элементы картографии имеет много необязательных параметров, позволяющих настроить его выполнение в соответствии с вашими потребностями без написания кода.
Описательное имя | Пример аргумента | Поведение |
---|---|---|
Приблизить к LOI. |
или
| В соответствии с поведением по умолчанию, изображение карты будет перемещено к области интереса (AOI) задания и приближено с коэффициентом 1 к геометрии формы. При необходимости можно отказаться от перемещения или маштабирования карты с помощью опции /nozoomloi. Или можно приблизить область интереса, используя более высокий коэффициент масштабирования для аргумента /aoifactor. Коэффициент масштабирования не применяется для POI. Для одной точки интереса карта масштабируется до 1:2000, а для нескольких – к их экстенту. |
Не изменять никакую информацию о подключении. |
| Поведение по умолчанию, когда /norepoint не используется, изменяет все слои карты на текущую рабочую область данных и, при необходимости, на версию задания. |
Изменить версию только для рабочей области данных задания. |
|
Если вы решите использовать опцию /changeversiononly, то изменится и версия слоев в документе карты типа задания. Пользователь данных и информация о подключении затронуты не будут. Все слои из рабочей области данных будут переключены независимо от того, выбраны ли они для переключения в свойствах типа задания. Слои, не ссылающиеся на данные рабочей области, будут отображены с поврежденными источниками данных. |
Сохранить MXD. |
| По умолчанию, когда аргумент /nosavemxd не используется, документ карты задания сохраняется в базе данных Workflow Manager (Classic). Таким образом, каждый раз, когда вы открываете документ карты задания, используя данный шаг в рабочем процессе, из базы данных извлекается последняя сохранённая карта. Однако, если вы решите использовать опцию /nosavemxd, документ карты задания не будет сохраняться в базе данных Workflow Manager (Classic). Таким образом, если вы измените экстент карты задания и закроете её, новый экстент не будет сохранен и в следующий раз карта будет вновь открыта в оригинальном экстенте. Если ваши документы карты имеют большой размер, вам может понадобиться скорректировать настройку конфигурации MAXBLOBSIZE SDE. Эта опция позволяет также переключаться между заданиями в ArcMap без очистки документа карты. |
Вырезать фрейм данных по AOI. |
| В соответствии с поведением по умолчанию, когда аргумент /cliptoaoi не используется, в документе карты отображаются все доступные для просмотра данные. При использовании опции /cliptoaoi фрейм данных в документе карты задания вырезается по форме области интереса (AOI). |
Подождите, пока ArcMap закроется (приостановить Workflow Manager (Classic)). |
| Поведение приложения Workflow Manager (Classic) по умолчанию, когда аргумент /nowait не используется, заключается в том, чтобы быть скрытым во время выполнения процесса ArcMap. Это означает, что пользователь не может работать с приложением Workflow Manager (Classic) во время работы в ArcMap. Когда опция /nowait используется, ArcMap запускается в отдельном процессе, позволяя пользователю работать с приложением Workflow Manager (Classic) во время работы ArcMap. |
Используйте существующий сеанс ArcMap. |
| Поведение по умолчанию, когда аргумент /useexisting не настроен, открывает новый сеанс ArcMap во время выполнения этого шага. С опцией /useexisting, если открыт сеанс ArcMapпри запуске шага, Workflow Manager (Classic) открывает документ карты задания в текущем сеансе. Если открытого сеанса ArcMap нет, Workflow Manager (Classic) откроет новый сеанс. |
Хранить MXD в совместно используемой директории. |
| При поведении по умолчанию альтернативное местоположение не настраивается, а документы карт задания сохраняются в базе данных Workflow Manager (Classic). Если ваши документы карты имеют большой размер, вам может понадобиться скорректировать настройку конфигурации MAXBLOBSIZE SDE. Если вы решите сохранить документы карты в альтернативном местоположении, Workflow Manager (Classic) не будет сохранять документы карты в базе данных, а сохранит их в этом местоположении для использования в будущем. |
Использовать альтернативный MXD. |
| Следуя поведению по умолчанию, данный шаг использует документ карты по умолчанию для типа задания в качестве документа базовой карты для LaunchArcMap. Если вы решите использовать эту опцию, Workflow Manager (Classic) загрузит документ или шаблон карты, настроенный для аргумента. |
Запустите команду ArcMap. |
| По завершении загрузкиArcMap запустится указанная команда. |
Загрузить рабочий процесс Task Assistant. |
| С настроенным аргументом, когда откроется ArcMap, Workflow Manager (Classic) откроет настроенный рабочий процесс Task Assistant. Переданное имя рабочего процесса является псевдонимом рабочего процесса Task Assistant, сохраненного в системе Workflow Manager (Classic). Можно передать несколько рабочих процессов, добавив дополнительные записи /taworkflow или выбрав рабочие процессы в редакторе аргументов. |
Хранить историю Task Assistant в Истории задания. |
| Если данный аргумент настроен, рабочий процесс Task Assistant добавляется в историю задания по умолчанию. Вы по-прежнему можете прикрепить его как текстовый файл с помощью инструментов Workflow Manager (Classic). |