Using Map and Viewer Configuration Files

Introduction

Configuration files are used to define a map. There are four types of configuration files: The following sections cover configuration files in detail. The first section discusses map configuration files for Image and Feature Services, the next section covers viewer configuration files, and the third section reviews default.axl. A final section provides a summary review of the similarities and differences among the configuration file types.

Note: Metadata configuration files and map configuration files created using ArcMap are not discussed in this document.

Map Configuration Files

Map configuration files are used as input to ArcIMS services. All information in a map configuration file provides a default set of instructions for map properties and rendering. Requests can override information in the service properties, but if the request does not include any special instructions, then the default service properties prevail. The diagram below shows the flow for creating an ArcIMS service using a map configuration file as input.
Map configuration file flow

Framework of a map configuration file

This next section focuses on the framework of ArcXML map configuration files used as input to Image and Feature MapServices. An ArcXML map configuration file can be divided into several sections. The following example shows the basic framework.

Framework of a map configuration file:
<?xml version="1.0" encoding="UTF-8"?>
<ARCXML version="1.1">
  <CONFIG>
    <ENVIRONMENT>...</ENVIRONMENT>
    <MAP>
      <PROPERTIES>...</PROPERTIES>
      <WORKSPACES>...</WORKSPACES>
      <LAYER>...</LAYER>
    </MAP>
  </CONFIG>
</ARCXML>

A map configuration file includes:

ARCXML and the prolog

The first line of an ArcXML statement is the prolog. All ArcXML 1.1 statements are required to use a standard prolog that includes the XML version and encoding. The XML version is 1.0. Encoding in ArcXML 1.1 is UTF8.

After the prolog, all ArcXML statements begin and end with ARCXML. This element is required, and the version number is 1.1.

Prolog and ARCXML:
<?xml version="1.0" encoding="UTF-8"?>
<ARCXML version="1.1">

...
</ARCXML>

CONFIG, ENVIRONMENT, and MAP

A map configuration file distinguishes itself from a REQUEST or RESPONSE by the CONFIG element. For more information on the relationship between map configuration files, requests, and responses, see Introduction to ArcXML.

The only child elements to CONFIG in a map configuration file are ENVIRONMENT and MAP.

CONFIG, ENVIRONMENT, and MAP:
<?xml version="1.0" encoding="UTF-8"?>
<ARCXML version="1.1">
  <CONFIG>
    <ENVIRONMENT>...</ENVIRONMENT>
    <MAP>...</MAP>
  </CONFIG>
</ARCXML>

ENVIRONMENT is used to set up information about the environment used in the ArcIMS service. Once the environment is established, clients in one locale can access a service created in another locale. Child elements of ENVIRONMENT include the following:
ENVIRONMENT and its child elements:
<ENVIRONMENT>
  <LOCALE language="en" country="US" />
  <UIFONT name="Arial" color="0,0,0" size="12" style="regular" />
  <SEPARATORS cs=" " ts=";"/>
  <SCREEN dpi="96"/>
</ENVIRONMENT>

The element MAP contains all the instructions for generating a map. This includes:
MAP and its child elements:
<MAP>
  <PROPERTIES>...</PROPERTIES>
  <WORKSPACES>...</WORKSPACES>
  <LAYER>...</LAYER>
</MAP>

The PROPERTIES, WORKSPACES, and LAYER elements are discussed in detail in the next sections.

MAP: PROPERTIES

PROPERTIES provides the framework for defining properties about an ArcIMS service. The child element ENVELOPE is required but all other child elements are optional. The child elements shown in the following example are used in both Image and Feature Services.

PROPERTIES and its child elements for both Feature and Image Services:
<PROPERTIES>
  <ENVELOPE minx="-105.594842" miny="-49.955227" maxx="75.672764" maxy="83.596039" name="Initial_Extent" />
  <MAPUNITS units="decimal_degrees" />
  <FEATURECOORDSYS id="54008" />
  <FILTERCOORDSYS id="54008" />
</PROPERTIES>

The following child elements are valid only with Image Services and are more commonly used in requests than in a map configuration file:

PROPERTIES and its child elements valid only with Image Services (in bold):
<PROPERTIES>
  <ENVELOPE minx="-105.594842" miny="-49.955227" maxx="75.672764" maxy="83.596039" name="Initial_Extent" />
  <MAPUNITS units="decimal_degrees" />
  <FEATURECOORDSYS id="54008" />
  <FILTERCOORDSYS id="54008" />
  <BACKGROUND... />
  <LEGEND... />
  <OUTPUT... />
</PROPERTIES>

MAP: WORKSPACES

WORKSPACES specifies the location of all the data used in the map configuration file. All data locations must be visible to any computer hosting ArcIMS services. Each workspace must have a unique reference name. Valid WORKSPACES in map configuration files are:
Valid WORKSPACES in a map configuration file:
<WORKSPACES>
  <SHAPEWORKSPACE name="shp_ws-0" directory="c:\ESRIDATA"/>
  <IMAGEWORKSPACE name="jai_ws-1" directory="c:\ESRIDATA"/>
  <SDEWORKSPACE name="sde_ws-2" server="zephyr" instance="port:5150" database="" user="washoe" encrypted="true" password="LXEMUR" />
</WORKSPACES>

MAP: LAYER

LAYER is the parent element for defining a map layer. Attributes cannot be overridden by a request. The following attributes are required: The following attributes are optional:
Sample LAYER with attributes:
<LAYER type="featureclass" name="CITIES" minscale="1:24000" maxscale="1:100000" visible="true" id="2"> ... </LAYER>

MAP: LAYER child elements

A LAYER used in a map configuration file has several child elements. The purpose of these elements is to identify the data source and to render the data.

LAYER with child elements:
<LAYER type="featureclass" name="CITIES" minscale="1:24000" maxscale="1:100000" visible="true" id="2">
  <DATASET name="Cities_Robinson" type="polygon" workspace="shp_ws-0" />
  <DENSIFY tolerance="10000" />
  <COORDSYS id="54030" />
  <SPATIALQUERY where="population > 1000000" />
  <SIMPLERENDERER>
    <SIMPLEPOLYGONSYMBOL filltransparency="1.0" fillcolor="27,127,127" />
  </SIMPLERENDERER>
</LAYER>

The types of child elements can be divided into several groups: DATASET, projection elements, query elements, EXTENSION elements, and renderer and symbol elements.

Sample map configuration file

The following map configuration file uses many of the elements discussed above.

Example map configuration file:
<?xml version="1.0" encoding="UTF-8"?>
<ARCXML version="1.1">
  <CONFIG>
    <ENVIRONMENT>
      <LOCALE country="US" language="en" variant="" />
      <UIFONT color="0,0,0" name="Arial" size="12" style="regular" />
      <SCREEN dpi="96" />
    </ENVIRONMENT>
    <MAP>
      <PROPERTIES>
        <ENVELOPE minx="-135.0" miny="-64.0" maxx="84.0" maxy="86.0" name="Initial_Extent" />
        <MAPUNITS units="decimal_degrees" />
      </PROPERTIES>
      <WORKSPACES>
        <SHAPEWORKSPACE name="shp_ws-4" directory="<path to WORLD ESRIDATA>" />
      </WORKSPACES>
      <LAYER type="featureclass" name="Oceans" visible="true" id="0">
        <DATASET name="WORLD30" type="polygon" workspace="shp_ws-4" />
        <SIMPLERENDERER>
          <SIMPLEPOLYGONSYMBOL fillcolor="51,153,255"/>
        </SIMPLERENDERER>
      </LAYER>
      <LAYER type="featureclass" name="Countries" visible="true" id="1">
        <DATASET name="country" type="polygon" workspace="shp_ws-4" />
        <GROUPRENDERER>
          <VALUEMAPRENDERER lookupfield="POP_CNTRY">
            <RANGE lower="0" upper="50000000" label="Less than 50000000">
              <SIMPLEPOLYGONSYMBOL fillcolor="255,255,0"/>
            </RANGE>
            <RANGE lower="50000001" upper="100000000" label="50000000 - 100000000">
              <SIMPLEPOLYGONSYMBOL fillcolor="255,170,0" />
            </RANGE>
            <RANGE lower="100000001" upper="1281008319" label="Greater than 100000000">
              <SIMPLEPOLYGONSYMBOL fillcolor="255,85,0"/>
            </RANGE>
          </VALUEMAPRENDERER>
          <SCALEDEPENDENTRENDERER upper="1:35000000">
            <SIMPLELABELRENDERER field="CNTRY_NAME">
              <TEXTSYMBOL antialiasing="true" font="Arial Bold" fontstyle="bold" fontsize="12" />
            </SIMPLELABELRENDERER>
          </SCALEDEPENDENTRENDERER>
        </GROUPRENDERER>
      </LAYER>
    </MAP>
  </CONFIG>
</ARCXML>

The map configuration file contains information on the locale, map properties, workspaces, and how each layer should be drawn. In the ENVIRONMENT section, the LOCALE country and language are the "US" and "En". For UIFONT, the default font of Arial is used, and the default dpi in SCREEN is 96. The PROPERTIES elements show that the MAPUNITS are in decimal degrees and the ENVELOPE coordinates are -135.0,-64.0 and 84.0,86.0. In the WORKSPACES section, one SHAPEWORKSPACE is included for shapefiles in the WORLD ESRIDATA dataset.

The map contains two layers:
  1. Ocean. This layer contains one renderer, SIMPLERENDERER. The layer has a solid blue fill as described in SIMPLEPOLYGONSYMBOL.
  2. Countries. This layer contains several renderers. A VALUEMAPRENDERER is used to define how each country should be colored based on population. Countries with a population less than 50 million are yellow, those with a population between 50 and 100 million are light orange, and those with a population greater than 100 million are dark orange. A SCALEDEPENDENTRENDERER is used for labeling. The labels do not turn on until the scale is less than 1:35000000.
The following figure shows a map drawn based on the instructions in the map configuration file.

Legend Inital map configuration file

If the initial extent is changed so the scale is less than 1:35000000, the map zooms in enough so that labels for countries appear.

Change in initial ENVELOPE:
<?xml version="1.0" encoding="UTF-8"?>
<ARCXML version="1.1">
  <CONFIG>
    <ENVIRONMENT>...</ENVIRONMENT>
    <MAP>
      <PROPERTIES>
        <ENVELOPE minx="-13.0" miny="36.0" maxx="34.0" maxy="69.0" name="Initial_Extent" />
        <MAPUNITS units="decimal_degrees" />
      </PROPERTIES>
      <WORKSPACES>...</WORKSPACES>
      <LAYER>...</LAYER>
    </MAP>
  </CONFIG>
</ARCXML>

The following figure shows a map at a scale of about 1:35000000 and includes labels.

Legend Map configuration file at 1:35000000

Viewer Configuration Files

Viewer configuration files are the output when a file is saved in ArcExplorer 4 or the ArcIMS Java Viewers. The diagram below provides a more detailed flow of the process to create a viewer configuration file:
Viewer configuration file flow

Framework of a viewer configuration file

The framework of a viewer configuration file is similar to a map configuration file. The framework includes the CONFIG, ENVIRONMENT, and MAP elements. These elements function the same in both map and viewer configuration files. PROPERTIES is fundamentally the same as well, but only ENVELOPE and MAPUNITS are included.

In many cases, a viewer configuration file can look just like a map configuration file. This is true when only local data sources are included in the file and the only WORKSPACES present are SHAPEWORKSPACE, IMAGEWORKSPACE, and SDEWORKSPACE.

Viewer configuration files can contain additional elements that are not in a map configuration file. The following example shows some of these elements.

Example viewer configuration file:
<?xml version="1.0" encoding="UTF-8"?>
<ARCXML version="1.1">
  <CONFIG>
    <ENVIRONMENT>
      <LOCALE country="US" language="en" variant="" />
      <UIFONT color="0,0,0" name="Arial" size="12" style="regular" />
      <SCREEN dpi="96" />
    </ENVIRONMENT>
    <MAP>
      <PROPERTIES>
        <ENVELOPE minx="-178.0" miny="12.89" maxx="-68.0" maxy="83.59" name="Initial_Extent" />
        <MAPUNITS units="decimal_degrees" />
      </PROPERTIES>
      <WORKSPACES>
        <IMAGESERVERWORKSPACE name="mapper_ws-6" url="http://mymachine.domain.com/servlet/com.esri.esrimap.Esrimap" service="background" />
        <FEATURESERVERWORKSPACE name="ifs_ws-7" url="http://mymachine.domain.com/servlet/com.esri.esrimap.Esrimap" service="states" />
        <AVIMSWORKSPACE name="av_ws-6" url="http://mymachine.domain.com/servlet/com.esri.esrimap.Esrimap" view="Roads" map="roads21204240" />
        <MOIMSWORKSPACE name="mo_ws-4" url="http://mymachine.domain.com/scripts/esrimap.dll" service="GPS_Points" />
        <SHAPEWORKSPACE name="shp_ws-8" directory="<path to CANADA ESRIDATA" />
      </WORKSPACES>
      <LAYER type="image" name="Background" visible="true" id="0">
        <DATASET name="background" type="image" workspace="mapper_ws-6" />
      </LAYER>
      <LAYER type="featureclass" name="States" visible="true" id="1">
        <DATASET name="2" type="polygon" workspace="ifs_ws-7" />
        <SIMPLERENDERER>
          <SIMPLEPOLYGONSYMBOL boundarytransparency="1.0" filltransparency="1.0" fillcolor="255,255,153" boundarycaptype="round" />
        </SIMPLERENDERER>
      </LAYER>
      <LAYER type="featureclass" name="Provinces" visible="true" id="2">
        <DATASET name="province" type="polygon" workspace="shp_ws-8" />
        <SIMPLERENDERER>
          <SIMPLEPOLYGONSYMBOL boundarytransparency="1.0" filltransparency="1.0" fillcolor="127,27,27" boundarycaptype="round" />
        </SIMPLERENDERER>
      </LAYER>
      <LAYER type="image" name="Roads" visible="true" id="3">
        <DATASET name="mymachine.domain.com:roads21204240:Roads" type="image" workspace="av_ws-6" />
        <IMAGEPROPERTIES transparency="0.80" />
      </LAYER>
      <LAYER type="image" name="GPS Points" visible="true" id="4">
        <DATASET name="mymachine.domain.com:GPS_Points" type="image" workspace="mo_ws-4" />
      </LAYER>
    </MAP>
    <OVERVIEWMAP backgroundcolor="255,255,255" framefillcolor="255,0,0,80" frameoutlinecolor="255,0,0" zoomfactor="4.0">
      <LAYERDEF name="States" />
      <LAYERDEF name="Provinces" />
    </OVERVIEWMAP>
    <SCALEBAR backcolor="212,208,200" fontcolor="0,0,0" mapunits="decimal_degrees" scaleunits="feet" screenunits="inches" />
  </CONFIG>
</ARCXML>

The additional elements are: Each of these elements is described below.

IMAGESERVERWORKSPACE

IMAGESERVERWORKSPACE is used in the WORKSPACES section for Image Service layers.

Using IMAGESERVERWORKSPACE:
<?xml version="1.0" encoding="UTF-8"?>
<ARCXML version="1.1">
  <CONFIG>
    <ENVIRONMENT>...</ENVIRONMENT>
    <MAP>
      <PROPERTIES>...</PROPERTIES>
      <WORKSPACES>
        <IMAGESERVERWORKSPACE name="mapper_ws-6" url="http://mymachine.domain.com/servlet/com.esri.esrimap.Esrimap" service="background" />
      </WORKSPACES>
      <LAYER type="image" name="Background" visible="true" id="0">
        <DATASET name="background" type="image" workspace="mapper_ws-6" />
      </LAYER>
    </MAP>
    <OVERVIEWMAP>...</OVERVIEWMAP>
    <SCALEBAR ... />
  </CONFIG>
</ARCXML>

References to an Image Service in IMAGESERVERWORKSPACE are made in the service attribute. In the above example, the name of the Image Service is "background". The url attribute gives the location of the Image Service. In the example, the location is "http://mymachine.domain.com". In addition to the domain, the location of the ArcIMS servlet connector is also included. This information is the same for all ArcIMS sites and is "/servlet/com.esri.esrimap.Esrimap".

For the Image Service layer, references to the ArcIMS service are made in DATASET. The attribute name is the same as IMAGESERVERWORKSPACE service. In this example, the name is "background". The DATASET type is always "image". Image Service layers are always treated as one layer in a viewer configuration file, and the sublayers are not included.

FEATURESERVERWORKSPACE

FEATURESERVERWORKSPACE is used in the WORKSPACES section for Feature Service layers.

Using FEATURESERVERWORKSPACE:
<?xml version="1.0" encoding="UTF-8"?>
<ARCXML version="1.1">
  <CONFIG>
    <ENVIRONMENT>...</ENVIRONMENT>
    <MAP>
      <PROPERTIES>...</PROPERTIES>
      <WORKSPACES>
        <FEATURESERVERWORKSPACE name="ifs_ws-7" url="http://mymachine.domain.com/servlet/com.esri.esrimap.Esrimap" service="states" />
      </WORKSPACES>
      <LAYER type="featureclass" name="States" visible="true" id="1">
        <DATASET name="3" type="polygon" workspace="ifs_ws-7" />
        <SIMPLERENDERER>
          <SIMPLEPOLYGONSYMBOL boundarytransparency="1.0" filltransparency="1.0" fillcolor="255,255,153" boundarycaptype="round" />
        </SIMPLERENDERER>
      </LAYER>
    </MAP>
    <OVERVIEWMAP>...</OVERVIEWMAP>
    <SCALEBAR ... />
  </CONFIG>
</ARCXML>

References to a Feature Service in FEATURESERVERWORKSPACE are made in the service attribute. In the above example, the name of the Feature Service is "States". The url attribute is used the same way as with Image Service. In the example, the location of the ArcIMS Servlet Connector is "http://mymachine.domain.com/servlet/com.esri.esrimap.Esrimap".

Each layer in a Feature Service is treated as a separate layer, and each layer can be accessed individually. In the above example, only one layer of a Feature Service has been accessed.

For a Feature Service layer, DATASET is always included, and rendering information is usually included. In DATASET, the attribute type is set to the same type as in the Feature Service. In the above example the type is "polygon". The attribute name is set to the LAYER id in the Feature Service. In this example, the LAYER id in the Feature Service is "3"; therefore, the DATASET name in the viewer configuration file is "3". The following examples highlight the differences between the map configuration file used as input to the Feature Service and the output in the viewer configuration file.

Map configuration file used in the Feature Service:
<LAYER type="featureclass" name="States" visible="true" id="3">
  <DATASET name="STATES" type="polygon" workspace="shp_ws-1" />
  <SIMPLERENDERER>
    <SIMPLEPOLYGONSYMBOL boundarytransparency="1.0" filltransparency="1.0" fillcolor="255,255,153" boundarycaptype="round" />
  </SIMPLERENDERER>
</LAYER>

Viewer configuration file:
<LAYER type="featureclass" name="States" visible="true" id="1">
  <DATASET name="3" type="polygon" workspace="ifs_ws-7" />
  <SIMPLERENDERER>
    <SIMPLEPOLYGONSYMBOL boundarytransparency="1.0" filltransparency="1.0" fillcolor="255,255,153" boundarycaptype="round" />
  </SIMPLERENDERER>
</LAYER>

In the map configuration file, the LAYER id is "3", which is unique within the map configuration file, and the DATASET name is "STATES" and refers to a shapefile in the "shp_ws-1" workspace. In the viewer configuration file, the LAYER id is "1", which is unique within the viewer configuration file. The DATASET name is "3", which refers to the LAYER id in the map configuration file. The workspace reference is "ifs_ws-7", which refers to the workspace for the Feature Service. The rest of the layer information in the map and viewer configuration files is identical.

When using ArcExplorer 4 and when permission is given in the ArcIMS Java Viewers, the layer rendering can be changed using the Layer Properties Dialog. In the following example, the States layer is rendered in light yellow by default.

Default viewer configuration file:
<LAYER type="featureclass" name="States" visible="true" id="1">
  <DATASET name="2" type="polygon" workspace="ifs_ws-7" />
  <SIMPLERENDERER>
    <SIMPLEPOLYGONSYMBOL boundarytransparency="1.0" filltransparency="1.0" fillcolor="255,255,153" boundarycaptype="round" />
  </SIMPLERENDERER>
</LAYER>

Default viewer configuration file

If a user changes the rendering, this new information is stored in the viewer configuration file. The change is local and does not affect the Feature Service. In the next example, the rendering is changed from light yellow to various colors based on the population of each state.
After layer rendering has been changed in the viewer configuration file:
<LAYER type="featureclass" name="States" visible="true" id="1">
  <DATASET name="2" type="polygon" workspace="ifs_ws-7" />
  <VALUEMAPRENDERER lookupfield="POP1999">
    <RANGE lower="482025" upper="11351422" label="Less than 11351422">
      <SIMPLEPOLYGONSYMBOL boundarytransparency="1.0" filltransparency="1.0" fillcolor="255,255,0" boundarycaptype="round" />
    </RANGE>
    <RANGE lower="11351422" upper="22220818" label="11351422 - 22220818">
      <SIMPLEPOLYGONSYMBOL boundarytransparency="1.0" filltransparency="1.0" fillcolor="255,170,0" boundarycaptype="round" />
    </RANGE>
    <RANGE lower="22220818" upper="33090215" label="22220818 - 33090215">
      <SIMPLEPOLYGONSYMBOL boundarytransparency="1.0" filltransparency="1.0" fillcolor="255,85,0" boundarycaptype="round" />
    </RANGE>
  </VALUEMAPRENDERER>
</LAYER>

Viewer configuration file after new rendering

Remember that in a viewer configuration file, any rendering changes remain local to the machine that the configuration file resides on. The change does not affect the Feature Service.

AVIMSWORKSPACE

AVIMSWORKSPACE is used in the WORKSPACES section to reference a map generated from ArcView IMS. Note: AVIMSWORKSPACE has been deprecated in ArcIMS 4.0.

Using AVIMSWORKSPACE:
<?xml version="1.0" encoding="UTF-8"?>
<ARCXML version="1.1">
  <CONFIG>
    <ENVIRONMENT>...</ENVIRONMENT>
    <MAP>
      <PROPERTIES>...</PROPERTIES>
      <WORKSPACES>
        <AVIMSWORKSPACE name="av_ws-6" url="http://mymachine.domain.com/servlet/com.esri.esrimap.Esrimap" view="Roads" map="roads21204240" />
      </WORKSPACES>
      <LAYER type="image" name="Roads" visible="true" id="3">
        <DATASET name="mymachine.domain.com:roads21204240:Roads" type="image" workspace="av_ws-6" />
        <IMAGEPROPERTIES transparency="0.80" />
      </LAYER>
    </MAP>
    <OVERVIEWMAP>...</OVERVIEWMAP>
    <SCALEBAR ... />
  </CONFIG>
</ARCXML>

AVIMSWOKSPACE references a map in ArcView IMS using the attributes view and map. The values for these attributes are the ArcView IMS MapName and ViewName, respectively, and can be found in the applet HTML file of an ArcView IMS MapCafé Web site. For example, if the Web site is named "MySite", open "MySiteapplet.html". Look for the parameters MapName and ViewName. For more information on using ArcView IMS with ArcIMS, see Using ArcIMS. As with other WORKSPACES types, the url attribute references the ArcIMS servlet connector.

The DATASET name for the layer references the machine and domain, MapName, and ViewName separated by colons (:). In the above example, the DATASET name is "mymachine.domain.com:roads21204240:Roads".

MOIMSWORKSPACE

MOIMSWORKSPACE is used in the WORKSPACES section to reference an ArcExplorer-enabled map generated from MapObjects IMS. Note: MOIMSWORKSPACE has been deprecated in ArcIMS 4.0.

Using MOIMSWORKSPACE:
<?xml version="1.0" encoding="UTF-8"?>
<ARCXML version="1.1">
  <CONFIG>
    <ENVIRONMENT>...</ENVIRONMENT>
    <MAP>
      <PROPERTIES>...</PROPERTIES>
      <WORKSPACES>
        <MOIMSWORKSPACE name="mo_ws-4" url="http://mymachine.domain.com/scripts/esrimap.dll" service="GPS_Points" />
      </WORKSPACES>
      <LAYER type="image" name="GPS Points" visible="true" id="4">
        <DATASET name="mymachine.domain.com:GPS_Points" type="image" workspace="mo_ws-4" />
      </LAYER>
    </MAP>
    <OVERVIEWMAP>...</OVERVIEWMAP>
    <SCALEBAR ... />
  </CONFIG>
</ARCXML>

References to an ArcExplorer-enabled MapObjects IMS map in MOIMSWORKSPACE are made in the service attribute. In the above example, the name of the map is "GPS_Points". The url attribute gives the location of esrimap.dll located on the machine with MapObjects IMS. ArcExplorer-enabled maps do not work with the ArcIMS Servlet Connector. However, the ArcIMS Servlet Connector can be used with regular MapObjects IMS sites.

The DATASET name references the machine and domain and the MapObjects IMS map name separated by a colon (:). In the above example, the DATASET name is "mymachine.domain.com:GPS_Points".

SHAPEWORKSPACE, IMAGEWORKSPACE, and SDEWORKSPACE

SHAPEWORKSPACE, IMAGEWORKSPACE, and SDEWORKSPACE are used when local data is referenced in the viewer configuration file. These WORKSPACES elements reference data exactly the same way as in a map configuration file.

OVERVIEWMAP and SCALEBAR

OVERVIEWMAP and SCALEBAR are client configuration elements and add an overview map or scale bar, respectively. Both elements are saved when using ArcExplorer 4 or an ArcIMS Java Standard Viewer. Only SCALEBAR is saved in an ArcIMS Java Custom Viewer even if an overview map is present. Also, the ArcIMS Java Custom Viewer ignores these elements when a viewer configuration file is read into the viewer.

Viewer configuration file after new rendering

If an overview map or scale bar are present when a viewer configuration file is saved, the OVERVIEW and SCALEBAR elements are included.

Using OVERVIEWMAP and SCALEBAR:
<?xml version="1.0" encoding="UTF-8"?>
<ARCXML version="1.1">
  <CONFIG>
    <ENVIRONMENT>...</ENVIRONMENT>
    <MAP>...</MAP>
    <OVERVIEWMAP backgroundcolor="255,255,255" framefillcolor="255,0,0,80" frameoutlinecolor="255,0,0" zoomfactor="4.0">
      <LAYERDEF name="Oceans" />
    <LAYERDEF name="Countries" />
  </OVERVIEWMAP>
    <SCALEBAR backcolor="212,208,200" fontcolor="0,0,0" mapunits="decimal_degrees" scaleunits="feet" screenunits="inches" />
  </CONFIG>
</ARCXML>

If these two elements are included in a map configuration file, they are ignored.

Default.axl: A Special Viewer Configuration File

Default.axl is a special viewer configuration file that is output by ArcIMS Designer when an ArcIMS Java Viewer is created. The diagram below shows the process to create default.axl:
Viewer configuration file flow

Framework of default.axl

Default.axl uses a subset of elements normally found in a viewer configuration file. Its primary purpose is to load ArcIMS service layers specified during the ArcIMS Designer process.

Example default.axl file:
<?xml version="1.0" encoding="UTF-8"?>
<ARCXML version="1.1">
  <CONFIG>
    <MAP>
      <PROPERTIES>
        <ENVELOPE minx="-180.0" miny="-90.0" maxx="180.0" maxy="90.0" name="Initial_Extent" />
        <MAPUNITS units="decimal_degrees" />
      </PROPERTIES>
      <WORKSPACES>
        <IMAGESERVERWORKSPACE name="mapper_ws-6" url="http://mycomputer.domain.com/servlet/com.esri.esrimap.Esrimap" service="background" />
        <FEATURESERVERWORKSPACE name="ifs_ws-7" url="http://mycomputer.domain.com/servlet/com.esri.esrimap.Esrimap" service="World" />
      </WORKSPACES>
      <LAYER type="image" name="background" visible="true" id="0">
        <DATASET name="background" type="image" workspace="mapper_ws-6" />
      </LAYER>
      <LAYER type="featureclass" name="Countries" visible="true" id="1">
        <DATASET name="0" type="polygon" workspace="ifs_ws-7" />
      </LAYER>
      <LAYER type="featureclass" name="United States" visible="true" id="2">
        <DATASET name="1" type="polygon" workspace="ifs_ws-7" />
      </LAYER>
    </MAP>
    <SCALEBAR backcolor="212,208,200" fontcolor="0,0,0" mapunits="decimal_degrees" scaleunits="feet" screenunits="inches" />
  </CONFIG>
</ARCXML>

Only elements that are needed to load the ArcIMS services are included. The principal similarities and differences between default.axl and a viewer configuration file are:

Relationship between Feature Services and default.axl

When ArcIMS Designer creates default.axl and a Feature Service is included, one LAYER is included in default.axl for every LAYER in the Feature Service. Since no rendering is included in default.axl, the rendering defined in the ArcIMS service is what is used by the ArcIMS Java Viewers. Any changes to the rendering in the service are immediately reflected in the ArcIMS Java Viewers.

Caution is needed when adding or deleting layers in Feature Service. If a layer is added to a service but not to default.axl, the ArcIMS Java Viewer will not display the new layer. If a layer is deleted from a service but not default.axl, an error message appears in the ArcIMS Java Viewer because a layer referenced in default.axl cannot be found in the service. In summary, if a layer is added or deleted in a service, it should be added or deleted in default.axl.

Comparing Different CONFIG Files

The table below summarizes the similarities and differences between map configuration files, viewer configuration files, and default.axl.

  Map Config Viewer Config Default.axl
Primary purpose Used as input to ArcIMS services Saves current map and viewer configuration on the client Used to load ArcIMS services in an ArcIMS Java Viewer
Created by ArcIMS Author or XML Editor ArcExplorer 4 or ArcIMS Java Viewers ArcIMS Designer
File is located On server On client On server
Data sources Local network only and must be accessible by ArcIMS Spatial Server ArcIMS services and local network on client ArcIMS services only
Valid workspaces SHAPEWORKSPACE, IMAGEWORKSPACE, SDEWORKSPACE IMAGESERVERWORKSPACE, FEATURESERVERWORKSPACE, AVIMSWORKSPACE, MOIMSWORKSPACE, SHAPEWORKSPACE, IMAGEWORKSPACE, SDEWORKSPACE IMAGESERVERWORKSPACE, FEATURESERVERWORKSPACE, AVIMSWORKSPACE, MOIMSWORKSPACE