Settings

Introduction

You can limit the number of returned records and search distance, as well as include distance to edge, count, and index fields to the output. The search selection that you make on the Input tab changes the options that display on the Settings and Output tabs. You can search by using a straight line distance or a route network distance

Straight Line Distance

The following setting are applicable when you select Straight Line in the Search by section on the Input tab.

Field Description
Limits These settings limit the maximum number of records that may be returned for any search geometry. To ensure the best performance for your flow and the system, it is highly recommended that at least one of these limits is set.
Limit the number of returned records

By default this option is selected with a default value of 1. If it is not selected, all nearest points of interest that are within the specified distance are returned. This might affect performance.

A value specified in the MaxCandidates input field will override this setting.

Limit the search distance

By default this option is selected with a value of 1 mile. Valid values are > or = 0, however a search distance of 0 will return only results that intersect the input geometry.

Values specified in the MaxDistance and MaxDistanceUnit input fields will override this setting.

Distance unit

Available units are:

  • Centimeters
  • Feet
  • Inches
  • Kilometers
  • Meters
  • Miles (Default)
  • Yards
Distance The distance field contains the shortest distance from an input geometry to the geometry of the returned record. The distance to edge field contains the distance between the two closest edges of the input geometry and the geometry of the returned record (for an input point, this is the distance between the point and the edge of a polygon).
Include distance

This option (which is selected by default) is useful when you want to know the shortest distance from an input geometry to the returned record.

Distance field Specifies the shortest distance from an input geometry to the returned record. When the returned record contains or intersects the input, the distance returned will be zero.
Distance unit field Specifies the name of the output field that will hold the distance unit.
Distance unit Specifies the unit of measure of the returned distance. Available units are:
  • Centimeters
  • Feet
  • Inches
  • Kilometers
  • Meters
  • Miles (Default)
  • Yards
Include distance to edge

This option is useful when you need to know how close a point is to the edge of a geometry. It is not selected by default.

Distance to edge field Specifies the name of the output field that will hold the distance to edge. Always contains the shortest distance to the edge; that is, the distance between the two closest points of the input geometry and the geometry of the returned record. The unit of the returned distance will be same as that selected in the Distance unit drop-down list above.

Geometries with intersecting edges will return zero. If one geometry fully contains the other, the field will return a distance value.

Count The count field contains the total number of records returned for each input. The index field contains the current record's order in the total count.
Include count and index

This option is useful when you have many records being returned and need to identify different records from each other.

Count field Specifies the name of the output field that contains the total number of records returned for each input.
Index field

Specifies the current record’s order in the collection of output records.

For example, "1 of 5" has a count of 5 and an index of 1.

Closest point These settings select the closest point of the input geometry and to the input geometry.
Return nearest point of input geometry Specifies the nearest point for the input geometry. It returns the closest input point. In case of the point (when you select longitude and latitude in the input), the nearest point is the point itself that you provided as an input. In case if you picked up a polygon (when you select a geometry in the input), the nearest point is the edge of the polygon in which the input point lies.
Return nearest point to input geometry Specifies the nearest Point of Interest (Point of Interest). In case if you have provided point as an input, the nearest POI will be a point. In case if the input is a polygon, the nearest POI will be on the edge of the polygon.

Route Network Distance

The following setting are applicable when you select Route Network Distance in the Search by section in the Input tab.

Field Description
Database The name of the database that contains the routing data to use to determine the shortest or fastest route. Use the database name specified in the Management Console's Database Resources tool. For more information, see Creating a Routing Database Resource.
Limits These settings allow you to select whether you wish to find the nearest points of interests for a specific distance or a time frame from the input point.
Limit number of returned records Specifies the number of points of interests you wish to calculate in the output.
Limit travel distance Specifies the distance for which you wish to find the nearest points of interest.
Distance unit Specifies the unit of measure of the returned distance. Available units are:
  • Centimeters
  • Feet
  • Inches
  • Kilometers
  • Meters
  • Miles (Default)
  • Yards
Limit travel time

Specifies the time length for which you wish to find the nearest points of interest. For example, you may want to calculate the point of interest that fall in a time length of five minutes.

Time unit Specifies the unit of measure of the returned time. Available units are:
  • Hours
  • Milliseconds
  • Minutes (Default)
  • Seconds
Optimized by These settings define how to optimize the route. The default is by distance.
Distance Select to optimize the route by distance.
Time Select to optimize the route by time.
Historic traffic time bucket

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 to use this feature. The data for each country and region has the same bucket definitions, where the speeds for these bucket values may vary. The options are:

  • None: Historic traffic data is not used in the calculation. Instead an averaged speed value is used. This is the default value.
  • AMPeak: Calculate routes with the peak AM speeds. The AMPeak time bucket is from 07:00 to 10:00 hours.
  • PMPeak: Calculate routes with the peak PM speeds. The PMPeak time bucket is from 16:00 to 19:00 hours.
  • Off-Peak: Calculate routes with the off peak (daytime) speeds. The OffPeak time bucket is from 10:00 to 16:00 hours.
  • Night: Calculate routes with the nighttime speeds. The Night time bucket is from 22:00 to 04:00 hours. This field is available on input from previous stage.
Output These settings define how to display the output of the nearest point of interest.
Distance field Specifies the shortest distance from an input geometry to the returned record. When the returned record contains or intersects the input, the distance returned will be zero. This option is useful when you want to know the shortest distance from an input geometry to the returned record.
Distance unit field Specifies the name of the output field that will hold the distance unit.
Distance unit Specifies the unit of measure of the returned distance. Available units are:
  • Centimeters
  • Feet
  • Inches
  • Kilometers
  • Meters
  • Miles (Default)
  • Yards
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 selected. This option is useful when you want to know the shortest distance from an input geometry to the returned record in a stipulated time frame.
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 selected.
Time unit Specifies the value that is set against the Time unit field. It has the following values:
  • Hours
  • Minutes (Default)
  • Seconds
  • Milliseconds
Count field This option allows you to setup a field to display the count of the total records returned by the stage.
Index field This option signifies the sequence index of each of the records based on the time elapsed in fetching the records.
Preferences These settings include various routing capabilities for the calculations.
Only use major roads Specifies whether to include all roads in the calculation or just major roads. If you choose to include only major roads, performance will improve, but accuracy may decrease. This field is available on input from the previous stage. It represents a Boolean value where the default value is True.
Max off road distance Specifies the maximum distance to allow travel off the road network. Examples of off-network roads include driveways and access roads. For example, if you specify a maximum off-road distance of 1 mile (default value and unit), the travel boundary will extend no further than one mile from the network road. Use the ambient speed options to specify the speed of travel along non-network roads. The default value is 0.5.
Distance unit Specifies the unit of measure of the returned distance. Available units are:
  • Centimeters
  • Feet
  • Inches
  • Kilometers
  • Meters
  • Miles (Default)
  • Yards
Default ambient speed

Specifies the ambient speed to use for off-network travel based on the road type. If you do not specify an ambient speed for a road type, the default ambient speed will be used, as specified in the

DefaultAmbientSpeed

text box. This option is applicable only when you specify a time value in the

TravelCostUnits

option. This field is available on input as

DefaultAmbientSpeed

from the previous stage. The default value is 15

Speed unit Available units are:
  • Kilometers per hour
  • Meters of minute
  • Meters per second
  • Miles per hour (Default)
Simplification factor

Specifies the percentage of the original points to be returned or upon which the resulting complexity of geometries should be based. This field is available on input asSimplificationFactor from the previous stage. A number between 0.0 and 1.0 is accepted, exclusive of 0.0 but inclusive of 1.0. Complexity increases as the value increases, therefore 1.0 means the most complex. The default value for this property 0.5.

Propagation factor

Specifies the percentage of the cost used to calculate the distance between the starting point and the isodistance for all road types (isodistance is the calculation of specific distance intervals from one point extending out along every possible route). Propagation factor controls how off-network travel is used in the travel boundary calculation. Propagation factor can affect the size and shape of the travel boundary polygon. In general, more the propagation factor value, the larger the polygon.

This field is available on input as PropagationFactor from the previous stage in which the user can override the Settings value from the input. If this property is not specified, then the calculation uses the server setting. Valid values are between 0.0 and 1.0, both inclusive. The default value for this property is 0.16.