Deploy your app

Applications built with ArcGIS Runtime SDK for Java are self-contained. For example, they do not add keys to the registry. Deploying them can be as simple as copying and pasting your runnable .jar files along with other dependent files to a different machine or device. Likewise, uninstalling can be as simple as deleting the files. The SDK lets you build and deploy self-contained, stand-alone applications or build and deploy capabilities into existing software.

Follow the steps below to ensure you've licensed the capabilities your app uses and that you understand associated costs.

  1. License the capabilities you included in the app. Licensing comes in two levels, Basic and Standard. License your app describes license levels and costs associated with deployment.
  2. Attribute Esri in your application. For details, see the attribution section in License your app.
  3. Prepare your application: compile your application, and then place it and any associated resources, such as packages, data, or dependent .jar files, inside a folder you intend to use as a deployment folder. Include all of the .jar files in <installation directory>/sdk/jars except for the ArcGIS_Runtime_Java_Toolkit-sources.jar file. Make sure you include ArcGIS_Runtime_Java_Toolkit.jar if you've used any toolkit classes (likely).
  4. Because every application requires a minimum set of Runtime components, you must create a Runtime deployment using the Deployment Builder as described in Build a Runtime deployment. This results in a folder named arcgisruntime10.2.4 that contains files required by your application. For applications that use local services, the runnable .jar file is at the same level as the arcgisruntime10.2.4 folder. The application will use the local server contained in the arcgisruntime10.2.4 folder. On Windows, you can confirm this in Windows Task Manager by checking the Image Path Name of the Runtime LocalServer.exe processes. Alternatively, the application code can specify an alternative location for the arcgisruntime folder.
  5. The deployment folder now contains everything you need to deploy your application. To distribute and deploy your application, copy and paste the deployment folder onto each of your end-user's machines or devices. Each deployment folder can be self-contained and consists of the following:
    1. Your application (runnable .jar).
    2. Supporting .jar files your application uses, including dependent .jar files.
    3. Runtime components from step 4 in a folder named arcgisruntime10.2.4.
    4. Supporting files, such as data or packages for local use. When you package data for use with your application, a report is provided that tells you which Runtime components the package requires. Use this report to determine which Runtime components to select during the deployment process.
  6. Test the application by running it from this location.
  7. Caution:

    For ArcGIS Runtime SDK deployments to Linux, it is particularly important that an application is not tested by running it from the deployment folder, as the SDK creates files that are specific to the current machine and user. To test a Linux deployment, make a copy of the deployment folder, test using one copy, and deploy the other clean copy. Similarly, deployments to Linux should only be run from a USB if they are not intended to be deployed to a different machine.

Related topics