Geocortex Analytics Installation

Important Prerequisites

The following prerequisites should be in place before you install Analytics:

About Installation

You can install Analytics in one of two scenarios:

If you plan to install Analytics using a Hub + Agents model, you must install Analytics on the Hub server before you install the Analytics Agent version on the other servers. All of the Analytics data is stored on the Hub and it also hosts the application, which is why the Hub server needs to be appropriately powerful.

Currently, there is no support for a name change of your Hub server machine or the cluster name once Analytics is installed.

Analytics starts collecting data quickly after installation so you can view some data within 15 minutes.

Geocortex Analytics installs to the following location by default:

C:\Program Files\Latitude Geographics\Geocortex\Analytics\

Difference Between a Hub and an Agent Installation

The process of installing a Hub and an Agent version of Analytics is, of course, different as you are installing more elements on the Hub server than on an Agent. For example, the Analytics Reports application is installed on the Hub but not on Agent machines. The Roles installed on a Hub and Agent also differ in that only a subset of Roles are installed on an Agent because the others are not needed. This means that there are fewer Roles on an Agent installation than on the Hub. Similarly, the Geocortex Core Roles that get installed on a Hub and on an Agent are different.

If you install an Agent version of Analytics on a machine that already has Essentials installed on it, a full installation of Core will be on that machine already. In that case, only the Analytics subset of roles will be added to the machine.

Analytics Role names have Geocortex.Analytics before the name of the Role when you see them on the Processes tab in Windows Task Manager.
Core names have Geocortex.Core in front of the name of the Role except for the Geocortex.Platform.Host Role.

Roles Installed on a Hub Server

Analytics Roles on a Hub Server

Core Roles on a Hub Server

Client Relay Role

Deployment Manager Role

Configuration Role

Document Store Role

Dashboard Role

Licensing Role

Data Aggregator Role

Core Security Role

Log Stats Converter Role

 

Resource Collector Role

 

Security Role

 

Web Application Relay Role

 

Roles Installed on an Agent Server

Analytics Roles on an Agent Server

Core Roles on an Agent Server

Resource Collector Role

Geocortex.Platform.Host

 

Bootstrapper Role

 

Configuration Sync Role

 

Deployment Manager Role

Install an Analytics Hub on an Essentials Server

Although it is not recommended, you can install Analytics on an existing Essentials server.

You can only install Analytics and Essentials on the same machine if you have a single-node configuration. If your Essentials is clustered, this configuration is NOT possible.

When you need to install Analytics as a Hub onto an existing Essentials server, Geocortex Core is already installed on the server, which means that you are not prompted to create a cluster as this happens automatically.

In addition, you are not offered the chance to select where the Analytics data is stored because the folder was selected when Essentials and Core were installed.

Install Analytics on a Hub Server

The installation process varies slightly when you are installing on a Hub server or on an Agent server. There is also variation if you are installing an Agent on a machine that already contains an installation of Geocortex Core. For example, the installer uses the existing data folder and cluster name, so you do not see those options.

If you have a version of Geocortex Core below version 3.0, you are asked for a shared secret.

It is important to install the Hub server first.

If you plan to use an ArcGIS Identity from a Portal for ArcGIS to log in to Analytics, you must first create a dedicated application in that Portal for ArcGIS. You can only use an OAuth2-secured Portal for ArcGIS as an identity provider. The App that you create provides you with the App ID and App Secret you need to securely log in to Analytics.

Cluster names are case-sensitive. Make a careful note of the exact name including capital or lower case letters.

Install Analytics on a Hub server:

  1. Navigate to the folder where you unzipped the installation package.

  2. Double-click the Geocortex Analytics.exe file or the desktop icon.

    The Geocortex Analytics dialog opens.

  3. Click the I agree to the License Terms and Conditions checkbox.

    You cannot continue the installation process until you accept the terms and conditions.

  4. If you want to change the default location to install Analytics, click the button and navigate to the folder where you want to install Analytics.

  5. Click Next.

  6. On the Installation Type page, select Hub.

  7. Click Next.

    The installer checks to see if there are other Hub servers installed.

    If other Hubs are found, a message appears that allows you to either create a new Hub or to change to an agent installation.

    If you see this message, the installer has found an existing Hub server. Do one of the following:

    If the installer detects either a Geocortex Essentials instance or an ArcGIS Server on the machine, you will also see a notice.

     

  8. On the Data Folder page, do one of the following:

  9. Click Next.

    The Run Service by Account window opens.

    If your environment is behind a proxy, you can use this window to enter the credentials of the Windows user account that is configured to use forward proxy server settings.

  10. To enter the Windows user account details, click Enabled.

    The Username and Password fields appear so that you can enter the Windows account credentials.

  11. In the Username field, type in the Username of the Windows user account you set up on the Hub machine.

    For details about how to set up a Windows user account, see Use a Forward Proxy Server with Analytics.

  12. In the Password field, type in the password that matches the user name of your Windows user account.

    You can test the validity of the credentials by clicking Test User Account. If the information matches the Windows user account, you will see a confirmation message.

  13. Click Next.

    The Create a Hub page opens.

  14. On the Create a Hub page, do the following: 

  15. Click Next, and then on the Confirm Installation page, click Install.

    Notice that Geocortex Core is installed automatically.

    The final page of the install wizard offers you options to:

  16. Click Finish.

    Both the Geocortex Analytics License Activation and ArcGIS Identity Setup windows open.

  17. In the License Activation window, do any of the following:

  18. In the Geocortex ArcGis Identity Setup window, you can set up credentials to access Analytics.

    To set up an ArcGIS Identity, follow the procedure in Set up an ArcGIS Identity or Portal for ArcGIS Login.

  19. When the confirmation of a successful installation displays, click Finish.

    The restart message displays.

  20. Click Yes.

    When you have set up an ArcGIS Identity, in the ArcGIS Identity Setup window, and your machine has restarted, you can open Geocortex Analytics and sign in.

Install Analytics on an Agent Server

If you are installing Analytics as an agent on a server so that you can monitor Geocortex Essentials, ensure that you install Essentials first.

If your Agent server has to use a proxy to access the Hub server, you need to set up a Windows user account on the Agent machine that is configured to use the forward proxy server settings. Because the Agent installer does not include a window where you can add the credentials of the Windows user account, you need to set up the account manually. See Use a Forward Proxy Server with Analytics for more information.

Install Analytics on an Agent server:

  1. Navigate to the folder where you unzipped the installation package.

  2. Double-click the Geocortex Analytics.exe file or the desktop icon.

    The Geocortex Analytics dialog opens.

  3. Click the I agree to the License Terms and Conditions checkbox.

    You cannot continue the installation process until you accept the terms and conditions.

  4. Click Next.

  5. When the Installation Type page opens, select the Agent radio button.

  6. Click Next.

  7. On the Data Folder window, do one of the following: 

  8. Click Next.

    The Connect to Hub window opens.

  9. In the Cluster Name drop-down list, select the cluster name of the Analytics Hub.

  10. If the cluster name you expect does not appear in the list, select Advanced, and then type in the name of the cluster.

  11. In the Host field, type in the IP address or fully-qualified domain name of the Hub server.

    The Port field will default to 19201. Only change this number if you've already specified a different port for your Hub's document store.
  12. In the Shared Secret box, type or paste in the name of the shared secret of this cluster.

  13. Select Enable SSL if your Hub server is using Secure Socket Layer (SSL) to encrypt communication between applications on your cluster.

    If you enable SSL on this node, you must enable it on all nodes.
    Similarly, you must install an SSL Certificate on every node in the cluster.

  14. Click Next, and then on the Confirm Installation page, click Install.

  15. When the confirmation of a successful installation displays, click Finish.

Activate Analytics Online or Offline

The most common timing for activating Analytics is during the initial installation at the very end of the installation process on the Hub server when the License Activation wizard opens automatically. However, you can start the License Activation Wizard at any time from the Windows Start menu.

Licensing is monitored by a specific file—GeocortexOptimizer.dlsc, which by default, can be found in the C:\ProgramData\Latitude Geographics\Licenses folder on the server. When you enter your product key online, the activation information is written to this file and then you are able to use Analytics. You can also activate Analytics manually if you are offline, but you need to send the licensing file to Latitude Support so that they can activate it for you. When they return the file, you use it to overwrite the original and Analytics is activated.

Activation is only necessary on the Hub server.

Activate Analytics Online

To activate Analytics online:

  1. In Windows, click the Start icon.

  2. Start typing the name of the product.

    A list of applications with the characters you typed appear in the list to select.

  3. Click Geocortex Analytics Activation.

    The License Activation wizard opens.

  4. Do any of the following:

  5. Click Close.

Activate Analytics Offline

To activate Analytics offline:

  1. In Windows, click the Start icon.

  2. Start typing the name of the product.

    A list of applications with the characters you typed appear in the list to select.

  3. Click Geocortex Analytics Activation.

    The License Activation wizard opens.

  4. Paste in the license key that you received from Latitude Geographics Support, and then click Activate.

    The process fails but during the attempt, the software writes specific information about your system to the license file that is needed for activation.

  5. Navigate to C:\ProgramData\Latitude Geographics\Licenses and email the GeocortexOptimizer.dlsc file to support@geocortex.com.

  6. When you receive the activated licensing file back from Latitude Support, use it to overwrite the same file on the same server.

    The Licensing file is server specific. The amended license file only works on the same server that the original file is on. It does not work on any other server.

Activate Analytics Running on a Demo License

If you have been running Analytics using a Demo license and you purchase the software, you can activate your installed software.

To activate Analytics running a Demo license:

  1. In Windows, click the Start icon.

  2. Start typing the name of the product.

    A list of applications with the characters you typed appear in the list to select.

  3. Click Geocortex Analytics Activation.

    The License Activation wizard opens.

  4. Do one of the following:

  5. Click Close.

Enable SSL in Analytics

From Analytics version 1.3, you can choose to enable Secure Sockets Layer (SSL) during installation. Using SSL enhances the security of data exchanged between Analytics installs (Hub and Agents) by ensuring that the data transmitted has been encrypted. If your cluster is exposed externally or the data collected is sensitive, using SSL is recommended.

Support for SSL applies only to new installations of Analytics. If you upgrade Analytics, you cannot enable SSL if it was not already enabled.

If you enable SSL on one node, you must enable it on all nodes.

A prerequisite of using SSL, is that you install an IIS certificate on every Node of the Cluster. The certificate must be bound to port 443 on each server. The host name on the certificate must be a fully-qualified domain name. For more information about certificates, see Microsoft Technet - Certificates.

Enable SSL During a New Installation

To set up Analytics to use SSL, during installation, you must select the Enable SSL option on the Create a Hub page of the installation wizard. You must do this for the Hub and all the Agent machines.

In the ArcGIS Identity Setup for Portal for ArcGIS

If you select the Enable SSL option during installation, when you open the ArcGIS Identity Setup window, the Include SSL-Secured Redirects option is already selected and so this option is not available.

In addition, if you add Alternate Redirect URLs, only HTTPS URLs will be accepted. As you continue with the Identity Setup, you must also ensure that the identity provider used by the specified Portal for ArcGIS instance sends all requests via HTTPS.

SSL and Clusters

Enabling SSL is a cluster-based choice. Either the whole cluster is enabled for SSL or the whole cluster is not enabled. Every node in the cluster must have a valid SSL Certificate installed on it.

For example, if you plan to add an Analytics Agent and the Hub is SSL enabled, then the Agent must also have a valid SSL certificate and you must select the Enable SSL option during the installation. Any other nodes in the same cluster, including agent installations, and Essentials installations on the same machine as Analytics agents, must have the same issuing authority and certificate type.

If you try to join an SSL-enabled cluster without selecting the Enable SSL option, you will not be able to proceed.

Similarly, during installation, if you try to join a cluster that is not SSL enabled and you select the Enable SSL option, you will get an error message and have to clear the Enable SSL option before you can proceed.

Open Geocortex Analytics

Once you have installed Analytics, you can check that it is collecting data by opening the application. The Analytics application can only be found on the Hub server.

It's best to wait for 5 minutes so that Analytics has had a chance to collect some data before opening the application.

To open Geocortex Analytics:

  1. Do one of the following:

© 2019 Latitude Geographics Group Ltd. All Rights Reserved.

Documentation Version 1.5