Skip to main content

Documentation Portal

Installing a self-hosted Plant Integrations

System Requirements

This section contains the minimum system requirements of Plant Integrations.

  • Operating system:

    • Windows Server 2016, 2019, 2022 (Standard or Datacenter) with Desktop Experience

    • Windows 10 or Windows 11

  • A minimum of  2 GB available memory

  • A minimum of 500 MB of available diskspace

Prerequisites

The installer currently does not  bundle/install the .NET (Framework) dependencies that are required to run the application. Therefore, we need to install the following components before starting the installer:

The installer will detect whether these components are installed. If they are not, an error message will be displayed indicating that these components are required.

PlantIntegrations_SelfHosted_Error.png

For reference, the detection of .NET (DotNetCompatibilityCheck) can yield the following result code:

  • 0 - Successful compatibility check.

  • 13 - Requested platform is not compatible with OS. 

  • 12289 - No runtime is installed.

  • 12290 - Required runtime is not installed.

  • 12291 - Failed to get hostfxr exports.

  • 12292 - Invalid arguments.

  • 12293 - Failed to construct temp json file path.

  • 12294 - Failed to create temp json file.   

Installation process

The installation process is straightforward. 

PlantIntegrations_SelfHosted_Welcome.png

Users are required to accept the license agreement and may optionally specify a custom installation directory. By default, the software is installed in the C:\Program Files\TrendMiner\Plant Integrations\ directory.

PlantIntegrations_SelfHosted_directory.png

The installer will perform the following steps during the installation of Plant Integrations:

  • Installs the “TrendMiner Plant Integrations API Gateway Service” as a Windows Service running under NT AUTHORITY\NetworkService

  • Installs the “TrendMiner Plant Integrations Connector Service“  as a Windows Service running under NT AUTHORITY\NetworkService

  • Adds Windows Firewall rule - Allowing external connections to our API on port 8001

    • <FirewallException Name="TrendMiner Plant Integrations (HTTP)" Port="8001" Protocol="tcp" Scope="any" /> 

  • Starts all the services

Validation

To validate the installation you can use the “Services” management console to check that the application is running:

PlantIntegrations_SelfHosted_validation.png

There is an installer for both x64 and x86 Plant Integrations. It is recommended to use the x64 version of Plant Integration. The x86 version should only be utilized when a provider specifically requires it. The following providers must run using Plant Integrations x86 :

  • Yokogawa Exaquantum

  • Honeywell PHD 3.X (Note: PHD 4.X and later require x64)

  • Aveva System Platform (Wonderware)

All other supported providers can function on either the x86 or x64 connector.

Endpoints

Component 

URL 

Plant Integrations API

http://localhost:8001/

The swagger endpoint is available on http://localhost:8001/swagger

PlantIntegrations_SelfHosted_swagger.png
Application & Data

The data of the application is stored separately from the binaries of the application. This translates into two directories on the filesystem. 

  • Application binaries - configurable during installation, default C:\Program Files\TrendMiner\Plant Integrations\.

    • There are separate subdirectories for the x86 and x64 instance of the connector

  • Application data - %LOCALAPPDATA%\TrendMiner\PlantIntegrations

    • For a normal user this will be expanded to C:\Users\$(Username)\AppData\Local\TrendMiner\PlantIntegrations

    • For NT AUTHORITY\NetworkService this will be expanded to C:\Windows\ServiceProfiles\NetworkService\AppData\Local\TrendMiner\PlantIntegrations

Important

The Application data folder will not be removed when the application is uninstalled or updated. However, migration scripts are allowed to change the databases within this folder.

Service Accounts

The default service account utilized by Plant Integrations is NT AUTHORITY\NetworkService. You can leverage the Service Isolation feature in Windows to assign specific permissions to the Windows service. If this option is unavailable, you may proceed to change the service account for the installed service.

We have ensured that any modifications made to the service account remain intact during updates. Additionally, the account associated with the Windows service is excluded from any alterations during the update process.

Vendor Assemblies

Some providers require third-party libraries of SDKs to function correctly. If these libraries cannot be automatically resolved during runtime, you should put these additional libraries alongside the application binaries.

The default location is C:\Program Files\TrendMiner\Plant Integrations\Connector 

Known Limitations

The following features are not supported currently:

  • Changing the network port where tm-plant-integration is running

  • Configure TLS to enable HTTPS

  • Configure Basic Authentication

  • Installing multiple instances of tm-plant-integrations on the same machine

In this section: