0

How to Configure the CSV Collector (version 20)

Establish CSV Import Configuration Files

The CSV Collector relies on two files that should be created.  These files are 'SAF_ImportService.config' and 'SAF_Import.config'.  

SAF_ImportService.config Creation

The purpose of this config file is to designate the input directory for the service to monitor for new CSV files.

  • Must reside in the same directory as 'SAF_ImportService.exe' which by default is: C:\Program Files\Canary\Collectors\CSV\.
  • 'Interval' specifies how long to pause (allowing for file transfer completion into the directory) before importing. 
  • To register creation or the config file or future changes, the service must be restarted by opening the Canary Admin application, selecting the 'Services' panel, and restarting the 'CSV Collector' service.
  • Multiple 'InputDirectory' instances may be monitored.

You can create your own file by using the following format (UserDefinedInput should be substituted for actual parameter value):

<Settings>
    <Interval>UserDefinedInput</Interval>
    <InputDirectory>UserDefinedInput</InputDirectory>
    <InputDirectory>UserDefinedInput</InputDirectory>
</Settings>

SAF_Import.config Creation

This file is used to outline the format of the CSV file to be imported into the historian. 

  • This file must reside in the same directory in which the CSV files will be placed.  If multiple directories are to be monitored, each directory will require an individual config file.
  • The location should also be a public folder. If it is a user folder, the collector will not be able to process the file.
  • To register creation or the config file or future changes, the service must be restarted by opening the Canary Admin application, selecting the 'Services' panel, and restarting the 'CSV Collector' service.
  • There are over 30 different parameters to choose from. A list of these parameters and their descriptions are attached to this article.

Here is an example (UserDefinedInput should be substituted for actual parameter value):

<Settings>
    <InputDelimiter>UserDefinedInput</InputDelimiter>
    <Historian>UserDefinedInput</Historian>
    <DataSet>UserDefinedInput</DataSet>
    <TagNameOffset>UserDefinedInput</TagNameOffset>
    <TimeStampOffset>UserDefinedInput</TimeStampOffset>
    <ValueOffset>UserDefinedInput</ValueOffset>
    <KeepProcessedFiles>UserDefinedInput</KeepProcessedFiles>
    <ProcessedDirectory>UserDefinedInput</ProcessedDirectory>
    <AutoCreateDataSet>UserDefinedInput</AutoCreateDataSet>
</Settings>

KeepProcessedFiles and AutoCreateDataSet should be set to a Boolean value.

Reply Oldest first
  • Oldest first
  • Newest first
  • Active threads
  • Popular