Skip To Content

Administrator configuration

As an administrator, you can configure settings in ArcGIS Online and ArcGIS Enterprise, or via the configuration file to make ArcGIS Earth meet your organization's requirements. You can go to the ArcGIS Earth Sample Configuration File page and download the sample file. After installation, you can find the configuration file in the application installation directory, which is typically in the C:\Program Files\ArcGIS\Earth\bin folder.

To configure the application settings with a configuration file, keep the following in mind:

  • You can preset configuration parameters and import the modified config.xml file during installation.
  • The configuration file is an XML file that can be modified as needed. For example, when you edit the file, use & instead of & to specify an escape character. Make sure the configuration file remains encoded as UTF-8 after editing.
  • Configurations preset by the administrator are automatically loaded when a user starts the application for the first time.
  • Users can adopt parameters configured by the administrator in the bin folder by clicking Reset from the application Settings.
  • For per-user installation of ArcGIS Earth, you can also find and edit the configuration file in the application installation directory, for example, C:\Users\username\AppData\Local\Programs\ArcGIS\Earth\bin.

Organizational configurations

Some settings in ArcGIS Earth use the organizational configurations of your ArcGIS Online or ArcGIS Enterprise portal account. These settings include the basemap, elevation service, and geocoding service used by ArcGIS Earth. See Set the basemap gallery and default basemap, Configure default elevation service, and Geocoding for details if you connect to ArcGIS Enterprise. See Administer organization for details if you connect to ArcGIS Online.

Configurable application parameters

Administrators can use the configuration file to change settings without recompiling the application. Users can also set policies that affect how ArcGIS Earth runs on their machine. Administrators can access the config.xml file in the installation directory, and specify values for corresponding attributes to customize a preferred startup setting by changing configurable parameters.

General application parameters

ElementDescription

general

workspace

Specifies the directory of the current workspace and whether to save a workspace on exit.

startupView

Sets the startup view as Custom or History.

spatialReference

Sets the spatial reference used by ArcGIS Earth as Web Mercator or WGS84. The default is WebMercator.

isShowInExternalBrowser

Displays HTML links in the pop-up window with an external browser. The default is False.

isShowStartupTips

Displays startup tips when starting the application. The default is True.

Tip:

Administrators can customize the contents of startup tips by updating the HTML files in the tips folder from the application installation directory.

language

Sets the display language for ArcGIS Earth user interface text. The default value is System.

If the value is System, ArcGIS Earth will match Windows display language setting.

navigation

flyto

Sets the fly-to speed between 0 and 100 and automatically zooms to a new layer. The default is True.

mouseWheel

Sets the mouse wheel speed between 0 and 100 and wheel zoom direction to forward or backward. The default is Forward.

continuousPanning

Turns continuous panning on (True) or off (False). The default is True.

nonMouseController

Enables navigating ArcGIS Earth with a nonmouse controller.

effects3d

atmosphere

Turns the enhanced atmosphere effect on or off. The default is Off.

elevationExaggeration

Sets the elevation exaggeration factor for terrain. The default is 1.

units

location

Specifies the default location unit. The default is DMS.

distance

Specifies the default distance unit. The default is Meters.

area

Specifies the default area unit. The default is SquareMeters.

isLongitudeFront

Flips latitude-longitude order of coordinates on search and display. The default is True.

advanced

proxy

Sets to use proxy (Boolean; optional). The default is False.

address

Specifies the address for the proxy server.

username

Specifies the user name for the proxy server.

password

Specifies the password for the proxy server.

Administrator application parameters

ElementDescription

isDefaultKmlViewer

Sets ArcGIS Earth as the default KML viewer. The default is False.

blockArcGISOnline

Blocks request and portal connection to ArcGIS Online when starting ArcGIS Earth. The default is False.

portals

portal

Sets the portal URLs to where ArcGIS Earth will connect.

Tip:

If the administrator lists multiple portal URLs in the configuration file, ArcGIS Earth will use the first portal as the active portal after installation.

pkiServers

Configures a list of portals or servers for ArcGIS Earth to send credentials to when working with services secured with PKI authentication, especially for the Oracle Access Management servers.

fonts

symbolFontName

Specifies the font for labels of the drawing element.

Note:

Use the font name inside the font file as the element value, and make sure the specified font file is installed on your operating system.

log

Records log information in the ESRI\ArcGISEarth\logs folder from user's AppData directory, for example, C:\Users\username\AppData\Roaming.

category

Records error logs by Debug, Info, Warning, and Error categories. The default is True.

rollSizeKB

Sets the maximum value of each log size. The default is 10000.

maxArchivedFiles

The maximum number of log files to be stored. The default is 1000.

startupLayers

layer

Sets up startup layers in the table of contents and configures the name, URL, type, and visibility.

Tip:
  • Startup layers support data types including KML/KMZ, WMS, shapefile, raster, tile package, scene layer package, and ArcGIS services.
  • The warning icon indicates the path is missing, or data is broken or not accessible.

group

Organizes startup layers into hierarchical groups.

organizationalBasemaps

basemap

Sets the basemaps for your organization.

Tip:

Organizational basemap layers support data types including KML/KMZ, WMS, raster, tile package, scene layer package, and ArcGIS services.

organizationalTerrains

terrain

Sets up terrains for your organization.

Tip:

Organizational terrain layers support data types including local raster and elevation image service. See Basemap and terrain for more details.

positionServiceUrl

Allows an administrator to enter a URL with some encoded values, which will be recognized by ArcGIS Earth and filled with location information. When using Ctrl+Right-click on the globe, the URL will be invoked and the latitude, longitude, and elevation of the point clicked will be passed to that URL. As long as the URL returns a valid KML file, the KML file will be displayed in the viewport.

Read an example from the ArcGIS Blog: Point Based Service access with ArcGIS Earth.

urlwithpos

Sets up the key attribute on the add element under the ServiceURL element to enable this feature.

Tip:
  • % LONGITUDE%—Key value that represents the longitude of the point clicked.
  • % LATITUDE%—Key value that represents the latitude of the point clicked.
  • % ELEVATION%—Key value that represents the elevation of the point clicked, currently in meters.
  • % HEADING%—Key value that represents the heading that the map view is currently facing.

urlwithoutpos

Sets up information that ArcGIS Earth will read. The information is a KML file returned from the service call without storing it on disk.

localKmlIcons

Enables access to a local KML Icons folder. The default is False.

Tip:

If it's set as False, ArcGIS Earth will use KML icons from google.com. If it's True, and the value for path is left empty, ArcGIS Earth will use local KML icons from the \resources\symbols\kml folder in the installation directory, typically C:\Program Files\ArcGIS\Earth\.

path

Sets up the local KML icon path. You can point to a customized icon folder.

acknowledgement

text

Specifies the display text for acknowledgements.

url

Specifies the URL address for acknowledgements.

help

text

Specifies the display text for help.

url

Specifies the URL address for help.

bannerBar

height

Sets the banner height.

background

Sets the background color of the banner.

bottomOffset

Sets the offset to the bottom of the frame.

bannerText

content

Edits the banner text.

contentAlignment

Sets the alignment between texts.

fontColor

Specifies and sets the text color of the banner.

fontName

Specifies the font name for the text of the banner.

fontSize

Specifies and sets the text size of the banner.

fontStyle

Specifies and sets the text style of the banner.