Integrações

Páginas filhas
  • Como utilizar o Download via SFTP na integração do APS com Protheus via Webservice

Parâmetro SFTP no APS;

Produto:

Totvs APS

Versões:

A partir da versão 12.1.31

Ocorrência:

Como utilizar o Download via SFTP na integração do Totvs APS com Protheus

Passo a passo:

O processo descrito neste documento somente é disponível quando o tipo de Integração é por WebService.

Pré-requisitos:

Antes de iniciar a configuração do APS, certifique-se de que está instalado o client winscp nas máquinas que irão utilizar a integração.
É necessário também configurar a variável de ambiente PATH, contendo o caminho completo da instalação do winscp, conforme abaixo:


Para ativar a integração com o SFTP, é necessário Habilitar a função “APS-WS-SFTP” no programa CD7070:


Com a função ativada, ao acessar o DB1000, irá habilitar o botão “Parâmetros SFTP”:


Obs: Neste modelo de integração é necessário estar atento ao valor informado no campo Diretório Retorno ERP.

Caso queira que os arquivos sejam gerados no diretório raiz do PROTHEUS, basta Informar o valor "\".
Mas, caso deseje agrupar os arquivos da integração em alguma subpasta, será necessário parametrizar o envio desta informação para este destino.

Ex.
A pasta raiz de geração dos Arquivos no PROTHEUS é a pasta "DEV" e queremos que o APS gere os dados dentro da pasta integraaps:

Logo, deve ser informado no diretório de Retorno ERP, no DB1000, como "/integraaps/"


O passo seguinte, é a configuração dos dados do SFTP.
Se o ambiente for T-CLOUD, esta informação pode ser adquirida junto a ferramenta de administração TOTVS Cloud.

Nesta tela devem ser configurados os dados para a conexão via SFTP, como:


Servidor: Deve ser informado o servidor SFTP conforme parametrizado e a porta de comunicação. Não é necessário aqui informar o comando "sftp://"

Exemplo: Uma URL de comando que esteja como "sftp://minhaempresa.protheus.cloudtotvs.com.br:2101/", deverá informar somente: "minhaempresa.protheus.cloudtotvs.com.br:2101"

Usuário: Usuário de Autenticação para o SFTP

Senha: Senha de Autenticação para o SFTP

Diretório Spool: O diretório spool é o caminho onde serão resgatados os arquivos de dados na integração com o APS. 

Neste campo, deverá ser informado, a partir do diretório raiz do SFTP onde estarão os arquivos gerados no WEBSERVICE.
Neste mesmo cenário apresentado acima, a pasta raiz do SFTP é a pasta do usuário /ftp_CHK2OL_production.
Como os arquivos ficam dentro das subpastas "./dev/integraaps", é essa a informação que precisaremos preencher como Diretório Spool:


Sugestão: Para identificar qual o diretório Spool, é indicado realizar uma conexão via WinScp ou outra ferramenta e navegar até o destino buscado.


Parâmetros Inicialização: Neste campo, normalmente são gravadas configurações adicionais de Chave e Protocolo de conexão.

Sugestão: Para identificar quais são os parâmetros de inicialização, é indicado realizar uma conexão via WinScp e buscar o script de comando:


Em seguida, navegar na ABA Script e selecionar o formato "Arquivo de Script".

Rolar a barra até o final, onde será indicado, após a porta de conexão, quais são os parâmetros de inicialização:

(Copiar essa linha até o final e colocar no campo de parâmetros de inicialização)


Informações adicionais:

Como saber se todas as configurações estão corretas?

O primeiro passo é verificar se o WebService do Protheus está habilitado e executando:

1) Verifique se a URL informada como URL WS, no DB1000, é acessível a partir de um navegador, na mesma sessão em que estiver rodando o Datasul

2) Verifique se o serviço "MTEXECUTEQUERY" existe e se está Habilitado no WebService



3) Tente executar uma query a partir do método "GETEXECUTEQUERY", disponível nesse serviço;

  • Esse teste poderá ser realizado a partir do próprio teste de conexão do Serviço, ou:
  • A partir de alguma ferramenta de conexão SOAP (Ex.: SOAP-UI)
  • Para executar o teste, deverá informar:
    • CUSERCODE= msalpha;
    • CQUERYSTMT = Query a ser executada no Protheus (Pode pegar como exemplo uma query no DB0141);
    • CRESULTFILE = Informar a pasta em que será gerado o arquivo (Pode ser como exemplo a pasta informada no campo Diretório Retorno ERP) + "TESTEQUERY.TXT.
      Ex.: "/integraaps/arquivo.txt";
    • CDELIMITER = Informar um delimitador como separador do arquivo;
    • Exemplo de uma execução:

4) Se o Webservice retornar algum erro, será necessário avaliar o impedimento ou não da execução;

5) Se o arquivo foi gerado corretamente, a etapa de execução WebService está Ok;

Para o SFTP, podem ocorrer problema de configuração, comunicação ou mesmo execução.

Para identificar se ocorreu algum problema na execução com SFTP, é gerado um arquivo de LOG que fica na pasta ArqAps, dentro do diretório Temporário da Sessão do APS.
Ex.:


Abaixo, algumas mensagens que podem ocorrer e que ficam disponíveis no LOG:
Acesso negado: Usuário ou senha informados incorretamente 

  1. Verifique se o usuário e a senha informadas nos parâmetros estão corretos para acesso no servidor SFTP
  2. Verifique se a senha do SFTP não foi alterada ou expirou recentemente

Host "sftp" não existe.: URL de conexão SFTP não existe ou não está acessível

  1. Verifique se foi informada a URL corretamente
  2. Verifique se a porta informada está de acordo com a porta do servidor
  3. Verifique se a URL informada está sem o "SFTP://" no programa DB1000

Arquivo ou diretório não encontrado: O diretório SPOOL não está acessível 

  1. Com uma conexão SFTP estabelecida, tente navegar no diretório informado
  2. Quando os arquivos estiverem em uma subpasta, é necessário informar "./" para navegar ao subdiretório. Ex.: "./dev/integraaps/"