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 lançamentos de ausências, envie os dados do cadastro de tipos de afastamento 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 Afastamento/Ausências.
Esta integração contempla apenas a consulta e envio dos dados de Tipos de Afastamento/Ausências.
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 Afastamento/Ausências.
Para realizar a integração com o parceiro TOTVS é necessário as informações básicas de consulta para retorno dos tipos de afastamento 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 afastamento por página. |
datemodified | 2001-01-01T18:25:43 | Não | String | query | Data que será utilizada como filtro para trazer tipos de afastamento com data de alteração (RCM_USERGA) ou inclusão (RCM_USERGI). | |
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/leaveOfAbsenceType/
Response da API:
{ "items": [ { "branchId": "D MG ", "leaveOfAbsenceCode": "006", "esocialLeaveCode": "17", "companyId": "T1", "name": "Afastamento Temporario por Motivo de Licença-Maternidade Pago pela Empresa", "id": "T1|D MG |006|" }, { "branchId": "D MG ", "leaveOfAbsenceCode": "007", "esocialLeaveCode": "", "companyId": "T1", "name": "Afastamento Temporario por Motivo de Licenca-Maternidade Pago pelo INSS", "id": "T1|D MG |007|" }, { "branchId": "D MG ", "leaveOfAbsenceCode": "010", "esocialLeaveCode": "", "companyId": "T1", "name": "Licenca-Maternidade Decorrente de Adocao (120 Dias)", "id": "T1|D MG |010|" } ], "hasNext": true } |
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 RCM_USERGI / RCM_USERGA 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: