Definición de las propiedades de documento personalizadas

Para extraer datos de cada documento de un trabajo, se utilizan propiedades de documento personalizadas. En primer lugar, se definen las propiedades del documento personalizadas en RICOH ProcessDirector y, a continuación, se correlacionan los datos de los documentos con las propiedades de los documentos. A medida que un trabajo pasa por el flujo de trabajo, el paso IdentifyPDFDocuments (archivos PDF) o el paso IdentifyDocuments (archivos AFP) extrae los datos.

Identifique los datos que desea extraer de los documentos. Si RICOH ProcessDirector suministra una propiedad de documento apropiado, utilícela en lugar de definir una propiedad de documento personalizada.

Por ejemplo, desea extraer el número de cuenta, el nombre del cliente, la dirección de correo y la fecha del extracto de todos los documentos de un trabajo. RICOH ProcessDirector suministra una propiedad de documento, Dirección de correo electrónico, para extraer direcciones de correo electrónico. Define propiedades de documento personalizadas para el número de la cuenta, el nombre del cliente y la fecha del extracto.

    Nota:
  • Si utiliza propiedades de documento personalizadas, a partir de la versión 3.11.2, puede crearlas en la pestaña Administración, mediante Objetos Propiedades personalizadas.

    Puede escoger el nombre de la base de datos y la etiqueta que aparece en los encabezados de columna y cuadernos de propiedades. También puede escoger qué tipo de datos almacenar en la propiedad y el acceso predeterminado que tienen los distintos grupos de usuarios para la propiedad sin añadirlos al archivo docCustomDefinitions.xml.

    Para obtener más información, consulte los temas Propiedades de trabajo y documento personalizadas y Creación y activación de propiedades personalizadas.

  • Si ya tiene propiedades de documento personalizadas definidas en un archivo docCustomDefinitions.xml, puede seguir utilizándolas. No vuelva a crearlas desde la pestaña Administración. Utilice esa pestaña únicamente para crear nuevos trabajos o propiedades de documentos.
  • Si desea utilizar la nueva función disponible en la versión 3.11.2 de RICOH ProcessDirector para crear una propiedad personalizada:
Para definir las propiedades de documento personalizadas:
  1. Seleccione el tipo de propiedad de documento personalizada:
    • Propiedad de base de datos
    • Propiedad limitada

    Para obtener más información sobre cada tipo de propiedad de documento personalizada y cómo definirlo, vea el tema sobre el archivo docCustomDefinitions.xml en el Centro de información.

  2. Seleccione un nombre de base de datos (interno) para la propiedad de documento personalizada.

    Por ejemplo, define una propiedad de documento personalizada con el nombre de base de datos Doc.Custom.AccountNumber.

      Nota:
    • Se recomienda que los nombres de las bases de datos de las propiedades de documento personalizadas empiecen por Doc.Personalizado. Si no utiliza esta convención de nomenclatura, verifique que ninguna de las propiedades de documento personalizada tenga el mismo nombre de base de datos que la propiedad de documento que se suministra con RICOH ProcessDirector.

    • No utilice un número inmediatamente después del punto (.) en el nombre de la base de datos. Por ejemplo, el nombre de la base de datos Doc.3rdLineAddress no es válido.
    • No suprima las propiedades de documento personalizadas después de añadirlas al archivo docCustomDefinitions.xml.

    • No cambie el nombre (nombre de base de datos), dataType o dbType de una propiedad de documento personalizada. El sistema le permite cambiar título (nombre de la interfaz de usuario), shortCaption, descripción y acceso.

  3. Seleccione un nombre de interfaz de usuario (título) para la propiedad de documento personalizada.

    Por ejemplo, define una propiedad de documento personalizada con el nombre de interfaz de usuario Número de cuenta.

      Nota:
    • Recomendamos que no defina una propiedad de documento personalizada con el mismo nombre de interfaz de usuario que una propiedad de documento suministrada por RICOH ProcessDirector.
  4. Seleccione un tipo de datos (dataType) para la propiedad de documento personalizada.

    Los ejemplos incluyen: Serie, Entero, IntegerNonNeg y Indicación de fecha y hora.

  5. Para propiedades de base de datos:
    1. Seleccione un tipo de base de datos (dbType).

      Para el tipo de datos Serie, los tipos de base de datos son char, varchar y long varchar.

      Para el tipo de datos Entero, los tipos de base de datos son smallint, bigint y entero.

      Para el tipo de datos Indicación de fecha y hora, el tipo de base de datos es Indicación de fecha y hora.

    2. Seleccione el nivel de acceso que tienen los usuarios a la propiedad de documento personalizada:

      • attrWriteAdmin

        Los miembros del grupo de seguridad Administrador tienen acceso de escritura. Los miembros de los grupos de seguridad Monitor, Operador y Supervisar tienen acceso de lectura.

      • attrWriteAdminSuper

        Los Supervisores y Administradores tienen acceso de escritura. Los Monitores y Operadores tienen acceso de lectura.

      • attrWriteAdminSuperOper

        Los Operadores, Supervisores y Administradores tienen acceso de escritura. Los Monitores tienen acceso de lectura.

      Si no especifica ningún nivel de acceso, los Administradores tienen acceso de escritura. Los Monitores, Operadores y Supervisores tienen acceso de lectura.

        Nota:
      • Si ha creado sus propios grupos de seguridad, estos reciben el mismo acceso a las propiedades de documento personalizadas que los grupos de seguridad de RICOH ProcessDirector que copió para crear los grupos.

    3. Seleccione un título breve.

      El título breve se muestra en las cabeceras de las columnas de la tabla.

      Por ejemplo, defina una propiedad de documento personalizada con el título breve Núm cta.

    4. Seleccione una descripción.

      La interfaz de usuario muestra la descripción como ayuda para la propiedad de documento personalizada.

      Por ejemplo, defina una propiedad de documento personalizada con la descripción Número de cuenta de cliente.

  6. Edite el archivo de configuración de propiedades de documento:
    • La primera vez que defina propiedades de documento personalizadas, haga una copia del archivo de ejemplo suministrado. Vaya a este directorio:
      • /aiw/aiw1/samples/config en Linux

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

    • Cuando defina propiedades de documento adicionales, haga una copia del archivo activo. Vaya a este directorio:
      • /aiw/aiw1/config en Linux

      • C:\aiw\aiw1\config en Windows

  7. Copie el archivo docCustomDefinitions.xml en un directorio de trabajo y edítelo.

    Conserve una copia de seguridad del archivo editado para fines de recuperación.

    Por ejemplo, estas líneas añaden dos propiedades de documento de base de datos con los nombres de base de datos Doc.Custom.AccountNumber y Doc.Custom.StatementDate al archivo:

    <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"/>
      Nota:
    • La línea name define el nombre de la base de datos. La línea caption define el nombre de la interfaz de usuario.

    Estas líneas añaden dos propiedades de documento limitadas con los nombres internos Doc.Custom.SSNumber y Doc.Custom.CheckAmt al archivo:

    <limitedProperties>
    
       <docProperty name="Doc.Custom.SSNumber"
          datatype="String"
          caption="Social Security number"/>
    
       <docProperty name="Doc.Custom.CheckAmt"
          datatype="String"
          caption="Check total"/>
    
    </limitedProperties>
  8. Utilice un editor de XML para validar la sintaxis.
  9. Copie el archivo editado en:
    • /aiw/aiw1/config/docCustomDefinitions.xml (Linux)
    • C:\aiw\aiw1\config\docCustomDefinitions.xml (Windows)
  10. Para que las propiedades de cualquier documento nuevo se muestren correctamente en la interfaz de usuario, edite el archivo docCustomDefinitions.properties para uno o más idiomas. Si no define etiquetas para las nuevas propiedades en este archivo, sólo verá los nombres de la base de datos de las propiedades de la interfaz de usuario. Consulte en Asignación de nombre a las propiedades de documento personalizadas en más de un idioma los pasos para editar el archivo.
  11. Ponga las propiedades del documento personalizadas que ha definido a disposición de RICOH ProcessDirector:
    1. Ejecute la utilidad docCustom.
      La primera vez que ejecute el programa de utilidad docCustom, este crea la característica Propiedades de documento personalizadas y la añade al Gestor de características. Cuando vuelva a ejecutar el programa de utilidad, este añade una característica Propiedades de documento personalizadas actualizada al Gestor de características.
    2. Utilice el Gestor de características para instalar o actualizar la característica Propiedades de documento personalizadas.
  12. Cargue las propiedades del documento personalizadas RICOH ProcessDirector en la herramienta que utiliza para configurar las propiedades de los documentos:
    • Si tiene la característica Soporte de documento PDF, cargue las propiedades de documento de RICOH ProcessDirector en Plug-in RICOH ProcessDirector para Adobe Acrobat.

      Para obtener más información, consulte el tema relacionado del Centro de información.

    • Si tiene la característica Soporte de AFP, utilice uno de estos métodos para iniciar RICOH Visual Workbench:
      • Inicie RICOH Visual Workbench desde el servidor RICOH ProcessDirector.

      • Sustituya la aplicación RICOH Visual Workbench en su escritorio:

        • Suprima el archivo VisualWorkbench.zip y todos los archivos descomprimidos.

        • Descargue el archivo VisualWorkbench.zip de la interfaz de usuario RICOH ProcessDirector.

        • Descomprima el archivo e inicie la nueva aplicación de escritorio RICOH Visual Workbench.

      Las propiedades de documento se cargan automáticamente.