Routing

Table 1. Routing Options
Parameter	Description
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 Spectrum OnDemand Spatial Guide.
OptimizeBy	Specifies whether to find the shortest distance or the shortest time. One of the following: Time Optimize by fastest time traveled. Default. Distance Optimize by shortest distance traveled.
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. 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.
RouteCostMatrixFormat	Specifies the data format of the route cost matrix. One of the following: 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 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.
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`.
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 (90.000000, 180.000000). Default. DecimalAssumed (90000000, 180000000). DegMinSec (90 00 00N, 180 00 00W) PreZero (090000000N, 180000000W) PreZeroDecimal (090.000000N, 180.000000W)
DistanceUnits	Specifies how GetTravelCostMatrix should return distance values. One of the following: Feet Return distance in feet. Kilometers Return distance in kilometers. Meters Return distance in meters. Miles Return distance in miles. Default. Yards Return distance in yards.
TimeUnits	Specifies how to return time. One of the following: Hours Return time in hours. Minutes Return time in minutes. Default. Seconds Return time in seconds. Milliseconds Return time in milliseconds.
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 The default value. Historic traffic data is not used in the calculation. Instead an averaged speed value is used. AMPeak Calculate routes with the peak AM speeds. The AMPeak time bucket is from 07:00 to 10:00hr time of day. PMPeak Calculate routes with the peak PM speeds. The PMPeak time bucket is from 16:00 to 19:00hr time of day. OffPeak Calculate routes with the off peak (daytime) speeds. The OffPeak time bucket is from 10:00 to 16:00hr time of day. Night Calculate routes with the nighttime speeds. The Night time bucket is from 22:00 to 04:00hr time of day.

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 Spectrum OnDemand Spatial Guide.

OptimizeBy

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

One of the following:

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

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.

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.

RouteCostMatrixFormat

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

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: 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.

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.

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: (90.000000, 180.000000). Default.
DecimalAssumed: (90000000, 180000000).
DegMinSec: (90 00 00N, 180 00 00W)
PreZero: (090000000N, 180000000W)
PreZeroDecimal: (090.000000N, 180.000000W)

DistanceUnits

Specifies how GetTravelCostMatrix should return distance values. One of the following:

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

TimeUnits

Specifies how to return time. One of the following:

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

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