Android Installation Prerequisites

Main Steps

The main steps to obtain the Geocortex Mobile App Framework for Android are:

1. Obtain an ArcGIS Runtime SDK license.

   The Geocortex Mobile App Framework ships with an ArcGIS Runtime SDK Basic license that is registered to VertiGIS. To allow offline editing using the App, you must obtain an ArcGIS Runtime SDK Standard license code. If you are not going to support offline editing, but you want the App to be associated with a license that is registered to your organization instead of to VertiGIS, you must obtain your own ArcGIS Runtime SDK Basic license.

2. Obtain the installation package.

   You can either download the package from the VertiGIS Studio Support or obtain a customized package from VertiGIS Studio Support.

Obtain an ArcGIS Runtime SDK License

Certain offline features require the App to be licensed using an ArcGIS Runtime SDK license.

There are two kinds of ArcGIS Runtime SDK license:

• Basic: Allows users to use offline basemaps, global search, query, filter, identify, and view related features offline. The Basic license does not allow users to do offline editing.

• Standard: Required for offline editing.

  As of version 2.0 of Geocortex Mobile App Framework, offline editing uses Esri's Replicas technology, which requires a Standard license code.

By default, the Geocortex Mobile App Framework is licensed using a Basic license that is registered to VertiGIS. To obtain your own license, you can either request the license from Esri, or you can become a Portal for ArcGIS or ArcGIS Online customer. ArcGIS Runtime SDK Standard licensing is built into Portal for ArcGIS and ArcGIS Online.

If you use Portal for ArcGIS or ArcGIS Online licensing, the user must sign in as a Level 2 Named User to Portal for ArcGIS or ArcGIS Online at least once every 30 days to maintain the Standard license. If the user fails to sign in after 30 days, functionality will be reduced to the equivalent of a Basic license until the user signs in again. Level 1 Named Users are equivalent to those with a Basic license.

The options for licensing the App with the ArcGIS Runtime SDK are:

 

• Basic License:

  • Use the Preconfigured Basic License: By default, the Geocortex Mobile App Framework is licensed using a Basic license that is registered to VertiGIS. You are welcome to use the preconfigured license.

  • Obtain your Own Basic License: If you want the App to be associated with a Basic license that is registered to your organization instead of to VertiGIS and you are not a Portal for ArcGIS or ArcGIS Online customer, you must obtain your own Basic license. The Basic license is free to subscribers of ArcGIS for Developers.

  • Sign in as a Portal for ArcGIS or ArcGIS Online Level 1 Named User: If you are, or would like to become, a Portal for ArcGIS or ArcGIS Online customer, you can use the Basic License that comes with being a Level 1 Named User to license the App.

• Standard License:

  • Obtain a Standard License Code: If you are going to support offline editing and you are not a Portal for ArcGIS or ArcGIS Online customer, you must obtain a Standard license code.

  • Sign in as a Portal for ArcGIS or ArcGIS Online Level 2 Named User: If you are going to support offline editing and you are, or would like to become, a Portal for ArcGIS or ArcGIS Online customer, you can use the Standard license that comes with being a Level 2 Named User to license the App.

For more information about obtaining an ArcGIS Runtime SDK license, refer to Esri's "License your app" documentation.

Obtain an ArcGIS Runtime SDK Basic License

The Geocortex Mobile App Framework is preconfigured with a Basic license belonging to VertiGIS. You only need to obtain a Basic license if you want the App to be associated with your Client ID, instead of the VertiGIS Client ID.

To obtain a ArcGIS Runtime SDK Basic license:

1. Contact your local Esri representative and request a ArcGIS Runtime SDK Basic license. You will need the license's Client ID.

   You may want to provide the license's Client ID to VertiGIS Studio Support if you decide to request a customized installation package. VertiGIS Studio Support will preconfigure the license in the installation package.

   If you use the download package from the VertiGIS Studio Support instead of a customized package, then the license must be applied after the App is installed.

Sign in as a Portal for ArcGIS or ArcGIS Online Level 1 Named User

When a Level 1 Named User signs in to Portal for ArcGIS or ArcGIS Online, the Basic license is automatically activated. No other steps are required.

Obtain an ArcGIS Runtime SDK Standard License Code

To obtain a ArcGIS Runtime SDK Standard license code:

1. Contact your local Esri representative and purchase a ArcGIS Runtime SDK Standard license code.

   You must provide the license code to VertiGIS Studio Support if you decide to request a customized installation package. VertiGIS Studio Support will preconfigure the license in the installation package.

   If you use the download package from the VertiGIS Studio Support instead of a customized package, then the license must be applied after the App is installed.

Sign in as a Portal for ArcGIS or ArcGIS Online Level 2 Named User

When a Level 2 Named User signs in to Portal for ArcGIS or ArcGIS Online, the Standard license is automatically activated. No other steps are required.

Obtain the Installation Package

There are two ways to obtain a Geocortex Mobile App Framework for Android installation package:

• Request a Customized Package: Request a customized package from VertiGIS Studio Support (recommended):

  • Request a Multi-Viewer Package: If you want end users to be able to select which viewer to open, request a multi-viewer package.

  • Request a Single-Viewer Package: If you want a specific viewer to open automatically when the App starts, request a single-viewer package.

• Download the Installation Package: Download the installation package from the VertiGIS Studio Support. The download package installs a multi-viewer App, which allows end users to select which viewer to open when the App starts.

Benefits of Customized Installation Packages

The customized installation packages that you obtain from VertiGIS Studio Support offer the following benefits:

• Customize the appearance of the App, such as the icon, name, and splash screen.

• Preregister the App with Essentials, so it does not need to be registered after installation on the end user's device.

• Preconfigure the ArcGIS Runtime SDK license, so the license does not have to be applied after installation on the end user's device.

• Use the App in a Mobile Device Management (MDM) software environment.

  While the Geocortex Mobile App Framework is not specifically tested to work with Mobile Device Management (MDM) software, VertiGIS Studio Support endeavors to help customers run the App in an MDM environment. If you cannot run the App with your particular MDM, we will try to find a solution in a reasonable time frame.

Request a Customized Multi-Viewer Package

This option allows users to select which viewer to open.

To obtain a customized package that supports multiple viewers:

1. Send the following information to VertiGIS Studio Support ():

   Required Information

   • Platforms: The platforms (Android, iOS, Windows) for which you want customized versions.

   • Standard License Code: If you obtained a ArcGIS Runtime SDK Standard license code so you can support offline editing, send VertiGIS Studio Support the license code.

   • MDM Type: The type of Mobile Device Management (MDM) software you intend to use, if applicable.

   Optional Information

   • Essentials URL: The URL of your Essentials instance, for example:

     http://MyServer.com/Geocortex/Essentials

     If you do not submit the Essentials URL, users will be prompted to enter it the first time they start the App.

   • Name: The App name, to customize your App.

   • Icon: The App icon, to customize your App.

   • Image: The splash screen images, to customize your App.

   • ArcGIS Client ID from Basic License: If you are going to license the App using a ArcGIS Runtime SDK Basic license, and you want the App to be associated with your ArcGIS Client ID instead of a VertiGIS Client ID, send VertiGIS Studio Support your Client ID.

Request a Customized Single-Viewer Package

This option automatically opens a specific viewer when the Geocortex Mobile App Framework starts.

To request a customized package that supports a single viewer:

1. Send the following information to VertiGIS Studio Support ():

   Required Information

   • Platforms: The platforms (Android, iOS, Windows) for which you want customized versions.

   • Launch URL: The URL from the viewer's Launch in Geocortex Mobile App Framework link. For example:

     gcx://viewerPackage?url=http://MyServer.com/Html5Viewer/gmaf/viewerpackage.ashx?viewerUrl=http://MyServer.com/Geocortex/Essentials/REST/sites/MySite/viewers/MyViewer

     This link appears on the Viewer Info page when you edit your HTML5 viewer in Essentials. You can right-click the link to copy the link's URL.

   • Standard License Code: If you obtained a ArcGIS Runtime SDK Standard license code so you can support offline editing, send VertiGIS Studio Support the license code.

   • MDM Type: The type of Mobile Device Management (MDM) software you intend to use, if applicable.

   Optional Information

   • Name: The App name, to customize your App.

   • Icon: The App icon, to customize your App.

   • Image: The splash screen images, to customize your App.

   • ArcGIS Client ID from Basic License: If you are going to license the App using a ArcGIS Runtime SDK Basic license, and you want the App to be associated with your ArcGIS Client ID instead of a VertiGIS Client ID, send VertiGIS Studio Support your Client ID.

Download the Software

Instead of downloading the installation package, you can request a customized package from VertiGIS Studio Support. Customized packages provide a number of benefits.

To download the Geocortex Mobile App Framework installation package from the VertiGIS Studio Support:

1. Open the Geocortex Essentials Downloads page in the VertiGIS Studio Support.

2. If prompted, log in with your Support account credentials.

   If you do not have a Support account, click the link to create an account.

3. Find the Geocortex Mobile App Framework section.

   Information is displayed about the current version of the Geocortex Mobile App Framework for Android, with download and documentation links.

   To download a previous version, click Previous Versions and find the version you want.

4. Click Geocortex Mobile App Framework 2.3.2 (Android).

   The APK file downloads.

What's next?

Android Server-side Tasks