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. Nähere Informationen zu RaptorXML-Funktionen finden Sie in der Dokumentation zu RaptorXML Server.
Informationen zur Kompatibilität
RaptorXML Server und FlowForce Server derselben Release-Version sind immer kompatibel miteinander. Bei Verwendung unterschiedlicher Versionen dieser Produkte kann es jedoch zu Kompatibilitätsproblemen kommen. Sie können die Kompatibilität durch Ausführung des Integrationsskripts überprüfen (wie weiter unten unter Integration beschrieben).
Generische Funktionen im Gegensatz zu Release-spezifischen RaptorXML-Funktionen
Wenn Sie RaptorXML-Funktionalitäten mit FlowForce Server integrieren, erhalten Sie zwei Gruppen von Funktionen: generische und Release-spezifische Funktionen.
Generische Funktionen
Die generischen Funktionen aus dem /RaptorXML-Container unterstützen einige Basisfunktionalitäten, die eventuell nicht alle Funktionalitäten der neuesten installierten RaptorXML Server-Version bereitstellen (so unterstützt eine generische Funktion eventuell nur einen Parameter, während dieselbe Funktion der neuesten Release mehrere Parameter hat). Diese Funktionalitäten ändern sich nie und verhalten sich bei jeder Version von RaptorXML Server gleich.
Release-spezifische Funktionen
Die Release-spezifischen Funktionen aus dem Container /RaptorXML/{Release} haben alle neuesten Funktionalitäten der aktuellen RaptorXML Release.
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. 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 Release-spezifischen Funktionen haben alle neuesten Funktionalitäten dieser Release.
•Die generischen RaptorXML-Funktionen werden auf eine Weise aktualisiert, dass sie auf die neu integrierte Version gemappt werden. D.h. die generischen Funktionen verwenden die neue RaptorXML-Version, um die generischen Funktionalitäten bereitzustellen, unterstützen aber alle Funktionen, die über den Umfang der generischen Funktionen hinausgehen, nicht.
Nähere Informationen zu Release-spezifischen und generischen RaptorXML-Funktionen finden Sie weiter oben 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.
Aufruf von RaptorXML-Funktionen
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.
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 generische Funktionen wie /RaptorXML/valjson oder Release-spezifische Funktionen wie /RaptorXML/2025/valjson auswählen. Die Unterschiede zwischen diesen sind weiter oben 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.
Upgraden Release-spezifischer RaptorXML-Funktionen auf eine neuere Version
Wenn Ihre Aufträge Release-spezifische Funktionen älterer Versionen (z.B. 2022) referenzieren und Sie eine neuere Version von RaptorXML Server (z.B. 2024) integriert haben, werden ältere Release-spezifische Funktionen in Ihren Aufträgen nicht automatisch aktualisiert. Um diese auf eine neuere Version von RaptorXML zu aktualisieren, können Sie eine der folgenden Methoden verwenden:
•Sie können die einzelnen Aufträge durchgehen und RaptorXML-Funktionen älterer Versionen manuell durch die neueren ersetzen.
•Kopieren Sie alternativ dazu die Raptor_<release>.tool-Datei aus dem Verzeichnis {INSTALLDIR}\etc von RaptorXML Server der neuesten installierten Release in das Verzeichnis {INSTANCEDIR}\tools von FlowForce Server. Anschließend müssen Sie die Datei umbenennen, damit diese der Version der Release entspricht, die Ihre Aufträge referenzieren. Wenn die alte Release-Version z.B. RaptorXML 2022 ist, so benennen Sie die Datei in RaptorXML_2022.tool um. Alle vorhandenen Aufträge sehen weiterhin so aus, als würden sie RaptorXML 2022-Funktionen aufrufen, während die neue .tool-Datei aber in Wirklichkeit auf die ausführbare RaptorXML Server 2024-Datei gemappt ist.
Wenn Ihre Aufträge generische RaptorXML-Funktionen referenzieren, müssen Sie keine Aktion setzen.
Informationen zu .tool-Dateien
FlowForce Server findet andere unter seiner Verwaltung ausgeführten Altova-Server-Produkte anhand von .tool-Dateien. Tool-Dateien bilden einen wichtigen Teil der RaptorXML-Integration, da FlowForce Server anhand dieser Dateien die entsprechende ausführbare RaptorXML Server-Datei ermittelt und unterschiedliche RaptorXML-Versionen findet. In diesen Dateien können auch Umgebungsvariablen definiert werden. Für jede RaptorXML Server Release-Version gibt es eine eigene .tool-Datei. Nähere Informationen zu .tool-Dateien finden Sie unter Tool-Dateien.