Hide Table of Contents
esri Workflow Manager (Classic)
Tasks
Return Types
Class: Enum
[AMD Module Require]
require(["workflowmanager/Enum"], function(Enum) { /* code goes here */ });;
Description
The class contains enumerations for Workflow Manager (Classic) settings.
Class hierarchy
workflowmanager/Enum
Constants
| Name | Summary |
|---|---|
| Enum.ChangeCondition | Enum for dataset evaluator change condition. |
| Enum.ChangeRuleSearchType | Enum for change rule search type. |
| Enum.ChangeType | Enum for change rule search type. |
| Enum.CompareOperator | Enum for Compare Operator. |
| Enum.ExtendedPropertyDisplayType | Enum for Display Type. |
| Enum.FieldType | Enum for Field Type. |
| Enum.JobAssignmentType | Enum for Job Assignment Type. |
| Enum.JobAttachmentType | Enum for Job Attachment Type. |
| Enum.JobDependencyType | Enum for Job Dependency Type. |
| Enum.JobStage | Enum for Job Stage. |
| Enum.JobTypeState | Enum for Job Type State. |
| Enum.StepDescriptionType | Enum for Step Description Type. |
| Enum.StepExecutionResult | Enum for Step Execution Result. |
| Enum.StepExecutionType | Enum for Step Execution Type |
| Enum.StepIndicatorType | Enum for Step Indicator Type. |
| Enum.StepPlatformType | Enum for Step Platform Type. |
| Enum.StepRunnableStatus | Enum for Step Runnable Status. |
| Enum.TableRelationshipType | Enum for Table Relationship Type. |
Constants Detail
Enum for dataset evaluator change condition.
Constants:
| Constant | Value | Description |
|---|---|---|
| ALL | 0 | All changes. |
| BEFORE | 1 | Condition before changes are made. |
| AFTER | 2 | Condition after changes are made. |
Enum for change rule search type.
Constants:
| Constant | Value | Description |
|---|---|---|
| CONTAINS | "contain" | Search result return the change rule if it contains the value. |
| EXACT | "exact" | Search matches exactly the change rule. |
| STARTS_WITH | "start" | Search result return the change rule if it starts with the value. |
| ENDS_WITH | "end" | Search result return the change rule if it ends with the value. |
Enum for Change Type.
Constants:
| Constant | Value | Description |
|---|---|---|
| ADD | 1 | Addition. |
| MODIFY | 2 | Modification. |
| DELETE | 4 | Deletion. |
| ALL | 7 | All changes. |
Enum for Compare Operator.
Constants:
| Constant | Value | Description |
|---|---|---|
| EQUAL | 0 | Equals. |
| NOT_EQUAL | 1 | Does not equal. |
| GREATER_THAN | 2 | Is greater than. |
| GREATER_OR_EQUAL | 3 | Is greater than or equal to. |
| LESS_THAN | 4 | Is less than. |
| LESS_OR_EQUAL | 5 | Is less than or equal to. |
| CONTAINS | 6 | Contains. |
Enum for Display Type.
Constants:
| Constant | Value | Description |
|---|---|---|
| DEFAULT | 0 | The UI determines what display type would be used to display the extended property. |
| TEXT | 1 | Extended property displayed as text. |
| DATE | 2 | Extended property displayed as date. |
| DOMAIN | 4 | Extended property displayed as list of domain values. |
| FILE | 5 | Extended property displayed as a file path. |
| GEO_FILE | 6 | Extended property displayed as path to the geographic dataset. |
| FOLDER | 7 | Extended property displayed as folder path. |
| LIST | 8 | Extended property displayed as list of values. |
| TABLE_LIST | 9 | Extended property displayed as list of values coming from specified table. |
| MULTI_LEVEL_TABLE_LIST | 10 | Extended property displayed a list of values coming from specified table and filters next field to be picked. |
Enum for Field Type.
Constants:
| Constant | Value | Description |
|---|---|---|
| SMALL_INTEGER | 0 | Short Integer. |
| INTEGER | 1 | Long Integer. |
| SINGLE | 2 | Single-precision floating-point number. |
| DOUBLE | 3 | Double-precision floating-point number. |
| STRING | 4 | Character string. |
| DATE | 5 | Date. |
| OID | 6 | Long Integer representing an object identifier. |
| GEOMETRY | 7 | Geometry. |
| BLOB | 8 | Binary Large Object. |
| RASTER | 9 | Raster. |
| GUID | 10 | Globally Unique Identifier. |
| GLOBAL_ID | 11 | ESRI Global ID. |
| XML | 12 | XML Document. |
Enum for Job Assignment Type.
Constants:
| Constant | Value | Description |
|---|---|---|
| NONE | -1 | Job assignment is NONE . The job type default job assignment type will be used. |
| UNASSIGNED | 0 | Job is unassigned. |
| ASSIGNED_TO_USER | 1 | Job is assigned to a user. |
| ASSIGNED_TO_GROUP | 2 | Job is assigned to a group. |
Enum for Job Attachment Type.
Constants:
| Constant | Value | Description |
|---|---|---|
| LINKED_FILE | 1 | Linked file attachment. |
| EMBEDDED | 2 | Embedded attachment. |
| LINKED_URL | 3 | Linked URL. |
Enum for Job Dependency Type.
Constants:
| Constant | Value | Description |
|---|---|---|
| STEP | 1 | Job is depended on a step. |
| STAGE | 2 | Job is depended on a stage. |
| STATUS | 3 | Job is depended on a status. |
Enum for Job Stage.
Constants:
| Constant | Value | Description |
|---|---|---|
| NONE | -1 | |
| CREATED | 1 | Job is created. |
| READY_TO_WORK | 2 | Job is ready to work. |
| WORKING | 3 | Job is being worked on. |
| DONE_WORKING | 4 | Working on the job is done. |
| CLOSED | 5 | Job is closed. |
Enum for Job Type State.
Constants:
| Constant | Value | Description |
|---|---|---|
| DRAFT | 0 | Draft State. |
| ACTIVE | 1 | Active State. |
| RETIRED | 2 | Retired State. |
Enum for Step Description Type.
Constants:
| Constant | Value | Description |
|---|---|---|
| NONE | 1 | No step description. |
| HTML | 2 | Step description in HTML type. |
| LINK | 3 | An URL link to step description. |
Enum for Step Execution Result.
Constants:
| Constant | Value | Description |
|---|---|---|
| EXECUTED | 1 | The step executed successfully. |
| DEPENDENT_ON_STEP | 2 | Dependent on a step in another job. |
| DEPENDENT_ON_STAGE | 3 | Dependent on a stage in another job. |
| DEPENDENT_ON_STATUS | 4 | Dependent on a status in another job. |
| JOB_ON_HOLD | 5 | Blocked by an active job hold. |
| STEP_DEPENDS_ON_STEP | 6 | Dependent on a previous step in this job's workflow. |
| CHECK | 7 | The step was marked as complete. |
| STEP_ASSIGNED_TO_OTHER_USER | 8 | The step is assigned to another user. |
| STEP_ASSIGNED_TO_OTHER_GROUP | 9 | The step is assigned to another group. |
| JOB_ASSIGNED_TO_OTHERS | 10 | The job is assigned to another user/group. |
| JOB_CLOSED | 11 | The job is closed. |
| INVALID_PLATFORM | 12 | The step is configured for a different platform (desktop vs. server). |
| INVALID_STEP | 13 | Invalid step. |
| DEPENDENT_ON_JOB | 14 | Dependent on another job. |
| NOT_CURRENT_STEP | 15 | The step is not the current workflow step. |
Enum for Step Execution Type.
Constants:
| Constant | Value | Description |
|---|---|---|
| EXECUTABLE | 1 | Executable step. |
| FUNCTION | 2 | Functional step. |
| PROCEDURAL | 3 | Procedural step. |
| LAUNCH_URL | 4 | Launch URL step. |
| QUESTION | 5 | Question step. |
| OPEN_FILE | 6 | Open file step. |
Enum for Step Indicator Type.
Constants:
| Constant | Value | Description |
|---|---|---|
| ROUNDED_RECTANGLE | 1 | Step shows in a rounded rectangle. |
| RECTANGLE | 2 | Step shows in a rectangle. |
| OVAL | 3 | Step shows in an oval. |
| DIAMOND | 4 | Step shows in a diamond. |
| PARALLELOGRAM | 5 | Step shows in a parallelogram. |
Enum for Step Platform Type.
Constants:
| Constant | Value | Description |
|---|---|---|
| DESKTOP | 0 | Step can be run on desktop. |
| SERVER | 1 | Step can be run on server. |
| BOTH | 2 | Step can be run on both desktop and server. |
Enum for Step Runnable Status.
Constants:
| Constant | Value | Description |
|---|---|---|
| CAN_RUN | 1 | The step is runnable. |
| DEPENDENT_ON_STEP | 2 | Dependent on a step in another job. |
| DEPENDENT_ON_STAGE | 3 | Dependent on a stage in another job. |
| DEPENDENT_ON_STATUS | 4 | Dependent on a status in another job. |
| JOB_ON_HOLD | 5 | Blocked by an active job hold. |
| STEP_DEPENDS_ON_STEP | 6 | Dependent on a previous step in this job's workflow. |
| CHECK | 7 | The step was marked as complete. |
| STEP_ASSIGNED_TO_OTHER_USER | 8 | The step is assigned to another user. |
| STEP_ASSIGNED_TO_OTHER_GROUP | 9 | The step is assigned to another group. |
| JOB_ASSIGNED_TO_OTHERS | 10 | The job is assigned to another user/group. |
| JOB_CLOSED | 11 | The job is closed. |
| INVALID_PLATFORM | 12 | The step is configured for a different platform (desktop vs. server). |
| INVALID_STEP | 13 | Invalid step. |
| DEPENDENT_ON_JOB | 14 | Dependent on another job. |
| NOT_CURRENT_STEP | 15 | The step is not the current workflow step. |