Usar a ferramenta Exportação e importação de plano de arquivo

Visão geral

Para as implementações do IBM InfoSphere Enterprise Records, você pode usar a Ferramenta de Exportação e Importação de Planejamentos de Arquivos para importar um planejamento de arquivo externo ou exportar um planejamento de arquivo para um ambiente externo. A ferramenta usa um arquivo XML para completar os processos de importação e exportação. Para obter informações detalhadas sobre o esquema XML e seus elementos, consulte Esquema XML de plano de arquivo.

Para obter detalhes sobre como modificar um arquivo XML exportado para incluir herança de planejamento, retenções alternativas, acionadores de descarte e suspensões dinâmicas (suspensões condicionais), consulte a seção Ferramenta de Importação e Exportação de Planejamento de Arquivos no Guia de Resolução de Problemas do FileNet P8 encontrado na Documentação do Produto para a Plataforma FileNet P8 .

Limitações

A ferramenta Exportação e importação de plano de arquivo facilita a migração de planos de arquivo. No entanto, a ferramenta não suporta o seguinte:

Além disso, primeiro você precisa exportar e importar propriedades personalizadas (como listas de escolhas) e classes em um arquivo XML separado, antes de importar o resto do plano de arquivo. Além disso, após importar um plano de arquivo, os estados da entidade como Fechada ou Pronta para disposição, não mais estão em efeito.

Executar a ferramenta

Você pode executar a ferramenta Exportação e importação de plano de arquivo a partir de uma linha do comando do executável Java, ou pode iniciar a ferramenta com o arquivo de comando, FilePlanTool.bat ou FilePlanTool.sh.

Você pode executar a ferramenta usando um destes cinco modos:

Configurar a ferramenta

Antes de executar a ferramenta no modo de importação ou exportação, é preciso configurá-la.

Para configurar a ferramenta

  1. Navegue para a pasta onde a ferramenta Exportação e importação de plano de arquivo está instalada.
  2. Execute um dos seguintes na linha de comando:

    No Windows®:
    FilePlanTool -mode configure

    No UNIX®:
    ./FilePlanTool.sh -mode configure

    Insira as seguintes informações na caixa de diálogo Ferramenta de plano de arquivo:

Exportar um plano de arquivo

Se um plano de arquivo que você deseja exportar contiver qualquer um dos itens a seguir:

Consulte Exportar um plano de arquivo com a opção de escopo.

Após configurar a ferramenta, você pode usá-la para exportar um plano de arquivo. Para exportar um plano de arquivo, digite o seguinte comando:

FilePlanTool -mode export -fileplan <file plan name> -o <XML filename.xml>

onde o nome do plano de arquivo é o nome do plano de arquivo a ser exportado e é requerido. Se o nome do plano de arquivo contiver espaços ou caracteres especiais, coloque nome do plano de arquivo entre aspas.

Nome do arquivo XML é o nome e o caminho do arquivo que você deseja criar. Se você não fornecer um nome de arquivo na linha de comando, a ferramenta irá usar o nome padrão de arquivo especificado pelo campo Nome do arquivo de saída na caixa de diálogo de configuração da ferramenta. Para obter informações detalhadas sobre como especificar o nome de arquivo de saída XML padrão, consulte Configurar a ferramenta.

Exportar um plano de arquivo com a opção de escopo

Quando você exporta um plano de arquivo, use a opção de escopo para planos grandes de arquivos ou para planos de arquivos que contenham classes ou propriedades personalizadas.

Para exportar um plano de arquivo usando a opção de escopo, digite o seguinte comando:

FilePlanTool -mode export -fileplan <file plan name> -o <XML filename.xml> -scope <parameter>

onde o nome do plano de arquivo é o nome do plano de arquivo a ser exportado e é requerido. Se o nome do plano de arquivo contiver espaços ou caracteres especiais, coloque nome do plano de arquivo entre aspas.

Nome do arquivo XML é o nome e o caminho do arquivo que você deseja criar. Se você não fornecer um nome de arquivo na linha de comando, a ferramenta irá usar o nome padrão de arquivo especificado pelo campo Nome do arquivo de saída na caixa de diálogo de configuração da ferramenta. Quando você usa a ferramenta com a opção de escopo, a ferramenta cria um arquivo XML para cada parte do plano de arquivo. Portanto, você precisa especificar um nome diferente de arquivo XML cada vez que usar a ferramenta no modo de exportação. Para obter informações sobre como especificar o nome de arquivo de saída XML padrão, consulte Configurar a ferramenta.

parâmetro pode ser qualquer um dos seguintes:

FilePlanTool.bat mode export scope includecategory /Cat01/Cat02/Cat03 o expfile.xml

FilePlanTool.bat -mode export scope includecategories file01.txt o export01.xml

File01.txt contém:

/categoryB
/CategoryC/SubcategoryC2
/CatogoryA/SubcategoryA1

O nome da categoria é representado pelo nome completo do caminho e uma categoria de registro por linha.

Importar/Atualizar um plano de arquivo

Para importar um plano de arquivo ou um segmento do mesmo, execute a ferramenta no modo de importação e especifique o arquivo XML que a ferramenta criou no modo de exportação.

Se seu plano de arquivo contém classes ou propriedades personalizadas, o processo de importação requer duas etapas. Uma etapa importa as classes e propriedades personalizadas no plano de arquivo e a segunda etapa importa o remanescente do plano de arquivo. Importe primeiro as classes e propriedades personalizadas, e aguarde ao menos cinco minutos antes de importar o plano de arquivo, já que os metadados da classe e propriedade personalizados são mantidos no cache da memória. O tempo de vida do cache (TTL) é de cinco minutos, após o cache é limpo.

Para importar/atualizar um plano de arquivo, digite o seguinte comando:

FilePlanTool -mode import -f <XML filename.xml> -reimportoption <option>

FilePlanTool -mode update -f <XML filename.xml> -reimportoption <option>

Nome do arquivo XML é o nome e o caminho do arquivo que você deseja importar. Se você não fornecer um nome de arquivo na linha de comando, a ferramenta irá usar o nome padrão de arquivo especificado pelo campo Nome do arquivo de saída na caixa de diálogo de configuração da ferramenta. Para obter informações sobre como especificar o nome de arquivo de saída XML padrão, consulte Configurar a ferramenta.

A opção de reimportação determina o comportamento padrão da ferramenta ao importar uma entidade que já existe em um plano de arquivo. Para obter informações detalhadas sobre a opção de reimportação, consulte Usar a opção de reimportação.

No modo Importação, a ferramenta não usa a opção de escopo, mas verifica um marcador XML para determinar o que importar. Você precisa fornecer um nome diferente de arquivo XML para metadados (classes e propriedades personalizadas) e o plano de arquivo.

NOTA  A tag ClassificationScheme no arquivo XML especifica o nome do plano de arquivo.

Você pode executar a ferramenta no modo Atualizar para efetuar modificações secundárias após a importação inicial de um plano de arquivo e pode distinguir atualizações subseqüentes dos arquivos XML inicialmente importados. Especifique update como o atributo InputMode do marcador FilePlan no arquivo XML. Você pode modificar uma propriedade personalizada (tal como uma lista de escolhas) ao usar o modo Atualizar.

Consulte o Guia de solução de problemas do FileNet P8 se você receber uma mensagem de erro ou se o processo de importação parar. Na maioria dos casos, o processo de importação pára após encontrar um erro e não exibe nenhuma mensagem.

Se necessário, execute a Varredura de suspensão para aplicar suspensões condicionais nas entidades após a importação, já que a ferramenta não importa suspensões condicionais. Consulte Limitações.

Validar um plano de arquivo

Após você criar manualmente um arquivo XML, verifique se o arquivo XML não contém erros ou questões de não conformidade, ao validá-lo através da ferramenta Exportação e importação de plano de arquivo.

Para executar a ferramenta Exportação e importação no modo de validação, digite o seguinte comando:

FilePlanTool -mode validate -f <XML filename.xml>

Nome do arquivo XML é o nome e o caminho do arquivo que você deseja validar. Se você não fornecer um nome de arquivo na linha de comando, a ferramenta irá usar o nome padrão de arquivo especificado pelo campo Nome do arquivo de saída na caixa de diálogo de configuração da ferramenta. Para obter informações sobre como especificar o nome de arquivo de saída XML padrão, consulte Configurar a ferramenta.

Usar a opção de reimportação

Use a opção de reimportação para determinar o comportamento padrão da ferramenta ao importar uma entidade que já exista em um plano de arquivo. A opção de reimportação tem três parâmetros:

Use a opção Ignorar após a falha na importação de um plano grande de arquivo. Durante a segunda tentativa de importar o mesmo plano de arquivo, a opção Ignorar evita reimportar as entidades que tenham sido importadas com êxito. No entanto, se a segunda tentativa de importação requer modificações secundárias em entidades que tenham sido importadas com êxito na primeira vez, use a opção Substituir.

Durante importações subseqüentes de modificações secundárias para um número menor de entidades, especifique Action="Modify" (na seção RMEntityObjectType do arquivo XML) para a entidades, em vez de fazer alterações no arquivo XML original. Também use o modo Atualizar para identificar com mais facilidade atualizações subseqüentes de importações completas iniciais. Consulte Importar/atualizar um plano de arquivo.