Skip to main content
Version: 4.1 (2026 H2)

ExcelDataProvider


Via the ExcelData provider Excel files can be accessed.

Configuration​

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

<ExcelDataProvider DisplayName="Customer addresses">
<Options>
<FilePath>\\fileshare\addressdata.xlsx</FilePath>
<HasHeaders>true</HasHeaders>
<SheetName>Data</SheetName>
</Options>
...
</ExcelDataProvider>
  • FilePath string, path to xlsx file
  • HasHeader bool, indication whether first row is a header row
    If there are no headers, the columns will be counted up as in Excel (A, B, ...) (important for SearchParameters and Mapping).
  • SheetName string, name of the worksheet. If no value is given or the worksheet is not found, the first worksheet is used.

Search and file access​

  • Search: the Id of a SearchParameter is mapped to the column name (with a header row) or the column letter (A, B, … 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.

Example​

<ExcelDataProvider DisplayName="Customer addresses">
<Options>
<FilePath>\\fileshare\addressdata.xslx</FilePath>
<HasHeaders>true</HasHeaders>
<SheetName>Data</SheetName>
</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>
</ExcelDataProvider>