Parameters for configuring map service provider

Feedback


Map service provider encapsulates the implementation of map functions, supports map service components. According to map function source, the map service provider is divided into: local map service provider, WMS map service provider, REST map service provider, aggregate map service provider. Each service provider has its own configuration parameters.

Local map service provider

Local map service provider encapsulates the map functions from Supermap workspace

Table 1. Configuration parameters of Local map service provider

  Parameter name Description

General settings

Map service provider [Required parameter]
Uniquely identifies this service provider.The default prefix is "ugcMapProvider-".

Basic settings

Workspace type [Required parameter]
Workspace type includes file, database(SQL Server ,Oracle workspace).SQL Server workspace means the workspace stores in SQL Server database, Oracle workspace means the workspace stores in Oracle database.
Workspace path Remote server file system Required if the workspace is file type, if it is database type,seeTable2. When Server is not at local,chooses "remote browse", then can use files in the server or upload local files to server then use. When server is at local, chooses "local browse".
SuperMap's workspace(*.smwu,*.sxwu, *.smw , *.sxw )stores GIS data related information.
Local file system.
Workspace password Workspace password, if not exists, do not fill or fill in any character.

Advanced settings

Cache version Dynamic cache version, the default is 4.0. See the cache version that iServer is currently supporting:SuperMap cache strategy. If need it compatible with the simple cache generated by SuperMap iServer 2008, the cache version should be set as 3.1.
Preferred type is PNG cache image When using PNG cache, PNG image type is preferred. Now we support PNG and PNG8. If the set is null, uses PNG. PNG8 supports transparent and 256-colors background, which is lossless compression.It's size is smaller than PNG, and it is more suitable for the simple image with small number of colors or big luminance difference and sharp contrast.It is only valid in 5.0 cache version.
Published map name list Published map name list, map names are separated by comma. If empty, publishes all maps.
Map default setting list User can set the display style of map highlighted objects. Highlight object means GIS server uses a different display style to render the object in map to highlight some objects and it's space position.
If not set, the highlighted object will be rendered according to the default setting.
Enable multi-thread mode Whether uses multiple thread mode.Enabling multiple thread mode can increase the concurrent performance of local map service provider, the default is enabled.
Map buffer pool size When enables multiple thread mode, the default of the map buffer pool size is 0, and the system will divide the object pool equally according to the map number in workspace.SuperMap iServer's 32-bit product has max number 32, and 64-bit product has max number 64.
Users can set or change the buffer pool size manually according to server status.
Disable caching Whether disables cache,using cache can increase the image output performance of local map service provider, the default is enabled. The image output parameter can set this too. When the conflict occurs, disabling is prefered.e.g, in the service provider it is enabled, and in image output parameter it is disabled, the outcome is that cache is disabled.

Notice:SuperMap iServer provides other optional parameters that can be set in configuration file, such as useCompactCache,extractCacheToFile,queryExpectCount,seeConfigures service provider by XML file..

Inside, the user can change the default style of highlighted point,highlighted line and highlighted plane:

Uses a point symbol style of UGC default symbol library to render highlighted point objects. You can set the point symbol style (specified by the ID of point style in symbol library) in map setting,and also color,size, rotation angle and so on of a symbol.

Uses a line symbol style of UGC default symbol library to render highlighted line objects. You can set the line symbol style (specified by the ID of line style in symbol library) in map setting,and also linewidth,size and so on of the line style.

Uses a plane symbol style of UGC default symbol library to render highlighted plane objects. You can set the plane symbol style (specified by the ID of plane style in symbol library) in map setting,also color of the border line,fill colr, transparant or not, the percentage of verticality or deviation of filled center and so on.

Every map can only set one style. iServer WebManager provides a default map setting. If not set, the highlighted object will be rendered according to default style set by map.

 

When SuperMap workspace is database type, configuration parameter description is shown below:

Table 2. Database type workspace's information configuration parameter

Parameter name Description
Server Server name. To Oracle database, the server name is its TNS service name. To SQL Server database, the servername is its system DSN(Database System Name) name.
Databse Spactial database name.
Driver The driver name when using ODBS. Only SQL Server database uses ODBC, and its driver name can be SQL Server or SQL Native Client.
Name The workspace name in database.
Username The username to login database.
Passoword The password to login database.

REST map service provider

REST map service provider encapsulates the GIS functions getting from REST service of remote SuperMap iServer map.

Table 3.  Configuration parameters of REST map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider.The default prefix is "restMapProvider-".
Basic settings REST service root directory URL [Required parameter]
Remote SuperMap iServer map REST service's root directory,e.g,http://supermapiserver:8090/iserver/services/map-world/rest .
Advanced settings Token or API-Key When enables security mechanism, accessing the protected REST resource requires Token or API-Key.
Enable caching Whether uses cache. The default is true. After enables cache, the REST request to resource will be stored in local, and next same request will read from cache directly, does not need to send to server again.
Cache strategy The max size of hard disk The max size of hard disk. The unit is MB, and the default size is 2048MB.
Live time Used to set the upper limit for the survival of the cache, when time's up, the cache will be removed. Timing starts from the creation of the record, the unit is second. and the default is 0, which means permanent survival.
Idle time Used to set the upper limit for the idle time of the cache, when time's up, the cache will be removed. Timing starts from last access time, the unit is second, and the default is 0, which means permanent survival.

 

SuperMap Cloud map service provider

SuperMap Cloud map service provider encapsulates the GIS functions getting from online service of remote SuperMap Cloud map.The parameters that uses need to set and the description is shown as the table below:

Table 4. Configuration parameters of  SuperMap Cloud map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider. The default prefix is "cloudMapProvider-".
Basic settings Map service address The image output service address of remote CloudSuperMap map service. If the user sets servicesUrl,uses the service address that the user sets, otherwise uses the default map cloud service address:http://t2.supermapcloud.com/FileService/image.
Advanced settings Enable caching Map service provider generates cache to improve the efficiency of service access. If true, generates map cache in local when accessing published service,thereby increasing the browse speed of followed service.

 

FastDFS map service provider

FastDFS map service provider encapsulates the GIS function provided by FastDFS tile package, the related parameter is shown in the table below:

Table 5. Configuration parameters of FastDFS map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider. The default prefix is "fastMapProvider-".
Basic settings Loads configuration from distributed tile repository Chooses the existing distributed tile repository,does not need to set FastDFS service address.
FDFS Trackers FastDFS Trackers service address.
FDHT Groups FastDHT Groups service address.

published map

If FastDFS server stores many map tiles, then you need to choose the map to be published. And you can publish all the maps.

GDP map service provider

GDP map service provider encapsulates the GIS function provided by GDP tile package, the related parameters are shown in the table below:

Table 6. Configuration parameters of GDP map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider.The default prefix is"gdpMapProvider-".
Basic settings GDP file directory [Required parameter]
GDP file(*.zip)directory.
dpi The tile resolution, and the default is 96.
Cache version Tile version, now supports 5.0 and 3.1 version of GDP tile package.
See the detail of tile version:SuperMap UGC format map tile.
Level 0 scale denominator Level 0 scale denominator in the tile package.The default is 5.916587109091312E8.

 

MongoDB map service provider

MongoDB map service provider encapsulates the GIS functionality acquired from the MongoDB distributed storage tiles. The parameters that a user needs to set and their descriptions are shown in the table below:

Table 7. Configuration parameters of MongoDB map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider. The default prefix is "mongodbMapProvider-".
Basic settings Loads configurations from distributed tile repository Chooses exsiting distributed tile repository, does not need to set MongoDB service address.

Service address

[Required parameter]
MongoDB service address.

Add replication set

Adds replication set by checking, multiple replication sets can improve read and write performance of tile and data secuirty.

Database

The database which stores the map tiles of the map service.

Username

The name of the user who have the permission to access dababase.

Password

The password of the user.

Maps to be published

If MongoDB server stores many map tiles, then you need to choose the map to be published. And you can publish all the maps.

MongoDB MVT map service provider

MongoDB MVT map service provider encapsulates the GIS functionality acquired from the MongoDB distributed storage tiles.. The parameters that a user needs to set and their descriptions are shown in the table below:

Table 8. Configuration parameters of MongoDB MVT map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider. The default prefix is "mongoDBMvtMapProvider-".
Basic settings

Service address

[Required parameter]
MongoDB service address.

Add replication set

Adds replication set by checking, multiple replication sets can improve read and write performance of tile and data secuirty.

Database

The database which stores the tiles to be published.

Username

The name of the user who have the permission to access dababase.

Password

The password of the user.

 

OTS map service provider

OTS map service provider encapsulates how to access distributed storage tiles in OTS. The parameters that a user needs to set and their descriptions are shown in the table below:

Table 9. Configuration parameters of OTS map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
 [Required parameter] Uniquely identifies this service provider.
Basic settings Loads configurations from distributed tile repository Chooses exsiting distributed tile repository, does not need to set OTS service information.

Instance name

[Required parameter]
The instance name of OTS which is created by Alibaba cloud management console.
Node name  The name of Alibaba cloud node. This means where you want to create the instance. For example, if the address is hangzhou, then the server node is cn-hangzhou.

fromPublic

 Access the OTS service by its public address or private address. The public access address is: http://<instanceName>.<nodeName>.ots.aliyuncs.com. The private access address is: http://<instanceName>.<nodeName>.ots-internal.aliyuncs.com.

accessKeyId

[Required parameter]
 OTS authenticates requests by AccessKey. And accessKeyId identifies the AccessKey. You can get accessKeyId from "management console" in Alibaba cloud official website.

accessKeySecret

[Required parameter]
AccessKeySecret is used to encrypt OTS requests. You can get accessKeySecret from "management console" in Alibaba cloud official website.

Published map

If OTS stores many map tiles, then you need to choose the map to be published. And you can publish all the maps.

SMTiles map service provider

Map service provider encapsulates the GIS functions getting from SMTiles map tile package.The parameter that a user need to st and their descriptions are shown in the table below:

Table 10. Configuration parameters of SMTiles map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Only makrs this service provider. The default prefix is "smTilesMapProvider-".
Basic settings SMTiles file directory [Required parameter]
SMTiles file directory.

SVTiles map service provider

SVTiles map service provider encapsulates the GIS functions getting from SVTiles map tile package.The parameters that a user needs to set and their descriptions are shown in the table below:

Table 11. Configuration parameters of SVTiles map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider.The default prefix is"svTilesMapProvider-".
Basic settings SVTiles file directory [Required parameter]
SVTiles file directory.

UGCV5 map service provider

UGCV5 map service provider encapsulates the GIS functions getting from SuperMap UGC V5 map tile package.

Table 12. Configuration parameters of UGCV5 map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider. The default prefix is"ugcv5MapProvider-".
Basic settings Tile configuration file [Required parameter]
The configuration or index file of SuperMap UGC V5 tile(*.sci or *.inf).

WMS map service provider

WMS map service provider encapsulates the map function from WMS service.

Table 13. Configuration parameters of WMS map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider. The default prefix is "wmsMapProvider-".
Basic settings WMS service root URL [Required parameter]
WMS service address.
WMS service version WMS service version, e.g,"1.1.1".
Athorized user name Only authorized user has access to WMS service, provided by the server publishing WMS map.
Password Password of authorized user, provided by the server publishing WMS map.
Reverse layer order Whether to reverse the order of layers.
Advanced settings Enable caching SuperMap iServer supports generating cache for this map service provider to improve service access efficency. If you enable the cache option, iServer will generate map cache in local when you access the published services. If it receives the same requests later, it will directly return the cache image and thus improves the access speed for you. See detail the configuration of WMSMapProvider cache .

WMTS map service provider

WMTS map service provider encapsulates map functions from WMTS service.

Table 14. Configuration parameters of WMTS map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider. The default prefix is "wmtsMapProvider-".
Basic settings WMTS service root URL [Required parameter]
WMTS service address.
WMTS service version WMTS service version,e.g,"1.0.0" . Now supports WMTS service 1.0.0 version as source.
Authorized username Only authorized user has access to WMTS service, provided by the server publshing WMTS map.
Password Password for authorized user, provided by the server publshing WMTS map.
dpi Remote WMTS service source's dpi.
Scale set Map's corresponding scale set.Lists all corresponding scale sets of maps in WMTS service source.
Advanced settings Resolution set Each level of WMTS service's corresponding resolution. Should be consistent with TileMatrix in chosen scale set. Adjacent resolutions are separated by comma, needs to write the corresponding resoultion of all levels of TileMatrix.
Enable caching SuperMap iServer supports generating cache for this map service provider to improve service access efficency. If you enable the cache option, iServer will generate map cache in local when you access the published services. If it receives the same requests later, it will directly return the cache image and thus improves the access speed for you.

 

Bing Maps map service provider

Bing Maps map service provider encapsulates GIS functions gettig from remote Bing Maps online service. The parameters that a user needs to set and their descriptions are shown in the table below:

Table 15. Configuration parameters of Bing Maps map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider. The default prefix is "bingMapsMapProvider-".
Basic settings Map set [Required parameter]
Bing Maps' map set name.Bing Maps provides "Aerial","AerialWithLables","Birdseye","BirdseyeWithLables","Road"several data set, corresponding to different types of map service.
Map version Bing Maps' map version, e.g, "v0","v1".
Bing Maps key Sets Bing Maps authorized key.Accessing to Bing Maps map service needs to apply for key that provided by Bing Maps..
Advanced settings Enable caching SuperMap iServer supports generating cache for this map service provider to improve service access efficency. If you enable the cache option, iServer will generate map cache in local when you access the published services. If it receives the same requests later, it will directly return the cache image and thus improves the access speed for you.

Google Maps map service provider

Google Maps map service provider encapsulates GIS functions gettig from remote Google Maps online service. The parameters that a user needs to set and their descriptions are shown in the table below:

Table 16.  Configuration parameters of Google Maps map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider. The default prefix is "googleMapsProvider-".
Basic settings Google Maps client ID The account who has the permission to access Google Maps.
Google Maps CryptoKey The private key of the account.
Language The language the text label uses in the map.
Google Maps Width The width of tile you request in pixel. Every tile may have a Google watermark, so you can set it larger to reduce the mark density. But if the value is too big, it will effect the efficiency. So you need set a proper value according to your hardware and software and network conditions.
Google Maps Height The height of tile you request in pixel. In general , it is equal to width of tile.
Advanced settings Enable caching SuperMap iServer supports generating cache for this map service provider to improve service access efficency. If you enable the cache option, iServer will generate map cache in local when you access the published services. If it receives the same requests later, it will directly return the cache image and thus improves the access speed for you.
 

Tianditu map service provider

Tianditu Map service provider encapsulates the GIS functions getting from remote Tianditu online service. Supports Tianditu 2.0 version. The parameters that a user needs to set and their description are shown in the figure below.

Table 17.  Configuration parameters of Tianditu map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider. The default prefix is "tiandituMapProvider-".
Basic settings Map service address Image output address of remote Tianditu map service.The format is as below: http://t<number >.tianditu.gov.cn
The service address number value of Tianditu is 0-7, if a user sets servicesUrl, uses this service address, otherwise randomly
picks from 0-7 as the number value to build service address.
License for development [Required parameter]
Token string used when calling Tianditu API or service interface.
Advanced settings Enable caching SuperMap iServer supports generating cache for this map service provider to improve service access efficency. If you enable the cache option, iServer will generate map cache in local when you access the published services. If it receives the same requests later, it will directly return the cache image and thus improves the access speed for you.

ArcGIS REST map service provider

    ArcGIS REST map service provider encapsulates GIS functions getting from ArcGIS REST online service .Parameters that a user needs to set and their descriptions are shown in the table below.

Table 18.  Configuration parameters of ArcGIS REST map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider. The default prefix is "ArcGISRESTMapProvider-".
Basic settings ArcGIS REST map service address [Required parameter]
Address of to-be-published ArcGIS REST map service,e.g, http://localhost:6080/arcgis/rest/services/SampleWorldCities/MapServer.
Username Username.
If to-be-published service enables security control, and safety authentication method is "username/password",then needs to provide authorized user account.
Password Password.
Token The token string with access to the to-be-published service.
If to-be-published service enables security control, and safety authentication method is "token",then needs to provide useable token string. Now only supports the token created by HTTP Referer, and HTTP Referer should sets as "ISERVER" when generating the token.
Advanced settings Enable caching SuperMap iServer supports generating cache for this map service provider to improve service access efficency. If you enable the cache option, iServer will generate map cache in local when you access the published services. If it receives the same requests later, it will directly return the cache image and thus improves the access speed for you.

TPK map service provider

TPK map service provider encapsulates GIS function provided by TPK tile package(*.tpk),related parameters are shown in the table below.

Table 19. Configuration parameters of TPK map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider. The default prefix is"tpkMapProvider-".
Basic settings TPK file path [Required Parameter]
TPK file directory.

BaiduMap map service provider

BaiduMap map service provider encapsulates the GIS functions getting from remote BaiduMap online service. The parameters that a user needs to set and their descriptions are shown in the table below.

Table 20. Configuration parameters of BaiduMap map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider. The default prefix is "baiduMapProvider-".
Basic settings Map service address   
Map service address should be an address model that can get map tile, and its {x},{y},{z} represents collumn number,line number and level of tile. e.g:http://online0.map.bdimg.com/tile/?qt=tile&x={x}&y={y}&z={z}&styles=pl
Map name Self defined map name.When configures map service address and not configures this parameter, the default is"baidu".
Advanced settings Enable caching SuperMap iServer supports generating cache for this map service provider to improve service access efficency. If you enable the cache option, iServer will generate map cache in local when you access the published services. If it receives the same requests later, it will directly return the cache image and thus improves the access speed for you.

OpenStreetMap map service provider

Table 21. Configuration parameters of OpenStreetMap map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider. The default prefix is"openStreetMapProvider-".
Basic settings Map service address    
Map service address should be an address model that can get map tile, and its {x},{y},{z} represents collumn number,line number and level of tile of tile.e.g:http://a.tile.openstreetmap.org/{z}/{x}/{y}.png
Map name Self defined map name.When configures map service address and not configures this parameter, the default is"OSM".
Advanced setting Enable caching SuperMap iServer supports generating cache for this map service provider to improve service access efficency. If you enable the cache option, iServer will generate map cache in local when you access the published services. If it receives the same requests later, it will directly return the cache image and thus improves the access speed for you.

Aggregated map service provider

Map service provider with aggregate capacity, used for aggregating multiple map functions.

See reference:The configuration of map function aggregation..

GeoPackage map service provider

GeoPackage map service provider encapsulates the GIS functions provided byGeoPackage map tile package(*.gpkg), the related parameters are shown in the table below.

Table 22. Configuration parameters of GeoPackage map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider. The default prefix is"geopkgMapProvider-".
Basic settings GeoPackage file directory [Required parameter]
GeoPackage file directory.
Map default projection [Required parameter]
After GeoPackage file publishes as map service, map default projection.
Positive direction of axis [Required parameter]
The positive direction of the axis, including RightDown and RightUp. The default value is RightDown.
Original point
 
[Required parameter]
The origin point for cutting map. The format is {x},{y}.

ZXYTiles map service provider

ZXYTiles map service provider encapsulates the GIS functions getting from ZXYTiles file. The parameters that a user needs to set and their descriptions are shown in the table below.

Table 23. Configuration parameters of ZXYTiles map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider.
Basic settings File path [Required parameter]
File path for ZXYTiles.

ArcGIS cache map service provider

ArcGIS cache map service provider encapsulates the GIS functions getting from ArcGIS cache file. The parameters that need  to be set are shown in the following table.

Table 24. ArcGIS cache map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider. The default prefix is "arcgisCacheMapProvider-".
Basic settings Cache configuration file [Required parameter]
The ArcGIS cache configuration file directory. The suffix is .xml or.cdi.

UGCV5(MVT) map service provider

UGCV5(MVT) map service provider encapsulates the GIS functions getting from  UGCV5(MVT)  cache files. The parameters that need  to be set are shown in the following table.

Table 25. UGCV5(MVT) map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider.
Basic settings Configuration file path [Required parameter]  
UGCV5(MVT) cache file directory. The suffix is .sci.

Shape map service provider

Shape map service provider encapsulates the GIS functions getting from  Shape data files. The parameters that need  to be set are shown in the following table.

Table 26. Configuration parameters of Shape map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provide.
Basic settings Shape directory [Required parameter]
The Shape data file path.
Shape file charset [Required parameter]
The encoding format of the Shape file.
Style file Specifies a Mapbox style file for maps to be published, such as: E:\SuperMapiServer\style\style.json. If not set, iServer will use the default style file: [SuperMapiServer installation directory]\webapps\iserver\WEB-INF\config\mapboxstyles\defaultstyle.json.
Advanced settings Disable caching Whether to disable cache.

PostGIS map service provider

PostGIS map service provider encapsulates the GIS functions provided by PostGIS service. The parameters that need  to be set are shown in the following table.

Table 27. Configuration parameters of PostGIS map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider, such as: "postgisMapProvider-".
Basic settings

Host address

[Required parameter]
The address of the PostGIS server.

Port

[Required parameter]
The port number of the PostGIS server.

Database

[Required parameter]
The database used to store tiles.

Username

[Required parameter]
The name of the user who have the permission to access dababase.

Password

[Required parameter]
The password of the user.

Style file

Specifies a Mapbox style file for maps to be published, such as: E:\SuperMapiServer\style\style.json. If not set, iServer will use the default style file: [SuperMapiServer installation directory]\webapps\iserver\WEB-INF\config\mapboxstyles\defaultstyle.json.

Advanced settings

Disable caching Whether to disable cache.

HBase map service provider

HBase map service provider encapsulates the GIS functions provided by HBase service. The parameters that need  to be set are shown in the following table.

Table 28. Configuration parameters of HBase map service provider

  Parameter name Description
General settings Service provider name [Required parameter]
Uniquely identifies this service provider, such as: "hbaseMapProvider-".

Basic settings

DataCatalog

[Required parameter]
The storage directory of Hbase data.
[Required parameter]
 zookeeper address, you can set multiple values, separated by commas.

Style file

Specifies a Mapbox style file for maps to be published, such as: E:\SuperMapiServer\style\style.json. If not set, iServer will use the default style file: [SuperMapiServer installation directory]\webapps\iserver\WEB-INF\config\mapboxstyles\defaultstyle.json.

Advanced settings

Disable caching Whether to disable cache.