Windows Installation Prerequisites

Main Steps

The main steps to obtain the Geocortex Mobile App Framework for Windows 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 Latitude Geographics. 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 Latitude Geographics, you must obtain your own ArcGIS Runtime SDK Basic license.

  2. Obtain the installation package.

    You can either download the package from the Geocortex Support Center or obtain a customized package from Geocortex Support.

  3. Manually customize the downloaded installation package (optional).

    If you want, you can manually customize some aspects of the Geocortex Mobile App Framework for Windows before distributing it.

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:

By default, the Geocortex Mobile App Framework is licensed using a Basic license that is registered to Latitude Geographics. 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:

 

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 Latitude Geographics. You only need to obtain a Basic license if you want the App to be associated with your Client ID, instead of the Latitude Geographics 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 Geocortex Support if you decide to request a customized installation package. Geocortex Support will preconfigure the license in the installation package.

    If you use the download package from the Geocortex Support Center instead of a customized package, and you do not manually preconfigure the license, 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 Geocortex Support if you decide to request a customized installation package. Geocortex Support will preconfigure the license in the installation package.

    If you use the download package from the Geocortex Support Center instead of a customized package, and you do not manually preconfigure the license, 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 Windows installation package:

Benefits of Customized Installation Packages

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

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 Geocortex Support (support@latitudegeo.com):

    Required Information

    Optional Information

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 Geocortex Support (support@latitudegeo.com):

    Required Information

    Optional Information

Download the Software

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

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

  1. Open the Geocortex Essentials Downloads page in the Geocortex Support Center.

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

    If you do not have a Support Center 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 Windows, 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 (Windows).

    The ZIP file downloads.

You can manually customize some aspects of the downloaded package if you want.

Manually Customize the Downloaded Installation Package

If you downloaded the installation package from the Geocortex Support Center, you may want to customize parts of the App by manually editing the configuration file. Manual customization allows you to:

At this time, to customize the appearance of the App, such as the icon, name, and splash screen, you must obtain a customized version from Geocortex Support.

Manually Change the Installation Package into a Single-Viewer Package

The installation package that you download from the Geocortex Support Center allows multiple viewers. If you want the App to work with only a single viewer, you can either obtain a customized version or follow the steps below.

To create a single-viewer package:

  1. Extract the files from the downloaded ZIP file.

  2. In the root folder where you extracted the files, edit the configuration.json file.

    Never edit a Geocortex configuration file when the application that it configures is running, or you may lose data. Close the application first.

  3. Locate the mainUri property and set its value to {0}/viewerpackages/MyViewer/Html5Viewer/Index.html?configBase=../VirtualDirectory/Resources/Config/Default.

    Replace MyViewer with the name of the viewer you want to use, as it appears in the viewer's Path. To see a viewer's Path, edit the viewer in Geocortex Essentials Manager and look on the Viewer Info page.

    {
        ....
        "mainUri": "{0}/viewerpackages/MyViewer/Html5Viewer/Index.html?configBase=../VirtualDirectory/Resources/Config/Default",
        ...
    }
  4. Within the defaultViewers array, add an object that represents the viewer you want to use:

    {
        ...
        "defaultViewers": [
            ....
            {
                "directoryName": "MyViewer",
                "uri": "Html5Viewer/Index.html?configBase=../VirtualDirectory/Resources/Config/Default",
                "packageSource": "http://MyServer.com/Html5Viewer/gmaf/viewerpackage.ashx?viewerUrl=http://MyServer.com/Geocortex/Essentials/REST/sites/MySite/viewers/MyViewer"
            }
            ...
        ],
        ...
    }
    1. Set the directoryName property to the name of the viewer as it appears in the viewer's Path.

      The Path is on the Viewer Info page when you edit the viewer in Geocortex Essentials Manager.

    2. Set the uri property to Html5Viewer/Index.html?configBase=../VirtualDirectory/Resources/Config/Default.

    3. Set the packageSource property to the viewerPackage URL, which is contained within the viewer's Launch in Geocortex Mobile App Framework link.

      The Launch in Geocortex Mobile App Framework link is on the Viewer Info page when you edit the viewer in Geocortex Essentials Manager. Right-click the launch link to copy its URL. The viewerPackage URL is found after gcx://viewerPackage?url= in the launch link.

  5. Save the file.

Manually Preconfigure the ArcGIS Runtime SDK License

There are two types of ArcGIS Runtime SDK license you can configure: Basic and Standard. For details, see Obtain an ArcGIS Runtime SDK License.

To preconfigure the ArcGIS Runtime SDK license:

  1. Extract the files from the downloaded ZIP file if you haven't already.

  2. In the root folder where you extracted the files, use a text editor to open the configuration.json file.

    Never edit a Geocortex configuration file when the application that it configures is running, or you may lose data. Close the application first.

  3. Configure the license information:

  4. Save the file.

Manually Preregister the App with Essentials

To preregister the App with Essentials:

  1. Extract the files from the downloaded ZIP file if you haven't already.

  2. In the root folder where you extracted the files, use a text editor to open the configuration.json file.

    Never edit a Geocortex configuration file when the application that it configures is running, or you may lose data. Close the application first.

  3. Locate the essentialsInstance property:

        "essentialsInstance": "http://MyServer.com/Geocortex/Essentials/REST",
  4. Set the value of the essentialsInstance property to the URL of your Essentials instance.

  5. Save the file.

Manually Customize the App's Data Storage Location

By default, the Geocortex App stores data in C:\Users\MyUserName\Documents\Geocortex App Data. Customizing the data storage location allows multiple Windows users of the same device to share TPK files, while retaining their own settings, including the list of viewers.

If you change the App data storage location, any existing data such as your TPK files are not moved automatically.

To customize the App's data storage location:

  1. Extract the files from the downloaded ZIP file if you haven't already.

  2. In the root folder where you extracted the files, use a text editor to open the configuration.json file.

    Never edit a Geocortex configuration file when the application that it configures is running, or you may lose data. Close the application first.

  3. Locate the storageLocation property and set its value to the location where you want the App to store data. Add a backslash before each backslash in the specified location, otherwise the App will not work. For example:

        "storageLocation": "C:\\MyAppData",

    Ensure the specified location is accessible to all users of the App, otherwise the default location is used. If the specified location does not exist, the App attempts to create it.

  4. Save the file.

What's next?

Windows Server-side Tasks

© 2019 Latitude Geographics Group Ltd. All Rights Reserved.

Documentation Version 4.11