O SFTP permite estabelecer uma conexão com um serviço que suporte o protocolo SFTP (Secure File Transfer Protocol ou SSH File Transfer) e executar os comandos de upload, delete, download, list ou move.

Dê uma olhada nos parâmetros de configuração do componente:

  • Operation: operação a ser executada, que pode ser upload, delete, download, list ou move.

  • Account: para o componente fazer a autenticação a um serviço SFTP é necessário usar uma account do tipo BASIC ou PRIVATE KEY. O parâmetro aceita Double Braces.

  • Host: nome do host ou endereço IP para realizar a conexão. O parâmetro aceita Double Braces.

  • User Name: deve ser usado apenas quando o account type for PRIVATE KEY. O parâmetro aceita Double Braces.

  • Port: número da porta - geralmente 22. O parâmetro aceita Double Braces.

  • File Name: nome do arquivo ou caminho completo (full file path) para o arquivo. O parâmetro aceita Double Braces.

  • Remote File Name: nome do arquivo remoto ou caminho relativo (i.e. tmp/file.txt) para o arquivo remoto. O parâmetro aceita Double Braces.

  • Remote Directory: campo obrigatório. Diretório remoto base, pode ser relativo (i.e. pub/tmp) ou absoluto (i.e. /root/pub). O parâmetro aceita Double Braces.

  • Connection Timeout: tempo de expiração da conexão com o servidor (em milissegundos).

  • Overwrite File On Upload: se "true", em caso de arquivos com nomes conflitantes o arquivo será substituído durante o upload.

  • Fail On Error: se a opção estiver habilitada, a execução do pipeline com erro será interrompida; do contrário, a execução do pipeline continua, mas o resultado vai mostrar um valor falso para a propriedade "success".

  • Proxy Enabled: se "true", permite a configuração de um proxy para estabelecer a conexão com o serviço de SFTP.

  • Host: host do proxy. O parâmetro aceita Double Braces.

  • Port: porta do proxy. O parâmetro aceita Double Braces.

IMPORTANTE: note que alguns dos parâmetros acima suportam Double Braces. Para entender como essa linguagem funciona, leia o nosso artigo clicando aqui.

Fluxo de mensagens

  • Saída

Ao executar um componente SFTP utilizando as operações download, upload ou move, a seguinte estrutura de JSON será gerada:

{
"fileName": "picture.png",
"remoteFileName": "imap-console-client.png",
"remoteDirectory": "pub/example",
"success": "true"
}

  • fileName: nome do arquivo local

  • remoteFileName: caminho do arquivo remoto ou caminho relativo do arquivo remoto

  • remoteDirectory: caminho do diretório remoto base (relativo ou absoluto)

  • success: "true" se a operação foi bem sucedida, "false" caso contrário

Ao executar um componente SFTP utilizando a operação list, a seguinte estrutura de JSON será gerada:

{
"remoteDirectory": "pub/example",
"success": true,
"content": [
{
"isDirectory": false,
"size": 1024,
"permission": "drwx------",
"flag": 14,
"accessed": "Sun Nov 08 16:36:32 BRT 2020",
"modified": "Sun Nov 08 16:36:32 BRT 2020"
}
]
}

  • remoteDirectory: caminho do diretório remoto base (relativo ou absoluto)

  • success: "true" se a operação foi bem sucedida, "false" caso contrário

  • content: a lista de arquivos no remoteDirectory

  • file: nome do arquivo

  • size: tamanho do arquivo

  • isDirectory: se o objeto retornado é um diretório, será exibido “true”; se for um arquivo, será exibido “false”

  • permissions: uma string contendo o tipo de permissão dada ao objeto

  • accessed: data do último acesso

  • modified: data da última modificação

  • flag: retorna flags, indicando quais atributos estão presentes

IMPORTANTE: a manipulação de arquivos dentro de um pipeline ocorre de forma protegida. Os arquivos ficam disponíveis em diretório temporário que somente o pipeline sendo executado tem acesso.

Para entender melhor o fluxo das mensagens na Plataforma, clique aqui e leia o nosso artigo.

Encontrou sua resposta?