Set up the PI AF extractor

The Cognite PI AF extractor is distributed as a Windows installer (.msi file). When you run the .msi file, a setup wizard guides you through the installation process. The installer creates a Windows service and installs the binary files needed to run the extractor.

Before you start

Check the server requirements for the PI AF extractor.
Assing access capabilities in a CDF project.

You can use OpenID Connect and your existing identity provider (IdP) framework to manage access to CDF data securely. Read more.

Set up a Windows Update schedule. Note that the update may reboot the machine, causing extractor downtime.

Install and configure the extractor

Download and run the installer

Navigate to Data fusion > Integrate > Extractors and download and run the latest PI AF Extractor .msi file.

Create a working directory

Create a working directory.

Set Modify permission under Properties in the installation folder to avoid permission issues.

Create a configuration file

Create a config directory inside the working directory and create a configuration file according to the configuration settings. The file must be in YAML format.

Run as a Windows service

Start the service

Start PI AF Extractor service from Windows services.

Verify the service is running

Verify that the service is running.

Set startup type

Open Properties for the service and set Startup type to Automatic (Delayed Start).

Verify the extractor is running

Verify that the extractor is running. If you’ve configured the extractor to log messages to a file, check the log files in the configured path, for instance, logs/log.txt.If you haven’t configured the extractor to read updates, it terminates after one reading. Check any error messages in the log to verify a successful run.

Run from a command line

You can run the extractor from a command line with these arguments:

Argument	Description
`--host`	Insert the PI server’s host name or IP address.
`--username`	Insert the PI server’s Windows username.
`--password`	Insert the PI server’s Windows password.
`--elements-query`	Specify the query parameter for PI AF elements.
`-s`\|`--service`	Launch the extractor as a service. You must specify this parameter if you’ve configured a Windows service for the extractor. Running this from the command line only won’t work.
`-f` \|`--config-file`	Set the path to the configuration file.
`-l`\|`--log-level`	Set the console log-level: `[fatal/error/warning/information/debug/verbose]`
`-w`\|`--working-dir`	Set the working directory for the extractor. The default value is the current directory for a stand-alone file or one level above the executable file for the service version.
`--log-dir`	Set the path to the log files to log to files unless you’ve already set the Logger configuration parameters.
`-?`\|`-h+`\|—help	Enter to show this information.

Upgrade the extractor

Download and run the .msi file for the new version of the extractor. The installer detects the current installation directory, updates the software, and keeps the configuration as-is. The sample configuration file is a part of the software package and is overwritten during an extractor upgrade.

Download the installer

Download the PI AF extractor .msi file from CDF.

Note current settings

Take note of the installed version in case of a rollback and of the service properties in the Properties dialog.

During the upgrade, the installer resets all custom service properties to their default values, such as the service recovery settings.

Run the installer

Run the installer.

Restore custom properties

Update the custom service properties you noted in step 2.

Verify the upgrade

Verify that the extractor is running and that the version displayed in the Starting PI Extractor logline matches the upgraded version.

Uninstall the extractor

Open the uninstaller

Run the installer, select Remove the extractor or open Add or remove programs from the Windows Control Panel.

Remove the extractor

Remove the Cognite PI AF extractor.

Optional. Clean up files

Optionally, remove the installation directory with the configuration file and logs.

Optional. Delete the installer

Optionally, delete the .msi file.

​Before you start

​Install and configure the extractor

​Run as a Windows service

​Run from a command line

​Upgrade the extractor

​Uninstall the extractor

Before you start

Install and configure the extractor

Run as a Windows service

Run from a command line

Upgrade the extractor

Uninstall the extractor