Zum Hauptinhalt springen
Die XML-Beschreibungsdatei enthält Informationen zu einem benutzerdefinierten Bericht und wird verwendet, um den Bericht in der Administration and Monitoring Console von ABBYY FlexiCapture zu aktivieren. Mehrere Beispiele für Berichte werden während der Installation automatisch aktiviert. Sie können deren Struktur analysieren und sie als Vorlage für die Erstellung Ihrer eigenen Berichte verwenden. Die XML-Beschreibungsdatei enthält die folgenden Elemente:
  1. <customreport></customreport> Das Hauptelement des Berichts. Es muss die vollständige Beschreibung eines Berichts enthalten. Attribute:
    • Name der Name des Berichts. Er wird in der Administration and Monitoring Console angezeigt und ist ein erforderliches Attribut.
    • Type der Typ Ihres Berichts. Dies ist ein erforderliches Attribut. Es kann zwei Werte haben: CrystalReportQuery (für Berichte, die auf Crystal-Report-Abfragen basieren) oder DataSetReport (für Berichte auf DataSet-Basis).
    • Description die Beschreibung des Berichts, die in der Administration and Monitoring Console angezeigt wird. Dieses Attribut ist optional.
  2. <crystalreportfile/> Dies ist ein erforderliches Element. Es hat nur ein Attribut, Filename, das den Namen der Berichtsdatei (*.rdlc oder *.rdl) enthalten muss. Der Bericht mit diesem Namen muss im selben Katalog wie die XML-Beschreibungsdatei gespeichert werden. Hinweis: Andere Elemente sind nur für Berichte auf DataSet-Basis erforderlich.
  3. <storedprocedure/> Dieses Element ist für Berichte erforderlich, die auf Daten basieren, die durch eine gespeicherte Prozedur extrahiert wurden. Es hat nur ein Attribut, Name, das den Namen der gespeicherten Prozedur enthält.
  4. <sqlText></sqlText> Dieses Element ist für Berichte erforderlich, die auf SQL-Abfragen basieren. Der Inhalt der Abfrage muss zwischen den öffnenden und schließenden Tags angegeben werden. Hinweis: Wenn sowohl die Tags <storedprocedure/> als auch <sqlText></sqlText> in der XML-Beschreibungsdatei vorhanden sind, wird das DataSet durch die gespeicherte Prozedur erstellt.
  5. <parameters></parameters> Eine Reihe von Parametern der gespeicherten Prozedur oder SQL-Abfrage. Alle diese Elemente müssen zwischen den Tags <parameter> und </parameter> angegeben werden. Wenn keine Parameter zum Erstellen des DataSet erforderlich sind, darf dieses Element nicht in die XML-Beschreibungsdatei aufgenommen werden.
  6. <parameter></parameter> Beschreibt einen Parameter einer SQL-Abfrage oder gespeicherten Prozedur und gibt Details an, die für die Parametereingabe in der Administration and Monitoring Console relevant sind. Attribute:
    • Name Der Name des Parameters. Dies ist ein erforderliches Attribut. Er wird an die SQL-Abfrage oder gespeicherte Prozedur übergeben.
    • Type der Typ des Parameters. Dies ist ein erforderliches Attribut. Mögliche Werte: Int, Date, String.
    • Prompt der Hinweis, der angezeigt wird, wenn ein Benutzer diesen Parameter eingeben soll. Dieses Attribut ist optional.
    • Default der Standardwert des Parameters, bevor der Benutzer einen anderen Wert eingibt. Dies ist ein optionales Attribut. Parameter vom Typ Date können den Wert „now“ haben, der dem aktuellen Datum entspricht.
Standardmäßig gibt der Benutzer die Werte von Parametern in ein Eingabefeld ein. Wenn der Wert aus einer Liste ausgewählt werden muss, fügen Sie das Element <possiblevaluelist> hinzu.
  1. <possiblevaluelist></possiblevaluelist> Die Elemente <possiblevaluelistitem /> stellen alle möglichen Werte eines <parameter>-Elements dar.
  2. <possiblevaluelistitem /> Beschreibt einen der möglichen Werte eines Parameters. Attribute:
    • value Möglicher Wert eines Parameters. Dieses Attribut ist erforderlich. Sein Typ muss mit dem Typ des Parameters übereinstimmen.
    • displayvalue der Eintrag, der in der Liste angezeigt wird. Dieses Attribut ist optional. Wenn dieser Wert fehlt, wird das Attribut value angezeigt.