Esta semana publicamos un nuevo documento técnico de preguntas frecuentes dirigido a desarrolladores de software que trabajan con paquetes de informes XBRL.
Estos paquetes sirven como una forma estandarizada de consolidar varios archivos que constituyen un informe XBRL o Inline XBRL en un único archivo, lo que aumenta la usabilidad y facilita los procesos de envío.
La estructura del paquete de informes abarca dos tipos de archivos principales: paquetes de informes XBRL en línea (.xbri) y paquetes de informes XBRL no en línea (.xbr). Estos paquetes, normalmente en formato ZIP, agilizan el manejo de informes XBRL, simplificando las interacciones tanto para los usuarios como para los sistemas de software.
El documento técnico de preguntas frecuentes aborda consultas comunes que enfrentan los desarrolladores de software, brindando claridad sobre aspectos esenciales de la construcción y administración del paquete de informes. Cubre cuestiones relacionadas con extensiones de archivos, ubicación de documentos, manejo de informes XBRL, archivos de metadatos, el uso del formato de archivo ZIP (pero preferiblemente no el sufijo .zip) y más.
Los paquetes de informes XBRL ofrecen una solución estandarizada para gestionar informes XBRL de forma eficiente. A medida que evoluciona el panorama de los informes digitales, la adhesión a estas nuevas soluciones garantiza una interoperabilidad perfecta y mejora la transparencia en las prácticas de informes comerciales. También están diseñados para simplificar la implementación posterior de firmas digitales sobre informes XBRL.
Este recurso está diseñado para guiar a los desarrolladores de software para garantizar que puedan navegar con confianza en la construcción del paquete de informes.
1. Introducción
Los paquetes de informes XBRL son una forma estándar de combinar los diferentes archivos que componen un informe XBRL o XBRL en línea en un solo archivo. Esto hace que los informes XBRL e Inline XBRL sean más fáciles de usar, ya que el archivo se puede abrir directamente en el software compatible con el formato y proporciona un único archivo para enviar a los recopiladores de informes.
La especificación del paquete de informes define los dos tipos de archivo siguientes:
- Paquetes de informes XBRL en línea, con la extensión de archivo.xbri
- Paquetes de informes XBRL no insertados, con la extensión de archivo.xbr
Este documento responde a las preguntas más frecuentes sobre la forma estándar de crear varios componentes de un paquete de informes. El público objetivo de este documento son los desarrolladores de software. Para obtener una descripción general de alto nivel de los paquetes de informes desde la perspectiva del usuario, consulte la guía independiente Descripción de los paquetes de informes.
2. Estructura de archivos del paquete de informes
Los paquetes de informes son archivos ZIP, aunque, como se indicó anteriormente, normalmente no usan la extensión de archivo. Para comprender las preguntas frecuentes técnicas de este documento, es necesario comprender la estructura de archivos dentro del archivo ZIP.zip
Carpeta superior: los paquetes de informes deben contener una única carpeta de nivel superior. Se recomienda que el nombre de la carpeta coincida con el nombre de archivo del paquete de informes. Es posible que no aparezcan otras carpetas o archivos en el nivel superior del paquete.
- META-INF: Una subcarpeta dentro de la carpeta superior. Contiene metadatos y archivos de configuración para identificar archivos de taxonomía e informes XBRL. La carpeta META-INF puede contener los siguientes archivos:
- reportPackage.json: este archivo contiene un URI para identificar el tipo de paquete de informes y la versión de la especificación del paquete de informes a la que se ajusta.
- taxonomyPackage.xml: este archivo incluye metadatos sobre la taxonomía, como su nombre, fecha de publicación y versión. Este archivo es necesario cuando se empaqueta una taxonomía junto con el informe XBRL.
- catalog.xml: Contiene información para reasignar direcciones URL a archivos dentro del paquete. Esto permite que un informe haga referencia a una taxonomía de extensión mediante una dirección URL pública, que luego se reasigna automáticamente a los archivos de taxonomía dentro del paquete. Este archivo es opcional y solo se utiliza cuando se va a realizar una reasignación, siempre que se empaquete una taxonomía junto con el informe XBRL.
Obtenga más información sobre los paquetes de taxonomía en este documento de orientación independiente.
- reports: Se trata de una subcarpeta donde se almacenan los informes XBRL. Esta carpeta puede contener subcarpetas en función de la organización del informe XBRL.
- taxonomy (opcional): se trata de una subcarpeta opcional que contiene archivos de taxonomía cuando se empaqueta una taxonomía junto con el informe XBRL. A diferencia de la carpeta, cuyo nombre está prescrito por la especificación, no hay un nombre prescrito para esta carpeta.
Esta es la estructura de archivos del paquete de informes de ejemplo. En este ejemplo se utiliza una estructura de carpetas que refleja la estructura de URL oficial de la taxonomía.
3. Preguntas frecuentes técnicas
En esta sección se proporcionan respuestas a las preguntas técnicas más frecuentes sobre los paquetes de informes. Siempre que sea relevante, también se proporciona una estructura de paquete de informes de ejemplo.
P1 ¿Qué extensión de archivo se debe utilizar para un paquete de informes?
La extensión de archivo recomendada para los paquetes de informes XBRL en línea es, mientras que para los paquetes de informes XBRL no en línea, es.xbri.xbr
P2 ¿Dónde se debe colocar un único informe iXBRL en un paquete de informes?
Un informe iXBRL de un solo documento, que puede tener la extensión, o archivo, debe colocarse en la carpeta. Si bien es posible colocarlo en una subcarpeta dentro de la carpeta, este no es el enfoque recomendado .xhtml.html.htmreportsreports
P3 ¿Cómo debe incluirse un conjunto de documentos iXBRL en un paquete de informes?
Un conjunto de documentos iXBRL que conste de varios archivos o archivos debe colocarse en una subcarpeta de los «informes» de un paquete de informes. Al colocar los archivos en una subcarpeta, se agrupan y se indica que deben procesarse como un único conjunto de documentos iXBRL.xhtml.html.htm
P4 ¿Dónde se deben colocar los recursos auxiliares, como los archivos de imagen y CSS, en un informe XBRL en línea en un paquete de informes?
Los recursos auxiliares, como imágenes, fuentes y archivos CSS, utilizados en los informes XBRL en línea deben colocarse en la misma carpeta que el informe XBRL en línea o en una subcarpeta de esa carpeta. Se recomienda utilizar archivos de imagen separados en lugar de incrustar imágenes directamente en el XHTML.
P5 ¿Dónde se debe colocar un único informe XBRL en un paquete de informes?
Lo ideal es colocar en la carpeta un único informe XBRL, ya sea en el archivo para el informe xBRL-XML, en el archivo para xBRL-JSON o en el archivo (metadatos JSON) para el informe xBRL-CSV. Si bien es técnicamente posible colocarlo dentro de una subcarpeta de la carpeta, este no es el método preferido.xbrl.json.jsonreportsreports
P6 ¿Dónde se deben colocar los archivos de datos CSV de un informe xBRL-CSV en un paquete de informes?
Los informes xBRL-CSV se identifican mediante un archivo de metadatos JSON desde el que se pueden detectar todos los datos CSV. Los archivos de datos deben estar en la misma carpeta que el archivo de metadatos JSON o en una subcarpeta de esa carpeta.csv
P7 ¿Cómo se debe incluir un archivo xBRL-CSV con varios archivos de metadatos JSON en un paquete de informes?
xBRL-CSV permite dividir los metadatos en varios archivos JSON. Es importante que no se coloquen varios archivos JSON de metadatos en la carpeta, ya que se tratarán como informes separados. En su lugar, solo se debe colocar el archivo de metadatos principal en la carpeta y todos los demás archivos deben colocarse dentro de una subcarpeta.reportsreports
P8 ¿Cómo se combinan varios informes XBRL para crear un paquete de informes?
Los paquetes de informes XBRL en línea () admiten un único documento o conjunto de documentos XBRL en línea. Los paquetes de informes XBRL no insertados () admiten un único informe XBRL.xbri.xbr
Si es necesario combinar varios informes para su envío o distribución, el enfoque preferido es preparar cada informe como un paquete de informes independiente, del tipo adecuado, y combinarlos mediante un mecanismo independiente, como un archivo ZIP.
P9 ¿Está permitido utilizar el formato .zip para un paquete de informes?
La extensión de archivo de los paquetes de informes sirve principalmente para mantener la compatibilidad con versiones anteriores de la nota del grupo de trabajo de 2018. No se recomienda para los nuevos programas XBRL que adopten paquetes de informes. Sin embargo, si se utiliza la extensión de archivo RP, se recomienda especificar el valor como en el archivo. Sin embargo, no es obligatorio que los paquetes de informes con extensiones de archivo incluyan un archivo. .zip.zipdocumentTypehttps://xbrl.org/report-package/2023reportPackage.json.zipreportPackage.json
P10 ¿Qué experiencia de usuario debe esperar un usuario al abrir un paquete de informes?
Se espera que el software reconozca automáticamente los paquetes de informes XBRL con extensiones y abra automáticamente el informe contenido. Los usuarios solo deberían encontrar un mensaje para seleccionar un documento de destino si es necesario. Al abrir un paquete de informes con una extensión o, normalmente no se debe dar a los usuarios la opción de tratarlo como un paquete de taxonomía o abrir cualquier punto de entrada de taxonomía contenido. Además, se recomienda configurar las asociaciones de archivos y los tipos de archivo en la aplicación correspondiente..xbr.xbri.xbr.xbri.xbr.xbri
P11 ¿Cómo se debe organizar la carpeta de taxonomía?
La carpeta de taxonomía se hace necesaria cuando un paquete de informes incluye una taxonomía de extensión. Es una práctica habitual hacer referencia a taxonomías de extensión a través de una dirección URL pública basada en el sitio web de la entidad notificante y reasignar esta dirección URL a un archivo dentro del paquete de informes. Cuando se hace esto, es común nombrar la carpeta con el nombre de host en la URL y reflejar la URL en la estructura de carpetas. Las reasignaciones de los archivos de taxonomía se pueden definir en el archivo de la carpeta.catalog.xmlMETA-INF
Por ejemplo, la taxonomía de extensiones podría usar una dirección URL pública y nominal de ‘https://www.sample.com/taxonomy/2024/entry-point.xsd’
P12 ¿Es necesario incluir el archivo reportPackage.json en un paquete de informes?
En el caso de los paquetes de informes que utilizan la extensión de archivo o, el archivo es obligatorio. En el caso de los paquetes de informes que utilizan la extensión, el archivo es opcional, pero esto se debe a motivos de compatibilidad con versiones anteriores; Se recomienda que se incluya en todos los paquetes de informes..xbr.xbrireportPackage.json.zip
P13 ¿Qué tipo de URI de documento se debe utilizar para los diferentes paquetes de informes en el archivo reportPackage.json?
Para un paquete de informes XBRL insertado con una extensión, utilice el URI: ..xbrihttps://xbrl.org/report-package/2023/xbri
En el caso de un paquete de informes XBRL no insertado con una extensión, utilice el URI: ..xbrhttps://xbrl.org/report-package/2023/xbr
En el caso de un paquete de informes heredado con una extensión, use el URI: .ziphttps://xbrl.org/report-package/2023
P14 ¿Cuándo se deben utilizar los paquetes de informes?
Los paquetes de informes son más útiles para los informes XBRL y XBRL en línea que constan de varios archivos, como los que tienen taxonomías de extensión o imágenes externas, hojas de estilo y otros recursos, pero para mantener la coherencia y facilitar su uso, se recomienda que todos los informes XBRL se distribuyan como paquetes de informes utilizando las extensiones anteriores.
Por lo general, las reglas de presentación especificarán el formato exacto que se utilizará, y los preparadores deben asegurarse de cumplir con dichas reglas. Cuando los informes se publican en un sitio web, puede ser útil ponerlos a disposición también en forma de desembalaje, siempre que todas las dependencias también estén disponibles. Algunos ejemplos de ello son la publicación de un informe XBRL en línea para el consumo del usuario final o la publicación de informes xBRL-JSON como parte de una API.
4. Terminología
El objetivo de los paquetes de informes es facilitar el tratamiento de los informes XBRL, reuniendo todos los archivos que componen un informe en un único archivo con una extensión de archivo reconocible que indique que se trata de un informe XBRL o XBRL en línea. Por lo tanto, el término preferido para referirse a un «paquete de informes» es «Informe» (o «Informe XBRL» o «Informe XBRL en línea»). Los usuarios no deberían necesitar conocer ninguno de los detalles de lo que contiene el «paquete», o incluso que es un «paquete» en absoluto, y se recomienda a los desarrolladores de software que eviten el término «paquete de informes» en el software de usuario final.