Defina um formato de arquivo no Jitterbit Design Studio

O Jitterbit permite que você use tipos de arquivos simples ou complexos como fontes ou destinos durante o processo de transformação de dados. Arquivos simples têm o mesmo tipo de linha de dados em todo o documento de texto, enquanto arquivos complexos contêm múltiplos tipos de linha de arquivo, como linhas de cabeçalho ou resumo.

Como parte do processo de transformação, é necessário definir o Formato de Arquivo para que o Jitterbit saiba como processar os dados. Normalmente, os Formatos de Arquivo são gerados como parte do assistente durante a criação da sua integração. Após a criação de um Formato de Arquivo, você pode modificá-lo na seção de Formatos de Arquivo na árvore do lado esquerdo do Studio. Se precisar definir um formato de arquivo personalizado, você pode criar um novo Formato de Arquivo a partir da mesma seção.

Esta página aborda como definir o Formato de Arquivo de um documento de texto a ser usado como fonte ou destino.

Crie um novo formato de arquivo

Normalmente, os Formatos de Arquivo são gerados como parte do assistente durante a criação da sua integração. Você também pode gerar um novo Formato de Arquivo separadamente por meio de um dos seguintes métodos:

• Vá para Arquivo > Novo > Novo Formato de Arquivo.
• Clique no ícone na barra de ferramentas.
• Clique com o botão direito em Formatos de Arquivo no painel esquerdo do Studio e escolha Novo Formato de Arquivo no menu.

Seu novo Formato de Arquivo será listado na seção de Formatos de Arquivo no painel esquerdo do Studio. Além disso, uma tela para configurar seu novo Formato de Arquivo será aberta no painel direito do Studio. Aqui você escolhe se deseja especificar a estrutura manualmente ou a partir de um arquivo de amostra:

• Criar Manualmente: Digite manualmente os nomes e tipos dos campos enquanto configura seu Formato de Arquivo.

• A partir de Arquivo de Amostra: Use um arquivo de amostra, se disponível, conforme descrito em Criando uma definição de documento de texto a partir de um arquivo de amostra.

  Nota

  Esta opção está disponível apenas para a criação de um formato de arquivo simples (plano).

Para Formatos de Arquivo que estão sendo criados manualmente, você também precisará selecionar o tipo de documento, bem como o formato.

• Documento de Texto Simples: Arquivos simples têm o mesmo tipo de linha de dados em todo o documento de texto.
• Documento de Texto Complexo: Arquivos complexos contêm múltiplos tipos de linha de arquivo, como linhas de cabeçalho ou resumo.

Tanto os tipos de documento simples quanto complexos permitem formatos delimitados por caracteres e de largura fixa de campo.

Clique no botão para continuar para a próxima tela de configuração.

Você também pode voltar à configuração existente a qualquer momento pelo painel esquerdo do Studio em Formatos de Arquivo.

Configurar campos manualmente

Após escolher criar seu Formato de Arquivo manualmente, outra tela de configuração será usada para definir cada campo em seu documento. Esta próxima etapa depende do tipo de estrutura de texto que você selecionou – simples ou complexa – assim como do formato que você selecionou – delimitado por caracteres ou de largura fixa de campo.

Documento de texto simples – delimitado por caracteres

Se você selecionou um documento de texto simples que é delimitado por caracteres, sua tela configurada deve parecer semelhante à abaixo. A seguir está uma explicação para cada seção configurável.

Delimitador & qualificador

• Delimitador de Campo: Insira o(s) caractere(s) a serem usados como delimitador(es) de campo que especificam o limite entre os campos de dados. O padrão é uma vírgula. Você também pode usar delimitadores de múltiplos caracteres, como um pipe duplo ||. Para usar uma tabulação como delimitador, insira \t.

• Qualificador de String & Usar qualificador: Insira o caractere a ser usado como um envoltório, indicando uma string de texto que deve ser tratada como uma única unidade de dados. O padrão é um caractere de aspas duplas. Se deixado em branco, nenhum qualificador de string é usado.

Quando usar um Qualificador de String, selecione uma regra de negócios correspondente, seja Sempre ou Somente quando necessário, para indicar quando o qualificador deve ser usado. O padrão, Somente quando necessário, é recomendado, para que, se o(s) caractere(s) especificado(s) como o Delimitador de Campo ocorrer(em) dentro da string, a string seja envolvida pelo caractere do qualificador de string especificado. Se o delimitador não ocorrer, a string não é envolvida.

Durante o processamento das fontes, o qualificador de string é removido. Durante o processamento dos alvos, o qualificador de string é adicionado.

• Usar quebras de linha para o final dos registros: A partir da versão 8.19, esta caixa de seleção é usada para ativar ou desativar o uso de quebras de linha como separação entre registros. Por padrão, o final dos registros é denotado por quebras de linha, de modo que cada registro exista em uma linha (a menos que esteja usando um qualificador). Quando desativado, as quebras de linha são ignoradas e novos registros começam após o número total de campos ser alcançado.

  Nota

  Esta flag é relevante apenas para formatos de arquivos de origem. Para arquivos de destino, as quebras de linha são sempre usadas para denotar o final dos registros.

• Converter sequências de escape: A partir da versão 8.23, esta caixa de seleção é usada para converter ou ignorar sequências de escape, conforme indicado por uma barra invertida (\). Por padrão, as sequências de escape são convertidas de acordo com os padrões do Java. Quando desativado, a conversão de texto ocorre sem interpretação das sequências de escape.

  Nota

  Esta flag é relevante apenas para formatos de arquivos de origem.

Validação (opcional)

• A linha deve conter pelo menos 'X' colunas: Se você deseja usar validação de texto (opcional), pode inserir um número de colunas aqui que cada linha deve conter, para que a ação especificada ao lado ocorra.

  Nota

  Você deve ter pelo menos uma linha de dados definida primeiro para habilitar as opções de validação.

• Se não: Após inserir um número de colunas, um menu suspenso ficará disponível, onde você pode selecionar "Pular Linha" ou "Gerar Erro." Mais informações sobre validação estão disponíveis em Validação de campo de arquivo plano.

Definir propriedades do segmento

Clique no botão Novo para definir o primeiro campo do documento. Você deve inserir o seguinte (obrigatório):

• Nome do Campo: Insira um nome para este campo.

• Tipo: Selecione um tipo no menu suspenso. As opções incluem String, Inteiro, Data, Longo, Flutuante, Duplo, Booleano.

  Nota

  Se houver dúvidas sobre o tipo de campo, recomenda-se escolher String, pois esse tipo permite que qualquer tipo de dado seja incluído como uma string.

Os seguintes são opcionais:

• Padrão: Se você quiser que este campo tenha um valor padrão, insira o valor aqui.

• Formato: Se você quiser que este campo tenha um formato específico, como para data ou moeda, insira o formato aqui.

• Validação: Clique duas vezes nesta coluna ou use o botão à direita para abrir opções adicionais para validação de campo. Mais informações sobre validação estão disponíveis em Validação de campo de arquivo plano.

Repita as etapas anteriores para cada campo de dados adicional que você precisa definir.

Documento de texto simples – larguras de campo fixas

Se você selecionou um documento de texto simples que possui larguras de campo fixas, sua tela configurada deve se parecer com a abaixo. A seguir, uma explicação para cada seção configurável.

Validação (opcional)

• A linha deve conter pelo menos 'X' colunas: Se você quiser usar a validação de texto (opcional), pode inserir um número de colunas aqui que cada linha deve conter, para que a ação especificada ao lado ocorra.

  Nota

  Você deve ter pelo menos uma linha de dados definida primeiro para habilitar as opções de validação.

• Se não: Após inserir um número de colunas, um menu suspenso ficará disponível, onde você pode selecionar "Ignorar Linha" ou "Gerar Erro." Mais informações sobre validação estão disponíveis em Validação de campo de arquivo plano.

Definir propriedades do segmento

Clique no botão Novo para definir o primeiro campo do documento. É necessário inserir o seguinte (obrigatório):

• Nome do Campo: Insira um nome para este campo.

• Tipo: Selecione um tipo no menu suspenso. As opções incluem String, Inteiro, Data, Longo, Flutuante, Duplo, Booleano.

  Nota

  Se houver dúvidas sobre o tipo de campo, recomenda-se escolher String, pois esse tipo permite que qualquer tipo de dado seja incluído como uma string.

• Início: Insira a posição do caractere inicial (1 é considerado a posição para o início do arquivo). Observe que o valor padrão para as linhas subsequentes será sempre o próximo caractere após a posição final do campo anterior.

• Comprimento: Insira o número de caracteres que são reservados para este campo.

  Nota

  Arquivos de texto de comprimento fixo sempre especificam um certo número de caracteres que são reservados para cada campo. Por exemplo, você pode identificar um campo chamado Sobrenome que sempre tem 30 caracteres reservados para ele. (Se o valor real for Smith, apenas 5 caracteres são usados; os caracteres restantes não contêm nada.)

  Se você alterou o valor do comprimento do caractere de algum campo, use o botão para recalcular todas as posições iniciais dos campos.

  Aviso

  O botão Calcular redefine todos os valores de campo Início e Fim, com base nos valores de Comprimento que você especificou. Não use este botão se as posições dos campos do seu arquivo tiverem lacunas ou sobreposições, pois elas serão excluídas.

• Fim: Insira a posição do caractere final.

  Nota

  Por padrão, segmentos de comprimento fixo são terminados com um caractere de nova linha.

Os seguintes são opcionais:

• Padrão: Se você deseja que este campo tenha um valor padrão, insira o valor aqui.

• Formato: Se você deseja que este campo tenha um formato específico, como para data ou moeda, insira o formato aqui.

• Validação: Clique duas vezes nesta coluna ou use o botão à direita para abrir opções adicionais para validação de campo. Mais informações sobre validação estão disponíveis em Validação de campo de arquivo plano.

Repita as etapas anteriores para cada campo de dados adicional que você precisa definir.

Documento de texto complexo – delimitado por caracteres

Se você selecionou um documento de texto complexo que é delimitado por caracteres, sua tela configurada deve se parecer com a abaixo. A seguir, uma explicação para cada seção configurável.

Delimitador e qualificador

• Delimitador de Campo: Insira o(s) caractere(s) a serem usados como delimitador(es) de campo que especificam o limite entre os campos de dados. O padrão é uma vírgula. Você também pode usar delimitadores de múltiplos caracteres, como um pipe duplo ||. Para usar uma tabulação como delimitador, insira /t.

• Qualificador de String & Usar qualificador: Insira o caractere a ser usado como um invólucro, indicando uma string de texto que deve ser tratada como uma única unidade de dados. O padrão é um caractere de aspas duplas. Se deixado em branco, nenhum qualificador de string é usado.

  Ao usar um Qualificador de String, selecione uma regra de negócios correspondente, seja Sempre ou Somente quando necessário, para indicar quando o qualificador deve ser usado. O padrão, Somente quando necessário, é recomendado, de modo que, se o(s) caractere(s) especificado(s) como o Delimitador de Campo ocorrerem dentro da string, então a string é envolvida pelo caractere qualificador de string especificado. Se o delimitador não ocorrer, então a string não é envolvida.

  Durante o processamento das fontes, o qualificador de string é removido. Durante o processamento dos destinos, o qualificador de string é adicionado.

• EDIFACT: Marque esta caixa se você estiver usando regras de sintaxe EDIFACT dentro do seu arquivo. Se você não souber o que esta opção é, deixe desmarcada.

• Usar quebras de linha para o final dos registros: A partir da versão 8.19, esta caixa de seleção é usada para ativar ou desativar o uso de quebras de linha como separação entre registros. Por padrão, o final dos registros é denotado por quebras de linha, de modo que cada registro exista em uma linha (a menos que esteja usando um qualificador). Quando desativado, as quebras de linha são ignoradas e novos registros começam após o número total de campos ser alcançado.

  Nota

  Esta flag é relevante apenas para formatos de arquivos de origem. Para arquivos de destino, quebras de linha são sempre usadas para denotar o fim dos registros.

• Converter sequências de escape: A partir da versão 8.23, esta caixa de seleção é usada para converter ou ignorar sequências de escape, conforme indicado por uma barra invertida (\). Por padrão, as sequências de escape são convertidas de acordo com os padrões do Java. Quando desativada, a conversão de texto ocorre sem a interpretação de sequências de escape.

  Nota

  Esta flag é relevante apenas para formatos de arquivos de origem.

Definir segmentos

Clique no botão Novo para definir o primeiro segmento do documento. Você deve inserir o seguinte (obrigatório):

• Nome do Segmento: Insira um nome para o segmento.
• Segmento Pai: Identifique o pai deste segmento no menu suspenso.

• Ocorrência: Especifique como o segmento ocorrerá em seu documento complexo escolhendo uma das opções no menu suspenso:

  • Escolha Apenas Uma Vez se este segmento deve ocorrer uma vez, mas apenas uma vez no documento.
  • Escolha Uma ou Mais se este segmento deve ocorrer pelo menos uma vez, mas pode também ser repetido.
  • Escolha Zero ou Uma se este segmento pode não ocorrer, mas se ocorrer, pode ocorrer apenas uma vez.
  • Escolha Zero ou Mais se este segmento pode não ocorrer, mas se ocorrer, pode ocorrer uma ou mais vezes.

Repita os passos anteriores para cada segmento adicional que você precisa definir.

Definir propriedades do segmento

Agora que todos os segmentos foram criados, você precisará definir os campos de cada segmento.

Clique duas vezes na coluna # do segmento desejado ou, com o segmento destacado, clique no botão . A janela pop-up Segmento: Detalhe aparecerá.

Para cada segmento, clique no botão Novo para definir os campos do segmento. Você deve inserir o seguinte (obrigatório):

• Nome do Campo: Insira um nome para este campo.

• Tipo: Selecione um tipo no menu suspenso. As opções incluem String, Inteiro, Data, Longo, Flutuante, Duplo, Booleano.

  Nota

  Se houver dúvidas sobre o tipo de campo, recomenda-se escolher String, pois esse tipo permite que qualquer tipo de dado seja incluído como uma string.

Os seguintes campos são opcionais:

• Padrão: Se você deseja que este campo tenha um valor padrão, insira o valor aqui.
• Formato: Se você deseja que este campo tenha um formato específico, como para data ou moeda, insira o formato aqui.

Repita os passos anteriores para cada campo de dados adicional que você precisa definir.

Documento de texto complexo – larguras de campo fixas

Se você selecionou um documento de texto complexo que possui larguras de campo fixas, sua tela configurada deve se parecer com a abaixo. A seguir, uma explicação para cada seção configurável.

Definir segmentos

Clique no botão Novo para definir o primeiro segmento do documento. Você deve inserir o seguinte (obrigatório):

• Nome do Segmento: Insira um nome para o segmento.
• Segmento Pai: Identifique o pai deste segmento no menu suspenso.

• Ocorrência: Especifique como o segmento ocorrerá em seu documento complexo escolhendo uma das opções no menu suspenso:

  • Escolha Apenas Uma Vez se este segmento deve ocorrer uma vez, mas apenas uma vez no documento.
  • Escolha Uma ou Mais se este segmento deve ocorrer pelo menos uma vez, mas pode ser repetido.
  • Escolha Zero ou Uma se este segmento pode não ocorrer, mas se ocorrer, pode ocorrer apenas uma vez.
  • Escolha Zero ou Mais se este segmento pode não ocorrer, mas se ocorrer, pode ocorrer uma ou mais vezes.

Repita os passos anteriores para cada segmento adicional que você precisa definir.

Definir propriedades do segmento

Agora que todos os segmentos foram criados, você precisará definir os campos de cada segmento.

Clique duas vezes na coluna # do segmento desejado ou, com o segmento destacado, clique no botão . A janela pop-up Segmento: Detalhe aparecerá.

Para cada segmento, clique no botão Novo para definir os campos do segmento. Você deve inserir o seguinte (obrigatório):

• Nome do Campo: Insira um nome para este campo.

• Tipo: Selecione um tipo no menu suspenso. As opções incluem String, Integer, Date, Long, Float, Double, Boolean.

  Nota

  Se houver dúvidas sobre o tipo de campo, recomenda-se escolher String, pois esse tipo permite que qualquer tipo de dado seja incluído como uma string.

• Início: Insira a posição do caractere inicial (1 é considerado a posição para o início do arquivo). Observe que o valor padrão para as linhas subsequentes será sempre o próximo caractere após a posição final do campo anterior.

• Comprimento: Insira o número de caracteres que são reservados para este campo.

  Nota

  Arquivos de texto de comprimento fixo sempre especificam um certo número de caracteres que são reservados para cada campo. Por exemplo, você pode identificar um campo chamado LastName que sempre tem 30 caracteres reservados para ele. (Se o valor real for Smith, apenas 5 caracteres são usados; os caracteres restantes não contêm nada.)

  Se você alterou o valor do comprimento de caracteres de algum campo, use o botão para recalcular todas as posições iniciais dos campos.

  Aviso

  O botão Calcular redefine todos os valores dos campos Início e Fim, com base nos valores de Comprimento que você especificou. Não use este botão se as posições dos campos do seu arquivo tiverem lacunas ou sobreposições, pois elas serão excluídas.

• Fim: Insira a posição do caractere final.

  Nota

  Por padrão, segmentos de comprimento fixo são terminados com um caractere de nova linha.

Os seguintes são opcionais:

• Padrão: Se você quiser que este campo tenha um valor padrão, insira o valor aqui.

• Formato: Se você quiser que este campo tenha um formato específico, como para data ou moeda, insira o formato aqui.

Repita as etapas anteriores para cada campo de dados adicional que você precisa definir.

Configurar campos a partir do arquivo de amostra

Para criar campos a partir de um arquivo de amostra, em vez de manualmente, consulte Criando uma definição de documento de texto a partir de um arquivo de amostra.