require(["esri/tasks/workflow/ConfigurationTask"], function(ConfigurationTask) { /* code goes here */ });
Class: esri/tasks/workflow/ConfigurationTask
Inheritance: ConfigurationTask Task Accessor
Since: ArcGIS API for JavaScript 4.3

Class to get information about Workflow Manager system configuration. The Workflow Manager system configuration consists of the following elements:

  • Users - Users are key to controlling what functionality is available and how work is managed and executed by each user. Get the information about one user or all the users configured in the system.
  • Groups - Groups are used to categorize users for many reasons, specifically to assign privileges or roles, but also to classify users for the purposes of assigning work. Get the information about one group or all the groups configured in the system.
  • Queries - Queries return the jobs based on a specific criteria, they can be defined as a public query by an administrator or as user-owned query by an individual user. The public queries are availalbe to all users, whereas the user-owned query are available only to the user who defined it. Get the configuration of public and user owned queries.
  • Job Types - Job types provide a way to categorize your work and processes based on commonalities. Job types allow you to group similar types of work together. In doing this, you provide templates for each unit of work you manage, making the creation and execution of that work more efficient. Get details for a job type and all the job types a user can see and create.
  • Table Relationships - Extended and linked properties are custom properties that enable you to store business-specific properties on a job. The information about what kind of extended or linked property relationships exist in the system can be retrieved.
  • Data Workspace - The spatial data which will be used to work with jobs. Get the information about the spatial database and it's versions.
  • Configuration properties - The configuration of the system such as Activity Types, Hold Types, Priorities, Status Types, Notification Types and Privileges.

Constructors

new ConfigurationTask(properties)

Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
Object

The options to be used for data requests.

more details
more detailsTask
String

URL to the ArcGIS Workflow Manager REST service.

more details
more detailsConfigurationTask

Property Details

declaredClassStringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

requestOptionsObject inherited

The options to be used for data requests. These options can also be controlled through the requestOptions method parameter.

URL to the ArcGIS Workflow Manager REST service.

Method Overview

NameReturn TypeSummaryClass
Promise<Object[]>

Gets an array of all the user groups that are configured in the Workflow Manager system.

more details
more detailsConfigurationTask
Promise<Object[]>

Gets an array of all the users that are configured in the Workflow Manager system.

more details
more detailsConfigurationTask
Promise<Object[]>

Gets the properties and an array of geodatabase versions for a data workspace.

more details
more detailsConfigurationTask
Promise<Object[]>

Gets a single user group in the Workflow Manager system.

more details
more detailsConfigurationTask
Promise<JobTypeDetails>

Gets the detailed configuration properties of a job type.

more details
more detailsConfigurationTask
Promise<JobQueryDetails>

Gets the configuration of a publicly accessible job query.

more details
more detailsConfigurationTask
Promise<WorkflowManagerServiceInfo>

Gets the configuration information specific to a Workflow Manager system.

more details
more detailsConfigurationTask
Promise<TableRelationship>

Gets an array of registered table relationships in the Workflow Manager system.

more details
more detailsConfigurationTask
Promise<UserDetails>

Gets information for a single user in the system.

more details
more detailsConfigurationTask
Promise<JobQueryDetails>

Gets the configuration of a user-owned job query.

more details
more detailsConfigurationTask
Promise<JobType>

Gets all the job types a user is allowed to see and create.

more details
more detailsConfigurationTask

Method Details

getAllGroups(requestOptions){Promise<Object[]>}

Gets an array of all the user groups that are configured in the Workflow Manager system.

Parameter:
requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< Object[]>Resolves to an array of groups, each group object having the following properties:
NameTypeDescription
descriptionStringThe description of the group.
idNumberThe unique id for the group.
nameStringThe name of the group.
usersString[]An array of users that belong to the group.

getAllUsers(requestOptions){Promise<Object[]>}

Gets an array of all the users that are configured in the Workflow Manager system.

Parameter:
requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< Object[]>Resolves to an array of users, each user object having the following properties:
NameTypeDescription
addressStringThe address of the user.
emailStringThe email address of the user.
faxNumberStringThe fax number of the user.
firstNameStringThe first name of the user.
lastNameStringThe last name of the user.
fullNameStringThe full name fo the user.
phoneNumberStringThe phone number of the user.
roomNumberStringThe room number of the user's office.
userNameStringThe username of the user.
zipCodeStringThe zip code of the user.

getDataWorkspaceDetails(params, requestOptions){Promise<Object[]>}

Gets the properties and an array of geodatabase versions for a data workspace.

Parameters:
params Object

See the object specifications in table below for the structure of the params object.

Specification:
dataWorkspaceId String

The unique id of the data workspace, whose version will be returned.

user String

The user name of the user who is requesting the information.

requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< Object[]>Resolves to an array of geodatabase versions, each version object having the following properties:
PropertyTypeDescription
idStringThe unique id for the data workspace.
nameStringThe name of the data workspace.
defaultVersionStringThe name of the default version of the workspace.
versionsVersionInfo[]An array of versions in the geodatabase.

getGroup(groupId, requestOptions){Promise<Object[]>}

Gets a single user group in the Workflow Manager system.

Parameters:
groupId Number

The unique id of the group whose information will be retrieved.

requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< Object[]>When resolved, returns a user group as an object with the following properties:
NameTypeDescription
descriptionStringThe description of the group.
emailStringThe email address associated to the group.
idNumberThe unique id for the group.
nameStringThe name of the group.
privilegesPrivilege[]An array of privileges associated to the group.
usersString[]An array of name of users that belong to the group.

getJobTypeDetails(jobTypeId, requestOptions){Promise<JobTypeDetails>}

Gets the detailed configuration properties of a job type.

Parameters:
jobTypeId Number

The unique id of a job type.

requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< JobTypeDetails>When resolved, returns the detailed configuration properties of a job type as JobTypeDetails object.

getPublicJobQueryDetails(queryId, requestOptions){Promise<JobQueryDetails>}

Gets the configuration of a publicly accessible job query.

Parameters:
queryId Number

The unique id of public query.

requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< JobQueryDetails>When resolved, returns a JobQueryDetails object.

getServiceInfo(requestOptions){Promise<WorkflowManagerServiceInfo>}

Gets the configuration information specific to a Workflow Manager system.

Parameter:
requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< WorkflowManagerServiceInfo>When resolved, returns the WorkflowManagerServiceInfo object with configuration information for a Workflow Manager system.

getTableRelationshipsDetails(requestOptions){Promise<TableRelationship>}

Gets an array of registered table relationships in the Workflow Manager system.

Parameter:
requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< TableRelationship>When resolved, returns an array of TableRelationship object.

getUser(user, requestOptions){Promise<UserDetails>}

Gets information for a single user in the system.

Parameters:
user String

The user name of the user whose information will be returned.

requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< UserDetails>When resolved, returns a UserDetails object.

getUserJobQueryDetails(params, requestOptions){Promise<JobQueryDetails>}

Gets the configuration of a user-owned job query.

Parameters:
params Object

See the object specifications in table below for the structure of the params object.

Specification:
queryId Number

The unique id of user query.

user String

The user name of the user who is requesting the information.

requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< JobQueryDetails>When resolved, returns a JobQueryDetails object.
Example:
var params = {
  queryId: 43,
  user: "cjones"
};
configurationTask.getUserJobQueryDetails(params).then(function(jobQueryDetails){
  var jobQueryName = jobQueryDetails.name;
  var jobQueryFields = jobQueryDetails.fields;
  var jobQueryTables = jobQueryDetails.tables;
  . . .
});

getVisibleJobTypes(user, requestOptions){Promise<JobType>}

Gets all the job types a user is allowed to see and create.

Parameters:
user String

The user name of the user for whom the information will be retrieved.

requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< JobType>When resolved, returns an array of JobType objects.

Type Definitions

DataWorkspaceObject

A geospatial database that will be used for editing in the Workflow Manager system.

Properties:

The unique id of the data workspace.

name String

The name of the data workspace.

GroupMembershipObject

The membership attributes of a group.

Properties:

The unique id for the group.

name String

The name of the group.

HoldTypeObject

The type of hold that can be applied to suspend the execution of a job.

Properties:
description String

The description of the type of hold.

The unique id for the hold type.

name String

The name of the hold type

JobPriorityObject

The properties of a job priority. Job priority is a way to assign a level of importance to the job.

Properties:
description String

The description of the priority.

name String

The name of the priority.

value Number

The unique id of the priority.

JobQueryObject

A query that is available to the user to execute. A query returns jobs based on a specific criteria.

Properties:

The unique id for the query.

name String

The name of the priority.

JobQueryContainerObject

A container of job queries, it can also contain nested containers with child job query containers under it.

Properties:

One or more job query containers which are nested under the parent container.

The unique id for the container.

name String

The name of the query container.

queries JobQuery[]

An array of queries inside the query container.

JobQueryDetailsObject

Detailed properties of a job query.

Properties:
aliases String[]

An array of field aliases included in the select statement.

fields String[]

An array of fields included in the select statement.

The unique id for the query.

name String

The name of the query.

orderBy String

The field used to order the results returned by the query.

tables String[]

An array of tables selected from and used in the where clause.

where String

The where clause used as filter for selecting job information.

JobStatusObject

Properties of a job status.

Properties:
caption String

An alias name for the status.

description String

The description of the type of status.

The unique id for the status type.

name String

The name of the status type.

JobTypeObject

A list of properties that describe a job type.

Properties:
category String

A category to group other similar job types.

description String

The description of the job type.

The unique id for the job type.

name String

The name of the job type.

state String

The state of the job type.

Possible Values: draft | active | retired

JobTypeDetailsObject

Detailed information of a job type.

Properties:
autoExecuteCreatedJobs Boolean

Indicates whether jobs of this type will have their workflows automatically executed, when created.

canDataWorkspaceChange Boolean

Indicates whether jobs of this type allows users to modify the current data workspace in the job.

category String

The category of the job type.

defaultAssignedTo String

The name of the user or group that the job will be assigned to by default.

defaultAssignedType String

Indicates whether the job is assigned to a user, group or unassigned by default.

Possible Values: unassigned | user | group

defaultDataWorkspaceId String

The unique id of the default data workspace of the job.

defaultDescription String

The description that gets associated with the job.

defaultDueDate String

The default due date of the job.

defaultJobDuration Number

The duration for completing the job assigned by default.

defaultParentVersionName String

The name of the geodatabase version that will be assigned the parent version of the job's geodatabase by default.

defaultPriority String

The numeric priority value assigned to the job by default.

defaultStartDate Date

The default start date of this job type.

description String

The description of the job type.

The unique id automatically generated for this job type.

jobNamingScheme String

The naming scheme for this job type, which would serve as template for the name of the job.

jobVersionNamingScheme String

The naming scheme for this job type, which would serve as template for the name of job's version.

mxdNamingScheme String

The naming scheme for this job type, which would serve as template for the name of job's map.

name String

The job type name.

state String

The state of the job type.

Possible Values: draft | active | retired

PrivilegeObject

A privilege in the Workflow Manager system that controls application access.

Properties:
description String

The description of the privilege.

The unique id for the privilege.

name String

The name of the privilege.

TableRelationshipObject

TableRelationship represents a list of extended properties tables and the properties that identify them like name and cardinality.

Properties:
cardinality String

The type of extra property table relationship, one-to-one represents one row for each property and one-to-many represents there will be multiple values for the property.

Possible Values: one-to-one | one-to-many

linkField String

The foreign key field used to join the jobs table.

tableAlias String

The alias name of the table.

tableName String

The name of the extended properties table.

UserDetailsObject

A list of properties including groups and privileges associated with a Workflow Manager user.

Properties:
address String

The address of the user.

email String

The email address of the user.

faxNumber String

The fax number of the user.

firstName String

The first name of the user.

fullName String

The full name of the user.

An array of group memberships of the user.

lastName String

The last name of the user.

phoneNumber String

The phone number of the user.

privileges Privilege[]

An array of application privileges of the user.

roomNumber String

The room number of the user.

userName String

The login username for the user.

An array of queries owned by the user.

zipCode String

The zip code of the user.

VersionInfoObject

A list of properties that describe a geodatabase version.

Properties:
access String

The level of access to the geodatabase version.

Possible Values: esriVersionAccessPrivate | esriVersionAccessPublic | esriVersionAccessProtected

name String

The name of the geodatabase version.

parent String

The name of the parent version of the geodatabase.

WorkflowManagerServiceInfoObject

The base properties of a Workflow Manager service.

Properties:
activityTypes ActivityType[]

An array of activity types in the Workflow Manager system.

configProperties Object

The configuration properties of the Workflow Manager system stored in the database table as key/value pairs.

Specification:
AOIOVERLAP String

Indicates whether the location of interest (LOI) for jobs are allowed to overlap.

AOISELECTIONCOLOR Number

The color of the current job's LOI when selected in the LOI tab. The value is in range of 0 to 167772155.

AUTOASSIGNJOB Boolean

Indicates whether the job will be automatically assigned based on step assignment.

AUTOCLOSEJOB Boolean

Indicates whether the job will be automatically closed after the last step in the workflow is marked as complete.

AUTOCOMMITWORKFLOW Boolean

Indicates whether the job workflow witll be automatically committed to the database when saved.

AUTOSTATUSASSIGN Boolean

Indicates whether the status of the jobs will be automatically assigned.

CONFIRMPROCEDURALCHECK Boolean

Indicates whether the user will be required to confirm that they want to mark the current procedural step as complete.

DEFAULT_SENDER_EMAIL String

The default email address to be used in the sender field when sending notifications.

DEFAULT_SENDER_NAME String

The default name displayed to be used in the sender field when sending notifications.

HTML_SUPPORT String

Indicates whether notifications will be sent as HTML.

JOB_ID_START_VALUE String

The starting value of job ids in the system.

PENDING_DAYS_USE_HOLDS Boolean

Indicates whether the the number of days for each hold is taken out of the pending days calculation.

PROMPTSDEPWD Boolean

Indicates whether the user attempting to delete a job version would be prompted to enter a password for the sde owner of the versions.

REQUIREPROCEDURALCHECKSTART Number

Indicates whether it will be required to mark procedural steps as started.

RESTRICT_AOI_OPTION String

Indicates whether the editing behavior will be restricted to data in the job's AOI using editing restriction rules.

Possible Values: Warn | NoSelect | Off

  • Warn - Warn users when selecting features outside the job AOI.
  • NoSelect - Prevent users from selecting features outside the job AOI.
  • Off - Allow edits to features outside the job AOI.
SEND_SN_CUSTOM_POST Boolean

Indicates whether the spatial notifications will be sent on Workflow Manager Post.

SHOW_STEP_IDS Boolean

Indicates whether to show step ids on workflow.

SHOW_STEP_PERCENT_COMPLETE Boolean

Indicates whether the step completion percentage will be displayed on the step.

SMTP_PASSWORD String

The password of the authenticated SMTP user in the secure SMTP server.

SHOW_PENDING_DAYS Boolean

Indicates whether the pending days will be displayed in the job.

SMTP_PORT String

The SMTP server port to be used for sending notifications.

SMTP_PROTOCOL String

SMTP Authentication protocol.

Possible Values: SSL | TLS

SMTP_SERVER String

The name of the SMTP Server to be used for sending notifications.

SMTP_USERNAME String

The user name that is authenticated in the secure SMTP server.

USE_STEP_STATUS Boolean

Indicates whether to use step status assignment such that the job's status updates to match the step status when the step is reached.

USER_STORE String

Indicates the user store of the Workflow Manager system, whether the users will be stored in a Portal or the Workflow Manager system.

Possible Values: traditional | portal

USEUSERDOMAIN Boolean

Indicates whether a user will be authenticated using domain along with the user name.

WF_SEL_STEP_FILL_COLOR Number

The fill color of a selected step in a workflow. The value is in range of 0 to 167772155. When the option is disabled it's value is -1.

WF_SEL_STEP_OUTLINE_COLOR Number

The outline color of a selected step in a workflow. The value is in range of 0 to 167772155. When the option is disabled it's value is -1.

WF_SEL_STEP_OUTLINE_WIDTH Number

The outline width of a selected step in a workflow.

Possible Values: 1 | 2 | 3

AOIOVERLAP String

Indicates whether the location of interest (LOI) for jobs are allowed to overlap. The LOI may overlap another job's LOI, or may not be allowed to overlap any other LOI in the system. They can also be set such that LOIs for jobs of the same job type cannot overlap each other.

Possible Values: allow | disallow | disallowjobtype

ZOOMTOAOI Boolean

Indicates whether the LOI of the job will be automatically zoomed to in the LOI tab.

currentVersion Number

The current software version.

dataWorkspaces DataWorkspace[]

An array of data workspaces in the Workflow Manager system.

holdTypes HoldType[]

An array of hold types in the Workflow Manager system.

jobPriorities JobPriority[]

An array of job priorities in the Workflow Manager system.

jobStatuses JobStatus[]

An array of job statuses in the Workflow Manager system.

jobTypes JobType[]

An array of job types in the Workflow Manager system.

notificationTypes NotificationType[]

An array of notification types in the Workflow Manager system.

privileges Privilege[]

An array of privileges in the Workflow Manager system.

publicQueries JobQueryContainer[]

The array of public queries.

API Reference search results

NameTypeModule

There were no match results from your search criteria.