Service configuration: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
(One intermediate revision by the same user not shown) | |||
Line 31: | Line 31: | ||
"MapCacheDiscUsageThreshold": 0.95, | "MapCacheDiscUsageThreshold": 0.95, | ||
"CatalogServiceUri": "http://localhost:9008/catalog", | "CatalogServiceUri": "http://localhost:9008/catalog", | ||
"RegisterProtocols": "http" | |||
"RasterServiceInstances": 2, | "RasterServiceInstances": 2, | ||
"VectorServiceInstances": 3, | "VectorServiceInstances": 3, | ||
Line 133: | Line 134: | ||
* '''ServicePort:''' The port on which this computer can be reached from other clients | * '''ServicePort:''' The port on which this computer can be reached from other clients | ||
* '''RegisterAs:''' The hostname on which this computer can be reached from other clients. Use [hostname] to automatically resolve uri to local machine name (f.ex. http://[hostname]:9008). | * '''RegisterAs:''' The hostname on which this computer can be reached from other clients. Use [hostname] to automatically resolve uri to local machine name (f.ex. http://[hostname]:9008). | ||
* '''LogPath:''' The path where the logfiles of all service add-ins are stored | * '''LogPath:''' The path where the logfiles of all service add-ins are stored | ||
* '''LockFilePath:''' The path where the map service add-ins will look for lock files. | * '''LockFilePath:''' The path where the map service add-ins will look for lock files. | ||
Line 144: | Line 144: | ||
* '''SuppressXmlAndJsonRestEndpoints:''' If AutoGenerateRestEndpoints are set, endpoints are generated for explicit xml and json return types unless this value is set to true. This can cause a large number of endpoints to be generated. If these are not required, set SuppressXmlAndJsonRestEndpoints in order to reduce generated endpoint count | * '''SuppressXmlAndJsonRestEndpoints:''' If AutoGenerateRestEndpoints are set, endpoints are generated for explicit xml and json return types unless this value is set to true. This can cause a large number of endpoints to be generated. If these are not required, set SuppressXmlAndJsonRestEndpoints in order to reduce generated endpoint count | ||
* '''AsyncAddinLoading:''' If false, service addins are loaded sequentially. Recommended setting is false in order to ensure deterministic addin loading sequence | * '''AsyncAddinLoading:''' If false, service addins are loaded sequentially. Recommended setting is false in order to ensure deterministic addin loading sequence | ||
== MapCatalogSettings == | == MapCatalogSettings == | ||
Line 157: | Line 155: | ||
* '''MapCacheDiscUsageThreshold:''' If the disc of the computer is x% used, the cache service should stop writing to the database. | * '''MapCacheDiscUsageThreshold:''' If the disc of the computer is x% used, the cache service should stop writing to the database. | ||
* '''CatalogServiceUri:''' The address to the Catalog service add-in. Use [hostname] to automatically resolve uri to local machine name (f.ex. http://[hostname]:9008). | * '''CatalogServiceUri:''' The address to the Catalog service add-in. Use [hostname] to automatically resolve uri to local machine name (f.ex. http://[hostname]:9008). | ||
* '''RegisterProtocols:''' List endpoint protocols that are registered into catalog service. Legal values: http, https, net.tct, net.pipe. | |||
* '''RasterServiceInstances,VectorServiceInstances:''' Number of simultaneous instances of the Raster and Vector service add-ins. | * '''RasterServiceInstances,VectorServiceInstances:''' Number of simultaneous instances of the Raster and Vector service add-ins. | ||
* '''RasterMosaicParams:''' | * '''RasterMosaicParams:''' |
Latest revision as of 08:50, 16 October 2024
The Maria GDK service add-ins are configurable through settings.json, which is located at C:\ProgramData\TeleplanGlobe\TpgServiceHoster\Config
, and which can be edited with a regular text editor. The file must be saved and the TpgServiceHoster service restarted for changes to take effect.
Warning: If this file is changed incorrectly, the service hoster will not be able to start.
{
"Version": "1.0",
"GeneralSettings": {
"ServicePort": 9008,
"BaseUriTemplates": "net.tcp://[hostname]:9009/,http://[hostname]:[port]/,net.pipe://localhost/,https://[FQDN]:9019/",
"AutoGenerateEndpointProtocols": "net.pipe,http",
"SuppressServiceHostConfigFile": false,
"SecondaryBaseUri": "net.pipe://localhost/",
"LogPath": "%ALLUSERSPROFILE%\\TeleplanGlobe\\MariaGDK\\Log",
"LockFilePath": "C:\\MariaGeoData",
"MaxLogFiles": 3,
"MaxLogSize": "10MB",
"HostPid": 0,
"AutoGenerateRestEndpoints": true,
"SuppressXmlAndJsonRestEndpoints": false,
"AsyncAddinLoading": false
},
"MapCatalogSettings": {
"DiscoveryEnabled": false
},
"MapSettings": {
"AlternateRasterMapDataSource": null,
"AlternateVectorMapDataSource": null,
"MapCachePath": "%ALLUSERSPROFILE%\\TeleplanGlobe\\MariaGDK\\MapCaches",
"MapCacheMaxBytesInMemory": 100000000,
"MapCacheDiscUsageThreshold": 0.95,
"CatalogServiceUri": "http://localhost:9008/catalog",
"RegisterProtocols": "http"
"RasterServiceInstances": 2,
"VectorServiceInstances": 3,
"RasterMosaicParams": {
"maxMemorySize": "512000000",
"multiThread": "true"
},
"M6MParams": {
"s52RootPath": "%ALLUSERSPROFILE%\\TeleplanGlobe\\TpgServiceHoster\\Vectoradd-in\\Symbols"
},
"Recycle": {
"Mode": 0,
"Days": 1,
"Time": "2018-07-03T03:00:00",
"Interval": "12:00:00"
}
},
"SymbolServiceSettings": {
"SymbolServiceConfigDir": "%ALLUSERSPROFILE%\\TeleplanGlobe\\MariaGDK\\SymbolService",
"SymbolServiceProviderConfigName": "ProviderConfiguration.xml",
"DiscoveryEnabled": false
},
"DrawObjectSettings": {
},
"DrawObjectRenderingSettings": {
},
"GeoFencingSettings": {
"GeoFencingLogFileType": "GeoFencingNotificationLog",
"GeoFencingLogFileName": "json",
"DiscoveryEnabled": false
},
"MapPreparationSettings": {
"MapPreparationWorkDir": "C:\\temp\\MapPrep",
"MapPreparationBinDir": null,
"MapPreparationUserScriptsDir": null,
"MapPreparationMapDir": "C:\\Data\\MariaGeoData",
"JobMaxLife": "05:00:00",
"DiscoveryEnabled": false
},
"LocationSettings": {
"LocationDefaultDatabase": "%ALLUSERSPROFILE%\\TeleplanGlobe\\MariaGDK\\GeoData\\Locations\\",
"LocationCacheSize": 200000000,
"DiscoveryEnabled": false,
"Datasources": [
{
"Path": "C:\\MariaGeoData",
"RecursionDepth": 3
}
]
},
"TemplateSettings": {
"DiscoveryEnabled": false,
"DataSources": [
{
"IsSavePath": true,
"Path": "C:\\MariaGeoData",
"RecursionDepth": 3
}
]
},
"TemplateEditSettings": null,
"RasterMapPackagesSettings": {
"DataSources": [
{
"IsSavePath": true,
"Path": "C:\\MariaGeoData",
"RecursionDepth": 3
}
]
},
"VectorMapPackagesSettings": {
"DataSources": [
{
"IsSavePath": true,
"Path": "C:\\MariaGeoData",
"RecursionDepth": 3
}
]
},
"TrackSettings": {
"DiscoveryEnabled": false
},
"SymbolPointSettings": {
"DiscoveryEnabled": false,
"DataSources": [
{
"Path": "\\\\tpg-geostore\\testdata\\symbolpoint\\dev\\",
"RecursionDepth": 2
}
]
}
}
GeneralSettings
- ServicePort: The port on which this computer can be reached from other clients
- RegisterAs: The hostname on which this computer can be reached from other clients. Use [hostname] to automatically resolve uri to local machine name (f.ex. http://[hostname]:9008).
- LogPath: The path where the logfiles of all service add-ins are stored
- LockFilePath: The path where the map service add-ins will look for lock files.
- MaxLogFiles: The maximum number of old logfiles to keep from each service add-in
- MaxLogSize: The maximum size of each logfile
- BaseUriTemplates: Provides services with information about how to generate endpoints. These are used for all protocols specified in AutoGenerateEndpointProtocols
- AutoGenerateEndpointProtocols: Endpoints are generated for all listed protocols using BaseUriTemplates. Legal values: http, https, net.pipe, net.tcp
- SuppressServiceHostConfigFile: If true, app.config endpoints are ignored. If false, app.config endpoints are instantiated prior to any auto generated endpoints
- AutoGenerateRestEndpoints: If true, web service endpoints are generated automatically
- SuppressXmlAndJsonRestEndpoints: If AutoGenerateRestEndpoints are set, endpoints are generated for explicit xml and json return types unless this value is set to true. This can cause a large number of endpoints to be generated. If these are not required, set SuppressXmlAndJsonRestEndpoints in order to reduce generated endpoint count
- AsyncAddinLoading: If false, service addins are loaded sequentially. Recommended setting is false in order to ensure deterministic addin loading sequence
MapCatalogSettings
- DiscoveryEnabled: If set to true, the map catalog can be discovered using WCF UDP discovery
MapSettings
- MapCachePath: Path where the Cache service add-in will store cached maps.
- MapCacheMaxBytesInMemory:
- MapCacheDiscUsageThreshold: If the disc of the computer is x% used, the cache service should stop writing to the database.
- CatalogServiceUri: The address to the Catalog service add-in. Use [hostname] to automatically resolve uri to local machine name (f.ex. http://[hostname]:9008).
- RegisterProtocols: List endpoint protocols that are registered into catalog service. Legal values: http, https, net.tct, net.pipe.
- RasterServiceInstances,VectorServiceInstances: Number of simultaneous instances of the Raster and Vector service add-ins.
- RasterMosaicParams:
- maxMemorySize: The maximum amount of memory allowed for GDAL-based rendering (raster formats other than GeoPackage, MBTiles, QM2 and ECW).
- maxDatasetAge: Maximum number of seconds to keep a dataset in memory since it was last used. Default is 0, which means keep it indefinitely.
- multiThread: Use multithreading when reprojecting/tiling datasets. Only relevant for GDAL-based data sets.
- useIndexFiles: (true/false) - Use index files to improve startup time for raster services with very large datasets. Default: true
- indexFilePath: Directory for index files. Default: %ALLUSERSPROFILE%\TeleplanGlobe\MariaGDK\MapIndex
- Recycle: Recycling of map services.
- Mode: The type of recycling. Disabled - no recycling, Specific - recycles the services at a specific time and days, Interval - recycles the services at a time interval.
- Days: The number of days between recycles for Specific mode.
- Time: The time of the day to recycle for Specific mode.
- Interval: The recycle interval/time-span for Interval mode.
- M6MParams:
- s52RootPath: Location of s52 symbol files utilized by the Vector service add-in.
- datasetindexpath: Directory for index files. Default: %ALLUSERSPROFILE%\TeleplanGlobe\MariaGDK\MapIndex
SymbolServiceSettings
- SymbolServiceConfigDir:
- SymbolServiceProviderConfigName:
- DiscoveryEnabled: If set to true, the add-in can be discovered using WCF UDP discovery
MapPreparationSettings
- MapPreparationWorkDir: Folder to store Map Preparation scripts and tools, as well as temporary files.
- MapPreparationMapDir: Folder to store completed map packages
- JobMaxLife: (hh:mm:ss) Maximum amount of time a Map Preparation job is allowed to exist.
- DiscoveryEnabled: If set to true, the add-in can be discovered using WCF UDP discovery
TemplateSettings
- DiscoveryEnabled: If set to true, the add-in can be discovered using WCF UDP discovery
- DataSources
- IsSavePath: (true/false) Use the path below to save template files
- Path: The path to search for template files
- RecursionDepth: Specifies how deep in the folder structure to look for template files
RasterMapPackagesSettings
- DataSources
- IsSavePath: (true/false) Use the path below to save raster map package files
- Path: The path to search for raster map package files
- RecursionDepth: Specifies how deep in the folder structure to look for raster map package files
VectorMapPackagesSettings
- DataSources
- IsSavePath: (true/false) Use the path below to save vector map package files
- Path: The path to search for vector map package files
- RecursionDepth: Specifies how deep in the folder structure to look for vector map package files
TrackSettings
- DiscoveryEnabled: If set to true, the add-in can be discovered using WCF UDP discovery
GeoFencingSettings
- GeoFencingLogFileType The log file type. Typically xml or json
- GeoFencingLogFileName The log file to use
- DiscoveryEnabled: If set to true, the map catalog can be discovered using WCF UDP discovery
LocationSettings
- LocationDefaultDatabase Default location database to use
- LocationCacheSize Cache size to allow
- Datasources Datasource to look for location databases
- DiscoveryEnabled: If set to true, the map catalog can be discovered using WCF UDP discovery
SymbolPointSettings
- DataSources
- Path: The path to search for symbol point products
- RecursionDepth: Specifies how deep in the folder structure to look for symbol point products
- DiscoveryEnabled If set to true, the symbol point service can be discovered using WCF UDP discovery