MANUAL DE ECOFACTURAWS #

Conceptos previos #

Antes de comenzar la configuración, es necesario aclarar diferentes conceptos:

#

Instalación: requerimientos #

Para la instalación de ecoFacturaWinService se requiere:

• Servidor Windows : no es necesario un servidor dedicado, puesto que los procesos para la firma de documentos no suelen ser muy exigentes.
  • Windows 2003 o superior
  • .NET framework 2.0 o superior
• ecoFacturaWinService : el setup instalador realiza las siguientes tareas
  • ejecutable instalado como servicio en C:\program files (x86)\ecoFacturaWS
  • licencias de uso
  • lib_pdf.ocx para el parseo de documentos PDF (depende de GDIplus.dll, que ya está instalada en los Win XP y posteriores). Ambas librerías se deben instalar en el mismo directorio del ejecutable.
  • Hay que registrar el OCX:
    • regsvr32 “C:\Archivos de programa\ecoFacturaWinService\lib_pdf.ocx”
• Auditoría de proceso : para el seguimiento de los ficheros procesados
  • Base de Datos (Access, SQL, oracle…)
  • IIS, si se desea acceder a la BBDD desde cualquier punto
  • Visor de proceso en web
• Firma electrónica :
  • Certificado electrónico
  • Firma XL(opcional): Servidor OCSP y Servidor TSP
• Módulo de envío
  • EnvíoeMail: servidor SMTP, parámetros de la cuenta de correo saliente y cuerpo del mensaje mail
  • Impresión: impresora instalada en el servidor. Si no se especifica, se imprimirá en la impresora configurada por defecto
  • Protocolo FTP: datos de acceso al servidor.

Principales Funcionalidades #

Las funcionalidades de ecoFacturaWinService se pueden agrupar:
● Generación de documentos : discriminación de ficheros, separación de PDFs con lotes de documentos, incluirmarcas de agua, acceso a BBDD para obtener datos (eMail, contraseña, path de FTP)
● Firma electrónica (PDF y XML), con posibilidad de TSP y OCSP
● Módulo de envío : email, FTP, impresión en papel
● Custodia : registro de proceso.Todas las acciones realizadas se pueden consultar en base de datos.

Las posibles acciones que realiza ecoFacturaWinService son:

• Firma electrónica de documentos, incluyendo OCSP y TSP
  • firmaPDF Firma ficheros PDF
• firmaXML Firma ficheros XML
• Verificación de la firma electrónica
• Módulo de envío
  • enviaEmail Envío de mensajes eMail, vía SMTP
  • imprime Impresión de los documentos
  • enviaFTP Envío por FTP
• Otros
  • Acceso BBDD Recupera datos (como el eMail de envío) desde la BBDD
  • SeparaPDF Separa lotes de PDF (de 1 PDF con 50 facturas a 50 ficheros)
  • EstampaPDF Incluye logos o textos en ficheros PDF (simulación de pre-impreso)
  • Merge Fusiona ficheros PDF (a partir de 2 ficheros se obtiene 1 solo PDF)
  • Mueve Distribuye documentos PDF en función de parámetros. Por ejemplo, a procesos de eFactura diferenciados en función del CIF de las empresas que emiten dichas facturas).

Todas las acciones realizadas se registran en la base de datos de “auditoría de registro”.
Además, existe un log con información técnica sobre estado del proceso.

Configuración de ecoFacturaWinService #

ecoFacturaWinService se configura en base a un fichero XML con la siguiente estructura de nodos:

Licencia #

codigo:
Valoralfanuméricoquecontienelainformacióndelalicenciadelproducto

idMaquina:
Valoralfanuméricoquecontienelainformacióndelalicenciaparalamáquinaenl
aqueseejecutaelservicio

Ejemplo:
Incrustado en el fichero ecoFactura.config

Incrustado en el fichero ecoFactura.config (facilita el copiar/pegar)

Especificando los archivos donde está la licencia.

• Las rutas relativas al directorio donde se encuentra el ejecutable (EcoFactura.Servicio.exe).
• Si no se especifica en el .config la sección por defecto busca los archivos de licenciaLicenciaApi.lic y LicenciaMaquina.lic
• Para que los cambios en los archivos surtan efecto hay que reiniciar el servicio.

Auditoria de proceso (BBDD de registro de acciones) #

La auditoría de proceso consiste en registrar en BBDD todas las acciones que realiza ecoFacturaWinService, así como si el resultado de la acción ha sido correcto o erróneo.

Para ello, se debe contar con una BBDD (SQL, Oracle, Access…), consistente en dos tablas hacia las que apunta el registro de ecoFactura. Una vez definida estas tablas, ecoFacturaWinService registrará las acciones para poder ser visualizadas desde cualquier puesto con privilegios de acceso a las tablas.

• Tabla de Registro de sesiones: registra cada sesión
• Tabla de Registro de acciones: registra todas las acciones realizadas sobre ficheros

La auditoría de proceso es opcional, por lo que puede permanecer inactiva.

• id-servicio: Valor alfanumérico. Referencia de la auditoría. Referencia única.
• databaseprovider: Proveedor de acceso a datos.
• connectionString: Cadena de conexión.
• Source: Origen de la información.

Trabajos #

Cada trabajo es un conjunto de acciones que se realizan sobre todos los archivos que aparecen en la carpeta de entrada.
Por tanto, a la hora de configurar un trabajo, primeramente indicaremos las rutas

• Base : a partir de esta ruta se pueden configurar rutas relativas
• Entrada : donde ecoFactura buscará los archivos a procesar
• Salida : donde se dejaran los ficheros procesados (ver función “mueve”)

Existen otras carpetas que se pueden configurar de manera opcional. Por defecto,
ecoFactura las dejará en la carpeta de salida:

• Temporal: Preferiblemente, deberá estar en la misma máquina donde está instalado el servicio.
• Errores: donde se dejaran los archivos que no se hayan procesado correctamente
• Archivos imprimidos
• Carpeta de pre-impresión

El resto de parámetros a configurar serán útiles para el registro de auditoría de proceso. Es
decir, para la base de datos en la que se registran las diferentes acciones realizadas:

• id: Valor alfanumérico. Identificador.
• Nombre: Valor alfanumérico. Nombre del trabajo.
• Descripción: Valor alfanumérico. Descripción del trabajo.

Cuando existen problemas de monitorización de carpetas, también se puede añadir el parámetro

• intervalo-barrido-carpeta-entrada=»5″

A partir de esta “configuración de cabecera” para el trabajo, se comienza a insertar las diferentes acciones.

Ejemplo de configuración:

Ejemplo de configuración (problemas de monitorización de Windows):
En algunos servidores antiguos, el SO Windows no permite monitorizar más de N directorios. Cuando se requiere que ecoFacturaWS monitorice más carpetas de entrada, se requiere indicar la periodicidad del barrido.

Ejemplo de configuración (problemas de parseo de documentos PDF):
ecoFacturaWS realiza algunas acciones en base al contenido de texto del documento, por ejemplo, extraer direcciónes de eMail o separar páginas en función de un tag. Para ello, ecoFacturaWS «parsea» el documento.
En el momento de la generación del PDF, por diferentes motivos, en algunos casos se generan espacios entre los caracteres y no permiten a ecoFacturaWS procesar algunas acciones correctamente.

Se ha incorporado una funcionalidad de extracción y lectura del texto de los PDFs, que implica desactivar el parseo nativo. El comportamiento mejora conmutando el parseo nativo por una funcionalidad externa.

Firma de PDF #

ecoFacturaWinService es capaz de firmar documentos PDF con los más altos estándares indicados por Adobe. Incluyendo el estado de revocación del certificado en el momento de la firma (consulta OCSP) y el sellado de tiempo de servidores externos (consulta TSP)

Por otro lado, se permite incorporar los datos informativos que se visualizarán en la validación de la firma de Adobe: el Autor de la Firma, la razón (o motivo) de firma, la dirección y datos de contacto del firmante.
El certificado electrónico puede estar instalado en el almacén de certificados por defecto del servidor (CryptoAPI de Windows), o bien en un fichero pfx.
Para la representación gráfica de la firma en PDF, se permite la visualización de una imagen.

Ejemplo de configuración

Resellado de PDFs #

Puesto que el Sello de Tiempo es una firma realizada con el certificado electrónico de la Autoridad de Sellado, cuando ese certificado caduca, el sello y, por tanto, la firma dejan de ser válidas.
Por eso, antes de que el certificado de la TSA caduque es necesario resellar o aplicar de nuevo el Sello Temporal para mantener la validez temporal de la firma.
De acuerdo a los estándares PDF, en el momento de la primera firma electrónica, se debe preparar el documento para aceptar resellados posteriormente. Para ello, se reservará un espacio extra para futuros resellados, cada resellado supone alrededor de 3KB (3072 bytes).
La cantidad que se reserva genera un «sobrepeso» del PDF firmado, de manera que el buffer se incrementa en el doble (2x) de la cantidad especificada en el siguiente parámetro.

Ejemplo de configuración
Para especificar el tamaño extra en el momento de la firma

Para resellar

Firma de XML #

La firma XML también sigue los más altos estándares XAdES, permitiendo firmar cualquier tipo de fichero XML, tanto facturas en formato facturae, UBL como cualquier otro.

Ejemplo de configuración

Verificación de eFirma #

La función de verificación valida que un documento PDF o XML

• Está firmado electrónicamente
• La firma es integra: el documento no ha sido modificado
• El certificado está emitido por una CA de confianza
• Confiamos directamente en el certificado
  
  Ejemplo de configuración

#

Envío de eMail #

La configuración de envío de email nos permite enviar el documento procesado por correo electrónico. Cada documento, se puede enviar a uno o varios destinatarios en modo “destinatario de envío”, “en copia” o “en copia oculta”.
Las direcciones de correo electrónico a las que se enviará se pueden obtener:

• una dirección fija: parámetro fijado en la configuración del servicio
• del propio archivo: el servicio recorre el archivo en busca de direcciones de email y envía a todas las direcciones encontradas.
  • La función {contexto.Documento.ExtraeEmails()} extrae las direcciones de eMail de todo el doc
  • Primera pagina ${contexto.Documento.ExtraeEmails(1)}
  • Ultima página: ${contexto.Documento.ExtraeEmails(contexto.Documento.NumeroPaginas)}
  • Primera, tercera y cuarta página: ${contexto.Documento.ExtraeEmails(1,3,4)}
  • De la segunda a la decimo cuarta:
    ${contexto.Documento.ExtraeEmails(contexto.Documento.CreaNumerosDePagina(2, 14))}
  • En este caso, mediante la configuración, se pueden “excluir” direcciones a las que no queremos que se envíen los correos.
• de una BBDD: en la que buscaríamos, por ejemplo, mediante un CIF obtenido en el propio archivo

El asunto se fija mediante un parámetro y el cuerpo del mensaje puede configurarse mediante ficheros en formato de texto (txt o html).

En el caso de archivos PDF, ecoFacturaWinService puede discriminar los documentos que no contienen direcciones de envío para imprimirlos en la impresora configurada a tal efecto.

En caso de envío de documentos XML, se puede extraer el mail de una etiqueta concreta o detectando la dirección desde cualquier punto del documento.

ecoFacturaWinService puede enviar también documentos anexos al archivo que está procesando. Por ejemplo, si lo que se pretende es enviar las “condiciones generales de contratación” o algún documento relacionado con una factura (albarán, nota de gastos…).

Distribución de documentos PDF #

ecoFacturaWinService permite distribuir archivos PDF en función de un parámetro contenido en el propio documento.
Es interesante utilizar esta función, por ejemplo, en un entorno multiempresa en el que las facturas de una empresa se quieren firmar con un certificado, o enviar por eMail en un idioma, y los de otra Empresa siguen una proceso diferente.
También, en el caso de las facturas que se imprimen varias veces, podemos separar las facturas que contienen la palabra «copia»

Ejemplo de configuración

#

Estampa PDF #

Mediante la función “estampaPDF”, ecoFacturaWinService sustituye el formato del papel preimpreso. Esta función permite agregar logos y textos a los documentos PDF.

Por defecto, esta función pone las imágenes y textos en la capa superior del PDF. De esta forma, se ocultarían logos o textos que quedaran por debajo. Si se pretende que las marcas de agua queden “por debajo” del contenido original, se debe activar la función “transparente”.

NOTAS:
Las cordenadas x,y son 0,0 en la esquina inferior izquierda (un A4 tiene un tamaño de 594,842)
El origen de la rotación es el vértice inferior izquierdo del texto o imagen.
Para los textos de más de una línea, el interlineado mínimo es “1”, por defecto toma el valor“1.5”.
Excluir páginas
· Todas menos la primera: paginas=”todas, -primera”
· Todas menos la segunda: paginas=”todas, -2”

Para estampar textos o imágenes en diferentes páginas:
Sólo la última: <texto paginas=»ultima»><imagen paginas=»primera»>
Sólo la primera: <texto paginas=»primera»><imagen paginas=»ultima»>
Todas, salvo la primera: <texto paginas=»todas -primera»><imagen paginas=»todas -primera»>
Todas de la uno a la veinte menos la quinta y la octava: <imagen paginas=»1-20,-5,-8″>
paginas = selectorPagina, selectorPagina, selectorPagina
pagina = rango 4-10 o por nombre {primera, ultima, *, todas} o por numero 1

MergePDF: Fusión de documentos PDF #

El objetivo de esta funcionalidad es la de fusionar Ficheros PDF de forma que, a partir de varios archivos PDF, se obtiene un solo archivo. Al configurarse como una acción, se podría conseguir un anexado múltiple concatenando acciones MergePDF.

Por ejemplo, se podría utilizar esta acción cuando las facturas electrónicas deben adjuntar una página de “condiciones generales de compra” o un documento anexo (albarán, detalle de los servicios…)

En el tratamiento de cada una de la facturas, se busca si existe un albarán asociado y se fusionan ambos ficheros obteniendo un solo PDF. Por ejemplo, en el proceso de una factura (archivo PDFde 3 páginas) se encuentra que lleva asociado un albarán (también PDF, de 2 páginas). El resultado de la acción sería 1 PDF de 5 páginas.

El fichero a anexar se podrá identificar mediante el nombre del archivo, de forma homogénea con el “anexar” del envío de eMails: parte del nombre del archivo a fusionar coincide con el del fichero en proceso. Se pueden utilizar comodines (*, ?).

Ejemplo: <adjunto ruta=»C:\eFactura${contexto.Documento.NombreSinExtension}_anexo.pdf»/>
Ejemplo: <adjunto ruta=»C:\eFactura${contexto.Documento.NombreSinExtension}_??.pdf»/>

La función no revisará que los PDF tengan la misma configuración de página (alineación vertical/ horizontal, dimensiones de la hoja…)

Opciones de la acción #

• Opciones por defecto: borrar=»false» à a true borraría el fichero anexado
• Opciones por defecto: requerido=»false» à a true daría error si el fichero no existe
• Opciones por defecto: posición = “ultima” à el fichero anexo se añadirá después del procesado (también podría ser primera)
• La ruta puede ser absoluta o relativa a ecoFactura.servicio.exe.
• Admite comodines * y ? en la ruta (solo en el nombre del fichero)

Separación de documentos PDF #

Muchos sistemas de gestión son capaces de imprimir facturas en formato PDF, pero en ocasiones generan un solo PDF con todas las facturas.
EWS es capaz de separar estos lotes de PDFs en base a dos criterios: cada N páginas o cada vez que encuentra un parámetro “secuencia de separación”. También permite exluirPDFsentre los documentos resultantes, en base a contenidos (por ejemplo, los
documentos que contengan la palabra “copia”)

Para nombrar el fichero de salida, podemos utilizar

• Una “ secuencia de numeración ”: de forma que el nombre del fichero resultante se tomará del texto inmediatamente posterior a esta secuencia de numeración (##FileName: FRV-123456)
• Expresiones regulares : de forma que el nombre del fichero se tomará de la primera cadena de caracteres que cumpla con la expresión regular. Por ejemplo: «\b(FVR-[0-9]{5,6})\b»

Impresión de documentos PDF
#

En el caso de documentos PDF, ecoFacturaWinService es capaz de imprimir documentos.
Para ello, se permite la configuración de cualquier impresora disponible en el puesto, utilizándose la impresora por defecto si no se especifica ninguna.
Para la configuración de la impresora, es importante conocer que el nombre no es sensible a mayúsculas (‘HP 845c’ es equivalente a ‘hp 845C’)

Una opción puede ser la de mover todas las facturas sin e-Mail a la carpeta de preimpresión, para que otra aplicación gestione la impresión de los documentos en papel.

Generación de ficheros PDF #

A partir de un fichero de texto, con la utilidad » StaplesFacturasAPdf.exe» se pueden generar de documentos PDF. El formato del PDF resultante (logos, textos…) será el que aporte una plantilla definida a tal efecto (fichero Plantilla_Factura.pdf)

Envío vía FTP #

El protocolo de envío mediante FTP también está incluido en el módulo de envío de ecoFacturaWinService.