The properties of service configurations are maintained in a file for each configuration in the GIS server's cfg directory. When you add a new service configuration to the GIS server, a new configuration file is automatically created. When a configuration is deleted, its configuration file is deleted from the cfg directory.
The name of a configuration file for a service will follow the pattern <configuration name>.<service type>.cfg. For example, a Map service called Redlands would have the name Redlands.MapServer.cfg.
It's possible to add a configuration to the GIS server by manually creating a configuration file in the cfg directory, and it's possible to delete a configuration by deleting its file from the cfg directory. In both cases, the new or deleted configuration will not be recognized by the server until the SOM is restarted. If the SOM encounters a corrupted configuration file, the SOM will log a warning and ignore the configuration.
Service configuration tags
The following are the tags, their meanings, and example values in a service configuration file:
<Description>
An optional string that is the description of the service configuration.<Properties>
The list of properties of the service configuration. The subtags are properties specific to the service configuration type. The following table lists which properties subtags each type of service supports. The table is followed by a description of each tag, in alphabetical order.| MapServer | GeocodeServer | GeodataServer | GlobeServer | GPServer |
|---|---|---|---|---|
| FilePath | Locator | FilePath | FilePath | MapFile |
| SupportedImageReturnTypes | LocatorWorkspacePath | OutputDir | MaxRecordCount | DataFrame |
| MaxRecordCount | LocatorWorkspaceConnectionString | VirtualOutputDir | MaxBufferCount | Toolbox |
| MaxBufferCount | SuggestedBatchSize | ConnectionCheckInterval | CacheDir | JobsDirectory |
| MaxImageWidth | MaxBatchSize | MaxRecordCount | SOMCacheDir | JobsVirtualDirectory |
| MaxImageHeight | MaxResultSize | ExecutionType | ||
| OutputDir | ConnectionCheckInterval | OutputDir | ||
| VirtualOutputDir | VirtualOutputDir | |||
| CacheDir | MaximumRecords | |||
| SOMCacheDir | ||||
| ConnectionCheckInterval |
<CacheDir>
MapServer, GlobeServerA string that represents the path to a location on the file system where the map or globe cache is stored. For globe services, the path should always end with "\GlobeCache".
<ConnectionCheckInterval>
MapServer, GeocodeServer, GeodataServerAn integer representing the number of seconds the service will wait before checking if ArcSDE servers that have become unavailable are once again available. Once the ArcSDE server is available, the service instance will be replaced to repair the connection to the ArcSDE server. By default, this property is not included in the .cfg file and this time is set to 300 seconds. You can add this tag to the .cfg file to modify this time. You can disable this behavior by specifying a value of 0.
<DataFrame>
GPServerA string representing the name of the data frame containing the tool layer associated with the geoprocessing service. This tag is not used when the geoprocessing service is associated with a toolbox only.
<ExecutionType>
GPServerA string that denotes whether geoprocessing jobs will be run in a Synchronous or Asynchronous manner.
<FilePath>
MapServer, GeodataServer, GlobeServerA string representing a path to the document that the service configuration will serve. For GeodataServer, this is the path to the sde file containing the sde connection information, or it can represent a path to a personal geodatabase.
<JobsDirectory>
GPServerA string representing the path to the server jobs directory associated with the service. Jobs directories are used by geoprocessing services for writing scratch and output data.
<JobsVirtualDirectory>
GPServerA string that represents the URL of the virtual directory that points to the physical location specified in the <JobsDirectory> tag.
<Locator>
GeocodeServerA string that represents the name of the address locator for a GeocodeServer
<LocatorWorkspaceConnectionString>
GeocodeServerA string that contains parameters for a connection to a locator stored in a geodatabase.
<LocatorWorkspacePath>
GeocodeServerA required string for file-based locators that represents the path to the location on disk where the locator file is stored.
<MapFile>
GPServerA string representing the path to the map document containing the tool layers associated with the geoprocessing service. This tag is not used when the geoprocessing service is associated with a toolbox only.
<MaxBatchSize>
GeocodeServerAn integer that represents the maximum number of result records returned by the FindAddressCandidates method on a GeocodeServer.
<MaxBufferCount>
MapServer, GlobeServerAn integer that represents the maximum number of features that can be buffered by the service at draw time per layer.
<MaxImageHeight>
MapServerAn integer representing the maximum height (in pixels) of images the MapServer will export.
<MaxImageWidth>
MapServerAn integer representing the maximum width (in pixels) of images the MapServer will export.
<MaximumRecords>
GPServerAn integer representing the maximum number of records that will be returned by a geoprocessing job.
<MaxRecordCount>
MapServer, GeodataServer, GlobeServerAn integer that represents the maximum number of result records that can be returned by query, find, and identify operations on a map or globe service, or by the TableSearch method on a geodata service.
<MaxResultSize>
GeocodeServerAn integer that represents the maximum number of result records returned by the FindAddressCandidates method on a GeocodeServer.
<OutputDir>
MapServer, GeodataServer, GPServerA string that represents the path to a location on the file system to which the service will write its output. When you create a new service configuration, this property is copied from the server output directory path that you specified. If you want the service's output to be cleaned by the GIS server, this path should be a path to a server output directory.
<SOMCacheDir>
MapServer, GlobeServerA string representing the path to the server cache directory used by the service. Note that this tag only contains the path of the cache directory; the full path to the cache is specified in the <CacheDir> tag.
<SuggestedBatchSize>
GeocodeServerAn integer that represents the number of records that will be located at a time for batch geocoding.
<SupportedImageReturnTypes>
MapServerPossible values are MIME or URL. Specifies whether images will be returned as MIME data or written to disk (MIME + URL). If you choose URL, you must have a server directory specified for the configuration.
<Toolbox>
GPServerA string representing the path to the toolbox associated with the geoprocessing service. This tag is not used when the geoprocessing service is associated with a tool layer in a map document. In that event, the MapFile and DataFrame tags would be used.
<VirtualGlobeCacheDir>
GlobeServerA string that represents the URL of the virtual directory that points to the physical location specified in the <GlobeCacheDir> tag. For globe services only.
<VirtualOutputDir>
MapServer, GeodataServer, GPServerA string that represents the URL of the virtual directory that points to the physical location specified in the <OutputDir> tag. When you create a new service configuration, this property is copied from the server directory's URL that you specify. For globe services only.
The following is an example of the <Properties> tag and some of its subtags for a MapServer configuration:
The following is an example of the <Properties> tag and some of its subtags for a GeocodeServer configuration whose locator is an ArcSDE locator:
<Extension>
The extension tag appears for each type of server object extension, or capability, that the configuration supports. The extension tag contains subtags that further describe the extension.
<TypeName>
The name of the type of server object extension—MobileServer, for example.
<Enabled>
A boolean property that specifies whether the extension is enabled (true) for that configuration or not (false).
<Properties>
Some server object extensions may have unique properties that are detailed here in subtags.
<Info>
This tag contains the WebEnabled and WebCapabilities subtags that describe the level of Web access for a service.
<WebEnabled>
A boolean property that describes whether clients will be able to access the service through HTTP. The default is true. Note: This tag must have <Info> as a parent tag.
<WebCapabilities>
A comma-delimited string that contains the allowed operations for the service. Allowed operations describe what a client can do with a service. Specifically, they refer to the groups of methods from the service's Web service description language (WSDL) that clients will be able to call. For a list of operations by service type, see Securing a service. Note: This tag must have <Info> as a parent tag.
<Recycling>
The list of recycling properties of the service configuration. This tag contains subtags <Start> and <Interval>. Note: If the <Recycling> tag is missing, or any of its subtags are invalid, recycling will be switched off for the configuration.
<StartTime>
A required string that represents the recycling start time, which is the first time at which recycling will occur for the service configuration. The time specified is in 24-hour notation. For example, to set the start time at 2:00 p.m., the StartTime property would be 14:00. The default is 00:00, meaning that recycling will happen for the first time at Midnight.
<Interval>
A required integer that defines the time between recycling operations in seconds. For example, to recycle the configuration every hour, this property would be set to 3600. The default value is 86400, meaning recycling will happen once every 24 hours.
The following is an example of the <Recycling> tag and its subtags:
<MinInstances>
An integer specifying the minimum number of instances for the service's pool. The default is 0.
<MaxInstances>
An integer specifying the maximum number of service instances that can be running at any time. The default is 0.
<WaitTimeout>
An optional integer specifying the maximum amount of time in seconds allowed between a client requesting a service and getting a service. The default is 60.
<UsageTimeout>
An optional integer specifying the maximum amount of time in seconds a client can hold onto a service before it is automatically released. The default is 600.
<IsPooled>
A required string indicating whether the services created by this configuration are pooled (true) or not pooled (false).
<Isolation>
A required string indicating if the configuration's service has high isolation (high) or low isolation (low).
<StartupType>
An optional string that specifies if the configuration is started by the SOM when the SOM starts, or if it needs to be manually started by an administrator. The valid values are "automatic" or "manual". The default is "automatic".
The following is an example of some of these tags:
