Integration mit RaptorXML Server
Wenn Sie RaptorXML Server und FlowForce Server integrieren, stehen die Funktionen von RaptorXML Server in Form von vordefinierten FlowForce Server-Funktionen zur Verfügung. D.h. Sie können Aufträge erstellen, mit denen XML- und JSON-Dokumente, XBRL-Taxonomien und -Instanzdateien validiert werden bzw. deren Wohlgeformtheit geprüft wird. Sie können auch XSLT-Transformationen durchführen und XQuery-Dokumente ausführen.
Integration
Nachdem Sie RaptorXML Server zusammen mit FlowForce Server (auf Windows verfügbar) oder als eigenstsändiges Produkt (auf jeder beliebigen Plattform verfügbar) installiert haben, müssen Sie außerdem die RaptorXML-Funktionalitäten in FlowForce Server integrieren. Die möglichen Integrationsoptionen sind unten aufgelistet:
•über die FlowForce Server Setup-Seite
•über verschiedene CLI-Befehle
•über das Integrations-Skript
Nähere Informationen dazu finden Sie in den Unterabschnitten weiter unten.
Integration über die Setup-Seite
Dies ist die schnellste und einfachste Methode, um die RaptorXML-Funktionen in FlowForce Server zu integrieren. Gehen Sie folgendermaßen vor:
1.Öffnen Sie die Setup-Seite. Die nötigen Schritte variieren je nach Plattform:
2.Klicken Sie auf der Setup-Seite für die jeweilige Server-Instanz auf die Schaltfläche Tools integrieren.
3.Klicken Sie im Dialogfeld, das daraufhin angezeigt wird, auf Integrieren. Im Log werden die Integrationsinformationen angezeigt (siehe Abbildung unten).
Es wird empfohlen, RaptorXML Server vor der Installation des FlowForce Server- und FlowForce Web Server-Diensts zu integrieren. Sie können RaptorXML auch zu einem späteren Zeitpunkt integrieren. Beachten Sie jedoch, dass die Dienste beendet werden müssen, bevor Sie auf die Schaltfläche Tools integrieren klicken.
Integration über die Befehlszeile (CLI)
Sie können die --integratetools-Option mit dem jeweiligen CLI-Befehl verwenden, um RaptorXML-Funktionen in eine neue (mit createdb, initdb oder migratedb) oder eine vorhandene FlowForce-Instanz (mit initdb oder upgradedb) zu integrieren.
Integration über das Skript
Eine weitere Methode zur Integration von RaptorXML ist die Ausführung des Skripts aus dem folgenden Ordner:
{RaptorXML-Installationsverzeichnis}\etc\functions\integrate.bat
| Anmerkung: | Auf Unix-Systemen lautet der Name des Skripts integrate.cs. Für die Ausführung dieses Skripts benötigen Sie Superupser-Rechte (sudo). |
Das Skript erhält zwei Argumente: den Pfad zum FlowForce Server-Installationsverzeichnis und den Pfad zum FlowForce Server-Instanzdatenverzeichnis (siehe Wichtige Pfade). Bei Ausführung des Skripts geschieht Folgendes:
•Alle Release-spezifischen Funktionen der integrierten RaptorXML Server-Version stehen daraufhin in FlowForce Server zur Verfügung.
•Die generischen (nicht Release-spezifischen) RaptorXML-Funktionen werden auf die Release-spezifischen Funktionen der integrierten RaptorXML-Version aktualisiert.
Nähere Informationen zu Release-spezifischen und allgemeinen RaptorXML-Funktionen finden Sie weiter unten unter Generische Funktionen im Gegensatz zu Release-spezifischen RaptorXML-Funktionen.
Wenn bei Ausführung des Skripts Fehler auftreten, sind die Funktionsdefinitionen der integrierten RaptorXML-Version nicht mit FlowForce Server kompatibel. Wenden Sie sich in diesen seltenen Fällen an den Altova-Support.
Nach der Integration
Nachdem RaptorXML Server in FlowForce Server integriert wurde, stehen alle RaptorXML Server-Funktion im Container /RaptorXML von FlowForce (Abbildung unten) zur Verfügung. Im Fall von RaptorXML+XBRL Server lautet der Name des Containers /RaptorXMLXBRL.
Aufruf von RaptorXML-Funktionen
Sie können die Funktionen von RaptorXML auf eine der folgenden Arten aufrufen:
•Navigieren Sie zum Container /RaptorXML (bzw. /RaptorXMLXBRL), öffnen Sie die gewünschte Funktion und klicken Sie anschließend auf Auftrag erstellen. Sie können Release-unabhängige Funktionen wie /RaptorXML/valjson oder Release-spezifische Funktionen wie /RaptorXML/2024/valjson auswählen. Die Unterschiede zwischen diesen sind weiter unten beschrieben.
•Erstellen Sie in einem Auftrag einen neuen Ausführungsschritt und rufen Sie die gewünschte RaptorXML-Funktion von diesem Schritt aus auf. Im Beispiel unten wird im Schritt die Funktion valjson aufgerufen:
Beispiele für Aufträge, in denen RaptorXML Server aufgerufen wird, finden Sie in den folgenden Kapiteln:
•Validieren eines Dokuments mit Hilfe von RaptorXML
•Validieren von XML mit Fehlerprotokollierung
•Übergeben von Schlüssel/Wert-Parameterpaaren mit Hilfe von RaptorXML
Nähere Informationen zu den verfügbaren RaptorXML-Funktionen finden Sie in der Dokumentation zu RaptorXML Server (https://www.altova.com/de/documentation).
Generische Funktionen im Gegensatz zu Release-spezifischen RaptorXML-Funktionen
Die Funktionen im Container RaptorXML- bzw. RaptorXMLXBRL sind folgendermaßen strukturiert:
•Funktionen aus dem /RaptorXML-Container sind bis zur FlowForce Server-Version 2014 (der ersten Version, die RaptorXML-Funktionen unterstützt hat) rückwärts kompatibel. Diese generischen Funktionen sind Wrapper für die Release-spezifischen Funktionen aus dem /RaptorXML/{Release}-Container. Sie sind garantiert mit allen Release-Versionen kompatibel, stellen aber nicht alle Funktionalitäten der neuesten installierten RaptorXML Server-Version bereit.
•Funktionen aus den /RaptorXML/{Release}-Containern stellen alle Funktionalitäten der entsprechenden RaptorXML-Release bereit. Diese Funktionen sind mit FlowForce Server derselben Release-Version kompatibel. Es ist jedoch nicht unbedingt jede Version von RaptorXML Server mit jeder Version von FlowForce Server kompatibel. Sie können die Kompatibilität durch Ausführung des Integrationsskripts überprüfen (wie weiter oben unter Integration beschrieben).
Wenn eine generische RaptorXML-Funktion aufgerufen wird, fungiert diese Funktion als Wrapper für die entsprechende Release-spezifische Funktion von RaptorXML Server. Die ausgewählte RaptorXML Release-Version ist diejenige, die zuletzt in FlowForce integriert wurde, wobei es sich auch um eine manuell integrierte Release-Version handeln kann. In solchen Aufrufen stehen die neuesten RaptorXML-Funktionalitäten (wie z.B. neue Argumente oder sogar Funktionen) jedoch nicht zur Verfügung. Um die neuesten RaptorXML-Funktionalitäten von FlowForce-Aufträgen aus verwenden zu können, rufen Sie eine Release-spezifische Funktion direkt auf.
Von der Release-spezifischen Funktion ist abhängig, mit welcher RaptorXML .tool-Datei die ausführbare RaptorXML-Datei gesucht werden soll. Für jede RaptorXML Server Release-Version gibt es eine eigene .tool-Datei. Eine .tool-Datei informiert FlowForce Server über den Pfad zur ausführbaren RaptorXML Server-Datei. Über sie werden auch Umgebungsvariablen definiert, siehe Umgebungsvariablen.
Wenn Ihre FlowForce-Aufträge versionsspezifische RaptorXML-Funktionen referenzieren und Sie ein Upgrade auf eine neuere Version von FlowForce Server und RaptorXML Server durchführen möchten, können Sie entweder alle Aufträge ändern, damit diese die neuesten Release-spezifischen RaptorXML-Funktionen referenzieren, oder Sie können die Raptor.tool-Datei auf eine neuere Version der ausführbaren RaptorXML Server-Datei mappen. Gehen Sie dazu folgendermaßen vor:
1.Kopieren Sie die Raptor_<release>.tool-Datei aus dem Verzeichnis {installation}\etc von RaptorXML Server der neuesten installierten Release in das Verzeichnis {configuration data}\tools von FlowForce Server derselben Release.
2.Benennen Sie die Datei um, damit sie der Version der alten Release (der Raptor Release-Version, auf die ihre Aufträge verweisen) entspricht. Wenn die alte Release-Version z.B. RaptorXML 2017r3 ist, so benennen Sie die Datei in Raptor_2017r3.tool um.
Wenn Sie die Mapping-Methode wählen, hat es den Anschein, als würden alle vorhandenen Aufträge weiterhin RaptorXML 2017r3-Funktionen aufrufen, während die .tool-Datei aber in Wirklichkeit auf die neueste ausführbare RaptorXML Server-Datei gemappt ist.