XML-Beschreibungsdatei - ABBYY Documentation

Die XML-Beschreibungsdatei enthält die Informationen zu einem benutzerdefinierten Bericht, die erforderlich sind, um ihn in der ABBYY FlexiCapture Administration and Monitoring Console zu aktivieren. Bei der Installation werden mehrere Beispielberichte automatisch aktiviert. Analysieren Sie deren Struktur und verwenden Sie sie als Ausgangspunkt für Ihre eigenen Berichte.

Elemente der XML-Beschreibungsdatei

Die Elemente <customreport> und <crystalreportfile/> sind immer erforderlich. Alle anderen Elemente gelten nur für DataSet-basierte Berichte.

Element	Erforderlich	Beschreibung
`<customreport></customreport>`	Ja	Das Hauptelement des Reports. Es muss die gesamte Beschreibung des Reports enthalten.
`<crystalreportfile/>`	Ja	Gibt den Namen der Berichtsdatei an.
`<storedprocedure/>`	Für gespeicherte Prozeduren	Erforderlich für Reports, die auf Daten basieren, die von einer gespeicherten Prozedur extrahiert wurden. Das einzige Attribut, `Name`, enthält den Namen der gespeicherten Prozedur.
`<sqlText></sqlText>`	Für SQL-Abfragen	Erforderlich für Reports, die auf SQL-Abfragen basieren. Geben Sie den Inhalt der Abfrage zwischen den öffnenden und schließenden Tags ein.
`<parameters></parameters>`	Nein	Enthält die Parameter der gespeicherten Prozedur oder SQL-Abfrage, jeweils in einem eigenen `<parameter>`-Element. Lassen Sie dieses Element weg, wenn das DataSet keine Parameter benötigt.
`<parameter></parameter>`	Nein	Beschreibt einen Parameter einer SQL-Abfrage oder gespeicherten Prozedur sowie die Art, wie die Administration and Monitoring Console zur Eingabe auffordert.
`<possiblevaluelist></possiblevaluelist>`	Nein	Enthält die möglichen Werte eines `<parameter>`-Elements, jeweils in einem eigenen `<possiblevaluelistitem />`-Element.
`<possiblevaluelistitem />`	Nein	Beschreibt einen möglichen Wert eines Parameters.

Wenn die Datei sowohl ein <storedprocedure/>- als auch ein <sqlText></sqlText>-Tag enthält, erstellt die gespeicherte Prozedur das DataSet.

Attribute von customreport

Attribut	Erforderlich	Beschreibung
`Name`	Ja	Der Name des Berichts, wie er in der Administration and Monitoring Console angezeigt wird.
`Type`	Ja	Der Typ des Berichts. Mögliche Werte: `CrystalReportQuery` für Berichte auf Grundlage von Crystal-Report-Abfragen, `DataSetReport` für DataSet-basierte Berichte.
`Description`	Nein	Die Beschreibung des Berichts, wie sie in der Administration and Monitoring Console angezeigt wird.

Attribute von crystalreportfile

Attribut	Erforderlich	Beschreibung
`Filename`	Ja	Der Name der Berichtsdatei mit der Erweiterung `.rdlc` oder `.rdl`. Speichern Sie die Berichtsdatei im selben Ordner wie die XML-Beschreibungsdatei.

Attribute des Parameters

Attribut	Erforderlich	Beschreibung
`Name`	Ja	Der Name des Parameters. Er wird an die SQL-Abfrage oder gespeicherte Prozedur übergeben.
`Type`	Ja	Der Typ des Parameters. Mögliche Werte: `Int`, `Date`, `String`.
`Prompt`	Nein	Der Hinweis, der angezeigt wird, wenn ein Benutzer für diesen Parameter einen Wert eingibt.
`Default`	Nein	Der Wert des Parameters, bevor der Benutzer einen anderen Wert eingibt. Ein `Date`-Parameter akzeptiert den Wert `now`, der dem aktuellen Datum entspricht.

Attribute von possiblevaluelistitem

Standardmäßig gibt der Benutzer Parameterwerte in ein Eingabefeld ein. Soll der Benutzer stattdessen aus einer Liste auswählen können, fügen Sie das Element <possiblevaluelist> hinzu.

Attribut	Erforderlich	Beschreibung
`value`	Ja	Ein möglicher Wert des Parameters. Der Typ muss mit dem Typ des Parameters übereinstimmen.
`displayvalue`	Nein	Der in der Liste angezeigte Eintrag. Ohne dieses Attribut zeigt die Liste das Attribut `value` an.

​Elemente der XML-Beschreibungsdatei

​Attribute von customreport

​Attribute von crystalreportfile

​Attribute des Parameters

​Attribute von possiblevaluelistitem

Elemente der XML-Beschreibungsdatei

Attribute von customreport

Attribute von crystalreportfile

Attribute des Parameters

Attribute von possiblevaluelistitem