Microsoft Excel Reader

The adapter reads a Microsoft Excel document (in Excel 97-2003 .xls format or in the XML-based OOXML format .xlsx) and outputs its content as an XML document.

Properties

Operation

Determines which operation the adapter executes.

Possible values:

Read Spreadsheet: Read Excel document

Parameter

Adapter

Main class of the adapter (do not change!)

Possible values:

en.softproject.integration.adapter.excel.ExcelReader: Main class (default)

Formatter

Formatter used (has an influence on the XML output, see below)

Possible values:

de.softproject.integration.adapter.excel.DefaultFormatter: Output each cell content of the Excel document in an element <Cell/> (default).
de.softproject.integration.adapter.excel.NumberedCellFormatter: Output each cell content of the Excel file in an XML element with cell number (e.g. <Cell_0/>).
de.softproject.integration.adapter.excel.LabeledCellFormatter: Output each cell content of the Excel file in an XML element with cell letters (e.g. <Cell_A/>)

MinimumInflateRatio

Optional. Specifies the minimum inflate ratio which is allowed when reading a file.

In Apache POI, a security check was introduced to intercept attacks by so-called ZIP bombs. In these attacks, a file multiplies its size when it is unpacked to memory. This can be problematic if the Java Virtual Machine's memory cannot handle the size of the decompressed file, which may lead to a server failure.

The introduced security check uses a minimum decompression ratio. This value measures the difference between the amount of memory used by a file in the file system and the amount of memory required when reading the file.

Possible values:

any integer between 0 and 100

Please note:

The default value is 1. With this value, the adapter fails if, for example, the file has a size of 1 KB in the file system, but a size of 100 KB in the memory.
A value of 0 deactivates the security check.
With a value of 100, the adapter does not read any of the provided documents, since a file is in no case smaller in memory than in the file system.
If the specified value is not in the allowed range (between 0 and 100) or if it is invalid, the default value is used.

Status values

`1`	The operation was executed successfully.
`-1`	The operation failed due to a technical error.

Output

The following XML structure is output with the standard formatter de.softproject.integration.adapter.excel.DefaultFormatter:

HTML/XML

<Workbook>
   <Sheet name="Name des Tabellenblatts">
      <Row rowId="Zeilennummer">
         <Cell colId="Spalten-ID" type="Datentyp" format="Formatierung"
               formula="Formel"><!--Zelleninhalt--></Cell>
      </Row>
   </Sheet>
</Workbook>

The following XML structure is output with the formatter de.softproject.integration.adapter.excelWriter.NumberedCellFormatter:

HTML/XML

<Workbook>
   <Sheet name="Name des Tabellenblatts">
      <Row rowId="Zeilennummer">
         <Cell_0 colId="Zellen-ID" type="Datentyp" format="Formatierung"
                 formula="Formel"><!--Zelleninhalt--></Cell_0>
      </Row>
   </Sheet>
</Workbook>

The following XML structure is output with the formatter de.softproject.integration.adapter.excel.LabeledCellFormatter:

XML

<Workbook>
   <Sheet name="Name des Tabellenblatts">
      <Row rowId="Zeilennummer">
         <Cell_A colId="Zellen-ID" type="Datentyp" format="Formatierung"
                 formula="Formel"><!--Zelleninhalt--></Cell_A>
      </Row>
   </Sheet>
</Workbook>