La commande xsd2jsonschema convertit un ou plusieurs documents W3C XML Schéma 1.0 ou 1.1 en un document JSON Schema.
raptorxmlxbrl xsd2jsonschema [options] XSDFile |
•L'argument XSDFile est le fichier de Schéma XML à convertir.
•Utilisez l’option --schema-conversion-output pour spécifier l’emplacement du fichier XSD généré.
Exemple
Exemple de la commande xsd2jsonschema :
•raptorxmlxbrl xsd2jsonschema --schema-conversion-output=c:\MyJSONSchema.json c:\MyXSDSchema.xsd
RaptorXMLXBRL( et RaptorXMLXBRLServer pour des commandes d'administration) sur Windows raptorxmlxbrl( et raptorxmlxbrlserver pour des commandes d'administration) sur Windows et Unix (Linux, Mac) * Veuillez noter que la casse minuscule (raptorxmlxbrl et raptorxmlxbrlserver) fonctionne sur toutes les plate-formes (Windows, Linux et Mac), alors que la casse majuscule (RaptorXMLXBRL) fonctionne uniquement sur Windows et Mac. * Utiliser des barres obliques basculée vers l'avant sur Linux et Mac, des barres obliques basculées vers l'arrière sur Windows. |
Dans les systèmes Windows : lorsque des espaces se produisent (par exemple, dans les noms de fichier ou de dossier, ou les noms d'entreprise, de personne ou de produit), utiliser des guillemets : par exemple, "My File". Veuillez noter, néanmoins qu'une barre oblique inversée suivie par un double guillemet (par exemple, "C:\My directory\") peut ne pas être lue correctement. Cela est dû au fait que le caractère de barre oblique inversée est également utilisé pour indiquer le début d'une séquence d'échappement, et la séquence d'échappement \" représente le caractère de marque de double guillemet. Si vous souhaitez échapper cette séquence des caractères, utiliser une barre oblique inversée précédente comme ceci : \\". Pour résumer : Si vous souhaitez écrire un chemin de fichier qui contient des espaces et des barre oblique inversée de fin, l'écrire comme ceci : "C:\My Directory\\". |
Options
Les options sont recensées dans la forme abrégée (si disponible) et dans la forme longue. Vous pouvez utiliser un ou deux tirets pour les formes abrégées et longues. Une option peut ou ne peut pas prendre une valeur. Si elle prend une valeur, elle est écrite comme ceci : --option=value. Des valeurs peuvent être spécifiées sans guillemets sauf dans deux cas : (i) si le string valeur contient des espace, ou (ii) s'il est explicitement indiqué dans la description que des guillemets sont exigés. Si une option prend une valeur booléenne et qu'aucune valeur n'est spécifiée, alors la valeur par défaut de l'option est TRUE. Utiliser l'option --h, --help pour afficher des informations à propos de la commande.
.
--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. |
|
--report-import-namespace-mismatch-as-warning = true|false Réduit des erreurs de non-correspondance d'espace de noms ou d'espace de noms cible lors de l'importation de schémas avec xs:import et les fait passer d'erreurs à des avertissements. 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. |
--xinclude = true|false Active la prise en charge de XML Inclusions (XInclude). La valeur par défaut est false. Si false, les élément include d'XInclude sont ignorés. Note : les valeurs d'option booléennes sont configurées sur true si l'option est spécifiée sans une valeur. |
--xml-mode-for-schemas = wf|id|valid Spécifie le mode de traitement XML à utiliser pour les documents de schéma XML : wf=vérification de la bonne formation ; id=contrôles de la bonne formation avec ID/IDREF ; valid=validation. La valeur par défaut est wf. Veuillez noter qu'une valeur de valid exige que chaque document de schéma chargé pendant le traitement référence un DTD. Si aucun DTD n'existe, une erreur est rapportée. |
--xsd-version = 1.0|1.1|detect Spécifie la version du langage de définition de Schéma W3C (XSD) à utiliser. Le défaut est 1.0. Cette option peut être utile pour découvrir comment un schéma compatible à 1.0 n'est pas compatible à 1.1. L'option detect est une fonction spécifique à Altova. Elle permet la détection de la version du document de Schéma XML (1.0 ou 1.1) en lisant la valeur de l'attribut vc:minVersion de l'élément du document <xs:schema>. Si la valeur de l'attribut @vc:minVersion est 1.1, le schéma est détecté comme étant de version 1.1. Pour toute autre valeur, ou si l'attribut @vc:minVersion est absent, le schéma est détecté comme étant de version 1.0. |
|
--array-and-item = true|false Si défini comme true, le Schéma JSON généré permettra non seulement des tableaux, mais aussi des items uniques pour des particules avec maxOccurs > 1. Le réglage par défaut est true. Note : les valeurs d'option booléennes sont configurées sur true si l'option est spécifiée sans une valeur. |
--consider-format = true|false Si défini comme true, les types de données dans le schéma source sont convertis, si possible, au type correspondant dans le schéma cible. 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. |
--jsonschema-version = draft04|draft06|draft07|2019-09|2020-12|oas-3.1|latest|detect Spécifie quelle version du projet de version de la spécification du schéma JSON à utiliser. Le défaut est detect. |
--property-for-comments = true|false Si défini comme true, crée une propritété appelée '#' dans chaque sous-schéma pour appuyer les commentaires. Le réglage 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. |
--property-for-pis = true|false Si défini comme true, crée une propriété de motif correspondant aux propriétés préfixées avec '?'' pour appuyer les instructions de traitement XML. Le réglage 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. |
--property-for- xmlns = true|false Si défini comme true, crée une propriété de motif correspondant aux propriétés préfixées avec '@xmlns' dans chaque sous-schéma pour appuyer la déclaration d’espace de nom. Le réglage 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. |
--property-for-xsi = true|false Si défini comme true, crée une propriété de motif corespondant aux propriétés préfixées avec '@xsi' dans chaque sous-schéma pour appuyer les attributs xsi:* tels que xsi:schemaLocation. Le réglage 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. |
--simple-content-pure-object= true|false Si défini comme true, crée un objet pur pour des types complexes avec du contenu simple. Le réglage 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. |
--o, --schema-converson-output = FICHIER Défini le chemin et le nom du fichier auquel le résultat de la conversion est envoyé. |
--simplify-occurrence-constraints = true|false Si défini comme true : (i) les définition d’occurrence dans le Schéma XML sont simplifiées à soit ’requis’ ou ‘optionnel’ dans le Schéma JSON : (ii) les éléments répétitifs dans le Schéma XML sont simplifiés dans les tableaux illimités maxItems. Le réglage 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. |
--xml-mode = wf|id|valid Spécifie des mappages URI préfixe pour les espaces de noms dans le Schéma XML. |
|
--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. |
--info-limit = N | unlimited Spécifie la limite de message d'information dans la plage 1-65535 ou unlimited. Le traitement continue si la limite d'info spécifiée est atteinte, mais les messages ultérieurs ne sont pas rapportés. La valeur par défaut est 100. |
--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 = VALEUR Spécifie le timeout en secondes pour les opérations I/O à distance. La valeur par défaut est : 40000. |
--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. |
|
--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\RaptorXMLXBRLServer2025\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. |
|
