MapRequest ArcIMS Map Service File Format

 

Map services for sites using ArcIMS should include this line:

 

driver=ebgeo.maprequest.ArcIMSMapService

 

ArcIMSMapService is a driver to talk to web sites running ESRI’s ArcIMS. (A sample .properties file is included called “sample map.properties”.)

 

The driver supports the following parameters.

 

 

Parameter: description

(Required)

Use: The description of the map service

Example:

description=My map service

 

Parameter: maxHeight

(Required)

Use: The maximum image height (in pixels) that the web site serves

Example:

maxHeight=462

 

Parameter: maxWidth

(Required)

Use: The maximum image width (in pixels) that the web site serves

Example:

maxWidth=770

 

Parameter: baseURL

(Required)

Use: The base URL for the ArcIMS server.

Example:

baseURL=http://mymapsite.com/

 

Parameter: infoURL

Default: none

Use: A URL giving information about the map (e.g. copyright and/or usage agreement). This URL is displayed to the user, but it is not used for any other purpose.

Example:

infoURL=http://www.mymapsite.com/information.html

 

Parameter: requestURL

(Required)

Use: The URL to use to send a request to Esrimap.

Example:

requestURL=http://mymapsite.com/servlet/com.esri.esrimap.Esrimap?ServiceName=map&ClientVersion=4.0&Form=True&Encode=False

 

Parameter: refererURL

Default: No referrer supplied

Use: This URL will be supplied as the referring page for all requests to the mapping web site.

Example:

refererURL= http://mymapsite.com/servlet/com.esri.esrimap.Esrimap?ServiceName=map&ClientVersion=4.0&Form=True&Encode=False

 

Parameter: mapDelay

Default: 5

Use: The number of seconds to delay between requests. If a map can be requested using only one request then there is no delay. For maps that require multiple requests, there is a delay of this many seconds between requests. This is to prevent MapRequest from swamping a web site with requests.

Example:

mapDealy=6

 

Parameter: projection

Default: latitude/longitude

Use: This specifies the projection of the map. See a list of supported datums and projections.

Example:

projection=UTM

 

Parameter: datum

Default: WGS84

Use: This specifies the datum of the map. See a list of supported datums and projections.

Example:

datum=GDA

 

Parameter: zone

Default: No zone information

Use: If the map uses a grid system that requires a zone identifier (e.g. UTM) then specify the zone for here. Note that if the map uses the British National Grid (BNG) projection MapRequest will supply the correct alphabetic zone automatically (e.g. “TQ”).

Example:

zone=55

 

Parameter: minXExtent

Default: Get minXExtent from map server

Use: Sets the minimum possible X value for the map. MapRequest tries to determine valid values for the min/max X/Y extents from the map server. For some map servers this returns only a small area of the map. As MapRequest does not allow you to zoom out past the min/max extent size, it can sometimes be useful to hard code the maximum and minimum possible values for X and Y in the .properties file.

Example:

minXExtent=149.0

 

Parameter: maxXExtent

Default: Get maxXExtent from map server

Use: Sets the maximum possible X value for the map. MapRequest tries to determine valid values for the min/max X/Y extents from the map server. For some map servers this returns only a small area of the map. As MapRequest does not allow you to zoom out past the min/max extent size, it can sometimes be useful to hard code the maximum and minimum possible values for X and Y in the .properties file.

Example:

maxXExtent=152.0

 

Parameter: minYExtent

Default: Get minYExtent from map server

Use: Sets the minimum possible Y value for the map. MapRequest tries to determine valid values for the min/max X/Y extents from the map server. For some map servers this returns only a small area of the map. As MapRequest does not allow you to zoom out past the min/max extent size, it can sometimes be useful to hard code the maximum and minimum possible values for X and Y in the .properties file.

Example:

minYExtent=-22.4

 

Parameter: maxYExtent

Default: Get maxYExtent from map server

Use: Sets the maximum possible Y value for the map. MapRequest tries to determine valid values for the min/max X/Y extents from the map server. For some map servers this returns only a small area of the map. As MapRequest does not allow you to zoom out past the min/max extent size, it can sometimes be useful to hard code the maximum and minimum possible values for X and Y in the .properties file.

Example:

maxYExtent=-20.1

 

Parameter: hemisphere

Default: none

Use: If the map uses a grid system where the hemisphere may be ambiguous (e.g. UTM), this specifies which hemisphere the coordinates are in.

Example:

hemisphere=S

 

Parameter: addText

Default: none

Use: This specifies text that should be added to the bottom of generated maps. This is useful if the map’s usage agreement requires that reproductions include some kind of copyright notice.

Example:

addText=\u00A9 1907 Government of Ruritania

 

Parameter: country

Default: none

Use: Specifies the country that this map is from. The country is used to set the sort order for map services in the map selection dialog box. By convention the country’s 2 letter internet code is used. (The country information is not used for any other purpose.)

Example:

country=au

 

Parameter: state

Default: none

Use: Specifies the state/province that this map is from. The state is used to set the sort order for map services in the map selection dialog box. (The state information is not used for any other purpose.)

Example:

state=Southern Province

 

Parameter: cookieCutterURL.n

Default: none

Use: Allows you to specify a number of URLs (to be hit in order) to collect cookies before making any map requests. (e.g. for authentication, or to pick up some kind of session cookie) The URL cookieCutterURL.0 is hit first, followed by cookieCutterURL.1 etc.

Example:

cookieCutterURL.0=http://mymapsite.com/welcome.html
cookieCutterURL.1=http://mymapsite.com/login.html?user=me&pass=secret

 

Parameter: cookieName

Default: none

Use: Allows you to specify the name of a single cookie to be sent to the web site along with map requests. (See cookieValue.)

Example:

cookieName=speed
cookieValue=high

 

Parameter: cookieValue

Default: none

Use: Allows you to specify the value of a single cookie to be sent to the web site along with map requests. (See cookieName.)

Example:

cookieName=speed
cookieValue=high

 

MapRequest documentation