Cada vez mais o mercado exige que as operações complexas e manipulação de dados sejam ainda mais ágeis e com custos reduzidos. Com o RH não é diferente, os processos cada vez mais complexos e com muitas inovações e prestadores de serviços no ramo de benefícios para administrar dentro do RH, empresas e softwares especialistas na administração de benefícios estão cada vez mais presentes no mercado e foi neste contexto que surgiu a necessidade da criação de uma interface para que possibilite automatizar o envio dos dados que hoje são realizados manualmente do ERP para o softwares especialista, seja feito através de uma interface de integração.
Descrição dos sistemas envolvidos no contexto de negócio (e que serão envolvidos na integração).
O objetivo desta integração é permitir que a área do RH ou área responsável pelos benefícios, envie os dados de funcionários para o sistema da DIVICOM e assim redução no trabalho de inclusão manual de todas as informações dentro do sistema.
Por padrão esta integração estará em repositório, porém demanda realizar a devida configuração conforme abaixo:
Exige que os seguintes pontos sejam revisados:
O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.
Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.
O suporte aos recursos da Integração será de responsabilidade da linha MicroSiga Protheus, onde será analisada pela equipe de suporte da Totvs.
Esta integração traz a funcionalidade exclusivamente para Calculo de Plano de Saúde e Histórico de Calculo de Saúde
Esta integração contempla apenas a consulta e envio dos dados de Calculo de Plano de Saúde e Histórico de Calculo de Saúde.
A DIVICOM realizará o consumo da API com dados básicos que serão utilizados como parâmetros para consultar a base e retornar um conjunto de informações pertinentes ao Calculo de Plano de Saúde e Histórico de Calculo de Saúde para o requisitante.
Para realizar a integração com o parceiro TOTVS é necessário as informações básicas de consulta para retorno dos funcionários desejados.
As Entradas e Saídas de dados tipo data(Date) acompanham o formato padrão YYYY-MM-DDThh:mm
Parâmetros de Entrada:
Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Parâmetro | Valor Default | Descrição |
page | 1 | Sim | Integer | query | Página que está sendo requisitada. | |
pageSize | 1 | Não | Integer | query | 100 | Quantidade de funcionários por página. |
product | PROTHEUS | Sim | String | query | ||
datemodified | 2001-01-01T18:25:43 | Não | String | query | Data que será utilizada como filtro para trazer funcionários com data de alteração(RA_USERLGA) | |
branchId | D MG 01 | Sim | String | query | ||
companyId | T1 | Sim | String | query | ||
authorization | não será informado pelos parâmetros REST | Sim | String | header | Configuração do parâmetro Security = 1 no arquivo appserver.ini |
Parâmetros e Chamada do Método:
Para a realização de testes foi utilizado a ferramenta SOAP UI e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo:
{protocolo}://{host}/{api}//rh/v1/payrollcontrol/
Response da API:
{ "items": [ { "originalRecord": "1 - Titular", "code": "000840", "internalIdCode": "T1|D MG 01 |000840", "contractCode": "", "companyKey": "T1|D MG 01 ", "paymentDate": "2018-01-31T00:00:00", "payrollIdentifier": "480", "paymentAmount": "50.00", "movimentDate": "2018-10-17T00:00:00", "providerCode": "001", "paymentPeriod": "201801", "branch": "D MG 01 ", "id": "T1|D MG 01 |000840|201801|1| |1|2|001|2|01|480", "providerType": "2 - Ass. Odontologica", "productCode": "01" }], "hasNext": false, "total": 1 } |
Dados utilizados da API
Por ser uma estrutura única para todos os produtos, há dados que existem em um produto (RM) e não existe no Protheus, desta forma cada produto utilizará os campos pertinentes aos seus ambientes.
CAMPOS PROTHEUS | PROPRIEDADES API REST | DESCRIÇÃO |
---|---|---|
RA_FILIAL | branch | Filial |
RA_MAT | code | Matricula |
RHS_DATA \ RHS_DATA | movimentDate | Data do Movimento |
Empresa + "|" + RA_FILIAL + "|" + RA_MAT | internalIdCode | Chave Interna do Funcionário |
RHS_ORIGEM / RHR_ORIGEM | originalRecord | Registro de Origem |
RHS_CODFOR \ RHR_CODFOR | providerCode | Código do Fornecedor |
RHS_TPFORN / RHR_TPFORN | providerType | Tipo de Fornecedor |
TABELA S074 | contractCode | Código do contrato |
RHS_PLANO / RHR_PLANO | productCode | Código do Plano |
RHS_PD / RHR_PD | payrollIdentifier | Código da Verba |
RHS_VLRFUN / RHR_COMPPG | paymentAmount | Valor Pago |
RHS_DATPGT / RHR_COMPPG | paymentDate | Data do Pagamento |
RHS_COMPPG / RHR_COMPPG | paymentPeriod | Período do Pagamento |
EMPRESA + "|"+ RA_FILIAL + "|" +RA_MAT + "|" + _COMPPG + "|" + _ORIGEM + "|" + _CODIGO + "|" + TP_PLAN + "|" + _TPFORN + "|" + _CODFOR + "|" + _TPPLAN+ "|" + _PLANO + "|" + _PD | id | Id interno do registro no protheus |
OBS: Campos da propriedade ID, que possuem o caractere inicial como "_" representa campos de mesmo nome que fazem parte tanto da tabela RHR quanto RHS.
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 Protheus:
Erro | Mensagem | Solução | |
400 | Campo RHS_USERLGA / RHR_USERLGA não foi encontrado. |
| |
400 | O Produto é um parâmetro obrigatório. |
| |
400 | A Filial é um parâmetro obrigatório. |
| |
400 | O Grupo de Empresa é um parâmetro obrigatório |
|
Itens a serem verificados durante o atendimento: