The following sections contain ArcGIS Arcade expressions that allow you to retrieve data reference and job version information managed by ArcGIS Workflow Manager. These expressions are commonly used in data editing workflows that involve the creation and management of branch versions.
JobDataReferenceDetails
The JobDataReferenceDetails expression returns the details of a data reference associated with a job.
Parameters
JobDataReferenceDetails(job_id, data_reference_id)
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
data_reference_id | The ID of the data reference configured with the workflow diagram. | String |
Output
Returns a string value of the data reference details associated with the specified job.
Expression sample
The following expression returns the details of the specified data reference associated with the current job.
JobDataReferenceDetails($job, 'd25bba32-f871-4a32-bc0f-9e6d3aa8e83d'){
"referenceType": "FeatureService",
"portalItemId": " 816eb574017742aa9679685ac3c01860",
"dataReferenceId": "d25bba32-f871-4a32-bc0f-9e6d3aa8e83d",
"alias": "Gas_Utility_Network",
"portalType": "Current"
}JobDataReferenceDetailsArray
The JobDataReferenceDetailsArray expression returns the details of all data references associated with a job.
Parameters
JobDataReferenceDetailsArray(job_id)
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
Output
Returns an array of all the data references associated with a job.
Expression sample
The following expression returns the details of all data references associated with the current job.
JobDataReferenceDetailsArray($job)[
{
"referenceType": "FeatureService",
"portalItemId": "aa2870503a8543669470a4a5b0303bc3",
"dataReferenceId": "a7454df2-75ad-4f5a-9855-4c1d5ae20fa3",
"alias": "Gas_Utility_Network",
"portalType": "Current"
},
{
"dataReferenceId": "ae457c8e-968b-43cf-a6e0-c531b8e8aa51",
"referenceType": "ProItem",
"itemName": "ProMap"
},
{
"dataReferenceId": "31fbc009-2fae-43d6-86b7-4c054508071b",
"referenceType": "ProItem",
"itemName": "Utility_Editing_task"
}
]JobDataSource
The JobDataSource expression returns the data source URL of the specified job's workflow diagram if it contains a data source and a version of the data source has been created for the specified job.
Parameters
JobDataSource(job_id, data_reference_id)
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
data_reference_id | The ID of the data reference configured with the workflow diagram. Note:While data_source_name is still supported, using data_reference_id is recommended for the centralized data references format. | String |
Output
Returns a string value of the data source URL of the specified job's workflow diagram if it contains a data source, and a version of the data source has been created for the specified job.
Expression sample
The following expression returns the data source URL of the current job's workflow diagram:
JobDataSource($Job, '31fbc009-2fae-43d6-86b7-4c054508071b')https://portal.domain.com/server/rest/services/UtilityNetwork_Data/FeatureServerJobDataSourceArray
The JobDataSourceArray expression returns all of the data source URLs for the specified job's workflow diagram.
Parameters
JobDataSourceArray(job_id)
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
Output
Returns an array of string values of all of the data source URLs for the specified job's workflow diagram.
Expression sample
The following expression returns the data source URLs for the current job's workflow diagram:
JobDataSourceArray($Job)['https://portal.domain.com/server/rest/services/Utility_Network_Data/FeatureServer', 'https://portal.domain.com/server/rest/services/Parcel_Fabric_Data/FeatureServer']JobVersionDetails
The JobVersionDetails expression returns the active version details of the specified data source.
Parameters
JobVersionDetails(job_id, data_reference_id)
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
data_reference_id | The ID of the data reference configured with the workflow diagram. Note:While data_source_name is still supported, using data_reference_id is recommended for the centralized data references format. | String |
Output
Returns the active version details for the specified data source.
Expression sample
The following expression returns the current job's active version details for the Gas_Utility_Network data source:
JobVersionDetails($Job,'aa2870503a8543669470a4a5b0303bc3'){
"replicaId":"<replica ID>",
"replicaName":"<replica name>",
"replicaLocation":"<replica location>",
"name":"<version name>",
"versionId":"<version ID>",
"url":"<URL>",
"privateUrl":"<privateURL>",
"layerItemId":"<Layer Item ID>"
}JobVersionDetailsArray
The JobVersionDetailsArray expression returns the version details of each data source in the order in which they are defined in the job's workflow diagram.
Parameters
JobVersionDetails(job_id)
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
Output
Returns a JSON object array for each data source in the order in which they are defined in the job's workflow diagram.
Expression sample
The following expression returns all of the version details for the current job's data sources:
JobVersionDetailsArray($Job)[
{
"replicaId":"<replica ID 1>",
"replicaName":"<replica name 1>",
"replicaLocation":"<replica location 1>",
"name":"<version name 1>",
"versionId":"<version ID 1>",
"url":"<URL 1>",
"privateUrl":"<privateURL 1>",
"layerItemId":"<layer item ID 1>"
},
{
"replicaId":"<replica ID 2>",
"replicaName":"<replica name 2>",
"replicaLocation":"<replica location 2>",
"name":"<version name 2>",
"versionId":"<version ID 2>",
"url":"<URL 2>",
"privateUrl":"<privateURL 2>",
"layerItemId":"<layer item ID 2>"
}
]JobVersionGuid
The JobVersionGuid expression returns the GUID of the active version for the job's specified data source.
Parameters
JobVersionGuid(job_id, data_reference_id)
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
data_reference_id | The ID of the data reference configured with the workflow diagram. Note:While data_source_name is still supported, using data_reference_id is recommended for the centralized data references format. | String |
Output
Returns a string value of the GUID of the active version for the job's specified data source.
Expression sample
The following expression returns the GUID of the active version for the current job's Gas_Utility_Network data source:
JobVersionGuid($Job,'aa2870503a8543669470a4a5b0303bc3')4C190A55-DE4B-4C1D-A40F-918FC7C6766AJobVersionGuidArray
The JobVersionGuidArray expression returns all of the active data source version GUIDs for the specified job.
Parameters
JobVersionGuidArray(job_id)
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
Output
Returns an array of string values that contains the active data source version GUIDs for the specified job.
Expression sample
The following expression returns all of the data source version GUIDs for the current job:
JobVersionGuidArray($Job)['4C190A55-DE4B-4C1D-A40F-918FC7C6766A', '4C190A55-DE4B-4C1D-A40F-918FC7C6766A']JobVersion
The JobVersion expression returns the name of the specified data source's active version for the specified job.
Parameters
JobVersion(job_id, data_reference_id)
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
data_reference_id | The ID of the data reference configured with the workflow diagram. Note:While data_source_name is still supported, using data_reference_id is recommended for the centralized data references format. | String |
Output
Returns the name of the specified data source's active version for the specified job.
Expression sample
The following expression returns the current job's active version name for the Gas_Utility_Network data source:
JobVersion($Job, 'aa2870503a8543669470a4a5b0303bc3')jdoe.JOB_123JobVersionArray
The JobVersionArray expression returns the names of all of the specified job's data sources in the order in which they are defined in the workflow diagram.
Parameters
JobVersionArray(job_id)
| Name | Explanation | Data type |
|---|---|---|
job_id | The ID of the job. | String |
Output
Returns an array of string values that contains the names of all of the specified job's data source versions in the order in which they are defined in the workflow diagram.
Expression sample
The following expression returns the names of all of the current job's data source versions:
JobVersionArray($Job)['jdoe.JOB_1', 'jdoe.JOB_1']