Deploy Local Server

Build a Local Server deployment

For your deployed application to use Local Server functionality, you must create a Local Server deployment to include with your application.

The ArcGIS Maps SDK for Local Server installation includes all the components of Local Server that might be required during the development of your application. When deployed to production, your application may only need a subset of these components. Use the Local Server Deployment Builder to create a Local Server deployment directory that includes only the components that your application requires. This will reduce your application footprint. The Local Server Deployment Builder is included with the Local Server SDK. You can open it from the Windows Start menu or the Local Server SDK installation folder, for example on Windows C:\Program Files\ArcGIS SDKs\LocalServer200.1\Tools\DeploymentBuilder.exe.

Local Server Deployment Builder

To create a new configuration:

  1. Click Create Configuration to start the process.
  2. On the Deployment Configuration dialog, enter a name for your configuration and click OK.
  3. The deployment builder will then automatically display the Local Server Deployment Settings dialog where you can configure the components required for your application to successfully execute all functionality that requires Local Server.
  4. When you have finished selecting the required sub-components of Local Server, click OK to return to the Local Server Deployment Builder dialog.
  5. When you are ready to create the deployment, in the Configurations list select the Configuration you just created then click Generate....
  6. On the next dialog, titled Deployment Location you must specify, or browse for, a folder path for the output location of your Local Server deployment, then click OK.
  7. Finally, the Summary dialog displays the name of your configuration and its output location, along with your selected deployment options and their estimated size on disk.
  8. Click OK to proceed with generating the Local Server deployment.

You can make this Local Server deployment directory 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 directory 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 LocalServer::instance()->setInstallPath("c:/myLocalServerInstall"->path());. Ensure the Local Server deployment directory is deployed to that location as part of the application installation.

Local Server components

Deployment ComponentDescription
ArcGIS Pro Compatible Server (Pro)This is required if your application uses any local services.
Microsoft C and C++ Runtime Libraries (ProCRuntime)Including Microsoft VC++ libraries in the runtime deployment following the app-local pattern allows for XCopy style deployments. Only include these if your setup is not installing the Microsoft Visual C++ redistributable packages.
Geoprocessing (ProGeoprocessing)
Available sub-packages:
  • 3D Analyst extension (Pro3DAnalyst): Required for any geoprocessing packages that make use of 3D Analyst tools.
  • Geocoding (ProGeocoding): Provides the ability to use ArcGIS Locators.
  • Map packaging (ProMapPackaging): Adds data consolidation, map packaging and create runtime content tools.
  • Map Server Results (ProMapServerResults): Required to add geoprocessing results as map services.
  • Network Analyst (ProNetworkAnalyst): Required for any geoprocessing packages that make use of Network Analyst tools.
  • Spatial Analyst (ProSpatialAnalyst): Required for any geoprocessing packages that make use of Spatial Analyst tools.
Provides the ability to perform geoprocessing tasks via geoprocessing packages. For a list of supported tools, refer to the Supported geoprocessing tools topic.
Python Scripting (ProPythonScripting)Provides the ability to use Python scripts in geoprocessing or labeling.
Additional Data Formats (ProAdditionalDataFormats)
Available sub-packages:
  • Raster (ProRaster): Provides additional raster file data format support. For a list of supported rasters, refer to the ArcGIS Pro documentation topic Raster file formats.
  • ECW Rasters (ProECWRasters)
  • Mosaic Rasters (ProMosaicRasters)
  • Vector (ProVector): Provides additional vector file data format support such as the ability to use shapefiles.
  • SDE (ProSDE): 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 RDBMS: Dameng, IBM Db2, Microsoft SQL Server, Oracle, PostgreSQL, SAP HANA, SQLite, or Teradata. The drivers for the specified database must be present on the target machine.
Provides additional vector file data format and raster file data format support. Enable the appropriate packages for the formats your application needs to support.
Additional Projection Engine Transformations (ProAdditionalProjectionEngineTransformations)Adds additional projections and geotransformations. For more information on coordinate systems, refer to the Spatial references topic.
Debug (ProDebug)
Available sub-packages:
  • Logging (ProLogging): Supports writing log messages from your running app.
Supports debugging of your deployed app. Should be used for testing only, and not included in your final app deployment.

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