External Distance/Service Engine and Map Parameters

AVOIDS_AND_FAVORS_SETIDS

It is used for custom routing preferences, such as avoiding or favoring certain roads, or overriding road restrictions. To apply avoids and favors, use numeric value of '-1' to apply all of the avoids and favors associated with the API key. To apply specific SET IDs, add set IDs as comma-separated values.

X

BACKUP_WITH_LAT_LONG
If a specific source/destination address type lookup fails, setting this parameter will retry the lookup using latitude and longitude for both source and destination location. Possible values are “Y” or “N”.

X

X

X

X

BOAT_FERRIES

For HERE Valid values are:

0 - Normal

-1 - Avoid

-2 - Soft Exclude

-3 - Strict Exclude

For HERE - Routing possible values are:

 - Y (Avoid) 

- N (Allow)(Default)

X

X

BORDERS_OPEN

This parameter enables you to control border crossing. When you set the default value to 1, PC*MILER Streets creates the best route for shipments which can cross the border many times.

When set to 0, PC*MILER Streets creates the best route for shipments within the country. Similarly, for PC*MILER Web Services the valid values are Y and N.

Default value for PC*MILER Streets is 1.

Default value for PC*MILER Web Services is Y.

X

X

CLASS OVERRIDES

This parameter specifies the classOverrides attribute to be sent in the request for PC*Miler Web Services.

Valid values are:

0 - None

1 - Fifty Three Feet

2 - National Network

3 - Fifty Three Feet and National Network

X

DATA_VERSION

Allows you to access distance or time of a specific version of PC*MILER Web Services.

Following are valid values:

• To access specific version number: Integer version numbers (no decimals) 18 and above.
• To access latest version: current.   
• To access previous quarter data: lastquarter.  
• To access baseline release data for current version (rather than current or last quarter update): baseline.     

Note: You can access specific data version of PC*MILER Web Services only with the PC*MILER Web Services premium license key.  

X

DEST_ADDRESS_TYPE
Defines the type of address associated with the destination. The following table shows valid address type values for DEST_ADDRESS_TYPE parameters.

X

X

X

X

X

X

X

DIRT_ROAD

For HERE Valid values are:

0 - Normal

-1 - Avoid

-2 - Soft Exclude

-3 - Strict Exclude

For HERE - Routing possible values are:

 - Y (Avoid) 

- N (Allow)(Default)

X

X

DISTANCE_UNIT

Optional. Values are mile or km (default).

X

ELEVATION_LIMIT Indicates the elevation limit when generating a route. Elevation unit can be either meters or feet and is determined by the Distance Units parameter. Miles = feet, Kilometers = meters. Limit will be ignored if either a routing is deemed impractical with the limit, or a stop is located at an elevation higher than the limit. The default is null.

X

EQUIPMENT_RESTRICTIONS

This is used to ensure proper street level routing. OTM needs to send equipment dimensions (length, width and height) for the EDE to use. Correct dimensions are needed for street level routing, tunnel restrictions on the dimension of the equipment, overhead height, bridge weight restrictions and so on. Equipment dimensions include the length, width and height of the total equipment. For this, set this to Y (on).

See About Sending Equipment Dimensions to External Distance Engines and Calculation of Loaded Equipment Dimensions for External Distance Engines.

Restrictions will not be used if the parameter is set to N (the default).

X

X

X

FERRY_DISCOURAGE Indicates whether to discourage the use of ferries when creating the route. Default: false

X

FIXED_LIMITED_WEIGHT

If this is set, OTM will use the weight defined for this parameter rather than calculate the running weight.

For HERE, values entered must be in metric tons. For example, if the shipment limit is 8 metric tons then the parameter must be set to 8.

For HERE - Routing, values entered must be in Kg. For example, if the shipment limit is 8 metric tons then the parameter must be set to 8000.

X

X

GEOCODE_SERVLET
Required if Oracle Map Cloud Services will be used to validate addresses. Points to the property identifying Oracle Map Cloud Services geocoding servlet.

X

GEOLIST_PROPERTY

While trying to validate the address, this parameter enables you to control whether you want to get multiple possible matches for a given address.

By default, the PCMiler Web Service returns one best possible match for the given address. But if you add this parameter and set its value to "Yes"/ "Y", then the PCMiler Web Service returns a list of several matching geo-coded addresses i.e. with latitudes and longitudes.

If the value of this parameter is not provided in the external distance/service engine, then the engine returns only one match.

Note: This parameter does not support the address type LAT_LONG.

X

GOVERNOR_SPEED_LIMIT

It is the maximum average road speed to use in route calculations that overrides all other road speeds when they are above this value. Valid value is between 1 and 100 mph, or 1 and 161kph determined by DistanceUnits.

X

HAZMAT_ROUTING
When you set this parameter to “y” or “Y”, OTM identifies the hazmat type from the hazmat items and then sends the hazmat information to the EDE.  

This parameter is off by default which means the hazmat information will not be sent to the EDE.

The 'TUNNEL_CATEGORY' parameter (see below) specifies which dangerous goods are not allowed to enter the regulated tunnel. The categories range from B to E with B being the least restrictive. The tunnel category provided in a truck profile excludes tunnels that are equally or more restrictive from the route calculation.

Because tunnel categories include restrictions for dangerous goods, you might expect the routing engine to automatically select the most appropriate tunnel category based on this parameter. However, this is not the case. If you have set the this parameter, you must still set the TUNNEL_CATEGORY parameter. The routing engine cannot calculate the value for the tunnel category based on this parameter  alone.

See About OTM Sending Hazmat Information to External Distance Engines.

X

X

X

HOST
This defines the host name of the server running the EDE.

X

X

X

X

LOCATION
Defines Client ID login credentials for the TCP interface.

QUALITY LEVEL 

This enables you to control the logic that returns possible matches.

For PC*MILER Web Services, valid values are:
- Exact
- Good
- Uncertain
- Failed
The default is Failed, which indicates all the results returned in the response are considered valid.

For HERE - Geocoding, you can provide a decimal value between 0 to 1. This value indicates the lowest accepted threshold. The default value is 0 where all the locations from the response with a quality level between 0 to 1 are considered valid. For example, a location with quality level 1 indicates an exact match. A higher quality level indicates better accuracy of a location match.

For  Oracle Spatial, possible values are 0, 1, 2, 3, 4, 10, 11, and 12. This value indicates the highest accepted threshold. The default value is 4 which indicates only the input fields postal code and city name are matched. All locations from the response with quality level <=4 are considered valid. A higher quality level indicates lesser accuracy except 0 which indicates no match whereas 1 indicates an exact match.

Note: For Oracle Spatial, when you save the QUALITY LEVEL parameter, the saved parameter name is displayed as MATCHCODE_THRESHOLD in the grid.

X

X

X

MOTORWAYS

If you specify motorway:-2, OTM will exclude motorways (highways) from the route calculation if it is possible to find a route that avoids them. Otherwise, the route calculation will include motorways.

For HERE valid values are:

0 - Normal

-1 - Avoid

-2 - Soft Exclude

-3 - Strict Exclude

For HERE - Routing, possible values are:

 - Y (Avoid) 

- N (Allow)(Default)

X

X

OVERLAY_ID

This parameter enables you to specify the overlay map ID created in HERE using the custom route extension feature, which is used for either blocking certain routes or creating new routes. Configure the here.route.host property using the https://cre.api.here.com/2/calculateroute.xml

URL and provide your credentials to configure user-defined routing. For more details, see host details of the HERE engine.

Note: The value of the OVERLAY_ID parameter must contain the word 'OVERLAY'. It can contain letters A - Z (both uppercase and lowercase) and numbers 0 - 9, but must not contain any special characters and spaces. For example, OVERLAYTEST, 1OVERLAYDEMO, or ROUTEOVERLAY. You can also add multiple map names with a comma. For example, OVERLAYTEST, OVERLAYDEMO. For more information, refer to the HERE documentation.

X

PASSWORD
Defines password login credentials for the TCP interface.

PORT
This identifies the host port of the server running the EDE.

X

X

X

RAIL_FERRIES

For HERE Valid values are:

0 - Normal

-1 - Avoid

-2 - Soft Exclude

-3 - Strict Exclude

For HERE - Routing possible values are:

 - Y (Avoid) 

- N (Allow)(Default)

X

X

REST_TIMES

This parameter is used in the case of the HERE Fleet Telematics to make the desired request for rest times. This updates the Rest Times and Transit Time fields on shipment stops.

Using the value field, rest times can be passed either as country code (Eg: &restTimes=USA) or as values in seconds (Eg: &restTimes=900,1200,2400,2100) (Country code in the value field is different than the Country Code field). There are various other ways to explicitly specify the rest times which can be found in the Fleet Telematics Documentation.

If you set rest times, weekend restrictions will also be honored even if  "Weekend Restriction" is not set to yes.

Note: When rest times are calculated using HERE, OTM hours of service (HOS) will not be used.  

Rest times cannot be used for multi stop.

X

ROAD_PREFERENCE
Restricts the route to only highway roads.

For Oracle Map Cloud Services: Optional - The default value is highway. See Oracle Map Cloud Services documentation for more values.

For PC*MILER Web Services: Possible values are Y - highway routing and N - street routing. The default value is N. This property enables road preference while calculating distance or time.

X

X

ROUTE_SERVLET
Required - points to Oracle Map Cloud Services routing servlet.

X

ROUTE_TYPE
Sets the type of search the EDE will use (practical, fastest, shortest, avoid tolls, etc.).

Acceptable entries for PC*MILER Web Service route type are P (practical), S (shortest) or F (fastest).

Note: For PC*MILER RAIL, possible values and its Route Type are:
P - Practical (default)
I - Intermodal
S - Shortest
C - CoalBulk
A - AutoRacks
F - FuelSurcharge

Note: For PC*MILER STREETS, possible values and its Route Type are:
0 - Practical
1 - Shortest
2 - National
3 - AvoidToll
4 - Air
6 - FiftyThree

X

X

X

X

X

ROUTING_MODE_TYPE

Defines the mode type of the route to be chosen by the EDE.

For HERE possible values are:

- fastest (Default)

- shortest

For HERE - Routing possible values are:

 - fast (Default)

- shortest

X

X

SAME_SOURCE_DEST_DIST
If both the source and destination locations are the same, the distance specified in this parameter will be returned without the EDE ever being called.

X

X

SOURCE_ADDRESS_TYPE
Defines the type of address associated with the source. The following table shows valid address type values for SOURCE_ADDRESS_TYPE parameters.

X

X

X

X

X

X

X

X

SPEED_PROFILE_TYPE

Specifies a speed model for a vehicle (presently only truck) indicated by a routing mode. It is used to adjust computed routes and estimated travel time to predefined set of speed profiles. The valid values are Fast and Default.

The default value is Default profile.

            X

TIMEOUT
Defines the amount of time in milliseconds to time out if there's no response from the EDE.

Following are default values:

Oracle Map Cloud Services:10,000ms

PC*Miler Streets:5000ms

PC*Miler Rail:5000ms

PC*Miler Web Services:10,000ms

Here: 10,000ms

PC*Miler Rail Web Services:10,000ms

X

X

X

X

X

X

TIME_UNIT
How time is counted, such as by second, minute, or hour.

X

TOLL_PREFERENCE

Generates the route by trying to avoid toll roads.

For PC*MILER Web Services: Possible values are Y (Yes-avoid toll) and N (No-don't avoid toll). Default: N.

For HERE Valid values are:

0 - Normal

-1 - Avoid

-2 - Soft Exclude

-3 - Strict Exclude

For HERE - Routing possible values are:

 - Y (Avoid) 

- N (Allow)(Default)

Refer to the HERE documentation for an explanation of the values.

X

X

X

TRANSPORT_MODE

Defines the mode of transport to calculate the route. The valid values are: car, pedestrian, and truck. The default is truck.

X

X

TRUCK_TYPE

Describes specific type of trucks which overrides more generalized truck rules. The valid values are: delivery, public, resident, or trailer. There is no default.

X

TUNNELS

For HERE Valid values are:

0 - Normal

-1 - Avoid

-2 - Soft Exclude

-3 - Strict Exclude

For HERE - Routing possible values are:

 - Y (Avoid) 

- N (Allow)(Default)

X

X

TUNNEL_CATEGORY

Truck routing only, specifies the tunnel category to restrict certain route links. The route will pass only through tunnels of a less strict category.

The HAZMAT_ROUTING parameter needs to be set to Y for the routing engine to calculate the value for tunnel category. See the HAZMAT_ROUTING parameter details as well.

The valid values are B, C, D and E with B being the least restrictive.

X

X

USE_CUSTOM_ROAD_SPEEDS

Allows use of custom speeds to negotiate service times with the carriers. The values can be Y or N. To apply this parameter set the value to Y.

X

USE_DEFAULT_ROUTE_TYPE
If you set this parameter to Y, OTM uses a default route type. If this parameter is blank or N, OTM will use the route type defined in the ROUTE_TYPE property.

X

X

X

X

USER
Defines user login credentials for the TCP interface.

VEHICLE_TYPE
The type of vehicle used, such as a truck or auto.

X

X

WEEKEND RESTRICTION

You need to use current host URL for Fleet Telematics to make the desired request for weekend restrictions. This may update the Wait Time and Transit Time fields on the shipment stops.

The following property must be valued to use weekend restriction: glog.optimization.scheduling.weekendRestrictionService.

If rest times is set, in order to get correct rest time results, a real time call is made to HERE. In that case, the weekend restriction will be honored, even if not set to yes.

The property glog.optimization.scheduling.weekendRestrictionTimeStepHours allows more granular start time adjustments for shipments when attempting to remove or reduce wait time introduced by weekend restrictions.  

Note: If using Rest Times / Weekend Restriction from HERE, OTM hours of service (HOS) will not be used.

Weekend restriction cannot be used for multistop.

X

ADDRESS (used only for Validate Address action)

X

X

CITY_COUNTRY

X

X

X

X

X

CITY_POSTAL

X

X

CITY_PROVINCE

X

X

X

X

X

LAT_LONG

X

X

X

X

X

POSTAL_CODE

X

X

X

X

X

POSTAL_CODE_COUNTRY

X

X

X

X

POSTAL_CODE_PROVINCE

For example, If you set the SAME_SOURCE_DEST_DIST parameter to 25 miles and then set  SOURCE_ADDRESS_TYPE and DEST_ADDRESS_TYPE to the POSTAL_CODE_PROVINCE value, then the external distance engine returns 25 MI.

X

X

X

X

RAIL_STATION (Rail city)

X

X

SPLC

X

X

STREET_ADDRESS

>=V.22

X

AVOIDS_AND_FAVORS_SETIDS

Used for custom routing preferences, such as avoiding or favoring certain roads, or overriding road restrictions. To apply avoids and favors, use numeric value of '-1' to apply all of the avoids and favors associated with the API key. To apply specific SET IDs, add set IDs as comma-separated values.

Not supported

Valid values are:

-1 or Specific avoids and favors IDs like (6170,6174)

Not supported

Not supported

BOAT_FERRIES

Identifier for boat ferries.

Not supported

Not supported

Possible values: 0 - Normal,
-1 - Avoid, -2 - Soft Exclude,
-3 - Strict Exclude
Default: 0

Possible values: Allow or Avoid.
Default: Allow

BORDERS_OPEN

This parameter enables you to control border crossing.

Not supported

Possible values: Y or N.
Default: N

Not supported

Not supported

DESTINATION ADDRESS TYPE

Not supported

Not supported

Possible Values: Address, City Country, City Postal, City Province, Latitude Longitude, Postal Code, Postal Code Country, Postal Code Province, Street Address

Possible values: Latitude Longitude (Distance/Service only)

DIRT_ROAD

Identifier for dirt roads.

Not supported

Not supported

Possible values: 0 - Normal,
-1 - Avoid, -2 - Soft Exclude,
-3 - Strict Exclude 

Default: 0

Possible values: Allow or Avoid
Default: Allow

DISTANCE_UNIT

Possible values: km, mile, or meter

Default: mile

Note: For map and driving directions.

Not supported

Possible values: imperial for miles, or metric for kilometers

Default: imperial for miles

Note: For driving directions only. Does not work for external distance engine.

Not supported

ELEVATION_LIMIT

Indicates the elevation limit when generating a route.

Elevation unit can be either meters or feet and is determined by the DISTANCE_UNIT parameter above.

Limit will be ignored if routing is deemed impractical with the limit or a stop is located at an elevation higher than the limit.

Not supported

Default value is null.

Not supported

Not supported

EQUIPMENT_RESTRICTIONS

When set to Y, this property provides a detailed distance if the equipment is oversized and a further route needs to be taken to avoid certain bridges and/or tunnels as long as height, weight, length, and width are recorded. OTM will look for exterior dimensions recorded in the Equipment Type table. If those values do not exist, OTM will obtain the dimensional information from the Equipment Group. If the order includes multiple equipment types, the largest values defined will be used.

Possible values: Y or N

Default: N

Possible values: Y or N

Default: N

Possible values: Y or N

Default: N

Possible values: Y or N

Default: N

FERRY_DISCOURAGE

Indicates whether or not to discourage the use of ferries when creating the route.

Not supported

Possible values: true, false

Default: false

Not supported

FIXED_LIMITED_WEIGHT

Determines the speed profile used in the route calculation.

• If a value is entered for this parameter, the 'limitedWeight' parameter will be sent to HERE irrespective of whether EQUIPMENT_RESTRICTIONS is on or off.

• If the EQUIPMENT_RESTRICTION parameter is on, the 'limitedWeight' calculated from the equipment will be replaced by the FIXED_LIMITED_WEIGHT value.

Not supported

Not supported

Values entered must be in tons.

Values entered must be in kilograms.

GOVERNOR_SPEED_LIMIT

The maximum average road speed to use in route calculations that overrides all other road speeds when they are above this value. Valid value is between 1 and 100 mph, or 1 and 161kph determined by DistanceUnits.

Not supported

1 and 100 mph, or 1 and 161kph

Not supported

Not supported

HAZARDOUS MATERIALS ROUTING

Restricts the route to roads that allow for the transport of the selected hazardous material.

Not supported

Possible values: Y or N

Possible values: Y or N

Possible values: Y or N

MOTORWAYS

Not supported

Not supported

Possible values: 0 - Normal,
-1 - Avoid, -2 - Soft Exclude,
-3 - Strict Exclude 

Default: 0

Possible values: Allow or Avoid
Default: Allow

RAIL_FERRIES

Identifier for rail ferries.

Not supported

Not supported

Possible values: 0 - Normal,
-1 - Avoid, -2 - Soft Exclude,
-3 - Strict Exclude 

Default: 0

Possible values: Allow or Avoid
Default: Allow

ROAD_PREFERENCE

Restricts the route to only highway roads.

Possible values: highway or local

Default: highway

Possible values: Y (allow highways) or N (avoid highways)

Default: N

Not supported

Not supported

ROUTE_TYPE

Possible values: fastest or shortest

Default: fastest

Possible values: fastest or shortest

Default: fastest

Possible values: fastest or shortest

Default: fastest

Possible values: fastest or shortest

Default: fastest

ROUTING_MODE_TYPE

Not supported

Not supported

Not supported

Possible values: fastest or shortest

Default: fastest

SOURCE ADDRESS TYPE

Not supported

Not supported

Possible Values: Address, City Country, City Postal, City Province, Latitude Longitude, Postal Code, Postal Code Country, Postal Code Province, Street Address

Possible values: Latitude Longitude (Distance/Service only)

SPEED PROFILE TYPE

Not supported

Not supported

Possible values: Default, Fastest
 

Not supported

TIME_UNIT

The unit for time values that are returned.

Possible values: hour, minute, or second

Default: minute

Note: Only used for map.

Not supported

Not supported

Not supported

TOLL_PREFERENCE (TOLL ROAD)

Generates the route by trying to avoid toll roads.

Not supported

Possible values: Y (avoid tolls) or N (allow tolls)

Default: N

Possible values: 0 - Normal,
-1 - Avoid, -2 - Soft Exclude,
-3 - Strict Exclude 

Default: 0

Possible values: Allow or Avoid
Default: Allow

TRUCK_TYPE

Values are delivery, public, resident, or trailer (default)

Possible values: delivery, public, resident, or trailer

Default: trailer

Not supported

Not supported

Not supported

TRANSPORT_MODE (TRANSPORT MODE TYPE)

Not supported

Not supported

Possible values: Car or Truck Default: truck

Possible values: Car or Truck Default: truck

TUNNEL_CATEGORY
Specific to truck routing only. Specifies the tunnel category to restrict certain routes. The route will pass only through tunnels of a less strict category.

Not supported

Not supported

Possible values: B, C, D, E

Possible values: B, C, D, E

TUNNELS

Identifier for tunnels.

Not supported

Not supported

Possible values: 0 - Normal,
-1 - Avoid, -2 - Soft Exclude,
-3 - Strict Exclude 

Default: 0

Possible values: Allow or Avoid
Default: Allow

USE_CUSTOM_ROAD_SPEEDS

Allows use of custom speeds to negotiate service times with the carriers. Possible values are Y or N. To apply this parameter set the value to Y.

Not supported

Y or N

Not supported

Not supported

VEHICLE_TYPE

Values are truck (default) or auto.

Possible values: truck or auto

Default: truck

Not supported

Not supported

Not supported

WEEKEND RESTRICTION

Not supported

Not supported

Possible Values: No, Yes (Using Fleet Telematics)

Not supported