La integración por URL de DocuWare permite integrar elementos de DocuWare en una aplicación de terceros. Los empleados pueden almacenar documentos en los archivadores o buscar en ellos directamente desde su aplicación principal, sin tener que abrir DocuWare primero.
Actualmente, solo en el DocuWare Client clásico
La integración por URL todavía no está disponible en el nuevo DocuWare Client, presentado con DocuWare 7.15.
El principio de la integración por URL es sencillo: cada elemento de DocuWare tiene un número de identificación (ID). Se puede acceder al ID a través del Platform Service, la interfaz de programación central de DocuWare. Los ID y algunos parámetros más se añaden a la URL estándar del sistema DocuWare. Los desarrolladores pueden integrar esta URL en el código de un sitio web o de una aplicación de terceros. Un elemento de DocuWare implementado con una integración por URL siempre queda incrustado en la interfaz de usuario de DocuWare. Una lista de resultados se muestra tal y como se abre en el Web Client.
Además, es posible integrar diálogos, bandejas de documentos y otros elementos de DocuWare en la interfaz de usuario de una aplicación de terceros. Esto exige más trabajo de programación que la integración por URL. Para más información, cambie al Platform Service.
Resumen: tipos de integración
Con la integración por URL puede acceder a estos elementos del DocuWare Client:
Visor (V): muestra un documento en el visor
Lista de resultados o de tareas con visor (RLV): muestra una lista de resultados o una lista con documentos. Un documento se puede abrir en el visor.
Diálogo de búsqueda: (SRLV): muestra un diálogo de búsqueda; el usuario puede introducir criterios de búsqueda o abrir un documento de la lista de resultados en el visor.
Descarga (D): el usuario puede descargar un documento archivado en DocuWare
Historial del documento (DH): muestra un documento con su historial
Lista de tareas de workflow (WFTL): muestra la sección del Web Client con la lista de tareas del Workflow Manager
Tarea de workflow (WFST): muestra la sección del Web Client con la tarea del Workflow Manager
Enviar solicitud (SWT): muestra un enlace a una solicitud de workflow asignada a un usuario (destinatario)
Solicitudes enviadas (SWO): muestra un enlace a todas las solicitudes de workflow de un usuario (remitente)
Diálogo de índice (IND): abre el diálogo de índice correspondiente a un documento
document tray (B): ofrece la bandeja de documentos con todas sus funciones.
Relación de documentos (DL): las relaciones de documentos proporcionan documentos relacionados en una lista de resultados o en el visor del Web Client
Casos de uso
Estos son algunos ejemplos de cómo la integración por URL de DocuWare simplifica el trabajo diario en la oficina:
1. Enlace para descargar una descripción de producto
¿Quiere ofrecer en su sitio web descripciones de productos que están almacenadas en DocuWare? Con una integración de descarga crea un enlace que apunta a un documento de un archivador. Al hacer clic en el enlace, el documento se descarga directamente. Por muchas veces que edite el documento en el archivador, solo tiene que crear el documento una vez.
2. Diálogo de búsqueda para clientes
Puede dar a sus clientes acceso a un diálogo de búsqueda mediante un enlace colocado, por ejemplo, en su sitio web. Los clientes pueden utilizar entonces ese diálogo de búsqueda para consultar todos los documentos que les conciernen, como pedidos, facturas y albaranes. Los clientes solo acceden a sus propios documentos, pero tienen la posibilidad de introducir determinados términos de búsqueda para, por ejemplo, limitar los resultados a un periodo de tiempo.
Cada cliente necesita una licencia propia para acceder a un documento almacenado en DocuWare. La integración por URL de DocuWare no está pensada para la multiplexación.
3. Enlace a una descripción de producto
¿Sus clientes necesitan acceder con regularidad a documentos como descripciones de productos? Para ello puede crear una integración con una consulta definida. La lista de resultados se muestra directamente. Los usuarios pueden seleccionar los documentos que les interesan.
4. Aprobación cómoda de facturas
Algunos empleados de su empresa tienen que aprobar facturas con regularidad. Con la integración por URL esto resulta muy sencillo. Supongamos que los empleados reciben las facturas que deben aprobar en una lista del Task Manager. Pueden crear en su escritorio un acceso directo que contenga la URL y utilizarlo para abrir la lista del Task Manager. Así ven todas las facturas pendientes de aprobación con un doble clic. La lista también se puede integrar en un software de contabilidad. De este modo, los empleados acceden a las tareas con aún más facilidad. Si su empresa utiliza el Workflow Manager, puede integrar las listas de tareas de workflow en un software de contabilidad de la misma manera.
5. Poner a disposición una lista de precios actualizada
Con una integración del visor puede dar a sus clientes o socios comerciales acceso de solo lectura a la última lista de precios. Con el enlace, la lista de precios se muestra directamente en el DocuWare Viewer. Así evita tener que reenviar continuamente las últimas listas de precios a clientes y socios.
6. Historial de versiones de un documento
Por ejemplo, quiere incluir en su proyecto wiki un enlace a todas las versiones de la documentación de un producto. Si esa documentación está almacenada en DocuWare, una integración "historial del documento" puede mostrar todas las versiones anteriores de la documentación junto a la más reciente. Naturalmente, este tipo de integración requiere un archivador con la gestión de versiones activada.
Crear una integración por URL: resumen
La integración en otras aplicaciones se realiza definiendo una URL específica. Para ello, añada los parámetros necesarios a la dirección HTTP de su DocuWare Web Client.
Hay dos maneras de crear una URL de este tipo:
DocuWare URL Creator: con la herramienta URL Creator se combinan fácilmente la URL base y los parámetros en cuatro pasos. Un asistente le guía paso a paso por la configuración de una URL de integración.
Crear integraciones por URL manualmente: los administradores de DocuWare o los desarrolladores pueden componer manualmente los parámetros de los elementos de DocuWare.
Ambos métodos se describen en este manual:
Para crear una integración por URL se necesita cierta información del DocuWare Server Manager, como el nombre del servidor: véase más abajo.
De un vistazo: los ID de los elementos de DocuWare
Para una integración por URL necesita los números de identificación de los elementos que va a integrar y también la URL del Web Client. Aquí puede encontrarlos:
URL del Web Client: DocuWare Server Manager > Conexiones del sistema > Conexión web > Directorio raíz Http > Web Client
GUID de la organización: DocuWare Server Manager > Organización
ID del archivador: DocuWare Configuraciones > Archivado de documentos > Archivadores > Archivador x > General
ID de la lista (Task Manager): DocuWare Configuraciones > Archivado de documentos > Archivadores > Archivador x > Diálogos > Lista
ID de la lista de resultados: DocuWare Configuraciones > Archivado de documentos > Archivadores > Archivador x > Diálogos > Resultado
ID del diálogo de búsqueda: DocuWare Configuraciones > Archivado de documentos > Archivadores > Archivador x > Diálogos > Búsqueda
ID de la bandeja de documentos: DocuWare Configuraciones > Personal > Bandeja de documentos
ID del documento: busque un documento en el Web Client. Cuando el documento se muestre en la lista de resultados, abra su menú contextual. Editar entradas de índice abre el diálogo de información del documento. Haga clic en Entradas de sistema. En las entradas de sistema encontrará el ID del documento.
Platform Service: puede acceder al DocuWare Platform Service con esta URL http://[servername]/DocuWare/Platform/Home/XSL. Si es necesario, haga clic en Iniciar sesión para introducir sus credenciales.
ID de la relación de documentos:
Reúna primero el nombre del archivador que contiene la relación de documentos y el ID del documento relacionado. Necesita ambos para encontrar el ID de la relación de documentos.
Cambie al Platform Service y haga clic en List Organizations y después en file cabinets.
Busque el nombre del archivador que contiene el enlace. Debajo del archivador, haga clic en el enlace situado junto a documents.
Busque ahora el ID del documento relacionado con el enlace de relación.
Cuando lo haya encontrado, desplácese hasta la sección Flags y haga clic en el enlace situado junto a self.
En la página siguiente, desplácese de nuevo hasta la sección Flags y haga clic en el enlace situado junto a documentLinks. Copie el ID del enlace.
Especificar derechos y perfiles
Con una URL de integración, el usuario puede acceder a todos los diálogos de búsqueda, archivadores, etc., que tenga asignados. Los derechos de acceso se especifican en DocuWare Configuraciones > Archivadores.
Al usuario con el que se accede al archivador de DocuWare se le debe haber asignado, mediante un perfil de archivador, el diálogo (lista de resultados, lista o diálogo de búsqueda) que se va a utilizar en el acceso.
Para poder mostrar un documento, el usuario necesita un perfil de archivador en el que estén activados al menos los derechos generales de archivador Buscar y Mostrar documentos.
Cuando integre un diálogo de búsqueda, debe activar al menos el derecho de campo Buscar para cada campo que vaya a estar disponible para la búsqueda del usuario.
Para ver el nombre del campo en el encabezado de columna de la lista de resultados y la entrada por campo (columna) de cada resultado, debe activarse para ese campo el derecho de campo Derecho de lectura. De lo contrario, el documento aparecerá en la lista de resultados y se podrá abrir, pero no se podrá identificar por falta de entradas.
Para poder mostrar las versiones de un documento con una integración DH (historial del documento), debe estar activada la gestión de versiones o la gestión automática de versiones del archivador en el que se encuentra el documento.