Initial Configuration

Some of the configuration for Analytics is done automatically. When Analytics is installed, it detects the components on the machine like Essentials and begins monitoring and collecting data from them immediately. If new components are added to the system, Analytics detects them as well.

Although many of the functions of Analytics happen automatically without any configuration necessary, there are some elements that you must configure before Analytics can function fully. For example, you must enter email and SMS details if you want to be notified when certain alarms fire. Similarly, if you use ArcGIS Online, you must provide Analytics with your account credentials in order to collect usage data about your ArcGIS Online account. The same is true for ArcGIS Servers where you need to add administrator credentials in order for Analytics to monitor them.

The Configuration section is where you edit or add resources manually as well as customize alarms and settings at all levels of your GIS infrastructure. To configure Analytics, you go to Configuration and select the resource you want to configure from the sidebar.

Agent and Remote Monitoring

How you configure a resource depends on whether you plan to monitor it remotely or using an Agent.

Geocortex Essentials cannot be monitored remotely. It must be monitored by an agent.

For more information, see Remote Monitoring and Agent Installation in the Installation Help.

Change the Monitoring Method

If you have a resource currently configured to collect data using Remote Monitoring and you want to change to using an Agent installation, ensure that you remove the resource from Analytics before you install the Agent on the server.

If you have a resource currently configured to run as an Agent installation and you want to change to use Remote Monitoring, ensure you uninstall the Agent and remove the resource from Analytics, and then add the server as a Remotely Monitoring resource.

Initial Configuration Tasks

After you install Analytics, you need to configure key elements of your system to provide Analytics access to the information that it needs to monitor.

To configure Analytics, you go to Configuration and select the resource you want to configure from the sidebar.

Specifically, the following elements need to be configured once you have installed Analytics:

Configure Alarm Notifications

When an alarm fires in Analytics, two events occur:

To enable Analytics to send either email or SMS messages when an alarm is fired, you need to ensure that your email and phone number are entered in the System section under Configuration. To receive alarm notifications as a text message to your phone, you must also set up a Twilio SMS account on the Twilio website.

Types of Notification

You can set the type of notification the alarm sends out by changing the settings under each resource or by setting global alarms that affect all the resources of a particular type, for example, ArcGIS Servers.

There are several types of alarm notifications:

Configure Email Settings

You enter email settings under System in Configuration on the Email Settings tab. You can use only one SMTP email host but you can set up notifications to go to multiple emails.

You can set the value of any of the following attributes:

Configure SMS Settings

You enter SMS contact information under System in Configuration on the SMS Settings tab.

You can edit the value of any of the following attributes:

Activate or Deactivate Alarm Notifications

Information about which Email(s) and which SMS(s) to use when sending notifications is entered on the System tab. However, you activate or deactivate alarm notifications for each individual resource that you monitor.

If you do not activate any alarm notifications on any resources or you do not enter any email or SMS information, you will not receive any alarm notifications via email or SMS. However, the alarm information about all those resources will still display in the Status tab.

If you do not wish to receive email or SMS notifications for a specific resource, ensure that the Email and SMS checkboxes are not selected. The default setting in Analytics, is to not have alarm notifications selected.

If you do want to receive alarm notifications when a resource fails or is slow, you need to activate the email and SMS settings for that resource specifically or you can activate notifications globally for each resource type.

Configure Portal for ArcGIS

Because your Portal for ArcGIS is secured, you need to enter credentials to access your portal in the Portals section. You must use the access credentials from an administrator account.

To use OAuth2 security, you have to first create an app for Analytics in your Portal for ArcGIS as you need the App ID and App Secret. You also need to specify the redirect URI.

ADFS/OAuth2 - Create a Portal App

To generate the App ID and App Secret properties that Analytics needs in order to access your Portal for ArcGIS, you need to create and register an application in Portal for ArcGIS. The app registration process creates the App ID and App Secret that function like a user name and password. You use these credentials to set up Analytics and allow it to gather data about the portal.

Add and Register an Application in Portal for ArcGIS

To add and register an application in Portal for ArcGIS:

  1. Open the Portal for ArcGIS page and select MY CONTENT.

  2. Click Add Item, and then select An application.

  3. In the dialog box that opens, select the Application radio button.

    The Application dialog box appears.

  4. In the Title box, enter a title for the application, for example, Analytics Access.

  5. To add a search tag to help you find this application, in the Tags box, type in a word that is in the title of your app. for example, Analytics.

  6. Click Add Item.

    The application's details page opens.

  7. Do one of the following:

  8. To see the information, in the App Registration area, click REGISTERED INFO.

    The App Registration information lists the App ID and App Secret.

    In order to collect data from your organization's account, the App must contain the redirect URI, which you will find on the Setup page under Configuration in Analytics.

  9. Click the blue Show Secret text to see the full App Secret text.

Add a Portal for ArcGIS to Analytics

To set up a Portal for ArcGIS:

  1. Open Analytics, and then click Configuration.

  2. At the bottom of the sidebar, click Add and select ArcGIS Portal.

  3. On the Setup tab, enter the following information:

  4. Click Save.

    The portal has been added. The name of the portal appears in the resource sidebar under Portals.

Add Credentials to an ArcGIS Portal for OAuth2 Security

To add credentials to an ArcGIS Portal for OAuth2 Security:

  1. Open Analytics, and then click Configuration.

  2. Click the beside Portals in the sidebar to see all the portals.

  3. Click the name of the portal you want to authorize.

  4. On the Setup tab, select OAuth2 from the Authentication Type drop-down list.

  5. Enter the following information:

  6. Click Save.

    A prompt appears to login to your Portal account.

Configure Access to ArcGIS Online

If you have an organizational ArcGIS Online account, and you want to collect data on the credits remaining and the resources used by your organization, you need to configure ArcGIS Online in Configuration in Analytics.

You can also use your ArcGIS Identity to log in to Geocortex Analytics. See Set up an ArcGIS Identity or Portal for ArcGIS Login in the Installation Help..

To collect data about your organization's ArcGIS Online account, you must have an ArcGIS Online user account with Administrator access.

Before you can collect data about your ArcGIS Online account, you need to provide Analytics with access to your ArcGIS Online account. To provide access, you need to create an App for Analytics in ArcGIS Online that contains a redirect URI. Analytics uses the App ID and App Secret of this app to gather information about your ArcGIS Online account.

Add and Register an Application in ArcGIS Online

To add and register an application in ArcGIS Online:

  1. Open ArcGIS Online and select MY CONTENT.

  2. Click Add Item, and then select An application.

  3. In the dialog box that opens, select the Application radio button.

    The Application dialog box appears.

  4. In the Title box, enter a title for the application, for example, Analytics Access.

  5. To add a search tag to help you find this application, in the Tags box, type in a word that is in the title of your app, for example, Analytics.

  6. Click Add Item.

    The application's Overview tab opens.

  7. Select the Settings tab.

  8. Do one of the following:

  9. To see the information, in the App Registration area, click REGISTERED INFO.

    The App Registration information lists the App ID, App Secret.

    In order to collect data from your organization's account in ArcGIS Online, the App must contain the http://[yourhostname]/analyticsreports/OAuth2Helper.html redirect URI.

  10. Click the blue Show Secret text to see the full App Secret text.

Configure ArcGIS Servers/Services

The collection of information from ArcGIS Servers takes into account the appropriate load that each ArcGIS Server is experiencing and determines when and how often to probe that server based on how busy it is.

Intelligent Probing

When Analytics is probing services on an ArcGIS Server, it distinguishes between active and inactive services. An active service is an ArcGIS service that is currently busy and has at least one instance of the service running. Analytics always respects the configured collection interval for an active ArcGIS service because the service is already in use. An inactive service is an ArcGIS service that is not being used and has not received any traffic for some time. To prevent Analytics from adversely affecting this server’s performance, inactive services are only checked every 24 hours, starting from the time that Analytics started. However, depending on the total number of services and the number of clusters and sites in any given ArcGIS environment, services may be checked more frequently.

ArcGIS Clusters

Analytics detects if ArcGIS Servers are within a cluster and assumes that a clustered server can carry a greater load as it is distributed across the cluster. Analytics takes clusters into account when it determines how often to probe a particular server.

Administrator Access Credentials

One result of intelligent monitoring is that Analytics 1.4.x requires you to enter administrator access credentials for the ArcGIS Servers you want to monitor.

If ArcGIS Server is installed on the same machine as Analytics Hub or Agent and the server did not have administrator credentials configured, the server is added to the resource sidebar, but is shown in red italics until you edit that server in Configuration and supply the credentials.

Analytics cannot collect information from an ArcGIS Server until you enter the administrator access credentials in Configuration.

Add Credentials to an ArcGIS Server

To add credentials to an ArcGIS Server:

  1. In Analytics, click Configuration.

  2. In the Sidebar, expand ArcGIS Servers and click on the name of the server.

  3. On the Setup Tab, in the Authentication Type drop-down list, select one of the following:

  4. In the Administrative Settings section, select http or https and then enter the URL to the ArcGIS Administrator directory.

    The URL should be a fully qualified URL that includes the domain name of the server.

  5. In the Username and Password fields, type in the name and password of a person who has administrator access to this server.
  6. Save your changes.

Set ArcGIS Server Logging to Verbose

In order to collect logging data for ArcGIS server: 

If you have ArcGIS Server logs at multiple locations, you must configure all of them to change the log level to Verbose.

To set the ArcGIS Server log level to Verbose:

The screen shots and steps for this procedure use ArcGIS Server Manager 10.2.

  1. Open ArcGIS Server Manager.

  2. Select the Logs tab.

  3. Click Settings.

  4. In the Log Settings dialog box, set the log level to Verbose, and the Keep logs for at least to a minimum of 7 days.

  5. Click Save.

Configure Access to Remote Servers

Analytics has the ability to monitor servers remotely in order to collect Windows, System, and Event data. In order to access these remote servers and collect data from them, you need to add the server to Analytics as a remote server with its login credentials. For information on how to set up a Remote server, see Add a Remote Server and Server Configuration.

To make it possible to collect data from remote servers, all the permissions and firewall settings need to be set up before you add and configure the server in Configuration. These firewall rules are in addition to the firewall rules discussed in Ports and Firewall Access.

Enable Windows Firewall Inbound Rules

To enable Windows Firewall inbound rules:

  1. Open Windows Control Panel.

  2. Click Windows Firewall.

  3. In the right side panel, click Advanced settings.

    Windows Firewall with Advanced Security opens.

  4. In the left side panel, click Inbound Rules.

  5. Scroll down until you find the Windows Management Instrumentation rules.

  6. Select the Windows Management Instrumentation rules, right-click, and then select Enable Rule.

  7. Scroll down to the Windows Remote Management (HTTP-In) rules.

  8. Right-click the two rules, and then select Enable Rule.

  9. Close Windows Firewall.

Add a Remote Server

To add a Remote server:

  1. Open Analytics and then click Configuration.

  2. At the bottom of the resource sidebar, click Add.

  3. On the Setup tab, enter the following information:

  4. Click Save.

    The server appears in the sidebar with the other servers.

Enable the Remote Registry Service

The Remote Registry service makes it possible for users to modify the registry settings on a particular computer remotely. The Remote Registry service is usually disabled. However, if it is disabled, Analytics cannot collect Performance Counter and Windows Event information and so it needs to be enabled on the server that you want to access.

To enable the Remote Registry service:

  1. On the server you are accessing remotely, do one of the following:

  2. Scroll down the list of services until you find the Remote Registry.

  3. Double-click the Remote Registry service.

    The Remote Registry Properties dialog opens.

  4. On the General tab, in the Startup type drop-down list, select Automatic (Delayed Start).

  5. Click Apply and then OK.

  6. Close Services.

Configure Analytics to Collect Data from Viewers

When Analytics is integrated with a viewer in Geocortex Essentials , the Analytics Integration module within each viewer sends viewer operational information to Analytics. You have to enable Analytics in every viewer and provide each viewer with the URI of the Client Relay in Analytics.

If an Essentials Site can be loaded outside the firewall, the Client Relay URL must also be accessible outside the firewall. If the Client Relay URL is not accessible behind the firewall, viewers sending data to the Client Relay URL will be blocked by the firewall and the data will not reach Analytics.

From Analytics 1.4, the old URL http://servername/Geocortex/Insight/ClientRelay is no longer supported and must be updated to http://servername/Geocortex/Analytics/ClientRelay.
Analytics does not collect information about Layer Catalog usage in the Geocortex Viewer for HTML5.

To enable Analytics in a viewer within Manager:

  1. Log in to Geocortex Essentials and navigate to the site that contains the viewer that you want to integrate into Analytics.

  2. Expand the side panel of the viewer that you want to activate.

  3. On side panel, click Analytics Integration.

    The Analytics Integration page opens.

  4. On the Analytics Integration page, select the Enabled checkbox to activate Analytics.

  5. In the Data Relay URI box, paste in the correct URI to the Client Relay, for example:

    http://analyticshub.domainname.com/Geocortex/Analytics/ClientRelay.

  6. Click Apply Changes.

  7. Click Save Site.

Add the Client Relay URL to HTML5 Viewers

To provide full access to HTML5 viewers, you need to configure an external URL for the Client Relay. If you do not include the external URL and only point the viewer to http://servername/Geocortex/Analytics/ClientRelay, then external clients will not able to relay to the server. To ensure that the Client Relay works, you must add a proxy URL to the HTML5 viewer's proxy.config file. The default installed location of the proxy.config file for the HTML5 viewer is C:\inetpub\wwwroot\Html5Viewer\proxy.config.

The URL must be added in the <serverUrl> element of the proxy.config file of every HTML5 viewer as follows:

<serverUrl url="http://ServerLocation" matchAll="true"></serverUrl>

The serverUrl can include the following parameters:

Sample code of a proxy.config file:

<?xml version="1.0" encoding="utf-8" ?>
   <!-- Proxy.config is used to set the ArcGIS Server services that the proxy will forward to. mustMatch: true to only proxy to sites listed, false to proxy to any site -->
  <ProxyConfig mustMatch="true">
    <serverUrls>
      <serverUrl url="http://agsdemo.geocortex.com/arcgis/rest"matchAll="true"></serverUrl>
      <serverUrl url="http://gedemo.geocortex.com/geocortex/essentials"
matchAll="true"></serverUrl>
      <serverUrl url="http://sampleserver1.arcgisonline.com/arcgis/rest/services/"matchAll="true"></serverUrl>
      <serverUrl url="http://sampleserver2.arcgisonline.com/arcgis/rest/services/"matchAll="true"></serverUrl>
      <serverUrl url="http://sampleserver3.arcgisonline.com/arcgis/rest/services/"matchAll="true"></serverUrl>
      <serverUrl url="http://sampleserver6.arcgisonline.com/arcgis/rest/services/"
matchAll="true"></serverUrl>
      <serverUrl url="http://server.arcgisonline.com/arcgis/rest/services/"
matchAll="true"></serverUrl>
      <serverUrl url="http://services.arcgisonline.com/arcgis/rest/services/"
matchAll="true"></serverUrl>
      <serverUrl url="http://orthogonal.esri.com/arcgis/rest/services/"
matchAll="true"></serverUrl>
      <serverUrl url="http://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer"
matchAll="true"></serverUrl>
    <serverUrl url="http://AnalyticsServerLocation" matchAll="true"></serverUrl>
    </serverUrls>
 </ProxyConfig>
			

To prevent mistakes when you are editing XML, we suggest you use a text editor like Notepad++ that includes syntax highlighting.

Configure Web Applications

If you want Analytics to monitor Web Applications, they must be manually added in Configuration.

If you require alarms to fire on a Web Application that requires authentication, you also need to enter a username and password that has access to the Web Application. Only Windows Authentication is supported.

You can monitor any of the following kinds of Web Applications:

Each type of Web Application is added using a different procedure.

The procedure for custom Web Applications requires a detailed knowledge and understanding of the code of the specific Web Application. For this reason, we recommend that only the person who developed the application, or someone who knows the code well, should add a custom Web Application to Analytics.

For detailed information about how to set up Web Applications, see Web Application Configuration.

© 2018 Latitude Geographics Group Ltd. All Rights Reserved.

Documentation Version 1.4