Install and set up

Install on Windows

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. When the file extraction completes ensure the Launch the setup program check box is checked then click Close to continue the installation process.

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

7. 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.

8. 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.

9. Click Install.

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

Install on Linux

1. Ensure that your development machine meets the system requirements.

2. Download the ArcGIS Runtime Local Server SDK Linux 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. Using an archive manager extract the ArcGIS_Runtime_Local_Server_SDK_100_x_x.tar.gz gzip file to access the tar installer file. Alternatively use the terminal and extract the .tar.gz file with the following example command tar xvzf ArcGIS_Runtime_Local_Server_SDK_100_x_x.tar.gz.

4. Navigate to ArcGIS_Runtime_Local_Server_SDK_Linux64 and run ./Setup or in the GUI double click the Setup program to launch the installer.

5. Click Next on the Introduction dialog of the ArcGIS Runtime Local Server SDK 100.x Setup program to continue the installation.

6. 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.

7. When prompted to Choose Install Folder dialog, click Next accept the default installation location or click the Choose button to select a different destination folder. Make sure this directory is on your development machine and that you have write permissions to this directory. Ensure no other users are using the directory.

8. Review the Pre-Installation Summary then click Install. The installer will now unpack and install Local Server and create Menu shortcuts.

9. Click Done on the Install Complete dialog to finish the Local Server installation.

Install database client software for enterprise geodatabase connections

If the geoprocessing or map packages (.gpkx or .mpkx files) 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.

If you are using an Enterprise Geodatabase connection which uses ODBC you must modify init_user_params.sh to uncomment the following line:

1
2
3
4
5
#
# Enable this section to point to the native ODBC driver.  Note the path
# may be different on your system.
#
#export LIB_ODBC_DRIVER_MANAGER=/usr/lib64/libodbc.so.2

The exact path may differ depending on your installation. You may need to install the library unixODBC-utf16-2.3.1-1.x86_64 (or a later version).

Include a Local Server deployment with your application

On your development machine applications that use Local Server will use the Local Server instance in the installation directory referenced in the RUNTIMELOCALSERVER_100_x environment variable (where x is the current release number).

When you deploy your application you must create a Local Sever deployment and make the Local Server files available to your application in one of the following ways:

• Copy the generated Local Server deployment directory adjacent to your application executable file. By default the API will search for a Local Server deployment in this location before defaulting to the SDK installation location.
• Copy the generated Local Server deployment directory to an alternative location and define the install path for the Local Server using the LocalServer.INSTANCE.setInstallPath("c:/myLocalServerInstall"); method. Ensure the Local Server folder is deployed to that location as part of the application installation.
• Set up your own RUNTIMELOCALSERVER_100_x environment variable pointing to the Local Server directory; although this is typically used as a developer workflow. As above, 100_x refers to the current release number, for example 100_10.

Next steps

• Introduction

  Learn about Local Server.

• Install and set up

  Install and setup the Local Server SDK.

• Create geoprocessing and map packages

  Create .gpkx and .mpkx files for use with Local Server.

• Use Local Server

  Learn how to use Local Server services.

• Supported geoprocessing tools

  Check the tools you need are supported.