Set up a PROSPER connector

Beta

The features described in this section are currently in beta testing and are subject to change.

The Cognite PROSPER connector is distributed as a Windows service. Follow the steps below to set up the connector.

Before you start

1. Check the server requirements for the connector.

2. Make sure the connector has these capabilities in a Cognite Data Fusion (CDF) project.

3. Create a configuration file according to the configuration settings in the working directory of the folder where the connector is installed. The file must be in YAML format.

Connect to PROSPER simulator

The connector uses COM to connect to the PETEX OpenServer protocol, which establishes the connection with the PROSPER simulator.

1. The connector connects to PETEX OpenServer via COM. In case of connection errors, it can retry. The retry parameters can be defined in the configuration file:

    automation:
        num-retries: 5
        retry-delay: 30

Run as a Windows service

1. Download the prosper-setup-{VERSION}.exe file via the download links available from Data management > Integrate > Extractors in CDF.

2. Run the installer on a Windows operating system. A wizard guides you through the installation process.

3. Select the destination folder where the connector will be installed. By default, this is C:\Cognite\. Inside this folder, the ProsperConnector working directory is created. The connector expects a config.yml file as the configuration in the same directory.

   dica

   You'll find templates for the configuration file in the config folder.

4. Open the Services app in Windows and find the Cognite PROSPER Connector service.

5. Right-click the service and select Start.

Uninstall and update the connector

Run the same MSI installer to uninstall the connector. The installer deletes installed binaries, removes the service, and cleans the application registry. The installation is not deleted and still contains the configuration file, logs, and application data generated by the connector. If the connector is re-installed, it resumes the operation using the saved state.

When a new version of the PROSPER connector is available, run the MSI installer for the new version to upgrade the connector to the new version. After the upgrade, you must manually restart the service.