El comando xsd2jsonschema convierte uno o varios documentos de esquema 1.0 o 1.1 de XML del W3C en un documento de esquema JSON.
raptorxmlxbrl xsd2jsonschema [opciones] ArchivoXSD |
•El argumento ArchivoXSD es el documento de esquema XML que se quiere convertir.
•Utilice la opción --schema-conversion-output para especificar dónde se debe guardar el archivo XSD generado.
Ejemplo
Ejemplo del comando xsd2jsonschema:
•raptorxmlxbrl xsd2jsonschema --schema-conversion-output=c:\MiEsquemaJSON.json c:\MiEsquemaXML.xsd
RaptorXMLXBRL (y RaptorXMLXBRLServer para comandos administrativos) en Windows raptorxmlxbrl (y raptorxmlxbrlserver para comandos administrativos) en Windows y Unix (Linux, Mac) * Las minúsculas (raptorxmlxbrl y raptorxmlxbrlserver) funcionan en todas las plataformas (Windows, Linux y Mac), mientras que las mayúsculas (RaptorXMLXBRL) funcionan solamente en Windows y Mac. * Use la barra diagonal en Linux y Mac y la barra diagonal inversa en Windows. |
En sistemas Windows: si hay espacios o caracteres especiales (por ejemplo en los nombres de archivos o de carpetas, empresas, personas o productos) debe usar comillas: por ejemplo, "Mi archivo". Sin embargo, debe tener en cuenta que una barra diagonal inversa seguida de comillas dobles (por ejemplo, "C:\Mi Directorio\") es posible que no se lea correctamente. Esto se debe a que la barra diagonal inversa también se usa para empezar secuencias de escape y la secuencia de escape \" también usa las comillas dobles. Para evitar secuencia de caracteres puede añadir otra barra diagonal inversa: \\". En resumen: si necesita escribir una ruta que contenga espacios y una barra diagonal inversa, esta es la mejor forma de hacerlo: "C:\Mi Directorio\\". |
Opciones
Las opciones del comando aparecen más abajo divididas en grupos. Los valores se pueden dar sin comillas excepto en estos dos casos: (i) cuando la cadena de valor contiene espacios y (ii) cuando en la descripción de la opción se indique explícitamente que es necesario el uso de comillas. Si una opción toma un valor booleano y no se indica ningún valor, entonces el valor predeterminado de la opción es TRUE. Use la opción --h, --help para ver información sobre el comando.
--schema-imports = load-by-schemalocation | load-preferring-schemalocation | load-by-namespace | load-combining-both | license-namespace-only Esta opción indica el comportamiento de los elementos xs:import. Cada uno de estos elementos tiene un atributo opcional namespace y un atributo opcional schemaLocation: <import namespace="unEspacioNombres" schemaLocation="unaURL">. La opción indica si se debe cargar un documento de esquema o solo autorizar a un espacio de nombres. Si la opción indica que se debe cargar un documento de esquema, entonces indica también qué información debe utilizarse para encontrar el documento de esquema. Valor predeterminado: load-preferring-schemalocation. •load-by-schemalocation: el valor del atributo schemaLocation se utiliza para buscar el esquema, teniendo en cuenta las asignaciones de catálogo. Si está presente el atributo namespace, se importa el espacio de nombres (con licencia). •load-preferring-schemalocation: si está presente, se utiliza el atributo schemaLocation teniendo en cuenta las asignaciones de catálogo. Si no está presente el atributo schemaLocation, entonces se usa el valor del atributo namespace a través de las asignaciones de catálogo. Este es el valor predeterminado. •load-by-namespace: el valor del atributo namespace se utiliza para buscar el esquema por medio de una asignación de catálogo. •load-combining-both: si el atributo namespace o schemaLocation tiene una asignación de catálogo, entonces se usa la asignación. Si ambos atributos tienen asignaciones de catálogo, entonces es el valor de la opción --schema-mapping (opción XBRL y opción XML/XSD) decide qué asignación se utiliza. Si no hay ninguna asignación de catálogo, entonces se usa el atributo schemaLocation. •license-namespace-only: se importa el espacio de nombres. No se importa el documento de esquema. |
--schema-mapping = prefer-schemalocation | prefer-namespace Si se usa la ubicación y el espacio de nombres para buscar el documento de esquema, esta opción indica cuál de ellos debe ser la opción preferida durante la búsqueda en el catálogo. Si la opción --schemalocation-hints o la opción --schema-imports tiene el valor load-combining-both y si las partes de espacio de nombres y URL pertinentes tienen asignaciones de catálogo, entonces el valor de la opción especifica cuál de las dos asignaciones se utiliza (la asignación del espacio de nombres o de la URL: el valor prefer-schemalocation se refiere a la asignación de la URL). Valor predeterminado: prefer-schemalocation. |
--schemalocation-hints = load-by-schemalocation | load-by-namespace | load-combining-both | ignore Determina el comportamiento predeterminado de los atributos xsi:schemaLocation y xsi:noNamespaceSchemaLocation. Indica si se debe cargar un documento de esquema y, si así es, indica qué información debe utilizarse para encontrarlo. Valor predeterminado: load-by-schemalocation. •Valor predeterminado: load-by-schemalocation. Este valor toma la URL de la ubicación del esquema de los atributos xsi:schemaLocation y xsi:noNamespaceSchemaLocation de los documentos de instancia XML o XBRL. •El valor load-by-namespace toma la parte de espacio de nombres del atributo xsi:schemaLocation y una cadena vacía en el caso del atributo xsi:noNamespaceSchemaLocation y encuentra el esquema por medio de una asignación de catálogo. •Si usa el valor load-combining-both y el espacio de nombres o la URL tienen una asignación de catálogo, se usa dicha asignación. Si ambos tienen asignaciones de catálogo, el valor de la opción schema-mapping (opción XBRL y opción XML/XSD) decide qué asignación se utiliza. Si ni el espacio de nombres ni la URL tiene una asignación de catálogo, se usa la URL. •El valor ignore ignora los atributos xsi:schemaLocation y xsi:noNamespaceSchemaLocation. |
|
--report-import-namespace-mismatch-as-warning = true|false Informa de los errores de disparidad del espacio de nombres o del espacio de nombres de destino al importar esquemas con xs:import como advertencias en vez de como errores. El valor predeterminado es false. Nota: si no se especifica un valor para la opción, el valor booleano de la opción se establece en true. |
--xinclude = true|false Habilita la compatibilidad con inclusiones XML (XInclude). Si el valor es false, los elementos XInclude include se ignoran. Valor predeterminado: false. Nota: si no se especifica un valor para la opción, el valor booleano de la opción se establece en true. |
--xml-mode-for-schemas = wf|id|valid Especifica el modo de procesamiento XML que debe utilizarse para el documento de instancia XML: wf=comprobación de formato; id=comprobación de formato con ID/IDREF; valid=validación. Valor predeterminado: wf. Recuerde que el valor valid exige que cada documento de esquema que se cargue durante el procesamiento haga referencia a una DTD. Si no existe ninguna DTD, se generará un error. |
--xsd-version = 1.0|1.1|detect Especifica qué versión de la especificación Schema Definition Language (XSD) del W3C se debe usar. Valor predeterminado: 1.0. Esta opción también puede ser útil si quiere ver en qué aspectos no es compatible un esquema 1.0 con la especificación 1.1. El valor detect es una característica de Altova. Permite detectar la versión del esquema XML (1.0 o 1.1) leyendo el valor del atributo vc:minVersion del elemento <xs:schema> del documento. Si el valor del atributo @vc:minVersion es 1.1, se entiende que la versión del esquema es 1.1. Si el atributo tiene otro valor que no sea 1.1 (o si no está presente el atributo @vc:minVersion), se entiende que la versión del esquema es 1.0. |
|
--array-and-item = true|false Si está establecido en true, el esquema JSON generado permitirá no sólo matrices sino también elementos individuales para partículas con maxOccurs > 1. El valor predeterminado es true. Nota: si no se especifica un valor para la opción, el valor booleano de la opción se establece en true. |
--consider-format = true|false Si su valor es true, los tipos de datos del esquema de origen se convierten, si es posible, al tipo correspondiente del esquema de destino. El valor predeterminado es false. Nota: si no se especifica un valor para la opción, el valor booleano de la opción se establece en true. |
--jsonschema-version = draft04|draft06|draft07|2019-09|2020-12|oas-3.1|latest|detect Indica qué versión del borrador de la especificación del esquema JSON debe utilizarse. El valor predeterminado es detect. |
--property-for-comments = true|false Si está configurado en true, se crea una propiedad llamada '#’ en cada subesquema para que se admitan comentarios. El valor predeterminado es false. Nota: si no se especifica un valor para la opción, el valor booleano de la opción se establece en true. |
--property-for-pis = true|false Si está establecido en true, se crea un patrón de propiedades que combina propiedades prefijadas con '?' para admitir instrucciones de procesamiento XML. El valor predeterminado es false. Nota: si no se especifica un valor para la opción, el valor booleano de la opción se establece en true. |
--property-for-xmlns = true|false Si está establecido en true, se crea un patrón de propiedades que combina propiedades prefijadas con '@xmlns' en cada subesquema para admitir la declaración de espacios de nombres. El valor predeterminado es false. Nota: si no se especifica un valor para la opción, el valor booleano de la opción se establece en true. |
--property-for-xsi = true|false Si está establecido en true, se crea un patrón de propiedades que combina propiedades prefijadas con '@ xsi' en cada subesquema para admitir atributos xsi:*, como por ejemplo xsi:schemaLocation. El valor predeterminado es false. Nota: si no se especifica un valor para la opción, el valor booleano de la opción se establece en true. |
--simple-content-pure-object= true|false Si está establecido en true, se crea un objeto puro para tipos complejos con contenido simple. El valor predeterminado es false. Nota: si no se especifica un valor para la opción, el valor booleano de la opción se establece en true. |
--o, --schema-converson-output = ARCHIVO Establece el nombre y la ruta de acceso del archivo al que se envía el resultado de la conversión. |
--simplify-occurrence-constraints = true|false Si está establecido en true: (i) las definiciones de aparición en el esquema XML se simplifican a obligatorias u opcionales en el esquema JSON: (ii) los elementos que se repiten en el esquema XML se simplifican a matrices con un número ilimitado de elementos (maxItems). El valor predeterminado es false. Nota: si no se especifica un valor para la opción, el valor booleano de la opción se establece en true. |
--xml-mode = wf|id|valid Especifica asignaciones de prefijos de URI para los espacios de nombres en el esquema XML. |
|
--error-format = text|shortxml|longxml Especifica el formato de la salida de error. Los valores posibles son formatos de texto, XML y XML detallado (longxml). Valor predeterminado: text. |
--error-limit = N | unlimited Especifica el límite de errores con un valor comprendido entre 1 y 9999 o unlimited (ilimitado). El valor predeterminado es 100. Cuando se alcanza el límite de error, se detiene la validación. Esta opción es muy práctica a la hora de limitar el uso del procesador durante la validación o transformación. |
--info-limit = N | unlimited Indica el límite del mensaje de información dentro del rango 1-65535 or unlimited. Si se alcanza el límite de información indicado, el procesamiento continúa pero ya no se informa de más mensajes. El valor predeterminado es 100. |
--help Muestra el texto de ayuda para el comando. Por ejemplo valany --h. (Otra opción es usar el comando help con un argumento. Por ejemplo: help valany). |
--listfile = true|false Si el valor es true, el argumento ArchivoEntrada del comando se entiende como un archivo de texto que contiene un nombre de archivo por línea. Otra opción es enumerar los archivos en la ILC, separados por un espacio. No obstante, recuerde que las ILC tienen un límite de caracteres. Además, no olvide que la opción --listfile solamente afecta a los argumentos y no a las opciones. Valor predeterminado: false. Nota: si no se especifica un valor para la opción, el valor booleano de la opción se establece en true. |
--log-output = ARCHIVO Escribe el registro de salida en la URL de archivo indicada. Compruebe que la ILC tiene permiso de escritura en la ubicación de destino. |
--network-timeout = VALOR Indica el tiempo de espera en milisegundos para operaciones remotas de entrada y salida. Valor predeterminado: 40000. |
--recurse = true|false Esta opción se utiliza para seleccionar ficheros dentro de subdirectorios (incluso en archivos ZIP). Si el valor es true, el argumento ArchivoEntrada del comando seleccionará el fichero seleccionado también en los subdirectorios. Por ejemplo: "test.zip|zip\test.xml" seleccionará los ficheros llamados test.xml en todos los subdirectorios de la carpeta ZIP. Si quiere puede usar los caracteres comodín * y ?. Por ejemplo: *.xml seleccionaría todos los ficheros de la carpeta ZIP que tengan la extensión .xml. Valor predeterminado: false Nota: si no se especifica un valor para la opción, el valor booleano de la opción se establece en true. |
--verbose = true|false Si el valor es true, se genera información adicional durante la validación. Valor predeterminado es false. Nota: si no se especifica un valor para la opción, el valor booleano de la opción se establece en true. |
--verbose-output = ARCHIVO Escribe el resultado detallado en el ARCHIVO indicado. |
--version Muestra el número de versión de RaptorXML+XBRL Server. Si se utiliza con un comando, escriba la opción --version antes del comando. |
--warning-limit = N | unlimited Especifica el límite de advertencia en el rango 1-65535 o unlimited (ilimitado). El procesamiento continua si se alcanza el límite pero no se registrarán más advertencias. El valor por defecto es 100. |
|
--catalog = ARCHIVO Especifica la ruta de acceso absoluta a un archivo de catálogo que no está en el archivo de catálogo raíz instalado. El valor predeterminado es la ruta de acceso absoluta del archivo de catálogo raíz instalado (<carpeta-instalación>\Altova\RaptorXMLXBRLServer2025\etc\RootCatalog.xml). Consulte el apartado Catálogos XML para obtener más información. |
--user-catalog = ARCHIVO Especifica la ruta de acceso absoluta a un catálogo XML que debe utilizarse junto con el catálogo raíz. Consulte el apartado Catálogos XML para obtener más información. |
--enable-globalresources = true|false Habilita la función de recursos globales. Valor predeterminado: false. Nota: si no se especifica un valor para la opción, el valor booleano de la opción se establece en true. |
|
