FTP

Descubra mais sobre o componente FTP e saiba como utilizá-lo na Digibee Integration Platform.

O FTP permite estabelecer uma conexão com um serviço que suporte o protocolo FTP (File Transfer Protocol) e executar operações de Upload, Delete, Download, List ou Move.

O componente FTP não funciona via VPN (Virtual Private Network). Um diretório FTP poderá ser acessado no pipeline apenas se estiver exposto na internet, e redes VPN não se aplicam a esta regra.

Parâmetros

Dê uma olhada nos parâmetros de configuração do componente. Parâmetros suportados por expressões Double Braces estão marcados com (DB).

Parâmetro	Descrição	Valor padrão	Tipo de dado
FTP Server Operating System	Tipo de sistema operacional que o FTP roda.	Unix	String
Account	Para o componente fazer a autenticação a um serviço FTP é necessário usar uma conta do tipo BASIC.	N/A	String
Host	Nome do host ou endereço IP para realizar a conexão.	ftp.server.com.br	String
Port	Número da porta (port).	21 para FTP, 990 para FPTS	Inteiro
Operation	Operação a ser executada, que pode ser Upload, Delete, Download, List ou Move.	Upload	String
File Name (DB)	Nome do arquivo ou caminho completo (full file path) do arquivolocal . (ex: tmp/processed/file.txt).	local-test.pdf	String
Remote File Name (DB)	Nome do arquivo ou caminho completo do arquivo remoto (ex: tmp/file.txt).	test.pdf	String
Remote File Name Move (DB)	Nome do arquivo remoto para o diretório move ou caminho completo (ex: tmp/processed/file.txt).	N/A	String
Remote Directory	Campo obrigatório. Diretório remoto base, que pode ser relativo (ex.: pub/tmp) ou absoluto (ex.:_ _/root/pub).	Folder	String
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.	True	Booleano
Connection Timeout	Tempo de expiração da conexão com o servidor (em milissegundos).	30000	Inteiro
Data Timeout	Tempo de expiração para transferência de cada arquivo (em milissegundos).	30000	Inteiro
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".	False	Booleano
FTP Security	Se a opção estiver ativada, o FTP é acessado de modo seguro FTPS (FTP-SSL ou FTP Secure).	False	Booleano
SSL	Se a opção estiver ativada, o FTP é acessado com o protocolo criptográfico SSL (Secure Sockets Layer).	False	Booleano
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.	False	Booleano
Local Passive Mode	Se a opção estiver ativada, é esperado que a sessão entre cliente e servidor seja feita de forma passiva.	False	Booleano
Remote Verification	Se a opção estiver ativada, permite a verificação do host remoto para confirmar se o host conectado é o mesmo host que está conectado à conexão de controle.	False	Booleano
Security Protocol	Tipo de protocolo de segurança que será utilizado - SSL (Secure Sockets Layer) ou TLS (Transport Layer Security).	TLS	String
Type Exec Protocol	Private, clear, confidential ou safe.	Private	String
Buffer Size	Tamanho de buffer do canal de dados seguros.	0	Inteiro
Use Dynamic Account	Quando a opção estiver ativada, o componente irá usar a conta dinamicamente. Quando estiver desativada, a conta será usada estaticamente.	False	Booleano
Account Name	Nome da conta a ser definida. O nome da conta deve ser gerado dinamicamente através do componente Store Account.	N/A	String
Scoped	Quando a opção estiver ativada, a conta armazenada é isolada para outro sub-processo. Nesse caso, os sub-processos verão sua própria versão dos dados da conta armazenada. Para saber mais sobre a funcionalidade Scoped, leia a documentação de Suporte a credenciais dinâmicas.	False	Booleano

Atualmente, os parâmetros Use Dynamic Account, Account Name e Scoped podem ser usados apenas no Pipeline Engine v2 e estão disponíveis em fase Beta Restrito. Para saber mais, leia o artigo Progama Beta.

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 a 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.

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 Digibee Integration Platform, leia a documentação sobre Processamento de mensagens.