Hide Table of Contents
Class: Step

Description

The Step class returns the properties of a step that is used in a job's workflow.

Class hierarchy

esri.WorkflowManager.SupportClasses.Step()

Properties

NameTypeSummary
assignedTostringThe user the step is assigned to.
assignedTypeJobAssignmentTypeA value that indicates if a job is assigned to a user(1), group(2) or unassigned(0).
asyncbooleanIndicates if the step can be run asynchronously.
autoRunbooleanIndicates if the step can be automatically executed when reached.
canSkipbooleanIndicates if the step can be skipped without executing it.
canSpawnConcurrencybooleanIndicates if the step can start parallel execution of other steps.
commonIdintThe step type ID.
defaultPercentCompleteintThe default percentage completion of the job once step is reached.
hasBeenExecutedbooleanIndicates if the step has already been executed.
hasBeenStartedbooleanIndicates if the step has been started.
idintA unique ID generated as the step Id.
namestringThe name of the step.
selfCheckbooleanIndicates if the step will be automatically marked as complete when complete.
statusIdintThe numeric status value configured as the status of the job once step is reached.
stepPercentCompleteintThe percentage completion of the step.
notificationTypestringThe type of notification that will be sent when step is completely executed.
stepTypeStepTypeThe step template in the workflow.
Property Details

<string> assignedTo

The user the step is assigned to.

<JobAssignmentType> assignedType

The type of assignment of the job/step.

<boolean> async

Indicates if the step can be run asynchronously.

<boolean> autoRun

Indicates if the step can be automatically executed when reached.

<boolean> canSkip

Indicates if the step can be skipped without executing it.

<boolean> CanSpawnConcurrency

Indicates if the step can start parallel execution of other steps.

<int> commonId

The step type ID.

<int> defaultPercentComplete

The default percentage completion of the job once step is reached.

<boolean> hasBeenExecuted

Indicates if the step has already been executed.

<int> id

A unique ID generate as the step Id.

<string> name

The name of the step.

<boolean> selfCheck

Indicates if the step will be automatically marked as complete when complete.

<int> statusId

The numeric status value configured as the status of the job once step is reached.

<int> stepPercentComplete

The percentage completion of the step.

<string> notificationType

The type of notification that will be sent when step is completely executed.

<stepType> stepType

The step template in the workflow.