valtaxonomypackage (taxpkg)

www.altova.com Agrandir/Réduire tout Imprimer cette rubrique Page précédente Un niveau supérieur Page suivante

Accueil >  Interface de ligne de commande (CLI) > Commandes de validation XBRL >

valtaxonomypackage (taxpkg)

La commande valtaxonomypackage | taxpkg valide un ou plusieurs packs de taxonomies XBRL conformément à la spécification Taxonomy 1.0 Packages.

 

Windows

RaptorXMLXBRL valtaxonomypackage | taxpkg [options] TaxonomyPackage

Linux

raptorxmlxbrl valtaxonomypackage | taxpkg [options] TaxonomyPackage

Mac

raptorxmlxbrl valtaxonomypackage | taxpkg [options] TaxonomyPackage

 

 

L'argument TaxonomyPackage est le pack de taxonomie XBRL à valider. Le pack de taxonomie est généralement un fichier ZIP. Pour valider plusieurs packs de taxonomie, il faut soit : (i) lister les fichiers à valider sur la CLI, chaque pack étant séparé du suivant par un espace ; ou (ii) lister les packs à valider dans un fichier texte (fichier .txt), avec un nom de fichier par ligne, et fournir ce fichier de texte en tant que l'argument TaxonomyPackage avec l'option --listfile définie sur true (voir la liste des Options ci-dessous).

 

Exemples

 

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

 

Click to expand/collapseCasse et lignes obliques sur la ligne de commande

RaptorXMLXBRL sur Windows

raptorxmlxbrl sur Unix (Linux, Mac)

 

* Veuillez noter que les caractères minuscules (raptorxmlxbrl) fonctionnent sur toutes les plates-formes (Windows, Linux et Mac), alors qu'une écriture en majuscule/minuscule (RaptorXMLXBRL) ne fonctionne que sur Windows et Mac.

* Utiliser les barres obliques penchées vers l'avant pour Linux et Mac, et les barres obliques penchées vers l'arrière sur Windows.

 

Options

Les options de la commande sont listées ci-dessous, et organisées en groupes. Les valeurs peuvent être spécifiées sans guillemets sauf dans deux cas : (i) lorsque le string de valeur contient des espaces, ou (ii) si la présence de guillemets est explicitement requise dans la description de l'option.

 

Cliquer pour agrandir/réduireTraitement

--listfile = true|false

Si true, traiter l'argument InputFile de la commande en tant que fichier de texte contenant un nom de fichier par ligne. La valeur par défaut est false. (Une alternative est de lister les fichiers sur la CLI avec un espace en tant que séparateur. Veuillez noter, néanmoins, que les CLI ont une limitation de caractères maximum.) Veuillez noter que l'option --listfile s'applique uniquement aux arguments, et non pas aux options.

Note :   les valeurs d'option booléennes sont configurées sur true si l'option est spécifiée sans une valeur.

 

--recurse = true|false

Utilisé pour sélectionner des fichiers dans le cadre de sous-répertoires, y compris des archives ZIP. Si true, l'argument InputFile de la commande sélectionnera aussi le fichier spécifié dans les sous-répertoires. Par exemple : test.zip|zip\test.xml sélectionnera des fichiers nommés test.xml à tous les niveaux de dossier du dossier zip. Les caractères génériques * et ? peuvent être utilisés. Donc, *.xml sélectionnera tous les fichiers .xml dans le dossier (zip). La valeur par défaut de l'option est false.

Note :   les valeurs d'option booléennes sont configurées sur true si l'option est spécifiée sans une valeur.

 

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

Spécifie le comportement des éléments xs:import, chacun d'entre eux ayant un attribut namespace optionnel et un attribut schemaLocation optionnel : <import namespace="someNS" schemaLocation="someURL">. L'option spécifie s'il faut charger un document de schéma ou juste mettre un espace de noms sous licence, et, si un document de schéma doit être chargé, quelle information doit être utilisée pour le trouver. Défaut : load-preferring-schemalocation.

Le comportement est le suivant :

 

load-by-schemalocation: La valeur de l'attribut schemaLocation est utilisée pour situer le schéma, en prenant en compte les mappages de catalogue. Si l'attribut de l'espace de nom est présent, l'espace de noms est importé (licencé).
load-preferring-schemalocation: Si l'attribut schemaLocation est présent, il est utilisé en prenant en compte les mappages de catalogue. Si l'attribut schemaLocation est présent, la valeur de l'attribut namespace est utilisée via un mappage de catalogue. C'est la valeur par défaut.
load-by-namespace: La valeur de l'attribut namespace est utilisée pour situer le schéma via un mappage de catalogue.
load-combining-both: Si soit l'Attribut namespace ou l'attribut schemaLocation a un mappage de catalogue, le mappage est utilisé. Si les deux ont des mappages de catalogue, alors la valeur de l'option --schema-mapping (option XBRL et option XML/XSD) décide de quel mappage utiliser. Si aucun mappage de catalogue n'est présent, l'attribut schemaLocation est utilisé.
license-namespace-only: Le nom d'espace est importé. Aucun document de schéma n'est importé.

 

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

Si l'emplacement de schéma et l'espace de noms sont tous les deux utilisés pour trouver un document de schéma, spécifie lequel des deux doit être utilisé pendant la consultation du catalogue. (Si soit l'option --schemalocation-hints ou l'option --schema-imports a une valeur de load-combining-both, et si les parties d'espace de noms et d'URL impliquées ont toutes les deux des mappages de catalogue, alors la valeur de cette option spécifie lequel des deux mappages utiliser (mappage d'espace de noms ou mappage URL ; la valeur prefer-schemalocation réfère au mappage URL).) Défaut : prefer-schemalocation.

 

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

Spécifie le comportement des attributs xsi:schemaLocation et xsi:noNamespaceSchemaLocation : S'il faut charger un document de schéma et, si oui, quelle information doit être utilisée pour la trouver. Défaut : load-by-schemalocation.

 

La valeur load-by-schemalocation utilise l'URL de l'emplacement de schéma dans les attributs xsi:schemaLocation et xsi:noNamespaceSchemaLocation dans les documents d'instance XML ou XBRL. Il s'agit de la valeur par défaut.
La valeur load-by-namespace prend la part d'espace de nom xsi:schemaLocation et un string vide dans le cas de xsi:noNamespaceSchemaLocation et localise le schéma par le biais d'un mappage de catalogue.
Si load-combining-both est utilisé et si soit la partie espace de noms ou la partie URL a un mappage de catalogue, alors le mappage de catalogue est utilisé. Si tous deux ont des mappages de catalogue, alors la valeur de l'option de --schema-mapping (option XBRL et option XML/XSD)  de quel mappage utiliser. Si ni l'espace de noms ni l'URL n'a un mappage de catalogue, l'URL est utilisée.
Si la valeur de l'option est ignore, les attributs xsi:schemaLocation et xsi:noNamespaceSchemaLocation seront ignorés tous les deux.

 

--script = FILE

Exécute le script Python dans le fichier soumis une fois que la validation a été terminée. Ajouter l'option plusieurs fois pour spécifier plus d'un seul script.

 

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

Spécifie la version API Python à utiliser pour le script. La valeur par défaut est la dernière version, actuellement 2.7. Au lieu des valeurs 1 et 2, vous pouvez aussi utiliser les valeurs 1.0 et 2.0, respectivement.

 

--script-output = FILE

Rédige la sortie standard du script dans le fichier nommé dans FILE.

 

--script-param = KEY:VALUE

Des paramètres spécifiés par l'utilisateur supplémentaires qui peuvent être accédés au cours de l'exécution des scripts Python. Ajouter l'option plusieurs fois pour spécifier plus d'un paramètre de script.

 

 

Click to expand/collapseCatalogues et ressources globales

--catalog = FILE

Spécifie le chemin absolu vers un fichier de catalogue root qui n'est pas le fichier catalogue root installé. La valeur par défaut est le chemin absolu vers le fichier de catalogue root installé (<installation-folder>\Altova\RaptorXMLXBRLServer2019\etc\RootCatalog.xml). Voir la section, Catalogues XML, pour plus d'informations à propos du travail avec les catalogues.

 

--user-catalog = FILE

Spécifie le chemin absolu vers un catalogue XML à utiliser en plus du catalogue root. Voir la section, Catalogues XML, pour plus d'informations concernant le travail avec des catalogues.

 

--enable-globalresources = true|false

Active les ressources globales. La valeur par défaut est false.

Note :   les valeurs d'option booléennes sont configurées sur true si l'option est spécifiée sans une valeur.

 

--gc | --globalresourceconfig = VALUE

Spécifie la configuration active de la ressource globale (et active les ressources globales).

 

--gr | --globalresourcefile = FILE

Spécifie le fichier de ressource globale (et active les ressources globales).

 

 

Click to expand/collapseMessages, erreurs, aide, timeout, version

--error-format = text|shortxml|longxml

Spécifie le format de la sortie d'erreur. La valeur par défaut est text. Les autres options génèrent des formats XML, avec longxml générant plus de détails.

 

--error-limit = N | unlimited

Spécifie la limite d'erreur avec une plage de valeur de 1 à 999 ou unlimited. La valeur par défaut est 100. Le traitement s'arrête lorsque la limite d'erreur est atteinte. Utile pour limiter l'utilisation du processeur pendant la validation/transformation.

 

--help

Affiche le texte d'aide pour la commande. Par exemple, valany --h. (en alternative, la commande help peut être utilisée avec un argument. Par exemple : help valany.)

 

--log-output = FILE

Écrit la sortie de log dans l'URL de fichier spécifié. Veuillez vous assurer que la CLI a une permission d'écriture dans l'emplacement de la sortie.

 

--network-timeout = VALUE

Spécifie le timeout en secondes pour les opérations I/O à distance. La valeur par défaut est : 40.

 

--verbose = true|false

Une valeur de true permet la sortie d'informations supplémentaires pendant la validation. La valeur par défaut est false.

Note :   les valeurs d'option booléennes sont configurées sur true si l'option est spécifiée sans une valeur.

 

--verbose-output = FILE

Écrit la sortie verbeuse sur FILE.

 

--version

Affiche la version de RaptorXML+XBRL Server. Si utilisé avec une commande, placer --version avant la commande.

 

--warning-limit = N | unlimited

Spécifie la limite d'avertissement dans la plage 1-65535 ou unlimited. Le traitement se poursuit si cette limite a été atteinte, mais d'autres avertissements ne sont pas rapportés. La valeur par défaut est 100.

 

 

 


© 2019 Altova GmbH