Input

The Matrix stage takes start geometry or a set of longitude and latitude for start point and end point respectively. You can specify either the start and end geometry or longitude and latitude. The following table lists all the input parameters and their descriptions:


Section	Field Name	Description
Start Geometry		Either specify Start Geometry, the Start Point as the name of an existing geometry field or create a point from a pair of X/Y field names. The Geometry and X/Y fields are mutually exclusive (you need to choose one or the other).
	Geometry	Select the geometry field name to be used as Start Geometry. By default, startGeometry name is selected in the Point/Multipoint Geometry drop-down. If the Geometry radio button is selected, the startGeometry field name automatically becomes available as the input from the previous stage and you can provide the appropriate value. The startGeometry contains point as well as multipoint geometry: Point Geometry: It signifies a geometry consisting of a single start point from the input. Multipoint Geometry: It signifies a geometry consisting of multiple start points from the input. For example, if the user takes one start point, then the geometry is defined as a point geometry and if the user takes multiple start points, then the geometry is defined as a multipoint geometry.
Start Point	Longitude/Latitude (X/Y)	Select the Longitude (X) and Latitude (Y) fields to be used to construct the start point. The drop-down contain names of all the fields of type string and double. It can take single start point as well as a list of start points. The list can be either a list of string or list of double. The user can also add new fields of double or string type using the input stage using the Enterprise Designer. The added fields immediately reflect in the Longitude or Latitude drop-down. By default the name startx is configured for the Longitude (X) field and the name starty for the Latitude (Y) field. If the Longitude/Latitude (X/Y) radio button is selected, then the startx and starty field names automatically become available as the input from the previous stage and you can provide the appropriate value. The type of startx and starty field names are of type string. By default, the coordinate system for start point is set to WGS84. If required, change the coordinate system to match the input X and Y fields. You can also provide the coordinate system from the previous input stage with name startcoordsys (case in-sensitive) of type string, which if provided, overrides the value present in the input tab. For more information about EPSG codes, see www.spatialreference.org. To retrieve a list of supported codespaces for EPSG, you can submit the SOAP request List Supported CoordSys by Code Space from the Geometry Service Demo page at http://<server>:<port>/Spatial/GeometryService/DemoPage.html.
End Geometry		Either specify the end point as the name of an existing geometry field or create a point from a pair of X/Y field names. The Geometry and X/Y fields are mutually exclusive (you need to choose one or the other).
	Geometry	Select the geometry field name to be used as End Geometry. By default, endGeometry name is selected in the Point/Multipoint Geometry drop-down. If the Geometry radio button is selected, the endGeometry field name will automatically be available as the input from previous stage and you can provide the value for this to be used. The endGeometry contains point as well as multipoint geometry: Point Geometry: It signifies a geometry consisting of a single end point from the input. Multipoint Geometry: It signifies a geometry consisting of multiple end points from the input. For example, if the user takes one end point, then the geometry is defined as a point geometry and if the user takes multiple end points, then the geometry is defined as a multipoint geometry
End Point	Longitude/Latitude (X/Y)	Select the Longitude (X) and Latitude (Y) fields to be used to construct the end point. The drop-down contain names of all the fields of type string and double. It can take single end point as well as a list of end points. The list can be either a list of string or list of double. The user can also add new fields of double or string type using the input stage in Enterprise Designer. The added fields get reflected immediately in the Longitude or Latitude drop-down. By default, the name endx is configured for the Longitude (X) field and endy for the Latitude (Y) field. If the Longitude/Latitude (X/Y) radio button is selected, the endx and endy field names will automatically be available as an input from the previous stage. You can also provide the coordinate system from the previous input stage with the name endcoordsys (case in-sensitive) of type string, which if provided, will override the value present in the Input tab. By default, the coordinate system for start point is set to WGS84. If required, change the coordinate system to match the input X and Y fields. You can also provide the coordinate system from previous input stage with name endcoordsys (case in-sensitive) of type string, which if provided, will override the value present in the Input tab. For more information about EPSG codes, see www.spatialreference.org. To retrieve a list of supported codespaces for EPSG, you can submit the SOAP request List Supported CoordSys by Code Space from the Geometry Service Demo page at http://<server>:<port>/Spatial/GeometryService/DemoPage.html.

Input from the Previous Stage

The following fields can be used as input from the previous stage. If a value is provided for any of them, it will override the corresponding value configured in the stage. You can view these fields by clicking the channel between the stages to open the Field Transform Options dialog box.


Field name	Type	Description
startGeometry	Geometry	Specifies the geometry for the start point. It is available only if the Geometry radio button for the start point is selected.
endGeometry	Geometry	Specifies the geometry for the end point. It is available only if the Geometry radio button for the end point is selected.
startx/starty	String	Specifies the values of X and Y for the start point. These are available only if the Longitude/Latitude (X/Y) for the start point is selected.
endx/endy	String	Specifies the values of X and Y for the end point. These are available only if the Longitude/Latitude (X/Y) for the end point is selected.
DataSetResourceName	String	Specifies the name of the routing database for calculation. If a value is specified, it overrides the value selected from Database in the Settings tab.
OptimizeBy	String	Specifies whether to return the shortest or the fastest route. Available values are time and distance (case in-sensitive). If a value is specified, it overrides the value selected using Optimize By radio button in the Settings tab.
HistoricTrafficTimeBucket	String	Specifies the time bucket of the day to apply historic traffic speed value. Available values are none, ampeak, pmpeak, offpeak and night (case in-sensitive). If a value is specified, it overrides the value selected from the Historic traffictime bucket drop-down in the Settings tab.
MajorRoads	Boolean	Specifies whether to calculate the route using major roads only. If a value is specified, it overrides the value of the Use major roads for calculation in the Settings tab.
UseVehicleRestrictions	Boolean	Specifies whether to consider Commercial Vehicle Restrictions (CVR) while route calculation. This is applicable if data has CVR information in it. If a value is specified, it overrides the value of the Use vehicle restriction in the Logistics tab.
LooseningBarrierRestrictions	Boolean	Specifies whether to ignore barrier restrictions while route calculation. Its value is considered only if UseVehicleRestrictions is set to true and data has CVR information in it. If a value is specified, it overrides the value of the Loosening barrier restrictions in the Logistics tab.
VehicleType	String	Specifies the type of the vehicle. Available values are(case in-sensitive): All Intermediate double Long double Other long combination vehicle Semi trailer Standard double Straight Triple Its value is considered only if UseVehicleRestrictions is set to true and data has CVR information in it. If a value is specified, it overrides the value selected from the Type of vehicle in the Logistics tab.
VehicleHeight	Double	Specifies the height of the vehicle. Its value is considered only if UseVehicleRestrictions is set to true and data has CVR information in it. If a value is specified, it overrides the value provided in the Height stepper in the Logistics tab.
VehicleLength	Double	Specifies the length of the vehicle. Its value is considered only if UseVehicleRestrictions is set to true and data has CVR information in it. If a value is specified, it overrides the value provided in the Length stepper in the Logistics tab.
VehicleWidth	Double	Specifies the width of the vehicle. Its value is considered only if UseVehicleRestrictions is set to true and data has CVR information in it. If a value is specified, it overrides the value provided in the Width stepper in the Logistics tab.
VehicleLinearUnit	String	Specifies the unit for VehicleHeight, VehicleLength, and VehicleWidth. Available values are (case in-sensitive): Feet Meters Yards Its value is considered only if UseVehicleRestrictions is set to true and data has CVR information in it. If a value is specified, it overrides the value selected from Linear unit in the Logistics tab.
VehicleWeight	Double	Specifies the weight of the vehicle. Its value is considered only if UseVehicleRestrictions is set to true and data has CVR information in it. If a value is specified, it overrides the value provided in the Weight stepper in the Logistics tab.
VehicleWeightUnit	String	Specifies the unit to be used against VehicleWeight. Available values are (case in-sensitive): Kilogram Metric Tonnes Pound. Ton Its value is considered only if UseVehicleRestrictions is set to true and data has CVR information in it. If a value is specified, it overrides the value selected from the Weight unit drop-down in the Logistics tab.
DistanceUnit	String	Specifies the unit of the distance returned in the response. Available values are (case in-sensitive): Feet Kilometers Meters Miles Yards If a value is specified, it overrides the value selected from the Distance unit drop-down in the Output tab.
TimeUnit	String	Specifies the unit of the time returned in the response. Available values are (case in-sensitive): Hours Minutes Seconds Milliseconds If a value is specified, it overrides the value selected from the Time unit drop-down in the Output tab.
AvoidTollRoads	Boolean	Specifies whether to calculate a route with or without a toll road. If you set the value of AvoidTollRoads to True, the response contains a route without any toll roads. If the value of AvoidTollRoads is set to False, the route includes toll roads. The default is False.
ReturnOptimalRoutes	Boolean	Specifies whether to return only the optimized route for each start point or end point combinations. The optimized route is either the fastest route or the shortest distance, depending on the optimizeBy parameter. The default is True.