L'intégration par URL dans DocuWare permet d'accéder aux documents archivés et aux fonctions de DocuWare directement via des liens web. Cet article fournit un aperçu des paramètres disponibles pour personnaliser et contrôler les intégrations par URL dans DocuWare.
Structure de l'URL
L'URL utilisée pour accéder à certaines parties du Web Client DocuWare depuis d'autres applications comprend toujours l'URL de base ainsi que des paramètres supplémentaires, comme expliqué ci-dessous.
Cliquez ici pour plus d'exemples de code et de packages NuGet.
URL de base
L'URL de base pour l'intégration se compose de l'« adresse HTTP du Web Client » et du suffixe « integration ».
Adresse du Web Client associé
L'adresse HTTP d'un Web Client se compose du nom de serveur de l'ordinateur sur lequel la plateforme a été installée, suivi du répertoire cible IIS (Internet Information Services) dans lequel le DocuWare Platform Service a été publié.
http://<your_servername>/<DocuWare>/<Platform>/WebClient
Vous trouverez l'adresse dans l'Administration DocuWare au niveau système, dans les paramètres des connexions web.
Extension de chemin par défaut
Ajoutez le suffixe « integration » à l'URL.
http://<your_servername>/<DocuWare>/<Platform>/WebClient/Integration
Depuis la version 7.1 de DocuWare, les clients de DocuWare Cloud peuvent créer une URL d'intégration sans GUID d'organisation ni nom spécifique, car l'organisation est encodée dans l'adresse de base de l'URL. Il en va de même pour les utilisateurs de DocuWare sur site lorsque le système ne comporte qu'une seule organisation.
Un identifiant n'est nécessaire que lorsqu'un système DocuWare comporte plusieurs organisations :
http://<your_servername>/<DocuWare>/<Platform>/WebClient/OrgGUID/Integration
Liste de tous les paramètres d'URL
Les paramètres sont ajoutés à la fin de l'URL de base. La partie de l'URL contenant les paramètres commence par un point d'interrogation (?).
Le tableau suivant fournit un récapitulatif des paramètres possibles. Vous trouverez des informations sur le chiffrement et l'encodage Base64 dans les chapitres suivants.
Tous les paramètres suivants sont sous forme chiffrée. La phrase secrète doit être définie dans l'Administration DocuWare.
Les paramètres doivent être écrits en minuscules. Exception : les valeurs du paramètre p (par ex. V pour l'intégration de la visionneuse) doivent être écrites en majuscules.
Les paramètres ep, ns, vf, vu ne sont utilisés qu'en cas de chiffrement (voir la section Connexion automatique au Web Client via URL).
Paramètre bid
Description : ID du bac
Obligatoire
Chiffré : pour comprendre la valeur, elle doit être déchiffrée.
Paramètre did
Description : Doc ID
Obligatoire
si aucune requête (via la liste des tâches ou un paramètre) et aucune boîte de dialogue de recherche ne sont définies ;
utile si vous souhaitez afficher un document spécifique ;
obligatoire si DH (historique du document) est sélectionné comme type d'intégration. Le DocID désigne alors le document dont toutes les versions doivent être affichées.
Remarque : vous pouvez utiliser tous les DocID de l'armoire ou le GUID de la liste de résultats dans l'URL.
Paramètre displayOnDoc
Description : affiche le document directement en cas de résultat unique
Remarque : si un seul document est trouvé, il est affiché directement dans la visionneuse dans le cadre d'une intégration DH ou RL, au lieu d'apparaître d'abord dans une liste.
Paramètre displayOnDoc
Description : affiche le document directement en cas de résultat unique
Remarque : si un seul document est trouvé, il est affiché directement dans la visionneuse dans le cadre d'une intégration DH ou RL, au lieu d'apparaître d'abord dans une liste.
Chiffré : pour comprendre la valeur, elle doit être déchiffrée.
Paramètre docLink
Description : ID de la relation de document
Obligatoire pour le type de document lien de document
Chiffré : pour comprendre la valeur, elle doit être déchiffrée.
Paramètre dt
Description : type de téléchargement
Obligatoire : non obligatoire. Si « D » est défini pour l'intégration, « plugin » sera utilisé par défaut comme type de téléchargement ; obligatoire uniquement si « Download » doit être défini comme type
Chiffré : pour comprendre la valeur, elle doit être déchiffrée.
Paramètre dv
Description : définit les valeurs de champ pour la boîte de dialogue de recherche, la liste de résultats et la visionneuse (SRLV)
Remarque : dans une boîte de dialogue de recherche, vous pouvez préremplir certains champs afin que la recherche soit déjà partiellement prédéfinie.
Chiffré : pour comprendre la valeur, elle doit être déchiffrée.
Paramètre ep
Description : paramètre chiffré
Obligatoire : utilisable uniquement en combinaison avec un type d'intégration (p)
Valeurs autorisées / remarques : tous les paramètres suivants sous forme chiffrée. La phrase secrète doit être définie dans l'Administration DocuWare.
Encodé en Base64 URL : pour comprendre la valeur, elle doit être décodée.
Paramètre fc
Description : armoire
Paramètre lc
Description : identifiant de connexion DocuWare
Obligatoire : non
Remarque : tous les identifiants de connexion utilisateur DocuWare existants ; l'identifiant doit être encodé en Base64 URL
Encodé en Base64 URL : pour comprendre la valeur, elle doit être décodée.
Chiffré : pour comprendre la valeur, elle doit être déchiffrée.
Paramètre lct
Description : jeton pour la connexion DocuWare
Obligatoire : non
Remarques : si un jeton d'identification est enregistré sur le serveur d'authentification, l'utilisateur peut se connecter au Web Client à l'aide d'un GUID ; la saisie d'un mot de passe n'est pas nécessaire.
Un jeton d'identification peut être généré via le DocuWare Platform Service et doit être chiffré.
Encodé en Base64 URL : pour comprendre la valeur, elle doit être décodée.
Chiffré : pour comprendre la valeur, elle doit être déchiffrée.
Paramètre ns
Description : bruit (noise)
Obligatoire : non
Valeurs autorisées / remarques : garantit que le résultat du chiffrement n'est jamais identique, c'est-à-dire que le texte chiffré est toujours différent. Pour cela, le bruit doit toujours être inséré au début de la chaîne de paramètres.
Chiffré : pour comprendre la valeur, elle doit être déchiffrée.
Paramètre p
Description : éléments à intégrer :
V = Visionneuse uniquement
RLV = Liste de résultats et visionneuse
D = Téléchargement (Plugin)
SRLV = Boîte de dialogue de recherche, liste de résultats et visionneuse.
Une boîte de dialogue de recherche doit être définie dans l'URL.
Les résultats d'une recherche plein texte ne sont pas mis en surbrillance par couleur dans la visionneuse DocuWare.DH = Historique des versions (historique du document)
DH nécessite que l'option Activer la gestion des versions soit activée pour l'armoire dans laquelle se trouvent les documents concernésIND = Boîte de dialogue d'index (boîte de dialogue Info)
WFTL = Liste des tâches du processus de travail
WFST = Tâche unique du processus de travail
SWT = Envoyer une demande (tâche simple du processus de travail)
SWO = Demandes envoyées (propriétaire du processus de travail simple)
B = Bac
DL = Relation de document (lien de document)
Obligatoire
Remarques :
Pour WFTL, WFST, SWT et SWO, le module Workflow Manager est requis.
Une liste de résultats avec une structure de dossiers n'est pas prise en charge.
Chiffré : pour comprendre la valeur, elle doit être déchiffrée.
Paramètre q
Description : requête
Obligatoire : uniquement si aucune boîte de dialogue de recherche n'est définie dans l'URL
Remarque : toute requête valide au format UTF-8 est possible.
Les requêtes doivent être encodées en Base64 URL.Pour effectuer une recherche en mode plein texte, le nom de champ « DocuWare Fulltext » doit être utilisé, par ex. [DocuWareFulltext] LIKE "*EINSTEIN*"
Encodé en Base64 URL : pour comprendre la valeur, elle doit être décodée.
Chiffré : pour comprendre la valeur, elle doit être déchiffrée.
Paramètre rl
Description : liste de résultats
Obligatoire : uniquement si aucune boîte de dialogue de recherche n'est définie dans l'URL et pour l'intégration d'une boîte de dialogue d'index.
Chiffré : pour comprendre la valeur, elle doit être déchiffrée.
Paramètre sed
Description : boîte de dialogue de recherche
Obligatoire : obligatoire si les utilisateurs doivent avoir la possibilité d'effectuer des recherches ; dans ce cas, la requête ne sera pas définie dans la définition d'une liste de tâches ni par un paramètre dans l'URL
Remarques : notez que l'utilisateur qui utilise cette boîte de dialogue de recherche doit avoir accès à cette boîte de dialogue
Chiffré : pour comprendre la valeur, elle doit être déchiffrée.
Paramètre vf
Description : valide à partir de
Définissez une période de validité pour l'URL à l'aide des paramètres vf + vu (voir ci-dessous). Les deux paramètres peuvent être définis individuellement ou ensemble ; si par ex. seul « vf » est défini, l'URL n'expirera jamais après la date « vf ».
Remarques : format conforme à ISO 8601 : « yyyy-MM-ddThh:mm:ss.fffffffzz »
« yyyy » = année
« MM » = mois
« DD » = jour
« hh » = heure
« mm » = minutes
« ss » = secondes
« fffffff » = fractions de seconde
« zz » = fuseau horaire ou décalage UTC (par ex. « Z » pour GMT, « +01 » pour Berlin)
Toute partie peut être omise, en partant de la droite vers la gauche. Si « zz » est absent, l'heure locale sera utilisée.
yyyy-MM-dd définit une date sans heure.
:,T,-,. sont de simples séparateurs
Chiffré : pour comprendre la valeur, elle doit être déchiffrée.
Paramètre vu
Description : valide jusqu'au
Définissez une période de validité pour l'URL à l'aide des paramètres vf + vu (voir ci-dessous). Les deux paramètres peuvent être définis individuellement ou ensemble ; si par ex. seul « vf » est défini, l'URL n'expirera jamais après la date « vf ».
Remarques : format conforme à ISO 8601 : « yyyy-MM-ddThh:mm:ss.fffffffzz »
« yyyy » = année
« MM » = mois
« DD » = jour
« hh » = heure
« mm » = minutes
« ss » = secondes
« fffffff » = fractions de seconde
« zz » = fuseau horaire ou décalage UTC (par ex. « Z » pour GMT, « +01 » pour Berlin)
Toute partie peut être omise, en partant de la droite vers la gauche. Si « zz » est absent, l'heure locale sera utilisée.
yyyy-MM-dd définit une date sans heure.
:,T,-,. sont de simples séparateurs
Chiffré : pour comprendre la valeur, elle doit être déchiffrée.
Paramètre waitDocContent
Description : attendre le contenu du document
Obligatoire : non, la valeur par défaut est « true »
Remarque : pour la « boîte de dialogue d'index avec visionneuse » : avec « true », un enregistrement de base de données n'est stocké qu'une fois qu'il est associé à un document. Avec « false », l'enregistrement de base de données est stocké dès sa création. Le document peut être ajouté ultérieurement.
Paramètre wiid
Description : ID d'instance du processus de travail
Obligatoire si le type d'intégration Tâche du processus de travail est sélectionné
Chiffré : pour comprendre la valeur, elle doit être déchiffrée.
Paramètre wid
Description : ID du processus de travail
Obligatoire : oui pour le type d'intégration Tâche du processus de travail ou Liste des tâches du processus de travail
Chiffré : pour comprendre la valeur, elle doit être déchiffrée.
Paramètre wr
Description : rôle du processus de travail
d = conception
c = contrôler
Obligatoire pour la liste des tâches du processus de travail
Chiffré : pour comprendre la valeur, elle doit être déchiffrée.
Paramètre wtid
Description : ID de la tâche du processus de travail
Obligatoire : obligatoire pour le type d'intégration « Envoyer une demande »
Encodage Base64 URL
Les valeurs doivent être encodées pour les paramètres d'URL « lc » et « q », car les données complexes doivent être encodées avant de pouvoir être utilisées dans une URL valide. DocuWare utilise l'encodage Base64 URL. Les caractères « + » et « / » ne pouvant pas être utilisés dans une URL, ils doivent être convertis en « - » et « _ ». Vous trouverez les spécifications détaillées dans le document RFC 4648, section 5 (http://tools.ietf.org/html/rfc4648#section-5).
À titre d'exemple, le code en PHP se présente comme suit :
function base64url_encode($plainText)
{
$base64 = base64_encode($plainText);
$base64url = strtr($base64, '+/', '-_');
return ($base64url);
}Veuillez noter que les chaînes contenant des guillemets (voir la section Exemples, par ex. [COMPANY]="Peters Engineering") peuvent varier selon l'éditeur utilisé et donc avoir un encodage Base64 différent. Cela n'affecte pas le fonctionnement de l'URL.
De plus, DocuWare supprime les caractères « = » de fin et ajoute 0, 1 ou 2 selon le nombre de caractères supprimés. L'implémentation utilise la fonction .NET « HttpServerUtility.UrlTokenEncode ». Vous trouverez plus d'informations sur le site web de Microsoft.
Paramètres : informations complémentaires
Identifiants de connexion DocuWare encodés
L'identifiant doit être une chaîne de caractères UTF-8 encodée en Base64 URL. La chaîne non encodée se présente comme suit :
User=<username>\nPwd=<password> (\n indique un saut de ligne)
Si vous souhaitez encoder l'identifiant utilisateur administrator et le mot de passe admin, vous saisissez ceci :
User=administrator\nPwd=admin
Vous encodez cette chaîne. Le résultat est :
VXNlcj1hZG1pbmlzdHJhdG9yXG5Qd2Q9YWRtaW4=.
C'est la valeur que vous utilisez pour le paramètre « lc ».
Paramètre de requête
La requête doit être une chaîne de caractères UTF-8 encodée en Base64 URL.
La chaîne non encodée se présente comme suit :
[Nom d'un champ dans la base de données]<nombre quelconque d'espaces><opérateur relationnel><nombre quelconque d'espaces>"<critères de recherche pour le type de champ DocuWare>"
par ex.
[COMPANY]="Peters Engineering"
[CONTACT] LIKE „Wi*"
Veuillez noter que les noms de champ doivent être identiques à leurs noms dans la base de données et qu'ils sont sensibles à la casse.
Si la requête contient des chiffres, elle fonctionne de la même manière que pour les lettres, par ex.
[RECORDNUMBER]="12345"
Pour un nombre décimal, utilisez un point ou une virgule comme séparateur, par ex. « 123,45 ».
Si la requête contient une date, les informations de date doivent être saisies dans un format indépendant de la langue, « YYYY-MM-DD », afin que la requête fonctionne toujours correctement. Pour une date avec heure, utilisez le format YYYY-MM-DD HH:mm:ss.
Si la requête contient un ou plusieurs guillemets, une barre oblique inverse doit être placée devant le guillemet afin de supprimer la signification méta des guillemets. Exemple :
[SUBJECT]="So-called \"Web 2.0\""
Les opérateurs relationnels possibles sont :
<=, >=, <, >, = et LIKE ; où LIKE n'est valide que pour les champs de texte. Si l'opérateur LIKE est utilisé, le critère de recherche doit contenir au moins un * (astérisque).
Les expressions de recherche simples peuvent être combinées en requêtes plus complexes à l'aide d'opérateurs logiques, par ex. :
[COMPANY]="Peters Engineering" AND [STATUS]="Valid"
Les opérateurs logiques possibles sont :
AND, OR, NOT.
Notez qu'il doit toujours y avoir au moins un espace avant et après chaque opérateur logique. Cela s'applique également à l'opérateur LIKE.
Encodez chaque requête de recherche valide avec l'encodage Base64. Exemple : [COMPANY]="Peters Engineering" devient alors :
WW0NPTVBBTlldPSJQZXRlcnMgRW5naW5lZXJpbmci.
Requête avec des champs numériques
Veuillez utiliser des points décimaux si vous utilisez des valeurs décimales dans les champs numériques. Avec un point décimal, la requête est indépendante de la culture et peut être utilisée avec différents paramètres régionaux.
Paramètre « dv »
Le paramètre dv permet de spécifier une ou plusieurs valeurs de champ pour une intégration de type boîte de dialogue de recherche, liste de résultats et visionneuse (SLRV). Les champs correspondants de la boîte de dialogue de recherche sont ainsi déjà préremplis. L'utilisateur peut supprimer ou modifier ces valeurs si nécessaire.
Nomenclature
La chaîne complète doit être encodée en Base64 URL. Les valeurs de champ doivent respecter le format suivant :
"[FieldName1]=fieldValue1&[FieldName2]=fieldValue2"
Le nom de base de données du champ doit être utilisé comme nom de champ.
Exemple : "[COMPANY]=Peters Engineering&[CONTACT]=SANDERS"
Dans un champ numérique ou de date, si l'un des champs « De » ou « À » — ou les deux — doivent être remplis, ces champs sont séparés par ;.
Exemples :
[NUMERIC_FIELD]=1;5 les deux champs « de » et « à » sont remplis
[NUMERIC_FIELD]=;5 remplit uniquement la valeur « à »
[NUMERIC_FIELD]=1 remplit uniquement la valeur « de »
Dans les champs de type MOT-CLÉ, une liste est requise dans laquelle les entrées sont également séparées par un point-virgule ;.
Si le paramètre dv définit une requête de date, les informations de date doivent être saisies dans un format indépendant de la langue, « YYYY-MM-DD », afin que la requête fonctionne toujours correctement.