| API Reference | ArcGIS Workflow Manager (Classic) API for JavaScript

Hide Table of Contents

esri Workflow Manager (Classic)

Enum

Tasks

BaseTask

WMAOILayerTask

WMConfigurationTask

WMJobTask

WMNotificationTask

WMReportTask

WMTokenTask

WMWorkflowTask

Return Types

ActivityRecord

ActivityType

AuxRecord

AuxRecordContainer

AuxRecordValue

ChangeRuleMatch

DataWorkspace

DataWorkspaceDetails

ExecuteInfo

FieldValue

GroupDetails

GroupInfo

GroupMembership

HoldType

JobAttachment

JobDependency

JobHold

JobInfo

JobPriority

JobQuery

JobQueryContainer

JobQueryDetails

JobStatus

JobType

JobTypeDetails

JobVersionInfo

NotificationType

Privilege

QueryFieldInfo

QueryResult

Report

ReportData

ReportDataGroup

Step

StepComment

StepType

TableRelationship

UserDetails

UserInfo

VersionInfo

WorkflowAnnotationDisplayClass

WorkflowConflicts

WorkflowDisplayDetails

WorkflowManagerServiceInfo

WorkflowOption

WorkflowPathDisplayDetails

WorkflowStepDisplayDetails

WorkflowStepInfo

SupportClasses

AOIEvaluator

AuxRecordDescription

ChangeRule

DataSetConfiguration

DataSetEvaluator

EmailNotifier

JobCreationParameters

JobQueryParameters

JobUpdateParameters

WhereCondition

Class: WMWorkflowTask

[AMD Module Require]

require(["workflowmanager/WMWorkflowTask"], function(WMWorkflowTask) { /* code goes here */ });;

Description

WMWorkflowTask class to perform operations on Workflow Manager (Classic) Workflows.

Class hierarchy

workflowmanager/BaseTask
|_workflowmanager/WMWorkflowTask

Constructors

Constructor	Description
new WMWorkflowTask(url)	Constructor for WMWorkflowTask. Disable client caching is default to be true.

Properties

Name	Type	Summary
disableClientCaching	Boolean	The indicator to disable client browser caching.
proxyURL	String	The proxy URL.
token	String	The token string if security is on.
url	String	The base URL for Workflow Manager (Classic) service.

Methods

Method	Return Value	Description
assignSteps(jobId, stepIds, assignedType, assignedTo, user, callback, errback)	Object	Assigns one or more steps (Step[]) of a job.
canRunStep(jobId, stepId, user, callback, errback)	Object	Get a StepRunnableStatus that indicates if this workflow step can be run.
executeSteps(jobId, stepIds, user, auto, callback, errback)	Object	Executes the specified steps in order and gets back execute information (ExecuteInfo[]).
getAllSteps(jobId, callback, errback)	Object	Retrieves all workflow steps (Step[]) of a job.
getCurrentSteps(jobId, callback, errback)	Object	Retrieves the current workflow steps (Step[]) of a job.
getStep(jobId, stepId, callback, errback)	Object	Retrieves a specific workflow step (Step[]) of a job.
getStepComments(jobId, stepId, callback, errback)	Object	Gets all the comments (StepComment[]) associated with a specific step of a job workflow.
getStepDescription(jobId, stepId, callback, errback)	none	Get the detailed description of a workflow step.
getStepFileURL(jobId, stepId)	string	Returns a URL string to access the file content of a file step.
getWorkflowDisplayDetails(jobId, callback, errback)	Object	Get a job's workflow display details (WorkflowDisplayDetails).
getWorkflowImageURL(jobId)	string	Returns a URL string to an image depicting the current state of a job's workflow.
logStepComment(jobId, stepId, comment, user, callback, errback)	none	Adds a new comment on a specific step of a job workflow.
markStepsAsDone(jobId, stepIds, user, callback, errback)	Object	Marks the specified steps of a job workflow as completed and returns ExecuteInfo[].
moveToNextStep(jobId, stepId, returnCode, user, callback, errback)	none	Advances the workflow to the next step based on a return code value.
recreateWorkflow(jobId, user, callback, errback)	none	Recreates the job workflow. The job workflow will be updated with the latest job type's workflow after the job has been created.
resolveConflict(jobId, stepId, optionReturnCode, optionStepIds, user, callback, errback)	none	Resolves workflow path conflicts that can result in executing or marking as complete a step that can have two or more next steps.
setCurrentStep(jobId, stepId, user, callback, errback)	none	Sets a step as the currently active step of a job workflow.

Constructor Details

new WMWorkflowTask(url)

Constructor for WMWorkflowTask. Set disableClientCaching to be True.

Parameters:

<string>url

Required

The base Workflow Manager (Classic) REST URL.

Sample:

require([
    "workflowmanager/WMWorkflowTask", ...
], function(WMWorkflowTask, ...) {
    var wmWorkflowTask = new WMWorkflowTask("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

assignSteps(jobId, stepIds, assignedType, assignedTo, user, callback, errback)

Assigns one or more steps (Step[]) of a job.

Input Parameters:

<int> jobId	Required	The job Id.
<array> stepIds	Required	An array of step IDs.
<JobAssignmentType> assignedType	Required	Determines whether to assign to a user or group.
<string> assignedTo	Required	The name of the user or group to assign the jobs to.
<string> user	Required	The user name.
<function> callback	Optional	The success callback function name.
<function> errback	Optional	The error callback function name.

Sample:

require([
    "workflowmanager/WMWorkflowTask", ...
], function(WMWorkflowTask, ...) {
    var stepIds = [574, 581];
    wmWMWorkflowTask.assignSteps(401, stepIds, esri.WorkflowManager.JobAssignmentType.USER, "jrobinson", "cjones", 
        function () {
            alert("Steps assigned successfully.")
        }, function () {
            alert("Failed to assign steps.")
        });       
    ...
});

canRunStep(jobId, stepId, user, callback, errback)

Get a StepRunnableStatus that indicates if this workflow step can be run. If the request is successful, the user-specified callback function is invoked with the result as a StepRunnableStatus. Otherwise, the errback function is invoked with the result error message as string.

Input Parameters:

<int> jobId	Required	The job Id.
<int> stepId	Required	The step Id.
<string> user	Required	The user name.
<function> callback	Optional	The success callback function name.
<function> errback	Optional	The error callback function name.

Sample:

require([
    "workflowmanager/WMWorkflowTask", ...
], function(WMWorkflowTask, ...) {
    wmWorkflowTask.canRunStep(6803, 6815, "demo", function (data) {
        console.log("canRun value is: " + data);
    });       
    ...
});

executeSteps(jobId, stepIds, user, auto, callback, errback)

Executes the specified steps in order and gets back execute information (ExecuteInfo[]). If the request is successful, the user-specified callback function is invoked with the result as a ExecuteInfo[]. Otherwise, the errback function is invoked with the result error message as string.

Input Parameters:

<int> jobId	Required	The job Id.
<int> stepId	Required	The step Id.
<string> user	Required	The user name.
<int> reportId	Required	The report Id.
<string> user	Required	The user name.

Sample:

require([
    "workflowmanager/WMWorkflowTask", ...
], function(WMWorkflowTask, ...) {
    var stepIds = [17682, 17683];
    var executeInfoArray = new Array();
    wmWorkflowTask.executeSteps(18011, stepIds, "demo", true, function (data) {
        executeInfoArray = data;
    });       
    ...
});

getAllSteps(jobId, callback, errback)

Retrieves all workflow steps (Step[]) of a job. If the request is successful, the user-specified callback function is invoked with the result as a Step[]. Otherwise, the errback function is invoked with the result error message as string.

Input Parameters:

<int> jobId	Required	The job Id.
<function> callback	Optional	The success callback function name.
<function> errback	Optional	The error callback function name.

Sample:

require([
    "workflowmanager/WMWorkflowTask", ...
], function(WMWorkflowTask, ...) {
    var steps = new Array();
    wmWorkflowTask.getAllSteps(18011, function (data) {
        steps = data;
    });       
    ...
});

getCurrentSteps(jobId, callback, errback)

Input Parameters:

<int> jobId	Required	The job Id.
<function> callback	Optional	The success callback function name.
<function> errback	Optional	The error callback function name.

Sample:

require([
    "workflowmanager/WMWorkflowTask", ...
], function(WMWorkflowTask, ...) {
    var steps = new Array();
    wmWorkflowTask.getAllSteps(18011, function (data) {
        steps = data;
    });       
    ...
});

getStep(jobId, stepId, callback, errback)

Retrieves a specific workflow step (Step) of a job. If the request is successful, the user-specified callback function is invoked with the result as a Step. Otherwise, the errback function is invoked with the result error message as string.

Input Parameters:

<int> jobId	Required	The job Id.
<int> stepId	Required	The step Id.
<function> callback	Optional	The success callback function name.
<function> errback	Optional	The error callback function name.

Sample:

require([
    "workflowmanager/WMWorkflowTask", ...
], function(WMWorkflowTask, ...) {
    wmWorkflowTask.getStep(6833, 6966, function (step) {
     console.log("id: " + step.id);
     console.log("assignedTo: " + step.assignedTo);
     console.log("canSkip: " + step.canSkip);
     console.log("name: " + step.name);
    });       
    ...
});

getStepComments(jobId, stepId, callback, errback)

Gets all the comments (StepComment[]) associated with a specific step of a job workflow. If the request is successful, the user-specified callback function is invoked with the result as a StepComment[]. Otherwise, the errback function is invoked with the result error message as string.

Input Parameters:

<int> jobId	Required	The job Id.
<int> stepId	Required	The step Id.
<function> callback	Optional	The success callback function name.
<function> errback	Optional	The error callback function name.

Sample:

require([
    "workflowmanager/WMWorkflowTask", ...
], function(WMWorkflowTask, ...) {
    var comments = new Array();
    wmWorkflowTask.getStepComments(6833, 6966, function (data) {
        comments = data;
    });       
    ...
});

getStepDescription(jobId, stepId, callback, errback)

Get the detailed description of a workflow step. If the request is successful, the user-specified callback function is invoked with the result as a string that describes the step. Otherwise, the errback function is invoked with the result error message as string.

Input Parameters:

<int> jobId	Required	The job Id.
<int> stepId	Required	The step Id.
<function> callback	Optional	The success callback function name.
<function> errback	Optional	The error callback function name.

Sample:

require([
    "workflowmanager/WMWorkflowTask", ...
], function(WMWorkflowTask, ...) {
    var description;
    wmWorkflowTask.getStepDescription(18819, 18118, function (data) {
        description = data;
    });        
    ...
});

{string} getStepFileURL(jobId, stepId)

Returns a URL string to access the file content of a file step.

Input Parameters:

<int> jobId	Required	The job Id.
<int> stepId	Required	The step Id.

Returns:: {string} URL String to access the file content of a file step.

Sample:

require([
    "workflowmanager/WMWorkflowTask", ...
], function(WMWorkflowTask, ...) {
    var urlString = wmWorkflowTask.getStepFileURL(18819, 18118);
    window.open(urlString, "_blank"); 
});

getWorkflowDisplayDetails(jobId, callback, errback)

Get a job's workflow display details (WorkflowDisplayDetails). If the request is successful, the user-specified callback function is invoked with the result as a WorkflowDisplayDetails. Otherwise, the errback function is invoked with the result error message as string.

Input Parameters:

<int> jobId	Required	The job Id.
<function> callback	Optional	The success callback function name.
<function> errback	Optional	The error callback function name.

Sample:

require([
    "workflowmanager/WMWorkflowTask", ...
], function(WMWorkflowTask, ...) {
    var details;
    wmWorkflowTask.getWorkflowDisplayDetails(18414, function (data) {
        details = data;
    });
    ...
});

{string} getWorkflowImageURL(jobId)

Returns a URL string to an image depicting the current state of a job's workflow.

Input Parameters:

<int> jobId

Required

The job Id.

Returns:: {string} URL String to access the file content of a job attachment.

Sample:

require([
    "workflowmanager/WMWorkflowTask", ...
], function(WMWorkflowTask, ...) {
    var img = document.getElemenyById("workflowImage");
    var urlString = wmWorkflowTask.getWorkflowImageURL(18819);
    img.src = urlString;
});

logStepComment(jobId, stepId, comment, user, callback, errback)

Adds a new comment on a specific step of a job workflow. If the request is successful, the user-specified callback function is invoked with the empty result. Otherwise, the errback function is invoked with the result error message as string.

Input Parameters:

<int> jobId	Required	The job Id.
<int> stepId	Required	The step Id.
<string> comment	Required	A brief message to associate with the step.
<string> user	Required	The user name
<function> callback	Optional	The success callback function name.
<function> errback	Optional	The error callback function name.

Sample:

require([
    "workflowmanager/WMWorkflowTask", ...
], function(WMWorkflowTask, ...) {
    wmWorkflowTask.logStepComment(6833, 6966, "this is to add comment to a step", "demo", function (data) {
        alert("Log comment successfully.");
    });
    ...
});

markStepsAsDone(jobId, stepIds, user, callback, errback)

Marks the specified steps of a job workflow as completed and returns ExecuteInfo[]. If the request is successful, the user-specified callback function is invoked with the result as a ExecuteInfo[]. Otherwise, the errback function is invoked with the result error message as string.

Input Parameters:

<int> jobId	Required	The job Id.
<int[]> stepIds	Required	The array of step Ids.
<string> user	Required	The user name
<function> callback	Optional	The success callback function name.
<function> errback	Optional	The error callback function name.

Sample:

require([
    "workflowmanager/WMWorkflowTask", ...
], function(WMWorkflowTask, ...) {
    var stepIds = [17682, 17683];
    var executeInfoArray = new Array();
    wmWorkflowTask.markStepsAsDone(18413, stepIds, "demo", function (data) {
      executeInfoArray = data;
    });
    ...
});

moveToNextStep(jobId, stepId, returnCode, user, callback, errback)

Advances the workflow to the next step based on a return code value. If the request is successful, the user-specified callback function is invoked with the empty result. Otherwise, the errback function is invoked with the result error message as string.

Input Parameters:

<int> jobId	Required	The job Id.
<int> stepId	Required	The step Id.
<int> returnCode	Required	A numeric value representing the return code chosen by the client.
<string> user	Required	The user name
<function> callback	Optional	The success callback function name.
<function> errback	Optional	The error callback function name.

Sample:

require([
    "workflowmanager/WMWorkflowTask", ...
], function(WMWorkflowTask, ...) {
    wmWorkflowTask.moveToNextStep(23223, 22154, 3, "demo", function (data) {
        alert("Successfully moved to next step.");
    });
    ...
});

recreateWorkflow(jobId, user, callback, errback)

Recreates the job workflow. The job workflow will be updated with the latest job type's workflow after the job has been created.

Input Parameters:

<int> jobId	Required	The job Id.
<string> user	Required	The user name
<function> callback	Optional	The success callback function name.
<function> errback	Optional	The error callback function name.

Sample:

require([
    "workflowmanager/WMWorkflowTask", ...
], function(WMWorkflowTask, ...) {
    wmWorkflowTask.recreateWorkflow(6833, "demo", function (data) {
        alert("Successfully recreated job workflow.");
    }); 
    ...
});

resolveConflict(jobId, stepId, optionReturnCode, optionStepIds, user, callback, errback)

Resolves workflow path conflicts that can result in executing or marking as complete a step that can have two or more next steps. If the request is successful, the user-specified callback function is invoked with the empty result. Otherwise, the errback function is invoked with the result error message as string.

Input Parameters:

<int> jobId	Required	The job Id.
<int> stepId	Required	The step Id.
<int> optionReturnCode	Required	A numeric value representing the return code from the step where the conflict was encountered.
<int[]> optionStepIds	Required	An array of step IDs of all the possible next steps.
<string> user	Required	The user name
<function> callback	Optional	The success callback function name.
<function> errback	Optional	The error callback function name.

Sample:

require([
    "workflowmanager/WMWorkflowTask", ...
], function(WMWorkflowTask, ...) {
    var steps = [6964];
    wmWorkflowTask.resolveConflict(6833, 6967, 2, steps, "demo", function (data) {
        alert("Successfully resolved conflict.");
    }); 
    ...
});

setCurrentStep(jobId, stepId, user, callback, errback)

Sets a step as the currently active step of a job workflow. If the request is successful, the user-specified callback function is invoked with the empty result. Otherwise, the errback function is invoked with the result error message as string.

Input Parameters:

<int> jobId	Required	The job Id.
<int> stepId	Required	The step Id.
<string> user	Required	The user name
<function> callback	Optional	The success callback function name.
<function> errback	Optional	The error callback function name.

Sample:

require([
    "workflowmanager/WMWorkflowTask", ...
], function(WMWorkflowTask, ...) {
    wmWorkflowTask.setCurrentStep(6833, 6967, "demo", function (data) {
      alert("Successfully set step 6967 as current step.");
    });  
    ...
});