Output

The Output tab contains the fields included in the output of the stage. These fields are further consumed by the next stage.

Note: The geometry field must be selected to perform any Spatial operations on records in subsequent stages.

Field name Description
Distance field

Specifies the name of the output field that holds the distance value calculated from given start to end. It is available in the output only if the check box against it is selected.
Distance unit field

Specifies the name of the output field that holds the distance unit against the calculated distance from given start to end. It is available in the output only if the check box against the Distance field is checked.
Distance unit

Specifies the unit to be used for displaying the calculated distance. It has the following values:

  • Feet
  • Kilometers
  • Meters. Default.
  • Miles
  • Yards

It will be available in the output only if the check box against the Distance field is selected.
Time field

Specifies the name of the output field that holds the time value calculated from given start to end. It is available in the output only if the check box against it is checked.
Time unit field

Specifies the name of the output field that holds the time unit against the calculated time from given start to end. It is available in the output only if the check box against the Time field is checked.
Time unit

Specifies the value that is set against the Time unit field. It has the following values:

  • Hours
  • Minutes. Default.
  • Seconds
  • Milliseconds
Return geometry
Specifies the return geometry. It returns the following fields:
  1. StartGeometry: It signifies the start point.
  2. EndGeometry: It signifies the end point
For example, if there are two start and two end point values, then the stage creates a matrix of 2 x 2 resulting in four matrices. Each of these matrices contain start geometry of each start point and end geometry of each end point.
Return index Specifies the return index. It returns the following fields:
  1. StartIndex: It signifies the index value of each start point.
  2. EndIndex: It signifies the index value of each end point.
For example, if there are two start and end points, then the stage creates a matrix of 2 x 2 which results in four matrices. Each of these matrices contain index values of each start and end point.

Warnings

The Matrix request excludes problematic points from the calculation to process the request. Any problematic points are, therefore, excluded from the response.

A response, which contains time and distance between points, also includes a warnings section with information about problematic points in the request that were excluded from the calculation. Warnings list the problematic points. Each object in the list contains the error code for that point and an error description.

The warning message is available in REST version 2, SOAP services introduced in version 2020.1 and later, SDK(GRS), and stages introduced in version 2020.1 and later.

To see an example response with a warning, go to Matrix Partial Response and Warnings.