Configuration and log files

Transcription

1 B Configuration and log files The ArcGIS manages a set of files that are written by the server manager. These files can be grouped into two categories: log files and configuration files. Understanding the structure of these files and how to use them will be critical for an ArcGIS administrator. This appendix gives a description of the structure and content for both the log and configuration files, including details of how to interpret and use them.

2 ARCGIS SERVER LOG FILES ArcCatalog Properties page General tab The ArcGIS logs events that occur in the server, and any errors associated with those events, to log files. Events such as when server s are started, when server contexts are created, and when machines are added to the server are some of the examples of events logged by the server. The server manager (SOM) is the centralized logging mechanism for ArcGIS server. Through the SOM, all events that occur within the SOM, events that occur in server containers (SOCs), and their contained s are logged by the SOM. The logs are actually a pair of files: an XML file and a.dat file. The XML file contains the <log> tags, and the.dat file contains the messages that are constantly being appended. You can open the XML file in any XML aware tool to view the messages in the.dat file. By default, these log files are written to <install_location>\log on the SOM machine. Each time the SOM service starts, a new log file is created, and the server will continue to write messages to that log until it reaches the maximum log size. Once the log file exceeds the maximum size, it is retired and a new log file is created. By default, the maximum log size is 10 megabytes. Log messages can vary in their level of severity from error, which indicates a problem that requires immediate attention, to detailed, which is a common message generated through regular use of the server. The messages that are logged are defined by the log level that is set in the server. The following are the ArcGIS s logging levels: 0 (None): No logging 1 (Error): Serious problems that require immediate attention are logged. 2 (Warning): Problems that require attention and errors are logged. 3 (Normal): Common administrative messages of the server, warnings, and errors are logged. 4 (Detailed): Common messages from user use of the server, including server s, normal messages, warnings, and errors are logged. 5 (Debug): Verbose messages to aid in troubleshooting; detailed messages, normal messages, warnings, and errors are logged. By default, the log level of the server is set to level 3 (Normal), meaning messages whose severity is Error, Warning, or Normal will be logged. All messages whose level is Detailed or Debug are not logged. The log location, maximum log size, and logging level can be changed at any time using either ArcCatalog or the server API. Changes made will be reflected immediately in the server. The log properties can also be modified by editing the.cfg configuration file. In that case, the changes will not be reflected until the SOM is stopped and restarted. 522 ArcGIS Administrator and Developer Guide

3 ARCGIS SERVER LOG FILES ArcCatalog Properties page Statistics tab USING THE LOG FILES Log files are an important tool for monitoring and troubleshooting problems with your GIS server. GIS server administrators will monitor the server s statistics and use the statistics to help determine when they need to consult the log files. The GIS server s statistics give general information about the state of the GIS server and whether errors have been occurring. The statistics are available to server administrators through ArcCatalog. Through both the GIS server s statistics and reports from users of the system, administrators will be confronted with errors and other problems occurring in the system. The log files provide the information to identify what the errors are and, through the information in the log, infer what to investigate to solve the problem. For example, an administrator may view the server statistics and note that there were a number of errors associated with creating new server s in the server. By further examining the statistics, the problem area can be narrowed down to a particular server container machine. The information in the log file can then be used to determine what errors have been logged and to discover, for example, that the server container machine on which the errors were occurring did not have access to the output directory. Using this information, the administrator can rectify the directory access problem, then use statistics and the log files to determine if the error occurs again. The log files also serve as a history of the statistics and events that occur over time in the server. The server s statistics are in memory and are accumulated summaries of time slices since the GIS server started. The granularity of these time slices is more coarse the further back in time you go. Statistics are also cleared when the server is stopped. The GIS server s logs maintain a record of all events in the server and are not deleted when the server is stopped. READING THE LOG FILES The information contained in the log file messages has a consistent structure. Understanding this structure is important when interpreting the information in the log files. Log message structure Loggable messages are generated by many subsystems of ArcGIS. Messages are generated as a result of SOM startup and administrative and user usage. Each message has a target that can be either or a server. -targeted messages log events associated with the core functionality of the SOM, while server messages log events associated with a specific server configuration and instances of that server configuration. Independent of target, all loggable messages have six explicit properties: time, level, code, target, thread, and message. The time is the time at which the logged event occurred. The level is the level of detail of the message in relation to other messages (as described above, the levels are: Error, Warning, Normal, Detailed, and Debug). The code is the result code associated with the message. The target is either or the name of a server configuration associated with the message. Thread is the SOM process thread that generated the message. Finally, Appendix B Configuration and log files 523

4 ARCGIS SERVER LOG FILES message is the human-readable description of the logged event that includes the process and thread IDs of the container processes where the that generated the message is running and the server container machine on which that process is running (if applicable). The message may contain any error description that comes from the server itself, such as an error indicating that it cannot write its output. Additional properties that may be included with certain messages include machine and elapsed. Machine indicates the server container machine for which the event occurred. For example, the sever may log an error that a server context for a particular server configuration could not be created on a particular machine. Only those messages that apply to statistics that are recorded for a specific machine will include a machine property. The elapsed property is the time it took for the event that is being logged to complete. For example, the create server event has an elapsed time to indicate the amount of time it took to create the server instance. The following is an example of a typical log message. This log message indicates that an instance of the Yellowstone map server was created on the server container machine padisha, and it took seconds to create the. <Msg time=" t14:36:05" level="detailed" code="4004" target="yellowstone.map" machine="padisha" thread="2936" elapsed="2.443"> Object instance is successfully created on machine padisha. </Msg> Message targets As described above, the targets for the log messages can be or a server. Messages associated with server s have the name and type of the server as the target property. For example, the Yellowstone map server will appear as Yellowstone.Map. There are two additional targets that will appear in the log that are internal server configurations. While the administrator does not manage these configurations directly, errors may still occur with them that need to be dealt with. The internal server s are SDM.DirectoryManager and Engine. SDM.DirectoryManager is the that cleans files from the GIS server s server directories. An instance of the SDM.DirectoryManager is created when the SOM starts. Each time a directory is cleaned, this instance of SDM.DirectoryManager does the cleaning for all server directories. Any errors it encounters are reported. Errors that are typically reported by SDM.DirectoryManager include the inability to access a directory it needs to clean. 524 ArcGIS Administrator and Developer Guide

5 ARCGIS SERVER LOG FILES Each time a server directory is created or removed, the SDM.DirectoryManager is stopped and restarted. The Engine.Engine server represents the empty server context configuration. When a client asks to create an empty context, the Engine.Engine configuration creates one for the client. Code Meaning Target Comments 1000 Add machine failed Error logged if you attempt to add a new server container machine that does not exist or cannot be found by the SOM Remove machine failed Error logged if removing a machine fails Illegal configuration name Error logged when you attempt to add a server configuration whose name contains illegal characters Load server configuration failed 1004 Add server configuration failed 1005 Delete server configuration failed 1006 Stopped server configuration failed 1007 Pause server configuration failed 1008 Start server configuration failed Error logged when the server cannot load a server configuration, for example, if the server configuration file is corrupt or contains invalid values. Error logged when adding a new server configuration fails, for example, if you attempt to add a server configuration with the same name and type as an existing server configuration. Error logged when deleting a server configuration fails, for example, if you attempt to delete a server configuration that does not exist. Error logged when stopping a server configuration fails, for example, if you attempt to stop a server configuration that is already stopped. Error logged when pausing a server configuration fails, for example, if you attempt to pause a stopped or already paused server configuration. Error logged when starting a server configuration fails, for example, if you attempt to start an already started configuration, or none of the minimum instances could be started type not found Error logged when a server configuration is trying to use a server type that is not registered with the server. The registered types are Map and Geocode Failed to load the server configuration file 1013 Failed to create a server context 1014 Failed to create a server container process 1015 Failed to create a thread in a container process 1016 Failed to create a server in a container process thread 1017 Container process crashed Error logged when the.cfg cannot be read on SOM startup, for example, if the SOM startup encounters a corrupted.cfg or if.cfg contains invalid values. Errors logged if the server fails to create a server context for a client, for example, if the client asks the server to create a context for a server configuration that does not exist. Error logged if the server failed to create a new container process on one of the server container machines. Error logged if the server failed to create a new thread in a container process on one of the server container machines. Error logged if an instance of a server failed to create on a server container machine. Look at the message for more specific error information. Error logged if a container process containing server s for the target server configuration crashes. If this is a pooled server, the server will create a new process and server s to repopulate the pool. Error logged if a server directory has an invalid path directory has invalid path 1019 Add server directory failed Error logged if the addition of a server directory failed. This can happen if you attempt to add a server directory if one already exists Delete server directory failed Error logged if the deletion of a server directory failed. This can happen if you attempt to delete a server directory that does not exist Update server directory failed Error logged if the update of a server directory failed. This can happen if you attempt to update a server directory that does not exist types file not found 1023 type not registered Error logged if the server types file cannot be found when the SOM starts. The server types file is <install_location>\bin\types.txt Error logged if the server types file is empty. The server types file is <install_location>\bin\types.txt Appendix B Configuration and log files 525

6 ARCGIS SERVER LOG FILES Log codes The codes are numbered based on the following: : Messages that are generated and written by the SOM and greater: Messages that are generated by the server components themselves (Map, Geocode, SDM.DirectoryManager, Engine.Engine). Code Meaning Target Comments 2000 container machine not found Message logged if the SOM attempts to create a new container process or thread on a machine that it can t find. This error will typically occur if the machine becomes unavailable (due to a network problem) while the SOM is running container machine exists 2002 configuration exists 2003 configuration is not found 2006 The minimum and maximum instance values are invalid Message logged when you attempt to add a server container machine that has already been added to the GIS server. Message logged when you attempt to add a new server configuration with the same name and type as an existing server configuration. Message logged when a client requests a server configuration that does not exist. When adding or updating server configuration, minimum or maximum instances specified are invalid, for example, a minimum that is larger than the maximum. A client held onto a server for longer than its usage time-out, and the server automatically released it. An instance of a server took longer to create than the creation time-out, and the server cancelled the creation A server context s usage time-out was exceeded 2008 A server s creation time-out was exceeded 2009 configuration not found Message logged if while the SOM is running, it cannot read the.cfg file configuration contains an invalid parameter Message logged if the SOM encounters invalid tags or values when reading the.cfg file A server directory was not found Message logged if you attempt to find or delete a server directory that does not exist directory exists Message logged if you attempt to add a new server directory that already exists. Code Meaning Target Comments 4000 Container process created This message is logged each time a container process for the target server configuration is started on a server container machine Thread created in a container process This message is logged each time a thread is created in a container process for the target server configuration Container process removed 4003 Thread removed from a container process 4004 created in a server container thread 4006 context created 4007 context released 4008 Recycling started 4009 Recycle next This message is logged each time a container process for the target server configuration is removed from a server container machine. This message is logged each time a thread is removed from a container process for the target server configuration. This message is logged each time an instance of a server is created in a thread within a container process for the target server configuration. The elapsed time logged is the amount of time taken to create the server. This message is logged any time a client calls CreateContext for the target server configuration. The elapsed time is the wait time between the call to CreateContext and when the client receives the server context. This message is logged any time a client calls ReleaseContext for a context created for the target server configuration. The elapsed time is the usage time between when the client s call to CreateContext is completed and when the client is released. Message logged when the target server configuration recycling is started. Message logged when an instance of the target server configuration is recycled. 526 ArcGIS Administrator and Developer Guide

7 ARCGIS SERVER LOG FILES Some codes can apply to messages of different levels, for example, a message with a code may be an error for one event, while it may be a warning for another event. These tables summarize the log codes, their meaning, and the applicable targets. Code Meaning Target Comments 3000 container machine added Message logged when the user adds a new server container machine to the GIS server container machine deleted Message logged when the user removes a server container machine from the GIS server configuration load begin Message logged for each server configuration when the SOM starts configuration add begin Message logged when the server attempts to add a server configuration. This event occurs when you either add a new or update an existing server configuration configuration delete begin 3005 configuration stop begin 3006 configuration pause begin 3007 configuration start begin 3008 configuration loaded 3009 configuration added 3010 configuration deleted 3011 configuration stopped 3012 configuration paused 3013 configuration started 3014 manager started Message logged when the server attempts to delete a server configuration. This event occurs when you either delete or update a server configuration. Message logged when the server attempts to stop a server configuration. Message logged when the server attempts to pause a server configuration. Message logged when the server attempts to start a server configuration. This message is not logged when server configurations are started during SOM startup. This message is logged for each server configuration that was successfully loaded on starting the SOM. This message is logged after a message with code If the load failed, an error with code 1003 is logged. Message logged when the SOM starts and successfully adds the SDM (DirectoryManager) and internal Engine server configurations. Message logged when a server configuration is deleted. Message logged when a server configuration is stopped. Message logged when a server configuration is paused. Message logged when a server configuration is started. Note that a successful start may occur after errors have been logged. Message logged when the SOM has successfully started. Note that a successful start may occur after errors have been logged. Message logged when the SOM is stopped. No additional messages will be added to a log file after this message manager stopped 3016 configuration loaded Message logged when the SOM starts and the information in.cfg is successfully loaded directory added Message logged when a new server directory is added to the server directory updated This message is logged when the properties of a server directory are updated directory deleted Message logged when a server directory is deleted from the server. Appendix B Configuration and log files 527

8 The ArcGIS administrator manages the various configuration properties of both the GIS server and its collection of server s. All of these properties are maintained by the server in a collection of configuration files. These configuration files are read by the SOM when its started, and they define such things as the set of server container machines, the output directories, the server configurations, their pooling model, and so on. The properties of the server itself are maintained in a file called.cfg, while the properties of each of the server s server configurations are maintained in files called <server configuration name>.<server type>.cfg. For example, the configuration file for the map server configuration called Yellowstone would be Yellowstone.Map.cfg. These configuration files are in XML and are located in the <install_location>\cfg folder on the SOM machine. When properties of the server and its configurations are set or modified using ArcCatalog, these changes are reflected in both the GIS server and the appropriate configuration file. Developers can also change these properties using the server API to update the server s properties and to create, update, and delete the server s configurations. The server s configuration files can also be modified manually using a text editor. Unlike using ArcCatalog or the server API, any changes made to the server s configuration files manually are not reflected in the server until it is restarted. While this appendix documents the structure of these files, it is recommended that you use ArcCatalog or the server API to create and modify their contents, which is done indirectly though modifying the server s properties. The remainder of this appendix details the content and use of the server configuration files. THE SERVER.CFG CONFIGURATION FILE The server s properties are maintained in the.cfg configuration file. The contents of this file are read when the SOM is started. The server will report a successful start once this file has been successfully read and any initialization detailed in it completed. If there are errors in the file, the SOM will log an error and attempt to start using default values for the missing or invalid properties. When the SOM is installed on a machine, the.cfg file does not exist..cfg is created after the SOM is started, and either a server container machine or a server directory is added to the GIS server. The following is an example of a.cfg file for a GIS server with a single container machine (padisha) and a single output directory (\\padisha\images), whose logging level is 3. <> <Machines> <Machine> <Name>padisha</Name> <Description> container machine 1</Description> </Machine> </Machines> <Directories> 528 ArcGIS Administrator and Developer Guide

9 The IObjectAdmin interface provides the methods and properties for updating the GIS server s properties and, therefore, the contents of.cfg. <Directory> <Path>\\padisha\images</Path> <URL> <Description>default output location</description> <Cleaning>sliding</Cleaning> <MaxFileAge>600</MaxFileAge> </Directory> </Directories> <Properties> <LogPath>C:\Program Files\ArcGIS\log\</LogPath> <LogSize>10</LogSize> <LogLevel>3</LogLevel> <ConfigurationStartTimeout>300</ConfigurationStartTimeout> <EngineContextTimeout>600</EngineContextTimeout> </Properties> </> IObjectAdmin : IUnknown Properties: IPropertySet AddConfiguration (in config: IObjectConfiguration) AddMachine (in machine: IMachine) AddDirectory (in psd: IDirectory) CreateConfiguration: IObjectConfiguration CreateMachine: IMachine CreateDirectory: IDirectory DeleteConfiguration (in Name: String, in TypeName: String) DeleteMachine (in machinename: String) DeleteDirectory (in Path: String) GetConfiguration (in Name: String, in TypeName: String) : IObjectConfiguration GetConfigurations: IEnumObjectConfiguration GetConfigurationStatus (in Name: String, in TypeName: String) : IObjectConfigurationStatus GetMachine (in Name: String) : IMachine GetMachines: IEnumMachine GetDirectories: IEnumDirectory GetDirectory (in Path: String) : IDirectory GetTypes: IEnumObjectType PauseConfiguration (in Name: String, in TypeName: String) StartConfiguration (in Name: String, in TypeName: String) StopConfiguration (in Name: String, in TypeName: String) UpdateConfiguration (in config: IObjectConfiguration) UpdateMachine (in machine: IMachine) UpdateDirectory (in psd: IDirectory) Provide access to members that administer the GIS server. The logging properties for the GIS server. Adds a server configuration (created with CreateConfiguration) to the GIS server. Adds a host machine (created with CreateMachine) to the GIS server. Adds a server directory (created with CreateDirectory) to the GIS server. Creates a new server configuration. Creates a new host machine. Creates a new server directory. Deletes a server configuration from the GIS server. Deletes a host machine from the GIS server, making it unavailable to host server s. Deletes a server directory such that its cleanup is no longer managed by the GIS server. It does not delete the physical directory from disk. Get the server configuration with the specified Name and TypeName. An enumerator over all the server configurations. Get the configuration status for a server configuration with the specified Name and TypeName. Get the host machine with the specified Name. An enumerator over all the GIS server's host machines. An enumerator over the GIS server's output directories. Get the server directory with the specified Path. An enumerator over all the server types. Makes the configuration unavailable to clients for processing requests, but does not shut down running instances of server s or interrupt requests in progress. Starts a server configuration and makes it available to clients for processing requests. Stops a server configuration and shuts down any running instances of server s defined by the configuration. Updates the properties of a server configuration. Updates the properties of a host machine. Updates the properties of a server directory. Appendix B Configuration and log files 529

10 .cfg tags The following are the tags, their meanings, and example values in a.cfg file. <Machines> The list of server container machines. This tag contains <Machine> subtags for each server machine. <Machine> A server container machine. This tag contains two subtags: <Name> and <Description>. <Name> The ArcCatalog ArcGIS Properties page Hosts tab A string that represents the name of the server container machine. If this tag is missing, the rest of the <Machine> tag is ignored. On start, the SOM does not validate that the value of this tag is a valid server container machine. If it s invalid, errors will be logged as the SOM attempts to create server s on it. The machine names must be unique. Duplicate machines will be ignored. <Description> An optional string that describes the server container machine. The following is an example of the <Machine> tag, <Machine> tag, and its subtags. The ArcCatalog ArcGIS Properties page Directories tab <Machines> <Machine> <Name>padisha</Name> <Description> container machine 1</Description> </Machine> <Machine> <Name>melange</Name> <Description> container machine 2</Description> </Machine> </Machines> <Directories> The list of server directories. This tag contains <Directory> subtags for each server directory. <Directory> A server directory. This tag contains the required subtag <Path> and a number of optional subtags. <Path> A string that represents the path of the server directory. This property is required and must be unique per server. Directories with duplicate <Path> tags will be ignored. Note, however, that if a single location has multiple paths for example, two shares with different names the SOM will not recognize those as being the same directory. 530 ArcGIS Administrator and Developer Guide

11 <URL> An optional string that represents the URL of a virtual directory that points to the physical location specified in the <Path> tag. The URL will be in URL form as in <Description> An optional string that is a description of the server directory. <Cleaning> An optional string that specifies the server directory s cleaning mode. Valid values are off, sliding, or absolute. If <Cleaning> is off, then the server will not clean up its files in the directory. If <Cleaning> is sliding, then the server will delete files for which the time specified by the <MaxFileAge> tag has elapsed since they were last accessed. If <Cleaning> is absolute, then the server will delete files for which the time specified by the <MaxFileAge> tag has elapsed since they were created. If this tag is missing, the default value is sliding. <MaxFileAge> An optional integer (greater than 0) that represents the amount of time in seconds that needs to elapse since files were last accessed (sliding) or were created (absolute) before they are deleted. If this tag is missing, the default is 10. The following is an example of the <Directory> tag, <Directory> tag, and its subtags. <Directories> <Directory> <Path>\\padisha\images</Path> <URL> <Description>default output location</description> <Cleaning>sliding</Cleaning> <MaxFileAge>600</MaxFileAge> </Directory> <Directory> <Path>\\melange\Output</Path> <URL> <Description>large file location</description> <Cleaning>absolute</Cleaning> <MaxFileAge>6000</MaxFileAge> </Directory> </Directories> <Properties> The list of properties of the GIS server, including the logging properties and server creation time-out. All the subtags of Properties are optional. <LogPath> An optional string representing the path to the location on disk that log files are written. The default is <install_location>\log. Note, the GIS server account must have write access to this location. Appendix B Configuration and log files 531

12 <LogSize> An optional integer representing the size to which a single log file can grow (in MB) before a new log file is created. The default is 10. <LogLevel> An optional integer that indicates the level of detail that the server logs. The levels are: 0 (None): No logging 1 (Error): Serious problems that require immediate attention are logged. ArcCatalog Properties page General tab 2 (Warning): Problems that require attention and errors are logged. 3 (Normal): Common administrative messages of the server, warnings, and errors are logged. 4 (Detailed): Common messages from user use of the server, including server s, normal messages, warnings, and errors are logged. 5 (Debug): Verbose messages to aid in troubleshooting, detailed messages, normal messages, warnings, and errors are logged. The default log level is 3. <ConfigurationStartTimeout> An optional integer that represents the time in seconds that the GIS server will wait for a server instance to start. If a server takes longer to start than <ConfigurationTimeout>, then it will time out and an error will be logged. The default time-out is 300. <EngineContextTimeout> An optional integer that represents the maximum amount of time in seconds a client can hold on to an empty server context before it is automatically released. The default is 600. The following is an example of the <Properties> tag and its subtags. <Properties> <LogPath>C:\Program Files\ArcGIS\log\</LogPath> <LogSize>10</LogSize> <LogLevel>3</LogLevel> <ConfigurationStartTimeout>300</ConfigurationStartTimeout> <EngineContextTimeout>600</EngineContextTimeout> </Properties> THE SERVER OBJECT CONFIGURATION FILES The properties of server configurations are maintained in a file for each server configuration. A GIS server s set of configurations is defined by the list of configuration files in the cfg directory. When a new configuration is added to the GIS server, a new file is created. When a configuration is deleted, its file is deleted from the cfg directory. A Map server configuration will have a file called <configuration_name>.map.cfg, and a Geocode server configuration will have a file named <configuration_name>.geocode.cfg. 532 ArcGIS Administrator and Developer Guide

13 For example, a GIS server that has map server s called USA, Redlands, and Yellowstone and geocode server s named Portland and USAStreets would have the following files in its cfg directory: Portland.Geocode.cfg Redlands.Map.cfg.cfg USA.Map.cfg USAStreets.Geocode.cfg Yellowstone.Map.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. The following is an example of a server configuration file for a Map: <ObjectConfiguration> <Description>Map server containing vegetation data for Yellowstone National Park</Description> <Properties> <FilePath>D:\ArcGIS Data\DocDevScenarioData\Yellowstone\Yellowstone.mxd</ FilePath> <OutputDir>\\padisha\images</OutputDir> <VirtualOutputDir> <MaxRecordCount>500</MaxRecordCount> <MaxBufferFeatures>100</MaxBufferFeatures> <MaxImageWidth>2048</MaxImageWidth> <MaxImageHeight>2048</MaxImageHeight> </Properties> <Recycling> <StartTime>00:00</StartTime> <Interval>36000</Interval> </Recycling> <IsPooled>true</IsPooled> <MinInstances>2</MinInstances> <MaxInstances>4</MaxInstances> <WaitTimeout>60</WaitTimeout> <UsageTimeout>600</UsageTimeout> <Isolation>high</Isolation> <StartupType>automatic</StartupType> </ObjectConfiguration> Appendix B Configuration and log files 533

14 The IObjectConfiguration interface provides the methods and properties for setting a server configuration s properties and, therefore, the contents of the configuration files. IObjectConfiguration : IUnknown Description: String IsolationLevel: esriisolationlevel IsPooled: Boolean MaxInstances: Long MinInstances: Long Name: String Properties: IPropertySet RecycleProperties: IPropertySet StartupType: esristartuptype TypeName: String UsageTimeout: Long WaitTimeout: Long Provides access to members that control the behavior and properties of a server configuration to administrators. Description of the server configuration. The isolation level of the server s defined by the server configuration. Indicates whether the server s defined by this configuration are pooled. The maximum number of server instances for a server configuration. The minimum number of server instances for a pooled server configuration. Name of the server configuration. Initialization parameters and properties for the server s created by the server configuration. The recycling properties for the server configuration. The startup type for this server configuration. Startup type describes whether the server configuration is started when the server manager service is started for the GIS server. Type of the server configuration (Map or Geocode). Maximum time (in seconds) a client can hold on to an instance of a server for this server configuration before releasing it back to the server. It is the maximum time allowed between calling CreateContext and ReleaseContext. Maximum time (in seconds) a client will wait for an instance of a server for this server configuration using the CreateContext method on IObjectManager before timing out. The ArcCatalog Object Properties page General tab configuration tags The following are the tags, their meanings, and example values in a server configuration file. <Description> An optional string that is the description of the server configuration. <Properties> The list of properties of the server configuration. The subtags are properties specific to the server configuration type. For Map configurations, the subtags are <FilePath>, <OutputDir>, <VirtualOutputDir>. For Geocode configurations, the subtags are <Locator>, <LocatorWorkspacePath>, <LocatorWorkspaceConnectionString>, and <SuggestedBatchSize>. <FilePath> A string representing the path to the map document (.mxd) or published map document (.pmf) that the Map will serve. <OutputDir> A string that represents the path to a location on the file system to which the Map will write its output. When ArcCatalog creates a new Map configuration, this property is copied from the server directory s path that the user specifies. If you want the Map s output to be cleaned by the GIS server, this path should be a path to a server directory. <VirtualOutputDir> A string that represents the URL of the virtual directory that points to the physical location specified in the <OutputDir> tag. When ArcCatalog creates a new Map configuration, this property is copied from the server directory s URL that the user specifies. 534 ArcGIS Administrator and Developer Guide

15 <MaxRecordCount> An integer that represents the maximum number of result records returned by the following methods on the map server: QueryFeatureData Find Identify <MaxBufferCount> The ArcCatalog Object Properties page Parameters tab for a Map The ArcCatalog Object Properties page Parameters tab for a Geocode An integer that represents the maximum number of features that can be buffered by the map server at draw time per layer. <MaxImageWidth> An integer representing the maximum width (in pixels) of images the map server will export. <MaxImageHeight> An integer representing the maximum height (in pixels) of images the map server will export. <ConnectionCheckInterval> An integer representing the number of seconds the Map or Geocode will wait before checking if ArcSDE servers that have become unavailable are once again available. Once the ArcSDE server is available, the Map or Geocode 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 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. The following is an example of the <Properties> tag and its subtags for a Map configuration. <Properties> <FilePath>\\padisha\ArcGIS Data\Yellowstone.mxd</FilePath> <OutputDir>\\padisha\images</OutputDir> <VirtualOutputDir> <MaxRecordCount>500</MaxRecordCount> <MaxBufferCount>100</MaxBufferCount> <MaxImageWidth>2048</MaxImageWidth> <MaxImageHeight>2048</MaxImageHeight> </Properties> <Locator> A string that represents the name of the locator for the Geocode. <LocatorWorkspacePath> A required string for file-based locators that represents the path to the location on disk where the locator file is stored. <LocatorWorkspaceConnectionString> A required string for ArcSDE software-based locators that represents the connection string to the ArcSDE database. Appendix B Configuration and log files 535

16 <SuggestedBatchSize> An integer that represents the number of records that will be located at a time for batch geocoding. <MaxResultSize> An integer that represents the maximum number of result records returned by the FindAddressCandidates method on the geocode server: <MaxBatchSize> An integer that represents the maximum number of records that can be input into the geocode server s GeocodeAddresses method. The following is an example of the <Properties> tag and its subtags for a Geocode configuration whose locator is an ArcSDE locator. The ArcCatalog Object Properties page Pooling tab The ArcCatalog Object Properties page Processes tab <Properties> <Locator>GDB.Portland</Locator> <LocatorWorkspaceConnectionString> ENCRYPTED_PASSWORD=0002c06e3bc49d6412c06c1baa554d00; SERVER=doug; INSTANCE=5151; USER=gdb; VERSION=SDE.DEFAULT </LocatorWorkspaceConnectionString> <SuggestedBatchSize>1000</SuggestedBatchSize> <MaxResultSize>500</MaxResultSize> <MaxBatchSize>1000</MaxBatchSize> </Properties> <Recycling> The list of recycling properties of the server 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. <Start> A required string that represents the recycling start time, which is the time at which recycling is initialized. 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. <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 The following is an example of the <Recycling> tag and its subtags. <Recycling> <StartTime>00:00</StartTime> <Interval>36000</Interval> </Recycling> 536 ArcGIS Administrator and Developer Guide

17 <MinInstances> An integer specifying the minimum number of instances for the server s pool. The default is 0. <MaxInstances> An integer specifying the maximum number of server 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 server and getting a server. The default is 60. <UsageTimeout> An optional integer specifying the maximum amount of time in seconds a client can hold onto a server before it is automatically released. The default is 600. <IsPooled> A required string indicating whether the server s created by this configuration are pooled (true) or not pooled (false). <Isolation> A required string indicating if the configuration s server 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 are examples of these tags: <IsPooled>true</IsPooled> <MinInstances>2</MinInstances> <MaxInstances>4</MaxInstances> <WaitTimeout>60</WaitTimeout> <UsageTimeout>600</UsageTimeout> <Isolation>high</Isolation> <StartupType>automatic</StartupType> Appendix B Configuration and log files 537

18