Microsoft Excel Writer

Dieser Adapter konvertiert ein XML-Dokument mit einer bestimmten Tabellenstruktur in eine Microsoft Excel -Datei (im .xls-Format Excel 97 – 2003 oder im XML-basierten OOXML-Format .xlsx) oder füllt eine bestehende Exceldatei (im .xls-Format Excel 97 – 2003 oder im XML-basierten OOXML -Format .xlsx) mit Daten aus einem XML-Dokument mit einer bestimmten Tabellenstruktur.

Eigenschaften (Properties)

Operation

Bestimmt, welche Operation der Funktions-Adapter durchführt

Mögliche Werte:

Create Spreadsheet: Excel-Dokument mit einem Tabellenblatt ausgeben, die den MIME-Typ Application/Vnd.ms-excel besitzt
Fill Template: Bestehende Excel-Vorlage, die in Parameter TemplateURL angegeben wird und beliebig viele Tabellenblätter besitzen kann, mit Daten füllen

Parameter

Adapter	Hauptklasse des Adapters (nicht verändern!) Mögliche Werte: de.softproject.integration.adapter.excel.ExcelWriter: Hauptklasse (Standard)
generateOOXML	Excel-Dateiformat (Microsoft Excel 97 – 2003 oder OOXML) bestimmen Mögliche Werte: `true`: XML-basiertes Excel-Dokument (Office Open XML; .xlsx) erzeugen `false`: Excel-Dokument im Format Microsoft Excel 97 – 2003 (.xls) erzeugen (Standard)
TemplateUrl	URL zur Excel-Vorlage (wenn die Eigenschaft Operation auf `Fill Template` gesetzt ist). Je nach dem in Parameter `generateOOXML` gewählten Dateiformat, muss die angegebene Vorlage in demselben Format vorliegen; z.B. muss eine `.xlsx`-Vorlage verwendet werden, wenn der Parameter `generateOOXML` gesetzt wurde. Der Wert des Parameters `TemplateUrl` kann durch das Attribut `templateUrl=".."` im Input-XML überschrieben werden (siehe unten). Mögliche Werte: URL mit file://-Protokollangabe (z.B. `file:///%USER_COLLECTION%/Project/Template.xls`) URL mit xstore://-Protokollangabe (z.B. `xstore://Project/Folder/Template.xlsx`)
recalc	Formeln vor dem Speichern des Dokuments neu berechnen und Feldwerte aktualisieren Mögliche Werte: `true`: Formeln neu berechnen `false`: Werte von Feldern mit Formeln unverändert lassen (Standard)

Statuswerte

`1`	Die Operation wurde erfolgreich ausgeführt.
`-1`	Die Operation ist aufgrund eines technischen Fehlers fehlgeschlagen.

Input

Je nach gewählter Operation erwartet der Adapter eine spezifische Input-Struktur:

Operation `Create Spreadsheet`:

Für diese Operation erwartet der Adapter folgende XML-Struktur, die dem Aufbau von (X)HTML-Tabellen entspricht. Hierbei erzeugt das Element <table> ein Tabellenblatt, jedes Element <tr> eine neue Tabellenzeile und jedes Element <td> eine neue Zelle oder <th> eine Kopfzelle. Wenn mehrere Tabellenblätter erzeugt werden sollen, müssen die <table>-Elemente von einem Wurzel-Element mit beliebigem Namen umschlossen werden.

Der Name der Tabelle, der über das Attribut name im Element <table> festgelegt wird, darf maximal 31 Zeichen lang sein.

Die Formatierung der einzelnen Zellen lässt sich über verschiedene Attribute steuern. Diese werden im Abschnitt Mögliche Attribute erläutert.

Beispiel-Input für die Operation Create Spreadsheet

XML

<?xml version="1.0" encoding="UTF-8"?>
<root>
 <table name="Name of the first spreadsheet">
   <tr autofit="true" height="10">
     <th fontHeight="12" forceString="true" autofit="true" bold="true">Header1</th>
     <th fontHeight="12" forceString="true" autofit="true" bold="true">Header2</th>
   </tr>
   <tr>
     <td>Value1</td>
     <td>Value11</td>
   </tr>
   <tr>
     <td>Value2</td>
     <td>Value22</td>
   </tr>
   <tr>
     <td>Value3</td>
     <td>Value33</td>
   </tr>
 </table>
</root>

Mit dem Attribut forceString="true" wird der Inhalt nicht als Zahl oder Datum interpretiert, sondern direkt in das Excel-Dokument reingeschrieben.

Beispiel: 008.07300 wird ohne das Attribut forceString="true" als Zahl 8.073 in das Excel-Dokument geschrieben, mit dem Attribut forceString="true" wird es als Zeichenkette 008.07300 in das Excel-Dokument geschrieben.

Operation `Fill Template`:

Für diese Operation erwartet der Adapter folgende XML-Struktur. In optionalen Attribut templateUrl=".." können Sie hierbei eine gültige URL zu einer Vorlagendatei angeben, z. B. templateUrl="file:///C:/Template.xlsx". Diese Angabe überschreibt den Wert des Adapter-Parameters TemplateURL. Jedes Element <cell> entspricht einer Zelle der Tabelle. Für Zeilen- und ggf. Spaltennummern beginnt die Zählung bei 0.

Die Formatierung der einzelnen Zellen lässt sich über verschiedene Attribute steuern. Diese werden im Abschnitt Mögliche Attribute erläutert.

Beispiel-Input für Operation FillTemplate

CODE

<TemplateFill templateUrl="URL to template file">
	<cell  sheet = "Name of the spreadsheet" 
			row = "Row number" 
			col = "Column ID " 
			value = "Cell content" 
			formatNumber = "Format number"
			wrapText="true"/>
</TemplateFill>

Mögliche Attribute

Die Formatierung der einzelnen Zellen lässt sich über folgende Attribute steuern:

Attribut Beschreibung

formatNumber

Zahlenformat

Mögliche Werte:

number1: Zahl 1
number2: Zahl 2
number3: Zahl 3
number4: Zahl 4
currency1: Währung 1
currency2: Währung 2
currency3: Währung 3
currency4: Währung 4
accounting: Buchhaltung
date: Datum
time: Uhrzeit
percentage: Prozent
fraction: Bruch
scientific: Wissenschaft
text: Text
postalCode: Postleitzahl
telephone: Telefonnummer

Bei Bedarf lassen sich auch benutzerdefinierte Zahlenformate hinterlegen

fontName Schriftart, z.B. Calibri

horizontalAlignment

Horizontale Ausrichtung des Textes innerhalb der Zelle

Mögliche Werte:

CENTER
CENTER_SELECTION
DISTRIBUTED
FILL
GENERAL
JUSTIFY
LEFT
RIGHT

verticalAlignment

Vertikale Ausrichtung des Textes innerhalb der Zelle

Mögliche Werte:

CENTER
BOTTOM
TOP
DISTRIBUTED
JUSTIFY

fontHeight Schriftgrad

fontColor

Schriftfarbe

Mögliche Werte:

CSS-Farbangaben, z.B. Red, Blue, Green etc.
RGB-Farbcode, z.B. 240, 80, 0
HEX-Farbcode, z.B. #124361

bold

Fette Schrift

Mögliche Werte:

true: fette Schrift
false: normale Schrift

italic

Kursive Schrift

Mögliche Werte:

true: kursive Schrift
false: normale Schrift

underline

Art des Unterstrichs

Mögliche Werte:

NONE
DOUBLE
DOUBLE_ACCOUNTING
SINGLE
SINGLE_ACCOUNTING

cellColor

Füllfarbe der Zelle

Mögliche Werte:

CSS-Farbangaben, z.B. Red, Blue, Green etc.
RGB-Farbcode, z.B. 240, 80, 0
HEX-Farbcode, z.B. #124361

border
borderLeft
borderRight
borderBottom

Art des Zellrahmens

Mögliche Werte:

DASH_DOT
DASH_DOT_DOT
DASHED
DOTTED
DOUBLE
HAIR
MEDIUM
MEDIUM_DASH_DOT
MEDIUM_DOT_DOT
MEDIUM_DASHED
SLANTED_DASH_DOT
THICK
THIN
NONE

borderColor
BorderColorLeft
borderColorRight
borderColorBottom
borderColorTop

Farbe des Zellrahmens

Mögliche Werte:

Farbname, z.B. Red, Blue, Green etc.
RGB-Farbcode, z.B. 240, 80, 0
HEX-Farbcode, z.B. #124361

orientation

Text-Ausrichtung

Mögliche Werte:

Zahl zwischen 90 und -90
HORIZONTAL
VERTICAL

wrapText

Optionales Attribut: Automatischen Zeilenumbruch in Zellen erlauben

Mögliche Werte:

true: Zeilenumbruch aktivieren
false: Zeilenumbruch deaktivieren

autofit

Optionales Attribut: Spaltenbreite automatisch anpassen

Mögliche Werte:

true: Automatische Spaltenbreite aktivieren
false: Automatische Spaltenbreite deaktivieren

Setzen des Attributs

Bitte beachten Sie:

Für die Operation Create Spreadsheet muss das Attribut innerhalb der ersten Zeile im Element <td> oder <th> gesetzt werden.

Für die Operation Fill Template muss zunächst ein neues Element columnProperties eingefügt werden, in dem die Konfiguration der einzelnen Spalten – jeweils in einem Knoten column – vorgenommen wird.

columnProperties

Gruppiert die Spalten eines Blattes.

Mögliche Werte: sheet: Name des Excel-Blattes für die die Konfiguration vorgenommen wird.

column

Spalte innerhalb eines Blattes

Mögliche Werte: id: Index der Spalte.
Der erste Index ist 0. Wird ein negativer Wert angegeben, wird eine Fehlermeldung ausgegeben.

XML

<columnProperties sheet="Week">
	<column id="1" autofit="true" width="256" />
    <column id="11" width="500" />
    <column id="9" width="255" />
    <column id="7" width="22" />
    <column id="22" autofit="true" />
</columnProperties>

width

Optionales Attribut: Feste Spaltenbreite definieren

Ist das Attribut autofit gesetzt, wird das Attribut width ignoriert.

Mögliche Werte: Zahl zwischen 0 und 255. Ist die angegebene Zahl größer 255, wird 255 als maximale Spaltenbreite gesetzt.

Setzen des Attributs

Bitte beachten Sie:

Für die Operation Create Spreadsheet muss das Attribut innerhalb der ersten Zeile im Element <td> oder <th> gesetzt werden.

Für die Operation Fill Template muss zunächst ein neues Element columnProperties eingefügt werden, in dem die Konfiguration der einzelnen Spalten – jeweils in einem Knoten column – vorgenommen wird.

columnProperties

Gruppiert die Spalten eines Blattes.

Mögliche Werte: sheet: Name des Excel-Blattes für die die Konfiguration vorgenommen wird.

column

Spalte innerhalb eines Blattes

Mögliche Werte: id: Index der Spalte.
Der erste Index ist 0. Wird ein negativer Wert angegeben, wird eine Fehlermeldung ausgegeben.

XML

<columnProperties sheet="Week">
	<column id="1" autofit="true" width="256" />
    <column id="11" width="500" />
    <column id="9" width="255" />
    <column id="7" width="22" />
    <column id="22" autofit="true" />
</columnProperties>

height

Optionales Attribut: Zeilenhöhe definieren

Excel wendet die automatische Anpassung der Höhe mit dem Attribut autofit nur an, wenn zuvor eine feste Zeilenhöhe über das Attribut height definiert wurde. Ist das Attribut autofit für die Zeile gesetzt, wird das Attribut heigth ignoriert. Zusätzlich wird die automatische Zeilenhöhe auch über das Attribut wrapText geregelt.

Mögliche Werte: Zahl zwischen 0 und 409. Ist die angegebene Zahl größer 409, wird 409 als maximale Zeilenhöhe gesetzt.

Setzen des Attributs

Bitte beachten Sie:

Für die Operation Create Spreadsheet muss das Attribut innerhalb des Element <tr> gesetzt werden.

Für die Operation Fill Template muss zunächst ein neues Element rowProperties eingefügt werden, in dem die Konfiguration der einzelnen Zeilen – jeweils in einem Knoten row – vorgenommen wird.

rowProperties

Gruppiert die Zeilen eines Blattes.

Mögliche Werte: sheet: Name des Excel-Blattes für die die Konfiguration vorgenommen wird.

row

Zeile innerhalb eines Blattes

Mögliche Werte: id: Index der Zeile.
Der erste Index ist 0. Wird ein negativer Wert angegeben, wird eine Fehlermeldung ausgegeben.

XML

<rowProperties sheet="Week">
   <row id ="7" height="50"/>
   <row id="6" height="409"/>
   <row id="8" autofit="true" height="250"/>
</rowProperties>

Eigenschaften (Properties)

Parameter

Statuswerte

Input

Operation Create Spreadsheet:

Operation Fill Template:

Mögliche Attribute

Operation `Create Spreadsheet`:

Operation `Fill Template`: