1. Home
  2. Docs
  3. geoSherpa Documentation
  4. About geoSherpa for Geocortex Essentials
  5. Deploying geoSherpa manually to a Geocortex Site

Deploying geoSherpa manually to a Geocortex Site

This page describes how to manually install and configure the geoSherpa module for Geocortex Essentials and the Geocortex Viewer for HTML5. 


Before proceeding with a manual installation of geoSherpa, it is highly recommended that you have a backup of your Geocortex site.

Geocortex Site Viewer Preparation

  1. Locate your Geocortex Essentials Sites directory, typically found at C:\Program Files (x86)\Latitude Geographics\Geocortex Essentials\Default\REST Elements\Sites\
  2. Navigate to the specific site’s Virtual Directory, typically found at ..\YOURSITENAME\Viewers\YOURVIEWERNAME\VirtualDirectory\
  3. Locate the Resources directory and create a new directory within it called ..\Resources\Custom\geoWidgets\
  4. Download the geosherpa-plugin.js and place it in the newly created folder (..\Resources\Custom\geoWidgets\geosherpa-plugin.js)

Geocortex Site Viewer Configuration

  1. Copy a geoSherpa Guide API key from the geoSherpa Planner:
    1. Open geoSherpa Planner
    2. From the Guide selector page, select the guide you want and click Deploy Guide menu item.
    3. Select Web AppBuilder
    4. Copy the API key and use it to paste into the Modules section below
  2. Locate the DesktopTablet, and Handheld configuration files, typically located in the \VirtualDirectory\Resources\Config\Default\ directory
  3. Repeat the following steps for each configuration file (Desktop.json.js, Handheld.json.js, and Tablet.json.js) that you wish to deploy geoSherpa into:
    1. WARNING! Make sure you have backups or copies of the configuration file before proceeding.
    2. Open the configuration file (Desktop.json.js, Handheld.json.js, and Tablet.json.js) in a file editor of your choice, such as Notepad++
    3. Within the libraries node of the JSON, add the following code:
        id": "GCX-geoSherpa-Interface",
        "async": true,
        "location": "{ViewerConfigUri}../../Custom/geoWidgets",
        "locales": []
    4. Within the modules node of the JSON, add the following code:
        "moduleName": "Plugin",
        "libraryId": "GCX-geoSherpa-Interface",
        "configuration": {
          "clientApiKey": "(paste the API Key from the Step 1D above)"
  4. Save the configuration file and repeat as necessary.
Was this article helpful to you? Yes No