Skip to main content
Version: 4.1 (2026 H2)

CsvDataProvider


Via the CsvData provider .csv files can be accessed.

Configuration​

In addition to the Mapping configuration and the optional SearchParameters (see Data interface), the CsvDataProvider can be configured via the Option element:

<CsvDataProvider DisplayName="Customer addresses">
<Options>
<FilePath>\\fileshare\addressdata.csv</FilePath>
<HasHeaders>true</HasHeaders>
<Delimiter>,</Delimiter>
</Options>
...
</CsvDataProvider>
  • FilePath string, path to csv file
  • HasHeader bool, indication whether first row is a header row
    If there are no headers, the columns will be numbered (0, 1, ...) (important for SearchParameters and Mapping).
    With a header row, an empty heading gets the 0-based column index (for example 1 for the second column) and a duplicate heading gets a counter, for example Name (2). SearchParameters and Mapping use these names. With a header row, values missing at the end of a row are empty and surplus values are ignored.
  • Delimiter string, indication of the delimiter

Search and file access​

  • Search: the Id of a SearchParameter is mapped to the column name (with a header row) or the 0-based column index (without a header row). The comparison is a substring (contains) match and is not case-sensitive. Empty search parameters are ignored. Multiple search parameters are combined with AND.
  • File access: the FilePath is resolved and opened server-side (on the server running the data interface). An absolute path or UNC path is expected. The file must be reachable by the server process. It is only read and may be open in Excel at the same time.

Example​

<CsvDataProvider DisplayName="Customer addresses">
<Options>
<FilePath>\\fileshare\addressdata.csv</FilePath>
<HasHeaders>true</HasHeaders>
<Delimiter>,</Delimiter>
</Options>
<SearchParameters>
<Text Id="Firma" Label="Firmenname" />
<Text Id="Ort" Label="Ort" />
</SearchParameters>
<Mapping>
<Map Source="Firma" Target="CompanyName" />
<Map Source="Strasse" Target="Street" />
<Map Source="PLZ" Target="PostalCode" />
<Map Source="Ort" Target="City" />
<Map Source="Land" Target="Country" />
</Mapping>
</CsvDataProvider>