Extended property functions

The following sections contain ArcGIS Arcade expressions that allow you to retrieve custom business-specific information from extended properties tables. For example, you can use an Arcade expression to populate an email with a work order or purchase order information that's associated with a job.

Note:

If you need to access job properties managed by ArcGIS Workflow Manager, you can access them using job property expressions.

JobExtendedProperty

The JobExtendedProperty expression returns the value of the specified extended property field for the specified job. The extended properties table must be associated with the job template from which the job was created. This expression can only be used with one-to-one properties tables.

Note:

If you need to access one-to-many properties, use the JobRelatedProperty expression.

Tip:

You can choose the table_name and field_name values associated with a one-to-one properties table from the This input supports Arcade Expressions This input supports Arcade expressions menu.

Parameters

JobExtendedProperty(job_id, table_name, field_name, {return_domain_description})

NameExplanationData type

job_id

The ID of the job that contains the extended properties table values you want to access.

String

table_name

The name of the extended properties table.

String

field_name

The name of the field in the extended properties table.

String

return_domain_description

(Optional)

For a domain extended property field, the value's description is returned if the parameter is set to True. If the parameter is unspecified or set to False, the value's code is returned.

Boolean

Output

Returns a string value for the extended properties table field for the specified job. Fields in extended properties tables can contain string, integer, double, boolean, datetime, and domain (string, integer, and double) data types.

Expression sample

The following expression returns the date that a purchase was submitted for the current job in epoch format:

JobExtendedProperty($Job, 'purchase_order', 'date')
Example output
1589414631

JobRelatedProperty

The JobRelatedProperty expression returns the value of the specified extended property field and row for the specified job. The extended properties table must be associated with the job template from which the job was created. This expression can only be used with one-to-many properties tables.

Note:

If you need to access one-to-one properties tables, use the JobExtendedProperties expression.

Tip:

You can choose the table_name and field_name values associated with a one-to-many properties table from the This input supports Arcade Expressions This input supports Arcade expressions menu.

Parameters

JobRelatedProperty(job_id, table_name, field_name, {row_id}, {return_domain_description})

NameExplanationData type

job_id

The ID of the job that contains the extended properties table values you want to access.

String

table_name

The name of the extended properties table.

String

field_name

The name of the field in the extended properties table.

String

row_id

(Optional)

The ID of the row to be returned. The most recent record is returned by default. To retrieve extended properties, use the workflow_guid associated with the related properties table.

To retrieve feature service extended properties or an ArcGIS Survey123 property, use the Link Id for the row_id parameter.

String

return_domain_description

(Optional)

For a domain extended property field, the value's description is returned if the parameter is set to True. If the parameter is unspecified or set to False, the value's code is returned.

Note:

If you need to retrieve the return_domain_description without specifying the row_id, use empty quotation marks for the row_id parameter—for example, JobRelatedProperty($job, 'extProp', '', true).

Boolean

Output

Returns a string value for the extended properties table field and row for the specified job. Fields in extended properties tables can contain string, integer, double, Boolean, datetime, and domain (string, integer, and double) data types.

Expression sample

The following expression returns the current job's most recent population record for the city of Redlands:

JobRelatedProperty($Job, 'Redlands', 'Population')
Example output
71198

Related topics