Páginas filhas
  • Relação de Tipos de Afastamento - leaveofabsencetype

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
leaveOfAbsenceType - INTEGRAÇÃO GPEA430API - Relação

Relação de Tipos de Afastamento/Ausência - leaveofabsencetype - INTEGRAÇÃO GPEA430API 

Sistemas Envolvidos

Descrição dos sistemas envolvidos no contexto de negócio (e que serão envolvidos na integração).

  • Protheus (módulo de Gestão de Pessoal): Módulo responsável pela gestão do funcionário.
  • Quírons - NG

Integração

O objetivo desta integração é permitir que a área do RH ou área responsável pelos benefícios 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.

  • Benefícios 
    • Normalmente o colaborador responsável ou empresa de benefícios, incluir as informações de cadastros de função através de um arquivo (csv, txt) ou até mesmo manualmente, com a interface de integração isso será feito de forma  automática.
    • Não terá um investimento alto de tempo para o cadastramento, pois os dados já serão enviados através da integração a cada requisição do sistema especialista.
  • Arquitetura (Tecnologia)
    • Toda integração entre o Protheus e o Sistema é feita por intermédio de comunicação direta com os Web Services(que são fixos)  REST(Representation State Transfer) utilizando o formato JSON(JavaScript  Object Notation) de serialização de dados, onde através da ativação do serviço do REST do Protheus esteja disponível para utilizar o serviço.
  • Premissas e Propriedades
    • O parceiro que será responsável pela requisição e transformação da informação recebida;
    • Cada produto deverá gerar um LOG de inclusão(RCM_USERGI) ou alteração (RCM_USERGA) de registros a fim de controlar os dados a serem integrados;
    • Na requisição, o parceiro deverá informar  através do preenchimento do parâmetro datemodified se desejar uma carga completa(deixar o parâmetro vazio) ou somente os dados que foram atualizados(Informando a data de alteração). Caso seja solicitada a carga, todos os dados deverão ser enviados novamente. Caso seja  solicitado uma atualização, somente os dados com data igual ou posterior a data informada, serão transmitidos;
    • A data de alteração do registro deverá ser enviada em cada processo, permitindo que o solicitante possa controlar essa informação;
    • Será implementado um controle de paginação a fim de facilitar o envio da informação para o solicitante. Neste processo o solicitante deverá informar qual é o tamanho da informação solicitada e qual página ela solicita;
    • Cabe a integração informar se existem mais páginas a serem solicitadas;


Ativação/Desativação da integração

Por padrão esta integração estará em repositório, porém demanda realizar a devida configuração conforme abaixo:

Controle de Ambiente

Exige que os seguintes pontos sejam revisados:

  • Protheus com sua arquitetura devidamente estruturada.
  • Módulo Gestão de Pessoal com os dados do cadastro de afastamento/ausências devidamente inseridos.

Controle de Versão

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.

Suporte

O suporte aos recursos da Integração será de responsabilidade da linha Protheus, onde será analisada pela equipe de suporte da Totvs.

Fluxo das Informações

Esta integração traz a funcionalidade exclusivamente para exportação do cadastro de Tipos de Afastamento/Ausências.

Cadastro

Esta integração contempla apenas a consulta e envio dos dados de Tipos de Afastamento/Ausências.

Processos

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.

Limitações / Restrições Gerais

  • A integração não contemplará inclusão,alteração e exclusão de registros no Protheus, para isso o usuário deverá acessar o ERP e efetuar as devidas ações manualmente.
  • Cada produto deverá gerar um LOG de inclusão e alteração de registros a fim de controlar os dados a serem integrados;
  • A data de alteração do registro deverá ser enviada em cada processo, permitindo que o solicitante possa controlar essa informação;


Como realizar a chamada da API REST

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.

  • Preenchimento do EndPoint da API GPEA430API;
  • Utilizar a chamada do método Get e do Serviço leaveOfAbsenceType leaveofabsencetype;
  • Preenchimento dos parâmetros obrigatórios da API;

Formatos de Data

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

TipoParâmetro

Valor Default

Descrição
page1Não

Integer

query1Página que está sendo requisitada.
pageSize1Não

Integer

query

2000

Quantidade de tipos de afastamento por página.
datemodified2001-01-01T18:25:43NãoStringquery
Data que será utilizada como filtro para trazer tipos de afastamento com data de alteração (RCM_USERGA) ou inclusão (RCM_USERGI).
branchIdD MG 01SimStringquery

companyIdT1SimStringquery

authorization

não será informado pelos parâmetros RESTSimStringheader
Configuração do parâmetro 

Security = 1 no arquivo appserver.ini

Image Removed



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:


Bloco de código
languagecpp
themeConfluence
titleResponse LeaveOfAbsenceTypes
{
    "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
}

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 Protheus:

Mensagens de Pré-Validação

Erro

Mensagem

Solução

400

Campo RCM_USERGI / RCM_USERGA não foi encontrado.

Bloco de código
languagecpp
themeConfluence
titleCampos _USERLGA/_USERLGI
{
    "code": 400,
    "detailedMessage": "Campo USERGA não foi encontrado: Entidade (RCM)",
    "helpUrl": "https://tdn.totvs.com/x/BJuMHw",
    "message": "Campo USERGA não foi encontrado: Entidade (RCM)"
}
400

A Filial é um parâmetro obrigatório.

Bloco de código
languagecpp
themeConfluence
titleQuando o campo branchId está em branco.
{
   "code": 400,
   "detailedMessage": "Falha ao validar as informações básicas da assinatura. Informação: branchId",
   "helpUrl": "https://tdn.totvs.com/x/BJuMHw",
   "message": "Falha ao validar as informações básicas da assinatura. Informação: branchId"
}
400O Grupo de Empresa é um parâmetro obrigatório 
Bloco de código
languagecpp
themeConfluence
titleErro quando campo companyId está vazio.
{
   "code": 400,
   "detailedMessage": "Falha ao validar as informações básicas da assinatura. Informação: companyId",
   "helpUrl": "https://tdn.totvs.com/x/BJuMHw",
   "message": "Falha ao validar as informações básicas da assinatura. Informação: companyId"
}
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 ou algo que possa identificar a origem do problema.