Configuration

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

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

Обсуждение

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

Обзор метода

МетодОписание
getActivityTypes ()

Возвращает все типы активности в База данных Workflow Manager (Classic) в виде списка объектов ActivityType.

getHoldTypes ()

Возвращает все типы удержаний в базе данных Workflow Manager (Classic) в виде списка объектов HoldType.

getJobTypeDescription ({job_type_id}, {job_type_name})

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

getJobTypes ()

Возвращает список всех типов задания в базе геоданных Workflow Manager (Classic), отобранный при помощи фильтров задания.

getMaps ()

Возвращает список названий карт в базе данных Workflow Manager (Classic).

getNotificationTypes ()

Возвращает список всех типов уведомлений в базе данных Workflow Manager (Classic).

getPriorities ()

Возвращает список приоритетов в базе данных Workflow Manager (Classic).

getPrivileges ({username})

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

getStatusTypes ()

Возвращает список всех типов статуса в базе данных Workflow Manager (Classic) в виде списка объектов StatusType.

getUserGroups ({username})

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

getUsers ()

Возвращает список имен для всех пользователей в базе данных Workflow Manager (Classic).

retrieveMap (map_name, destination_location)

Извлекает карту из Workflow Manager (Classic) базы данных в указанную папку.

storeMap (map_name, source_location, {storage_type}, {overwrite})

Сохраняет карту в базе данных Workflow Manager (Classic). Только .mxd может храниться в базе данных Workflow Manager (Classic).

Методы

getActivityTypes ()
Возвращаемое значение
Тип данныхОписание
ActivityType

Список типов активности возвращен как список объектов ActivityType.

Типы активности – это шаблоны для активности, записанной в историю в течении жизненного цикла задания.

getHoldTypes ()
Возвращаемое значение
Тип данныхОписание
HoldType

Список типов удержаний возвращен как список объектов HoldType.

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

getJobTypeDescription ({job_type_id}, {job_type_name})
ПараметрОписаниеТип данных
job_type_id

ID типа задания, свойства которого будут возвращены.

Integer
job_type_name

Имя типа задания, свойства которого будут возвращены.

String
Возвращаемое значение
Тип данныхОписание
JobTypeDescription

Свойства типа задания, которые можно настроить и назначить новому создаваемому заданию, возвращаемые как объект JobTypeDescription.

Описание типа задания, которое можно настроить для определения свойств задания перед его созданием.

getJobTypes ()
Возвращаемое значение
Тип данныхОписание
JobType

Возвращает типы задания в виде списка объектов JobType. Возвращаемые типы заданий отобранные при помощи фильтров задания в базе данных Workflow Manager (Classic).

Тип задания в базе данных Workflow Manager (Classic) – это шаблон для создаваемых заданий.

getMaps ()
Возвращаемое значение
Тип данныхОписание
String

Список названий карт в базе данных Workflow Manager (Classic).

Карты в базе данных Workflow Manager (Classic), используемые как шаблоны для карт заданий и карт AOI заданий.

getNotificationTypes ()
Возвращаемое значение
Тип данныхОписание
String

Список всех имен типов уведомлений в базе данных Workflow Manager (Classic).

Типы уведомлений – это шаблоны для уведомлений задания, отсылаемых в течении жизненного цикла задания.

getPriorities ()
Возвращаемое значение
Тип данныхОписание
Priority

Список приоритетов в базе данных Workflow Manager (Classic). Запись состоит из id, имени и описания каждого приоритета в базе данных Workflow Manager (Classic).

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

getPrivileges ({username})
ПараметрОписаниеТип данных
username

Имя пользователя, для которого возвращаются права.

(Значение по умолчанию — currentuser)

String
Возвращаемое значение
Тип данныхОписание
String

Список прав, назначенных пользователю. Если нет заданных аргументов, возвращаются права для текущего пользователя.

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

getStatusTypes ()
Возвращаемое значение
Тип данныхОписание
StatusType

Список типов статуса возвращается в виде списка объектов StatusType.

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

getUserGroups ({username})
ПараметрОписаниеТип данных
username

Имя пользователя, для которого возвращаются группы пользователей.

(Значение по умолчанию — currentuser)

String
Возвращаемое значение
Тип данныхОписание
String

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

Группы пользователей применяются для организации пользователей и назначения прав пользователям.

getUsers ()
Возвращаемое значение
Тип данныхОписание
String

Список имен для всех пользователей в базе данных Workflow Manager (Classic).

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

retrieveMap (map_name, destination_location)
ПараметрОписаниеТип данных
map_name

Имя карты, которая будет извлечена из базы данных Workflow Manager (Classic).

String
destination_location

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

String

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

storeMap (map_name, source_location, {storage_type}, {overwrite})
ПараметрОписаниеТип данных
map_name

Имя используется для хранения карты в базе данных Workflow Manager (Classic).

String
source_location

Местоположение папки, в котором лежит карта - с именем карты.

String
storage_type

Тип хранения карты. Если не задано значение, карта сохраняется в базе данных Workflow Manager (Classic) по умолчанию.

  • EMBEDDEDКарта сохраняется в базе данных Workflow Manager (Classic).
  • LINKEDСсылка на местоположение карты сохраняется в базе данных Workflow Manager (Classic).

(Значение по умолчанию — embedded)

String
overwrite

Перезапишите карту, если она уже имеется в базе данных Workflow Manager (Classic). Если значение не указано, имеющаяся карта не перезапишется.

  • TrueКарта сохраняется в базе данных Workflow Manager (Classic).
  • FalseСсылка на карту сохраняется в базе данных Workflow Manager (Classic).

(Значение по умолчанию — false)

String

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