Available in real-time and big data analytics.
The Add XYZ Values tool is used to obtain the x, y, and z coordinates from point feature geometry. The coordinate values are appended as unique fields in the tool output schema.
Examples
The following are example use cases for the Add XYZ Values tool:
- Applications may require feature location to be expressed as separate coordinates instead of feature JSON, GeoJSON, or generic JSON's geometry representation.
- The Add XYZ Values tool can be used to extract the coordinates from feature JSON (for example, the point geometry of a feature from a feature service).
Usage notes
Keep the following in mind when working with the Add XYZ Values tool:
- The Add XYZ Values tool only supports extracting coordinate values from point geometry expressed as feature JSON. Therefore, the tool is best paired with HTTP Poller, HTTP Receiver, or ArcGIS Feature Service feed types.
- Although the default name value for the X Coordinate Field Name, Y Coordinate Field Name, and Z Coordinate Field Name fields are respectively x, y, and z, these values can be changed. For example, the X Coordinate Field Name parameter can be specified as longitude, the Y Coordinate Field Name parameter as latitude, and the Z Coordinate Field Name parameter as elevation.
Parameters
The parameters for the Add XYZ Values tool are described below:
Parameter | Description |
---|---|
X Coordinate Field Name | The name of the field used to store the x coordinate value. The field is added to the tool output schema as a unique field. The default is x. |
Y Coordinate Field Name | The name of the field used to store the y coordinate value. The field is added to the tool output schema as a unique field. The default is y. |
Z Coordinate Field Name | The name of the field used to store the z coordinate value. The field is added to the tool output schema as a unique field. The default is z. Note:If the point geometry does not have a Z Coordinate Field Name value, it defaults to null and the z field name is not configurable. |
Consideration and limitation
Consider the following when working with the Add XYZ Values tool:
The Add XYZ Values tool only extracts the coordinate values from points. This tool does not support other geometry types, such as multipoint, envelope, polyline, or polygon.
Output layer
The tool appends coordinate values as unique fields to the output schema.