Configuration and Administration

HERE Properties

These tables list the properties for HERE maps which are used for external distance engine and Workbench maps.

In the near future, HERE will stop supporting version 3.0 of the HERE maps API. So in an effort to smoothly transition to the new 3.1 version, OTM is taking the following approach:

  • Expose some previously reserved properties to allow you to switch between versions
  • By default, these HERE properties are set to use version 3.0 as detailed in section For Version 3.0 of HERE Maps API
  • Provide new properties as well as settings for existing properties to support version 3.1 as detailed in For version 3.1 of HERE Maps API

General Properties

Property

New in Version

Description

here.app_code

6.3.7

This property is used to specify the application code which connects to external engine provided by HERE. It is a part of the credential along with app_id. See the glog.ExternalDistanceEngine.HERE.authenticationType property for more information.

Note: HERE is deprecating this property in favor of ApiKey and OAuth.

here.app_id

6.3.7

This property is used to specify the application ID which connects to external engine provided by HERE. It is a part of the credential along with app_code. See the glog.ExternalDistanceEngine.HERE.authenticationType property for more information.

Note: HERE is deprecating this property in favor of ApiKey and OAuth.

here.api_key

21A

Contains the API key generated by HERE version 3.1. See the glog.ExternalDistanceEngine.HERE.authenticationType property for more information.

here.geocode.host

6.3.7

This property is used to specify the complete geocode URL for validating an address with HERE.

here.route.host

6.3.7

This property is used to specify the complete route URL of HERE to get the distance or time between two given locations.
here.route.overlay 24A This property is used to specify a global overlay for HERE V7 routing.

here.route.matrix.host

20C

This property is used to specify the complete route URL of the HERE service to get distance or time between a list of source locations and a list of destination locations for Generate Rush Hour Data.

here.useLatestApi

21A

This property is used to specify which version of the following HERE APIs to use for Workbench maps:

  • HERE maps (legacy workbench): set property to true to use version 3.1
  • HERE routing (Enhanced Workbench only): set property to true to use version 8

Set to false to use HERE maps version 3.0 and HERE routing version 7.

Default: false

Note: The Enhanced Workbench only uses HERE maps API 3.1.
 

 

For version 3.1 of HERE Maps API

To switch to version 3.1 of the HERE maps API, set the following properties as listed below:

Property

New in Version

Description

here.useLatestApi

21A

Set this property to true to use version 3.1.

Default: false

here.useLatestApiKey

 24A

Set this property to true to use the new Map Tile Service functionality in the Enhanced Workbench map. You must also enter the platform key obtained from HERE support into the here.api_key property.

Default: false

here.api_key

21A

Contains the API key generated by HERE version 3.1.

For External Distance Engine setup, see the glog.ExternalDistanceEngine.HERE.authenticationType property for more information.

To use the new Map Tile Service functionality in the Enhanced Workbench map, contact HERE support to get a platform key and enter that key here. Then, set the here.useLatestApiKey propery to true.

here.core_url

No longer reserved as of 21A

For version 3.1, set to https://js.api.here.com/v3/3.1/mapsjs-core.js

here.core_legacy_url

21A

For version 3.1, set to https://js.api.here.com/v3/3.1/mapsjs-core-legacy.js

here.css_url

No longer reserved as of 21A

For version 3.1, set to https://js.api.here.com/v3/3.1/mapsjs-ui.css

here.event_url

No longer reserved as of 21A

For version 3.1, set to https://js.api.here.com/v3/3.1/mapsjs-mapevents.js

here.service_legacy_url

21A

For version 3.1, set to https://js.api.here.com/v3/3.1/mapsjs-service-legacy.js

here.service_url

No longer reserved as of 21A

For version 3.1, set to https://js.api.here.com/v3/3.1/mapsjs-service.js

here.ui_url

No longer reserved as of 21A

For version 3.1, set to https://js.api.here.com/v3/3.1/mapsjs-ui.js

 

For Version 3.0 of HERE Maps API

By default, Oracle Transportation Management uses version 3.0 of the HERE maps API. These properties are set by default as shown below.

Note: This version of HERE Maps API is in maintenance mode and will no longer be supported in the near future. Update to version 3.1 of the HERE Maps API.

Property

New in Version

Description

here.useLatestApi

21A

This property is to false to use version 3.0.

here.app_code

6.3.7

This property is used to specify the application code which connects to external engine provided by HERE. It is a part of the credential along with app_id. See the glog.ExternalDistanceEngine.HERE.authenticationType property for more information.

Note: HERE is deprecating this property in favor of ApiKey and OAuth.

here.app_id

6.3.7

This property is used to specify the application ID which connects to external engine provided by HERE. It is a part of the credential along with app_code. See the glog.ExternalDistanceEngine.HERE.authenticationType property for more information.

Note: HERE is deprecating this property in favor of ApiKey and OAuth.

here.core_url

No longer reserved as of 21A

This property is set to https://js.api.here.com/v3/3.0/mapsjs-core.js

here.css_url

No longer reserved as of 21A

This property is set to https://js.api.here.com/v3/3.0/mapsjs-ui.css

here.event_url

No longer reserved as of 21A

This property is set to https://js.api.here.com/v3/3.0/mapsjs-mapevents.js

here.service_url

No longer reserved as of 21A

This property is set to https://js.api.here.com/v3/3.0/mapsjs-service.js

here.ui_url

No longer reserved as of 21A

This property is set to https://js.api.here.com/v3/3.0/mapsjs-ui.js

 

HERE Engine Host Details

This table displays host details of the HERE engine.

HERE Services

Property

Description

Host

Geocoding

here.geocode.host

Validates address

https://geocoder.api.here.com/6.2/geocode.xml

Routing

here.route.host

Calculates distance or time between two locations.

https://route.api.here.com/routing/7.2/calculateroute.xml

Routing Matrix

here.route.matrix.host

Calculates the distance or time between a list of source locations and a list of destination locations.

https://matrix.route.api.here.com/routing/7.2/calculatematrix.xml

Custom Routing Extension

here.route.host

Creates optimistic custom route considering user-defined roadblocks (overlay). This overlay name is set as a value for the OVERLAY_ID parameter in 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.

https://cre.api.here.com/2/calculateroute.xml

Custom Location Extension

here.route.host

Creates routing by considering overlays and the new route provided (road blocks).

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.

https://cle.api.here.com/2/calculateroute.xml


 

 

The app_id/app_code, API Key, and OAuth columns show the endpoint URLs.

Use Case

Properties

Description

app_dd/app_code

API Key

OAuth

Custom Locations

here.route.host

Creates routing by considering overlays and the new route provided (road blocks).

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.

https://cle.api.here.com/2/calculateroute.xml

https://fleet.ls.hereapi.com/2/calculateroute.xml

https://fleet.ls.hereapi.com/2/

Custom Routes

here.route.host

Creates optimistic custom route considering user-defined roadblocks (overlay). This overlay name is set as a value for the OVERLAY_ID parameter in 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.

https://cre.api.here.com/2/calculateroute.xml

https://fleet.ls.hereapi.com/2/calculateroute.xml

https://fleet.ls.hereapi.com/2/

Distance

here.route.host

 

https://route.api.here.com/routing/7.2/calculateroute.xml

https://route.ls.hereapi.com/routing/7.2/calculateroute.xml

https://route.ls.hereapi.com/routing/7.2/

Generate Rush Hour

here.route.matrix.host

Calculates the distance or time between a list of source locations and a list of destination locations.

If property glog.business.session.useMatrixServiceToGenerateRushHours is false then https://route.api.here.com/routing/7.2/calculateroute.xml. If true https://route.api.here.com/routing/7.2/calculatematrix.xml

If property glog.business.session.useMatrixServiceToGenerateRushHours is false then https://route.ls.hereapi.com/routing/7.2/calculateroute.xml . If true https://matrix.route.ls.hereapi.com/routing/7.2/calculatematrix.xml

https://matrix.route.ls.hereapi.com/routing/7.2/

Geo Coding

here.geocode.host

Validates address

https://geocoder.api.here.com/6.2/geocode.xml

https://geocoder.ls.hereapi.com/6.2/geocode.xml

https://geocoder.ls.hereapi.com/6.2/

Service Time

here.route.host

 

https://route.api.here.com/routing/7.2/calculateroute.xml

https://route.ls.hereapi.com/routing/7.2/calculateroute.xml

https://route.ls.hereapi.com/routing/7.2/

Weekend Restrictions (Using Fleet Telematics)

glog.optimization.scheduling.weekendRestrictionService

 

https://fleet.api.here.com/2/calculateroute.xml

https://fleet.ls.hereapi.com/2/calculateroute.xml

https://fleet.ls.hereapi.com/2/

 

 

Related Topics

External Distance Engine Parameters

ALK Properties

elocation Properties

Integrating with HERE Engine

glog.ExternalDistanceEngine.HERE.authenticationType

Copyright © 2001, 2023, Oracle and/or its affiliates.

For the latest installation and reference guides, go to the online library. For the additional materials, see Knowledge Document 796594.1 on My Oracle Support.

For questions about Oracle Transportation Management or Global Trade Management, contact Support or find the Support phone number for your region.

If you have any questions or comments about this documentation page, please Contact Oracle Documentation. Was this page helpful? Click to send feedback.How can we improve this page?What did you like about this page?Comments