Job

Краткая информация

Объект Job предоставляет доступ к свойствам и методам для работы с заданием Workflow Manager (Classic).

Обсуждение

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

Свойства

Свойство	Описание	Тип данных
assignedTo (чтение и запись)	Имя пользователя или группы, которым назначено задание.	String
assignedType (чтение и запись)	Тип назначения для данного задания. Ниже приведен список допустимых строк, используемых при установке назначения задания. Если используется некорректная строка, задание останется по умолчанию неназначенным. User—Пользователь в базе данных рабочего процесса Group—Группа в базе данных рабочего процесса Unassigned—Нет назначенного задания	String
createdBy (чтение и запись)	Имя пользователя, создавшего задание.	String
createdDate (только чтение)	Возвращает дату создания задания.	DateTime
currentSteps (только чтение)	Возвращает список идентификаторов шагов, определяющих активные шаги данного рабочего процесса.	List
description (чтение и запись)	Описание задания.	String
dueDate (чтение и запись)	Дата запланированного завершения задания.	DateTime
endDate (только чтение)	Возвращает дату завершения задания.	DateTime
hasAOI (только чтение)	Возвращает True, когда у задания есть определенная область интереса. Прежние версии: Этот метод больше не используется. Вместо этого используйте hasLOI.	Boolean
hasLOI (только чтение)	Возвращает True, когда у задания есть определенная область интереса (точка или полигон).	Boolean
ID (только чтение)	Возвращаетs ID задания.	Integer
jobTypeID (только чтение)	Получает идентификатор ID типа задания для этого задания.	Integer
name (чтение и запись)	Имя задания.	String
notes (чтение и запись)	Примечания, связанные с заданием, содержат информацию для пользователей.	String
owner (чтение и запись)	Имя пользователя, которому принадлежит задание.	String
parent (чтение и запись)	Получает идентификатор ID родительского задания для текущего задания.	Integer
parentVersion (чтение и запись)	Имя владельца родительской версии задания.	String
percentComplete (только чтение)	Возвращает процент выполнения задания.	Double
priority (чтение и запись)	Приоритет задания.	Integer
startDate (чтение и запись)	Дата запланированного начала выполнения задания.	DateTime
startedDate (только чтение)	Возвращает дату начала выполнения задания.	DateTime
status (чтение и запись)	Имя статуса для задания. Доступными статусами являются те, которые определены в качестве типов статусов в базе данных .	String
versionExists (только чтение)	Возвращает True, когда для задания существует версия.	Boolean
versionName (чтение и запись)	Имя версии для задания.	String

Обзор метода

Метод	Описание
addAttachment (storage_type, source_location)	Добавляет вложения к заданию.
addDependency (depends_on_job_id, {held_on_type}, {held_on_value}, {dependent_on_type}, {dependent_on_value})	Добавляет зависимость от задания, чтобы ограничить прогресс выполнения задания на определенной стадии, пока этой стадии не достигло другое выполняемое задание.
addHold (hold_type_id, {comment})	Добавляет блокировку в задание, приостанавливая его действие.
deleteAttachment (attachment_id)	Удаляет вложение, связанное с заданием.
deleteJobMap ()	Удаляет карту задания, связанную с заданием.
executeStep ({step_id}, {callback})	Выполняет шаг в рабочем процессе.
getAttachments ()	Возвращает все вложения, связанные с заданием в виде списка объектов Attachment.
getExtendedPropertyTable (tableName)	Возвращает отдельную таблицу расширенного свойства на основе его полного имени таблицы.
getHolds ()	Возвращает удержания, связанные с заданием, в виде списка объектов Hold.
getPendingDays (consider_hold)	Возвращает количество оставшихся дней для задания. Может также дополнительно рассматривать удержания и вычитать их из количества оставшихся дней для задания.
getWorkflow (jobID)	Возвращает Workflow задания на основе его ID.
listExtendedProperties ()	Перечисляет полное имя всего расширенного свойства или связанных таблиц свойства, относящихся к заданию.
logActivity (activity_type, {message})	Ведёт журнал действий в истории задания, чтобы описать действие в задании.
markStepAsComplete ({step_id}, {callback})	Отмечает шаг рабочего процесса как завершенный
releaseHold (hold, {comment})	Снимает блокировку, связанную с заданием и отмечает ее как неактивную блокировку.
retrieveAttachment (attachment_id, destination_location)	Извлекает файловые вложения, связанные с заданием, в папку на диске.
retrieveJobMap (destination_location)	Извлекает карту задания в папку на диске.
save ()	Сохраняет любые изменения, сделанные в задании, обратно в базу данных Workflow Manager (Classic).
sendNotification (notification_type)	Отправляет уведомление, основываясь на событии в жизненном цикле задания.
setAOI (aoi)	Устанавливает полигон области интереса для задания. Прежние версии: Этот метод больше не используется. Вместо этого используйте setLOI.
setDataWorkspace (data_workspace_id)	Устанавливает рабочую область данных для задания.
setLOI (loi)	Устанавливает расположение местоположения интереса (LOI) для задания. Местоположения интереса могут быть точками (POI) или полигонами (AOI).
setStepAsCurrent (step_id)	Делает шаг рабочего процесса активным.
storeJobMap (source_location)	Сохраняет карту в базе данных Workflow Manager (Classic) и связывает ее с заданием, чтобы карта задания использовалась для редактирования.

Методы

addAttachment (storage_type, source_location)

Параметр	Описание	Тип данных
storage_type	Тип добавляемого вложения. EMBEDDED—Файл сохраняется в базе данных Workflow Manager (Classic). LINKED—Ссылка на путь к этому файлу сохраняется в базе данных Workflow Manager (Classic). URL—URL-ссылка сохраняется в базе данных.	String
source_location	Путь к файлу или URL добавляемого вложения.	String

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

• Встроено – Файл сохраняется в базе данных Workflow Manager (Classic).
• Связано – В базе данных Workflow Manager (Classic) сохраняется ссылка на путь к этому файлу.
• URL – в базе данных сохраняется URL-ссылка.

addDependency (depends_on_job_id, {held_on_type}, {held_on_value}, {dependent_on_type}, {dependent_on_value})

Параметр	Описание	Тип данных
depends_on_job_id	ID родительского задания, от которого будет зависеть текущее задание.	Integer
held_on_type	Определяет, будет ли текущее задание (для которого добавляется зависимость) приостановлено на шаге или статусе. Рабочий процесс задания, которое было приостановлено, не может быть выполнен, пока зависимость не будет снята. Рабочий процесс задания, которое было приостановлено, не может быть выполнен, пока зависимость не будет снята. Зависимость будет снята, когда задание окажется на шаге или будет в статусе, которое было указано в параметрах зависимости. (Значение по умолчанию — STEP)	String
held_on_value	Значение, при котором задание должно быть приостановлено (шаг или статус). Этим значением может быть ID шага в виде целого числа или статус задания в виде текстового значения.	Variant
dependent_on_type	Определяет, будет ли текущее задание (для которого добавляется зависимость) зависеть от шага или статуса другого задания. Когда зависимое задание будет приостановлено на шаге или статусе другого задания, оно не сможет продолжить свою работу, пока другая работа не дойдет до шага или статуса, которые были указаны в параметрах зависимости. Как только задание дойдет до шага или статуса, указанных в параметрах зависимости, зависимость будет снята и зависимое задание продолжит свою работу. (Значение по умолчанию — STATUS)	String
dependent_on_value	Значение шага или статуса другого задания, от которого зависит текущее задание. Этим значением может быть ID шага в виде целого числа или статус задания в виде текстового значения. (Значение по умолчанию — CLOSED)	Variant

Зависимости между заданиями позволят вам моделировать отношения между ними. Таким образом, вы сможете приостановить выполнение какой-то задачи до тех, пор пока другое задание не окажется на определенной стадии. Ограничения могут быть включены для следующих частей задания: Статус или Шаг.

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

addHold (hold_type_id, {comment})

Параметр	Описание	Тип данных
hold_type_id	ID шаблона типа блокировки, который будет использоваться для создания блокировки этого задания.	Integer
comment	Комментарий, который будет сохранен в качестве причины для добавления блокировки.	String

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

• Недостаточное финансирование
• Технические проблемы
• Отсутствующие данные
• Недостаток ресурсов

deleteAttachment (attachment_id)

Параметр	Описание	Тип данных
attachment_id	ID удаляемого вложения.	Integer

Вложения – это один из способов добавить информацию в задание.

deleteJobMap ()

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

executeStep ({step_id}, {callback})

Параметр	Описание	Тип данных
step_id	ID выполняемого шага. ID шага является дополнительным. Если ID не предоставлен, текущий шаг будет выполнен.	Integer
callback	Аргумент обратного вызова пропускает функцию, запрашивающую у пользователя ответ на основе входных данных из этого шага. При выполнении шага-вопроса, например, обратный вызов берет возможные опции ответа шага и позволяет пользователю выбрать следующий шаг. Также это используется, если невозможно определить следующий шаг в рабочем процессе, поэтому пользователь может выбрать путь следования.	Function

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

Тип данных	Описание
WorkflowExecutionResult	Возвращает объект WorkflowExecutionResult, хранящий коды возврата шага.

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

getAttachments ()

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

Тип данных	Описание
Attachment	Вложения, связанные с заданием, возвращаются в виде списка объектов Attachment.

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

• Встроено – Файл сохраняется в базе данных Workflow Manager (Classic).
• Связано – В базе данных Workflow Manager (Classic) сохраняется ссылка на путь к этому файлу.
• URL – в базе данных сохраняется URL-ссылка.

getExtendedPropertyTable (tableName)

Параметр	Описание	Тип данных
tableName	Возвращаемое полное имя таблицы расширенного свойства.	String

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

Тип данных	Описание
ExtendedProperty	Возвращает таблицу расширенного свойства в виде объекта ExtendedProperty.

Информация о специфике бизнеса, хранящаяся в части задания как расширенные свойства, возвращается в виде объекта ExtendedProperty.

getHolds ()

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

Тип данных	Описание
Hold	Удержания задания, возвращаемые в виде списка объектов Hold.

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

• Недостаточное финансирование
• Технические проблемы
• Отсутствующие данные
• Недостаток ресурсов

Информация об Hold никогда не удаляется из системы и может быть запрошена.

getPendingDays (consider_hold)

Параметр	Описание	Тип данных
consider_hold	Отметка для определения, учитывать ли удержания при вычислении количества оставшихся дней.	Boolean

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

Тип данных	Описание
Integer	Возвращает количество оставшихся дней для задания.

Оставшиеся дни относятся к количеству дней, которые задание выполняется, либо количеству дней, оставшихся для задания, прежде чем оно будет завершено. В качестве даты начала выполнения для вычисления используется либо Дата начала (Start Date), если она была задана, либо Дата создания (Created Date), в противном случае. В качестве даты завершения вычисления используется либо текущая дата, либо Дата завершения (End Date), если задание закрыто.

getWorkflow (jobID)

Параметр	Описание	Тип данных
jobID	ID задания.	Integer

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

Тип данных	Описание
Object	Возвращает рабочий процесс виде объекта Workflow.

Позволяет легко получить рабочий процесс задания.

listExtendedProperties ()

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

Тип данных	Описание
String	Список полных имен всего расширенного свойства или связанных таблиц свойства, относящихся к заданию.

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

logActivity (activity_type, {message})

Параметр	Описание	Тип данных
activity_type	ID или имя ActivityType.	String
message	Пользовательское сообщение, которое добавляется к существующему сообщению ActivityType.	String

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

markStepAsComplete ({step_id}, {callback})

Параметр	Описание	Тип данных
step_id	ID выполняемого шага, который будет отмечен как завершенный. ID шага является дополнительным. Если ID не предоставлен, текущий шаг будет выполнен.	Integer
callback	Аргумент обратного вызова пропускает функцию, запрашивающую у пользователя ответ на основе входных данных из этого шага. При отметке шага-вопроса как завершенного, например, обратный вызов учитывает возможные варианты ответа шага и позволяет пользователю выбрать следующий шаг. Он также используется, когда невозможно определить следующий шаг в рабочем процессе, поэтому пользователь может выбрать путь следования.	Function

Предоставляет способ отметки шага как завершенного.

releaseHold (hold, {comment})

Параметр	Описание	Тип данных
hold	Блокировка снимается объектом Hold.	Hold
comment	Комментарий, который будет сохранен в качестве причины снятия блокировки.	String

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

retrieveAttachment (attachment_id, destination_location)

Параметр	Описание	Тип данных
attachment_id	ID извлекаемого вложения.	Integer
destination_location	Местоположение папки, в которой будет сохранено вложение. Можно также ввести имя файла с расширением или без него. Если имя не указывается, с заданием сохраняется вложение под именем, используемым по умолчанию.	String

Вложения – это один из способов добавить информацию в задание. Из задания можно извлечь следующие типы вложений:

• Встроено – Файл сохраняется в базе данных Workflow Manager (Classic).
• Связано – В базе данных Workflow Manager (Classic) сохраняется ссылка на путь к этому файлу. Его можно извлечь лишь в случае, если у вас есть доступ к этому пути.

retrieveJobMap (destination_location)

Параметр	Описание	Тип данных
destination_location	Местоположение папки, в которой будет сохранено карта задания. Можно также ввести имя сохраняемой карты. Если имя карты задания не указывается, карта задания сохраняется со схемой наименования, используемой по умолчанию.	String

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

save ()

sendNotification (notification_type)

Параметр	Описание	Тип данных
notification_type	Имя шаблона типа уведомления, используемого для отправки уведомления по электронной почте, связанного с заданием.	String

Уведомления по e-mail могут быть вызваны в течение жизненного цикла задания для передачи информации, связанной с заданием. К примерам уведомлений по e-mail относятся:

• Задание назначено или переназначено
• Задание создано
• Задание закрыто

setAOI (aoi)

Параметр	Описание	Тип данных
aoi	Полигон области интереса, который будет присвоен заданию.	Geometry

Определяет область интереса для задания. Чтобы получить полигон области интереса для задания, используйте инструмент Получить AOI задания.

setDataWorkspace (data_workspace_id)

Параметр	Описание	Тип данных
data_workspace_id	GUID той рабочей области данных задания, которую необходимо сделать активной.	String

Установить рабочую область данных для задания. Чтобы получить рабочую область данных для задания, используйте инструмент Получить рабочую область данных задания.

setLOI (loi)

Параметр	Описание	Тип данных
loi	Точка или полигон, которые назначаются в качестве местоположения интереса для задания.	Geometry

Определяет местоположения интереса для задания. Чтобы получить местоположение интереса для задания, используйте инструмент Получить AOI задания.

setStepAsCurrent (step_id)

Параметр	Описание	Тип данных
step_id	ID шага, который делается активным.	Integer

Обеспечивает возможность задания шага рабочего процесса как активного.

storeJobMap (source_location)

Параметр	Описание	Тип данных
source_location	Путь к файлу с картой, сохраняемой в базе данных Workflow Manager (Classic).	String

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