Map Services |
This screen is used to define two types of services. These services are tile layer services and geocoding services. Only one service of each type will be used by the API service which is determined by the record with the lowest display order value. Tile layers may come in different varieties depending on the service provider. For example, with Bing and Google Maps, it is common to provide three varieties: roads, aerial, and hybrid. These types are mutually exclusive and are toggled by the radio buttons in the layers control in the top right corner of the map frame.
There are many different settings for maps when it comes to provider and type of map information. For information on these choice lists and where to choose them, refer to the information below in the Provider and Type fields.
Service Provider |
Service Type |
Settings |
BING |
TILES |
Requires Service Key with paid subscription. Requires Service Key option. |
ESRI |
TILES |
Requires URL option which will specify service endpoint. |
ESRI |
GEOCODING |
Requires URL option which will specify service endpoint. An option to specify single line address field searching called GEOCODE SEARCH FIELD is located on the Map Providers screen. This is only needed if your Esri geocoding service uses a different name than the standard “Single Line Input” name on Esri geocode's findAddressCandidates endpoint. |
MAPBOX |
TILES |
Requires Service Key and Client ID. |
OPENSTREETMAP (OSM) |
TILES |
No setting options required. This service must adhere to the provider’s title policy which does not allow the usage of their service for production. |
Notes for ESRI Map Services
The format of the URL is http://<ESRI SERVER>/arcgis/rest/services/<MAP SERVICE>/MapServer/tile
Map Services must use the Web Mercator spatial reference (102100/3857) which can be verified in the service directory.
http://<ESRI SERVER>/arcgis/rest/services/<MAP SERVICE>/MapServer
NOTE: When browsing the service directory copy what is entered in Map Services screen and delete the "/tile" at the end of the URL
If the service is changed, delete previously cached tiles. They can be found in <INSTALL DIR>\APIService\tiles\esriroads
Mapping layer ID
The identifier of the mapping layer. This field has a choice list for a new item, otherwise, this field is display only.
Description
The description of the map service.
Display order
The order in which the records display.
The provider of the mapping information.
BING
ESRI
MAPBOX
OPENSTREETMAP
The type of service provided.
Tiles
Geocoding
Feature Service
Allow Caching
Check this box if your map tile service provider permits caching and you would like to cache map tiles. It is recommended that you follow the Terms of Use as specified by your service provider.
Allow proxy
Check this box if your map tile service provider permits proxy use. It is recommended that you follow the Terms of Use as specified by your service provider.
Note: If your organization uses MobileFocus and mapping, be sure this option is checked for the tile providers you are using.
Active
Check this box to make the map service active. Map services must be active to be viewed in the web portals and elsewhere. Newly created services default to inactive (unchecked) and must be activated to be used.
Note: Services that were already been defined in a previous release version before this checkbox existed were defaulted to active.
Days to keep cache data
Set the number of days to keep cache data as specified by your service provider.
Maximum default zoom level
Enter a value to set the maximum default zoom level for maps. This stops the auto-zoom when selecting a layer that only displays one asset preventing the map from auto-zooming beyond the region's available map tiles. To determine the appropriate zoom level to set, do the following:
1. Once Data Services is running, click the Admin option in Web Modules.
2. Go to Admin > View Log > DataServices.
3. In JSON, view each map service record for tiles and zoom levels, which is usually on a scale of zero to approximately 20.
Al Allow long-term storage
This checkbox is used to specify that data obtained from this geocode service can be stored in the database. Please review your geocode provider's license to ensure that you can persist geocoded data from this service. Note that enabling this feature may result in additional costs from your geocode provider. If this feature is disabled, data obtained from this geocode service will only be used to provide temporary context on the map.
Delete: To delete the entries in the fields to the right, place a check in this field and click save.
Option: This field has a choice list. In the choice list, you can choose an ID from the following:
SERVICE KEY
CLIENT ID
URL
GEOCODE SEARCH FIELD
IMAGE FORMAT
PACKAGE NAME
SERVICE VERSION - Allows users to specify a version of a provider's service as opposed to using the default version.
TOKEN URL - Supports authorization with paid third-party map services. Encrypted upon entry.
Value: The description of the Option field.