InsightIntegration Module

The InsightIntegration Module implements integration between Geocortex Analytics and the HTML5 viewer.

The InsightIntegration Module collects usage and other data about the viewer and sends it to the Client Relay Collector in Analytics. The InsightIntegration module creates a file in local storage and adds events that happen in the viewer to this file. Once the file reaches 100 KB, or the configured amount of time has lapsed, the module creates a zip file and sends it to the Client Relay Collector.

The InsightIntegration Module then collects data about:

• Viewer users

• Map services, layers and areas viewed

• Tools used

• Searches performed

• Data links resolved

• Log messages

• Print events

• Report-generation events

• Workflow requests

• Unhandled errors

This data is collected and used in informative reports within Analytics.

The domains of Analytics and the HTML5 Viewer are likely different. If so, to ensure the HTML5 Viewer can send data to Geocortex Analytics, you must add a proxy entry for Geocortex Analytics in the proxy.config file, which is located in the root folder where HTML5 Viewer is installed. For example, <serverUrl url="http://MyDomain.com/Geocortex/Analytics" matchAll="true"></serverUrl>.

Configuration Properties

Module

• enabled: If set to true, the module is enabled.

• dataRelayUri: Sets the URL to the Client Relay in Analytics. For example, "http://localhost/Geocortex/Analytics/ClientRelay"

• dataRelayIntervalInSeconds: Sets the time interval in seconds that the module waits before sending accumulated data to the Client Relay Collector. The default is 30 seconds.

Views

• ExternalComponentView: No configuration properties

View Models

• ExternalComponentViewModel:

  • containerRegionName: The name of the container region in which to host Analytics integration. The default is ExternalComponentRegion.

  • containerRegionType: The type of the container region in which to host Analytics integration. The default is geocortex.framework.ui.DivStackRegionAdapter.

  • headerIsVisible: To display the container header, set to true. The default is true.

  • showXButton: To display a button to close the container, set to true. The default is true.

  • showMaximizeButton: To display a maximize button for the container, set to true. The default is true.

  • resizeY: To allow the container to be vertically resized, set to true. The default is true.

  • selectorIconUri: (optional) The URI for the icon to display at the left end of the header. The icon is for display only—it is not clickable.

  • selectorText: The text to label the drop-down list of external components.

  • defaultComponents: An array of IDs of external components to open when ExternalComponentView is activated. The default is [ ].

  • ExternalComponents: An array of applications that the viewer integrates with. The default is [ ].

See Also...

Analytics Integration