License

Before you deploy your ArcGIS Runtime app into production, you're required to license it with one of the four ArcGIS Runtime licensing capabilities levels: Lite, Basic, Standard, or Advanced. ArcGIS Runtime extension licenses can also be applied to bring additional functionality into your app.

Other costs may be incurred when deploying your app, such as transactions used with ArcGIS Location Services. Refer to deployment and our FAQ for more information on the terms and conditions.

Develop and test

You can download and install an ArcGIS Runtime SDK using an ArcGIS Developer account. You then have access to all of the functionality in the API for development and testing purposes. In this mode, the app will adopt the following behavior:

• Any map or scene will be watermarked with the words Licensed For Developer Use Only.
• A message will be written to the console or log that states that the app is Licensed For Developer Use Only.

Licensing your app for deployment will remove the watermark and console output and provide the appropriate capabilities to your app users.

Licensing options

Before you can use your app in production, you are required to license the ArcGIS Runtime app. Esri provides four ArcGIS Runtime license levels: Lite, Basic, Standard, or Advanced. Each additional level opens more capabilities for your app users.

Two options are available to set the license level in your app:

Named User licensing

A named user (also known as an ArcGIS identity) refers to an ArcGIS organizational account that is a member of an organization in ArcGIS Online or ArcGIS Enterprise. The ability to license an ArcGIS Runtime app is just one feature of a named user. You need to include code in your ArcGIS Runtime app to enable a user to sign in (log in) to a portal and return license details associated with their named user account.

Use Named User licensing if your target audience has access to ArcGIS Online or ArcGIS Enterprise and use devices that will be online at least once every 30 days (timeout for a Named User license for ArcGIS Runtime). One notable benefit of this model is the license for ArcGIS Runtime travels with the named user, not the app, so one named user can license many ArcGIS Runtime apps.

License string

A license string is a text string that contains license details. license strings can be acquired through your ArcGIS Developer account or purchased in ArcGIS Runtime deployment packs. license strings are usually compiled into your ArcGIS Runtime app. Each installation of your app available to a single user counts as a deployment.

Use a license string if your target audience does not have access to named user accounts with an ArcGIS Online organization or on-premises ArcGIS Enterprise portal, needs to use an application that will remain offline indefinitely, or needs to guarantee an application will function if offline more than 30 days. Customers are required to track the number of ArcGIS Runtime deployments at the Basic, Standard, and Advanced level. Each installation of your app available to a single user counts as a deployment.

Licensing capabilities

The functionality associated with each license level is described below, including the available licensing options and how to acquire a license. For details on API classes and members that require a paid license or extension, see Licensing details in the API reference.

Extension licenses

ArcGIS Runtime offers extensions that provide access to additional capabilities, analysis tools, and/or data.

Store geocode results from ArcGIS Online

The Geocoding service includes a for_storage parameter. Storing the results of a geocode or reverse geocode operation using this service (by setting the for_storage parameter to true) requires an ArcGIS Developer account with a properly scoped API key, or an ArcGIS Online paid account and uses credits from the subscriber's account. Additionally, the user performing a paid operation must be assigned a user role that includes the Geocoding privilege. For more information, see Geocoding service, pricing information in Pricing made simple, and User types, roles, and privileges in ArcGIS Online documentation.

Named User licensing

Beginning with the release of ArcGIS Enterprise 10.5, members in an organization in ArcGIS Online or on-premises ArcGIS Enterprise portal can be assigned one of two membership levels, as described in Levels, roles, and privileges. Level 1 can be used to license ArcGIS Runtime at the Lite level. Level 2 can be used to license ArcGIS Runtime at the Lite and Basic level. For Portals prior to version 10.5, all named users are equivalent to Level 2 and can be used to license ArcGIS Runtime at the Basic level.

At the end of 2018, named user types were introduced in ArcGIS Online to replace named user levels. Named users of any type can still be used to license ArcGIS Runtime. Named users of type Viewer can license ArcGIS Runtime at the Lite level and named users of type Editor, Field Worker, Creator, and GIS Professional can license ArcGIS Runtime at the Basic level.

Starting with ArcGIS Enterprise 10.8 and the December 2019 update of ArcGIS Online, named user types explicitly include ArcGIS Runtime licenses and extensions when applicable. ArcGIS Runtime 100.7 and higher is licensed on the basis of these explicit license entitlements when used with such named user types.

Use tile packages from ArcGIS Online basemaps

App developers may use ArcGIS Online basemaps for their apps. Esri has designed a use policy that seeks to maximize the use of these basemaps by the ArcGIS Runtime developer community. The rules for using these basemaps are conditioned on how the basemaps are used.

A developer can only export basemaps from services that support the export tiles operation.

A developer may:

• Export basemaps as tile packages for use with an ArcGIS Runtime app, up to the limits imposed by the basemap for a single tile package.
• Use an ArcGIS Runtime app to export basemaps on demand. Authorization must be as a named user or with an app login.
• Embed or bundle basemap tile packages in an ArcGIS Runtime app.
• Use an ArcGIS Runtime app to download pre-created basemap tile packages hosted by ArcGIS Online or ArcGIS Enterprise, but only if the ArcGIS Online organization or ArcGIS Enterprise is licensed for production use.

A developer may not:

• Allow their users to use the exported content outside of ArcGIS technology.
• Allow their users to unbundle the exported content and publish the exported content as a map service.
• Allow their users to unbundle the exported content or redistribute to other users.
• Systematically harvest map tiles using the service (a practice often referred to as "scraping tiles").

License your app

Follow these steps to license your app with a license string or a named user account. If you use an API key to access ArcGIS services, the Runtime app itself must still be licensed with a Runtime license string or named user. After licensing the app, the watermark and debug messages will no longer display and your app will be ready for distribution and use in production.

License your app with a license string

Using a license string involves adding code to set the license level at compile time so that the license string is built into the application.

1. Read the end user license agreement.
2. Find a location in your code that runs before any ArcGIS Runtime functionality is used.
3. Call the setLicense() method on the ArcGISRuntimeEnvironment singleton object to license the app with a license string.

The following must run before any other ArcGIS Runtime code.

1
2
// license with a license string
ArcGISRuntimeEnvironment.setLicense("runtimelite,1000,rud#########,day-month-year,####################");

Your app is now licensed for deployment.

License your app with a named user account

Use of a named user (also known as an ArcGIS identity) involves adding code to enable sign-in for using an ArcGIS organizational account. At runtime, a user must sign in successfully to return their license information which will be used by the app to set the license level. Follow these steps to license your app using the named user's account:

1. Read the end user license agreement.
2. Find a location in your code that runs before any ArcGIS Runtime functionality is used.
3. Allow the app user to authenticate with an ArcGIS organizational account. Upon loading the Portal obtain the LicenseInfo and use this to license the app. As part of the process, save the license information in preparation for your app being used in an offline environment for up to 30 days.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
// connect to ArcGIS Online or an ArcGIS portal as a named user
// The code below shows the use of token based security but
// for ArcGIS Online you should consider using Oauth authentication.
UserCredential credential = new UserCredential("user", "password");

// replace the URL with either the ArcGIS Online URL or your portal URL
Portal portal = new Portal("https://your-org.arcgis.com");
portal.setCredential(credential);

// load portal and listen to done loading event
portal.loadAsync();
portal.addDoneLoadingListener(() -> {

  // check that the portal loaded correctly
  if (portal.getLoadStatus() == LoadStatus.LOADED) {

    // get license info from the portal
    ListenableFuture<LicenseInfo> licenseFuture = portal.fetchLicenseInfoAsync();

    // listen for the license info from the server
    licenseFuture.addDoneListener(() -> {
      try {
        LicenseInfo licenseInfo = licenseFuture.get();

        // Get the license as a json string
        String licenseJson = licenseInfo.toJson();

        // the license string will need to be stored locally for starting
        // the app when there is no network connection.

        // Apply the license
        ArcGISRuntimeEnvironment.setLicense(licenseInfo);

      } catch (InterruptedException e) {
        // error code goes here
      } catch (ExecutionException e) {
        // error code goes here
      }
    });
  }
});

If you saved the license information on local storage, your app can be started and licensed in an offline environment using the saved license information. Retrieve the license from storage and license your app.

1
2
3
4
5
6
7
8
// get the license Json which was stored on the device
String storedLicense = getLicenceFromStorage();

// generate a LicenseInfo from the Json string
LicenseInfo licenseInfo = LicenseInfo.fromJson(storedLicense);

// license the app
ArcGISRuntimeEnvironment.setLicense(licenseInfo);

License extensions with a license string

1. Read the end user license agreement.
2. Find a location in your code that runs before any ArcGIS Runtime functionality is used.
3. Call the setLicense() method on the ArcGISRuntimeEnvironment singleton object to license the app with a main license string and any extension licenses.

1
2
3
4
// license with a license and a list of extensions
ArcGISRuntimeEnvironment.setLicense("runtimeadvanced,1000,rud#########,day-month-year,####################",
  Arrays.asList("runtimeanalysis,1000,rud#########,day-month-year,####################",
    "another license extension code"));

Your app is now licensed to use the extensions.

Attribute Esri in your app

Esri requires that when you use an ArcGIS Online basemap, Esri data services, or Esri API technology in your app you must also include Esri attribution. There are specific requirements for attribution you may be required to address in your app depending on how your app is built and the data it uses. This is outlined in detail here in the Attribution in your app topic.