Definindo propriedades de documento personalizadas

Você usa propriedades de documento personalizadas para extrair dados de cada documento em uma tarefa. Primeiramente, você define as propriedades do documento personalizadas no RICOH ProcessDirector e, em seguida, mapeia dados nos documentos para as propriedades do documento. À medida que uma tarefa entra no fluxo de trabalho, a etapa IdentifyPDFDocuments (arquivos PDF) ou a etapa IdentifyDocuments (arquivos AFP) extrai os dados.

Identifique os dados que você deseja extrair dos documentos. Se o RICOH ProcessDirector fornecer uma propriedade do documento apropriada, use-a em vez de definir uma propriedade do documento personalizada.

Por exemplo, você deseja extrair o número da conta, o nome do cliente, o endereço de e-mail e a data do demonstrativo de cada documento em uma tarefa. O RICOH ProcessDirector fornece uma propriedade do documento, Endereço de e-mail, para extrair endereços de e-mail. Você define propriedades de documento personalizadas para o número da conta, o nome do cliente e a data do demonstrativo.

Obs.:

Se você usar propriedades de documento personalizadas, a partir da versão 3.11.2, poderá criá-las na guia Administração, usando Objetos ⇒ Properties personalizadas.
Você pode escolher o nome do banco de dados e a etiqueta que é exibida nos blocos de notas de propriedades e nos cabeçalhos das colunas. Você também escolhe que tipo de dados é armazenado na propriedade e o acesso padrão que os diferentes grupos de usuários têm para a propriedade, sem adicioná-los ao arquivo docCustomDefinitions.xml.

Para obter mais informações, consulte os tópicos Propriedades de tarefa e documento personalizadas e Criação e ativação de propriedades personalizadas.
Se você já tiver propriedades de documento personalizadas definidas em um arquivo docCustomDefinitions.xml, poderá continuar a usá-las. Não os crie novamente na guia Administração. Use essa guia apenas para criar novas propriedades de tarefa ou documento.

Se você quiser usar a nova função disponibilizada no RICOH ProcessDirector na versão 3.11.2 para criar uma propriedade personalizada:
- Planeje as propriedades conforme mencionado nas etapas 1 a 5 mencionadas abaixo.
- Continue com a etapa definida em Criação e ativação de propriedades personalizadas.

Para definir propriedades de documento personalizadas:

Escolha o tipo de propriedade de documento personalizada:
- Propriedade do banco de dados
- Propriedade limitada
Para obter mais informações sobre cada tipo de propriedade de documento personalizada e como defini-los, consulte o tópico sobre o arquivo docCustomDefinitions.xml no centro de informações.
Escolha um nome de banco de dados (interno) para a propriedade de documento personalizada.

Por exemplo, defina uma propriedade de documento personalizada com o nome do banco de dados Doc.Custom.AccountNumber.
- Recomendamos que os nomes do banco de dados de suas propriedades do documento personalizadas iniciem com Doc.Cliente. Caso não utilize essa convenção de nomenclatura, verifique se alguma de suas propriedades do documento personalizadas tem o mesmo nome do banco de dados da propriedade do documento fornecida com o RICOH ProcessDirector.
- Não utilize um número imediatamente após o ponto (.) no nome do banco de dados. Por exemplo, o nome do banco de dados Doc.3rdLineAddress não é válido.
- Não exclua as propriedades de documento personalizadas depois de adicioná-las ao arquivo docCustomDefinitions.xml.
- Não altere o name (nome do banco de dados), o dataType ou o dbType de uma propriedade de documento personalizada. O sistema permite que você altere caption (nome da interface do usuário), shortCaption, descrição e acess.
Escolha um nome da interface do usuário (legenda) para a propriedade de documento personalizada.

Por exemplo, defina uma propriedade de documento personalizada com o nome da interface do usuário Número de conta.
- Recomendamos que você não defina uma propriedade do documento personalizada com o mesmo nome da interface do usuário de uma propriedade do documento fornecida pelo RICOH ProcessDirector.
Escolha um tipo de dados (dataType) para a propriedade do documento personalizada.

Os exemplos incluem String, Integer, IntegerNonNeg e Timestamp.
Para as propriedades do banco de dados:
1. Escolha um tipo de banco de dados (dbType).
  
  Para o tipo de dados String, os tipos de bancos de dados são char, varchar e long varchar.
  
  Para o tipo de dados Integer, os tipos de bancos de dados são smallint, bigint e integer.
  
  Para o tipo de dados Timestamp, o tipo de bancos de dados é Timestamp.
2. Escolha o nível de acesso que os usuários têm à propriedade de documento personalizada:
  - attrWriteAdmin
    
    O grupo de segurança Membros do Administrador tem acesso de gravação. Os grupos de segurança Membros do Monitor, Operador e Supervisor têm acesso de leitura.
  - attrWriteAdminSuper
    
    Supervisores e Administradores têm acesso de gravação. Monitores e Operadores têm acesso de leitura.
  - attrWriteAdminSuperOper
    
    Operadores, Supervisores e Administradores têm acesso de gravação. Monitores têm acesso de leitura.
  Se você não especifica um nível de acesso, os Administradores têm acesso de gravação. Monitores, Operadores e Supervisores têm acesso de leitura.
  - Se tiver criado seus próprios grupos de segurança, eles receberão o mesmo acesso às propriedades do documento personalizadas que os grupos de segurança do RICOH ProcessDirector que você copiou para criar seus grupos.
3. Escolha uma legenda curta.
  
  A legenda curta é exibida nos cabeçalhos das colunas da tabela.
  
  Por exemplo, defina uma propriedade de documento personalizada com a legenda curta Nº conta.
4. Escolha uma descrição.
  
  A interface de usuário exibe a descrição como ajuda para a propriedade de documento personalizada.
  
  Por exemplo, defina uma propriedade de documento personalizada com a descrição Número da conta do cliente.
Edite o arquivo de configuração das propriedades do documento:
- Na primeira vez que você definir as propriedades de documento personalizadas, faça uma cópia do arquivo de amostra fornecido. Vá até este diretório:
  - /aiw/aiw1/samples/config no Linux
  - C:\aiw\aiw1\samples\config no Windows
- Quando você definir mais propriedades do documento, faça uma cópia do arquivo ativo. Vá até este diretório:
  - /aiw/aiw1/config no Linux
  - C:\aiw\aiw1\config no Windows

Copie o arquivo docCustomDefinitions.xml para um diretório de trabalho e edite o arquivo.

Mantenha uma cópia de backup do arquivo editado para fins de recuperação.

Por exemplo, essas linhas adicionam duas propriedades do documento do banco de dados com os nomes de banco de dados Doc.Custom.AccountNumber e Doc.Custom.StatementDate ao arquivo:

<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"/>

Obs.:

A linha name define o nome do banco de dados. A linha caption define o nome da interface com o usuário.

Essas linhas adicionam duas propriedades de documento limitadas com os nomes internos Doc.Custom.SSNumber e Doc.Custom.CheckAmt ao arquivo:

<limitedProperties>

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

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

</limitedProperties>

Utilize um editor XML para validar sua sintaxe.
Copie o arquivo editado para:
- /aiw/aiw1/config/docCustomDefinitions.xml (Linux)
- C:\aiw\aiw1\config\docCustomDefinitions.xml (Windows)
Para que qualquer nova propriedade de documento seja exibida corretamente na interface do usuário, edite o arquivo docCustomDefinitions.properties para um ou mais idiomas. Se você não definir rótulos para as novas propriedades neste arquivo, só verá nomes de banco de dados para as propriedades na interface de usuário. Veja Nomeando propriedades de documento personalizadas em mais de um idioma para as etapas para editar o arquivo.
Disponibilize as propriedades do documento personalizadas que você definiu para o RICOH ProcessDirector:
1. Execute o utilitário docCustom.
  Na primeira vez que você executa o utilitário docCustom, ele cria o recurso Propriedades de documento personalizadas e o adiciona ao Gerenciador de Recursos. Quando você executa o utilitário novamente, ele adiciona um recurso Propriedades de documento personalizadas atualizado ao Gerenciador de Recursos.
2. Use o Gerenciador de Recursos para instalar ou atualizar o recurso Propriedades do documento personalizadas.
Carregue as propriedades de documento personalizadas atualizadas do RICOH ProcessDirector para a ferramenta que você utiliza para configurar propriedades do documento:
- Caso tenha o recurso Suporte de documento PDF, carregue as propriedades do documento do RICOH ProcessDirector para o Plug-in do RICOH ProcessDirector para Adobe Acrobat.
  Para obter mais informações, consulte o tópico relacionado no centro de informações.
- Caso tenha o recurso do Suporte AFP, utilize um dos seguintes métodos para iniciar o RICOH Visual Workbench:
  - Inicie o RICOH Visual Workbench a partir do servidor do RICOH ProcessDirector.
  - Substitua o aplicativo RICOH Visual Workbench em seu desktop:
    - Exclua o arquivo VisualWorkbench.zip e todos os arquivos descompactados.
    - Faça download do arquivo VisualWorkbench.zip a partir da interface de usuário do RICOH ProcessDirector.
    - Descompacte o arquivo e inicie o novo aplicativo de desktop do RICOH Visual Workbench.
  As propriedades do documento são carregadas automaticamente.

RICOH ProcessDirector™ para Linux

Definindo propriedades de documento personalizadas

Related information: