IMPORTANTE: esta documentação foi descontinuada. Leia a documentação FTP atualizada no nosso novo portal de documentação.
O FTP permite estabelecer uma conexão com um serviço que suporte o protocolo FTP (File Transfer Protocol) e executar os comandos de upload, delete, download, list ou move.
Dê uma olhada nos parâmetros de configuração do componente:
FTP Server Operating System: tipo de sistema operacional que o FTP roda.
Account: para o componente fazer a autenticação a um serviço FTP é necessário usar uma account do tipo BASIC.
Host: nome do host ou endereço IP para realizar a conexão. Este parâmetro aceita Double Braces.
Port: número da porta - geralmente 21 para FTP e 990 para FTPS. Este parâmetro aceita Double Braces.
Operation: operação a ser executada, que pode ser upload, download, listagem, delete ou move.
File Name: nome do arquivo ou caminho completo (full file path) para o arquivo. Este parâmetro aceita Double Braces.
Remote File Name: nome do arquivo remoto ou caminho relativo (ex.: tmp/file.txt) para o arquivo remoto. Este parâmetro aceita Double Braces.
Remote Directory: campo obrigatório. Diretório remoto base, que pode ser relativo (ex.: pub/tmp) ou absoluto (ex.: /root/pub). Este parâmetro aceita Double Braces.
Binary File: se "true", a transferência de arquivos será feita no modo binário (TYPE I ou Image); caso "false" o modo texto simples (TYPE A ou ASCII) será utilizado.
Connection Timeout: tempo de expiração da conexão com o servidor (em milissegundos).
Data Timeout: tempo de expiração para transferência de cada arquivo (em milissegundos).
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".
FTP Security: se a opção estiver ativada, o FTP é acessado de modo seguro FTPS (FTP-SSL ou FTP Secure).
SSL: se a opção estiver ativada, o FTP é acessado com o protocolo criptográfico SSL (Secure Sockets Layer).
Implicit: se a opção estiver ativada, a conexão SSL é estabelecida através da porta 990 antes mesmo do login ou antes da transferência de arquivos.
Remote Verification: habilita ou desabilita a verificação de que o host remoto (que faz parte de uma conexão de dados) é o mesmo host a qual a conexão de controle está conectada.
Security Protocol: tipo de protocolo de segurança que será utilizado - SSL (Secure Sockets Layer) ou TLS (Transport Layer Security).
Execution Type Protocol: private, clear, confidential ou safe.
Buffer Size: tamanho de buffer do canal de dados seguros.
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 FTP utilizando as operações download, upload ou move, a seguinte estrutura de JSON será gerada:
{
"status": {
"success": true,
"content": [
{
"symbolicLink": false,
"name": "file.pdf",
"type": 0,
"size": 144089,
"directory": false,
"file": true,
"timestamp": 1544726460000,
"unknown": false,
"rawListing": "-rw-rw---- 1 user 10002 144089 Dec 13 16:41 file.pdf",
"link": null,
"hardLinkCount": 1,
"user": "user",
"group": "10002"
}
]
}
}
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 sucedeu, "false" caso contrário
Ao executar um componente FTP utilizando as operação list, a seguinte estrutura de JSON será gerada:
{
"remoteDirectory": "pub/example",
"success": true,
"content": [
{
"file": "imap-console-client.png"
}
]
}
remoteDirectory: caminho do diretório remoto base (relativo ou absoluto)
success: "true" se a operação sucedeu, "false" caso contrário
content: a lista de arquivos no remoteDirectory
file: nome do arquivo
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.