Configuration

サマリー

The Configuration object provides access to the configuration elements in the Workflow Manager (Classic) database.

説明

The Configuration object provides access to the configuration elements in the Workflow Manager (Classic) database.

方法の概要

方法	説明
getActivityTypes ()	Returns all activity types in the Workflow Manager (Classic) database as a list of ActivityType objects.
getHoldTypes ()	Returns all the hold types in the Workflow Manager (Classic) database, as a list of HoldType objects.
getJobTypeDescription ({job_type_id}, {job_type_name})	Returns the job type properties that can be customized before creating a job, using either the job type id or job type name.
getJobTypes ()	Returns a list of all job types in the Workflow Manager (従来版) database filtered by applied job filters.
getMaps ()	Returns a list of the names of maps in the Workflow Manager (従来版) database.
getNotificationTypes ()	Returns a list of all the notification types in the Workflow Manager (Classic) database.
getPriorities ()	Returns a list of priorities in the Workflow Manager (従来版) database.
getPrivileges ({username})	Returns a list of privileges assigned to a user. If no argument is given, the privileges for the current user are returned.
getStatusTypes ()	Returns all status types in the Workflow Manager (Classic) database as a list of StatusType objects.
getUserGroups ({username})	Returns a list of the name of user groups a user belongs to in the database. If no argument is given, the user groups the current user belongs to are returned.
getUsers ()	Returns a list of user names of all the users in the Workflow Manager (従来版) database.
retrieveMap (map_name, destination_location)	Retrieves a map from the Workflow Manager (従来版) database to a specified folder.
storeMap (map_name, source_location, {storage_type}, {overwrite})	Stores a map in the Workflow Manager (従来版) database. Only .mxd can be stored in the Workflow Manager (従来版) database.

方法

getActivityTypes ()

戻り値

データ タイプ	説明
ActivityType	A list of activity types returned as a list of ActivityType objects.

The activity types are templates for the activity logged in history during the life cycle of a job.

getHoldTypes ()

戻り値

データ タイプ	説明
HoldType	The list of hold types returned as a list of HoldType objects.

The hold types are a template for the holds used to suspend the job activity for an indefinite amount of time.

getJobTypeDescription ({job_type_id}, {job_type_name})

パラメーター	説明	データ タイプ
job_type_id	The ID of the job type whose properties will be returned.	Integer
job_type_name	The name of the job type whose properties will be returned.	String

戻り値

データ タイプ	説明
JobTypeDescription	The properties of the job type that can be customized and assigned to a new job being created, returned as the JobTypeDescription object.

The job type description can be customized to set the job properties before its creation.

getJobTypes ()

戻り値

データ タイプ	説明
JobType	Returns the job types as a list of JobType objects. The job types returned are filtered by applied job filters in the Workflow Manager (従来版) database.

The job type in the Workflow Manager (従来版) database is a template for the jobs to be created.

getMaps ()

戻り値

データ タイプ	説明
String	A list of the names of maps in the Workflow Manager (従来版) database.

The maps in the Workflow Manager (従来版) database are used as the template for the job map and job AOI map.

getNotificationTypes ()

戻り値

データ タイプ	説明
String	A list of all the notification type names in the Workflow Manager (Classic) database.

The notification types are the templates for the job notifications sent during the life cycle of a job.

getPriorities ()

戻り値

データ タイプ	説明
Priority	The list of priorities in the Workflow Manager (従来版) database. The tuple consists of the id, name, and description of each priority in the Workflow Manager (従来版) database.

The priority assigns a level of importance to the work to be completed as part of the job.

getPrivileges ({username})

パラメーター	説明	データ タイプ
username	The username of the user whose privileges will be returned. (デフォルト値は次のとおりです currentuser)	String

戻り値

データ タイプ	説明
String	The list of privileges assigned to a user. If no argument is given, the privileges for the current user are returned.

The privileges restrict or allow application functionality to users.

getStatusTypes ()

戻り値

データ タイプ	説明
StatusType	A list of status types returned as a list of StatusType objects.

The status types are templates used to describe the states that a job moves through during its execution.

getUserGroups ({username})

パラメーター	説明	データ タイプ
username	The username of the user whose user groups will be returned. (デフォルト値は次のとおりです currentuser)	String

戻り値

データ タイプ	説明
String	The list of the name of user groups in the database.

The user groups are utilized to organize users and assign privileges to the users.

getUsers ()

戻り値

データ タイプ	説明
String	A list of user names of all the users in the Workflow Manager (従来版) database.

The users are utilized to assign work, log history in the job, and authorize access to the application.

retrieveMap (map_name, destination_location)

パラメーター	説明	データ タイプ
map_name	The name of the map to be retrieved from the Workflow Manager (従来版) database.	String
destination_location	The folder location where the retrieved map will be saved and the name to be used.	String

The maps are utilized to provide a basemap for editing and orient the user where most of the work for the job will be accomplished.

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

パラメーター	説明	データ タイプ
map_name	The name used to store the map in the Workflow Manager (従来版) database.	String
source_location	The folder location where the map exists, with the name of the map.	String
storage_type	The storage type of the map. If no value is given, the map is stored in the Workflow Manager (従来版) database by default. EMBEDDED—The map is stored in the Workflow Manager (従来版) database. LINKED—The link to the map location is stored in the Workflow Manager (従来版) database. (デフォルト値は次のとおりです embedded)	String
overwrite	Overwrite the map if it exists in the Workflow Manager (従来版) database. If no value is provided, the existing map is not overwritten. True—The map is stored in the Workflow Manager (従来版) database. False—The link to the map is stored in the Workflow Manager (従来版) database. (デフォルト値は次のとおりです false)	String

The maps are utilized to provide a basemap for editing and orient the user where most of the work for the job will be accomplished.