This topic explains the properties available when using a system-generated capabilities file for WMS services. See Using external capabilities files with WMS services to learn more about defining WMS metadata by using an external capabilities file.
Accessing WMS service properties
The following topics include full instructions on how to access the properties for WMS services:
WMS service properties
The following table lists the properties available for WMS services and a description of each:
| Property | Description |
|---|---|
Name | The OGC service type. This property is automatically populated by ArcGIS Server and should not be modified. |
Title | The name of the map or image service that was used to create the WMS service. This property is automatically populated by ArcGIS Server and should not be modified. |
Abstract | A narrative description which provides additional information about the WMS service. For example: WMS service maintained by Acme Corporation. Contact: webmaster@wmt.acme.com. High-quality map showing eagle nests and possible nesting locations. |
Keywords | A list of keywords or keyword phrases describing the WMS service which aid in catalog searching. For example: map, bird, eagle, nest, site |
Online Resource | The OnlineResource property lists the URL of the WMS service. It is necessary for a WMS client to communicate correctly with your WMS service. This property is automatically populated by ArcGIS Server and should not be modified. |
ContactPerson | The primary contact person for the WMS service. For example: John Smith |
ContactPosition | The position of the contact person for the WMS service. For example: IT Analyst |
ContactOrganization | The organization that created the WMS service. For example: NASA |
Address type | The address type used by the organization that created the WMS service. For example: postal |
Address | The address of the organization that created the WMS service. For example: 380 New York Street |
City | The city in which the organization resides that created the WMS service. For example: Redlands |
StateorProvince | The state in which the organization resides that created the WMS service. For example: California |
PostCode | The postal code in which the organization resides that created the WMS service. For example: 92373 |
Country | The country in which the organization resides that created the WMS service. For example: USA |
ContactVoiceTelephone | The telephone number where the primary contact person for the WMS service can be reached. For example: +1 909 793-2853 |
ContactFacsimilieTelephone | The fax number where the primary contact person for the WMS service can be reached. For example: +1 123 456-7890 |
ContactElectronicMailAddress | The email address where the primary contact person for the WMS service can be reached. For example: user@host.com |
Fees | Text describing the fees imposed when accessing the WMS service. For example: none |
Access constraints | Text describing the restrictions and legal prerequisites for accessing and using the WMS service. For internal use only. Do not distribute. |
SLD Path or URL | SLDs allow you to publish multiple styles for each WMS layer. If you are binding an SLD file to the current WMS service, you need to enter the SLD Path or URL property to the URL, UNC path, or physical location of an SLD XML file. The ArcGIS Server account must have access to the location in order for ArcGIS Server to properly read the SLD XML file. To learn more about SLDs, see Using Styled Layer Descriptors with WMS services. |
Additional spatial reference systems | This property can be used to add additional spatial reference systems to WMS services. By default, WMS services only list two spatial reference systems; EPSG:4326 (or CSR:84 for WMS 1.3.0) and the spatial reference of the map service that WMS is enabled on. To list additional spatial reference systems, separate the spatial reference systems with a comma (,). For example, EPSG:4267,EPSG:4269,EPSG:102113. The EPSG namespace (e.g. EPSG) and the EPSG ID (e.g. 4267) must be separated by a colon (:), or the spatial reference will be ignored by the server. |
Use layer names from the map document | By default, this option is unchecked, meaning that layers in the WMS service will be represented with zero-based integers, indicating their position in the table of contents from the top down. Selecting this checkbox will allow the layer names to be represented with the same strings that are used in the map document's table of contents. All the layer names in the map must be unique and cannot contain any of the characters &, <, >, ", or '. If you need to use one of these characters, refer to the character substitute table below. |
Force map reaspect based on width and height | This property determines whether the map is reaspected or not. By default, this option is deselected, which means that the pixels representing the map area are stretched to fit into the height and width requested by WMS clients. If this option is selected, the pixel height and width ratio will stay the same. When a map is requested at full extent, it may not fill the entire viewing area. |
Setting the IdentifyToleranceInPixel property
The IdentifyToleranceInPixel property allows you to define a tolerance (in pixels) in which the GetFeatureInfo operation will return feature information to the client when they click on the screen. For example, if you define a pixel tolerance of 10 for your WMS, the information will be returned to the client as long as they click within 10 pixels of the feature on the screen.
This property can only be added to the list of WMS properties using the ArcGIS Server Administrator Directory. To access the Administrator Directory and add this property, follow these steps:
- Open the Administrator Directory in a browser and log in. The typical URL to the directory is http://gisserver.domain.com:6080/arcgis/admin/.
- Click services.
- In the Folder - / page, click the name of the WMS-enabled map service that you want to edit. If you don't see your service in the list, it may be located within a subfolder under the root folder.
- On the Service - <service name> (MapServer) page, scroll to the bottom and click edit.
- In the Service Properties dialog box, locate the "typeName": "WMSServer" section.
- Within the "properties": { section, add the IdentifyToleranceInPixel property and specify the desired pixel tolerance. For example:
"properties": { "IdentifyToleranceInPixel": "10", ... - Click Save Edits.
The IdentifyToleranceInPixel property is added to your WMS.
Setting the listCustomCRS property
The listCustomCRS property allows you to define a custom projection or Well Known Text (WKT) representation of a projection in a WMS service. This means that publishers and consumers of the WMS can:
- Assign IDs to custom projections and advertise them through the WMS capabilities file.
- Overwrite an existing projection with a WKT string.
- Request a map in a particular projection by directly specifying the well-known text.
This property can only be added to the list of WMS properties using the ArcGIS Server Administrator Directory. To access the Administrator Directory and add this property, follow these steps:
- Open the Administrator Directory in a browser and log in. The typical URL to the directory is http://gisserver.domain.com:6080/arcgis/admin/.
- Click services.
- In the Folder - / page, click the name of the WMS-enabled map service that you want to edit. If you don't see your service in the list, it may be located within a subfolder under the root folder.
- On the Service - <service name> (MapServer) page, scroll to the bottom and click edit.
- In the Service Properties dialog box, locate the "typeName": "WMSServer" section.
- Within the "properties": { section, add the listCustomCRS property and define the custom projection or WKT representation of a projection. For example, to define a default custom projection for your WMS service, do the following:
"properties": { "listCustomCRS": "EPSG:200001=DEFAULT", ... - Click Save Edits.
The listCustomCRS property is added to your WMS. For more information on how to define a custom projection, WKT, and request a map in a specific projection, see Defining a custom projection for a WMS service.
Special characters in service properties
The following characters cannot be included in any of the service properties: &, <, >, ", '. If you need to use one of these characters, you must substitute the appropriate escape sequence from the table below:
| Character | Character substitute |
|---|---|
& | & |
< | < |
> | > |
" | " |
' | ' |