generate
Syntax und Beschreibung
Der Befehl generate (Kurzform gen) generiert durch Transformieren der XML-Input-Datei mit Hilfe des/der in der PXF-Input-Datei enthaltenen XSLT-Dokuments/Dokumente eine oder mehrere Ausgabedateien (HTML, PDF, RTF und/oder DOCX).
stylevisionserver generate | gen --inputxml=Filename [additional options] InputPXF |
•Die Option --inputxml ist obligatorisch und gibt den Pfad der XML-Datei an.
•Das Argument InputPXF definiert den Pfad der PXF-Datei, die das/die zur Generierung des/der Ausgabedokuments/Ausgabedokumente verwendete(n) XSLT-Dokument(e) enthält. PXF-Dateien wird mit der Altova-Applikation StyleVision generiert.
•Jedes Ausgabeformat wird durch Definition einer Option für diese Ausgabe (siehe Liste der Optionen unten) generiert. Der Wert jeder Option ist ein Pfad, der definiert, wo die Ausgabe generiert werden soll.
Anmerkung: | StyleVision Server verwendet Apache FOP, den FO-Prozessor des Apache Project zur Generierung von PDF-Dateien anhand von FO. Apache FOP wird zusammen mit StyleVision Server unter dem folgenden Pfad installiert: Auf Windows-Systemen, ProgramData\Altova\SharedBetweenVersions; auf Linux- und macOS-Systemen in einem Ordner unterhalb des Ordners StyleVisionServer2025. Beachten Sie, dass für Apache FOP Java Runtime Environment 1.8 oder höher auf dem StyleVision Server-Rechner installiert sein muss. Installieren Sie für die 32-Bit-Version von StyleVision Server die Java-32-Bit-Version und für die 64-Bit-Version von StyleVision Server die Java-64-Bit-Version. Nähere Informationen zur Konfiguration von FOP finden Sie im Kapitel FOP-Anforderungen. |
Bei Ausführung mehrerer Transformationen ins PDF-Format empfiehlt sich vor allem bei großen Dokumenten die Verwendung von AltovaFOPServer, um die Transformation schneller durchführen zu können. Die höhere Geschwindigkeit ist darauf zurückzuführen, dass bei AltovaFOPServer die Java VM- und FOP jar-Dateien im Speicher geladen bleiben, wodurch diese Dateien nicht für jede Transformation erneut geladen werden müssen. AltovaFOPServer wird mit Ihrem StyleVision-Paket installiert. Um AltovaFOPServer für Transformationen verwenden zu können, müssen Sie ihn zuerst über die Befehlszeile starten.
Starten von AltovaFOPServer Die Befehlssyntax zum Starten von AltovaFOPServer lautet:
java -cp "{classPath}" {className} --pid "{pidFile} --port {portNumbers}
Ein Beispiel für einen CLI-Befehl zum Starten von AltovaFOPServer:
java -cp "C:\Programme\Altova\Common2024\jar\gson\gson.jar;C:\Programme\Altova\Common2024\jar\AltovaFOPServer.jar" com.altova.stylevision.fopserver.Main --pid "C:\Users\user\AppData\Local\Temp\AltovaFopServer.pid" --port 9090-9103,9999
Das Argument classPath muss die Pfade zu den Dateien gson.jar und AltovaFOPServer.jar enthalten. Geben Sie die korrekten Pfade dieser Dateien ein.
Aufrufen von AltovaFOPServer in StyleVision Server Nachdem der AltovaFOPServer gestartet wurde, können Sie ihn von StyleVision Server mit Hilfe des generate-Befehls entweder mit der Option altova-fopserver-pid-file oder altova-fopserver-port aufrufen (siehe Options unten).
|
StyleVisionServer unter Windows stylevisionserver unter Windows und Unix (Linux, Mac)
* Beachten Sie, dass klein geschriebene Befehle (stylevisionserver) auf allen Plattformen (Windows, Linux und Mac) funktionieren, während großgeschriebene Befehle (StyleVisionServer) nur unter Windows und Mac ausgeführt werden. *Verwenden Sie auf Linux und Mac-Systemen Schrägstriche und auf Windows-Systemen umgekehrte Schrägstriche. |
Auf Windows-Systemen: Verwenden Sie bei Vorhandensein von Leerzeichen oder Sonerzeichen in Strings (z.B. in Datei- oder Ordnernamen oder Firmen-, Personen- oder Produktnamen) Anführungszeichen: z.B., "Meine Datei". Beachten Sie jedoch, dass ein von einem doppelten Anführungszeichen gefolgter umgekehrter Schrägstrich (z.B: "C:\Mein Verzeichnis\") eventuell nicht korrekt gelesen wird, da der umgekehrte Schrägstrich auch den Beginn einer Escape-Sequenz markiert und die Escape-Sequenz \" für ein doppeltes Anführungszeichen steht. Wenn Sie diese Zeichensequenz mit einem Escape versehen wollen, verwenden Sie einen vorangestellten umgekehrten Schrägstrich, wie den folgenden: \\". Einfacher ausgedrückt: Wenn Sie einen Dateipfad, der Leerzeichen oder einen umgekehrten Schrägstrich am Ende enthält, schreiben müssen, so schreiben Sie diesen folgendermaßen: "C:\Mein Verzeichnis\\".
|
Beispiele
Beispiele für den Befehl generate:
stylevisionserver generate --inputxml=C:\MyFiles\ExpReport.xml --html=Test.html ExpReport.pxf
stylevisionserver generate --inputxml=C:\ExpReport.pxf|zip\ExpReport.xml --html=Test.html ExpReport.pxf
stylevisionserver generate --inputxml=altova://packagedfile/ExpReport.xml --html=Test.html ExpReport.pxf
stylevisionserver generate --inputxml=ExternalXML.xml --html=Test.html Test.pxf
•Die obigen Befehle enthalten die obligatorische Option --inputxml, das Argument InputPXF (Test.pxf) sowie mindestens eine Option zur Ausgabeerstellung (--html in allen Beispielen oben).
•Die verwendete XML-Input-Datei kann sich innerhalb der PXF-Datei (siehe erstes und drittes Beispiel oben) befinden oder eine externe XML-Datei sein (die sich außerhalb der PXF-Datei befindet; siehe erstes und viertes Beispiel oben).
•Der --inputxml Switch wird ignoriert, wenn die Hauptschemaquelle eine Datenbank oder DB-XML ist, muss aber aus syntaktischen Gründen vorhanden sein und Sie sollten z.B. --inputxml=database verwenden.
•Wenn die Option --html zur Erstellung des Output wie im Beispiel oben einen relativen Pfad erhält, so wird die Output-Datei unter einem Pfad relativ zum Ordner, in dem sich die PXF-Datei befindet, erstellt.
Optionen
--xml, --inputxml = PathToXMLFile Diese Option ist obligatorisch. Sie definiert den Pfad zu der zu verarbeitenden XML-Datei. Die XML-Datei kann sich innerhalb oder außerhalb der PXF-Datei befinden. Um als Ziel XML-Dateien innerhalb einer PXF-Datei zu definieren, verwenden Sie den Lokator |zip (siehe markierter Teil in den Beispielen oben). Die Option --inputxml wird ignoriert, wenn es sich bei der Hauptschemaquelle der Input-PXF-Datei um eine Datenbank oder eine DB-XML-Quelldatei handelt.
|
--dbw, --dbwhere = WHEREClause Eine SQL-WHERE-Klausel, die festlegt, welche Zeilen einer DB-XML-Quelldatei verarbeitet werden sollen.
|
--p, --param = $ParamName:ParamValue Weist einem in der PXF-Datei definierten Parameter einen Wert zu. Vor jedem Parameter muss die Option --param verwendet werden. Verwenden Sie Anführungszeichen, wenn ParamName oder ParamValue ein Leerzeichen enthält. Beispiel: --p=$company:"Nanonull Inc"
|
--prohibit-output-outside-target-folder = true|false Die Werte sind true|false. Bei Auswahl von true können Ausgabedokumente nur in dem Ordner erstellt werden, in dem die Hauptausgabedatei (HTML, PDF, RTF, DOCX, FO) erstellt wird. Dadurch werden andere Ordner, falls nötig, geschützt. Der Standardwert ist false.
|
--html, --outhtml = FilePath Pfad zur zu generierenden HTML-Datei
|
--pdf, --outpdf = FilePath Pfad zur zu generierenden PDF-Datei
|
--rtf, --outrtf = FilePath Pfad zur zu generierenden RTF-Datei
|
--docx, --outdocx = FilePath Pfad zur zu generierenden DOCX-Datei
|
--text, --outtext = FilePath Pfad zur zu generierenden Textdatei.
|
--fo, --outfo = FilePath Pfad zur zu generierenden FO-Datei
|
--generate-html-output-as-mime = true|false Die Werte sind true|false. Wenn die Option nicht definiert ist, ist der Standardwert false. Wenn die Option ohne Wert definiert ist, so ist er true. Bei true wird die HTML-Ausgabe als Mime-Stream generiert.
|
--altova-fopserver-pid-file = PathToFile Der Pfad zum PID-Datei, die für die Verbindung mit einem laufenden AltovaFOPServer verwendet werden soll. Sie können die Verbindung zu AltovaFOPServer entweder über die PID-Datei oder einen Port des Servers herstellen. Diese PID-Option ist eine Alternative zur Port-Option (siehe nächste Option). Nähere Informationen zur Verwendung von AltovaFOPServer finden Sie unter der allgemeinen Beschreibung des Befehls generate oben.
|
--altova-fopserver-port = Value Eine Port-Nummer oder eine Liste von Port-Nummern, die für die Verbindung zu einem laufenden AltovaFOPServer verwendet werden soll. Die Port-Nummern in einer Liste werden durch Kommas getrennt. Anstelle einer einzigen Nummer kann in der Liste ein Bereich verwendet werden. Daher können Sie als Wert dieser Option 9090-9100,9999 angeben. Beachten Sie, dass Sie die Verbindung zu AltovaFOPServer entweder über die PID-Datei des AltovaFOPServers oder einen Port herstellen können. Diese Port-Option ist eine Alternative zur PID-Option (siehe vorherige Option). Nähere Informationen zur Verwendung von AltovaFOPServer finden Sie unter der allgemeinen Beschreibung des Befehls generate oben.
|
--taxonomy-package = FilePath Pfad zu einem zusätzlichen Taxonomiepaket. Fügen Sie die Option mehrmals hinzu, um mehr als ein Taxonomiepaket zu definieren.
|
--taxonomy-packages-config-file = FilePath Pfad zur TaxonomyPackagesConfig.json-Datei, einer gemeinsam von den Altova-Produkten XMLSpy, MapForce und StyleVision verwendeten Datei, zum Konfigurieren der XBRL-Taxonomien, die allen diesen Produkten zur Verfügung gestellt werden.
|
--v, --verbose = true|false Die Werte sind true|false. Aktiviert bzw. deaktiviert Anzeige aller Meldungen. Der Standardwert ist false, wenn die Option nicht angegeben wird, true, wenn die Option ohne einen Wert angegeben wird.
|
--l, --lang = en|de|es|fr|ja Die zur Anzeige der Meldung verwendete Sprache.
|
Mit Hilfe der Option --h, --help können Sie Informationen über den Befehl anzeigen.
Optionen werden in ihrer kurzen Form (falls verfügbar) und in ihrer langen Form aufgelistet. Für die kurze und die lange Form können ein oder zwei Bindestriche verwendet werden. Eine Option kann, muss aber keinen Wert erhalten. Eine Option, die einen Wert erhält, wird folgendermaßen geschrieben: --option=wert. Werte können außer in zwei Fällen ohne Anführungszeichen definiert werden: (i) wenn der Wertestring Leerzeichen enthält oder (ii) wenn in der Beschreibung der Option explizit erwähnt ist, dass Anführungszeichen zwingend erforderlich sind. Wenn eine Option einen Booleschen Wert erhält und kein Wert definiert ist, so ist der Standardwert der Option TRUE. Mit Hilfe der Option --h, --help können Sie Informationen über den Befehl anzeigen.
Kataloge
Wenn Sie den Altova-Katalog-Mechanismus verwenden, finden Sie die entsprechenden Katalogdateien im Ordner etc des StyleVision Server-Applikationsordners. Ausführliche Informationen dazu finden Sie im Abschnitt "Kataloge" des Altova StyleVision-Handbuchs.
CustomCatalog.xml kann anhand der Vorlagendatei CustomCatalog_template.xml erstellt werden. Benennen Sie die Vorlagendatei in CustomCatalog.xml um, da dies die Datei ist, die im Katalogmechanismus verwendet wird (und nicht die Vorlagendatei).
Beachten Sie dazu Folgendes:
•Bei einer Neuinstallation derselben Hauptversion (selbe oder unterschiedliche Nebenversion) wird die Vorlagendatei durch eine neue Vorlagendatei ersetzt, wobei CustomCatalog.xml jedoch unverändert bleibt.
•Wenn Sie jedoch eine neue Hauptversion über eine vorherige Hauptversion installieren, wird der Ordner der vorherigen Hauptversion zusammen mit seiner CustomCatalog.xml-Datei gelöscht. Wenn Sie also CustomCatalog.xml weiterhin verwenden möchten, müssen Sie CustomCatalog.xml aus dem Ordner der vorherigen Hauptversion in einem anderen Ordner sichern. Nach Installation der neuen Hauptversion können Sie die zuvor gespeicherte Datei CustomCatalog.xml in den Ordner etc der neuen Hauptversion kopieren und dort je nach Bedarf bearbeiten.