Documentation Index

Fetch the complete documentation index at: https://knowledgecenter.docuware.com/llms.txt

Use this file to discover all available pages before exploring further.

Configurer docXporter

Prev Next

Une fois docXporter installé, vous pouvez le configurer. Notez que docXporter ne dispose pas d'outil de configuration à interface graphique. Toutes les configurations sont gérées au moyen de fichiers XML individuels, que vous pouvez modifier avec n'importe quel éditeur de texte.

Nous vous recommandons d'utiliser un éditeur tel que Notepad++ ou Visual Studio Code pour modifier les fichiers de configuration. L'éditeur fourni avec Windows (Notepad.exe) a déjà rendu des fichiers de configuration inutilisables par le passé.

Lors de l'installation de docXporter, le fichier de configuration par défaut defaultconfig.xml est placé dans le dossier C:\ProgramData\docXporter\.

Utilisez ce fichier de configuration comme modèle pour les autres fichiers de configuration. Vous pouvez créer autant de configurations que nécessaire en copiant un fichier existant et en le renommant selon sa fonction. Par exemple, si vous avez besoin d'un export spécifique pour les factures, le nom invoices.xml est un bon choix. Les configurations peuvent être exécutées en totalité ou de manière ciblée (voir le chapitre « Exécuter un export »)

Pour les réglages de base, il suffit de modifier la valeur comprise entre les balises XML. Reportez-vous aux paramètres généraux dans le tableau ci-dessous.

Les réglages tels que les paramètres de recherche dans l' ou la mise à jour des termes d'index suivent une structure précise :

  • La ligne Item est dupliquée pour chaque entrée

  • Name contient le nom de base de données du champ

  • Value la valeur

Exemple

<Object Name="DWArchivFilter" Type="Docuscan.DocuwareExporter.Configuration.FieldMapping">
  <Item Name="COMPANY" Value="Berger Stahlgroßhandel GmbH" />
  <Item Name="STATUS" Value="Export" />
</Object>

Les caractères spéciaux tels que &, < ou >, ainsi que les caractères propres à une langue tels que ä, ö ou ñ, peuvent poser problème s'ils sont utilisés en clair dans des fichiers XML. Si votre configuration nécessite l'emploi de ces caractères, développez la section suivante pour plus d'informations.

Informations complémentaires sur la gestion des caractères spéciaux dans les fichiers XML

La syntaxe utilisée dans un fichier XML réserve certains caractères ; ceux-ci doivent être réécrits pour pouvoir être enregistrés dans le fichier. Le tableau suivant présente les caractères les plus courants qui doivent être réécrits. Les problèmes surviennent particulièrement souvent lorsque l'esperluette n'est pas réécrite.

Caractères

À remplacer par

&

&amp;

<

&lt;

>

&gt;

Les exemples classiques sont les noms d'organisation DocuWare des formulaires d'entreprise tels que GmbH & Co KG, ou les requêtes SQL comportant des conditions supérieur à / inférieur à.

Des problèmes peuvent également survenir si des caractères situés hors de l'espace de caractères ASCII sont utilisés. C'est par exemple le cas de é, à, etc.

Ces caractères doivent eux aussi être remplacés par les caractères de substitution correspondants. Une recherche sur Internet portant sur « Unicode character table » renvoie par exemple la page suivante : https://www.utf8-zeichentabelle.de/unicode-utf8-table.pl?names=-&unicodeinhtml=hex

Selon cette table, le caractère é est par exemple remplacé par &#233; et à par &#224;. Il est bien entendu également possible d'utiliser la notation hexadécimale correspondante.

Paramètres du fichier de configuration

Général

DWServiceUrl

URL des DocuWare Platform Services

Exemple : https://DOCUWARESERVER/DocuWare/Platform

Remplacez la valeur DOCUWARESERVER par le même nom de serveur que celui utilisé pour le DocuWare Web Client

DWUser

Nom de l'utilisateur DocuWare avec lequel l'application se connecte à DocuWare.

DWPassword

Mot de passe de l'utilisateur DocuWare avec lequel l'application se connecte à DocuWare.

Le mot de passe doit être chiffré à l'aide de l'EncryptionTool fourni. Vous trouverez un raccourci dans le dossier des fichiers de configuration.

DWOrganization

L'organisation DocuWare auprès de laquelle l'application est enregistrée.

DWArchivGuid

GUID de l'armoire DocuWare depuis laquelle les documents sont exportés. Vous trouverez le GUID dans les paramètres généraux de l'armoire, dans DocuWare Configuration.

DWSearchDialogGuid

GUID de la boîte de dialogue de recherche utilisée pour rassembler les documents en vue de l'export. Vous trouverez le GUID dans les boîtes de dialogue d'armoire, dans DocuWare Configuration.

Tampons

Les documents peuvent être tamponnés avant ou après l'export.

EnableStamps

Active ou désactive l'option permettant d'apposer le tampon sur le document exporté.
Les valeurs valides sont True = activé, False = désactivé.

Reportez-vous aux informations complémentaires sur les tampons ci-dessous.

StampBeforeExport

Ce commutateur est ignoré si EnableStamps a la valeur False.

Choisissez si :

  • le tampon est apposé avant l'export du document et figure ainsi dans les documents exportés (si les annotations doivent être exportées via ExportMode) ;

  • ou après l'export du document.


Les valeurs valides sont :

  • True = tampon avant l'export

  • False = tampon après l'export

StampLayer

Désigne le niveau d'annotation sur lequel le tampon est appliqué. Par défaut, ce réglage a la valeur 1.

StampPosX

Position en pixels, à partir du bord gauche du document, où le tampon est placé.

Pour un positionnement automatique du tampon, saisissez ici -1.

StampPosY

Position en pixels, à partir du haut du document, où le tampon est placé.

Pour un positionnement automatique du tampon, saisissez ici -1.

DWStampName

Nom du tampon appliqué au document lors de l'export.

docXporter prend en charge deux variantes pour rechercher des documents. La méthode recommandée consiste à utiliser le SearchMode DocuWare. Pour des cas d'usage très particuliers dans DocuWare sur site, vous pouvez utiliser le SearchMode SQL.

SearchMode

Les valeurs valides sont DocuWare et SQL.

Une recherche normale est effectuée dans l'armoire DocuWare. Les paramètres valides lors d'une recherche dans DocuWare (par exemple NOT, OR ou EMPTY()) peuvent être utilisés lors d'une recherche dans des champs de texte.

La recherche via DocuWare renvoie au maximum 10 000 résultats.

Pour utiliser ce mode de recherche, les paramètres suivants doivent être configurés :

DWSearchDialogGuid

GUID de la boîte de dialogue de recherche utilisée pour rassembler les documents en vue de l'export. Vous trouverez le GUID dans les boîtes de dialogue d'armoire, dans DocuWare Configuration.

DWArchivFilter

Critères de filtre selon lesquels les documents à exporter sont sélectionnés. La syntaxe générale des réglages se présente comme suit. Une ligne item supplémentaire doit être ajoutée pour chaque champ DocuWare.

<Object Name="DWArchivFilter" Type="Docuscan.DocuwareExporter.Configuration.FieldMapping">
  <Item Name="COMPANY" Value="Peter Engineering" />
  <Item Name="STATUS" Value="Export" />
</Object>

La valeur de l'attribut name correspond au nom de base de données du champ DocuWare en majuscules (voir les propriétés du champ concerné dans DocuWare Configuration).

Des caractères spéciaux comme ont parfois été utilisés lors de la création du champ. Saisissez-les ici également, par exemple Name=”COMPANY

L'attribut value peut être une valeur fixe, une partie d'une valeur fixe avec * comme caractère générique, ou une variable connue de DocuWare telle que EMPTY() ou NOTEMPTY(). Les options de saisie correspondent à la boîte de dialogue de recherche générale de DocuWare Configuration, par exemple pour les filtres d'armoire.

Pour des opérations de recherche plus élaborées, reportez-vous à l'article consacré aux Filtres de recherche avancés.

Recherche alternative dans une base de données SQL pour les systèmes sur site

Cette recherche n'est nécessaire que dans des cas particuliers, par exemple lorsque le nombre de résultats attendus dépasse 10 000 documents ou lorsqu'une comparaison avec une autre base de données est requise.

Pour utiliser ce mode de recherche, les paramètres suivants doivent être configurés

SqlConnectionString

Une chaîne de connexion SQL vers la base de données utilisée. Dans la plupart des cas, il s'agit de la base de données DocuWare. Vous trouverez divers exemples de chaînes de connexion, par exemple sur https://connectionstrings.com

docXporter ne prend en charge que les bases de données Microsoft SQL Server.

SqlSearchQuery

L'instruction select sous forme de requête SQL permettant de déterminer les documents à exporter. La requête doit contenir le champ DWDOCID. De plus, tous les champs nécessaires au nom de fichier et au nom de dossier doivent être indiqués explicitement.

Export

docXporter prend en charge différentes options d'export des documents depuis DocuWare. Celles-ci sont définies par le réglage ExportMode

ExportMode

Indiquez le format dans lequel les documents seront enregistrés dans le système de fichiers après l'export. Tenez compte des majuscules et des minuscules.

Disabled

Désactive l'export des documents.

Remarque : permet d'exporter uniquement les données d'index (voir IndexFileMode)

Pdf

Export au format PDF

PdfWithAnnotations

Export au format PDF avec annotations. Correspond à la fusion des annotations

Tiff

Export au format Tiff ; voir ci-dessous pour d'autres réglages

TiffWithAnnotations

Export au format Tiff avec annotations. Correspond à la fusion des annotations

OriginalFormat

Export du document au format d'origine.

Un document attaché est exporté sous forme de plusieurs fichiers, et un index est ajouté au nom de fichier.

OriginalFormatZipped

Export au format d'origine, regroupé dans un fichier zip

ExportCoverage

Définit la partie du document à exporter.

All

Par défaut. Export du document entier

FirstSection

Export de la première section uniquement

LastSection

Export de la dernière section uniquement

SectionIndex

Export des sections portant un index donné uniquement, tel que défini dans le réglage SectionIndex. Tous les documents à exporter doivent comporter une section avec cet index.

SectionIndex

L'index de la section à exporter. Pour que ce réglage soit pris en compte, la valeur SectionIndex doit être définie dans le réglage ExportCoverage.

ExportPath

Définit le dossier vers lequel les documents doivent être exportés. Exemple : C:\Export\ (un chemin UNC est possible). Si le dossier n'existe pas, il est créé. Vous pouvez aussi utiliser ici les valeurs d'index du document en indiquant le nom du champ entre accolades, par exemple {COMPANY}. Comme pour les autres réglages, le nom du champ est indiqué selon le nom de base de données du champ DocuWare.

Exemple : C:\Export\{COMPANY}\

Le ExportPath peut également contenir des parties d'un champ de date DocuWare, par exemple le mois ou l'année. Après le nom du champ, le format de date conforme à .NET est indiqué après deux-points, par exemple {DATE:MMMM} pour le nom complet du mois, ou {DATE:yy} pour une année à deux chiffres.

Si le mois et l'année sont tous deux utilisés dans un chemin d'export, l'information est saisie en une seule fois.

Exemple : C:\Export\{DATE:yyyy\\MMMM}\{COMPANY}\

Résultat : C:\Export\2021\January\Peters Engineering\

FileName

Définit la structure du nom du fichier exporté. Vous pouvez utiliser à la fois des valeurs fixes et des valeurs d'index du document. Pour les valeurs d'index, le nom du champ est indiqué entre accolades, par exemple {COMPANY} ou {DWDOCID}. Comme pour les autres réglages, le nom du champ est indiqué selon le nom de base de données du champ DocuWare. Les fichiers sont exportés au format PDF par défaut.

Utilisez un nom de fichier unique afin d'éviter tout écrasement accidentel. Dans certaines circonstances, des documents différents peuvent recevoir le même nom de fichier lors de l'export, à savoir lorsque les deux documents contiennent la même valeur dans les champs d'index à partir desquels le nom de fichier est constitué. Dans ce cas, le document déjà exporté est écrasé.

Cela vaut en particulier pour la cible d'export MergedPdf.

TiffCompression

Indiquez la compression utilisée pour enregistrer les fichiers Tiff. Elle influe sur la qualité et la taille du fichier. Les valeurs suivantes sont disponibles :

  • JPEG : recommandé pour les documents en couleur et les documents en niveaux de gris

  • CcittGroup4 : recommandé pour les documents en noir et blanc

TiffResolution

Indiquez la résolution du Tiff. Plus la valeur est élevée, meilleure peut être la qualité ; toutefois, la taille du fichier risque d'augmenter avec des valeurs élevées.

Une fois l'export d'un document terminé, il convient de mettre à jour les données d'index du document afin d'éviter de l'exporter à nouveau.

DWArchivUpdateIndex

Contient les valeurs d'index à modifier après l'export afin d'exclure les documents exportés du filtre d'export. La configuration fonctionne fondamentalement de la même manière que pour DWArchivFilter.

La syntaxe générale du réglage DWArchivUpdateIndex se présente comme suit. Une ligne Item supplémentaire doit être ajoutée pour chaque champ DocuWare.

<Object Name="DWArchivUpdateIndex" Type="Docuscan.DocuwareExporter.Configuration.FieldMapping">
  <Item Name="STATUS" Value="Exported" />
</Object>

La valeur de l'attribut name correspond au nom de base de données du champ DocuWare en majuscules (que vous trouverez dans les propriétés du champ concerné, dans DocuWare Configuration). Des caractères spéciaux comme y figurent parfois lorsqu'ils ont été utilisés lors de la création du champ. Ils doivent eux aussi être saisis, par exemple : Name=”COMPANY

Exemple : <Item Name=“EXPORTED_” Value=“done” />. Value est soit une valeur fixe, soit une date relative telle que DATE(-1) pour la date de la veille.

Fichiers d'index

Lorsque des documents sont exportés, vous pouvez créer des fichiers supplémentaires contenant les données d'index des documents. Reportez-vous à l'article détaillé sur les fichiers d'index pour savoir comment créer des modèles.

IndexFileMode

Détermine si un fichier d'index doit être créé pour un document et comment il est créé. Les majuscules et les minuscules doivent être respectées.

Disabled

Ne pas créer de fichier d'index

Document

Créer un fichier d'index par document

ResultSet

Créer un fichier d'index contenant les données d'index de tous les documents exportés.

IndexFileNamePattern

Définit la structure du nom du fichier exporté. Vous pouvez utiliser à la fois des valeurs fixes et des valeurs d'index du document. Contrairement au réglage FileName (voir ci-dessus), l'extension de fichier doit être indiquée ici.

TemplateFile

Le chemin du fichier modèle. Si seul le nom de fichier est indiqué, le modèle est recherché dans le dossier C:\ProgramData\docXporter\Templates. Si un chemin est indiqué, il est utilisé directement.

Anciens réglages obsolètes

Vous pouvez trouver les réglages IndexFileDocumentTemplate et IndexFileRepetitionTemplate dans le fichier de configuration. Ce réglage est conservé pour des raisons de compatibilité et ne doit plus être utilisé. Utilisez plutôt un modèle pour les fichiers d'index.

Regrouper des documents dans un fichier ZIP ou un PDF fusionné

Outre l'export des documents vers un dossier du système de fichiers, les documents peuvent également être exportés vers un ou plusieurs fichiers ZIP. Selon les besoins, les documents peuvent aussi être répartis sur plusieurs fichiers.

ExportTarget

Détermine si l'export est effectué vers un fichier ZIP ou un dossier du système de fichiers.

Folder

Export vers le dossier ExportPath

ZipFile

Les documents exportés sont regroupés dans un ou plusieurs fichiers ZIP, qui sont ensuite enregistrés dans le dossier ExportPath.

MergedPdf

Les documents exportés sont regroupés dans un seul fichier PDF, qui est enregistré dans le dossier ExportPath. Le ExportMode est automatiquement défini sur Pdf lorsqu'un ExportMode autre que Pdf ou PdfWithAnnotations est défini.

GroupFileNamePattern

Indiquez ici le modèle à partir duquel le nom du fichier de sortie doit être créé.

Il n'est pas nécessaire d'indiquer l'extension de fichier ici, car celle-ci est attribuée automatiquement. Selon la cible d'export sélectionnée, l'extension est .zip ou .pdf

Les fichiers sont mis à disposition dans le dossier défini dans le réglage ExportPath.

Lors de la création d'un fichier zip, la structure des noms de fichiers des documents au sein du fichier zip est définie via le réglage FileName.

Exemple : {CUSTOMER_NUMBER}

GroupPath

Pour regrouper les documents, ce réglage permet de créer un regroupement à partir d'un ou de plusieurs termes d'index.

La valeur définie ici est ajoutée au chemin temporaire généré en interne afin de regrouper les documents concernés dans les fichiers ZIP prévus une fois l'export terminé, ou de générer un PDF fusionné à partir de ces fichiers.

Exemple : {COMPANY}\{CUSTOMER_NUMBER} selon cet exemple, des fichiers ZIP sont créés contenant les documents qui partagent la même valeur dans les champs d'index COMPANY et CUSTOMER_NUMBER.

Tampons

Si le tampon contient des champs portant le même nom (libellé) que les noms de base de données des champs d'index du document sur lequel il doit être apposé, ces champs sont automatiquement renseignés avec les valeurs d'index du  correspondant.

Pour utiliser l'ID de document DocuWare dans un tampon, utilisez le libellé DWDOCID pour le champ du tampon.

Exécuter une configuration

Une fois l'application entièrement configurée, vous pouvez la démarrer.

Pour ce faire, exécutez simplement docXporter.exe. S'il est exécuté sans autre paramètre, tous les fichiers de configuration sont traités.

Si vous ne souhaitez pas traiter une configuration donnée, vous pouvez la supprimer ou la renommer. Attribuez-lui simplement une extension de fichier différente de votre choix, par exemple :

invoices.xml.disable

Peu importe l'extension utilisée à cet effet. Elle ne doit simplement pas être « .xml ».

Si l'appel est effectué avec le paramètre docXporter.exe -c "Configuration name", seule la configuration correspondante est traitée. Le nom de la configuration est identique au nom du fichier de configuration sans son extension.

L'application consigne les différentes étapes de traitement en tant que sortie dans la fenêtre de console et dans un fichier journal. Il peut être utile d'examiner attentivement la sortie du programme, en particulier lors des premiers tests.

Pour automatiser le traitement ou l'exécution, docXporter.exe peut être lancé via le « Planificateur de tâches » de Windows, selon les possibilités qu'il offre, à différents moments ou en réponse à différents événements.

Paramètres de ligne de commande avancés

docXporter peut également être appelé avec des paramètres de ligne de commande. Vous pouvez ainsi définir d'autres critères de recherche, effectuer une recherche dans différentes armoires ou attribuer une valeur différente aux valeurs d'index.

Cette fonctionnalité est utile lorsque vous souhaitez appeler docXporter depuis des applications tierces et définir dynamiquement les documents à sélectionner.

-help

Appelle la page d'aide et n'effectue aucun traitement.

-q “FELDNAME=value”

Un terme de recherche supplémentaire qui complète ou remplace les valeurs du fichier de configuration.

-u “FELDNAME=value”

Une mise à jour d'index supplémentaire qui complète ou remplace les valeurs du fichier de configuration.

-fc GUID

Le GUID d'une armoire peut être indiqué ici. Il remplace le réglage du fichier de configuration.

-sd GUID

Le GUID d'un masque de recherche peut être indiqué ici. Il remplace le réglage du fichier de configuration.

Les paramètres -q et -u permettent d'indiquer plusieurs champs et valeurs. Ceux-ci sont séparés par le caractère dièse #.

Exemple : -q “CUSTOMER=Peters Engineering#STATUS=New”

Exemple de cas d'usage

docXporter est utilisé pour exporter toutes les factures du trimestre en cours qui n'ont pas encore été exportées.

Voici ce qui est indiqué dans le fichier de configuration :

<setting name="DWArchivFilter" serializeas="Xml">
 <value>
   <arrayofstring xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
     <string>DOCUMENT_DATE=SEARCH_QUARTER()</string>
     <string>DOCUMENT_TYPE=Invoice</string>
     <string>STATUS=NOT Exported</string>
   </arrayofstring>
  </value>
</setting>

Désormais, au lieu des factures, ce sont les avoirs du trimestre en cours qui doivent être exportés, pour le client « Peters Engineering ». De plus, le champ Status doit être défini sur « Exported ».

Les paramètres suivants sont indiqués :

DocXporter.exe -q “DOCUMENT_TYPE=Invoice#CUSTOMER=Peters Engineering” -u “STATUS=Exported”

Comme DOCMENT_DATE a déjà été correctement défini dans la configuration, il n'est pas nécessaire de l'indiquer à nouveau.

Journalisation

Toutes les activités du programme peuvent être consignées dans un fichier journal. Le répertoire des journaux se trouve sous C:\ProgramData\docXporter\Logs. Par défaut, un fichier journal est créé par jour et 30 fichiers sont conservés. Dès que ce nombre de fichiers journaux historiques est atteint, le fichier le plus ancien est supprimé.

Au départ, seules les informations et les erreurs sont consignées. Si davantage de détails sont nécessaires, par exemple pendant la phase de test, le niveau de journalisation peut être augmenté à DEBUG.

Le niveau de détail de la journalisation se définit lui aussi dans docXporter.exe.config. Recherchez le bloc suivant et remplacez le texte INFO par DEBUG :

<root>
  <level value="INFO" />
</root>

Versions prises en charge : DocuWare Cloud + 7.14 + 7.13 + 7.12 + 7.11 + 7.10