valtaxonomypackage (taxpkg)

www.altova.com Alle erweitern/reduzieren Dieses Kapitel drucken Vorherige Seite Eine Ebene nach oben Nächste Seite

Startseite >  Befehlszeilenschnittstelle (CLI) > XBRL-Validierungsbefehle >

valtaxonomypackage (taxpkg)

Der Befehl valtaxonomypackage | taxpkg validiert ein oder mehrere XBRL-Taxonomiepakete anhand der Taxonomy 1.0 Packages-Spezifikation.

 

Windows

RaptorXMLXBRL valtaxonomypackage | taxpkg [options] TaxonomyPackage

Linux

raptorxmlxbrl valtaxonomypackage | taxpkg [options] TaxonomyPackage

Mac

raptorxmlxbrl valtaxonomypackage | taxpkg [options] TaxonomyPackage

 

 

Mit dem Argument TaxonomyPackage wird das zu validierende XBRL-Taxonomiepaket angegeben. Normalerweise handelt es sich beim Taxonomiepaket um eine ZIP-Datei. Um mehrere Taxonomiepakete zu validieren: (i) listen Sie die zu validierenden Pakete in der Befehlszeile auf, wobei jedes Paket vom nächsten durch ein Leerzeichen getrennt wird, oder (ii) listen Sie die zu validierenden Pakete in einer Textdatei (.txt-Datei) (ein Dateiname pro Zeile) auf und stellen Sie diese Textdatei zusammen mit der auf true gesetzten Option --listfile (siehe Optionsliste unten) als Textdatei zur Verfügung.

 

Beispiele

 

raptorxmlxbrl valxtaxonomypackage c:\Test.zip
raptorxmlxbrl taxpkg --listfile=true c:\TaxonomyPackageList.txt
raptorxmlxbrl taxpkg --listfile c:\TaxonomyPackageList.txt

 

Click to expand/collapseGroß- und Kleinschreibung und Schrägstriche in der Befehlszeile

RaptorXMLXBRL unter Windows

raptorxmlxbrl unter Unix (Linux, Mac)

 

* Beachten Sie, dass klein geschriebene Befehle (raptorxmlxbrl) auf allen Plattformen (Windows, Linux und Mac) funktionieren, während großgeschriebene Befehle (RaptorXMLXBRL) nur unter Windows und Mac ausgeführt werden.

*Verwenden Sie auf Linux und Mac-Systemen Schrägstriche und auf Windows-Systemen umgekehrte Schrägstriche.

 

Optionen

Die Optionen des Befehls sind unterhalb nach Gruppen geordnet aufgelistet. Die Werte aller Optionen können ohne Anführungszeichen angegeben werden. Eine Ausnahme bilden die beiden folgenden Fälle: (i) wenn der Wertstring Leerzeichen enthält oder (ii) wenn in der Beschreibung der Option ausdrücklich angegeben ist, dass Anführungszeichen benötigt werden.

 

Click to expand/collapseVerarbeitung

--listfile = true|false

Bei true wird das Argument InputFile des Befehls als Textdatei behandelt, die einen Dateinamen pro Zeile enthält. Der Standardwert ist false. (Als Alternative können die Dateien im CLI getrennt durch ein Leerzeichen aufgelistet werden. Beachten Sie allerdings, dass CLIs eine maximale Zeichenanzahl haben.) Beachten Sie, dass die Option --listfile nur auf Argumente, nicht aber auf Optionen angewendet wird.

Hinweis:   Die Booleschen Optionswerte werden auf true gesetzt, wenn die Option ohne einen Wert definiert wird.

 

--recurse = true|false

Dient zur Auswahl von Dateien innerhalb von Unterverzeichnissen einschließlich ZIP-Archiven. Bei true wählt das Argument InputFile des Befehls die angegebene Datei auch in den Unterverzeichnissen aus. Beispiel: test.zip|zip\test.xml wählt Dateien mit dem Namen test.xml auf allen Ordnerebenen des ZIP-Ordners aus. Es können die Platzhalter * und ? verwendet werden. Mit *.xml werden folglich alle .xml Dateien im (ZIP-)Ordner ausgewählt. Der Standardwert der Option ist false.

Hinweis:   Die Booleschen Optionswerte werden auf true gesetzt, wenn die Option ohne einen Wert definiert wird.

 

--schema-imports = load-by-schemalocation | load-preferring-schemalocation | load-by-namespace | load-combining-both | license-namespace-only

Definiert das Verhalten von xs:import Elementen, von denen jedes ein optionales namespace Attribut und ein optionales schemaLocation Attribut hat: <import namespace="someNS" schemaLocation="someURL">. Mit der Option wird definiert, ob ein Schema-Dokument geladen oder nur ein Namespace lizenziert werden soll und, wenn ein Schema-Dokument geladen werden soll, anhand welcher Informationen es gesucht werden soll. Standardeinstellung: load-preferring-schemalocation. Das Verhalten ist das folgende:

 

load-by-schemalocation: Anhand des Werts des schemaLocation Attributs wird der Schemapfad ermittelt, wobei Katalog-Mappings berücksichtigt werden. Wenn das Namespace-Attribut vorhanden ist, wird der Namespace importiert (lizenziert).
load-preferring-schemalocation: Wenn das schemaLocation Attribut vorhanden ist, wird es verwendet, wobei Katalog-Mappings berücksichtigt werden. Falls kein schemaLocation Attribut vorhanden ist, wird der Wert des namespace Attributs über ein Katalog-Mapping verwendet. Dies ist der Standardwert.
load-by-namespace: Anhand des Werts des namespace Attributs wird der Schemapfad über ein Katalog-Mapping ermittelt.
load-combining-both: Wenn entweder das Attribut namespace oder das Attribut schemaLocation ein Katalog-Mapping hat, so wird das Mapping verwendet. Wenn beide Attribute Katalog-Mappings haben, ist es vom Wert der Option --schema-mapping (XBRL-Option und XML/XSD-Option)  abhängig, welches Mapping verwendet wird. Falls kein Katalog-Mapping vorhanden ist, wird das schemaLocation Attribut verwendet.
license-namespace-only: Der Namespace wird importiert. Kein Schema-Dokument wird importiert.

 

--schema-mapping = prefer-schemalocation | prefer-namespace

Wenn ein Schema-Dokument sowohl anhand des Schema-Pfads als auch des Namespace gesucht werden soll, wird damit festgelegt, welche der beiden Optionen beim Katalog-Lookup Vorrang erhält. (Wenn eine der Optionen --schemalocation-hints oder --schema-imports einen Wert load-combining-both hat und wenn die betroffenen Namespace- und URL-Teile beide Katalog-Mappings haben, gibt der Wert dieser Option an, welches der beiden Mappings verwendet werden soll (das Namespace Mapping oder das URL-Mapping; der Wert prefer-schemalocation bezieht sich auf das URL-Mapping)). Der Standardwert ist prefer-schemalocation.

 

--schema-location-hints = load-by-schemalocation | load-by-namespace | load-combining-both | ignore

Definiert das Verhalten der Attribute xsi:schemaLocation und xsi:noNamespaceSchemaLocation: Legt fest, ob ein Schema-Dokument geladen werden soll und falls ja, anhand welcher Informationen es gesucht werden soll. Standardeinstellung: load-by-schemalocation.

 

Der Wert load-by-schemalocation verwendet die URL des Schemapfads in den Attributen xsi:schemaLocation und xsi:noNamespaceSchemaLocation in XML- oder XBRL-Instanzdokumenten. Dies ist der Standardwert.
Der Wert load-by-namespace verwendet den Namespace-Teil von xsi:schemaLocation und - im Fall von xsi:noNamespaceSchemaLocation - einen leeren String und ermittelt das Schema über ein Katalog-Mapping.
Bei Verwendung von load-combining-both und wenn entweder der Namespace-Teil oder der URL-Teil ein Katalog-Mapping hat, so wird das Katalog-Mapping verwendet. Wenn beide Katalog-Mappings haben, ist es vom Wert der --schema-mapping Option (XBRL-Option und XML/XSD-Option)  abhängig,  welches Mapping verwendet wird. Wenn weder der Namespace noch die URL ein Katalog-Mapping hat, wird die URL verwendet.
Wenn der Wert der Option ignore ist, werden die beiden Attribute xsi:schemaLocation und xsi:noNamespaceSchemaLocation ignoriert.

--script = FILE

Führt nach Abschluss der Validierung das Python-Skript in der angegebenen Datei aus. Fügen Sie die Option mehrmals hinzu, um mehr als ein Skript zu definieren.

 

--api, --script-api-version = 1|2|2.1|2.2|2.3|2.4|2.4.1|2.5|2.6|2.7

Definiert, welche Python API-Version für das Skript verwendet werden soll. Der Standardwert ist die neueste Version, derzeit 2.7. Anstelle der Werte 1 und 2 können Sie auch die Werte 1.0 und 2.0 verwenden.

 

--script-output = FILE

Schreibt die Standardausgabe des Skripts in die in FILE angegebene Datei.

 

--script-param = KEY:VALUE

Zusätzliche benutzerdefinierte Parameter, die während der Ausführung von Python Skripts aufgerufen werden können. Fügen Sie die Option mehrmals hinzu, um mehr als einen Parameter zu definieren.

 

Click to expand/collapseKataloge und globale Ressourcen

--catalog = FILE

Gibt den absoluten Pfad zu einer Root-Katalog-Datei an, die nicht die installierte Root-Katalog-Datei ist. Der Standardwert ist der absolute Pfad zur installierten Root-Katalog-Datei.  (<installationsordner>\Altova\RaptorXMLXBRLServer2019\etc\RootCatalog.xml). Informationen zum Arbeiten mit Katalogen finden Sie im Abschnitt XML-Kataloge.

 

--user-catalog = FILE

Definiert den absoluten Pfad zu einem XML-Katalog, der zusätzlich zum Root-Katalog verwendet werden soll.  Informationen zum Arbeiten mit Katalogen finden Sie im Abschnitt XML-Kataloge.

 

--enable-globalresources = true|false

Aktiviert die globalen Ressourcen. Standardwert ist false.

Hinweis:   Die Booleschen Optionswerte werden auf true gesetzt, wenn die Option ohne einen Wert definiert wird.

 

--gc | --globalresourceconfig = VALUE

Definiert die aktive Konfiguration der globalen Ressource (und aktiviert globale Ressourcen).

 

--gr | --globalresourcefile = FILE

Definiert die globale Ressourcendatei (und aktiviert globale Ressourcen).

 

 

Click to expand/collapseMeldungen, Fehler, Hilfe, Timeout, Version

--error-format = text|shortxml|longxml

Definiert das Format der Fehlerausgabe. Der Standardwert ist text. Mit den anderen Optionen werden XML-Formate generiert, wobei mit longxml mehr Details generiert werden.

 

 

--error-limit = N | unlimited

Definiert das Fehlerlimit mit einem Wertebereich von 1 bis 9999 oder unbegrenzt. Der Standardwert ist 100. Bei Erreichung des Fehlerlimits wird die Validierung gestoppt. Dient dazu, die Prozessorverwendung während der Validierung/Transformation einzuschränken.

 

--help

Zeigt den Hilfetext zum Befehl an. Beispiel: valany --h. (Alternativ dazu kann der Befehl help zusammen mit einem Argument verwendet werden. Beispiel: help valany.)

 

--log-output = FILE

Schreibt die Meldungsausgabe in die angegebene URL. Stellen Sie sicher, dass das CLI Schreibrechte für den Ausgabepfad hat.

 

--network-timeout = VALUE

Definiert das Timeout in Sekunden für entfernte I/O-Operationen. Der Standardwert ist: 40.

 

--verbose = true|false

Mit dem Wert true wird die Ausgabe zusätzlicher Informationen bei der Validierung aktiviert. Der Standardwert ist false.

Hinweis:   Die Booleschen Optionswerte werden auf true gesetzt, wenn die Option ohne einen Wert definiert wird.

 

--verbose-output = FILE

Schreibt die ausführliche Ausgabe in FILE.

 

--version

Zeigt die Version von RaptorXML+XBRL Server an. Setzen Sie --version bei Verwendung mit einem Befehl vor den Befehl.

 

--warning-limit = N | unlimited

Definiert das Warnungslimit im Bereich von 1-65535 oder unbegrenzt. Bei Erreichen dieses Limits wird die Verarbeitung fortgesetzt, doch werden keine weiteren Warnungen mehr ausgegeben. Der Standardwert ist 100.

 

 


© 2019 Altova GmbH