Arquivo docCustomDefinitions.xml

O arquivo de configuração de propriedades do documento (docCustomDefinitions.xml) define as propriedades usadas para gerenciar documentos. O processo de instalação coloca um arquivo de amostra em /aiw/aiw1/samples/config em sistemas operacionais baseados em UNIX, e em c:\aiw\aiw1\samples\config no Windows.

    Obs.:
  • Se você alterar o arquivo docCustomDefinitions.xml depois de instalar o Pool de documentos avançado, o Suporte AFP ou o Suporte de documento PDF:
    • Execute o utilitário docCustom e instale ou atualize o recurso Propriedades de documento personalizadas.
    • Para o recurso Suporte de documento PDF, carregue as propriedades do documento no Plug-in do RICOH ProcessDirector para Adobe Acrobat.
    • Para o recurso Suporte AFP, acesse o RICOH Visual Workbench a partir da interface com o usuário do RICOH ProcessDirector. As novas propriedades do documento serão carregadas no RICOH Visual Workbench quando ele for aberto na estação de trabalho.

Propriedades de banco de dados e propriedades limitadas

Você pode definir dois tipos de propriedades do documento:

  • Propriedades do banco de dados
  • Propriedades limitadas

Você pode armazenar e manipular os dois tipos de propriedade em um arquivo de propriedades do documento, mas somente as propriedades do banco de dados são armazenadas no banco de dados.

Você pode trabalhar com os dois tipos de propriedade da seguinte maneira:

  • Usá-las com etapas em um fluxo de trabalho para agrupar ou classificar documentos (por exemplo, com o modelo de etapa SortDocuments).
  • Você pode vinculá-las às tags de índice AFP usando o RICOH Visual Workbench Document Property Designer.
  • Você pode mapear a elas os dados de documento em tarefas PDF usando o Plug-in do RICOH ProcessDirector para Adobe Acrobat.
  • Se tiver o recurso Arquivo, você poderá armazená-las em um repositório. Depois de armazená-las, você pode usá-las para pesquisar o repositório e recuperar tarefas, documentos e informações do histórico. Os valores das propriedades aparecem na guia Propriedades quando você clica em Mostrar Detalhes na tabela de Resultados.
  • Se tiver o recurso Gerenciamento de preferência, você poderá usar um arquivo de preferência externo para configurar os valores das propriedades.

Você pode trabalhar com as propriedade do banco de dados da seguinte maneira:

  • Usá-las para pesquisar documentos no portlet Documentos, na página Principal da interface com o usuário.
  • Ao selecionar um documento no portlet Documentos, os valores das propriedades do banco de dados são exibidos.
  • Usá-las para pesquisar documentos para exibir no visualizador.
  • Você pode determinar os valores em uma tarefa, atualizá-los em outra tarefa e utilizar os valores atualizados na tarefa original.
  • Se tiver o recurso Verificação automatizada ou Insersor, você poderá usar as propriedades de banco de dados para pesquisar documentos para reconciliar ou reimprimir.
  • Se tiver o recurso estendido do Pool de documentos avançado, você poderá usar seletores para manipular documentos com base em seus valores de propriedade.

As propriedades limitadas oferecem as seguintes vantagens:

  • Você pode usá-las para evitar a exibição de valores de propriedades sensíveis na interface com o usuário, como números de Segurança Social ou quantidades para verificação.
  • Elas maximizam o desempenho do sistema. A manipulação das propriedades do banco de dados pode degradar o desempenho se você processar um número significativo de documentos.

Trabalhe com o seu representante de suporte para determinar sua necessidade referente às propriedades de documentos do banco de dados e às propriedades limitadas.

Seções no arquivo de amostra

A amostra de arquivo docCustomDefinitions.xml contém várias seções. Esta tabela contém um resumo delas.

Seções no arquivo docCustomDefinitions.xml

Seção Propósito
Esquema A seção do esquema identifica o esquema e a cadeia de caracteres exclusiva para as propriedades do documento personalizado. Somente o representante do suporte deve editar esta seção.
Propriedades do banco de dados Esta seção define as propriedades de documentos do banco de dados.
Propriedades limitadas Esta seção define as propriedades limitadas dos documentos:
Propriedades de autorização do usuário Esta seção é opcional. As propriedades de autorização do usuário especificam os grupos de autoridade personalizado para acessar às propriedades do banco de dados.

Seção Esquema

A seção Esquema contém um elementodocCustomDefinitions e um elemento schema. Somente os representantes do suporte devem editar a seção do esquema.

Seção de propriedades do banco de dados

A seção Propriedades do banco de dados contém o elemento docProperty.

    Obs.:
  • Não definir uma propriedade como propriedade de banco de dados e propriedade limitada. Um comportamento inesperado pode ocorrer.
  • Não defina uma propriedade do documento com o mesmo nome de uma propriedade definida automaticamente pelo RICOH ProcessDirector . Veja uma lista em Propriedades do documento definidas automaticamente.
<docProperty>
Define as propriedades do documento que estão na base de dados.

Atributos para o elemento docProperty

Atributo docProperty Necessário? Observações
nome Sim O nome do banco de dados (nome interno) da propriedade. Programas que leem ou gravam propriedades utilizam esse nome. Recomendamos o uso de uma convenção de nomenclatura consistente para seus nomes de propriedades personalizadas, para que sejam exclusivos em todo o sistema. Por exemplo, o arquivo de amostra docCustomDefinitions.xml utiliza o prefixo Doc.Custom para fazer suas propriedades exclusivas do produto base.

Não utilize nenhum espaço ou caractere especial (como @, #, $, % ou - (traço)) no nome da propriedade. É possível usar pontos e sublinhados.

Não use um número imediatamente após o ponto (.) no nome da propriedade do banco de dados. Por exemplo, a propriedade Doc.3rdLineAddress não é válida.

acesso Não O nível de acesso do usuário para a propriedade. Você pode usar um nível de acesso que já está definido no produto ou pode criar um nível de acesso personalizado se o existente não atende suas necessidades. Consulte a seção Acesso para ter mais informações.
datatype Sim O tipo de dados a ser usado para a propriedade. Consulte a próxima tabela.
dbType Não Um parâmetro de banco de dados que especifica o tipo de dados.
    Obs.:
  • A propriedade dbType é obsoleta e não é mais usada. Use a propriedade datatype em vez disso.
subtítulo Sim O nome da interface com o usuário (legenda padrão) da propriedade. Se você estiver configurando legendas em apenas um idioma, defina as legendas neste arquivo. Se você estiver configurando nomes para as interfaces com o usuário em mais de um idioma, crie arquivos adicionais de nomes de propriedades do documento (docCustomDefinitions_languageproperties) para os outros idiomas. Para obter mais informações, consulte Arquivo docCustomDefinitions.properties.
shortCaption Sim A legenda curta padrão exibida para esta propriedade, quando necessário, como em cabeçalhos das colunas da tabela. Se você estiver configurando legendas curtas em apenas um idioma, defina as legendas neste arquivo. Se você estiver configurando legendas curtas em mais de um idioma, crie arquivos adicionais de nomes de propriedades do documento (docCustomDefinitions_languageproperties) para os outros idiomas. Para obter mais informações, consulte Arquivo docCustomDefinitions.properties.
descrição Sim A descrição padrão da propriedade documento, que é exibida na interface do usuário como texto de ajuda. Se você estiver configurando descrições em apenas um idioma, defina as legendas neste arquivo. Se você estiver configurando descrições em mais de um idioma, crie arquivos adicionais de nomes de propriedades do documento (docCustomDefinitions_languageproperties) para os outros idiomas. Para obter mais informações, consulte Arquivo docCustomDefinitions.properties.

Você pode usar esses tipos de dados e tipos de banco de dados nas definições de propriedades do banco de dados. Lembre-se de que a definição do banco de dados pode restringir ainda mais os valores que podem ser armazenados, além das regras de validação mostradas nesta tabela. Por exemplo, um SMALLINT pode armazenar números inteiros de 0 a 32.767. Os valores de tipo de banco de dados não são sensíveis a maiúsculas.

Tipos de dados e tipos de banco de dados para as definições de docProperty

Tipo de dados Tipo de banco de dados (usado em SQL) Validação de tipo de dados
Sequência VARCHAR(128) VARCHAR: comprimento variável, 1–128 caracteres
IntegerNonNeg SMALLINTBIGINTINTEGER SMALLINT: 2 bytesBIGINT: 4 bytesINTEGER: 8 bytesMinimum=0
Registro de data e hora TIMESTAMP TIMESTAMP: Must contain values for day (D), month (M), and year (Y).Those components can appear in one of these formats:MM DD YYYYDD MM YYYYYYYY MM DDDay and month must be represented by a two-digit number.You can add a time of day in this format:hh:mm:ss
XdkString10 VARCHAR(10) VARCHAR: comprimento variável, 1-10 caracteres

    Obs.:
  • Esses valores são variações do tipo de dados de Cadeia que podem ser usados em vez de Cadeia para reduzir a quantidade de espaço reservado no banco de dados de valores de propriedade.

XdkString20 VARCHAR(20) VARCHAR: comprimento variável, 1-20 caracteres

    Obs.:
  • Esses valores são variações do tipo de dados de Cadeia que podem ser usados em vez de Cadeia para reduzir a quantidade de espaço reservado no banco de dados de valores de propriedade.

XdkString30 VARCHAR(30) VARCHAR: comprimento variável, 1-30 caracteres

    Obs.:
  • Esses valores são variações do tipo de dados de Cadeia que podem ser usados em vez de Cadeia para reduzir a quantidade de espaço reservado no banco de dados de valores de propriedade.

XdkString40 VARCHAR(40) VARCHAR: comprimento variável, 1-40 caracteres

    Obs.:
  • Esses valores são variações do tipo de dados de Cadeia que podem ser usados em vez de Cadeia para reduzir a quantidade de espaço reservado no banco de dados de valores de propriedade.

XdkString50 VARCHAR(50) VARCHAR: comprimento variável, 1-50 caracteres

    Obs.:
  • Esses valores são variações do tipo de dados de Cadeia que podem ser usados em vez de Cadeia para reduzir a quantidade de espaço reservado no banco de dados de valores de propriedade.

XdkString128 VARCHAR(128) VARCHAR: comprimento variável, 1–128 caracteres

    Obs.:
  • Esses valores são variações do tipo de dados de Cadeia que podem ser usados em vez de Cadeia para reduzir a quantidade de espaço reservado no banco de dados de valores de propriedade.

Seção de propriedades limitadas

A seção Propriedades limitadas contém um ou mais elementos DocProperty.

    Obs.:
  • Não definir uma propriedade como propriedade de banco de dados e propriedade limitada. Um comportamento inesperado pode ocorrer.
  • Não defina uma propriedade do documento com o mesmo nome de uma propriedade definida automaticamente pelo RICOH ProcessDirector . Veja uma lista em Propriedades do documento definidas automaticamente.
<docProperty>
Define as propriedades do documento manipuladas apenas no arquivo de propriedades do documento e não no banco de dados.

Atributos para o elemento docProperty

Atributo docProperty Necessário? Observações
nome Sim Recomendamos o uso de uma convenção de nomenclatura consistente para seus nomes de propriedades personalizadas, para que sejam exclusivos em todo o sistema. Por exemplo, o arquivo de amostra docCustomDefinitions.xml utiliza o prefixo Doc.Custom para fazer suas propriedades exclusivas do produto base.

Não utilize nenhum espaço ou caractere especial (como @, #, $, % ou - (traço)) no nome da propriedade. É possível usar pontos e sublinhados.

Não use um número imediatamente após o ponto (.) no nome da propriedade do banco de dados. Por exemplo, a propriedade Doc.3rdLineAddress não é válida.

datatype Não Consulte a próxima tabela.
subtítulo Não A legenda exibida nas listas da interface com o usuário para essa propriedade. Se você estiver configurando legendas em apenas um idioma, defina as legendas neste arquivo. Se você estiver configurando legendas em mais de um idioma, crie um arquivo de nomes de propriedades do documento (docCustomDefinitions_languageproperties) para os outros idiomas. Consulte o tópico do centro de informações relacionado para ter mais detalhes.

Você pode usar esses tipos de dados nas definições de docProperty:

Tipos de dados do elemento docProperty

Tipo de dados Validação de tipo de dados
Sequência
Nenhum
IntegerNonNeg
Inteiro entre 0 e 2147483647
Registro de data e hora TIMESTAMP: Must contain values for day (D), month (M), and year (Y).Those components can appear in one of these formats:MM DD YYYYDD MM YYYYYYYY MM DDDay and month must be represented by a two-digit number.You can add a time of day in this format:hh:mm:ss

Seção de propriedades de autorização do usuário

A seção Propriedades de autorização do Usuário é opcional. As propriedades de autorização do usuário especificam os grupos de autoridade personalizado para acessar às propriedades do banco de dados. Esta seção contém um ou mais elementos de .acesso.

<acesso>
Usada para definir a capacidade de ler ou editar propriedades personalizadas. Você usa esses níveis de acesso no elemento docProperty. Você pode usar um dos grupos de segurança padrão que o RICOH ProcessDirector fornece ou definir seu próprio grupo. Estes são os atributos:

Atributos para o elemento de acesso

atributo de acesso Observações
nome Nome do nível de acesso.
groupAttributeAccess Capacidade do grupo de usuário para ler ou editar o atributo.
Estes são os níveis de acesso padrão e autorizações que o RICOH ProcessDirector fornece:

Níveis de acesso e autorizações padrão

Nome de acesso Nome do Grupo Nível de acesso
genérico AnyAuthenticated Acesso do atributo: leitura
Operador Acesso do atributo: leitura
Supervisor Acesso do atributo: leitura
Administrador Acesso do atributo: gravação
attrWriteAdmin Operador Acesso do atributo: leitura
Supervisor Acesso do atributo: leitura
Administrador Acesso do atributo: gravação
Todos Acesso do atributo: leitura
Monitor Acesso do atributo: leitura
attrWriteAdminSuper Operador Acesso do atributo: leitura
Supervisor Acesso do atributo: gravação
Administrador Acesso do atributo: gravação
Todos Acesso do atributo: leitura
Monitor Acesso do atributo: leitura
attrWriteAdminSuperOper Operador Acesso do atributo: gravação
Supervisor Acesso do atributo: gravação
Administrador Acesso do atributo: gravação
Todos Acesso do atributo: leitura
Monitor Acesso do atributo: leitura
actionAdmin Operador Acesso à ação: falso
Supervisor Acesso à ação: falso
Administrador Acesso à ação: verdadeiro
Todos Acesso à ação: falso
Monitor Acesso à ação: falso
actionAdminSuper Operador Acesso à ação: falso
Supervisor Acesso à ação: verdadeiro
Administrador Acesso à ação: verdadeiro
Todos Acesso à ação: falso
Monitor Acesso à ação: falso
actionAdminSuperOper Operador Acesso à ação: verdadeiro
Supervisor Acesso à ação: verdadeiro
Administrador Acesso à ação: verdadeiro
Todos Acesso à ação: falso
Monitor Acesso à ação: falso

Propriedades do documento definidas automaticamente

Essa tabela lista as propriedades do documento que o RICOH ProcessDirector define automaticamente durante a instalação. Não defina essas propriedades no arquivo docCustomDefinitions.xml.

Propriedades do documento definidas automaticamente

Nome do banco de dados de propriedades Incluído no pacote com... Observações
Doc.Address.1 Ativação postal Especifica a primeira linha do bloco de endereço no documento.
Doc.Address.Company Ativação postal Especifica o nome da empresa no documento.
Doc.Address.PostalCode Ativação postal Especifica o código postal no documento.
Doc.Address.ZipCode Ativação postal Especifica o código postal no documento.
Doc.AV.ScanCount Verificação automatizada Mostra o número de vezes de leitura do código de barras do documento.
Doc.ChildJobID Todos os recursos de processamento de documento Um identificador de agrupamento para tarefas filho. Embora o valor seja definido inicialmente em IdentifyDocuments ou IdentifyPDFDocuments, ele pode ser atualizado por qualquer etapa que altera o arquivo de propriedades do documento, como SplitDocuments ou CreateJobsFromDocuments.
Doc.CurrentFirstPage Todos os recursos de processamento de documento O número de página da primeira página do documento no arquivo de impressão atual.
Doc.CurrentJobID Todos os recursos de processamento de documento O número de tarefa associado.
Doc.CurrentPages Todos os recursos de processamento de documento O número de páginas para o documento na tarefa atual.
Doc.CurrentSequence Todos os recursos de processamento de documento A seqüência do documento na tarefa atual.
Doc.CurrentSheets Todos os recursos de processamento de documento O número de folhas para o documento na tarefa atual.
Doc.Custom.MemberLevel Electronic Presentment O nível de associação do cliente no momento em que a instrução foi criada.
Doc.Custom.PURL Electronic Presentment Uma URL personalizada para ser vinculada ao local em que o cliente pode recuperar a instrução.
Doc.Custom.StatementDate Electronic Presentment A data de quando a instrução foi emitida pela primeira vez.
Doc.DataLen Todos os recursos de processamento de documento O comprimento (em bytes) do documento no arquivo de impressão.
Doc.DataOffset Todos os recursos de processamento de documento O deslocamento em byte do documento no arquivo de impressão da tarefa original. Esse valor é usado por BuildAFPFromDocuments e CreateAFPJobsFromDocuments para localizar o AFP para extrair a tarefa original.
Doc.DocSize.PieceThickness Ativação postal Especifica a espessura de uma mala postal quando as malas postais de uma tarefa apresentam espessuras diferentes.
Doc.DocSize.PieceWeight Ativação postal Especifica o peso de uma mala postal quando as malas postais de uma tarefa apresentam pesos diferentes.
Doc.Email.Sent Todos os recursos de processamento de documento Especifica se um e-mail que contenha um documento anexado foi criado e entregue ao servidor SMTP pela etapa Enviar documentos por e-mail do fluxo de trabalho.
Doc.EmailAddress Todos os recursos de processamento de documento O endereço de e-mail associado ao documento.
Doc.ID Todos os recursos de processamento de documento Um identificador exclusivo para o documento.
Doc.Insert.BinTriggers Insersor Os compartimentos do insersor que devem oferecer inserções para este documento.
Doc.Insert.DivertBin Insersor O número do compartimento de saída do insersor para o qual o documento é desviado após a inserção.
Doc.Insert.OriginalBarCode Insersor Os dados no código de barras que controla a inserção do documento.
Doc.Insert.RecipientName Insersor O nome da pessoa para quem este documento é enviado.
Doc.Insert.ReprintJobId Insersor Para uma tarefa de reimpressão de um insersor, o ID da tarefa pai que criou a tarefa.
Doc.Member.Number Arquivo Especifica o número de membro no documento. O fluxo de trabalho RepositorySample fornecido utiliza essa propriedade.
Doc.OriginalFirstPage Todos os recursos de processamento de documento O número de página da primeira página do documento.
Doc.OriginalJobID Todos os recursos de processamento de documento O ID de tarefa da tarefa original.
Doc.OriginalPages Todos os recursos de processamento de documento O número de páginas no documento.
Doc.OriginalSequence Todos os recursos de processamento de documento A sequência do documento na tarefa original. O sistema dá ao primeiro documento o valor de seqüência 1, o próximo documento tem o valor de seqüência 2, e assim por diante.
Doc.OriginalSheets Todos os recursos de processamento de documento O número de folhas necessárias para imprimir o documento.
Doc.Postal.AddressProcessingRC Ativação postal Um valor retornado do software postal para indicar se há uma mudança de endereço disponível para o documento.
Doc.Postal.Category Ativação postal Especifica a marca de quebra do palete para o documento.
Doc.Postal.ChangeAddressRC Ativação postal Especifica o número do palete para o documento.
Doc.Postal.ContainerBreakMark Ativação postal Especifica a marca de quebra do contêiner para o documento.
Doc.Postal.ContainerNumber Ativação postal Especifica o número do contêiner para o documento.
Doc.Postal.HandlingUnitBreakMark Ativação postal Especifica a marca de quebra do pacote para o documento.
Doc.Postal.HandlingUnitNumber Ativação postal Especifica o número do pacote para o documento.
Doc.Postal.PackageBreakMark Ativação postal Especifica a taxa de postagem para o documento.
Doc.Postal.PackageNumber Ativação postal Especifica o código da taxa de postagem para o documento.
Doc.Postal.PostageRate Ativação postal Especifica o número da sequência de pré-classificação para o documento.
Doc.Postal.PostageRateCode Ativação postal Um valor retornado do software postal para ordenar o resultado do seu processamento.
Doc.Postal.SequenceNumber Ativação postal A sequência do documento na tarefa filha.
Doc.Postal.SequencingProcessingRC Ativação postal O estado do documento.
Doc.Pref.Member Gerenciamento de preferência Pode ser usado com um objeto de mapeamento de propriedades para identificar os documentos de uma tarefa. O objeto de mapeamento de propriedades DelimitedSample fornecido e o fluxo de trabalho PreferencesSample fornecido utilizam essa propriedade.
Doc.Pref.Output Gerenciamento de preferência Pode ser usado com um objeto de mapeamento de propriedades para indicar o tipo de saída (como e-mail, Imprimir ou Suprimir) de um documento. O objeto de mapeamento de propriedades DelimitedSample fornecido e o fluxo de trabalho PreferencesSample fornecido utilizam essa propriedade.
Doc.Pull Todos os recursos de processamento de documento Pode ser usado com o modelo de etapa SetDocPropsFromList para indicar que um documento deve ser removido de uma tarefa. Os fluxos de trabalho PullPDFSample e PullAFPSample fornecidos usam essa propriedade.
Doc.PullProp Todos os recursos de processamento de documento Pode ser usado com o modelo de etapa SetDocPropsFromList para identificar qual propriedade do documento determina quais documentos devem ser removidos de uma tarefa. Os fluxos de trabalho PullPDFSample e PullAFPSample fornecidos usam essa propriedade.
Doc.SequenceInChild Todos os recursos de processamento de documento A sequência de um documento em uma tarefa filho. Embora o valor seja definido inicialmente em IdentifyDocuments, ele pode ser atualizado por qualquer etapa que altera o arquivo de propriedades do documento, como SortDocuments ou CreateJobsFromDocuments.
Doc.SourceFileName Todos os recursos de processamento de documento O nome do arquivo de entrada que continha o documento.
Doc.State Todos os recursos de processamento de documento O estado atual do documento.
Doc.TT.BarcodeStatus1 Verificação automatizada Mostra se a câmera ou o leitor leu o código de barras lido corretamente em um documento com uma etapa ReadBarcodeData.
Doc.TT.BarcodeStatus2 Verificação automatizada Mostra se a câmera ou o leitor leu o código de barras lido corretamente em um documento com uma etapa ReadBarcodeData.
Doc.TT.BarcodeStatus3 Verificação automatizada Mostra se a câmera ou o leitor leu o código de barras lido corretamente em um documento com uma etapa ReadBarcodeData.
Doc.TT.BarcodeStatus4 Verificação automatizada Mostra se a câmera ou o leitor leu o código de barras lido corretamente em um documento com uma etapa ReadBarcodeData.
Doc.TT.BarcodeStatus5 Verificação automatizada Mostra se a câmera ou o leitor leu o código de barras lido corretamente em um documento com uma etapa ReadBarcodeData.
Doc.Verification.Recipient Verificação automatizada Especifica informações, como nome da conta, que ajudam você a identificar um documento.