Páginas filhas
  • TOTVS HCM x Suricato - Api Rest recordValidatedVersion

INTEGRAÇÃO

Contexto de Negócio (Introdução)

Com a vigência da portaria 671 é necessário que, tanto o ERP como o Suricato estejam atualizados para atender as novas informações estabelecidas nesta portaria.

Para isto, há a necessidade de identificar se a base de dados do ERP está atualizada em relação à portaria 671, permitindo que marcações realizadas em dispositivos que atendam à esta portaria possam ser integradas através da execução da api recordClockMarkings.

Sistemas Envolvidos

  • HCM (módulo Controle de Frequência): O módulo Controle de Frequência permite de forma prática, segura e automática o controle da apuração de informações referentes à frequência dos funcionários de uma empresa, possibilitando, também, o controle e o acompanhamento do consumo e cobrança de refeições dos funcionários, quando esta é feita em refeitório na empresa.

  • Suricato (Telemática):  software multi-idioma para a gestão integrada da segurança e controle de acesso.

Pré-requisitos instalação/implantação/utilização

  • Versões mínima do TOTVS/Datasul: 12.1.2205.12, 12.1.2209.7 e 12.1.2301.2.
  • Servidor de aplicação tomcat (não é compatível com o servidor de aplicação jboss)
  • Estrutura de rede estável, para que haja trafego de dados sem interrupção.
  • Datasul devidamente configurado e serviço Rest habilitado em seu server, com acesso à internet.

Integração

O objetivo desta integração é verificar se o banco de dados do ERP está atualizado com relação à portaria 671, de forma a estar apto a receber as marcações do Suricato que foram realizadas em dispositivos que atendem à portaria 671.

Parâmetros e Chamada do Método:

Esta api utiliza Basic Authentication.

{protocolo}://{host}/api/rh/v1/recordValidatedVersion.r


A API REST recordValidatedVersion será consumida pelo Suricato, sendo que não possui parãmetros a serem enviados para a mesma.


Exemplo de retorno da API recordValidatedVersion:


  • Quando na base de dados dthrtma, a tabela marcac_nova_integr estiver atualizada com os campos: cod_fuso, cod_cpf_func, num_vers_layout_afd e cod_inscr_emp, o json de retorno será:

{ version671 : 'yes' }


  • Quando na base de dados dthrtma, a tabela marcac_nova_integr não estiver atualizada com os campos: cod_fuso, cod_cpf_func, num_vers_layout_afd e cod_inscr_emp, o json de retorno será:

{ version671 : 'no' }


Checklist de suporte da aplicação

Itens a serem verificados durante o atendimento:

  • Verificar se os pré-requisitos foram atendidos para a chamada da API;
  • Verificar se na chamada da API o EndPoint, o nome do serviço e todos os campos obrigatórios foram informados;
  • Verificar se o retorno da API apresenta algum erro tratado (códigos e mensagens de erro citados neste documento) e consultar a solução na mesma tabela que descreve o erro;
  • Em caso de Erro não tratado, verificar se possui alguma informação de banco de dados, conexão com o servidor, clientlog, log do appServer ou algo que possa identificar a origem do problema.