ESRI ArcGIS JavaScript API Licensing

<< Click to Display Table of Contents >>

EQuIS 7  >>  Enterprise > Installation and Configuration > Configuration >

ESRI ArcGIS JavaScript API Licensing

Disclaimer: The information contained in this article is provided as-is for the convenience of EarthSoft clients. This article is not officially sanctioned by Esri and the information referenced herein may change without notice. This article may not be used for the legal definition or declaration of Esri licensing agreements.

 

The EQuIS Enterprise Map Widget (as well as some other widgets) use the Esri ArcGIS API for JavaScript to provide web-based GIS functionality (base maps, user interaction, displaying EQuIS data as layers, etc). After initial installation, EQuIS Enterprise will utilize the Esri sample server for ArcGIS API for JavaScript functionality. The sample server may only be used for development and testing purposes; it may not be used for production usage. Before using EQuIS Enterprise web-based GIS functionality (e.g. Map Widget) in a production environment, you must configure EQuIS Enterprise using one of the methods described here.

 

Method 1: ArcGIS Server License

 

As stated by Esri:

 

"To deploy an app you build with the ArcGIS APIs or SDKs, you will need a trial or subscription for ArcGIS Online.*

 

*An ArcGIS Online subscription is not required for organizations that use the Web APIs in conjunction with an ArcGIS for Server or Portal for ArcGIS license."

 

A valid Esri ArcGIS for Server license includes usage rights for Esri ArcGIS API for JavaScript. If your organization owns a valid Esri ArcGIS Server license, then you do not need an ArcGIS Online subscription in order to use ArcGIS API for JavaScript. In order to utilize the usage rights included with your ArcGIS for Server license, you need to make the following modification(s) to the ST_CONFIG table in each of your EQuIS database(s):

 

CONFIG_

SECTION

CONFIG_KEY

OBJECT_TYPE

OBJECT_VALUE

STRING_VALUE

EQuIS6_GIS

DefaultBasemap

NULL

NULL

Enter the full URL to map server hosted by your ArcGIS Server environment (e.g. https://GIS01/ArcGIS/rest/services/BaseMapServer)

EQuIS6_GIS

GeometryServerURL

NULL

NULL

Enter full URL to the Geometry Server hosted by your ArcGIS Server environment (e.g. https://GIS01/ArcGIS/rest/services/GeometryServer)

 

After updating the ST_CONFIG table, you also need to add your GeometryServerURL to the ./Enterprise7/Widgets/EQuIS/GIS/Proxy.config file. Open the Proxy.config file in an XML/Text editor and add your GeometryServerURL within the <serverUrls> element, and then save the file:

 

   <serverUrl url="https://GIS01/ArcGIS/rest/services/GeometryServer"  matchAll="true"></serverUrl>

 

Method 2: ArcGIS Online Subscription

 

If your organization has a valid ArcGIS Online subscription, then you need to associate your EQuIS Enterprise application with your ArcGIS Online subscription. Using your own organizational subscription for ArcGIS Online allows you to use the full functionality provided by ArcGIS Online, including cloud storage of spatial layers and the ability to publish your own map/feature services.

 

First, you must create and register your EQuIS Enterprise web application within ArcGIS Online as described in the ArcGIS.com Help article entitled "Adding applications":

 

1.Verify that you are logged in to ArcGIS.com with your organizational account and click My Content.

2.Add your EQuIS Enterprise application using these steps:

a.Click the Add Item button.

b.Choose An Application from the The item is options.

c.Choose Web Mapping as the type of item.

d.Enter the URL to your EQuIS Enterprise application (e.g. http://someserver/equis7).

e.Choose Ready to Use as the purpose of the item.

f.Choose JavaScript as the API of the item.

g.Enter the title for this item (e.g. "EQuISEnterprise").

h.Enter one or more tags for this item (e.g. "EQuIS").

i.Click the Add Item button.

3.Click the title of the application you want to register to view its item details.

4.Scroll down to the App Registration section and click the Register button.

5.Select browser as the type of application.

6.Enter the URL to your EQuIS Enterprise application (e.g. http://someserver/equis7) as the Redirect URI.

7.Click the Register button.

8.Click the title of the registered application to view its details.

9.Scroll down to the App Registration section and click the Registered Info button.

10.The App ID will be displayed.

11.Click Show Secret to show the App Secret.

 

Tips:

Setting your ArcGIS Online Subscription up for multiple Enterprise instances:

If you want to use the same API Key for all sites on the server, then you only need to register one application with the root URL. All usage will be aggregated for that one API Key or, alternatively, you can register each individual application for a separate API key, then usage will be tracked for each individual application.

Using Secure HTTPS Connections:

You can use https instead of http for the links above (e.g. https://someserver/equis7).

 

After registering EQuIS Enterprise as an application within your ArcGIS Online subscription, make the following modification(s) to the ST_CONFIG table in each of your EQuIS database(s):

 

CONFIG_SECTION

CONFIG_KEY

OBJECT_TYPE

OBJECT_VALUE

STRING_VALUE

EQuIS6_GIS

DefaultBasemap

NULL

NULL

https://server.arcgisonline.com/ArcGIS/rest/services/World_Topo_Map/MapServer

EQuIS6_GIS

GeometryServerURL

NULL

NULL

https://utility.arcgisonline.com/arcgis/rest/services/Geometry/GeometryServer

EQuIS6_GIS

AppID

NULL

NULL

Enter the App ID as shown in the App Registration section (see steps above)

EQuIS6_GIS

AppSecret

NULL

NULL

Enter the App Secret as shown in the App Registration section (see steps above)

EQuIS6_GIS

esriToken

NULL

NULL

Leave this value blank (it will be populated by EQuIS)

 

After updating the ST_CONFIG table, you also need to add your GeometryServerURL to the ./Enterprise7/Widgets/EQuIS/GIS/Proxy.config file. Open the Proxy.config file in an XML/Text editor and add your GeometryServerURL within the <serverUrls> element, then save the file:

 

   <serverUrl url="https://utility.arcgisonline.com/arcgis/rest/services/Geometry/GeometryServer" matchAll="true"></serverUrl>

 

Method 3: EarthSoft's ArcGIS Online Subscription (Limited Use)

 

If your organization does not have an ArcGIS Online subscription, then you need to associate your EQuIS Enterprise application with EarthSoft's ArcGIS Online subscription. Using EarthSoft's ArcGIS Online subscription does enable reasonable usage of the web-based GIS functionality in EQuIS Enterprise, but does not provide full ArcGIS Online functionality. You will not receive an ArcGIS Online user account, cloud storage of spatial layers, nor the ability to publish your own map map/feature services. Excessive usage may incur additional costs and/or prohibit your use of EarthSoft's ArcGIS Online subscription.

 

Note: Usage of EarthSoft's ArcGIS Online subscription is provided as a convenience to EQuIS Enterprise licencees. EarthSoft reserves the right to discontinue its ArcGIS Online subscription or any licensee's usage thereof, at any time, for any or no reason.

 

First, you must register your EQuIS Enterprise web application with EarthSoft by sending an email to support@earthsoft.com that includes the URL to your EQuIS Enterprise application. EarthSoft will register your EQuIS Enterprise application within ArcGIS Online and send you the App ID and App Secret for your application. After receiving the App ID and App Secret from EarthSoft, make the following modification(s) to the ST_CONFIG table in each of your EQuIS database(s):

 

CONFIG_SECTION

CONFIG_KEY

OBJECT_TYPE

OBJECT_VALUE

STRING_VALUE

EQuIS6_GIS

DefaultBasemap

NULL

NULL

https://server.arcgisonline.com/ArcGIS/rest/services/World_Topo_Map/MapServer

EQuIS6_GIS

GeometryServerURL

NULL

NULL

https://utility.arcgisonline.com/arcgis/rest/services/Geometry/GeometryServer

EQuIS6_GIS

AppID

NULL

NULL

Enter the App ID as received from EarthSoft

EQuIS6_GIS

AppSecret

NULL

NULL

Enter the App Secret as received from EarthSoft

EQuIS6_GIS

esriToken

NULL

NULL

Leave this value blank (it will be populated by EQuIS)

 

After updating the ST_CONFIG table, you also need to add your GeometryServerURL to the ./Enterprise7/Widgets/EQuIS/GIS/Proxy.config file. Open the Proxy.config file in an XML/Text editor and add your GeometryServerURL within the <serverUrls> element, then save the file:

 

   <serverUrl url="https://utility.arcgisonline.com/arcgis/rest/services/Geometry/GeometryServer" matchAll="true"></serverUrl>