Esta actividad le permite integrar servicios web REST o SOAP en su flujo de trabajo. Web Services se pueden utilizar para intercambiar datos automáticamente entre sistemas o para crear, actualizar o eliminar información en otras aplicaciones a través del flujo de trabajo.
De igual modo, puede utilizar datos de otros programas en sus flujos de trabajo, como conectar su sistema de contabilidad o CRM a DocuWare.
Para utilizar Web Services con Workflow Manager, primero regístrelos en la Configuración de DocuWare en Web Services.
The La actividad Web Services en Workflow Designer le proporciona una estructura asistida con un tipo de flujo de trabajo para crear el acceso al servicio web. Los pasos más importantes se ilustran mediante el ejemplo de un servicio web REST.
1. General
Primero, seleccione el servicio web REST y especifique el formato para el intercambio de datos. Los servicios que se hayan configurado previamente en la opción Web services de la configuración de DocuWare aparecen como seleccionables. La información necesaria será diferente dependiendo del tipo de servicio web que seleccione.
Si su servicio web ofrece un archivo de especificación OpenAPI (*.json, *.txt, *.yml o *.yaml), tiene la opción de importarlo. Tras la importación, todos los puntos finales disponibles aparecen en la lista desplegable:
2. Request
Seleccione el método y use la interfaz guiada para crear la vista, que se mostrará en la vista previa de la parte superior. Puede usar variables para diseñar de forma dinámica la ruta de la URL, los parámetros de consulta y el contenido del cuerpo. A continuación, pruebe la vista y verifique en la ficha de "Respuesta" si la vista es correcta.
Al final, pruebe la consulta y vea en la pestaña "Códigos de estado de respuesta HTTP" si la consulta se ha realizado correctamente.
Debe especificar un valor de prueba para cada variable para poder realizar la prueba.
Cuerpo HTTP
En la pestaña de cuerpo HTTP, tiene la opción de adjuntar el documento actual a la solicitud HTTP a un servicio web RESTful externo. Esto le permite, por ejemplo, enviar un documento guardado, como una factura, a un servicio de captura de IA externo para capturar el documento y asignar la información capturada a campos de índice o variables globales.
El documento se puede exportar como PDF con (DocuWare versión 7.14 o posterior) o sin anotaciones, o como documento original. Si el documento DocuWare contiene varios archivos (recortados), todos los archivos se exportan y adjuntan por separado. La solicitud HTTP contiene entonces varios objetos de archivo.
Con la versión 7.12 de DocuWare también puede especificar aquí un documento de prueba, que se incluirá en la solicitud de servicio web de prueba.
Validación del cuerpo HTTP
El cuerpo de las solicitudes HTTP se valida con Enviar o bien automáticamente al guardar la configuración. Si hay contenido no válido, aparece resaltada la parte incorrecta y se muestra un mensaje, sin embargo, podrá guardar la configuración.
Cifrado de consultas HTTP
Existen tres opciones a la hora de codificar solicitudes HTTP:
Codificar caracteres especiales (recomendado): Se codifican todos los caracteres especiales, por ejemplo: «AT&T» se convierte en «AT%26T» y «Rapid Transport» en «Rapid%20Transport»
Codificar caracteres especiales excepto los reservados para URL: ?#[]@!$&/*+,;='() A excepción de los reservados para URL, se codifican todos los caracteres especiales, por ejemplo: «AT&T» quedaría igual, pero «Rapid Transport» se convierte en «Rapid%20Transport».
No codificar caracteres especiales: no se codifica ningún carácter especial ni espacio.
La codificación se aplica a todos los valores cuya transferencia se especifica en las fichas de Ruta y Consultas , pero no a los valores de las fichas Encabezado HTTP y Cuerpo HTTP.
Configurar terminales
Si utiliza un archivo de especificación OpenAPI o el servicio Web REST estándar "DocuWare Platform API", configure el punto final seleccionado en el paso anterior. Para simplificar la configuración, todos los parámetros necesarios se preestablecen automáticamente en función del endpoint seleccionado.
Específicamente para DocuWare Platform API, defina los valores que faltan en las secciones Ruta y Consultas, por ejemplo, el archivador o documento al que se debe acceder.
En la sección Cuerpo HTTP, introduzca la información requerida y las propiedades necesarias para ejecutar la operación seleccionada, por ejemplo, el GUID del sello a colocar.
3. Asignación de datos
Aquí puede asignar los valores de las variables de respuesta o indexar datos. Elija los valores requeridos del JSON o XML de la vista en árbol (ver más abajo).
Esto le permite extraer información específica de la respuesta y guardarla para utilizarla posteriormente en su flujo de trabajo.
Si desea tratar todas las entradas devueltas, sustituya manualmente el índice por un asterisco (*) en el indexador de matrices. Esto permite un procesamiento completo de todas las entradas de la matriz.
API de la plataforma DocuWare: servicio web predeterminado
Consulte los puntos finales preconfigurados en el artículo «API de la plataforma DocuWare: servicio web predeterminado».
Este es un caso de uso para el endpoint "documentAnnotations":
Después de procesar una factura en el software de contabilidad, desea establecer automáticamente un sello de "Pagado" en la factura en DocuWare.
Para ello, cree una tarea Autoindex que cambie la entrada de índice de la factura a "pagado". El cambio de la entrada de índice de la factura desencadena un flujo de trabajo, cuya actividad de servicio Web coloca automáticamente el sello "Pagado" en el documento de factura.
Tenga en cuenta que el sello "Pagado" debe configurarse y asignarse al usuario especificado para que el flujo de trabajo ejecute actividades automáticas.
La configuración del endpoint "documentAnnotations" tiene el siguiente aspecto::
