ArcGIS Runtime SDK for Java

Create a Local Server deployment

Local services allow you to deploy services that run locally with your app to provide functionality like geoprocessing, routing, and so on. Local services are only available for Windows and Linux apps. An app built for other platforms can use such functionality from an online service, but not locally.

Deploying Local Server

Because every application that uses Local Server requires a minimum set of components, use the Local Server Deployment Builder tool to create a deployment as described in the following procedure. In this process, you select the components to include which helps ensure you deploy only the components you need, keeping your application footprint small. For a description of the optional components, see the section ArcGIS Runtime components.

The Local Server Deployment Builder does not collect/bundle:

  • Dependent .jar files (platform-specific JARs).
  • Your application files.


A deployment for Windows cannot be used on a Linux environment, and a Linux deployment will not be suitable for Windows. Windows uses .dll files (Dynamic Link Libraries) and Linux uses .so (Shared Object) files.

  1. Start the Local Server Deployment Builder.
    The ArcGIS Runtime Local Server Deployment Builder appears.
  2. Click the Create Configuration button.
  3. In the Deployment Configuration dialog box, in the Name text box, type a name for the configuration you're creating, then click OK. Configurations you create can be used as templates for future configurations. This name is used as the first part of the name of the folder it creates to store the deployment.
  4. In the Version text box, type a number for the version of the deployment you named in the previous step. Deployment Builder uses this version as the last part of the name of the folder it creates to store the deployment. Once you've created at least one deployment, when you specify a different version for a deployment with the same name, Deployment Builder creates a new deployment folder for the new version.
  5. In the Platform area, select from the drop-down either 64-bit or 32-bit. This indicates whether the deployment's software will be 32-bit or 64-bit.
  6. In the Local Server Functionality area, check the check boxes that correspond to the capabilities (components) you've included in the application you're deploying. If you don't check any boxes, no component files will be included in the deployment. When you package data for use with your application, a report is provided (by analyzers) that tells you which options to select in this step. For a description of each option, see the ArcGIS Runtime components section. You can also click an item in the dialog box to view a brief description of it.
  7. When you're finished selecting options, click OK to close the dialog box.
  8. In the ArcGIS Runtime Local Server Deployment Builder dialog box, the deployment name and version you just specified will be selected. Click the Generate button to create a deployment for it.
  9. In the Deployment Location dialog box, in the Folder text box, type a path for or browse to an existing folder where you want the Deployment Builder to write the deployment. If you previously created a deployment in this folder and you're using the same deployment name (step 3) and the same version (step 4) as you did previously, the previous deployment will be overwritten.
  10. Click OK.
    The Deployment Builder displays a summary of the deployment it is about to generate. Also provided are notes about requirements for content creation.

  11. Click OK.
    The Deployment Builder writes the selected components to the folder you specified and displays a summary dialog box that provides details on the files copied.

After you create the deployment, copy it to a location where your app can find it. For details, see the Local Server topic.

ArcGIS Runtime components

The ArcGIS Runtime components available to include in your Local Server deployment are described in the following table.


Microsoft C and C++ Runtime Libraries

Including Microsoft C and C++ libraries in the runtime deployment allows for XCopy style deployments. Only include these if your setup is not installing the Microsoft redistribution package.

Local Server

Required if your application uses any local services. This is enabled by default when you initially add the Local Server package to your project.


Provides the ability to perform geoprocessing tasks via geoprocessing packages. For a list of supported tools, see Supported geoprocessing tools.

3D Analyst extension

Required for any geoprocessing packages that make use of 3D Analyst tools.

Map packaging

Adds data consolidation, map packaging and create runtime content tools.

Map Server Results

Required to add geoprocessing results as map services.

Network Analyst extension

Required for any geoprocessing packages that make use of Network Analyst tools.

Spatial Analyst extension

Required for any geoprocessing packages that make use of Spatial Analyst tools.

Python Scripting

Provides the ability to use Python scripts.

Python geoprocessing tools

Provides support for geoprocessing tools that use Python.

Additional data formats

Provides additional vector file data format and raster file data format support.


Provides additional raster file data format support. For a list of supported rasters, see Supported raster dataset file formats.

ECW Rasters

Provides support for ECW format raster.

Mosaic Rasters

Provides support for raster mosaic layers.


Provides additional vector file data format support such as the ability to use shapefiles.


Adds support to allow you to connect directly to enterprise geodatabases. This option must be selected in conjunction with at least one of the following DBMSs: Alitbase, Dameng, DB2, Informix, Netezza, Oracle, PostgreSQL, SAP HANA, SQL Server, SQLite, or Teradata. The drivers for the specified database must be present on the target machine.

Additional projection engine transformations

Adds additional projections and geotransformations. For more information on coordinate systems, see Spatial references.


Supports debugging of your deployed app. Should be used for testing only, and not included in your final app deployment.


Supports writing log messages from your running app.