Archivo docCustomDefinitions.xml
El archivo de configuración de las propiedades del documento (
docCustomDefinitions.xml) define las propiedades que se utilizan para gestionar documentos. El proceso de
instalación coloca un archivo de ejemplo en /aiw/aiw1/samples/config en sistemas operativos basados en UNIX y en C:\aiw\aiw1\samples\config en Windows.
- Nota:
- Si cambia el archivo
docCustomDefinitions.xmldespués de instalar Agrupación de documentos avanzada, Soporte de AFP o Soporte de documento PDF:- Ejecute la utilidad
docCustome instale/actualice la característica Propiedades de documentos personalizadas. - Para la característica Soporte de documento PDF, cargue las propiedades de documento en Plug-in RICOH ProcessDirector para Adobe Acrobat.
- Para la característica Soporte de AFP, acceda a RICOH Visual Workbench desde la interfaz de usuario de RICOH ProcessDirector. Las propiedades de documento nuevas se cargan en RICOH Visual Workbench cuando se abre en la estación de trabajo.
- Ejecute la utilidad
Propiedades de base de datos y propiedades limitadas
Puede definir dos tipos de propiedades de documento:
- Propiedades de base de datos
- Propiedades limitadas
Puede almacenar y manipular ambos tipos de propiedades en un archivo de propiedades de documento, pero sólo las propiedades de base de datos se almacenan en la base de datos.
Puede trabajar con ambos tipos de propiedades como sigue:
- Puede utilizarlas con los pasos de un flujo de trabajo para agrupar u ordenar documentos (por ejemplo, con la plantilla de pasos SortDocuments).
- Puede enlazarlas con códigos de índice de AFP mediante el RICOH Visual Workbench Document Property Designer de .
- Puede correlacionar datos de documentos de trabajos PDF con ellas mediante Plug-in RICOH ProcessDirector para Adobe Acrobat.
- Si tiene la característica Archivador, puede almacenarlas en un repositorio. Después de almacenarlas, puede utilizarlas para realizar búsquedas en el repositorio y recuperar trabajos, documentos e información de historial. Los valores de las propiedades aparecen en la pestaña Propiedades al pulsar Mostrar detalles en la tabla Resultados.
- Si tiene la característica Gestión de preferencias, puede utilizar un archivo de preferencias externo para configurar los valores de las propiedades.
Puede trabajar con propiedades de base de datos, pero no con propiedades limitadas, como sigue:
- Puede utilizarlas para buscar documentos en el portlet Documentos en la página Principal de la interfaz de usuario.
- Al seleccionar un documento en el portlet Documentos, se muestran los valores de las propiedades de base de datos.
- Puede utilizarlas para buscar documentos para mostrarlos en el visor.
- Puede determinar sus valores en un trabajo, actualizar sus valores en otro trabajo y utilizar los valores actualizados en el trabajo original.
- Si tiene la característica Verificación automatizada o Mecanismo de inserción, puede utilizar propiedades de base de datos para buscar documentos para reconciliar o volver a imprimir.
- Si tiene la característica ampliada Agrupación de documentos avanzada, puede utilizar selectores para manipular documentos en función de los valores de sus propiedades.
Las propiedades limitadas ofrecen las siguientes ventajas:
- Puede utilizarlas para evitar mostrar valores de propiedades delicados en la interfaz de usuario, como números de la Seguridad Social o importes de cheques.
- Maximizan el rendimiento del sistema. La manipulación de las propiedades de base de datos puede degradar el rendimiento si procesa un número importante de documentos.
Trabaje con su representante de soporte para determinar sus necesidades en cuanto a propiedades de documento de base de datos y limitadas.
Secciones del archivo de ejemplo
El archivo de ejemplo docCustomDefinitions.xml contiene varias secciones. En esta tabla se ofrece un resumen.
Secciones del archivo docCustomDefinitions.xml
| Sección | Propósito |
|---|---|
| Esquema | La sección de esquema identifica el esquema y la serie exclusiva de caracteres para las propiedades personalizadas del documento. Esta sección sólo debería editarla el representante de soporte. |
| Propiedades de base de datos | En esta sección se definen las propiedades de documento de base de datos. |
| Propiedades limitadas | En esta sección se definen las propiedades de documento limitadas. |
| Propiedades de autorización del usuario | Esta sección es opcional. Las propiedades de autorización del usuario especifican grupos de autoridad personalizados para acceder a propiedades de base de datos. |
Sección de esquema
La sección de esquema contiene un elemento docCustomDefinitions y un elemento schema. Sólo los representantes de soporte deberían editar la sección de esquemas.
Sección de propiedades de bases de datos
La sección de propiedades de bases de datos contiene el elementodocProperty.
- Nota:
- No defina una propiedad como propiedad de base de datos y como propiedad limitada. Podría producirse un comportamiento inesperado.
- No defina una propiedad de documento con el mismo nombre que una propiedad que RICOH ProcessDirector defina automáticamente. Para ver una lista, consulte Propiedades de documento definidas automáticamente.
- <docProperty>
- Define las propiedades del documento que hay en la base de datos.
Atributos para el elemento docProperty
Atributo docProperty ¿Requerido? Notas nombre Sí El nombre de la base de datos (nombre interno) de la propiedad. Los programas que leen o escriben propiedades utilizan este nombre. Le recomendamos que utilice una convención coherente para los nombres, de manera que sean únicos en todo el sistema. Por ejemplo, el archivo de ejemplo docCustomDefinitions.xml utiliza el prefijo Doc.Custom para que sus propiedades sean diferentes de las del producto base. No utilice caracteres especiales (como @, #, $, % o - [guión]) ni espacios en el nombre de la propiedad. Puede utilizar puntos o guiones bajos.
No utilice un número inmediatamente después del punto (.) en el nombre de la base de datos de propiedades. Por ejemplo, la propiedad Doc.3rdLineAddress no es válida.
access No Nivel de acceso del usuario a la propiedad. Puede utilizar un nivel de acceso que ya esté definido en el producto, o puede crear un nivel de acceso personalizado si uno existente no satisface las necesidades. Consulte la sección Acceso para obtener más información. datatype Sí El tipo de datos que se va a utilizar para la propiedad. Consulte la tabla siguiente. dbType No Un parámetro de base de datos que especifica el tipo de datos. - Nota:
- La propiedad dbType está obsoleta y ya no se utiliza. Utilice la propiedad datatype en su lugar.
caption Sí El nombre de la interfaz de usuario (título por omisión) de la propiedad. Si está configurando títulos sólo en un idioma, defínalos en este archivo. Si está configurando nombres de la interfaz de usuario en más de un idioma, cree archivos adicionales de nombres de propiedades de documento (docCustomDefinitions_language.properties) para los demás idiomas. Para obtener más información, consulte Archivo docCustomDefinitions.properties. shortCaption Sí El título corto predeterminado mostrado para esta propiedad donde se requiera, como en las cabeceras de las columnas de la tabla. Si está configurando títulos cortos sólo en un idioma, defínalos en este archivo. Si está configurando títulos cortos en más de un idioma, cree archivos adicionales de nombres de propiedades de documentos (docCustomDefinitions_language.properties) para los demás idiomas. Para obtener más información, consulte Archivo docCustomDefinitions.properties. descripción Sí La descripción predeterminada de la propiedad del documento, que se muestra en la interfaz de usuario como texto de ayuda. Si está configurando descripciones sólo en un idioma, defínalas en este archivo. Si está configurando descripciones en más de un idioma, cree archivos adicionales de nombres de propiedades de documentos (docCustomDefinitions_language.properties) para los demás idiomas. Para obtener más información, consulte Archivo docCustomDefinitions.properties. Puede utilizar estos tipos de datos y de bases de datos en las definiciones de las propiedades de bases de datos. Recuerde que la definición de bases de datos puede restringir más los valores que se pueden almacenar, junto con las reglas de validación mostradas en esta tabla. Por ejemplo, un SMALLINT puede almacenar números enteros de 0 a 32767. Los valores de los tipos de bases de datos no distinguen entre mayúsculas y minúsculas.
Tipos de datos y de bases de datos para las definiciones docProperty
Tipo de datos Tipo de base de datos (utilizada en SQL) Validación para el tipo de datos Serie VARCHAR(128) VARCHAR: longitud variable, 1-128 caracteres IntegerNonNeg SMALLINTBIGINTINTEGER SMALLINT: 2 bytesBIGINT: 4 bytesINTEGER: 8 bytesMinimum=0 Indicación de fecha y hora TIMESTAMP TIMESTAMP: Debe contener valores para el día (D), el mes (M) y el año (Y).Esos componentes pueden aparecer en uno de estos formatos:MM DD YYYYDD MM YYYYYYYY MM DDEl día y el mes deben representarse mediante un número de dos cifras.Puede añadir una hora del día en este formato:hh:mm:ss XdkString10 VARCHAR(10) VARCHAR: longitud variable, 1-10 caracteres - Nota:
- Estos valores son variaciones del tipo de datos Serie que se pueden utilizar en lugar de Serie para reducir la cantidad de espacio reservada en la base de datos para valores de propiedades.
XdkString20 VARCHAR(20) VARCHAR: longitud variable, 1-20 caracteres - Nota:
- Estos valores son variaciones del tipo de datos Serie que se pueden utilizar en lugar de Serie para reducir la cantidad de espacio reservada en la base de datos para valores de propiedades.
XdkString30 VARCHAR(30) VARCHAR: longitud variable, 1-30 caracteres - Nota:
- Estos valores son variaciones del tipo de datos Serie que se pueden utilizar en lugar de Serie para reducir la cantidad de espacio reservada en la base de datos para valores de propiedades.
XdkString40 VARCHAR(40) VARCHAR: longitud variable, 1-40 caracteres - Nota:
- Estos valores son variaciones del tipo de datos Serie que se pueden utilizar en lugar de Serie para reducir la cantidad de espacio reservada en la base de datos para valores de propiedades.
XdkString50 VARCHAR(50) VARCHAR: longitud variable, 1-50 caracteres - Nota:
- Estos valores son variaciones del tipo de datos Serie que se pueden utilizar en lugar de Serie para reducir la cantidad de espacio reservada en la base de datos para valores de propiedades.
XdkString128 VARCHAR(128) VARCHAR: longitud variable, 1-128 caracteres - Nota:
- Estos valores son variaciones del tipo de datos Serie que se pueden utilizar en lugar de Serie para reducir la cantidad de espacio reservada en la base de datos para valores de propiedades.
Sección de propiedades limitadas
La sección de propiedades limitadas contiene un elemento docProperty o más.
- Nota:
- No defina una propiedad como propiedad de base de datos y como propiedad limitada. Podría producirse un comportamiento inesperado.
- No defina una propiedad de documento con el mismo nombre que una propiedad que RICOH ProcessDirector defina automáticamente. Para ver una lista, consulte Propiedades de documento definidas automáticamente.
- <docProperty>
- Define las propiedades del documento que se manipulan sólo en el archivo de propiedades
del documento y no en la base de datos.
Atributos para el elemento docProperty
Atributo docProperty ¿Requerido? Notas nombre Sí Le recomendamos que utilice una convención coherente para los nombres de las propiedades personalizadas, de manera que sean únicos en todo el sistema. Por ejemplo, el archivo de ejemplo docCustomDefinitions.xml utiliza el prefijo Doc.Custom para que sus propiedades sean diferentes de las del producto base. No utilice caracteres especiales (como @, #, $, % o - [guión]) ni espacios en el nombre de la propiedad. Puede utilizar puntos o guiones bajos.
No utilice un número inmediatamente después del punto (.) en el nombre de la base de datos de propiedades. Por ejemplo, la propiedad Doc.3rdLineAddress no es válida.
datatype No Consulte la tabla siguiente. caption No Título mostrado en las listas de la interfaz de usuario para esta propiedad. Si está configurando títulos sólo en un idioma, defínalos en este archivo. Si está configurando títulos en más de un idioma, cree un archivo de nombres de propiedades de documentos (docCustomDefinitions_language.properties) para los demás idiomas. Consulte el tema central de información relacionada para ver más detalles. Puede utilizar estos tipos de datos en definiciones de docProperty:
Tipos de datos para el elemento docProperty
Tipo de datos Validación para el tipo de datos Serie Ninguno
IntegerNonNeg Entero entre 0 y 2147483647
Indicación de fecha y hora TIMESTAMP: Debe contener valores para el día (D), el mes (M) y el año (Y).Esos componentes pueden aparecer en uno de estos formatos:MM DD YYYYDD MM YYYYYYYY MM DDEl día y el mes deben representarse mediante un número de dos cifras.Puede añadir una hora del día en este formato:hh:mm:ss
Sección de propiedades de autorización de usuario
La sección de propiedades de autorización de usuario es opcional. Las propiedades de autorización del usuario especifican grupos de autoridad personalizados para acceder a propiedades de base de datos. Esta sección contiene un elemento access o más.
- <access>
- Utilizado para definir la capacidad de leer o editar propiedades personalizadas. Utilice
estos niveles de acceso en el elemento docProperty. Puede utilizar uno en el grupo
de seguridad predeterminado que proporciona RICOH ProcessDirector o definir uno propio. Estos son los atributos:Estos son los niveles de acceso predeterminados y las autorizaciones que proporciona RICOH ProcessDirector:
Atributos para el elemento access
atributo access Notas nombre Nombre del nivel de acceso. groupAttributeAccess Capacidad del grupo de usuarios para leer o editar el atributo. Niveles de acceso predeterminados y autorizaciones
Nombre de acceso Nombre de grupo Nivel de acceso genérico AnyAuthenticated Acceso de atributo: lectura Operador Acceso de atributo: lectura Supervisor Acceso de atributo: lectura Administrador Acceso de atributo: escritura attrWriteAdmin Operador Acceso de atributo: lectura Supervisor Acceso de atributo: lectura Administrador Acceso de atributo: escritura Todos Acceso de atributo: lectura Monitor Acceso de atributo: lectura attrWriteAdminSuper Operador Acceso de atributo: lectura Supervisor Acceso de atributo: escritura Administrador Acceso de atributo: escritura Todos Acceso de atributo: lectura Monitor Acceso de atributo: lectura attrWriteAdminSuperOper Operador Acceso de atributo: escritura Supervisor Acceso de atributo: escritura Administrador Acceso de atributo: escritura Todos Acceso de atributo: lectura Monitor Acceso de atributo: lectura actionAdmin Operador Acceso de acción: falso Supervisor Acceso de acción: falso Administrador Acceso de acción: verdadero Todos Acceso de acción: falso Monitor Acceso de acción: falso actionAdminSuper Operador Acceso de acción: falso Supervisor Acceso de acción: verdadero Administrador Acceso de acción: verdadero Todos Acceso de acción: falso Monitor Acceso de acción: falso actionAdminSuperOper Operador Acceso de acción: verdadero Supervisor Acceso de acción: verdadero Administrador Acceso de acción: verdadero Todos Acceso de acción: falso Monitor Acceso de acción: falso
Propiedades de documento definidas automáticamente
Esta tabla enumera propiedades de documento que RICOH ProcessDirector define automáticamente durante la instalación. No defina estas propiedades en el archivo docCustomDefinitions.xml.
Propiedades de documento definidas automáticamente
| Nombre de la base de datos de la propiedad | Empaquetado con... | Notas |
|---|---|---|
| Doc.Address.1 | Postal Enablement | Especifica la primera línea del bloque de direcciones en el documento. |
| Doc.Address.Company | Postal Enablement | Especifica el nombre de la empresa en el documento. |
| Doc.Address.PostalCode | Postal Enablement | Especifica el código postal en el documento. |
| Doc.Address.ZipCode | Postal Enablement | Especifica el código postal en el documento. |
| Doc.AV.ScanCount | Verificación automatizada | Muestra el número de veces que se explora el código de barras en un documento. |
| Doc.ChildJobID | Todas las características de procesamiento de documentos | Un identificador de grupo para trabajos hijo. Aunque inicialmente el valor se defina en IdentifyDocuments o en IdentifyPDFDocuments, puede actualizarse en cualquier paso que cambie el archivo de propiedades del documento, como SplitDocuments o CreateJobsFromDocuments. |
| Doc.CurrentFirstPage | Todas las características de procesamiento de documentos | Número de página de la primera página del documento en el archivo de impresión actual. |
| Doc.CurrentJobID | Todas las características de procesamiento de documentos | El número de trabajo asociado. |
| Doc.CurrentPages | Todas las características de procesamiento de documentos | Número de hojas del documento en el trabajo actual. |
| Doc.CurrentSequence | Todas las características de procesamiento de documentos | Secuencia del documento en el trabajo actual. |
| Doc.CurrentSheets | Todas las características de procesamiento de documentos | Número de hojas del documento en el trabajo actual. |
| Doc.Custom.MemberLevel | Presentación electrónica | El nivel de pertenencia a grupo del cliente en el momento en que se creó el extracto. |
| Doc.Custom.PURL | Presentación electrónica | Una URL personalizada que enlaza con la ubicación que permite al cliente recuperar el extracto. |
| Doc.Custom.StatementDate | Presentación electrónica | La fecha de primera emisión del extracto. |
| Doc.DataLen | Todas las características de procesamiento de documentos | La longitud (en bytes) del documento en el archivo de impresión. |
| Doc.DataOffset | Todas las características de procesamiento de documentos | El desplazamiento de bytes del documento del archivo de impresión del trabajo original. BuildAFPFromDocuments y CreateAFPJobsFromDocuments utilizan este valor para localizar el AFP que se va a extraer del trabajo original. |
| Doc.DocSize.PieceThickness | Postal Enablement | Especifica el grosor de un correo cuando los diferentes correos de un trabajo tienen distintos grosores. |
| Doc.DocSize.PieceWeight | Postal Enablement | Especifica el peso de un correo cuando los diferentes correos de un trabajo tienen distintos pesos. |
| Doc.Email.Sent | Todas las características de procesamiento de documentos | Especifica si el paso EmailDocuments de un flujo de trabajo ha creado y entregado un correo electrónico con un documento adjunto al servidor SMTP. |
| Doc.EmailAddress | Todas las características de procesamiento de documentos | La dirección de correo electrónico asociada con el documento. |
| Doc.ID | Todas las características de procesamiento de documentos | Un identificador único para el documento. |
| Doc.Insert.BinTriggers | Unidad de inserción | Bandejas de inserción que deben suministrar inserciones para este documento. |
| Doc.Insert.DivertBin | Unidad de inserción | Número de la bandeja de salida de inserción a la que se desvía este documento después de la inserción. |
| Doc.Insert.OriginalBarCode | Unidad de inserción | Datos del código de barras que controla la inserción del documento. |
| Doc.Insert.RecipientName | Unidad de inserción | Nombre de la persona a la que se envía este documento. |
| Doc.Insert.ReprintJobId | Unidad de inserción | En un trabajo de reimpresión del mecanismo de inserción, el ID del trabajo padre que creó el trabajo. |
| Doc.Member.Number | Archivador | Especifica el número de miembro en el documento. El flujo de trabajo suministrado RepositorySample utiliza esta propiedad. |
| Doc.OriginalFirstPage | Todas las características de procesamiento de documentos | Número de página de la primera página del documento. |
| Doc.OriginalJobID | Todas las características de procesamiento de documentos | ID de trabajo del trabajo original. |
| Doc.OriginalPages | Todas las características de procesamiento de documentos | Número de páginas del documento. |
| Doc.OriginalSequence | Todas las características de procesamiento de documentos | Secuencia del documento en el trabajo original. El sistema da al primer documento el valor de secuencia 1, el siguiente documento tiene el valor de secuencia 2, etc. |
| Doc.OriginalSheets | Todas las características de procesamiento de documentos | Número de hojas necesarias para imprimir el documento. |
| Doc.Postal.AddressProcessingRC | Postal Enablement | Un valor devuelto del software postal para indicar si hay disponible un cambio de dirección para el documento. |
| Doc.Postal.Category | Postal Enablement | Especifica la marca de ruptura de palé para el documento. |
| Doc.Postal.ChangeAddressRC | Postal Enablement | Especifica el número de palé para el documento. |
| Doc.Postal.ContainerBreakMark | Postal Enablement | Especifica la marca de ruptura de contenedor para el documento. |
| Doc.Postal.ContainerNumber | Postal Enablement | Especifica el número de contenedor para el documento. |
| Doc.Postal.HandlingUnitBreakMark | Postal Enablement | Especifica la marca de ruptura de paquete para el documento. |
| Doc.Postal.HandlingUnitNumber | Postal Enablement | Especifica el número de paquete para el documento. |
| Doc.Postal.PackageBreakMark | Postal Enablement | Especifica el tipo de franqueo para el documento. |
| Doc.Postal.PackageNumber | Postal Enablement | Especifica el código de tipo de franqueo para el documento. |
| Doc.Postal.PostageRate | Postal Enablement | Especifica el número de secuencia de preclasificación para el documento. |
| Doc.Postal.PostageRateCode | Postal Enablement | Valor devuelto del software de clasificación postal para indicar el resultado de su procesamiento. |
| Doc.Postal.SequenceNumber | Postal Enablement | Secuencia del documento en el trabajo hijo. |
| Doc.Postal.SequencingProcessingRC | Postal Enablement | Estado del documento. |
| Doc.Pref.Member | Gestión de preferencias | Se puede utilizar con un objeto de correlación de propiedad para identificar los documentos de un trabajo. El objeto de correlación de propiedad DelimitedSample y el flujo de trabajo PreferencesSample suministrados utilizan esta propiedad. |
| Doc.Pref.Output | Gestión de preferencias | Se puede utilizar con un objeto de correlación de propiedad para indicar el tipo de salida (como Email, Print o Suppress) de un documento. El objeto de correlación de propiedad DelimitedSample y el flujo de trabajo PreferencesSample suministrados utilizan esta propiedad. |
| Doc.Pull | Todas las características de procesamiento de documentos | Se puede utilizar con la plantilla de pasos SetDocPropsFromList para indicar que debe eliminarse un documento de un trabajo. Los flujos de trabajo suministrados PullPDFSample y PullAFPSample utilizan esta propiedad. |
| Doc.PullProp | Todas las características de procesamiento de documentos | Se puede utilizar con la plantilla de pasos SetDocPropsFromList para identificar la propiedad de documento que determina los documentos que deben eliminarse de un trabajo. Los flujos de trabajo suministrados PullPDFSample y PullAFPSample utilizan esta propiedad. |
| Doc.SequenceInChild | Todas las características de procesamiento de documentos | Secuencia de un documento en un trabajo hijo. Aunque el valor se define en principio en IdentifyDocuments, puede ser actualizado por cualquier paso que cambie el archivo de propiedades del documento, como SortDocuments o CreateJobsFromDocuments. |
| Doc.SourceFileName | Todas las características de procesamiento de documentos | El nombre del mecanismo de inserción que contenía el documento. |
| Doc.State | Todas las características de procesamiento de documentos | Estado actual del documento. |
| Doc.TT.BarcodeStatus1 | Verificación automatizada | Muestra si el código de barras de un documento se ha leído correctamente por parte de la cámara o el escáner de códigos de barras que se ha asociado con el paso ReadBarcodeData. |
| Doc.TT.BarcodeStatus2 | Verificación automatizada | Muestra si el código de barras de un documento se ha leído correctamente por parte de la cámara o el escáner de códigos de barras que se ha asociado con el paso ReadBarcodeData. |
| Doc.TT.BarcodeStatus3 | Verificación automatizada | Muestra si el código de barras de un documento se ha leído correctamente por parte de la cámara o el escáner de códigos de barras que se ha asociado con el paso ReadBarcodeData. |
| Doc.TT.BarcodeStatus4 | Verificación automatizada | Muestra si el código de barras de un documento se ha leído correctamente por parte de la cámara o el escáner de códigos de barras que se ha asociado con el paso ReadBarcodeData. |
| Doc.TT.BarcodeStatus5 | Verificación automatizada | Muestra si el código de barras de un documento se ha leído correctamente por parte de la cámara o el escáner de códigos de barras que se ha asociado con el paso ReadBarcodeData. |
| Doc.Verification.Recipient | Verificación automatizada | Especifica información, como el nombre de cuenta, que le ayuda a identificar un documento. |