Install and set up

ArcGIS Runtime Local Server is supported on Windows when using either Esri.ArcGISRuntime.WPF or Esri.ArcGISRuntime.WinUI. Local Server is not supported for apps developed using .NET MAUI (Multi-platform App UI) or Universal Windows Platform (UWP).

Install Local Server SDK

  1. Ensure that your development machine meets the system requirements. Development and deployment machines must also have the following packages installed:

    • Microsoft Visual C++ Redistributable for Visual Studio 2019
    • Development and deployment on Windows 8.1, Windows Server 2012, Windows Server 2012 R2 also requires installation of the Windows 10 Universal C Runtime via the following Windows Updates or Update Packages:
      • Update for Windows 8.1 for x64-based Systems (KB3118401)
      • Update for Windows Server 2012 R2 (KB3118401)
      • Update for Windows Server 2012 (KB3118401)
  2. Download the ArcGIS Runtime Local Server SDK Windows setup from your ArcGIS Developer dashboard and save the file to a location on your development machine. You will need to sign in to your dashboard or create an ArcGIS Developer account.

  3. Double-click the executable (.exe) file in the location where you downloaded Local Server SDK download to extract the installation files.

  4. Click Next to accept the default destination folder where the installation files will be extracted or click Browse to select a different destination folder then click Next.

  5. The extraction dialog will complete when the files have been successfully extracted.

  6. Ensure the Launch the setup program check box is checked then click Close to continue the installation process.

  7. Click Next On the Welcome to the ArcGIS Runtime Local Server SDK Setup program window.

  8. Review the license agreement and choose an option:

    • If you agree to the terms, select the option to accept the agreement and click Next.
    • If you do not agree to the terms, click Cancel to exit the installation.
  9. Click Next to accept the default location of <System Drive>\Program Files\ArcGIS SDKs\LocalServer<version>\ or click Change to specify a different destination folder then click Next.

  10. Click Install.

  11. Click Finish. The Local Server SDK installation is complete.

Install database client software for enterprise geodatabase connections

If the geoprocessing or map package files (.gpkx or .mpkx) used by your application reference enterprise geodatabase connections, then you may need to install client software for the RDBMS (Relational Database Management System) on your development and deployment machines. For more information on supported database types, database versions, and client software required, refer to the ArcGIS Pro documentation topic Supported databases.

Add a reference to the Local Server API

To develop with ArcGIS Maps SDK for .NET and ArcGIS Runtime Local Server SDK you must add the Esri.ArcGISRuntime.LocalServices NuGet package to your WPF application project. The Esri.ArcGISRuntime.LocalServices NuGet package contains classes to work with ArcGIS Runtime Local Server. These classes include functionality for management of the Local Server environment, such as setting the path of temporary files, and classes for managing the lifecycle and properties of local geoprocessing and map services.

Local Server Nuget package manager

If the ArcGIS Runtime Local Server SDK is not installed on your development machine, the first time you build your project after referencing the Esri.ArcGISRuntime.LocalServices NuGet package you will receive a build error.Follow the steps above to install the ArcGIS Runtime Local Server SDK.

Visual Studio install error

Next steps

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.