SFTP - Instruções de configuração

ÍNDICE

• SFTP - Instruções de configuração
  • Alojamento e autenticação
  • Configuração
  • Frequência e agendamento
  • Relatórios e gestão de erros
    • Perguntas frequentes relacionadas
  • Como criar uma chave pública SSH para o servidor SFTP
    • Formato
    • Padrão
    • Criação de chaves SSH 
    • Exemplo de chave
  • Instruções para tipos de registos específicos

Alojamento e autenticação

O seu diretório SFTP é alojado num servidor SFTP dedicado (via AWS). Cada cliente tem uma conta de utilizador única, com acesso direto apenas à sua própria pasta SFTP. A autenticação é feita por chave pública, por isso terá de criar um par de chaves (pública e privada) e inserir a chave pública no campo Chave pública ao configurar a sua pasta. A chave deve estar no formato openSSH RSA . Para saber como criar as chaves, consulte Como criar uma chave pública SSH para o servidor SFTP em baixo.

Configuração

1. Coloque a chave pública que criou no campo Chave pública . Se quiser, pode alterar o Nome de utilizador . O valor do campo Nome de utilizador deve começar por uma letra, número ou sublinhado e ter entre 3 e 100 caracteres. Pode incluir letras, números, sublinhados, arrobas (@), pontos (.) e hífens (-).

2. Guarde o Nome de utilizador, URL do domínio Spotnanae o Número da porta num local seguro, pois estes dados vão ser necessários mais tarde pela equipa da sua organização que vai configurar o envio de ficheiros para a nova pasta. 
   Nota: Depois de concluir a configuração da pasta SFTP, pode voltar a aceder a estes dados em Gerir.

3. Introduza o(s) endereço(s) de email para onde pretende receber relatórios sobre os carregamentos de ficheiros no campo Notificação por email SFTP . Para mais informações, veja Relatórios e gestão de erros em baixo.

4. Clique em Ligar.

Assim que adicionar uma chave pública, o estado inicial será Não verificado. Este será o estado apresentado no OBT até que seja recebido um ficheiro na pasta. Pode enviar um ficheiro de teste à sua escolha ou um ficheiro real de RH ou de campos personalizados (apenas ficheiros nos formatos suportados serão processados). Se mais tarde atualizar a chave pública, o estado volta a ser Não verificado até ser recebido um novo ficheiro.

Para remover a sua pasta SFTP, clique em Desligar. Isto elimina a sua pasta SFTP. Se precisar de a criar novamente no futuro, terá de introduzir todos os dados desde o início, tal como explicado acima.

Frequência e agendamento

É você quem define quando e com que frequência os ficheiros são carregados. O processamento dos ficheiros é iniciado assim que o ficheiro é colocado na sua pasta SFTP, através do trigger de criação do ficheiro. Ou seja, assim que colocar um ficheiro na sua pasta no nosso servidor SFTP, a aplicação começa logo a tratar desse carregamento. 

Para recomendações sobre frequência e agendamento para cada tipo de registo (por exemplo, utilizadores, campos personalizados, entidades legais), consulte a secção Frequência e agendamento nas instruções SFTP de cada tipo de registo.

Relatórios e gestão de erros

Recolhemos dados sobre os seus carregamentos de ficheiros e criamos um relatório interno após cada carregamento. Este relatório é enviado para o(s) endereço(s) de email que indicou no campo Notificação por email SFTP durante a configuração. Para cada ficheiro carregado, o relatório inclui: 

• os motivos pelos quais o carregamento do ficheiro falhou (formato incorreto, colunas em falta, etc.).

• os motivos pelos quais uma linha do ficheiro não foi carregada. Não fazemos atualizações parciais: se houver um erro numa coluna específica ou faltar um campo obrigatório nessa linha, a linha é rejeitada. 

• o estado do carregamento (pendente, concluído, falhado).

Pode usar esta informação para resolver eventuais erros. Se não conseguir corrigir o problema, contacte o suporte técnico. 

Perguntas frequentes relacionadas

1. Aceitam ficheiros incrementais, que só incluam os registos a atualizar ou adicionar?

   • Sim

2. O ficheiro que carrega (seja via SFTP ou manualmente) precisa de incluir as colunas opcionais mesmo que não as utilize?

   • Não

Como criar uma chave pública SSH para o servidor SFTP

Siga as instruções abaixo para criar a chave pública SSH que nos vai fornecer.

Formato

• Tipo: String

• Limite de comprimento: Máximo de 2048 caracteres.

Padrão

 ^ssh-rsa\s+[A-Za-z0-9+/]+[=]{0,3}(\s+.+)?\s*$

Criação de chaves SSH 

Para criar as chaves SSH, execute este comando na linha de comandos do Windows ou no terminal do macOS, Linux ou UNIX:

ssh-keygen -t rsa -b 4096 -f nome_da_chave

Onde 

• -t é o tipo de encriptação

• -b é o comprimento da chave (em bits)

• -f é o nome da chave

Exemplo de chave

ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDDJB9oBRPrBegMDPEQo+HmNDb/jKUJL6q2kQpNNMDjNps9mhhwJ1dP/lOavMitBPAndeXlwaNEm2XbGaSrZtD/tbQTX1HQjP6pacy+Alf8kYBm5QFfl/Z6lGC8qHys10fpRXgYE7UhdSv6VyRqt1gELGFQwVBZ2kJJuBGJF1IRywwvG/h68B8iWU1+6KEWYQoUcT45r3j3otnx4NhhzpTiNgDbMk0ix+kar4/IstobRLcb7rt7FoUerTLNrVDi69DqbsGY5LN+NM8jVx0sPQLRC/ruil8pTHP3k4rDCc7a80+sH4sUTW+mHc7MTqbi/CcyyFAD8h7p6WqxEydOaJjMnvqAbE17BOj0TSxv3HMohTf3skzE7PbzVcjIfHTpFPGxmJkghAYAMi5l9VvAs91IpVylxjqPss3xQQJIZEmQdG2k7zk/UpsUFlmaOj6lCHRicFKCixKekzzm3nFuJvDEklurtydOQjZ8WkPzTSJfZBdKMuMUi0SQ9m9ZAw99t0=

Instruções para tipos de registos específicos

Para instruções mais detalhadas sobre o carregamento de tipos de registo específicos via SFTP, consulte os seguintes tópicos:

• Feeds de RH (utilizadores)
• Funções
• Campos personalizados
• Escritórios
• Entidades legais