Pular para o conteúdo principal

S-FTP In

Configuração atual da tarefa S-FTP In no Workflow Designer

A Tarefa “S-FTP In” permite descarregar de forma segura um ou mais ficheiros de um servidor remoto para o sistema local utilizando o protocolo SFTP (Secure File Transfer Protocol). É um componente crucial para automatizar a aquisição de dados ou ficheiros de sistemas externos, tornando-os disponíveis para serem processados pelo Workflow.

Configuração​

A configuração da Tarefa articula-se na definição das credenciais de acesso e na especificação do que descarregar. Os campos de configuração da Tarefa podem ser preenchidos manualmente ou através de parâmetros e variáveis do workflow

Autenticação​

Define o método pelo qual o Workflow se autenticará junto do servidor SFTP.

  • Método de Autenticação: É possível escolher entre:
  • Password: A autenticação ocorrerá através da palavra-passe associada ao utilizador.
  • Chaves SSH: A autenticação ocorrerá através de um par de chaves SSH (pública/privada).
  • Host: O endereço IP ou o nome DNS do servidor SFTP ao qual se conectar.
  • Porta: A porta de comunicação para a ligação SFTP. O valor padrão é 22.
  • User: O nome de utilizador para a ligação.

Descarregar ficheiros de remoto​

Especifica o modo de descarregamento.

  • Modo de Descarregamento: É possível escolher entre duas opções:
  • Ficheiro Único: Permite descarregar um ficheiro específico.
  • Diretório Inteiro: Permite descarregar todos os ficheiros contidos numa pasta remota específica.
  • Nome do Ficheiro: Este campo é visível apenas se for escolhido o modo "Ficheiro Único". Deve ser inserido aqui o nome exato do ficheiro a descarregar.
  • Caminho remoto: O caminho do diretório no servidor SFTP de onde descarregar os ficheiros. Se for descarregado um ficheiro único, este é o caminho da pasta que o contém.

Parâmetros de Saída​

Após tentar a operação de descarregamento, a Tarefa expõe os seguintes parâmetros de saída, que fornecem informações detalhadas sobre o resultado e os ficheiros descarregados.

  • result: Contém uma mensagem de texto que descreve o resultado da operação.
  • Exemplo de sucesso (ficheiro único): "Transferência do ficheiro [NomeFile] realizada com sucesso!"
  • Exemplo de sucesso (diretório): "Transferência dos ficheiros do diretório [PathRemoto] realizada com sucesso!"
  • Exemplo de falha: "Erro de Autenticação com utilizador [NomeUtente]" ou "Erro na transferência do ficheiro [NomeFile]!"
  • ftpInFile: Contém o nome do ficheiro descarregado.
  • ftpInPath: Retorna o caminho do diretório remoto de onde foi efetuado o descarregamento.
  • resultJson: Representa o resultado da execução da tarefa em formato JSON, incluindo informações gerais, configurações e detalhes da execução.

Notas Importantes

  • O modo "Diretório Inteiro" descarrega os ficheiros presentes no primeiro nível da pasta especificada, mas não descarrega recursivamente o conteúdo de quaisquer subpastas.