Hide Table of Contents
Class: WMConfigurationTask
[AMD Module Require]
require(["workflowmanager/WMConfigurationTask"], function(WMConfigurationTask) { /* code goes here */ });;

Description

WMConfigurationTask class to perform operations on Workflow Manager (Classic) Configurations.

Class hierarchy

workflowmanager/BaseTask
|_workflowmanager/WMConfigurationTask

Constructors

NameSummary
new WMConfigurationTask(url)Constructor for WMConfigurationTask. Disable client caching is default to be true.

Properties

NameTypeSummary
disableClientCachingBooleanThe indicator to disable client browser caching.
proxyURLStringThe proxy URL.
tokenStringThe token string if security is on.
urlStringThe base URL for Workflow Manager (Classic) service.

Methods

NameTypeSummary
getAllGroups(callback, errback)ObjectGets a list of all the user groups(GroupInfo[]) that are configured in the ArcGIS Workflow Manager (Classic) system.
getAllUsers(callback, errback)ObjectGets a list of all the users(UserInfo[]) that are configured in the ArcGIS Workflow Manager (Classic) system.
getDataWorkspaceDetails(dataWorkspaceId, callback, errback)ObjectGets the properties and the list of geodatabase versions(DataWorkspaceDetails) for a data workspace.
getGroup(groupId, callback, errback)ObjectGets a single group (GroupDetails).
getJobTypeDetails(jobTypeId, callback, errback)ObjectGets the detailed configuration properties(JobTypeDetails) of a job type.
getPublicJobQueryDetails(queryId, callback, errback)ObjectGets the configuration(JobQueryDetails) of a publicly accessible job query.
getServiceInfo(callback, errback)ObjectGets the configuration properties(WorkflowManagerServiceInfo) specific to a Workflow Manager (Classic) system.
getTableRelationshipsDetails(callback, errback)ObjectGets a list of registered table relationships(TableRelationship[]) in the ArcGIS Workflow Manager (Classic) system.
getUser(username, callback, errback)ObjectGets a single user information(UserDetails).
getUserJobQueryDetails(username, queryId, callback, errback)ObjectGets the configuration(JobQueryDetails) of a user-owned job query.
getVisibleJobTypes(username, callback, errback)ObjectGets a list of job types(JobType[]) a user is allowed to see and create.
Constructor Details

new WMConfigurationTask(url)

Constructor for WMConfigurationTask. Disable client caching is default to be true.
Parameters:
<String>urlRequiredThe base Workflow Manager (Classic) REST URL.
Code Snippet: 
require([
    "workflowmanager/WMConfigurationTask", ...
], function(WMConfigurationTask, ...) {
    var wmConfigTask = new WMConfigurationTask("http://myserver/arcgis/rest/services/WMService/WMServer");
    });
    ...
});
Property Details

<Boolean> disableClientCaching

The indicator to disable client browser caching.

<String> proxyURL

The proxy URL.

<String> token

The token string if security is on.

<String> url

The base URL for Workflow Manager (Classic) Service.
Method Details

getAllGroups(callback, errback)

Gets a list of all the user groups (GroupInfo[]) that are configured in the ArcGIS Workflow Manager (Classic) system. If the request is successful, the user-specified callback function is invoked with the result as a GroupInfo[]. Otherwise, the errback function is invoked with the result error message as string.
Return Value: Object
Input Parameters:
<function> callbackOptionalThe success callback function name.
<function> errbackOptionalThe error callback function name.
Code Snippet: 
require([
    "workflowmanager/WMConfigurationTask", ...
], function(WMConfigurationTask, ...) {
    var groups = new Array();
    wmConfigTask.getAllGroups(function(data){  
        groups = data;    
    });
    ...
});

getAllUsers(callback, errback)

Gets a list of all the users (UserInfo[]) that are configured in the ArcGIS Workflow Manager (Classic) system. If the request is successful, the user-specified callback function is invoked with the result as a UserInfo[]. Otherwise, the errback function is invoked with the result error message as string.
Return Value: Object
Input Parameters:
<function> callbackOptionalThe success callback function name.
<function> errbackOptionalThe error callback function name.
Code Snippet: 
require([
    "workflowmanager/WMConfigurationTask", ...
], function(WMConfigurationTask, ...) {    
    var users = new Array();
    wmConfigTask.getAllUsers(function(data){  
        users = data;    
    });
    ...
});

getDataWorkspaceDetails(dataWorkspaceId, callback, errback)

Gets the properties and the list of geodatabase versions (DataWorkspaceDetails) for a data workspace. If the request is successful, the user-specified callback function is invoked with the result as a DataWorkspaceDetails. Otherwise, the errback function is invoked with the result error message as string.
Return Value: Object
Input Parameters:
<int> dataWorkspaceIdRequiredThe dataWorkspace Id.
<function> callbackOptionalThe success callback function name.
<function> errbackOptionalThe error callback function name.
Code Snippet: 
require([
    "workflowmanager/WMConfigurationTask", ...
], function(WMConfigurationTask, ...) {    
    var dataworkspaceDetails;
    wmConfigTask.getDataWorkspaceDetails("{3E202429-5181-4A2B-ADF9-939D3174D895}",function(data){  
        dataworkspaceDetails = data;    
    });
    ...
});

getGroup(groupId, callback, errback)

Gets a single group (GroupDetails). If the request is successful, the user-specified callback function is invoked with the result as a GroupDetails. Otherwise, the errback function is invoked with the result error message as string.
Return Value: Object
Input Parameters:
<int> groupIdRequiredThe group Id.
<function> callbackOptionalThe success callback function name.
<function> errbackOptionalThe error callback function name.
Code Snippet: 
require([
    "workflowmanager/WMConfigurationTask", ...
], function(WMConfigurationTask, ...) {    
    wmConfigTask.getGroup(6, function(groupDetail){   
        console.log("id: " + groupDetail.id);
        console.log("name: " + groupDetail.name);
        console.log("email: " + groupDetail.email);
        console.log("description: " + groupDetail.description);    
    });
    ...
});

getJobTypeDetails(jobTypeId, callback, errback)

Gets the detailed configuration properties (JobTypeDetails) of a job type. If the request is successful, the user-specified callback function is invoked with the result as a JobTypeDetails. Otherwise, the errback function is invoked with the result error message as string.
Return Value: Object
Input Parameters:
<int> jobTypeIdRequiredThe job type Id.
<function> callbackOptionalThe success callback function name.
<function> errbackOptionalThe error callback function name.
Code Snippet: 
require([
    "workflowmanager/WMConfigurationTask", ...
], function(WMConfigurationTask, ...) {    
    wmConfigTask.getJobTypeDetails(6, function(jobTypeDetails){   
      console.log("id: " + jobTypeDetails.id);
      console.log("name: " + jobTypeDetails.name);
      console.log("state: " + jobTypeDetails.state);
      console.log("defaultPriority: " + jobTypeDetails.defaultPriority);
      console.log("canDataWorkspaceChange: " + jobTypeDetails.canDataWorkspaceChange);    
    });
    ...
});

getPublicJobQueryDetails(queryId, callback, errback)

Gets the configuration (JobQueryDetails) of a publicly accessible job query. If the request is successful, the user-specified callback function is invoked with the result as a JobQueryDetails. Otherwise, the errback function is invoked with the result error message as string.
Return Value: Object
Input Parameters:
<int> queryIdRequiredThe public query Id.
<function> callbackOptionalThe success callback function name.
<function> errbackOptionalThe error callback function name.
Code Snippet: 
require([
    "workflowmanager/WMConfigurationTask", ...
], function(WMConfigurationTask, ...) {    
    wmConfigTask.getPublicJobQueryDetails(3, function(jobQueryDetails){   
      console.log("id: " + jobQueryDetails.id);
      console.log("name: " + jobQueryDetails.name);
      console.log("fields: " + jobQueryDetails.fields);
      console.log("aliases: " + jobQueryDetails.aliases);
      console.log("tables: " + jobQueryDetails.tables);
      console.log("where: " + jobQueryDetails.where);
      console.log("orderBy: " + jobQueryDetails.orderBy);      
    });
    ...
});

getServiceInfo(callback, errback)

Gets the configuration properties (WorkflowManagerServiceInfo) specific to a Workflow Manager (Classic) system. If the request is successful, the user-specified callback function is invoked with the result as a WorkflowManagerServiceInfo. Otherwise, the errback function is invoked with the result error message as string.
Return Value: Object
Input Parameters:
<function> callbackOptionalThe success callback function name.
<function> errbackOptionalThe error callback function name.
Code Snippet: 
require([
    "workflowmanager/WMConfigurationTask", ...
], function(WMConfigurationTask, ...) {    
    wmConfigTask.getServiceInfo(function(data){  
      dojo.forEach(data.jobTypes,function(jobType){
        console.log("name: " + jobType.name);
        console.log("id: " + jobType.id);
        console.log("state: "   + jobType.state);
      }), 
      function(errData){
        console.log("error:" + errData);
      }    
    });
    ...
});

getTableRelationshipsDetails(callback, errback)

Gets a list of registered table relationships (TableRelationship[]) in the ArcGIS Workflow Manager (Classic) system. If the request is successful, the user-specified callback function is invoked with the result as a TableRelationship[]. Otherwise, the errback function is invoked with the result error message as string.
Return Value: Object
Input Parameters:
<function> callbackOptionalThe success callback function name.
<function> errbackOptionalThe error callback function name.
Code Snippet: 
require([
    "workflowmanager/WMConfigurationTask", ...
], function(WMConfigurationTask, ...) {        
    var tableRelationships = new Array();
    wmConfigTask.getTableRelationshipsDetails(function(data){   
      tableRelationships = data;
      dojo.forEach(data,function(tableRelationship){
        console.log("tableName: " + tableRelationship.tableName);
        console.log("tableAlias: " + tableRelationship.tableAlias);
        console.log("linkedField: "   + tableRelationship.linkedField);
        console.log("cardinality: "   + tableRelationship.cardinality);
      });    
    });
    ...
});

getUser(username, callback, errback)

Gets a single user information(UserDetails). If the request is successful, the user-specified callback function is invoked with the result as a UserDetails. Otherwise, the errback function is invoked with the result error message as string.
Return Value: Object
Input Parameters:
<string> usernameRequiredThe user name.
<function> callbackOptionalThe success callback function name.
<function> errbackOptionalThe error callback function name.
Code Snippet: 
require([
    "workflowmanager/WMConfigurationTask", ...
], function(WMConfigurationTask, ...) {        
    var userDetails;
    wmConfigTask.getUser("cjones", function(data){   
      userDetails = data;
    });
    ...
});

getUserJobQueryDetails(username, queryId, callback, errback)

Gets the configuration(JobQueryDetails) of a user-owned job query. If the request is successful, the user-specified callback function is invoked with the result as a JobQueryDetails. Otherwise, the errback function is invoked with the result error message as string.
Return Value: Object
Input Parameters:
<string> usernameRequiredThe user name.
<int> queryIdRequiredThe user query Id.
<function> callbackOptionalThe success callback function name.
<function> errbackOptionalThe error callback function name.
Code Snippet: 
require([
    "workflowmanager/WMConfigurationTask", ...
], function(WMConfigurationTask, ...) {        
    wmConfigTask.getUserJobQueryDetails("cjones", 417, function(jobQueryDetails){   
      console.log("id: " + jobQueryDetails.id);
      console.log("name: " + jobQueryDetails.name);
      console.log("fields: " + jobQueryDetails.fields);
      console.log("aliases: " + jobQueryDetails.aliases);
      console.log("tables: " + jobQueryDetails.tables);
      console.log("where: " + jobQueryDetails.where);
      console.log("orderBy: " + jobQueryDetails.orderBy);
    });
    ...
});

getVisibleJobTypes(username, callback, errback)

Gets a list of job types(JobType[]) a user is allowed to see and create. If the request is successful, the user-specified callback function is invoked with the result as a JobType[]. Otherwise, the errback function is invoked with the result error message as string.
Return Value: Object
Input Parameters:
<string> usernameRequiredThe user name.
<function> callbackOptionalThe success callback function name.
<function> errbackOptionalThe error callback function name.
Code Snippet: 
require([
    "workflowmanager/WMConfigurationTask", ...
], function(WMConfigurationTask, ...) {    
    var jobTypes = new Array();
    wmConfigTask.getAllUsers("cjones", function(data){  
        jobTypes = data;    
    });
    ...
});