Installation

The section covers the installation of the Connector. Before starting the installation process, ensure your systems meet the system requirements.

The following steps already assume you have downloaded the Connector and copied across the installation package to the desired server, with access to both the OSIsoft PI and PTC Thingworx platforms and that you have logged in with local Administrator privileges to the operating system.

It is recommended prior to install you gather the necessary information required during the install process. This includes:

Local user login credentials to run the Connector service (by default you can use the LOCALSYSTEM user. However, company policy may dictate you will need to provide another user to do this.
PTC Thingworx web address for the server, the port that is open and the API key required to authenticate the connection.
OSISoft PI and AF Server names and login credentials for a user with sufficient permissions to see the data you want to import.

The Connector comes with a 30-day trial license enabled by default. The trial license provides full Connector functionality for the time bound period of the trial.

To purchase a full license, please contact Capula. Once you have purchased a license, you will need to run through the steps outlined in https://capulaopus.atlassian.net/wiki/spaces/OPTPTC/pages/1051885792 to generate a machine signature file, so that Capula can generate a license file for you.

Install the Connector

To install the Connector:

Locate the Connector MSI package, right click the MSI and select Run as Administrator
Select Yes on the User Account Access window
The installer package for the Connector will then start. Select Next to proceed
Review the End User License Agreement and click the I accept the terms in this License Agreement check-box and select Next to continue
Select the installation folder where you would like to install the Connector on the local machine and select Next. By default the installation folder is C:\Program Files(x86)\Capula\PI Connector\
Enter the details of the account that will run the Connector service and select Next.
This installation guide assumes you will be running the service as the local user. If your organisation uses group policies and the server is connected to a domain, please refer to your Network Administrators about providing a user with the necessary permissions to start/stop services.

The details provided above can be changed after installation.
You will be presented a screen that will require you to have your PTC Thingworx details to hand. Enter the necessary details in the appropriate fields and select Next

The connection parameters are:
- Thingworx Address: IP or DNS name of the ThingWorx server - i.e, 127.0.0.1 or localhost
- Port: Thingworx server port - i.e, 80 or 443
- Remote Thing Name: The name of the Thing in PTC Thingworx that will be used - The default is OSIPIThing
- Application Key: Application key (KeyID) used for security when connecting to ThingWorx. This is the authentication token. Refer to the API Key section for instructions
- Disable Encryption: By default SSL encryption on the PTC Thingworx server is assumed. If you are not using SSL, click Disable Encryption and make sure the port is using a corresponding unencrypted port. - i.e, Port 80 instead of port 443
  NOTE: It is advisable to initially configure without security to test and ensure the proper operation of the connector before manually changing the configuration to a more secure setup
The following screen will require the entry of your OSISoft specific server details. Once you have entered them, select Next

The parameters are:
- PI Server Name: The IP or Server name of the PI Server - i.e, 127.0.0.1 or localhost
- AF Server Name: The IP or Server name of the AF Server - i.e, 127.0.0.1 or localhost
Once all the necessary details have been provided you can now select Install followed by Finish once the process has finished.

Once the installation has been complete, you can make manual configuration changes to the Connector. For information, please refer to Making manual Configuration changes to the Connector.