L'intégration par URL de DocuWare permet d'intégrer des éléments de DocuWare dans une application tierce. Les collaborateurs peuvent stocker des documents dans les armoires ou y effectuer des recherches directement depuis leur application principale, sans avoir à ouvrir DocuWare au préalable.
Le principe de l'intégration par URL est simple : chaque élément de DocuWare possède un numéro d'identification (ID). Cet ID est accessible via le Platform Service, l'interface de programmation centrale de DocuWare. Les ID et quelques autres paramètres sont ajoutés à l'URL standard du système DocuWare. Les développeurs ont la possibilité d'intégrer cette URL dans le code d'un site web ou d'une application tierce. Un élément DocuWare mis en œuvre par intégration par URL est toujours intégré dans l'interface utilisateur de DocuWare. Une liste de résultats s'affiche telle qu'elle s'ouvre dans le Web Client.
Il est en outre possible d'intégrer des boîtes de dialogue, des bacs et d'autres éléments de DocuWare dans l'interface utilisateur d'une application tierce. Cela demande davantage de travail de programmation que l'intégration par URL. Pour en savoir plus, consultez le Platform Service.
Aperçu : types d'intégration
L'intégration par URL vous donne accès à ces éléments du DocuWare Client :
Visionneuse (V) : affiche un document dans la visionneuse
Liste de résultats ou de tâches avec visionneuse (RLV) : affiche une liste de résultats ou une liste de documents. Un document peut être ouvert dans la visionneuse.
Boîte de dialogue de recherche (SRLV) : affiche une boîte de dialogue de recherche ; l'utilisateur peut saisir des critères de recherche ou ouvrir un document de la liste de résultats dans la visionneuse.
Téléchargement (D) : l'utilisateur peut télécharger un document archivé dans DocuWare
Historique du document (DH) : affiche un document avec son historique
Liste des tâches de workflow (WFTL) : affiche la section du Web Client contenant la liste des tâches du Workflow Manager
Tâche de workflow (WFST) : affiche la section du Web Client contenant la tâche du Workflow Manager
Demande envoyée (SWT) : affiche un lien vers une demande de workflow attribuée à un utilisateur (destinataire)
Demandes envoyées (SWO) : affiche un lien vers toutes les demandes de workflow d'un utilisateur (expéditeur)
Boîte de dialogue d'indexation (IND) : appelle la boîte de dialogue d'indexation associée à un document
(B) : propose le bac avec toutes ses fonctions.
Relation de documents (DL) : les relations de documents fournissent les documents associés dans une liste de résultats ou dans le DocuWare Viewer du Web Client
Cas d'utilisation
Voici quelques exemples illustrant comment l'intégration par URL de DocuWare simplifie le travail quotidien au bureau :
1. Lien pour télécharger une description de produit
Vous souhaitez proposer sur votre site web des descriptions de produits stockées dans DocuWare ? Avec une intégration de téléchargement, vous créez un lien qui pointe vers un document dans une armoire. Un clic sur le lien télécharge directement le document. Quel que soit le nombre de modifications que vous apportez au document dans l'armoire, vous ne créez le document qu'une seule fois.
2. Boîte de dialogue de recherche pour les clients
Vous pouvez donner à vos clients l'accès à une boîte de dialogue de recherche au moyen d'un lien placé, par exemple, sur votre site web. Les clients peuvent alors utiliser cette boîte de dialogue pour consulter tous les documents qui les concernent, comme les commandes, les factures et les bons de livraison. Les clients n'accèdent qu'à leurs propres documents, mais ils ont la possibilité de saisir certains termes de recherche pour, par exemple, restreindre les résultats à une période donnée.
Chaque client a besoin d'une licence distincte pour accéder à un document stocké dans DocuWare. L'intégration par URL de DocuWare n'est pas conçue pour le multiplexage.
3. Lien vers une description de produit
Vos clients doivent consulter régulièrement des documents tels que des descriptions de produits ? Vous pouvez alors créer une intégration avec une requête définie. La liste de résultats s'affiche directement. Les utilisateurs peuvent sélectionner les documents qui les intéressent.
4. Validation pratique des factures
Dans votre entreprise, certains collaborateurs doivent valider des factures régulièrement. C'est très simple avec l'intégration par URL. Supposons que les collaborateurs reçoivent les factures à valider dans une liste du Task Manager. Ils peuvent créer sur leur bureau un raccourci contenant l'URL et l'utiliser pour appeler la liste du Task Manager. Cela leur permet de voir toutes les factures à valider d'un double-clic. La liste peut aussi être intégrée à un logiciel de comptabilité. Les collaborateurs accèdent ainsi encore plus facilement aux tâches. Si votre entreprise utilise le Workflow Manager, vous pouvez intégrer les listes de tâches de workflow à un logiciel de comptabilité de la même manière.
5. Mettre à disposition une liste de prix à jour
Avec une intégration de la visionneuse, vous pouvez donner à vos clients ou partenaires commerciaux un accès en lecture seule à la dernière liste de prix. Grâce au lien, la liste de prix s'affiche directement dans le DocuWare Viewer. Vous évitez ainsi de devoir renvoyer sans cesse les dernières listes de prix à vos clients et partenaires.
6. Historique des versions d'un document
Vous souhaitez par exemple insérer dans votre projet wiki un lien vers toutes les versions de la documentation d'un produit. Si cette documentation est stockée dans DocuWare, une intégration « historique du document » peut afficher toutes les versions précédentes de la documentation à côté de la plus récente. Ce type d'intégration nécessite naturellement une armoire dont la gestion des versions est activée.
Créer une intégration par URL : aperçu
L'intégration dans d'autres applications se fait en définissant une URL spécifique. Pour cela, vous ajoutez les paramètres nécessaires à l'adresse HTTP de votre DocuWare Web Client.
Il existe deux façons de créer une telle URL :
DocuWare URL Creator : avec l'outil URL Creator, vous assemblez facilement l'URL de base et les paramètres en quatre étapes. Un assistant vous guide pas à pas dans la configuration d'une URL d'intégration.
Créer des intégrations par URL manuellement : les administrateurs DocuWare ou les développeurs peuvent assembler manuellement les paramètres des éléments de DocuWare.
Les deux méthodes sont décrites dans ce manuel :
Intégration par URL avec URL Creator
Créer des intégrations par URL manuellement
Pour créer une intégration par URL, vous avez besoin de certaines informations issues du DocuWare Server Manager, comme le nom du serveur (voir ci-dessous).
En un coup d'œil : les ID des éléments DocuWare
Pour une intégration par URL, vous avez besoin des numéros d'identification des éléments à intégrer, ainsi que de l'URL du Web Client. Voici où les trouver :
URL du Web Client : DocuWare Server Manager > Connexions système > Connexion web > Répertoire racine HTTP > Web Client
GUID de l'organisation : DocuWare Server Manager > Organisation
ID de l'armoire : DocuWare Configurations > Stockage de documents > Armoires > Armoire x > Général
ID de la liste (Task Manager) : DocuWare Configurations > Stockage de documents > Armoires > Armoire x > Boîtes de dialogue > Liste
ID de la liste de résultats : DocuWare Configurations > Stockage de documents > Armoires > Armoire x > Boîtes de dialogue > Résultat
ID de la boîte de dialogue de recherche : DocuWare Configurations > Stockage de documents > Armoires > Armoire x > Boîtes de dialogue > Recherche
ID du bac : DocuWare Configurations > Personnel > Bac
ID du document : recherchez un document dans le Web Client. Lorsque le document s'affiche dans la liste de résultats, ouvrez son menu contextuel. Modifier les entrées d'index ouvre la boîte de dialogue d'informations du document. Cliquez sur Entrées système. Vous y trouverez l'ID du document.
Platform Service : vous pouvez accéder au DocuWare Platform Service à cette URL : http://[servername]/DocuWare/Platform/Home/XSL. Si nécessaire, cliquez sur Connexion pour saisir vos identifiants.
ID de la relation de documents :
Relevez d'abord le nom de l'armoire qui contient la relation de documents, ainsi que l'ID du document associé. Vous avez besoin des deux pour trouver l'ID de la relation de documents.
Accédez au Platform Service, puis cliquez sur List Organizations et ensuite sur file cabinets.
Recherchez le nom de l'armoire qui contient le lien. Sous cette armoire, cliquez sur le lien situé à côté de documents.
Recherchez maintenant l'ID du document associé au lien de relation.
Une fois que vous l'avez trouvé, faites défiler jusqu'à la section Flags et cliquez sur le lien situé à côté de self.
Sur la page suivante, faites de nouveau défiler jusqu'à la section Flags et cliquez sur le lien situé à côté de documentLinks. Copiez l'ID du lien.
Définir les droits et les profils
Avec une URL d'intégration, l'utilisateur peut accéder à toutes les boîtes de dialogue de recherche, armoires, etc., qui lui sont attribuées. Les droits d'accès sont définis dans DocuWare Configuration > Armoires.
L'utilisateur avec lequel on accède à l'armoire DocuWare doit s'être vu attribuer, via un profil d'armoire, la boîte de dialogue (liste de résultats, liste ou boîte de dialogue de recherche) à utiliser lors de l'accès.
Pour pouvoir afficher un document, l'utilisateur a besoin d'un profil d'armoire dans lequel au moins les droits généraux d'armoire Rechercher et Afficher les documents sont activés.
Lorsque vous intégrez une boîte de dialogue de recherche, vous devez activer au moins le droit de champ Rechercher pour chaque champ qui sera mis à la disposition de l'utilisateur pour une recherche.
Pour voir le nom du champ dans l'en-tête de colonne de la liste de résultats et l'entrée par champ (colonne) pour chaque résultat, le droit de champ Droit de lecture doit être activé pour ce champ. Sinon, le document figurera certes dans la liste de résultats et pourra être ouvert, mais il ne pourra pas être identifié faute d'entrées.
Pour pouvoir afficher les versions d'un document avec une intégration DH (historique du document), la gestion des versions ou la gestion automatique des versions doit être activée pour l'armoire dans laquelle se trouve le document.