Routing

Table 1. Routing Options
Option optionName Parameter	Description
Database DataSetResourceName Option.DataSetResourceName	The name of the database that contains the data to use in the search process. Use a valid routing database resource name defined in the Resources section of the Management Console. For more information, see the Creating a Routing Database Resource The name of the database that contains the data to use in the search process. Use a valid routing database resource name defined in the Resources section of the Management Console. For more information, see the Spectrum Technology Platform Spatial Guide. The name of the database that contains the data to use in the search process. Use a valid routing database resource name defined in the Resources section of the Management Console. For more information, see the Spectrum Technology Platform Spatial Guide.
Optimize by OptimizeBy Option.OptimizeBy	Specifies whether to find the shortest distance or the shortest time. One of the following: Fastest Time Time Optimize by fastest time traveled. Default. Shortest Distance Distance Optimize by shortest distance traveled.
Return fastest/shortest routes only ReturnOptimalRoutesOnly Option.ReturnOptimalRoutesOnly	Specifies whether to return only the optimized route for each start point/end point combination. The optimized route is either the fastest route or the shortest distance, depending on the selection you make for the OptimizeBy option. The optimized route is either the fastest route or the shortest distance, depending on the selection you make for the Option.OptimizeBy parameter. The optimized route is either the fastest route or the shortest distance, depending on the selection you make for the Optimize by option. For example, if you have one start point (S1) and two end points (E1 and E2) and it is faster to go from S1 to E2 than from S1 to E1, and you choose to return only the optimal route, then only the route cost information for S1 to E2 will be returned. Y Yes, return only optimal routes. Default. N No, return all routes not just the optimal routes.
Route cost matrix format RouteCostMatrixFormat Option.RouteCostMatrixFormat	Specifies the data format of the route cost matrix. One of the following: Hierarchy Hierarchy The route cost matrix is returned as list that you can view in Management Console or Enterprise Designer. Choose this option if you want to view the data in these tools or if you want to work with the data in tabular format. Default. Object Object The route cost matrix is returned as a data object that you cannot interact with directly. Only select this option if the output is going directly to another stage in a dataflow or a web service call, or if it will be used by another application to visualize the routes, such as input to mapping software.
Coordinate system CoordinateSystem Option.CoordinateSystem	The coordinate system of the input coordinates. For more information on 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`.
Coordinate format CoordinateFormat Option.CoordinateFormat	Specifies the format of latitude/longitude coordinates in the input. Note: Use this option only if you specify a Latitude/Longitude coordinate system. If the coordinate system is not a Latitude/Longitude coordinate system, set the coordinate format to Decimal. One of the following: Decimal Decimal (90.000000, 180.000000). Default. Decimal Assumed DecimalAssumed (90000000, 180000000). Degrees Minutes Seconds DegMinSec (90 00 00N, 180 00 00W) Pre-Zero PreZero (090000000N, 180000000W) Pre-Zero Decimal PreZeroDecimal (090.000000N, 180.000000W)
Distance units DistanceUnits Option.DistanceUnits	Specifies how Get Travel Cost Matrix should return distance values. One of the following: Feet Feet Return distance in feet. Kilometers Kilometers Return distance in kilometers. Meters Meters Return distance in meters. Miles Miles Return distance in miles. Default. Yards Yards Return distance in yards.
Time units TimeUnits Option.TimeUnits	Specifies how to return time. One of the following: Hours Hours Return time in hours. Minutes Minutes Return time in minutes. Default. Seconds Seconds Return time in seconds. Milliseconds Milliseconds Return time in milliseconds.
Historic traffic time bucket HistoricTrafficTimeBucket Option.historicTrafficTimeBucket	Specifies whether the routing calculation uses the historic traffic speeds. These speeds are based on different time-of-day buckets. The data must have historic traffic speeds included in order to use this feature. The data for each country/region has the same bucket definitions, where the speeds for these bucket values may vary. The options are: None None The default value. Historic traffic data is not used in the calculation. Instead an averaged speed value is used. AMPeak AMPeak Calculate routes with the peak AM speeds. The AMPeak time bucket is from 07:00 to 10:00hr time of day. PMPeak PMPeak Calculate routes with the peak PM speeds. The PMPeak time bucket is from 16:00 to 19:00hr time of day. Off-Peak OffPeak Calculate routes with the off peak (daytime) speeds. The OffPeak time bucket is from 10:00 to 16:00hr time of day. Night Night Calculate routes with the nighttime speeds. The Night time bucket is from 22:00 to 04:00hr time of day.

Database

DataSetResourceName

Option.DataSetResourceName

The name of the database that contains the data to use in the search process. Use a valid routing database resource name defined in the Resources section of the Management Console. For more information, see the Creating a Routing Database Resource

The name of the database that contains the data to use in the search process. Use a valid routing database resource name defined in the Resources section of the Management Console. For more information, see the Spectrum Technology Platform Spatial Guide.

Optimize by

OptimizeBy

Option.OptimizeBy

Specifies whether to find the shortest distance or the shortest time.

One of the following:

Fastest Time
Time: Optimize by fastest time traveled. Default.
Shortest Distance
Distance: Optimize by shortest distance traveled.

Return fastest/shortest routes only

ReturnOptimalRoutesOnly

Option.ReturnOptimalRoutesOnly

Specifies whether to return only the optimized route for each start point/end point combination. The optimized route is either the fastest route or the shortest distance, depending on the selection you make for the OptimizeBy option. The optimized route is either the fastest route or the shortest distance, depending on the selection you make for the Option.OptimizeBy parameter. The optimized route is either the fastest route or the shortest distance, depending on the selection you make for the Optimize by option.

For example, if you have one start point (S1) and two end points (E1 and E2) and it is faster to go from S1 to E2 than from S1 to E1, and you choose to return only the optimal route, then only the route cost information for S1 to E2 will be returned.

Y: Yes, return only optimal routes. Default.
N: No, return all routes not just the optimal routes.

Route cost matrix format

RouteCostMatrixFormat

Option.RouteCostMatrixFormat

Specifies the data format of the route cost matrix. One of the following:

Hierarchy
Hierarchy: The route cost matrix is returned as list that you can view in Management Console or Enterprise Designer. Choose this option if you want to view the data in these tools or if you want to work with the data in tabular format. Default.
Object
Object: The route cost matrix is returned as a data object that you cannot interact with directly. Only select this option if the output is going directly to another stage in a dataflow or a web service call, or if it will be used by another application to visualize the routes, such as input to mapping software.

Coordinate system

CoordinateSystem

Option.CoordinateSystem

The coordinate system of the input coordinates.

For more information on 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.

Coordinate format

CoordinateFormat

Option.CoordinateFormat

Specifies the format of latitude/longitude coordinates in the input.

Note: Use this option only if you specify a Latitude/Longitude coordinate system. If the coordinate system is not a Latitude/Longitude coordinate system, set the coordinate format to Decimal.

One of the following:

Decimal
Decimal: (90.000000, 180.000000). Default.
Decimal Assumed
DecimalAssumed: (90000000, 180000000).
Degrees Minutes Seconds
DegMinSec: (90 00 00N, 180 00 00W)
Pre-Zero
PreZero: (090000000N, 180000000W)
Pre-Zero Decimal
PreZeroDecimal: (090.000000N, 180.000000W)

Distance units

DistanceUnits

Option.DistanceUnits

Specifies how Get Travel Cost Matrix should return distance values. One of the following:

Feet
Feet: Return distance in feet.
Kilometers
Kilometers: Return distance in kilometers.
Meters
Meters: Return distance in meters.
Miles
Miles: Return distance in miles. Default.
Yards
Yards: Return distance in yards.

Time units

TimeUnits

Option.TimeUnits

Specifies how to return time. One of the following:

Hours
Hours: Return time in hours.
Minutes
Minutes: Return time in minutes. Default.
Seconds
Seconds: Return time in seconds.
Milliseconds
Milliseconds: Return time in milliseconds.

Historic traffic time bucket

HistoricTrafficTimeBucket

Option.historicTrafficTimeBucket

Specifies whether the routing calculation uses the historic traffic speeds. These speeds are based on different time-of-day buckets. The data must have historic traffic speeds included in order to use this feature. The data for each country/region has the same bucket definitions, where the speeds for these bucket values may vary. The options are:

None
None: The default value. Historic traffic data is not used in the calculation. Instead an averaged speed value is used.
AMPeak
AMPeak: Calculate routes with the peak AM speeds. The AMPeak time bucket is from 07:00 to 10:00hr time of day.
PMPeak
PMPeak: Calculate routes with the peak PM speeds. The PMPeak time bucket is from 16:00 to 19:00hr time of day.
Off-Peak
OffPeak: Calculate routes with the off peak (daytime) speeds. The OffPeak time bucket is from 10:00 to 16:00hr time of day.
Night
Night: Calculate routes with the nighttime speeds. The Night time bucket is from 22:00 to 04:00hr time of day.