Modify Web.config Settings

If necessary, navigate to C:\inetpub\wwwroot\Wavepoint and open Web.config in a text editor (Notepad++ or XMLSpy).

This section discusses each of the configurable entries and what you can accomplish in them. If you would like to see a sample Web.config in its entirety, visit the myArcFM page Wavepoint-Example web.config file.

You can adjust the following Web.config keys to suit your business needs:

AGSRoot - Required

Change the URL in that line to reflect the machine you are using as your server:

<add key="AGSRoot" value=http://yourserver:6080/arcgis /> 

AGSMapServicePath - Required

This is the name of your published map service. For example, in the earlier step Register Data in ArcGIS Server Data Store, it is Wavepoint_MapService.

<add key="AGSMapServicePath" value="Wavepoint_MapService" />

AGSLogin and AGSPassword - Recommended

We strongly encourage you to secure your service. If you do not provide a value for AGSLogin, no password is required to access the service.

This password should never be identical to your Server Manager password.

<add key="AGSLogin" value="example_password" />
<add key="AGSPassword" value="example_password" />

ALoss and BLoss - Optional

The Web.config file comes pre-populated with wavelengths of 1310 and 1550 nanometers (nm).

<add key="ALoss" value="1310" />
<add key="ALoss" value="1550" />

Searchable Layers - Optional

You can limit which layers are searchable in the Wavepoint search tool.

By default, all layers in the published service are searchable. Adding entries limits the search.

<add key="SearchableLayers" value="" />

To limit the list of search layers, add layer numbers to the Web.config file's SearchableLayers setting. Separate each layer number by a space.

<add key="SearchableLayers" value="3 7 12" />

To determine layer numbering, visit the REST URL page for the map service. The REST URL is located on the Capabilities menu for the map service itself.

  • Do not add table numbers since the search tool supports only feature classes.

  • Do not add layer numbers corresponding to features for which Wavepoint displays a one-line diagram. These include splices and patch locations. Wavepoint uses a different mechanism for including these features in its search.

LocatorServiceUrl - Recommended

We strongly recommend you use the default value here, which is the ArcGIS Online locator service. You can, however, provide the URL of another locator service.


Wavepoint versions 10.1.1 and 10.2 shipped with the following default value for this key in the Web.config file:

<add key="LocatorServiceUrl" value="" />

In late 2013 the value above was discontinued by Esri.

Use the following key instead:

<add key="LocatorServiceUrl" value="" />

UseAGOLBasemaps - Optional

Set this value to true if you want all of the ArcGIS Online basemaps to display. Set to false if you do not want to display ArcGIS online basemaps.

<add key="UseAGOLBasemaps" value="true" />

UseBingBasemaps and BingMapApiKey - Optional

Set this value to true if you want all of the Bing basemaps to display.

<add key="UseBingBasemaps" value="true" />

If you set this value to true, you must supply a BingMapsApiKey. Refer to Microsoft's Bing maps help topic for guidance.

<add key="BingMapApiKey" value="123exampleAPIKey456" />

If you do not intend to use Bing Maps, change the value to false and set the API key to a dummy value. You can literally use the word dummy as the value.

<add key="UseBingBasemaps" value="false" />
<add key="BingMapApiKey" value="dummy" /> 

Custom Basemaps - Optional

You may not want to include all Bing or all ArcGIS Online basemaps. It is possible to configure a subset of each individually or together to provide your own fully customized basemap. Read Configure Custom Basemaps (optional) to learn more about custom basemap configuration.

If you do opt to customize the list of basemaps, an example entry in the Web.config could look like the following:

<add key="basemap.1" value="{title:'My Streets', url:'', type:'OpenStreetMap', key:'', thumbnail:''}" />
<add key="basemap.2" value="{title:'Hybrid', url:'', type:'BingMapsHybrid', key:'', thumbnail:''}" />
<add key="basemap.3" value="{title:'Light Gray', url:'', type:'agol', key:'8b3b470883a744aeb60e5fff0a319ce7', thumbnail:''}" />
<add key="basemap.4" value="{title:'Imagery', url:'', type:'agol', key:'86de95d4e0244cba80f0fa2c9403a7b2', thumbnail:''}" />

InitialMapCenter - Recommended

When the application opens, the map centers on a specified geography. Enter the decimal degree location for the longitude (x) and latitude (y), separated by a comma. It is required to specify the longitude first, followed by the latitude. For example, for the map to open centered on Fort Collins, CO, USA, the entry looks like the following:

<add key="InitialMapCenter" value="[-105.0284,40.5690]" />

InitialMapZoom - Optional

When the application opens, the map starts at a specified zoom extent. This extent is dictated by an integer value for the IntialMapZoom (decimal values are not permitted). The minimum is 0 and the maximum is 20. The lower the number, the farther the map is zoomed out upon opening the application. The higher the number, the closer the map is zoomed in. Think of it like a volume control on a radio, where you don’t choose an exact decibel value, but instead use a relative scale of low to high. Finding the best starting zoom is best tested with your end users.

For example, setting the value at 0 means the map opens essentially at a world-wide scale:

And, setting the value at 20 means the map opens at a parcel level scale:

The default value provided in the Web.config is 11.

<add key="InitialMapZoom" value="11" />

PointGeometryZoom - Optional

You can add this entry in the Web.config if you want the map to zoom on point features at a different zoom extent than the initial map zoom extent. This is an optional setting.

Just like the InitialMapExtent, the PointGeometryZoom is dictated by an integer value (decimal values are not permitted). The minimum is 0 and the maximum is 20. The lower the number, the farther the map zooms out when you click a point feature. The higher the number, the closer the map zooms in when you click a point feature.

For example, if the InitialMapExtent value is 11, typing in a value of 15 for the PointGeometryZoom means the map zooms in closer when navigating to point features.

TIP: Regarding line features, there is no separate entry, as the application initially zooms to the geographic extent of the line, using the begin and end points to set the zoom extent.

<add key="PointGeometryZoom" value="15" />

PortStateColors - Optional

This key is used to change the port colors visible in the Wavepoint rack view and in other views as well.

The following is the default value of this field:

<add key="PortStateColors" value="1(Circuit):#FF6600, 2(Reserved):#FF0000, 3(Damaged):#FFFF00, 4(Available):#9900FF, 5(Permanent - In Service):#000000, 6(Temporary - In Service):#0000CC, 7(Allocated - Not Installed):#FF6600, 8(Installed - Not In Service):#CC66CC, 9(Uncertain):#444455, -1(Other):#555555

Follow the same pattern when making modifications:

Coded value from a domain such as Port Status(optional name such as Circuit):Hex Color Code

DistanceUnits - Recommended

Change this to the distance unit label you would like to see in the Wavepoint application.

For example, enter ft for feet:

<add key="DistanceUnits" value="ft" />

Or, enter m for meters:

<add key="DistanceUnits" value="m" />

DefaultSpatialReference - Required

As stated in the topic Configure Customer Basemaps (optional), you are allowed one projection for all basemaps. In other words, different basemaps cannot have different projections. So, if you have opted to include ArcGIS Online maps, you must enter the value for WGS Web Mercator, as that is the projection used by this service.

If you are not using the online service, this value should match the spatial reference of your company’s custom basemaps.

For more information, read the ArcGIS Resources topic Web Map Specification.

The following example uses the value for WGS Web Mercator:

<add key="DefaultSpatialReference" value="{wkid:102100}" />

IdentifyBuffer and IdentifyTolerance - Optional

By default, the Web.config provides a buffer of 10 as the search proximity when users attempt to identify a feature on the map. For usability purposes, this gives the user a small buffer around the click point when identifying features.

<add key="IdentifyBuffer" value="10" />
<add key="IdentifyTolerance" value="10.0" />

DisplayFieldOverrides - Optional

Normally Wavepoint defers to ArcGIS Server to acquire the display field for a given entity.  In that case, leave the entry as the default:

<add key="DisplayFieldOverrides" value="[]" />

If you need to override this and use a different column than the display field, DisplayFieldOverrides can be specified. This is a JSON field, so the value needs to be valid JSON. Otherwise, this value is ignored.

In the example, this key value tells the application to use PortName as the display field for layers with layerID 37 and layerID 40.

<add key="DisplayFieldOverrides" value="[{ 'layerId': 37, 'displayField': 'PortName' },{ 'layerId': 40, 'displayField': 'PortName']" />

DisableQueryPagination - Recommended

Due to issues encountered with SQL Server 2008 R2 and its lack of support for pagination, you can set this Boolean value to DisableQueryPagination = true. If you do not encounter issues, this can safely be omitted.

<add key=”DisableQueryPagination” value=”true” />

QR code for this page

Was this helpful?