El presente documento est bajo la licencia Creative Commons Reconocimiento-No comercial-Compartir Igual versin 2.5 Espaa. Usted es libre de: - copiar, distribuir y comunicar pblicamente la obra - hacer obras derivadas
Bajo las condiciones siguientes: - Reconocimiento. Debe reconocer los crditos de la obra de la manera especificada por el autor o el licenciador (pero no de una manera que sugiera que tiene su apoyo o apoyan el uso que hace de su obra). - No comercial. No puede utilizar esta obra para fines comerciales. - Compartir bajo la misma licencia. Si altera o transforma esta obra, o genera una obra derivada, slo puede distribuir la obra generada bajo una licencia idntica a sta.
Al reutilizar o distribuir la obra, tiene que dejar bien claro los trminos de la licencia de esta obra. Alguna de estas condiciones puede no aplicarse si se obtiene el permiso del titular de los derechos de autor Nada en esta licencia menoscaba o restringe los derechos morales del autor. Esto es un resumen legible por humanos del texto legal (la licencia completa) disponible en http://creativecommons.org/licenses/by-nc-sa/2.5/es/
El presente documento cumple con las condiciones de accesibilidad del formato PDF (Portable Document Format).
Se trata de un documento estructurado y etiquetado, provisto de alternativas a todo elemento no textual, marcado de idioma y orden de lectura adecuado.
Para ampliar informacin sobre la construccin de documentos PDF accesibles puede consultar la gua disponible en la seccin Accesibilidad > Formacin > Manuales y Guas de la pgina http://www.inteco.es.
Descripcin funcional API XBRL LENLOC PENLOC 3
NDICE 1. INTRODUCCIN 5 1.1. PRESENTACIN 5 1.2. Justificacin del proyecto 5 1.3. Objeto del documento 6 2. DESCRIPCIN DEL PROYECTO 7 2.1. OBJETIVO 7 2.2. BENEFICIOS 7 2.3. ALCANCE 7 3. DESCRIPCIN DEL SISTEMA 9 3.1. Descripcin de los servicios 9 3.1.1. Servicio de transformacin 9 3.1.2. Servicio de validacin de informes XBRL 16 3.1.3. Servicio de visualizacin de informes XBRL 18 3.1.4. Servicio de validacin de formato comn XML 21 3.2. CASOS DE USO 22 4. INTEGRACIN Y LICENCIA 28 4.1. INTEGRACIN 28 4.2. LICENCIA 28
Descripcin funcional API XBRL LENLOC PENLOC 4
NDICE FIGURAS Figura 1: Diagrama de actividad para la transformacin de formato comn XML a XBRL....12 Figura 2: Arquitectura de la transformacin de formato comn XML a XBRL .......................13 Figura 3: Diagrama de actividad para la transformacin de XBRL a formato comn XML....15 Figura 4: Arquitectura de la transformacin de XBRL a formato comn XML .......................16 Figura 5: Diagrama de actividad para la validacin de informes XBRL.................................17 Figura 6: Diagrama de actividad para la visualizacin de informes XBRL ............................21 Figura 7: Diagrama de casos de uso CU1............................................................................23 Figura 8: Diagrama de casos de uso CU2............................................................................24 Figura 9: Diagrama de casos de uso CU3............................................................................26
Descripcin funcional API XBRL LENLOC PENLOC 5
1. Introduccin 1.1. PRESENTACIN XBRL Espaa es una asociacin privada sin nimo de lucro cuyos objetivos son: Implantacin, adopcin y desarrollo nacional e internacional del lenguaje XBRL en inters de la unificacin de estndares aplicables a la presentacin de informacin financiera y empresarial. Agrupar personas y entidades pblicas y privadas para la implantacin y adopcin del lenguaje XBRL, as como su representacin nacional e internacional ante: Personas Organizaciones Entidades Autoridades Corporaciones Grupos pblicos o privados Velar por la imagen y el prestigio de XBRL y defender los intereses en el proceso implantacin, adopcin y desarrollo de XBRL en Espaa. Impulsar la colaboracin entre miembros y promover iniciativas de implantacin de XBRL. Colaborar con los poderes pblicos en el desarrollo, implantacin y reconocimiento de XBRL. Coordinar actividades, actos, investigaciones y actividades de naturaleza anloga con el lenguaje XBRL para su implantacin, adopcin y desarrollo en Espaa. Promover y participar en estudios e investigaciones de XBRL, en el mbito nacional e internacional, y facilitar asesoramiento a los asociados y a terceros. Planificar e implementar los procesos de adopcin y desarrollo de XBRL en Espaa y en el extranjero.
1.2. Justificacin del proyecto El proyecto API XBRL LENLOC PENLOC estaba incluido entre las iniciativas llevadas a cabo por el INTECO ante el objetivo global de convertir al lenguaje XBRL (eXtensible Business
Descripcin funcional API XBRL LENLOC PENLOC 6
Reporting Language) en el estndar de facto de intercambio de informacin econmico- financiera y de negocio en el mbito de los sectores pblico y privado nacionales. En 2010 se produjo un versionado de las taxonomas que sirven de base para el intercambio de informacin entre Ministerio de Economa y Hacienda. La API qued por tanto, desactualizada y no funcional. En 2011 XBRL Espaa financi la actualizacin de la API con cargo a su partida presupuestaria Premios para cdigo abierto, con la condicin de crear una forja y una comunidad de usuarios desarrolladores en torno a la API. La forja y la comunidad se encuentran en http://sourceforge.net/projects/apilenlocpenloc/
1.3. Objeto del documento Este documento describe el alcance funcional del proyecto, concebido para la construccin de un conjunto de libreras de componentes para el tratamiento de instancias XBRL bajo las taxonomas: LENLOC, de captura de la liquidacin de los presupuestos de las Entidades Locales y PENLOC, de captura de los presupuestos de las Entidades Locales.
Descripcin funcional API XBRL LENLOC PENLOC 7
2. DESCRIPCIN DEL PROYECTO 2.1. OBJETIVO El objetivo principal de este proyecto consiste en proporcionar utilidades que faciliten la trasmisin de la informacin presupuestaria de las Entidades Locales a travs del estndar XBRL. Estas utilidades ayudarn a los emisores y receptores de esta informacin en el tratamiento de las instancias XBRL, aislndoles de la posible complejidad en el procesamiento del modelo de datos de las taxonomas LENLOC y PENLOC. Para ello, se ha desarrollado un conjunto de libreras de componentes software para el tratamiento de informes XBRL (XBRL Instance Documents) correspondientes a las taxonomas: LENLOC y PENLOC. Estos componentes de software se han desarrollado con enfoque modular y abierto.
2.2. BENEFICIOS Actualmente, gran parte del software contable implantado en los sistemas informticos de las Entidades Locales carece de la capacidad de tratamiento de ficheros XBRL. Este mdulo facilitar la implementacin de esa capacidad, aislndoles de la necesidad del conocimiento exhaustivo del estndar XBRL, y reduciendo por tanto, gastos de formacin y desarrollo del software. Este mdulo facilitar gracias al uso del estndar XBRL, la transparencia del proceso y reducir los errores en la transmisin de datos entre las Entidades Locales y la Administracin Central.
2.3. ALCANCE Se desarrollar una librera de componentes software que procese informes XBRL de acuerdo a las taxonomas LENLOC 2010 y PENLOC 2010, exponiendo los siguientes servicios: - Servicio de transformacin desde un formato comn a formato XBRL. - Servicio de transformacin desde XBRL al formato comn.
Descripcin funcional API XBRL LENLOC PENLOC 8
- Servicio de validacin de instancias. - Servicio de visualizacin de informes XBRL de presupuestos y liquidaciones presupuestarias.
Descripcin funcional API XBRL LENLOC PENLOC 9
3. DESCRIPCIN DEL SISTEMA El mdulo software desarrollado constituye un conjunto de componentes y utilidades que sern usados, entre otros, por diversos programas de gestin. Estas libreras han sido desarrolladas bajo licencia de cdigo abierto y se apoyan, a su vez, en otras libreras de cdigo abierto. Las libreras y utilidades se usarn dentro del marco constituido para el envo de informes XBRL correspondientes a los presupuestos o liquidaciones presupuestarias de Entidades Locales. El usuario del puesto local, a travs del uso del software de gestin habitual, podr llevar a cabo la realizacin de dichos informes. Ser el software contable, o de gestin, de cada Entidad Local, por tanto, el que se encargue de interactuar con las libreras desarrolladas para elaborar informes en un formato comn. Estos informes con formato comn sern convertidos a XBRL y validados por dichas libreras antes de ser reportados, asegurando que el informe XBRL cumpla con la especificacin XBRL 2.1 frente a las taxonomas LENLOC2010 o PENLOC 2010, dependiendo del tipo de informacin que se enve, liquidacin presupuestaria o presupuestos iniciales.
3.1. Descripcin de los servicios A continuacin se detalla cada uno de los servicios que expone la librera para la ejecucin de las funcionalidades a cubrir por el sistema. 3.1.1. Servicio de transformacin El servicio de transformacin expone los mtodos necesarios para llevar a cabo la conversin entre los formatos de entrada y de salida, facilitando en su implementacin la manipulacin de los modelos de objetos inherentes al estndar XBRL, en concreto en la traduccin de acuerdo con las taxonomas LENLOC y PENLOC de un formato simplificado de los datos de entrada, que se describe a continuacin. Este servicio est compuesto por dos funcionalidades simtricas. Por un lado, la conversin del formato comn a XBRL y por otro, la transformacin de XBRL a formato comn. 3.1.1.1. Definicin del Formato Comn de Entrada y Salida
Descripcin funcional API XBRL LENLOC PENLOC 10
Para el intercambio de informacin entre los sistemas de gestin de terceros con las libreras, se define un formato que de alguna forma simplifique los datos que representa un informe financiero, pero que contenga informacin suficiente para elaborar un informe XBRL que permita su validacin y consumo por herramientas estndar. Para ello se ha optado por modelar un documento XML, considerando este formato el ms adecuado por el tipo de informacin que debe contener y por el tipo de herramientas que lo tienen que consumir. Se define este modelo intermedio para su uso en la trasformacin. Este formato es lo suficientemente general para ser utilizado por cualquier herramienta y contiene toda la informacin necesaria para crear un fichero XBRL bien formado. El fichero XML de formato comn contiene: - Informacin sobre la taxonoma de referencia (LENLOC o PENLOC) - Informacin sobre el modelo de visualizacin del informe - Informacin sobre los contextos, entidad que reporta, fechas de reporte, etc. - Informacin sobre cada uno de los conceptos reportados, con una codificacin que permita su localizacin en la taxonoma correspondiente, o la identificacin del concepto por parte de la herramienta de terceros. - El valor en el informe de cada uno de los conceptos para cada una de las fechas incluidas en el informe. El fichero de formato comn XML se validar contra un esquema XML que defina la estructura completa del fichero. 3.1.1.2. Transformacin desde formato comn XML a XBRL Este servicio se encarga de realizar la transformacin de un documento que entra al sistema en formato comn (definido en el punto anterior) y de elaborar un informe XBRL vlido. El servicio recibe un fichero con la estructura de formato comn. A partir de esta informacin genera un informe XBRL bien formado, que cumple con las especificaciones tcnicas XBRL y contiene toda la informacin pertinente incluida en el formato comn. Para una correcta generacin del informe XBRL se necesita informacin adicional que se debe extraer de la taxonoma correspondiente (LENLOC o PENLOC). Esta informacin estar almacenada en una serie de mapas, que relacionan los conceptos incluidos en el formato
Descripcin funcional API XBRL LENLOC PENLOC 11
comn, con informacin especfica XBRL, que la herramienta de terceros no tiene por qu conocer ni consumir. Para comprobar que se cumplen las especificaciones requeridas, se realizar una validacin del fichero comn a consumir, y del informe XBRL generado. A continuacin, se detalla la secuencia de ejecucin del servicio de transformacin de formato comn de entrada (XML) a un informe XBRL de acuerdo a las taxonomas LENLOC y PENLOC:
Descripcin funcional API XBRL LENLOC PENLOC 12
Figura 1: Diagrama de actividad para la transformacin de formato comn XML a XBRL Como se aprecia en el diagrama, el proceso de transformacin consiste en la carga del documento de entrada XML en el formato comn, una primera validacin contra el esquema XSD, documento que define la estructura y sintaxis que debe cumplir dicho documento. De esta forma se verifica que la entrada no contiene errores.
Descripcin funcional API XBRL LENLOC PENLOC 13
A continuacin se cargarn, en base a la identificacin del documento de entrada, los mapas e identificadores correspondientes al mdulo o mdulos que contiene el documento. Una vez cargados los recursos necesarios, y mediante el uso de una API de cdigo abierto para el tratamiento de XBRL, se generar en memoria la estructura con los datos recibidos en el formato comn para elaborar el informe XBRL correspondiente a dicha estructura con los valores recibidos. En cada fase se comprueba la posible existencia de errores, en cuyo caso se procedera a su tratamiento y notificacin. MAPAS Identificadores XML con formato comn Informe XBRL Transformador de XML a XBRL API XBRL (OS)
Figura 2: Arquitectura de la transformacin de formato comn XML a XBRL En la figura anterior se puede apreciar el diagrama de bloques del servicio generador de XBRL. El proceso de generacin, el cual ha sido previamente descrito, se basa en una serie de elementos, los cuales son necesarios para definir la relacin existente entre los datos de entrada y los conceptos de la taxonoma. Los principales elementos son los siguientes: - XML con formato comn. Constituye la informacin del documento de entrada al servicio, el cual debe cumplir con el modelo definido para tal efecto. Los objetos de este modelo son informados mediante datos e identificadores asociados. Estos identificadores indican a qu concepto de negocio se refiere un determinado dato. - Identificadores. La tabla de identificadores relaciona el contenido de los mapas con la informacin contenida en el XML de entrada. Se definirn tantos identificadores como conceptos existan en los informes a representar. - Mapas. Los mapas son los documentos que permiten realizar la traduccin del formato simplificado de los informes del plan contable (documento de formato comn XML), donde se reportan conjuntos de pares clave-valor de forma estructurada, en elementos o items pertenecientes a un esquema taxonmico
Descripcin funcional API XBRL LENLOC PENLOC 14
concreto, de forma que se puedan generar informes semnticamente enriquecidos. En esta estructura, junto a Identificadores habr la informacin suficiente para poder generar el informe XBRL asociado a cada modelo de reporte. Por tanto, se definirn tantos mapas como modelos de reporte contienen las taxonomas LENLOC y PENLOC. - Transformador de XML a XBRL. Es el conjunto de clases encargado de procesar todos los elementos necesarios para generar el documento que constituye el informe XBRL. - API XBRL (OS). Librera Java en cdigo abierto, sobre la que se apoyar el servicio para simplificar el tratamiento y proceso del modelo de objetos que constituyen las taxonomas e informes XBRL. 3.1.1.3. Transformacin desde XBRL a formato comn XML Este servicio se encarga de realizar la transformacin de un informe XBRL, acorde con la taxonoma LENLOC o con la taxonoma PENLOC, en un documento con el mismo formato comn definido para la entrada al sistema. El servicio recibe un fichero XBRL. A partir de esta informacin genera un informe con estructura definida para el formato comn y que contiene todos los conceptos y valores asociados a los mismos. Para una correcta generacin del formato comn se necesitar informacin adicional, por ejemplo una serie de cdigos comunes que se manejarn en el conjunto del mdulo. Esta informacin estar almacenada en una serie de mapas que relacionan los conceptos descritos en el fichero XBRL con los cdigos que la herramienta de terceros puede manejar. Para comprobar que se cumplen las especificaciones requeridas, se realizar una validacin del fichero XBRL a consumir, y del fichero de formato comn generado. Se muestra a continuacin el diagrama de actividad asociado a esta tarea:
Descripcin funcional API XBRL LENLOC PENLOC 15
Figura 3: Diagrama de actividad para la transformacin de XBRL a formato comn XML El uso de esta funcionalidad conlleva el paso de una serie de parmetros. En uno de ellos se indicar la instancia XBRL que se quiere transformar y por otro lado un parmetro booleano que indicar si se debe validar previamente. Si se valida la instancia y se producen errores, estos errores sern notificados y se terminar el proceso. En caso contrario, se continuar con el proceso y se crear en memoria una estructura en formato comn correspondiente a la instancia XBRL. Si todo ha ido sin errores, se generar el documento XML en formato comn, el cual ser finalmente validado contra el esquema XSD que define el formato comn, reportando aquellos errores de validacin que puedan producirse.
Descripcin funcional API XBRL LENLOC PENLOC 16
En la siguiente figura se puede apreciar la arquitectura de conversin de informes XBRL a formato comn. Consiste en una arquitectura simtrica a la conversin desde XML en formato comn a XBRL, dado que el proceso es el opuesto.
MAPAS Identificadores XML con formato comn Informe XBRL Transformador XBRL a XML API XBRL (OS)
Figura 4: Arquitectura de la transformacin de XBRL a formato comn XML El proceso de transformacin de XBRL a XML en formato comn tambin estar basado en los mismos elementos que su proceso inverso, es decir, Identificadores, Mapas y API XBRL (OS), con la diferencia de que la entrada ser XBRL y la salida XML con formato comn. 3.1.2. Servicio de validacin de informes XBRL Este servicio recibir un informe XBRL. Si este contiene errores, el proceso devuelve una lista con los errores generados. La descripcin de estos errores es algo abstracta, ya que se basa en la especificacin XBRL. De cara a una mejor interpretacin de los errores por parte de la herramienta de terceros, y en ltimo trmino de los usuarios que consuman la aplicacin, se aconseja realizar una personalizacin de estos errores, abstrayndolos en la medida de lo posible a un lenguaje menos tcnico y con referencias a conceptos no enmarcados dentro del XBRL. A continuacin se detalla la secuencia de ejecucin del servicio:
Descripcin funcional API XBRL LENLOC PENLOC 17
Figura 5: Diagrama de actividad para la validacin de informes XBRL El proceso de validacin se realiza con el objetivo de poder asegurar la calidad de los informes XBRL generados, verificando que cumplen con las especificaciones XBRL. En primer lugar, se realiza la carga del documento XBRL de entrada, el cual se requiere validar. Tras la carga del documento XBRL se procede a la carga de la taxonoma a la cual hace referencia dicho XBRL (LENLOC o PENLOC) y todas las dependencias de dicha taxonoma, generando de este modo el DTS (Discoverable Taxonomy Set, conjunto de dependencias de la taxonoma) correspondiente. Una vez realizada la validacin de esquema, se proceder a notificar los errores, en caso de que existan, o bien a realizar el siguiente paso, es decir, la validacin XBRL. La validacin XBRL se encarga de comprobar que el documento ha sido creado cumpliendo las especificaciones de la taxonoma XBRL (LENLOC o PENLOC).
Descripcin funcional API XBRL LENLOC PENLOC 18
Finalmente, se procesar el resultado del motor de validacin. Funcionalmente, el servicio indicar en este resultado, de manera global, si la validacin es correcta o errnea, y en este ltimo supuesto detallar cada uno de los errores de validacin encontrados en el proceso, tratando de dar una descripcin lo ms adaptada funcionalmente para que se pueda detectar y solucionar la incidencia por parte del generador de informes. 3.1.3. Servicio de visualizacin de informes XBRL Para realizar la visualizacin de informes XBRL, adems de la informacin contenida en el informe, es necesario conocer qu mdulo se quiere visualizar. Llevado a XBRL, esto se traduce en el rol de presentacin, o en el caso de informes dimensionales, en el rol de definicin, que son los que determinarn la estructura de visualizacin del informe. Adems de la propia estructura de la informacin XBRL, se debe definir una estructura comn que de forma al informe final. Para obtener toda esta informacin se realizar una plantilla para cada mdulo de visualizacin del informe. El resultado final del proceso ser un fichero HTML con toda la informacin contenida en el informe XBRL para el mdulo cuya visualizacin se seleccion. En la siguiente tabla se muestran los mdulos existentes tanto para LENLOC como para PENLOC y los cdigos asignados. Tabla 1: Cdigos mdulos de LENLOC2010 y PENLOC2010 Cdigo Descripcin Taxonoma DI Datos identificativos LENLOC2010 A1 Importes del Anexo 1 (Intereses y rendimientos devengados) LENLOC2010 A2 Importes del Anexo 2 (Operaciones de tesorera) LENLOC2010 A3P Importes del Anexo 3 (Intereses pagados) LENLOC2010 A3R Importes del Anexo 3 (Intereses recibidos) LENLOC2010
Descripcin funcional API XBRL LENLOC PENLOC 19
A4ECNP Anexo 4. Ejecutados con concepto no presupuestario LENLOC2010 A4ECP Anexo 4. Ejecutados con clasificacin presupuestaria LENLOC2010 A4RCNP Anexo 4. Reintegrados con concepto no presupuestario LENLOC2010 A4RCP Anexo 4. Reintegrados con clasificacin presupuestaria LENLOC2010 A5 Importes del Anexo 5 (Flujos internos) LENLOC2010 GAST Importes de la Clasificacin econmica de gastos LENLOC2010 GASTA Importes de Econmica de Gastos (Cuentas abiertas) LENLOC2010 ING Importes de Econmica de Ingresos LENLOC2010 INGA Importes de Econmica de Ingresos (Cuentas abiertas) LENLOC2010 CB Estado de tesorera LENLOC2010 ACR ONP. Acreedores e ingresos pendientes de aplicacin LENLOC2010 DEU ONP. Deudores y pagos pendientes de aplicacin LENLOC2010 PROG Cuentas de la Econmica de Gastos cruzadas con Programas LENLOC2010 PROGA Cuentas de la Econmica de Gastos cruzadas con Programas (Cuentas abiertas) LENLOC2010 RT Remanente de Tesorera LENLOC2010 RP Importes del resultado presupuestario LENLOC2010 RPA Importes del resultado presupuestario ajustado LENLOC2010
Descripcin funcional API XBRL LENLOC PENLOC 20
PDI Datos identificativos PENLOC2010 PING Importes de Econmica de Ingresos PENLOC2010 PINGA Importes de Econmica de Ingresos (Cuentas abiertas) PENLOC2010 PPROG Cuentas de la Econmica de Gastos cruzadas con Programas PENLOC2010 PPROGA Cuentas de la Econmica de Gastos cruzadas con Programas (Cuentas abiertas) PENLOC2010 PGAST Importes de Econmica de Gastos PENLOC2010 PGASTA Importes de Econmica de Gastos (Cuentas abiertas) PENLOC2010
A continuacin se detallan los pasos de ejecucin del servicio:
Descripcin funcional API XBRL LENLOC PENLOC 21
Figura 6: Diagrama de actividad para la visualizacin de informes XBRL 3.1.4. Servicio de validacin de formato comn XML La librera de componentes ofrece un servicio que valida los documentos de formato comn XML para facilitar al software que lo integre su correcta generacin y uso. Dicho servicio consiste en la validacin de documento XML, con formato comn, comprobando que est bien formado y su estructura sintctica sea correcta. Para realizar esta validacin se ha definido un documento XML de esquema (XSD) que representa el modelo definido por el formato comn. El URI del esquema XSD vendr informado en el propio XML del formato comn. El validador resuelve la localizacin del esquema XSD gracias a su configuracin. En dicha configuracin se indica la ruta del sistema local en la cual se encuentra el documento XSD con el que se realizar la validacin.
Descripcin funcional API XBRL LENLOC PENLOC 22
3.2. CASOS DE USO A continuacin, se pueden ver los diagramas de casos de uso. En dichos diagramas se muestra, de un modo grfico, la relacin entre los actores y los servicios del sistema. CU1. La Entidad Local crea un informe en la herramienta con el objetivo de exportarlo a formato XBRL:
Descripcin funcional API XBRL LENLOC PENLOC 23
Figura 7: Diagrama de casos de uso CU1 En el caso de uso 1, la entidad creara un informe utilizando la herramienta correspondiente, que generar un fichero de formato comn XML. Una vez generado el fichero, se inicia la interaccin con las libreras, a travs del mdulo de transformacin. El sistema validar el fichero de formato comn XML contra el esquema que define su estructura XSD. Si el fichero es vlido, comenzar el proceso de transformacin a instancia XBRL. Una vez generada la instancia XBRL, con los datos suministrados en el fichero de formato comn, se realizar la validacin XBRL de la instancia generada. Este paso es opcional, ya que en algn caso se podr querer generar una instancia XBRL aunque tenga errores y corregirla con una herramienta externa a la aplicacin. En el caso de optar por realizar la validacin desde el sistema, el proceso terminar devolviendo la instancia vlida, o una lista de los errores de validacin que tiene la instancia.
CU2. La Entidad Local carga en la herramienta de terceros un fichero XBRL con el objetivo de gestionarlo desde su aplicacin:
Descripcin funcional API XBRL LENLOC PENLOC 24
Figura 8: Diagrama de casos de uso CU2 En el caso de uso 2, la Entidad Local creara una instancia XBRL utilizando una herramienta externa a la aplicacin. La entidad enviar a la herramienta de terceros la instancia creada para poder gestionarla o modificarla a travs de la aplicacin.
Descripcin funcional API XBRL LENLOC PENLOC 25
El sistema, a peticin de la herramienta de terceros, realizar la validacin XBRL de la instancia enviada. Si la validacin devuelve errores bloqueantes, terminar el proceso, devolviendo la lista de errores obtenidos en la validacin XBRL. Si no se producen errores, se llevar a cabo la transformacin al fichero de formato comn que la herramienta de terceros es capaz de manejar. Una vez generado el fichero de formato comn se lanzar la validacin del mismo contra su esquema. El proceso terminar devolviendo el fichero de formato comn vlido, o una lista de los errores de validacin que tiene el fichero.
CU3. La Entidad Local carga un fichero XBRL en la herramienta de terceros con el objetivo de visualizarlo:
Descripcin funcional API XBRL LENLOC PENLOC 26
Figura 9: Diagrama de casos de uso CU3
Descripcin funcional API XBRL LENLOC PENLOC 27
En el caso de uso 3, la Entidad Local creara una instancia XBRL utilizando una herramienta externa a la aplicacin. La Entidad Local enviar a la herramienta de terceros la instancia XBRL creada para poder gestionarla o modificarla a travs de la aplicacin. El sistema realizar la validacin XBRL de la instancia enviada. Si la validacin devuelve errores bloqueantes, terminar el proceso, devolviendo la lista de errores obtenidos en la validacin XBRL. Si no se producen errores, se llevar a cabo la visualizacin de la instancia XBRL, esta visualizacin se realiza generando un fichero HTML, que se alimenta a travs de la instancia XBRL suministrada, y de una serie de plantillas. Para realizar este proceso se llevar a cabo la transformacin de la instancia XBRL en el fichero de formato comn, por lo que esta funcionalidad tambin ser accesible sin necesidad de haber generado previamente una instancia XBRL. El proceso terminar devolviendo el fichero HTML generado.
Descripcin funcional API XBRL LENLOC PENLOC 28
4. INTEGRACIN Y LICENCIA 4.1. INTEGRACIN El mdulo de software construido es capaz de integrarse en aplicaciones software: - De manera nativa, si la aplicacin est escrita en lenguaje de programacin Java. Las herramientas que estn desarrolladas en Java, podrn importar las libreras de mdulo y llamar directamente a los mtodos definidos para ejecutar cada uno de los componentes descritos. - De forma alternativa, en el caso de integracin en aplicaciones no escritas en lenguaje de programacin Java, permitiendo invocar mediante un cliente de servicios web los componentes descritos. - Mediante lnea de comandos. De esta forma los programas y aplicaciones pueden, de una forma desacoplada, invocar la ejecucin de la librera en su runtime de Java sin tener que realizar desarrollos en este lenguaje, ni servicios web. As, las aplicaciones Windows no Java invocarn un comando ejecutable con los parmetros adecuados para la utilizacin de cada uno de los servicios que expone la librera. 4.2. LICENCIA Las fuentes del proyecto se incluyen bajo licencia de cdigo abierto LGPL v3.0 que permite su utilizacin en aplicaciones de terceros, tanto pblica como comercial, siempre reconociendo en el copyright a INTECO y a XBRL Espaa, y manteniendo el control en cuanto a posibles correcciones del cdigo que se puedan producir. La siguiente tabla muestra el cdigo libre utilizado por el API XBRL LENLOC PENLOC y sus licencias de uso: Tabla 2: Licencias de cdigo utilizadas CDIGO LICENCIA Log4J Apache License v2.0
Descripcin funcional API XBRL LENLOC PENLOC 29
Castor Apache License v2.0 Apache Commons Apache License v2.0 ehcache Apache License v2.0 wsdl4j Eclipse Public License Version 1.0 (EPL) Xerces2 Java Parser Apache License v2.0 UBmatrix Processing Engine Open Source GNU General Public License v2.0 (GPL)