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 do cadastro de tipos de abono para o sistema da NG e assim reduzir o 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 Protheus, onde será analisada pela equipe de suporte da Totvs.
Esta integração traz a funcionalidade exclusivamente para exportação do cadastro de Tipos de Abono.
Esta integração contempla apenas a consulta e envio dos dados de Tipos de Abono.
A solicitante 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 cadastro de Tipos de Abono.
Para realizar a integração com o parceiro TOTVS é necessário as informações básicas de consulta para retorno dos tipos de abono 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 | Não | Integer | query | 1 | Página que está sendo requisitada. |
pageSize | 1 | Não | Integer | query | 2000 | Quantidade de tipos de abono por página. |
datemodified | 2001-01-01T18:25:43 | Não | String | query | Data que será utilizada como filtro para trazer tipos de abono com data de alteração (P6_USERLGA) ou inclusão (P6_USERLGI). | |
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/AllowanceType/
Response da API:
{ "items": [ { "BranchId": "D MG ", "AllowanceCode": "009", "CompanyId": "T1", "Name": "ABONO INTEGRAL", "id": "T1|D MG |009|" }, { "BranchId": "D MG ", "AllowanceCode": "107", "CompanyId": "T1", "Name": "ABONO ATRASO", "id": "T1|D MG |107|" }, { "BranchId": "D MG ", "AllowanceCode": "114", "CompanyId": "T1", "Name": "ABONO FALTAS", "id": "T1|D MG |114|" }, { "BranchId": "D MG ", "AllowanceCode": "115", "CompanyId": "T1", "Name": "ABONO 1/2 FALTA", "id": "T1|D MG |115|" } ], "hasNext": false } |
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 P6_USERLGI / P6_USERLGA não foi encontrado. |
| |
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: