Input

Route takes route points, which include starting and ending latitudes and longitudes as input. The table below provides information about the format and layout of the input. This tab has the input fields required for the stage.


Section	Field Name	Description
*Start Point*		Either specify 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 Point. By default, startGeometry name is configured. If the Geometry radio button is selected, the startGeometry field name will automatically be available as the input from previous stage and you can provide the value for this to be used.
	Longitude/Latitude (X/Y)	Select the Longitude (X) and Latitude (Y) fields to be used to construct the Start Point. The drop-down lists contain the names of all the fields of type string and numeric. 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, the startx and starty field names will automatically be available as the input from previous stage and you can provide the value for this to be used. The type of startx and starty field names will be 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 previous input stage with name startcoordsys (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.
*End Point*		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 Point. By default, the name endGeometry is configured. If the Geometry radio button is selected, endGeometry field name will automatically be available as the input from previous stage and you can provide the value for this to be used.
	Longitude/Latitude (X/Y)	Select the Longitude (X) and Latitude (Y) fields to be used to construct the End Point. The drop-down lists contain names of all the fields of type string and numeric. 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.
Intermediate Points		In this MultiPoint Geometry, the user can give multiple points, which can be used as Intermediate Points between a start point and an end point.
	MultiPoint Geometry	Select the Multipoint geometry field name to be used as Intermediate Points. By default, the name intermediatePointsGeometry is configured. If the MutiPoint Geometry checkbox is selected, intermediatePointsGeometry field name will be exposed automatically in the input from previous stage and you can provide the value for this to be used.

Input from Previous Stage

The fields below will be available to be provided as the input from previous stage. If a value is provided for any of them, it will override the corresponding value configured in the stage.

These fields can be viewed by clicking the channel between the stages to open the Field Transform Options dialog box.


Field name	Type	Description
startGeometry	Geometry	The geometry for Start Point. It will be available only if the Geometry radio button for Start Point is selected.
endGeometry	Geometry	The geometry for End Point. It will be available only if the Geometry radio button for End Point is selected.
intermediatePointsGeometry	Geometry	The geometry field for Intermediate points. It will be available only if the IntermediatePoint Geometry check box is selected.
startx/starty	String	Values of X and Y for Start Point. These will be available only if the Longitude/Latitude (X/Y) radio button for Start Point is selected.
endx/endy	String	Values of X and Y for End Point. These will be available only if the Longitude/Latitude (X/Y) radio button for End Point is selected.
DataSetResourceName	String	Name of the Routing Database to be used for calculation. If a value is specified, it will override the value selected from Database drop-down in the Settings tab.
OptimizeBy	String	Name of the parameter that specifies whether to return shortest or fastest route. Accepted values are time and distance (case in-sensitive). If a value is specified, it will override the value selected using Optimize By radio button in the Settings tab.
HistoricTrafficTimeBucket	String	Name of the parameter that specifies the time bucket of the day to apply historic traffic speed value. Accepted values are none, ampeak, pmpeak, offpeak and night (case in-sensitive). If a value is specified, it will override the value selected from the Historic traffictime bucket drop-down in the Settings tab.
MajorRoads	Boolean	Name of the parameter that specifies whether to calculate the route using major roads only. It can be either true or false. If a value is specified, it will override the value of the Use major roads for calculation check box in the Settings tab.
UseVehicleRestrictions	Boolean	Name of the parameter that specifies whether to consider commercial vehicle restrictions (CVR) while route calculation. It can be either true or false. This will be applicable if data has CVR information in it. If a value is specified, it will override the value of the Use vehicle restriction check box in the Logistics tab.
LooseningBarrierRestrictions	Boolean	Name of the parameter that specifies whether to ignore barrier restrictions while route calculation. It can be either true or false. Its value will be considered if and only if UseVehicleRestrictions is set to true and data has CVR information in it. If a value is specified, it will override the value of the Loosening barrier restrictions check box in the Logistics tab.
VehicleType	String	Name of the parameter that specifies the type of the vehicle. Accepted values are(case in-sensitive): All Intermediate double Long double Other long combination vehicle Semi trailer Standard double Straight Triple Its value will be considered if and only if UseVehicleRestrictions is set to true and data has CVR information in it. If a value is specified, it will override the value selected from the Type of vehicle drop down in the Logistics tab.
VehicleHeight	Double	Name of the parameter that specifies the height of the vehicle. Its value will be considered if and only if UseVehicleRestrictions is set to true and data has CVR information in it. If a value is specified, it will override the value provided in the Height stepper in the Logistics tab.
VehicleLength	Double	Name of the parameter that specifies the length of the vehicle. Its value will be considered if and only if UseVehicleRestrictions is set to true and data has CVR information in it. If a value is specified, it will override the value provided in the Length stepper in the Logistics tab.
VehicleWidth	Double	Name of the parameter that specifies the width of the vehicle. Its value will be considered if and only if UseVehicleRestrictions is set to true and data has CVR information in it. If a value is specified, it will override the value provided in the Width stepper in the Logistics tab.
VehicleLinearUnit	String	Name of the parameter that specifies the unit to be used against VehicleHeight, VehicleLength and VehicleWidth. Accepted values are (case in-sensitive): Feet. Meters Yards Its value will be considered if and only if UseVehicleRestrictions is set to true and data has CVR information in it. If a value is specified, it will override the value selected from the Linear unit drop down in the Logistics tab.
VehicleWeight	Double	Name of the parameter that specifies the weight of the vehicle. Its value will be considered if and only if UseVehicleRestrictions is set to true and data has CVR information in it. If a value is specified, it will override the value provided in the Weight stepper in the Logistics tab.
VehicleWeightUnit	String	Name of the parameter that specifies the unit to be used against VehicleWeight. Accepted values are (case in-sensitive): Kilogram Metric Tonnes Pound. Ton Its value will be considered if and only if UseVehicleRestrictions is set to true and data has CVR information in it. If a value is specified, it will override the value selected from the Weight unit drop-down in the Logistics tab.
DistanceUnit	String	Name of the parameter that specifies the unit of the distance returned in the response. Accepted values are (case in-sensitive): Feet Kilometers Meters Miles Yards If a value is specified, it will override the value selected from the Distance unit drop-down in the Output tab.
TimeUnit	String	Name of the parameter that specifies the unit of the time returned in the response. Accepted values are (case in-sensitive): Hours Minutes Seconds Milliseconds If a value is specified, it will override the value selected from the Time unit drop-down in the Output tab.
AvoidTollRoads	Boolean	This feature specifies whether you want a route with or without a toll road. This is a Boolean type parameter. The default value is False. 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.
OptimizeIntermediatePoints	Boolean	This feature specifies whether you want an optimized route or not for the points taken. This is a Boolean type parameter. The default value is False. If you set the value of OptimizeIntermediatePoints to True, the response contains an optimized route. If the value of OptimizeIntermediatePoints is set to False, the route includes a route, which is not optimized.