Histórico da Página
INTEGRAÇÃO
Contexto de Negócio (Introdução)
Atualmente a integração de marcações de ponto do Suricato para o TOTVS HCM ocorre através de uma conexão direta com o banco de dados, atualizando a tabela msa_control_marcac.
Há a necessidade de realizar esta integração através de uma API REST garantindo a integridade da informação e, evitando assim a necessidade de conexão direta com o banco de dados.
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.34
- 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 é permitir a integração das marcações de ponto do Suricato para o Datasul e, este efetue a validação e gravação das marcações na tabela marcac_nova_integr, sem que ocorra acesso direto ao banco de dados por parte do Suricato.
Parâmetros e Chamada do Método:
Autenticação do tipo básica.
{protocolo}://{host}/api/rh/v1/recordClockMarkings
A API REST recordClockMarkings será consumida pelo Suricato e poderá receber no método POST os seguintes parâmetros:
Propriedade | Descrição | Tipo | Obrigatório? |
---|---|---|---|
items | Array das marcações | Array | Sim |
tems.codRelogioExtChave | Código Relógio | Caracter | Não |
items.codFuncMsa | Código do funcionário | Caracter | Sim |
items.codNsr | Código NSR | Numérico | Sim |
items.codPisMsa | Código do PIS | Caracter | Sim |
items.datMarcacAces | Data da marcação | Caracter | Sim |
items.numHorarMarcacAces | Hora da marcação em segundos | Numérico | Sim |
items.codRep | Código do REP | Caracter | Não |
items.codUnidExtChave | Código da Unidade | Caracter | Sim |
items.codUsuarExtChave | Código do usuário | Caracter | Sim |
Request da API: Exemplo:
{
"items": [
{
"codRelogioExtChave": "",
"codFuncMsa": "529",
"codNsr": 1,
"codPisMsa": "15423654711",
"datMarcacAces": "2021-10-21 09:30:00.000",
"numHorarMarcacAces": 34200,
"codRep": "5009940099846",
"codUnidExtChave": "10;1",
"codUsuarExtChave": "10;1;529"
},
{
"codRelogioExtChave": "",
"codFuncMsa": "1356",
"codNsr": 2,
"codPisMsa": "15423654711",
"datMarcacAces": "2021-10-23 22:00:00.999",
"numHorarMarcacAces": 79200,
"codRep": "5009940099846",
"codUnidExtChave": "10;1",
"codUsuarExtChave": "10;1"
}
]
}
Dados utilizados da API
"S" para sim
"N" para não.
Situações de Erros Tratados
O envio de dados inesperados nos parâmetros de entrada da API REST pode ocasionar alguns erros. Desta forma, foram criados alguns tratamentos de erros, listados abaixo, cada um com sua respectiva mensagem e solução.
Tratamento de erros de integração Datasul HCM:
Mensagens de Pré-Validação
Erro
Mensagem
Solução
265
Processo (nrProc) deve ser informado(a).
Verificar se a propriedade json nrProc está preenchida no pacote enviado .
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"message": "Processo (nrProc) deve ser informado(a).\n",
"code": "265",
"type": "error"
} |
Informe um(a) Tipo Processo (tpProc) válido(a). Valores Válidos: 1 ou 2 ou 3
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"message": "Informe um(a) Tipo Processo (tpProc) válido(a). Valores Válidos: 1 ou 2 ou 3.\n",
"code": "158",
"type": "error"
} |
Processo cadastrado(a) no HCM deve ser mantido neste produto. Verifique o FP0030.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"message": "Processo cadastrado(a) no HCM deve ser mantido neste produto. Verifique o FP0030.\n",
"code": "56650",
"type": "error"
} |
Empresa não relacionada com Nenhum Empregador.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"message": "Empresa não relacionada com Nenhum Empregador",
"code": "7137",
"type": "error"
} |
Situações de Erros Tratados
A API irá retornar a lista com o indicativo individual de sucesso ou erro na gravação. Os retornos possíveis estão na lista abaixo:
status | errorCode | message |
---|---|---|
200 | Marcação gravada com sucesso. | |
400 | 00001 | PIS em formato inválido ou inexistente no cadastro. |
400 | 00002 | NSR duplicado. Número já foi importado na tabela marcac_nova_integr . |
400 | 00003 | NSR não foi informado e é obrigatório. |
400 | 00006 | É obrigatório informar o campo codRelogioExtChave. |
400 | 00006 | É obrigatório informar o campo codFuncMsa. |
400 | 00006 | É obrigatório informar o campo codPisMsa. |
400 | 00006 | É obrigatório informar o campo datMarcacAces. |
400 | 00006 | É obrigatório informar o campo numHorarMarcacAces. |
400 | 00006 | É obrigatório informar o campo codRep. |
400 | 00006 | É obrigatório informar o campo codUnidExtChave. |
400 | 00006 | É obrigatório informar o campo codUsuarExtChave. |
400 | 00006 | Campo 'codRelogioExtChave' no formato incorreto. Deve ser preenchido como texto e conter o código da empresa e do relógio no ERP. |
400 | 00006 | Campo 'codNsr' no formato incorreto. Deve ser preenchido como numérico. |
400 | 00006 | Campo 'numHorarMarcacAces' no formato incorreto. Deve ser preenchido como numérico. |
400 | 00006 | Campo 'codUnidExtChave' no formato incorreto. Deve ser preenchido como texto e conter o código da empresa e do estabelecimento no ERP. |
400 | 00006 | Campo 'codUsuarExtChave' no formato incorreto. Deve ser preenchido como texto e conter o código da empresa, do estabelecimento e matricula do funcionário no ERP.. |
400 | 00006 | Foi enviado marcações de um relógio que não está cadastrado no ERP |
Dado Registro infoSusp (codSusp: 1) incorreto - indSusp (50).
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"message": "Dado Registro infoSusp (codSusp: 1) incorreto - indSusp (50).",
"code": "53817",
"type": "error"
} |
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.
EMS2:
- Verificar se os parâmetros de conexão foram cadastrados corretamente no CD0387: URL, Porta, Usuário e Senha.
- Verificar se estão cadastrados corretamente os processos no CD2021 dentro do período selecionado no CD2014.
- Verificar se o processo (CD2021) está relacionado ao estabelecimento (CD2021A).