AspenTech IP.21 Agent

The AspenTech InfoPlus 21 Agent uses SqlPlus ODBC Driver to execute SqlPlus queries to read data from an InfoPlus server. The agent is a .NET application and is delivered separately from the core HighByte Intelligence Hub installation. The requirements for the agent are as follows.

1. Windows Operating System
2. Microsoft .NET 4.8 or greater
3. SqlPlus ODBC Driver. This is installed as part of the InfoPlus 21 installation or manually following instructions documented in the Aspen Support Knowledge Base.

The agent runs as a standalone application, by running the intelligencehub-ip21.exe OR as a Windows service. When running standalone, it’s recommended to run the executable with admin level permissions. To install as a service, run the following command. InstallUtil is found in the .NET installation directory: %windir%\Microsoft.NET\Framework64\v4.0.30319\InstallUtil.exe

installutil intelligencehub-ip21.exe

NOTE: Whether the agent is run in a console or a service the application should be run with a user that has read-only access to InfoPlus.21 database.

To optionally control the service name, using the following syntax.

installutil /serviceName="myServiceName" /displayName="myDisplayName" intelligencehub-ip21.exe

The agent opens a port to receive requests from the HighByte Intelligence Hub instance. By default, this communication occurs using secure websockets. On the first run the agent creates a self-signed certificate called intelligencehub.pfx as well as a settings.json file. The file contains the following.

{
	"port": 45390,
	"token": "randomtoken"
}

The port controls the port that the agent listens on. This port must be open and available to the Intelligence Hub connecting to the agent. The token is a random security token created by the agent. This token must be applied to the Intelligence Hub IP.21 connection settings to authenticate the hub. Any changes to these settings require restarting the agent.

In the Intelligence Hub IP.21 connection settings, enter the IP/port of the agent, as well as the token. The agent also has a local intelligencehub.log file for debug information. See below on how to enable detailed diagnostics logging.

Enable Diagnostics Logging

The IP.21 Agent includes detailed diagnostics to analyze read and write performance. To enable diagnostics create a intelligencehub-ip21.exe.config file in the same directory as the intelligencehub-ip21.exe file. Add the following configuration to the file, save the file, and restart the agent. Diagnostics logs will be included in the console output and in the log file.

If the agent is running as a Windows Service under a Windows account, it must also have local file system access to write the diagnostics file locally. Otherwise, the local log file will not be written.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
	<startup>
		<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8"/>
	</startup>
	<system.diagnostics>
		<trace autoflush="true" indentsize="4"></trace>
		<sources>
			<source name="IntelligenceHub"
			  switchName="sourceSwitch"
			  switchType="System.Diagnostics.SourceSwitch">
			</source>
		</sources>
		<switches>
			<add name="sourceSwitch" value="Verbose"/>
		</switches>
	</system.diagnostics>
</configuration>