Set up the File Extractor

The Cognite File Extractor is distributed as a Windows executable file. Follow the steps below to set up the extractor.

Before you start

1. Check the server requirements for the extractor.

2. Make sure the extractor has the following access capabilities in a Cognite Data Fusion (CDF) project:

   • files:read and files:write
   • raw:read, raw:write, and raw:list for state store configured to use CDF RAW.
   Tip

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

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

4. Navigate to Data management > Integrate > Extractors to download the Windows executable file.

   Permission issues

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

5. Create a configuration file according to the configuration settings. The file must be in YAML format.

Run from a command line

1. Navigate to the installation directory/folder in a command line or terminal window.
2. Run the file-extractor-standalone<version*number>-<platform_name>.exe* file.

The extractor reads and configures the extractor according to the configuration settings.

In this example, the configuration file is named config.yml and saved in the same folder as the executable file:

For Windows:

.\file-extractor-standalone-<version>-win32.exe <config-file>

For Linux:

./file_extractor-standalone-<version>-linux <config-file>

Install the File extractor using its Windows installer

1. 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 Cognite Data Fusion (CDF) user interface.
2. Save the file in a folder.
3. Navigate to the folder where you saved the file.
4. Double-click the file, or type the below command in a command line window to install the extractor.

.\file-extractor\{VERSION\}.msi

## Run as a Windows standalone executable file

1. 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 Cognite Data Fusion (CDF) user interface.
1. Save the file in a folder.
1. 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:

```bash
.\file-extractor-standalone-\{VERSION\}-win32.exe ./config.yml

Run as a Windows service

1. 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 to the same directory as a configuration file named config.yml. This must be the exact name of the file.

3. 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:

   
    > .\file-extractor-winservice-\{VERSION\}-win32.exe install
   

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

5. Right-click the service and select Properties.

6. Configure the service per your needs/requirements.

Run as a standalone executable file on Linux systems

1. Download the file_extractor-standalone-{VERSION}-linux_ file via the download links available from the Cognite File extractor section on the Extract data page in the Cognite Data Fusion (CDF) user interface.
2. Save the file in a directory.
3. Open a terminal window, and run the file with its 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:

./file-extractor-standalone-\{VERSION\}-linux ./config.yml