Data source parameters

friendlyName

Optional

string

The label to use for the data source.

inputDirectory

Required

string

Location of the source files to process. FTP servers are not supported.

Example: C:\\InputDirectory

Note: For the adapter to process data, the adapter service account must have read, write, and delete permissions for the input directory.

outputDirectory

Required

string

Location for the files to be moved to after being processed. FTP servers are not supported.

Example: C:\\OutputDirectory

Note: For the adapter to process data, the adapter service account must have read, write, and delete permissions for the output directory.

discoveryDirectory

Optional

string

Location for the files to be processed during discovery. FTP servers are not supported.

Example: C:\\DiscoveryDirectory

Default value: null

Note: For the adapter to process data, the adapter service account must have read, write, and delete permissions for the discovery directory.

fileNameFilter

Optional

string

Pattern used to match files in the InputDirectory for processing. If no filter is specified, the adapter will attempt to process all files in the InputDirectory. Use * as the wildcard character.

Example: *.csv

hasHeader

Optional

bool

Indicates if a header line is present in the file. Only applies to CSV files.

Default value: false

culture

Optional

string

Locale setting for the input files.

Note: The value associated with the culture parameter are only applied to the values read in from the .csv file and not the headers. For example, a culture of "en-US" parses floats like 1.234, while a culture of "fr-FR" parses floats like 1,234.

Example: en-US

Default value: local culture

timeZone

Optional

string

Time zone of timestamps in the input files. If specified, the value must be a valid entry from the IANA time zone database.

Example 1: America/Los_Angeles

Default value: Etc/UTC

Example 2: This example represents three dates and a value seperated by commas.

Date1,Date2,Date3,Value

03-08-2020T02:59-05:00,03-08-2020T02:59,03-08-2020T02:59Z,12345.6789

Date1 = 03-08-2020T02:59-05:00

this date has a "-05:00" adjustment meaning the date will be UTC-5.

Date2 = 03-08-2020T02:59

this date is displayed with no adjustment and will make use of the default timezone properly.

Date3 = 03-08-2020T02:59Z

this date is displayed with a "Z" so will be UTC.

Value = 12345.6789

format

Optional

string

Input file format.

Allowed values: Csv, Json, Xml

Default value: Csv

compression

Optional

string

Input file compression format.

Allowed value: None, Zip, Tar, GZip, TarGZip

Default value: None

encoding

Optional

string

Character encoding used in the input files.

Allowed value: UTF8, ASCII, Unicode

Default value: UTF8

fieldSeparator

Optional

string

Character used to delineate fields in the input files. Only applies to CSV files.

Default value: ,

lineSeparator

Optional

string

Character(s) used to separate lines in the input files. Only applies to CSV files.

Allowed values: \n, \r, \r\n

Default value: The default value depends on the platform you are using.

If you are using Linux, the parameter defaults to \n.

If you are using Windows, the parameter defaults to \r\n.

streamIdPrefix

Optional

string

The stream ID prefix applied to all data items collected from the data source.

Note: If you change the StreamIdPrefix of a configured adapter, for example when you delete and add a data source, you need to restart the adapter for the changes to take place. New streams are created on adapter restart and pre-existing streams are no longer updated.

Default value: null

defaultStreamIdPattern

Optional

string

Specifies the default stream ID pattern to use.

Possible parameters: {FriendlyName}, {ValueField}

Default pattern: {FriendlyName}.{ValueField}

Note: The {FriendlyName} parameter can contain any text, the {ValueField} parameter contains JSONPath/XPath symbols, which are replaced according to Text parser.

purgeDelay

Optional

string

Specifies a time after which processed files will be removed from the output directory to save disk space.

Note: If purgeDelay is set to null, files are never purged from the output directory.

Allowed value: A valid time span string (minimum of zero seconds: 0.00:00:00.0000000 or null.
Default value: 10 days (10.00:00:00.0000000)