Fichier docCustomDefinitions.xml
Le fichier de configuration des propriétés de document (
docCustomDefinitions.xml) définit les propriétés utilisées pour gérer des documents. Le processus d'installation
place un modèle de fichier dans /aiw/aiw1/samples/config sous systèmes d'exploitation UNIX et dans C:\aiw\aiw1\samples\config sous Windows.
- Remarque:
- Si vous modifiez le fichier
docCustomDefinitions.xmlaprès l'installation de Pool de documents avancé, Prise en charge AFP ou Prise en charge document PDF :- Exécutez l'utilitaire
docCustom, puis installez ou mettez à niveau la fonction Propriétés de document personnalisées. - Pour la fonction Prise en charge document PDF, chargez les propriétés de document dans Plug-in RICOH ProcessDirector pour Adobe Acrobat.
- Pour la fonction Prise en charge AFP, accédez à RICOH Visual Workbench à partir de l'interface utilisateur RICOH ProcessDirector. Les nouvelles propriétés de document sont chargées dans RICOH Visual Workbench lorsqu'il s'ouvre sur votre poste de travail.
- Exécutez l'utilitaire
Propriétés de base de données et propriétés limitées
Vous pouvez définir deux types de propriétés de document :
- Propriétés de base de données
- Propriétés interdites
Vous pouvez stocker et manipuler ces deux types de propriétés dans un fichier de propriétés de document, mais seules les propriétés de base de données sont stockées dans la base de données.
Vous pouvez utiliser les deux types de propriétés comme suit :
- Vous pouvez les utiliser avec des étapes dans un flot de travaux pour regrouper ou trier des documents (par exemple, avec le modèle d'étape SortDocuments).
- Vous pouvez les associer à des repères d'indexation AFP à l'aide de RICOH Visual Workbench Document Property Designer.
- Vous pouvez mapper les données des documents des travaux PDF sur ces propriétés à l'aide de Plug-in RICOH ProcessDirector pour Adobe Acrobat.
- Si vous disposez de la fonction Archive vous pouvez les stocker dans un référentiel. Une fois stockées, vous pouvez les utiliser pour faire des recherches dans le référentiel et récupérer des travaux, des documents, et des informations sur l'historique. Les valeurs des propriétés apparaissent dans l'onglet Propriétés lorsque vous cliquez sur Afficher les détails dans la table des résultats.
- Si vous disposez de la fonction Gestion des préférences, vous pouvez utiliser un fichier de préférences externe pour définir les valeurs des propriétés.
Vous pouvez utiliser les propriétés de base de données, mais pas les propriétés limitées, comme suit :
- Vous pouvez les utiliser pour rechercher des documents sur le portlet Documents sur la page Page principale de l'interface utilisateur.
- Lorsque vous sélectionnez un document sur le portlet Documents, les valeurs des propriétés de base de données apparaissent.
- Vous pouvez les utiliser pour rechercher des documents à afficher dans le visualiseur.
- Vous pouvez déterminer leurs valeurs dans un travail, les mettre à jour dans un autre travail et utiliser les valeurs mises à jour dans le travail d'origine.
- Si vous disposez des fonctions Vérification automatique ou Mise sous pli, vous pouvez utiliser les propriétés de base de données pour rechercher des documents à synchroniser ou réimprimer.
- Si vous disposez de la fonction d'extension Pool de documents avancé, vous pouvez utiliser les sélecteurs pour manipuler des documents suivant leurs valeurs de propriété.
Les propriétés limitées offrent les avantages suivants :
- Vous pouvez les utiliser pour éviter d'afficher des valeurs de propriétés confidentielles dans l'interface utilisateur, telles que les numéros de sécurité sociale ou les montants des chèques.
- Elles optimisent les performances du système. La manipulation de propriétés de base de données peut altérer les performances si vous traitez un grand nombre de documents.
Contactez le responsable de l'assistance technique pour déterminer vos besoins en termes de propriétés de document de base de données et limitées.
Sections du fichier d'exemple
Le fichier d'exemple docCustomDefinitions.xml contient plusieurs sections. Ce tableau les résume.
du fichier docCustomDefinitions.xml.
| section | Objet |
|---|---|
| schema | La section Schéma identifie le schéma et la chaîne de caractères unique des propriétés de document personnalisées. Seul le responsable de l'assistance technique peut modifier cette section. |
| Propriétés de base de données | Cette section définit les propriétés de document de base de données. |
| Propriétés interdites | Cette section définit les propriétés de document limitées. |
| Propriétés d'autorisation utilisateur | Cette étape est facultative. Les propriétés d'autorisation utilisateur spécifient des groupes de droits d'accès personnalisés pour l'accès aux propriétés de base de données. |
Section d'attache
La section Schéma contient un élément docCustomDefinitions et un élément schema. Seuls les responsables de l'assistance technique peuvent modifier la section Schéma.
Section Propriétés de base de données
La section Propriétés de base de données contient l'élément docProperty.
- Remarque:
- Ne définissez pas de propriété en tant que propriété de base de données et propriété limitée. Vous risqueriez d'obtenir des résultats inattendus.
- Ne définissez pas une propriété de document avec le même nom qu'une propriété que RICOH ProcessDirector définit automatiquement. Pour obtenir une liste, voir Propriétés de document définies automatiquement.
- <docProperty>
- Définit les propriétés de document qui sont dans la base de données.
Attributs pour l'élément docProperty
Attribut docProperty Obligatoire ? Remarques nom Oui Nom de base de données (nom interne) pour la propriété. Les programmes qui lisent ou écrivent les propriétés utilisent ce nom. Nous recommandons d'utiliser une convention de dénomination cohérente pour les noms de propriété personnalisée afin d'obtenir des noms uniques dans tout le système. Par exemple, le modèle de fichier docCustomDefinitions.xml utilise le préfixe Doc.Custom afin de distinguer ses propriétés de celles du produit de base. N'utilisez ni espaces, ni caractères spéciaux (tels que @, #, $, % ou - (tiret)) pour le nom de la propriété. Vous pouvez, en revanche, utiliser des points et des traits de soulignement.
Ne placez pas de chiffre immédiatement après le point (.) dans le nom de la base de données des propriétés. Par exemple, la propriété Doc.3rdLineAddress n'est pas valide.
access Non Niveau d'accès de l'utilisateur pour la propriété. Vous pouvez utiliser un niveau d'accès déjà défini dans le produit ou créer un niveau d'accès personnalisé si les niveaux existants ne répondent pas à vos besoins. Pour plus d'informations, consultez la section Accès. datatype Oui Type de données à utiliser pour la propriété. Voir le tableau suivant. dbType Non Paramètre de base de données indiquant le type des données. - Remarque:
- La propriété dbType est obsolète et n'est plus utilisée. Utilisez la propriété datatype à la place.
caption Oui Nom de l'interface utilisateur (légende par défaut) pour la propriété. Si vous créez les légendes dans une seule langue, définissez-les dans ce fichier. Si vous définissez les noms d'interfaces utilisateur dans plusieurs langues, vous devez créer des fichiers de noms de propriétés de document supplémentaires (docCustomDefinitions_langue.properties) pour les autres langues. shortCaption Oui Courte légende par défaut affichée pour cette propriété, le cas échéant, comme dans les en-têtes de colonne de tableau. Si vous créez les courtes légendes dans une seule langue, définissez-les dans ce fichier. Si vous définissez les courtes légendes dans plusieurs langues, vous devez créer des fichiers de noms de propriétés de document supplémentaires (docCustomDefinitions_langue.properties) pour les autres langues. description Oui Description par défaut de la propriété de document qui apparaît dans l'interface utilisateur sous la forme de texte d'aide. Si vous créez les descriptions dans une seule langue, définissez-les dans ce fichier. Si vous définissez les descriptions dans plusieurs langues, vous devez créer des fichiers de noms de propriétés de document supplémentaires (docCustomDefinitions_langue.properties) pour les autres langues. Nous recommandons d'utiliser les types de données et les types de base de données suivants dans les définitions de propriété : Gardez à l'esprit que la définition de base de données peut limiter encore les valeurs pouvant être stockées, en plus des règles de validation indiquées dans ce tableau. Par exemple, une valeur SMALLINT peut stocker des entiers compris entre 0 et 32 767. Les valeurs de types de base de données ne font pas la distinction entre les majuscules et les minuscules.
Types de données et types de base de données recommandés pour les définitions de propriété
Type de données Type de base de données (utilisé dans SQL) Validation pour le type de données Chaîne VARCHAR(128) VARCHAR : longueur variable, 1 à 128 caractères IntegerNonNeg SMALLINTBIGINTINTEGER SMALLINT 2 octetsBIGINT: 4 octetsINTEGER: 8 octetsMinimum=0 Horodatage TIMESTAMP TIMESTAMP: Doit contenir des valeurs pour le jour (D), le mois (M), et l'année (Y).Ces composants peuvent apparaître sous l'un des formats suivants :MM DD YYYYDD MM YYYYYYYY MM DDLe jour et le mois doivent chacun être représentés par un nombre à deux chiffres.Vous pouvez ajouter une heure au format suivant :hh:mm:ss XdkString10 VARCHAR(10) VARCHAR : longueur variable, 1 à 10 caractères - Remarque:
- Ces valeurs sont des variations du type de données String qui peuvent être utilisées à la place de la chaîne afin de réduire la quantité d'espace réservé dans la base de données pour les valeurs de propriété.
XdkString20 VARCHAR(20) VARCHAR : longueur variable, 1 à 20 caractères - Remarque:
- Ces valeurs sont des variations du type de données String qui peuvent être utilisées à la place de la chaîne afin de réduire la quantité d'espace réservé dans la base de données pour les valeurs de propriété.
XdkString30 VARCHAR(30) VARCHAR : longueur variable, 1 à 30 caractères - Remarque:
- Ces valeurs sont des variations du type de données String qui peuvent être utilisées à la place de la chaîne afin de réduire la quantité d'espace réservé dans la base de données pour les valeurs de propriété.
XdkString40 VARCHAR(40) VARCHAR : longueur variable, 1 à 40 caractères - Remarque:
- Ces valeurs sont des variations du type de données String qui peuvent être utilisées à la place de la chaîne afin de réduire la quantité d'espace réservé dans la base de données pour les valeurs de propriété.
XdkString50 VARCHAR(50) VARCHAR : longueur variable, 1 à 50 caractères - Remarque:
- Ces valeurs sont des variations du type de données String qui peuvent être utilisées à la place de la chaîne afin de réduire la quantité d'espace réservé dans la base de données pour les valeurs de propriété.
XdkString128 VARCHAR(128) VARCHAR : longueur variable, 1 à 128 caractères - Remarque:
- Ces valeurs sont des variations du type de données String qui peuvent être utilisées à la place de la chaîne afin de réduire la quantité d'espace réservé dans la base de données pour les valeurs de propriété.
Section Propriétés limitées
La section Propriétés limitées contient un ou plusieurs éléments docProperty.
- Remarque:
- Ne définissez pas de propriété en tant que propriété de base de données et propriété limitée. Vous risqueriez d'obtenir des résultats inattendus.
- Ne définissez pas une propriété de document avec le même nom qu'une propriété que RICOH ProcessDirector définit automatiquement. Pour obtenir une liste, voir Propriétés de document définies automatiquement.
- <docProperty>
- Identifie les propriétés de document ou les propriétés du travail situées dans le
fichier de propriétés de document mais pas dans la base de données.
Attributs pour l'élément docProperty
Attribut docProperty Obligatoire ? Remarques nom Oui Nous recommandons d'utiliser une convention de dénomination cohérente pour les noms de propriété personnalisée afin d'obtenir des noms uniques dans tout le système. Par exemple, le modèle de fichier docCustomDefinitions.xml utilise le préfixe Doc.Custom pour que ses propriétés aient un nom unique par rapport à celui du produit de base. N'utilisez ni espaces, ni caractères spéciaux (tels que @, #, $, % ou - (tiret)) pour le nom de la propriété. Vous pouvez, en revanche, utiliser des points et des traits de soulignement.
Ne placez pas de chiffre immédiatement après le point (.) dans le nom de la base de données des propriétés. Par exemple, la propriété Doc.3rdLineAddress n'est pas valide.
datatype Non Voir le tableau suivant. caption Non Légende affichée dans les listes déroulantes de l'interface utilisateur pour cette propriété. Si vous créez les légendes dans une seule langue, définissez-les dans ce fichier. Si vous définissez les légendes dans plusieurs langues, vous devez créer un fichier de noms de propriétés de document (docCustomDefinitions_langue.properties) pour les autres langues. Pour plus de détails, consultez la rubrique associée du centre de documentation. Vous pouvez utiliser ces types de données dans les définitions docProperty :
Attributs pour l'élément docProperty
Type de données Validation pour le type de données Chaîne Néant
IntegerNonNeg Entier compris entre 0 et 2147483647
Horodatage TIMESTAMP: Doit contenir des valeurs pour le jour (D), le mois (M), et l'année (Y).Ces composants peuvent apparaître sous l'un des formats suivants :MM DD YYYYDD MM YYYYYYYY MM DDLe jour et le mois doivent chacun être représentés par un nombre à deux chiffres.Vous pouvez ajouter une heure au format suivant :hh:mm:ss
Section Propriétés d'autorisation utilisateur
La section Propriétés d'autorisation utilisateur est facultative. Les propriétés d'autorisation utilisateur spécifient des groupes de droits d'accès personnalisés pour l'accès aux propriétés de base de données. Cette section contient un ou plusieurs éléments access.
- <access>
- Permet de définir la capacité de lire ou d'éditer des propriétés personnalisées. Utilisez
ces niveaux d'accès dans l'élément docProperty. Vous pouvez utiliser l'un des groupes
de sécurité par défaut fournis par RICOH ProcessDirector, ou définir votre propre groupe. Les attributs sont les suivants :Voici les niveaux d'accès et les autorisations par défaut fournis par RICOH ProcessDirector :
Attributs pour l'élément access
Attribut access Remarques nom Nom du niveau d'accès. groupAttributeAccess Capacité du groupe d'utilisateurs de lire ou d'éditer l'attribut. Niveaux d'accès et autorisations par défaut
Nom d'accès Nom du groupe Niveau d'accès générique AnyAuthenticated Accès de l'attribut : lecture Opérateur Accès de l'attribut : lecture Superviseur Accès de l'attribut : lecture Administrateur Accès de l'attribut : écriture attrWriteAdmin Opérateur Accès de l'attribut : lecture Superviseur Accès de l'attribut : lecture Administrateur Accès de l'attribut : écriture Tout le monde Accès de l'attribut : lecture Surveillance Accès de l'attribut : lecture attrWriteAdminSuper Opérateur Accès de l'attribut : lecture Superviseur Accès de l'attribut : écriture Administrateur Accès de l'attribut : écriture Tout le monde Accès de l'attribut : lecture Surveillance Accès de l'attribut : lecture attrWriteAdminSuperOper Opérateur Accès de l'attribut : écriture Superviseur Accès de l'attribut : écriture Administrateur Accès de l'attribut : écriture Tout le monde Accès de l'attribut : lecture Surveillance Accès de l'attribut : lecture actionAdmin Opérateur Accès de l'action : faux Superviseur Accès de l'action : faux Administrateur Accès de l'action : vrai Tout le monde Accès de l'action : faux Surveillance Accès de l'action : faux actionAdminSuper Opérateur Accès de l'action : faux Superviseur Accès de l'action : vrai Administrateur Accès de l'action : vrai Tout le monde Accès de l'action : faux Surveillance Accès de l'action : faux actionAdminSuperOper Opérateur Accès de l'action : vrai Superviseur Accès de l'action : vrai Administrateur Accès de l'action : vrai Tout le monde Accès de l'action : faux Surveillance Accès de l'action : faux
Propriétés de document définies automatiquement
Cette table liste les propriétés de document que RICOH ProcessDirector définit automatiquement durant l'installation. Ne définissez pas ces propriétés dans le fichier docCustomDefinitions.xml.
Propriétés de document définies automatiquement
| Nom de base de données de la propriété | Package avec... | Remarques |
|---|---|---|
| Doc.Address.1 | Postal Enablement | Spécifie la première ligne du bloc d'adresse dans le document. |
| Doc.Address.Company | Postal Enablement | Spécifie le nom de la société dans le document. |
| Doc.Address.PostalCode | Postal Enablement | Spécifie le code postal dans le document. |
| Doc.Address.ZipCode | Postal Enablement | Spécifie le code postal dans le document. |
| Doc.AV.ScanCount | Vérification automatique | Affiche le nombre de fois où le code barres d'un document est lu. |
| Doc.ChildJobID | Toutes les fonctions de traitement des documents | Un identifiant de regroupement dans les travaux enfant. Bien que la valeur soit initialement définie dans IdentifyDocuments ou IdentifyPDFDocuments, elle peut être mise à jour par toute étape qui modifie le fichier des propriétés du document, par exemple SplitDocuments ou CreateJobsFromDocuments. |
| Doc.CurrentFirstPage | Toutes les fonctions de traitement des documents | Numéro de page de la première page du document dans le fichier d'impression actuel. |
| Doc.CurrentJobID | Toutes les fonctions de traitement des documents | Numéro de travail associé. |
| Doc.CurrentPages | Toutes les fonctions de traitement des documents | Nombre de pages du document dans le travail actuel. |
| Doc.CurrentSequence | Toutes les fonctions de traitement des documents | Séquence du document dans le travail actuel. |
| Doc.CurrentSheets | Toutes les fonctions de traitement des documents | Nombre de feuilles du document dans le travail actuel. |
| Doc.Custom.MemberLevel | Electronic Presentment | Niveau d'appartenance du client au moment où le relevé a été créé. |
| Doc.Custom.PURL | Electronic Presentment | URL personnalisée permettant d'accéder à l'emplacement d'où le client peut extraire le relevé. |
| Doc.Custom.StatementDate | Electronic Presentment | Date de la première émission du relevé. |
| Doc.DataLen | Toutes les fonctions de traitement des documents | La taille en octets du document dans le fichier d'impression. |
| Doc.DataOffset | Toutes les fonctions de traitement des documents | Le déplacement d'octet du document dans le fichier d'impression du travail original. Cette valeur est utilisée par BuildAFPFromDocuments et CreateAFPJobsFromDocuments pour trouver l'AFP à extraire du travail original. |
| Doc.DocSize.PieceThickness | Postal Enablement | Spécifie l'épaisseur d'un courrier lorsqu'un travail contient plusieurs courriers de différentes épaisseurs. |
| Doc.DocSize.PieceWeight | Postal Enablement | Spécifie le poids d'un courrier lorsqu'un travail contient plusieurs courriers de différents poids. |
| Doc.Email.Sent | Toutes les fonctions de traitement des documents | Indique si un e-mail contenant une pièce jointe a été créé et envoyé au serveur SMTP par l'étape EmailDocuments du flot de travaux. |
| Doc.EmailAddress | Toutes les fonctions de traitement des documents | Adresse e-mail associée au document. |
| Doc.ID | Toutes les fonctions de traitement des documents | Identificateur unique du document. |
| Doc.Insert.BinTriggers | Module d'insertion | Bacs de mise sous pli devant fournir des encarts pour ce document. |
| Doc.Insert.DivertBin | Module d'insertion | Le numéro du bac de sortie de mise sous pli vers lequel ce document est réorienté après la mise sous pli. |
| Doc.Insert.OriginalBarCode | Module d'insertion | Données du code barres qui contrôlent la mise sous pli du document. |
| Doc.Insert.RecipientName | Module d'insertion | Le nom du destinataire du document. |
| Doc.Insert.ReprintJobId | Module d'insertion | Pour un travail de réimpression de mise sous pli, ID du travail parent qui a créé le travail. |
| Doc.Member.Number | Archive | Spécifie le numéro de membre dans le document. Le flot de travaux RepositorySample fourni utilise cette propriété. |
| Doc.OriginalFirstPage | Toutes les fonctions de traitement des documents | Numéro de page de la première page du document. |
| Doc.OriginalJobID | Toutes les fonctions de traitement des documents | ID de travail du travail d'origine. |
| Doc.OriginalPages | Toutes les fonctions de traitement des documents | Nombre de pages du document. |
| Doc.OriginalSequence | Toutes les fonctions de traitement des documents | Séquence du document dans le travail original. Le système donne au premier document la valeur de séquence 1, le document suivant a la valeur 2, et ainsi de suite. |
| Doc.OriginalSheets | Toutes les fonctions de traitement des documents | Nombre de feuilles requis pour imprimer le document. |
| Doc.Postal.AddressProcessingRC | Postal Enablement | Valeur renvoyée par un logiciel de courrier pour indiquer si un changement d'adresse existe pour le document. |
| Doc.Postal.Category | Postal Enablement | Spécifie la marque de division de la palette pour le document. |
| Doc.Postal.ChangeAddressRC | Postal Enablement | Spécifie le numéro de la palette pour le document. |
| Doc.Postal.ContainerBreakMark | Postal Enablement | Spécifie la marque de division du conteneur pour le document. |
| Doc.Postal.ContainerNumber | Postal Enablement | Spécifie le numéro du conteneur pour le document. |
| Doc.Postal.HandlingUnitBreakMark | Postal Enablement | Spécifie la marque de division du package pour le document. |
| Doc.Postal.HandlingUnitNumber | Postal Enablement | Spécifie le numéro du package pour le document. |
| Doc.Postal.PackageBreakMark | Postal Enablement | Spécifie le tarif d'affranchissement pour le document. |
| Doc.Postal.PackageNumber | Postal Enablement | Spécifie le code du tarif d'affranchissement pour le document. |
| Doc.Postal.PostageRate | Postal Enablement | Spécifie le numéro de séquence du pré-tri pour le document. |
| Doc.Postal.PostageRateCode | Postal Enablement | Valeur renvoyée par un logiciel de tri postal pour indiquer le résultat du traitement. |
| Doc.Postal.SequenceNumber | Postal Enablement | Séquence du document dans le travail d'origine. |
| Doc.Postal.SequencingProcessingRC | Postal Enablement | État du document. |
| Doc.Pref.Member | Gestion des préférences | Peut être utilisé avec un objet de mappage des propriétés pour identifier les documents d'un travail. L'objet de mappage des propriétés DelimitedSample fourni et le flot de travaux PreferencesSample fourni utilisent cette propriété. |
| Doc.Pref.Output | Gestion des préférences | Peut être utilisé avec un objet de mappage des propriétés pour indiquer le type de sortie (tel que E-mail, Imprimer ou Supprimer) pour un document. L'objet de mappage des propriétés DelimitedSample fourni et le flot de travaux PreferencesSample fourni utilisent cette propriété. |
| Doc.Pull | Toutes les fonctions de traitement des documents | Peut être utilisée avec le modèle d'étape SetDocPropsFromList pour indiquer qu'un document doit être supprimé d'un travail. Les flots de travaux fournis PullPDFSample et PullAFPSample utilisent cette propriété. |
| Doc.PullProp | Toutes les fonctions de traitement des documents | Peut être utilisée avec le modèle d'étape SetDocPropsFromList pour identifier la propriété de document qui détermine les documents à supprimer d'un travail. Les flots de travaux fournis PullPDFSample et PullAFPSample utilisent cette propriété. |
| Doc.SequenceInChild | Toutes les fonctions de traitement des documents | Séquence du document dans un travail enfant. Bien que la valeur soit initialement définie dans IdentifyDocuments, elle peut être mise à jour par toute étape qui modifie le fichier des propriétés du document, par exemple SortDocuments ou CreateJobsFromDocuments. |
| Doc.SourceFileName | Toutes les fonctions de traitement des documents | Nom du fichier d'entrée contenant le document. |
| Doc.State | Toutes les fonctions de traitement des documents | État actuel du document. |
| Doc.TT.BarcodeStatus1 | Vérification automatique | Indique si le code barres d'un document a été correctement lu par l'appareil photo ou le lecteur de codes-barres associé à l'étape ReadBarcodeData. |
| Doc.TT.BarcodeStatus2 | Vérification automatique | Indique si le code barres d'un document a été correctement lu par l'appareil photo ou le lecteur de codes-barres associé à l'étape ReadBarcodeData. |
| Doc.TT.BarcodeStatus3 | Vérification automatique | Indique si le code barres d'un document a été correctement lu par l'appareil photo ou le lecteur de codes-barres associé à l'étape ReadBarcodeData. |
| Doc.TT.BarcodeStatus4 | Vérification automatique | Indique si le code barres d'un document a été correctement lu par l'appareil photo ou le lecteur de codes-barres associé à l'étape ReadBarcodeData. |
| Doc.TT.BarcodeStatus5 | Vérification automatique | Indique si le code barres d'un document a été correctement lu par l'appareil photo ou le lecteur de codes-barres associé à l'étape ReadBarcodeData. |
| Doc.Verification.Recipient | Vérification automatique | Spécifie des informations, telles que le nom du compte, qui vous permettent d'identifier un document. |