Atividade de Leitura de FTP¶

Introdução¶

Uma atividade FTP Read lê dados de um endpoint FTP e deve ser usada como uma fonte para fornecer dados para uma operação ou para ser chamada em um script. Depois de configurar uma conexão FTP, você pode configurar quantas atividades FTP desejar para cada conexão FTP.

Crie uma Atividade FTP¶

Uma instância de uma atividade é criada a partir de uma conexão usando um tipo de atividade.

Para criar uma instância de uma atividade, arraste o tipo de atividade para a quadro de design ou copie o tipo de atividade e cole-o na quadro de design. Para obter detalhes, consulte Criando uma instância de atividade em Reutilização de componentes.

Uma atividade existente pode ser editada nestes locais:

• A quadro de design (consulte Menu Ações do componente em Quadro de Design).
• A aba Componentes do painel do projeto (consulte Menu Ações do componente em Guia Componentes do painel do projeto).

Configurar uma Atividade de Leitura de FTP¶

Siga estas etapas para configurar uma atividade de leitura de FTP:

• Etapa 1: insira um nome, forneça um esquema de resposta e especifique as configurações
• Etapa 2: Revise os esquemas de dados

Etapa 1: Insira um Nome, Forneça um Esquema de Resposta e Especifique as Configurações¶

• Nome: Insira um nome a ser usado para identificar a atividade de leitura de FTP. O nome deve ser exclusivo para cada atividade de leitura de FTP e não deve conter barras (/) ou dois pontos (:).

• Fornecer esquema de resposta: O esquema de resposta define a estrutura de dados usada pela atividade FTP Read. A necessidade de um esquema de resposta depende se a atividade é usada como origem de uma transformação (consulte Uso do esquema). Para obter instruções sobre como concluir esta seção de configuração de atividades, consulte Esquemas definidos em uma atividade.

• Caminho: Insira um único caminho válido. Um caminho deve apontar para um diretório existente no servidor FTP. Por exemplo, /inbound.

• Obter arquivos: Digite o nome do(s) arquivo(s) que você deseja ler no caminho digitado acima. Este campo também pode incluir um asterisco (*) para usar como curinga (por exemplo, *.dat ou *.*) ou um ponto de interrogação (?) para corresponder exatamente a um caractere (por exemplo, file?.txt). O uso de curingas é separado da opção Usar expressão regular descrita abaixo. Se você especificar dados no formato ZIP para serem descompactados e lidos automaticamente, consulte as opções de Compactação descritas abaixo.

  Dica

  Se você estiver faltando arquivos conhecidos ou se os nomes dos arquivos tiverem informações extras anexadas a eles após recuperá-los do endpoint, defina jitterbit.source.ftp.enable_regex_parser para true acima na cadeia de uma atividade FTP Read.

• Configurações opcionais: Clique para expandir configurações opcionais adicionais:

  

  • Opções de filtro de arquivos: Essas opções afetam como a entrada inserida no campo Obter arquivos acima é interpretada:

    • Ignorar maiúsculas e minúsculas: Marque esta caixa de seleção se você inseriu uma entrada no campo Obter arquivos acima, que deve ser interpretada como não diferenciando maiúsculas de minúsculas.

    • Usar Expressão Regular: Marque esta caixa de seleção se você inseriu uma entrada no campo Obter Arquivos acima que deve ser interpretada como uma expressão regular. Esta opção é separada do uso de curingas descritos em Obter arquivos acima.

  • Listar apenas nomes de arquivos: Marque esta caixa se desejar listar apenas nomes de arquivos (usando o comando FTP NLST em vez de LIST). Tente fazer isso se o Harmony não conseguir analisar a listagem de diretórios FTP enviada de volta pelo servidor FTP.

    Dica

    Se você estiver faltando arquivos conhecidos ou se os nomes dos arquivos tiverem informações extras anexadas a eles após recuperá-los do endpoint, defina jitterbit.source.ftp.enable_regex_parser para true acima na cadeia de uma atividade FTP Read.

  • Codificação de caracteres: Especifique a codificação de caracteres para definir uma codificação de caracteres específica para o arquivo de origem. Se você deixar o campo em branco, o Harmony tentará detectar a codificação. Se quiser substituir o padrão, você pode escolher qualquer um dos tipos de codificação listados em Codificações de caracteres suportadas.

  • Pasta de sucesso/erro: Estas opções são usadas para arquivar uma cópia de todos os arquivos processados. Isso pode ser usado no lugar da opção Após Processamento para Renomear Arquivo na origem do arquivo para permitir que você grave em um local separado em vez de em uma subpasta no mesmo local.

    • Usar pasta de sucesso: Marque esta caixa de seleção para gravar um arquivo na pasta especificada após o processamento bem-sucedido no caminho de destino principal. Se gravar um arquivo em vários caminhos, a operação será bem-sucedida somente se todos os caminhos forem bem-sucedidos. Se esta caixa de seleção estiver marcada, forneça também a Pasta de sucesso no caminho absoluto na máquina do Agente Privado.

    • Usar pasta de erros: Marque esta caixa de seleção para gravar um arquivo na pasta especificada após um processamento malsucedido. Se pelo menos um caminho não tiver êxito, o arquivo será gravado nesta pasta. Se esta caixa de seleção estiver marcada, forneça também a Pasta de erros no caminho absoluto na máquina do Agente Privado.

      Cuidado

      Um arquivo será gravado somente se a falha for devido a erros no processamento da atividade de leitura de FTP. Um arquivo não é gravado se, por exemplo, a conexão FTP não for bem-sucedida, causando falha em toda a operação.

    Importante

    Os caminhos absolutos para as pastas de sucesso e erro estão localizados no Agente Privado, não no servidor FTP.

    Ao usar palavras-chave de nome de arquivo nesses campos, as palavras-chave não são resolvidas. Para obter uma solução alternativa, consulte Limitação e solução alternativa em Palavras-chave do nome do arquivo. Usando asteriscos (*) e outros caracteres de nome de arquivo normalmente não suportados causarão falha na operação.

    Os arquivos são nomeados conforme especificado no campo Obter arquivos acima, com um sublinhado no final e um carimbo de data/hora adicionado. Se já existir um arquivo com o mesmo nome nessa pasta, um sublinhado adicional e um contador serão adicionados.

    Por exemplo, se um arquivo chamado data.csv for processado com sucesso, uma cópia chamada data.csv_2018-01-01_12-00-00-000 pode ser gravado na pasta especificada como pasta de sucesso. Se tal arquivo já existir de uma execução anterior, um novo arquivo data.csv_2018-01-01_12-00-00-000_1 seria adicionado. De maneira semelhante, se uma pasta de erro for especificada, todos os arquivos que falharem serão gravados em um arquivo na pasta de erro.

  • Após o processamento: Se você quiser realizar outras ações após o processamento dos dados, estas opções estão disponíveis:

    • Excluir arquivo: Marque esta caixa de seleção se desejar que os arquivos que foram processados com sucesso sejam excluídos. Quando esta opção é selecionada, a opção Renomear arquivo abaixo é preenchida automaticamente com /\delete/\ para indicar que os arquivos processados serão excluídos e, como tal, renomear um arquivo não se aplica. Desmarcar Excluir arquivo também limpa o campo Renomear arquivo.

    • Renomear arquivo: Digite um nome se desejar renomear arquivos após o processamento. Qualquer uma das palavras-chave do nome do arquivo estão disponíveis para gerar nomes de arquivos exclusivos para os dados de origem após o processamento. Observe que o campo Renomear arquivo não estará disponível se Excluir arquivo acima estiver selecionado. Além disso, alternar Excluir arquivo acima limpa qualquer entrada inserida no campo Renomear arquivo.

      Dica

      Se você deseja arquivar a origem do arquivo em um local separado em um Agente Privado, consulte também a opção Success/Error Folder na página FTP Write atividade configuração.

  • Arquivo de Acionamento: Disponível apenas para uso com Agentes Privados onde arquivos locais estão habilitados, um arquivo acionador é um arquivo que deve estar presente antes que um arquivo de origem seja recuperado por uma operação para processamento. A presença de um arquivo acionador indica que um arquivo de origem está pronto para ser lido e ainda não está em processo de gravação por uma operação anterior.

    • Usar acionador: Marque esta caixa de seleção se desejar que o sistema procure um arquivo acionador antes de processar os arquivos de origem. Observe, ao usar um arquivo de gatilho:

      • A operação faz polling, procurando o arquivo trigger. O intervalo de tempo de votação é fixado em um segundo.

      • O arquivo acionador é excluído quando o processamento é iniciado.

      • Se o arquivo do gatilho não for encontrado, a operação continuará tentando encontrar o arquivo do gatilho até que a operação expire.

      • Definir um arquivo acionador bloqueia qualquer operação ou script que use a origem até que a condição do arquivo acionador seja satisfeita ou a operação expire.

    • Caminho absoluto do arquivo: Insira o caminho absoluto do arquivo na máquina do Agente Privado onde o arquivo acionador reside. Selecione um arquivo que atenda a estes critérios:

      • O arquivo pode ser de qualquer tipo e pode conter qualquer coisa em seu conteúdo; somente a presença do arquivo define o comportamento do arquivo acionador.

      • O uso de curingas não é permitido.

      • O arquivo acionador não pode ser o mesmo arquivo que um arquivo de origem que está sendo processado.

      Nota

      Ao usar palavras-chave de nome de arquivo neste campo, as palavras-chave não são resolvidas. Para obter uma solução alternativa, consulte Limitação e solução alternativa em Palavras-chave do nome do arquivo.

  • Ignorar linhas: Se houver cabeçalhos e/ou rodapés nos dados de origem, insira o número de linhas a serem ignoradas nos campos Primeira e Último.

  • Compactação: Se os dados de origem estiverem em um formato compactado, selecione Os dados de origem estão compactados. Estas opções ficam disponíveis:

    • Formato: Use o menu suspenso para selecionar o formato dos dados compactados. Atualmente, apenas o formato ZIP é compatível.

    • Senha: Se o arquivo estiver criptografado, digite a senha.

      Nota

      O Harmony oferece suporte à leitura apenas do diretório raiz de um arquivo criptografado.

  • Tipo de transferência: Se os arquivos forem baseados em ASCII, escolha o tipo de transferência ASCII. Para todos os outros tipos de arquivo, escolha Binário. Binário é o padrão e geralmente funciona melhor.

• Salvar e Sair: Se ativado, clique para salvar a configuração desta etapa e feche a configuração da atividade.

• Próximo: Clique para armazenar temporariamente a configuração desta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.

• Descartar alterações: Após fazer as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 2: Revise os Esquemas de Dados¶

• Esquema de dados: Se fornecido durante a configuração da atividade, o esquema de dados de resposta será exibido. Se a operação usar uma transformação, os esquemas de dados serão exibidos novamente posteriormente durante o mapeamento da transformação, onde você pode mapear campos de destino usando objetos de origem, scripts, variáveis, valores personalizados e muito mais. Você também pode definir esquemas diretamente em uma transformação.

• Adicionar plug-in(s): Plugins são aplicativos fornecidos pelo Jitterbit ou pelo usuário que ampliam os recursos nativos do Harmony. Para aplicar um plugin à atividade, clique para expandir esta seção e marque a caixa de seleção ao lado do plugin a ser usado. Para obter instruções adicionais sobre o uso de plug-ins, incluindo detalhes sobre como definir quaisquer variáveis necessárias usadas pelo plug-in, consulte Plugins adicionados a uma atividade.

• Voltar: Clique para armazenar temporariamente a configuração desta etapa e retornar à etapa anterior.

• Concluído: Clique para salvar a configuração de todas as etapas e fechar a configuração da atividade.

• Descartar alterações: Após fazer as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Próximos Passos¶

Depois de configurar uma atividade de leitura de FTP, você poderá usá-la em uma operação ou script conforme descrito abaixo.

Conclua a Operação¶

Depois de configurar uma atividade de leitura de FTP, conclua a configuração da operação adicionando e configurando outras atividades, transformações ou scripts como etapas da operação. Você também pode definir as configurações de operação de uma operação, que incluem a capacidade de encadear operações que estejam no mesmo fluxo de trabalho ou em workflows diferentes.

Depois que uma atividade de leitura de FTP for criada, as ações de menu para essa atividade estarão acessíveis no painel do projeto nas guias Workflows ou Componentes e na quadro de design. Consulte Menu Ações de Atividade para detalhes.

As atividades de leitura de FTP podem ser usadas como fonte com estes padrões de operação:

• Padrão de arquivo
• Padrão de transformação
• Padrão de arquivo de dois alvos (apenas como a primeira fonte)
• Padrão de arquivo HTTP de dois destinos (apenas como a primeira fonte)
• Padrão de duas transformações (apenas como a primeira fonte)
• Padrão de meta em massa do Salesforce

Outros padrões não são válidos usando atividades de leitura de FTP. Veja os padrões de validação na página Validade da Operação página.

Um caso de uso típico é usar uma atividade FTP Read no Transformação Pattern. Neste exemplo, a atividade FTP Read (Read Request) fornece dados para a operação que são então recebidos pela transformação (FTP to Database). A atividade Database Insert (Insert Response) é utilizada como alvo, recebendo dados dentro da operação:

Quando estiver pronto, implantar e execute a operação e valide o comportamento verificando os logs de operação.

Usando Atividades FTP em Scripts¶

As atividades de leitura de FTP também podem ser referenciadas em um script para uso com funções de script que usam um sourceId como parâmetro, incluindo estes:

Funções de Jitterbit Script

• ArchiveFile
• Base64EncodeFile
• DeleteFile
• DeleteFiles
• DirList
• FileList
• ReadFile

Funções JavaScript Jitterbit

• Jitterbit.ReadFile

Para obter mais detalhes sobre como referenciar atividades em scripts, consulte Endpoints em Jitterbit Script ou Endpoints em JavaScript.