Skip to main content

Before you start

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.
  • To create and monitor the extractor as an integration (public preview), see Set up an on-premises integration. You can also navigate to Data fusion > Integrate > Extractors to download the Windows executable file.
Set Modify permission under Properties in the installation folder to avoid permission issues.

Trusting internal and self-signed certificates

The extractor uses HTTPS to connect to file sources, such as SharePoint Online, Azure Blob Storage, or Documentum, and to the Cognite Data Fusion (CDF) API.
REQUESTS_CA_BUNDLE replaces the default trust store. It does not extend it. Point it at a combined bundle that includes the public CAs and your internal CA. The corporate CA file alone is not enough when any destination still presents a public certificate chain.
If your file source uses an internal or self-signed certificate, or if a corporate proxy inspects outbound traffic with certificates signed by an internal certificate authority (CA), add the certificate to the extractor’s certificate bundle so connections between the source system, the extractor host, and CDF remain trusted. If REQUESTS_CA_BUNDLE points only at the corporate CA, endpoints that still present a public certificate chain are not trusted. SharePoint Online and Microsoft Graph requests do not log a certificate error. The extractor keeps retrying those requests.

Create a combined certificate bundle

1

Locate the public CA bundle

Locate the public CA bundle in the certifi library:
2

Copy the bundle to a persistent directory

Copy the file from the printed path to a persistent directory that the extractor’s service account can read, and name it cacert.pem:
  • Windows: C:\Cognite\certificates\cacert.pem
  • Linux: /opt/cognite/certificates/cacert.pem
3

Add your certificate

  1. Obtain the certificate of the file source or proxy in PEM format.
  2. Open the certificate in a text editor.
  3. Open the cacert.pem file you saved.
  4. Prepend the certificate contents to the top of the file.
  5. Save the updated file.
The updated cacert.pem file contains the public CAs and your internal or self-signed certificate.

Configure the extractor

1

Set REQUESTS_CA_BUNDLE

Set the environment variable REQUESTS_CA_BUNDLE to the path of the updated cacert.pem file. Set it at the machine level or in the service unit so the extractor service picks it up.
In an elevated PowerShell session, set a machine-level variable:
Make sure the service account can read the .pem file.
For a one-off run, you can instead set the variable in the current shell, for example $env:REQUESTS_CA_BUNDLE="C:\Cognite\certificates\cacert.pem" in PowerShell or export REQUESTS_CA_BUNDLE=/opt/cognite/certificates/cacert.pem in Bash, and run the extractor from that same shell.
2

Restart the extractor

Restart the extractor or its service so it reads the new variable.
A packaged extractor executable doesn’t pick up the trust store that a Python script uses in an interactive console. Set REQUESTS_CA_BUNDLE for the executable or service even when the same script works without it.

Sources that use other settings

REQUESTS_CA_BUNDLE covers the CDF connection and most file sources, including SharePoint Online, Azure Blob Storage, Azure Data Lake Storage, Google Cloud Storage, and AWS S3. Two sources read their certificate settings elsewhere:
If you extract from Documentum, set both REQUESTS_CA_BUNDLE and SSL_CERT_FILE to the same bundle so that source and CDF connections are both trusted.
For mutual TLS (mTLS) and forward proxy settings, see Configure SSL certificates and proxy settings for extractors.

Run as a Windows standalone executable file

1

Download the executable

Download the file_extractor-{VERSION}-win32.exe file via the download links available from the Cognite File extractor section on the Extract data page in the CDF user interface.
2

Save the file

Save the file in a folder.
3

Run the file

Open a command line window and run the file with a configuration file as an argument.In this example, the configuration file is named config.yml and saved in the same folder as the executable file:

Install and run the extractor

Install using Windows installer

1

Download the installer

Download the file-extractor-{VERSION}-win32.msi file via the download links available from the Cognite File extractor section on the Extract data page in the CDF user interface.
2

Save the file

Save the file in a folder.
3

Navigate to the folder

Navigate to the folder where you saved the file.
4

Install the extractor

Double-click the file, or type the below command in a command line window to install the extractor.

Run as standalone executable

1

Download the executable

Download the file_extractor-{VERSION}-win32.exe file via the download links available from the Cognite File extractor section on the Extract data page in the CDF user interface.
2

Save the file

Save the file in a folder.
3

Run the file

Open a command line window and run the file with a configuration file as an argument.In this example, the configuration file is named config.yml and saved in the same folder as the executable file:

Run as Windows service

1

Download the service executable

Download the file-extractor-service-{VERSION}-win32.exe file via the download links available from the Cognite File extractor section on the Extract data page in the CDF user interface.
2

Save the file

Save the file to the same directory as a configuration file named config.yaml. This must be the exact name of the file.
3

Install the service

As an administrator, open up the command line window in the folder you placed the executable file and the configuration file and run the following command:
4

Open the Services app

Open the Services app in Windows and find the Cognite File Extractor Executor service.
5

Configure the service

Right-click the service and select Properties.
6

Adjust settings

Configure the service per your needs/requirements.
Last modified on October 30, 2026