INTEGRAÇÃO 

Contexto de negócio (Introdução)

Cada vez mais o mercado exige que as operações complexas e manipulação de dados ainda mais ágeis e com custos reduzidos.

Frente a esta necessidade, foi criada uma API para fazer a integração direta entre o ERP e o sistema TFS

Sistemas Envolvidos

• HCM (módulo Folha de Pagamento): O módulo é responsável por manter as informações pessoais e financeiras do funcionário em relação a empresa
• TOTVS Financial Services - Sistema de serviços financeiros da TOTVS

Integração

O objetivo dessa integração é permitir que o TFS tenha acesso facilitado as informações dos funcionário cadastrados no EPS Datasul, reduzindo o trabalho de inclusão manual

Arquitetura (Tecnologia)

• Esta integração é feita por intermédio de comunicação direta com os Web Services REST (Representation State Transfer) utilizando o formato JSON (JavaScript Object Notation) de serialização de dados.

Escopo

Por intermédio desta integração será disponibilizada a seguinte funcionalidade:

• O HCM irá enviar as informações do funcionário cadastradas no sistema.

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

• Versões mínima do TOTVS/Datasul: 12.1.27
• 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. 
• No programa FP0200 tem um registro que inicie com TFS5M

Processos

O Sistema requisitante enviará as informações via Json para a interface de integração, desta forma será validado as informações contidas no Json. Caso tenha êxito na geração do registro, será retornado a mesma estrutura de Json confirmando sua gravação, caso contrário enviará as informações de inconsistências citadas nos próximos tópicos.

Limitações / Restrições Gerais

• A integração não contemplará exclusão de registros no HCM, para isso o usuário deverá acessar o HCM e excluir manualmente o mesmo e seus devidos relacionamentos. 

Como realizar a chamada da API REST

Para realizar a integração, é necessário as informações básicas para cadastramento do processo.

• Preenchimento do EndPoint da API EmployeePayrollInfo;
• Utilizar a chamada do método Post e do Serviço rEmployeePayrollInfo;
• Preenchimento dos parâmetros obrigatórios da API;

Parâmetros de Entrada:

Ordem da busca do funcionário, se informado os seguintes campos:

1 - companyInternalId e employeeInternalId

Já que foi informado o caminho exato da matrícula do funcionário, faz a busca direta.

2 - companyFederalIdentification e employeeCode

Busca pelo CNPJ da empresa e o código do funcionário.

3 - companyFederalIdentification e employeeFederalIdentification

Busca pelo CNPJ da empresa e CPF do funcionário.

Parâmetros e Chamada do Método:

Autenticação do tipo básica. 

Método POST.

{protocolo}://{host}/dts/datasul-rest/resources/prg/rh/v1/EmployeePayrollInfo

Request da API

Dados utilizados da API

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

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.