Définition de propriétés de document personnalisées

Les propriétés de document personnalisées permettent d'extraire des données de chaque document d'un travail. Définissez d'abord les propriétés de document personnalisées dans RICOH ProcessDirector, puis mappez les données des documents aux propriétés de document. Alors qu'un travail parcourt le flot de travaux, l'étape IdentifyPDFDocuments (fichiers PDF) ou IdentifyDocuments (fichiers AFP) extrait les données.

Identifiez les données à extraire des documents. Si RICOH ProcessDirector fournit une propriété de document appropriée, utilisez-la au lieu de définir une propriété de document personnalisée.

Par exemple, vous souhaitez extraire le numéro de compte, le nom du client, l'adresse e-mail et la date du relevé de chacun des documents figurant dans le travail. RICOH ProcessDirector fournit une propriété de document, Adresse e-mail, pour l'extraction des adresses e-mail. Définissez des propriétés de document personnalisées pour le numéro de compte, le nom du client et la date du relevé.

    Remarque:
  • Si vous utilisez des propriétés de document personnalisées, à partir de la version 3.11.2, vous pouvez les créer dans l'onglet Administration, via Objets ⇒ Propriétés personnalisées.

    Vous pouvez choisir le nom de la base de données et l'intitulé qui s'affiche dans les blocs-notes de propriétés et les en-têtes de colonnes. Vous pouvez également déterminer le type de données à stocker dans la propriété, ainsi que l'accès par défaut accordé aux différents groupes d'utilisateurs pour la propriété, sans les ajouter au fichier docCustomDefinitions.xml.

    Pour plus d'informations, consultez les rubriques relatives à Propriétés personnalisées de travail et de document et Création et activation de propriétés personnalisées.

  • Si votre fichier docCustomDefinitions.xml contient déjà des propriétés de document personnalisées, vous pouvez continuer à les utiliser. Ne les recréez pas à partir de l'onglet Administration. N'utilisez cet onglet que pour créer de nouvelles propriétés de travail ou de document.
  • Si vous souhaitez utiliser la nouvelle fonction disponible sur RICOH ProcessDirector dans la version 3.11.2 afin de créer une propriété personnalisée :
Pour définir de propriétés de document personnalisées :
  1. Choisissez le type de propriété de document personnalisée :
    • Propriété de base de données
    • Propriété limitée

    Pour plus d'informations sur le fichier docCustomDefinitions.xml, voir Fichier docCustomDefinitions.xml.

  2. Choisissez un nom (interne) de base de données pour la propriété de document personnalisée.

    Par exemple, définissez une propriété de document personnalisée avec le nom de base de données Doc.Custom.AccountNumber.

      Remarque:

    • Nous vous recommandons d'attribuer aux bases de données de vos propriétés de document personnalisées des noms commençant par Doc.Custom. Si vous n'utilisez pas cette convention de dénomination, vérifiez qu'aucune de vos propriétés de document personnalisées ne porte le même nom de base de données qu'une propriété de document fournie par RICOH ProcessDirector.

    • Ne placez pas de chiffre immédiatement après le point (.) dans le nom de la base de données. Par exemple, le nom de la base de données Doc.3rdLineAddress n'est pas valide.

    • Ne supprimez pas les propriétés de document personnalisées après les avoir ajoutées au fichier docCustomDefinitions.xml.

    • Ne modifiez pas le nom (nom de base de données), le type de données ou le type de base de données d'une propriété de document personnalisée. Le système vous permet de modifier la légende (nom d'interface utilisateur), la courte légende, la description et l'accès.

  3. Choisissez un nom d'interface utilisateur (légende) pour la propriété de document personnalisée.

    Par exemple, définissez une propriété de document personnalisée avec le nom d'interface utilisateur Numéro de compte.

      Remarque:
    • Nous vous recommandons de ne pas définir de propriété de document personnalisée avec le même nom d'interface utilisateur qu'une propriété de document fournie par RICOH ProcessDirector.
  4. Choisissez un type de données (dataType) pour la propriété de document personnalisée.

    Les exemples incluent String, Integer, IntegerNonNeg et Timestamp.

  5. Pour les propriétés de base de données :
    1. Choisissez un type de base de données (dbType).

      Pour le type de données String, les types de base de données sont char, varchar et long varchar.

      Pour le type de données Integer, les types de base de données sont smallint, bigint et integer.

      Pour le type de données Timestamp, le type de base de données est Timestamp.

    2. Choisissez le niveau d'accès à la propriété de document personnalisée accordé aux utilisateurs :

      • attrWriteAdmin

        Les membres du groupe de sécurité Administrateur disposent d'un accès en écriture. Les membres des groupes de sécurité Moniteur, Opérateur et Superviseur disposent d'un accès en lecture.

      • attrWriteAdminSuper

        Les superviseurs et les administrateurs disposent d'un accès en écriture. Les moniteurs et les opérateurs disposent d'un accès en lecture.

      • attrWriteAdminSuperOper

        Les opérateurs, les superviseurs et les administrateurs disposent d'un accès en écriture. Les moniteurs disposent d'un accès en lecture.

      Si vous ne spécifiez aucun niveau d'accès, les administrateurs disposent d'un accès en écriture. Les moniteurs, les opérateurs et les superviseurs disposent d'un accès en lecture.

        Remarque:
      • Si vous avez créé vos propres groupes de sécurité, ceux-ci bénéficient du même accès aux propriétés de document personnalisées que les groupes de sécurité RICOH ProcessDirector que vous avez copiés pour les créer.

    3. Choisissez une courte légende.

      Cette courte légende s'affiche dans les en-têtes de colonne du tableau.

      Par exemple, définissez une propriété de document personnalisée avec la courte légende N° compte.

    4. Choisissez une description.

      L'interface utilisateur affiche la description comme une aide sur la propriété de document personnalisée.

      Par exemple, définissez une propriété de document personnalisée avec la description N° de compte client.

  6. Éditiez le fichier de configuration des propriétés de document :
    • La première fois que vous définissez des propriétés de document personnalisées, effectuez une copie du fichier fourni en exemple. Accédez au répertoire suivant :

      • /aiw/aiw1/samples/config sous Linux

      • C:\aiw\aiw1\samples\config sous Windows

    • Lorsque vous définissez des propriétés de document supplémentaires, effectuez une copie du fichier actif. Accédez au répertoire suivant :

      • /aiw/aiw1/config sous Linux

      • C:\aiw\aiw1\config sous Windows

  7. Copiez le fichier docCustomDefinitions.xml dans un répertoire de travail, puis éditez le fichier.

    Conservez une copie de sauvegarde du fichier édité pour les opérations de récupération.

    Par exemple, ces lignes ajoutent deux propriétés de document de base de données avec les noms de base de donnée Doc.Custom.AccountNumber et Doc.Custom.StatementDate au fichier : 

    <docProperty name="Doc.Custom.AccountNumber"
   datatype="String"
   dbType="varchar (32)"
   access="attrWriteAdmin"
   shortCaption="Acount number"
   caption="Account number"
   description="Customer account number"/>

<docProperty name="Doc.Custom.StatementDate"
   datatype="Timestamp"
   dbType="Timestamp"
   access="attrWriteAdmin"
   shortCaption="Statement date"
   caption="Statement date"
   description="The date the statement was created"/>
      Remarque:
    • La ligne name définit le nom de la base de données. La ligne caption définit le nom de l'interface utilisateur.

    Ces lignes ajoutent deux propriétés de document limitées avec les noms internes Doc.Custom.SSNumber et Doc.Custom.CheckAmt au fichier :

    <limitedProperties>

   <docProperty name="Doc.Custom.SSNumber"
      datatype="String"
      caption="Social Security number"/>

   <docProperty name="Doc.Custom.CheckAmt"
      datatype="String"
      caption="Check total"/>

</limitedProperties>
  8. Validez votre syntaxe à l'aide d'un éditeur XML.
  9. Copiez le fichier édité dans le répertoire :
    • /aiw/aiw1/config/docCustomDefinitions.xml (Linux)
    • C:\aiw\aiw1\config\docCustomDefinitions.xml (Windows)
  10. Pour que les nouvelles propriétés du document s'affichent correctement dans l'interface utilisateur, modifiez le fichier docCustomDefinitions.properties pour une ou plusieurs langues. Si vous ne définissez pas d'étiquettes pour les nouvelles propriétés dans ce fichier, vous ne verrez que les noms de base de données pour les propriétés sur l'interface utilisateur. Voir Attribution de noms aux propriétés de document personnalisées en plusieurs langues pour les étapes de modification du fichier.
  11. Mettez les propriétés de document personnalisées que vous avez définies à la disposition de RICOH ProcessDirector :
    1. Exécutez l'utilitaire docCustom.
      Lors de la première exécution de l'utilitaire docCustom, il crée la fonction Propriétés de document personnalisées et l'ajoute à Feature Manager. Lors de l'exécution suivante, il ajoute une fonction Propriétés de document personnalisées mise à jour à Feature Manager.
    2. Utilisez Feature Manager pour installer ou mettre à jour la fonction Propriétés de document personnalisées.
  12. Chargez les propriétés de document personnalisées mises à jour RICOH ProcessDirector dans l'outil que vous utilisez pour configurer les propriétés personnalisées :
    • Si vous disposez de la fonction Prise en charge document PDF, chargez les propriétés de document RICOH ProcessDirector dans Plug-in RICOH ProcessDirector pour Adobe Acrobat.

      Pour plus d'informations, consultez la rubrique correspondante du centre de documentation.

    • Si vous disposez de la fonction Prise en charge AFP, utilisez l'une des méthodes ci-après pour lancer RICOH Visual Workbench :

      • Lancez RICOH Visual Workbench à partir du serveur RICOH ProcessDirector.

      • Remplacez l'application RICOH Visual Workbench sur votre bureau :

        • Supprimez le fichier VisualWorkbench.zip, ainsi que tous les fichiers décompressés.

        • Téléchargez le fichier VisualWorkbench.zip à partir de l'interface utilisateur RICOH ProcessDirector.

        • Décompressez le fichier, puis lancez la nouvelle application de bureau RICOH Visual Workbench.

      Les propriétés de document sont automatiquement chargées.

Related information:

Fichier docCustomDefinitions.xml
Considérations relatives à un système à plusieurs langues
Mise à jour des propriétés de document personnalisées
Attribution de noms aux propriétés de document personnalisées en plusieurs langues
Configuration de la synchronisation manuelle des travaux
Rubrique parente : Installation de la fonction sur l'ordinateur principal RICOH ProcessDirector