2.- Manual de usuario TTO - Herramienta conversora de trámites

Mientras que el Tramitador Online permite a cualquier ciudadano realizar solicitudes de forma telemática y su portal privado gestiona los trámites que se pueden realizar mediante TTO, es necesario la creación de los formularios que corresponden a dichos trámites administrativos.
Para crear estos formularios es necesario rellenar para cada trámite una plantilla en formato Excel y ejecutar una herramienta conversora que transforme la información de esta plantilla en formato XML.

En los siguientes apartados describiremos cómo ejecutar la herramienta y los archivos que genera el proceso de conversión.


1.- Creación de formulario de un trámite administrativo (XML)


A la hora de crear el formulario correspondiente a un trámite administrativo es necesario rellenar primeramente una plantilla en formato Excel con la siguiente información:

  • Información básica del trámite (signatura, nombre, tema, organismos, etc.)
  • Documentos que solicita el trámite
  • Autorizaciones del trámite
  • Categorías con los datos que se incluyen en cada una de ellas

Buenas prácticas

Para la creación de la estructura del formulario deberemos seguir una guía de buenas prácticas. Consulte el  ANEXO I: Buenas prácticas para la creación de la estructura de formulario de trámites (XML) al final de este documento


Este fichero Excel con toda la información del trámite será la entrada a la herramienta conversora que la transforma en un archivo con formato XML que se adjuntará a un trámite administrativo mediante el portal privado de TTO.
Tanto la plantilla Excel como la herramienta conversora se podrán descargar desde el apartado 
Descargas y novedades en herramienta conversora de trámites.


Para iniciar la herramienta basta con ejecutar haciendo doble click o mediante la siguiente instrucción:

java -jar converter-x.x.x.jar

Donde x.x.x es la versión del conversor.


Se recomienda utilizar la opción de línea de comandos para visualizar el progreso de la ejecución.


Al comenzar la ejecución se abrirá una ventana para solicitar el fichero Excel que se desea convertir.


Una vez elegido el archivo Excel que se desea convertir, pulsaremos "Abrir" para que comience en proceso de conversión.

Cuando la herramienta haya hecho la conversión, aparecerá una pantalla avisando del número de errores/advertencias encontradas durante el proceso de conversión.

2.- Resultado y revisión del proceso


Una vez haya terminado el proceso, el resultado de la ejecución será un directorio en la misma ruta que el fichero Excel y con el mismo nombre. Este directorio contendrá los siguientes elementos:

  • Ficheros XML del procedimiento. Estos ficheros contendrán la estructura del procedimiento en el formato aceptado por TTO, y cada uno de ellos se corresponderá con un entorno de ejecución (INT, PRE, PRO). 
  • Fichero de revisiones. Contiene los errores y advertencias detectados en el fichero Excel que impiden la correcta generación del XML, así como las notas que se deberán tener en cuenta a la hora de subir el XML.
  • Fichero de log. Contendrá una traza detallada de la ejecución.

Es importante revisar los archivos de revisión y de log para encontrar información más detallada sobre los posibles errores / advertencias que han ocurrido durante el proceso de conversión. 

  • La existencia de errores GRAVES hará que el procedimiento no funcione correctamente en TTO, por ello se tendrán que corregir en la Excel y tendremos que volver a generar los xml. 
  • Las ADVERTENCIAS es necesario revisarlas pero en este caso no impiden que el fichero XML se pueda subir correctamente en el portal privado y se muestre correctamente en TTO.


Una vez que se hayan corregido todos los posibles errores y/o advertencias, se podrá subir el fichero XML al portal privado de TTO (ver Manual de Usuario del Portal Privado) siguiendo los consejos que se muestran en ANEXO II: Buenas prácticas para la gestión del formulario de trámites (XML).



ANEXO I: Buenas prácticas para la creación de la estructura de formulario de trámites (XML)


En este anexo se recogen una serie de buenas prácticas a la hora de crear los modelos XML de los trámites administrativos

1.- Identificadores

Estos identificadores son únicos y obligatorios en cada procedimiento. Se definen en la configuración del trámite.

Probablemente en dos procedimientos distintos existan campos iguales, en este caso es aconsejable usar el mismo identificador.

Ejemplos: 

Procedimiento XX con campo nombre e identificador NOMBRE

Procedimiento YY con campo nombre e identificador NOMBRE


Hay dos tipos: identificadores de variables e identificadores de documentos.

A) Identificadores de variables

La estructura a seguir:  [Letra secuencial categoría]_[descriptivo del campo]. 

Ejemplo: A_TFNO: → A: 1 categoría, TFNO: teléfono

Ejemplo: F_GASTOS_POL → F 6 categoría, GASTOS_POL: gastos del polígono

B) Identificadores de documentos

La estructura a seguir: DOC_[descriptivo del campo]

Ejemplo: DOC_RENTA → documento declaración de la renta.

Si por alguna razón, no se especifica este identificador, se usará un número correlativo.

Buenas prácticas

  • Usar el descriptivo del campo siempre en español.
  • Para un identificador largo, usar una contracción.
  • Comprobar si el descriptivo esta usado en otro procedimiento. Si es así, usar el mismo. Ver campos comunes.


2.- Códigos de literales

Estos códigos seguirán las reglas:

  • Palabras separadas por barra o guion bajo.
  • Siempre se indicarán en inglés.
  • En el caso de texto de comentario de un concepto se añade el sufijo "COMMENTS" a la clave del concepto. Ejemplo: FULLNAME, FULLNAME_COMMENTS
  • En el caso de enumeraciones o lista de valores se añadirá un número correlativo. Ejemplo: GENDER_VALUE_1, GENDER_VALUE_2.
  • Para los literales de las categorías/pantallas se añade el sufijo "_CAT" y un número que corresponda con el orden de la pantalla
    • DESCRIPTION_CAT_1
    • SHORT_TITLE_CAT_
    • ADD_HELP_n , Ayuda adicional de la pantalla.
  • Para las claves muy utilizadas o conocidas siempre se usará la misma palabra (literales comunes).
    • AMOUNT
    • PERCENTAGE
  • En caso de que la clave se considere demasiado larga se podrá contraer alguna palabra usando una tabla de equivalencia establecida
    • SUBSIDY_PERCENTAGE_OVER…
    • SUBIDY_PERCEN_OVER…

Buenas prácticas

  • Para un identificador largo, usar una contracción.
  • Algunos de los literales de los formularios son de uso común, por lo que es probable que ya existan en la base de datos. Conviene realizar esta comprobación para evitar datos duplicados y homogeneizar el contenido. 


3.-Tabla contracciones comunes

Palabra

Contracción

PERCENTAGE

PERCEN

DESCRIPTION

DESC

INDICATOR

IND

DOCUMENT

DOC

CERTIFICATE

CERT

SERVICESERV
AGENCIA TRIBUTARIAAEAT
SEGURIDAD SOCIALSEG_SOC
GOBIERNO DE ARAGONDGA
CATEGORYCAT
VALUEVAL


ANEXO II: Buenas prácticas para la gestión del formulario de trámites (XML)


En este anexo se recogen una serie de buenas prácticas a la hora de gestionar los modelos XML de los trámites administrativos

1.- Subir XML para crear un nuevo trámite

Es necesario realizar los siguientes pasos para asociar el XML a un nuevo trámite que todavía no se encuentra dado de alta en el portal privado:

2.- Actualizar un XML en un trámite ya existente

No afecta a aquellos usuarios que tengan una solicitud guardada a medias. Se utiliza este proceso para corregir erratas y hacer cambios de estilo, pero no de contenido porque podría confundir a los usuarios que estén en proceso de tramitación. 

Con esta opción sobrescribimos el trámite. Los usuarios que tengan una solicitud a medias continuarán tramitando con la versión anterior hasta que lo finalicen, por este motivo no se pueden hacer cambios de contenido que afecten al sentido del procedimiento (requisitos, documentación a presentar, etc.)

3.- Versionar trámite y XML

En caso de que los cambios sean estructurales (p.ej. una nueva categoría) se creará una nueva versión del trámite antes de subir el nuevo XML.

Nunca cambiar de versión mientras el procedimiento esté en plazo de presentación. El cambio de versión hace que se depuren los trámites de versiones anteriores.