The Add XYZ Values Processor is used to obtain the X, Y, and Z coordinates from GeoEvents with a point geometry. The coordinate values are appended as unique fields within a new GeoEvent Definition.
The following are example uses of the Add XYZ Values Processor:
- Applications may require an event record’s location to be expressed as separate coordinates instead of feature JSON, GeoJSON, or generic JSON’s geometry representation.
- This processor can be used to extract the coordinates from feature JSON (for example, the point geometry of a feature from a feature service).
- The X, Y, and Z values extracted by this processor can be used as input origin or destination for the Bearing Calculator Processor.
Keep the following in mind when working with the Add XYZ Values Processor:
- The processor only supports extracting coordinate values from point geometry expressed as feature JSON. Therefore, the processor is best paired with event data imported from the Poll an ArcGIS Server for Features or Receive Features on a REST Endpoint input connectors.
- Event records sent to the processor must have a GeoEvent Definition containing a point geometry. The geometry value is used to derive the X, Y, and Z coordinate values for each event record.
- Although the default name value for the X, Y, and Z fields are respectively x, y, and z, these values can be changed. For example, the X-Field parameter can be specified as longitude, the Y-Field parameter as latitude, and the Z-Field parameter as altitude or height.
- The X-Field, Y-Field, and Z-Field parameters are all required. Pair this processor with either a Field Mapper Processor or Field Reducer Processor to modify the schema of the output GeoEvent Definition created by the processor.
The following are the parameters for the Add XYZ Values Processor:
A descriptive name for the processor used for reference in GeoEvent Manager.
Specifies the processor selected.
The name of the geometry field or the GEOMETRY tagged field of the event record that the processor will use to extract the X, Y, and Z coordinate values from. The specified geometry field must be a point geometry.
Output GeoEvent Definition
Specifies the name of the GeoEvent Definition created by the processor. The created GeoEvent Definition will have the X, Y, and Z coordinate fields appended as a part of the new schema.
The name of the field to store the X coordinate value. The field will be added to the new GeoEvent Definition created by the processor. The default is x.
The name of the field to store the Y coordinate value. The field will be added to the new GeoEvent Definition created by the processor. The default is y.
The name of the field to store the Z coordinate value. The field will be added to the new GeoEvent Definition created by the processor. The default is z.
If the point geometry does not have a Z coordinate value, the default of 0.0 will be added to the field.
Considerations and limitations
There are several considerations to keep in mind when using the Add XYZ Values Processor:
- The processor uses the geometry field or tag on the incoming GeoEvent Definition to identify the point geometry and obtain the X, Y, and Z coordinate values. If the geometry field or tag does not exist, you will need to create the geometry field or apply the GEOMETRY tag to an existing field prior to configuring this processor. If the incoming geometry field name is geometry, or if the GEOMETRY tag is already used, this limitation does not apply.
- The processor will create a new GeoEvent Definition since new fields are being added. Altering an event record’s schema by adding a new field always requires GeoEvent Server to create a new GeoEvent Definition.
- The processor does not obtain the array of coordinate values for other geometry types such as multipoint, envelope, polyline, and polygon. Only extracting the coordinate values of a point geometry is supported.