Before you start
- Check the server requirements for the extractor.
- Assign access capabilities in a CDF project.
- Set up a Windows Update schedule. Note that the update may reboot the machine, causing extractor downtime.
- Navigate to Data management > Integrate > Extractors to download the Windows executable file.
Set Modify permission under Properties in the installation folder to avoid permission issues.
- Create a configuration file according to the configuration settings. The file must be in YAML format.
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
- Windows
- Linux
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.yml. 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.