Server requirements
Connectors run as Windows services and must be installed on a server within your organisation's environment. Multiple connectors can be installed on the same server provided the resource and port requirements are met.
Connector Version 2 (current)
Windows Server 2019 or later
64-bit Java JDK version 11, with the JAVA_HOME option enabled during installation
1 GB RAM available per connector instance (additional memory may be required depending on other services running on the server)
500 MB disk space per connector installation
A dedicated network port per connector (must be in the range 1024–65535)
Administrative rights to install applications
Connector-specific prerequisites
Some connector types require additional components before installation.
The Database (Measurement) Connector requires a compatible JDBC driver for the target database. The driver must be obtained from the database vendor.
The Historian Connector for PI systems requires access to the PI Web API service. Confirm this is reachable from the connector server before proceeding.
The Historian Connector for PHD systems requires the PHD client driver provided with the historian software.
Installing a connector
Run the installer for the connector type you want to install. Administrator permissions are required.
Select New to install a new connector.
Choose the directory where the connector will be installed. Log files are also stored in this location.
Specify the port number the connector will use. Port numbers must be in the range 1024–65535 and cannot be reused by another connector on the same server.
For Measurement and PHD connectors, provide the location of the required driver file when prompted.
Configuring certificate authentication
During installation you must provide the client certificate used to authenticate the connector with the platform.
When prompted, supply the location of the keystore file and the keystore password. The keystore file must be in PKCS#12 format (.p12 extension) and contains the certificate and private key. See Client Certificates for Connectors for the procedure to generate this file.
If multiple connectors are installed on the same server, the same certificate can be used for all of them.
Completing installation
Once installation completes, the connector starts automatically as a Windows service and the connector management interface becomes accessible via a web browser on the installation server.
First-time setup
When you access the connector interface for the first time, you are prompted to create administrator credentials.
Username — 6 to 20 characters
Password — 8 to 20 characters, must include at least one uppercase letter, one lowercase letter, and one number
Sign in after creating these credentials to continue configuration.
Next steps
After installation:
Upload the required credential files for the connector via the Manage Credentials screen. See Connector Credentials Reference for the full list of files required for each connector type.
Provide the public key from the connector certificate to support so the connection can be authorised on the platform side.
Once these steps are complete, the connector can be configured with queries and scheduled jobs to begin transferring data.