The following sections contain ArcGIS Arcade expressions that allow you to retrieve job information managed by ArcGIS Workflow Manager. Many of the values for job properties are initially set when the job is created and are based on the values defined in the job template. Job properties can be manually updated in the Details panel or updated by running steps.
Tip:
To access business-specific properties that were configured by your organization, use extended properties expressions.
JobDescription
The JobDescription expression returns the description associated with a job.
Parameters
JobDescription(job_id)
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
Output
Returns a string value of the specified job's description field.
Expression sample
The following expression returns the current job's description:
JobDescription($Job)This is a landbase editing job.JobDueDate
The JobDueDate expression returns the due date for the specified job in epoch format.
Parameters
JobDueDate(job_id)
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
Output
Returns a string value of the due date for the specified job in epoch format.
Expression sample
The following expression returns the current job's due date:
JobDueDate($Job)1589414631JobEndDate
If the specified job is closed, the JobEndDate expression returns the date that it was closed.
Parameters
JobEndDate(job_id)
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
Output
Returns a string value of the date that the specified job was closed in epoch format.
Expression sample
The following expression returns the date that the specified job was closed:
JobEndDate('RRpFaSk1QK2IIHZTJX4flQ')1589416739JobCreator
The JobCreator expression returns the username of the user who created the specified job.
Parameters
JobCreator(job_id)
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
Output
Returns a string value of the username of the user who created the specified job.
Expression sample
The following expression returns the username of the user who created the current job:
JobCreator($Job)jdoeJobComment
The JobComment expression returns the most recent comment associated with the specified job or step.
Parameters
JobComment(job_id, {step_id})
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
step_id (Optional) | The ID of the step in the workflow diagram. If an ID is not provided, the most recent comment associated with the job is returned. | String |
Output
Returns a string value of the most recent comment associated with the specified job or step.
Expression sample
The following expression returns the most recent comment associated with the current job's specified step:
JobComment($Job, 'f50d740d-cc04-9296-4ce3-181e82604465')The submitted feature edits are ready for your review.$Job
The $Job variable returns the job ID of the current job. This variable is frequently used to dynamically populate the job_id parameter of other Arcadeexpressions.
Output
Returns a string value of the current job's ID.
Variable sample
The following variable returns the ID of the current job:
$JobRRpFaSk1QK2IIHZTJX4flQJobIndex
The JobIndex expression returns the index value associated with the chronological order of job creation. Jobs created before Workflow Manager 11.2 evaluate to a value of -1.
Parameters
JobIndex(job_id)
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
Output
Returns a string value of the specified job's index field. This is the value associated with the chronological order of job creation.
Expression sample
The following expression returns the index of the current job:
JobIndex($Job)12345JobName
The JobName expression returns the name of the specified job.
Parameters
JobName(job_id)
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
Output
Returns a string value of the name of specified job.
Expression sample
The following expression returns the name of the current job:
JobName($Job)DataEdits_123JobOwner
The JobOwner expression returns the username of the job owner.
Parameters
JobOwner(job_id)
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
Output
Returns a string value of the username of the job owner.
Expression sample
The following expression returns the username of the current job's owner:
JobOwner($Job)jdoe$ParentJob
The $ParentJob variable returns the job ID of the parent job to which the current job belongs.
Output
Returns a string value of the job ID of the parent job to which the current job belongs.
Variable sample
The following variable returns the job ID of the parent job to which the current job belongs:
$ParentJobZZfPSka12KQHHITZXJf4qLJobPriority
The JobPriority expression returns the priority of the specified job.
Parameters
JobPriority(job_id)
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
Output
Returns a string value of the specified job's priority.
Expression sample
The following expression returns the priority of the current job:
JobPriority($Job)MediumJobStartDate
The JobStartDate expression returns the date that the specified job was started.
Parameters
JobStartDate(job_id)
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
Output
Returns a string value of the start date for the specified job in epoch format.
Expression sample
The following expression returns the date that the current job was started:
JobStartDate($Job)1589414631JobStatus
The JobStatus expression returns the status of the specified job.
Parameters
JobStatus(job_id)
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
Output
Returns a string value of the specified job's status.
Expression sample
The following expression returns the status of the current job:
JobStatus($Job)Ready to workJobType
The JobType expression returns the name of the job template from which the specified job was created.
Parameters
JobType(job_id)
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
Output
Returns a string value of the name of the job template from which the specified job was created.
Expression sample
The following expression returns the name of the job template from which the current job was created:
JobType($Job)Data Edits