LabOps
      Back to home
      1. Knowledge Base
      2. LabOps

      File Agent Set-up

      This article guides you through the set-up and configuration of Artificial File Agents.

      Installation

      For the installation of the file agent on the PC, you will need the .exe installer and a config.yaml file. Both of these will be provided by your Customer Success representative. 

      At a minimum, the config file must have:

      • token: This is an API token you obtain from the instance.

        • From Artificial, go to Settings ‣ (user name) ‣ API Keys ‣ + Add.

      • host: This is the instance URL. E.g. myinstance.artificial.com:443
      • labID: This is where you will configure and monitor the file agent. See how to get your lab ID here.

      Once the file agent is installed onto your PC, it will run as a Windows Service. To check the connection, go to the lab's Adapters page within LabOps. You should see the file agent there with the computer's hostname. If you are having problems, check your logs.

      You can do a silent install or launch the .exe installer. A silent install can be performed by running the installer with the /S command line flag, and the config file must also be passed using the /C flag.

      .\ArtificialFileAgentInstaller.exe /S /C “<file path to config.yaml>”

      File Agent Configuration

      You can configure the following for your File Agents from the Adapters page in LabOps:

      • Source folder: The folder the agent should watch for files. If you want to configure multiple source paths, you must use local configuration.
      • Destination: Where the files should be uploaded (Local network drive or s3 bucket)
        • If s3 is enabled, tags can be added.
      • Upload delay: If there is a known delay between when a file is created and when it is ready for upload, an upload delay can be set. If an event happens on the file again, it will continue to reset the delay until it is uploaded.

      These must be set in the UI. 

      If you modify your configuration remotely through the UI, those will override any local settings. 

      Local Configuration (optional)

      The below options are currently only available through the local config.yaml file. In the future, these configuration options will be available via the UI.

      • Source folders: One or more folders for the File Agent to watch for files. If you only want to watch a single folder, you can configure it remotely.
      • Exclusion and inclusion rules: you can set rules to exclude or include certain file types or subfolders. The file must be in gitignore format. Examples are below.
      • Instance ID: The name of the File Agent that will show up in LabOps. Defaults to fileagent-<hostname> if omitted.

      Example config.yaml file 

      host: test.artificial.com:443
      token: token
      labID: lab_123

      # This section is only required if you want to watch multiple folders
      sourcePaths:
          /path1
          /path2

      #This section is only required if you are setting exclusion/inclusion rules
      rules:
          filePath: path to gitignore-style rules file

      # InstanceID will default to fileagent-<hostname> if omitted
      instanceID: file-agent3

      If you change your config.yaml or rules, you need to restart the Windows Service.

      Example rules - ignore specific subdirectories 

      #ignore specific directories

      ignored_folder/
      folder/ignored_subdirectory

      Example rules - ignore specific file types 

      *.csv #ignore all CSV files

      Example rules - only allow specific file types

      #ignore everything by default
      *

      #allow only .csv files
      !*.csv

      Logs

      You can find the logs in the file path:

      C:\Windows\System32\config\systemprofile\AppData\Roaming\Artificial\File Agent

      You can see the service status when you run:

       sc.exe query artificial-file-agent 

      The SERVICE_EXIT_CODE will map to an error code in the application.