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 StyleVisionServer2023. 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. |
StyleVisionServer on Windows stylevisionserver on Windows and Unix (Linux, Mac)
* Note that lowercase (stylevisionserver) works on all platforms (Windows, Linux, and Mac), while upper-lower (StyleVisionServer) works only on Windows and Mac. * Use forward slashes on Linux and Mac, backslashes on Windows.
|
On Windows systems: When spaces or special characters occur in strings (for example in file or folder names, or company, person or product names), use quotes: for example, "My File". Note, however, that a backslash followed by a double-quotation mark (for example, "C:\My directory\") might not be read correctly. This is because the backslash character is also used to indicate the start of an escape sequence, and the escape sequence \" stands for the double-quotation mark character. If you want to escape this sequence of characters, use a preceding backslash, like this: \\". To summarize: If you need to write a file path that contains spaces or an end backslash, write it like this: "C:\My Directory\\".
|
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.
|
--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.
|
Use the --h, --help option to display information about the command.
Options are listed in short form (if available) and long form. You can use one or two dashes for both short and long forms. An option may or may not take a value. If it takes a value, it is written like this: --option=value. Values can be specified without quotes except in two cases: (i) when the value string contains spaces, or (ii) when explicitly stated in the description of the option that quotes are required. If an option takes a Boolean value and no value is specified, then the option's default value is TRUE. Use the --h, --help option to display information about the command.
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.