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})	使用作业类型 id 或作业类型名称，返回可在创建作业之前进行自定义的作业类型属性。
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) 数据库中。Workflow Manager (Classic) 数据库中仅可存储 .mxd。

方法

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) 数据库中优先级的列表。元组由 Workflow Manager (Classic) 数据库中每个优先级的 id、名称和描述构成。

优先级可为作为作业的一部分来完成的工作分配重要性级别。

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

该地图可用于提供编辑所需的底图，并将用户定向到将完成作业的大部分工作的地方。