Licensing

GeoAnalytics Engine is subscription in and of itself and must be authorized with a valid license before running any tool or function. ArcGIS Online subscriptions cannot be used to authorize GeoAnalytics Engine. There are two types of licenses for GeoAnalytics Engine:

• Connected licensing via a prepaid subscription, authorized via a defined user
• Disconnected licensing via a prepaid subscription, authorized via license file

Connected licensing and usage reporting

Connected licensing is a prepaid subscription to ArcGIS GeoAnalytics Engine which includes a given amount of core-hours for processing big data. Your Spark cluster must be able to connect to https://www.arcgis.com/ for usage reporting. You can use the username and password for your subscription to authorize ArcGIS GeoAnalytics Engine. See Authorization for a complete list of authorization methods.

When authorizing with a connected license, any Spark job that includes ArcGIS GeoAnalytics Engine functionality will be measured in compute unit-milliseconds and will be reported to Esri and deducted from the available compute unit-hours or "core-hours" in your prepaid plan. Only the runtime of Spark jobs that include ArcGIS GeoAnalytics Engine functionality will be reported.

As an example, say you have a prepaid plan and you run a Spark job on a cluster with 60 cores for 1 minute. If that Spark job includes a GeoAnalytics Engine data source, SQL function, or tool, the total usage reported would be 60 cores times 60000 milliseconds for a total of 3600000 compute unit-milliseconds or 1.00 core-hours. This value is reported to Esri and is deducted from the available core-hours in your prepaid plan.

Usage is reported in the following scenarios for connected licensing:

• Every five minutes if there is new usage data that has not been reported.
• After a Spark job completes if more than 5 minutes have elapsed since the last time usage was reported.
• After a Spark job completes if more than 1 core-hour is consumed.
• When the Spark driver shuts down.
• When you deauthorize GeoAnalytics Engine.

You can view your subscription's usage history and available core-hours in the GeoAnalytics Engine dashboard. There may be a delay between when you consume core-hours and when those core-hours are shown as consumed in the dashboard. You can also query your subscription's usage history with the API at any time using the usage function, geoanalytics.usage(). This function returns a DataFrame where each row represents your subscription's GeoAnalytics Engine usage during a period of time. The columns ComputeMillis and ComputeHours contain the amount of compute time used during each interval in cpu-milliseconds and cpu-hours respectively. The From and To columns contain the start and end time of each interval. Lastly, the Committed column shows whether or not the usage has been committed to your account. The example below shows what a DataFrame from geoanalytics.usage() might look like.

1
2
3
4
5
6
7
8
import geoanalytics
geoanalytics.auth(username="User1", password="p@ssw0rd")

geoanalytics.usage().show()

1
2
3
4
5
6
7
8
9
10
11
12
 +-------------+------------+--------------------+--------------------+---------+
|ComputeMillis|ComputeHours|                From|                  To|Committed|
+-------------+------------+--------------------+--------------------+---------+
|      4719873|      1.3111| 2022-01-10 10:00:00| 2022-01-10 11:00:00|     true|
|       470036|      0.1306| 2022-01-10 11:00:00| 2022-01-10 12:00:00|     true|
|       356497|      0.0990| 2022-01-10 12:00:00| 2022-01-10 13:00:00|     true|
|       295957|      0.0822| 2022-01-10 13:00:00| 2022-01-10 14:00:00|     true|
|            0|      0.0000| 2022-01-10 14:00:00| 2022-01-10 15:00:00|     true|
|            0|      0.0000| 2022-01-10 15:00:00| 2022-01-10 16:00:00|     true|
|            0|      0.0000| 2022-01-10 16:00:00| 2022-01-10 17:00:00|     true|
|          451|      0.0001|2022-01-10 16:02:...|2022-01-10 16:07:...|    false|
+-------------+------------+--------------------+--------------------+---------+

To change your subscription password, use the "Forgot password?" option when logging in to the GeoAnalytics Engine dashboard. To change the email address associated with your subscription, please contact Esri Technical Support.

Disconnected licensing

Disconnected licensing is a prepaid subscription to ArcGIS GeoAnalytics Engine that enables usage on Spark environments that are not able to connect for online usage reporting. This licensing requires a .ecp file provided by Esri to authorize ArcGIS GeoAnalytics Engine. See Authorization for a complete list of authorization methods. Unlike connected licensing, with a disconnected license no usage is recorded or reported from your Spark cluster and no connection to the internet is required.

If your license was delivered as a .prvc file, you must use the Software Authorization Wizard to activate the license and generate a .ecp file. GeoAnalytics Engine will not authorize with .prvc files.