Skip To Content

System checks

During installation, the ArcGIS Maps for SharePoint installation wizard runs a series of system checks to verify that all required or dependent services or software are correctly installed and running before installing the solution and add-in. If an issue is found, the wizard displays an error or warning. Some issues must be corrected immediately before the installation can proceed; others do not impact the installation but must be rectified to allow ArcGIS Maps for SharePoint to operate properly.

All system check resolutions must be performed by the SharePoint farm administrator.

The following sections list possible errors and warnings and their resolutions. The first system check verifies your system for components required to install ArcGIS Maps for SharePoint. If any of these component checks fail, pause the installation, resolve the issue, and click Re-run checks to ensure that the issue is resolved before you proceed with the installation. The additional services check verifies if additional services and applications are running. These services or applications are required to allow ArcGIS Maps for SharePoint to operate properly but will not impede the current installation. Most of these services are fundamental to a healthy SharePoint farm, which, in most cases, will already be properly configured. If any of these service checks fail, pause the installation, resolve the issue, and click Re-run checks before you proceed with the installation.

Required services

  • Is SharePoint Foundation Services 201x installed?

    This check fails when the current machine does not have SharePoint Foundation Services 201x installed.

    Solution: Install ArcGIS Maps for SharePoint on a system that has SharePoint Foundation Services 201x installed.

  • Do you have permission to install and deploy SharePoint solutions?

    This check fails when the user running the ArcGIS Maps for SharePoint installer is not a SharePoint administrator.

    Solution: You must be a SharePoint farm administrator to install ArcGIS Maps for SharePoint. Run the setup as Administrator.

  • Is the SharePoint 201x Administration service started?

    This check fails when the SharePoint 201x Administration service is not running.

    Solution: Start the service in Windows Services (run services.msc). The name of the service is SharePoint 201x Administration.

  • Is the SharePoint 201x Timer service started?

    This check fails when the SharePoint 201x Timer service is not running.

    Solution: Start the service in Windows Services (run services.msc). The name of the service is SharePoint 201x Timer.

  • Does the solution file exist?

    The solution file is named ESRI.ARCGIS.Mapping.SharePoint.wsp and is bundled in the root directory of the installer folder. If this file is manually deleted or renamed, this system check will fail.

    Solution: Restore the original ESRI.ARCGIS.Mapping.SharePoint.wsp solution file to the ArcGIS Maps for SharePoint installer folder.

  • Detecting ArcGIS Maps for SharePoint

    This check verifies whether the current SharePoint farm contains a previous version of ArcGIS Maps for SharePoint. Depending on the results of the check, you are presented with different installation options, such as remove, modify, install, or upgrade.

SharePoint service applications

All SharePoint on-premises servers that host ArcGIS Maps for SharePoint must have several SharePoint Service Applications configured and running. The following table lists the required and recommended services.

SharePoint Service Application typeRequired stateMicrosoft helpSharePoint 2013SharePoint 2016SharePoint 2019

App Management Service Application

Started

Configure an environment for apps for SharePoint Server

Required

Required

Required

App Management Service Application Proxy

Started

Configure an environment for apps for SharePoint Server

Required

Required

Required

Business Data Connectivity Service Application

Started

Configure a Business Data Connectivity service application in SharePoint Server

Recommended

Recommended

Recommended

Business Data Connectivity Service Application Proxy

Started

Configure a Business Data Connectivity service application in SharePoint Server

Recommended

Recommended

Recommended

Managed Metadata Service

Started

Configure the Managed Metadata service

Required

Required

Required

Managed Metadata Service Connection

Started

Configure the Managed Metadata service

Required

Required

Required

Search Service Application

Started

Create and configure a Search service application

Required

Required

Required

Search Service Application Proxy

Started

Create and configure a Search service application

Required

Required

Required

Secure Storage Service Application

Started

Configure the Secure Store Service

Recommended

Recommended

Recommended

Secure Store Service Application Proxy

Started

Configure the Secure Store Service

Recommended

Recommended

Recommended

Security Token Service Application

Started

Configure the Secure Store Service

Required

Required

Required

Microsoft SharePoint Foundation Subscription Settings Service Application

Started

Subscription Settings Service Application Step by Step

Required

Required

Required

Microsoft SharePoint Foundation Subscription Settings Service Application Proxy

Started

Subscription Settings Service Application Step by Step

Required

Required

Required

Usage and Health Data Collection Service Application

Started

Configure usage and health data collection in SharePoint Server

Recommended

Recommended

Recommended

Usage and Health Data Collection Service Application Proxy

Started

Configure usage and health data collection in SharePoint Server

Recommended

Recommended

Recommended

Note:

  • Required—This service is required for ArcGIS Maps for SharePoint to function.
  • Recommended—One or more subfeatures of ArcGIS Maps for SharePoint relies on this service. Without this service, some features will not be available.
  • Not required—ArcGIS Maps for SharePoint does not require this service for this version of SharePoint.
  • Not applicable—This version of SharePoint does not support this service.

Additional features

  • Install and run SharePoint add-ins

    Beginning with SharePoint 2013, on-premises versions of SharePoint Server use an add-in model in addition to the solution model used in previous versions.

    Solution: If you're using SharePoint 2013 or later, your SharePoint farm must be preconfigured to support third-party add-ins. For more information, see Configure an environment for apps in SharePoint 2013.

  • Geotag documents

    Geotagging allows you to tag documents in your SharePoint site collections with values that indicate location. Geotags generated by ArcGIS Maps for SharePoint are stored in a new term set in the term store managed by the SharePoint Managed Metadata service. The Managed Metadata service must be running to enable geotagging in ArcGIS Maps for SharePoint.

    Solution: Run the Managed Metadata service. For more information, see Configure the Managed Metadata service in SharePoint 2013.

  • Geosearch documents

    Geosearching allows you to search for documents that have been geotagged with location information. ArcGIS Maps for SharePoint uses the SharePoint enterprise search function commonly used in production SharePoint farms. The Search and Site Settings service and the Search Host Controller service must be running to enable geosearching in ArcGIS Maps for SharePoint.

    Solution: To enable geosearching, the add-in requires underlying search-related services. For more information, see Create and configure a Search service application in SharePoint 2013.

  • Use ArcGIS Maps Connect workflow

    The ArcGIS Maps Connectworkflow is a custom Business Connectivity Service (BCS) feature that allows ArcGIS Maps for SharePoint to connect to external data, such as a SQL Server database. The Business Data Connectivity (BDC) service must be running to enable the ArcGIS Maps Connect workflow.

    Solution: The ArcGIS Maps Connect workflow requires a BCD service. For more information, see Configure a Business Data Connectivity service application in SharePoint 2013.

  • Use SSS to store ArcGIS credentials

    You can optionally use Secure Store Service (SSS) to store ArcGIS credentials. If you do, the SSS must be running. If the service is not running and you proceed with the installation, the Use SSS option during installation will not be available. You can configure SSS after installation when you configure the app part. For more information, see Configure ArcGIS Maps for SharePoint.

    Solution: Run the SSS. For more information, see Configure the Secure Store Service in SharePoint 2013.