HOW TO

Edit the ArcGIS Raster Datasets raster type to read internal overviews

Last Published: April 25, 2020

Summary

Not all ArcGIS Image Server raster types offer identical options; however, anyone can edit the defaults or user interface to add the options they need. Instructions provided describe how to edit ArcGIS Raster Datasets raster type to use the internal overviews that may exist in a raster dataset.

Procedure

ArcGIS Image Server utilizes Extensible Markup Language (XML) for storing the definitions and properties of image services and raster datasets and for passing data between components such as the service provider and client. The structure of the XML is defined using an XML Attribute Definition (.XADef) file, and forms are created dynamically using XML Form Definition (XFDef) file.
Access one or both of these types of XML files that are installed, by default, in C:\Program Files\Common Files\ESRI\Image Server\XADefs\RPDef Generators.

There are two options available to perform this function. The first option is to edit the .XADef to include the internal overviews by default. This change is implemented in any of the methods used to add the raster dataset. The second option is to edit the .XFDef so a user has the option on the user interface. This is only presented to the user when they use the Add Raster Dataset method, not when they use either of the wizards.

OPTION ONE
To include internal overviews automatically, when adding ArcGIS Raster Datasets raster types, open the file c:\Program Files\Common Files\ESRI\Image Server\XADefs\RPDef Generators\AORaster.RPDefGen.Process.XADef in a text editor and change the IncludeInternalOverviews setting from False to True, as shown below.

From:

<IncludeInternalOverviews IncludeInternalOverviews_TYPE_="Bool" IncludeInternalOverviews_DESCRIPTION_="Include internal overviews" IncludeInternalOverviews_REQUIRED_="No" IncludeInternalOverviews_VALIDATIONRULE_="" IncludeInternalOverviews_LIST_="" IncludeInternalOverviews_LONGDESCRIPTION_="Specify whether internal layers of the Raster should be included." IncludeInternalOverviews_UOM_="" IncludeInternalOverviews_ID_="" IncludeInternalOverviews_HELP_="">False</IncludeInternalOverviews>

To:

<IncludeInternalOverviews IncludeInternalOverviews_TYPE_="Bool" IncludeInternalOverviews_DESCRIPTION_="Include internal overviews" IncludeInternalOverviews_REQUIRED_="No" IncludeInternalOverviews_VALIDATIONRULE_="" IncludeInternalOverviews_LIST_="" IncludeInternalOverviews_LONGDESCRIPTION_="Specify whether internal layers of the Raster should be included." IncludeInternalOverviews_UOM_="" IncludeInternalOverviews_ID_="" IncludeInternalOverviews_HELP_="">True</IncludeInternalOverviews>

OPTION TWO
To include the internal overviews option on the user interface, open c:\Program Files\Common Files\ESRI\Image Server\XADefs\RPDef Generators\AORaster.RPDefGen.Process.XFDef in a text editor and add the following under the forceDefaultSRS node.

<IncludeInternalOverviews IncludeInternalOverviews_LEFT_="" IncludeInternalOverviews_TOP_="" IncludeInternalOverviews_WIDTH_="" IncludeInternalOverviews_HEIGHT_="" IncludeInternalOverviews_TABINDEX_="" IncludeInternalOverviews_BOLD_="" IncludeInternalOverviews_READONLY_="" IncludeInternalOverviews_VISIBLE_="" IncludeInternalOverviews_ID_="">

</IncludeInternalOverviews>

The following displays where to insert the above text:
[O-Image] Where to place new text
Below is a result of the added text, when it is viewed in the GUI:

[O-Image] Addition to user interface

Article ID:000009670

Software:
  • ArcGIS Server

Get help from ArcGIS experts

Contact technical support

Download the Esri Support App

Go to download options

Related Information

Discover more on this topic

Esri Community

Search for related information

Training

Find training related to this topic

ArcGIS Ideas

Explore ideas and give feedback