Additional - INTEGRAÇÃO GPEAADIAPI - Controle de Adicionais

Sistemas Envolvidos

Protheus (módulo Gestão de Pessoal): Módulo responsável pela gestão dos dados dos funcionários, folha de pagamento e dentre outros cadastros pertinentes aos colaboradores.
Quírons - NG

Integração

O objetivo desta integração é permitir que o RH ou área responsável pelo Gestão de Pessoal do Protheus, receba os dados do Controle de Adicionais dos funcionários de outros sistemas especializados, reduzindo assim o trabalho de inclusão/alteração/exclusão manual dessas informações dentro do sistema;

Benefícios
- Não terá um investimento alto de tempo para o cadastramento, pois os dados já serão enviados, editados ou excluídos através da integração a cada requisição do sistema especialista através da API de Adicional.
- A informação será atualizada de forma automática, facilitando que conferência e confiabilidade dos dados recebidos.

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.

Escopo

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

Atualização dos Adicionais de Periculosidade e Insalubridade do funcionário no módulo SIGAGPE;

Fora do escopo

Automatização de consultas dos adicionais do funcionário
Importação de base cadastral - dados do Funcionário,

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

Versões mínimas do Protheus: 12.1.23
Possuir acesso à Internet, caso o sistema que venha a utilizar a integração com a aplicação Protheus.
Estrutura de rede estável, para que haja tráfego de dados sem interrupção.
Protheus devidamente configurado e serviço Rest habilitado em seu server.

Instalação/Atualização

Este tópico tem por objetivo orientar a instalação da integração, visando o seu funcionamento completo.

Instalação de produtos ou ferramentas necessárias podem referenciar outros documentos existentes, desde que estejam disponíveis no repositório de documentação da TOTVS ou sejam enviados junto com o documento da integração em si.

As informações mínimas necessárias para este tópico são:

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:

Configuração de Webservice Rest no Protheus no formato apresentado na seguinte documentação (Exemplo de Configuração de Webservice REST)

Controle de Ambiente

Exige que os seguintes pontos sejam revisados:

Protheus com sua arquitetura devidamente estruturada.
Módulo de Gestão de Pessoal (SIGAGPE) com suas entidades base, devidamente populadas por dados que no momento da integração serão utilizados na criação do registro de adicional. (Para melhor compreensão, analise o cadastro disponível dentro do sistema e verifique os campos que possuem consultas em outras tabelas se as mesmas estão com os seus dados devidamente cadastrados).

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 à área de Gestão de Pessoal, no processo de alteração dos adicionais do funcionario.

Processos

O Sistema requisitante enviará as informações via json para a interface de integração, desta forma serão atualizados os dados de periculosidade e insalubridade dentro do cadastro do funcionário no Protheus, caso tenha êxito na geração do registro, será retornada a mesma estrutura json recebida, acompanhada de uma nova tag chamada id, que será uma chave única composta de informações da entidade dentro do sistema. Desta forma será confirmada sua gravação, caso contrário enviará as informações de inconsistências que serão citadas nos próximos tópicos.

Limitações / Restrições Gerais

Com o objetivo de manter a estrutura e a agilidade da estrutura Rest, o Web Service Rest receberá o registro individual de cada funcionário.

Como realizar a chamada da API REST

Para realizar a integração com o parceiro TOTVS são necessárias as informações básicas de consulta para retorno do funcionário desejado.

Preenchimento do EndPoint da API GPEAADIPI;
Utilizar a chamada do método Put e do Serviço Additional;
Preenchimento dos parâmetros obrigatórios da API.

Totvs custom tabs box

tabs	PUT
ids	PUT

Totvs custom tabs box items

default	no
referencia	PUT

Parâmetros de Entrada PUT:

Parâmetro	Valor de Exemplo	Obrigatório	Tipo	Valor Default	Descrição
authorization	usuario:senha	Sim	header	""	autenticação é requerida para o funcionamento correto da API em casos de ambientes com autenticação Http Basic.
additionalId	T1; D MG 01 ; T1\|D MG 01 \|000001	Sim	URL Parameters	""	Composição da string a ser enviada, deve ser ser composta por "GRUPO DE EMPRESA\|RA_FILIAL\|RA_MAT".
content	{ "companyId":"T1", "branchId": "D MG 01 ", "employeeId":"T1\|D MG 01 \|160001", "unhealthyDegree1": "1", "dangerousness1": "2" }	sim	body	""	Estrutura json com informações de periculosidade e insalubridade do funcionário: dangerousness: unhealthyDegree

Parâmetros e Chamada do Método:

Para a realização de testes foi utilizado a ferramenta POSTMAN 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/Additional/{additionalId}

Exemplo: http://localhost:5192/api/rh/v1/additional/T1;M SP 01 ;T1|M SP 01 |600001

Dados utilizados da API

Por ser uma estrutura única para todos os produtos, há dados que existem em um produto e não existe em outro produto, desta forma cada produto utilizará os campos pertinentes aos seus ambientes.

Propriedade API REST	CAMPO PROTHEUS	DESCRIÇÃO	Formato
companyId	M0_CODIGO	Informações de acesso ao sistema, campo contém informação do grupo de empresa
branchId	RA_FILIAL	Informações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial
employeeId	RA_MAT	Matrícula do Funcionário.	Empresa\|Filial\|Matrícula
dangerousness	RA_ADCPERI	Periculosidade	"1"
unhealthyDegree	RA_ADCINS	Insalubridade Grau	"2"

Situações Tratadas

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.

Mensagens Validação

Erro

Mensagem

Solução

API RESPONSE

400

Erro na validação do recebimento da mensagem.

Verificar se as propriedade URL Parameters additionalId está preenchida e com dados válidos no pacote enviado.

Dados de Empresa e Filial,
Dados de Filial e Matrícula,

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

{
    "code": 400,
    "detailedMessage": "Informação addionalId ausente ou inválida",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": "Erro na validação do recebimento da mensagem."
}

500

Ocorreu uma falha no retorno da informação.

É necessário avaliar se o servidor está funcionando corretamente.

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

{
   "errorCode": 500,
   "errorMessage": "Ocorreu uma falha no retorno da informação."
}

OBS: Estas mensagens de validações serão retornadas sempre que algum campo passado que seja obrigatório ou que algum campo enviado tenha sua origem de dados em outra tabela e não seja localizado na mesma, vale lembrar que são apenas exemplos de mensagens de erros e podendo variar o nome da propriedade enviada.

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.

Páginas filhas

Versões comparadas

Versão antiga 16

Nova versão 17

Chave

Additional - INTEGRAÇÃO GPEAADIAPI - Controle de Adicionais

Sistemas Envolvidos

Integração

Escopo

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

Instalação/Atualização

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

Controle de Ambiente

Controle de Versão

Suporte

Fluxo das Informações

Limitações / Restrições Gerais

Como realizar a chamada da API REST

Parâmetros de Entrada PUT:

Situações Tratadas

Checklist de suporte da aplicação

Anexos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 16

Nova versão 17

Chave

Additional - INTEGRAÇÃO GPEAADIAPI - Controle de Adicionais

Sistemas Envolvidos

Integração

Escopo

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

Instalação/Atualização

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

Controle de Ambiente

Controle de Versão

Suporte

Fluxo das Informações

Limitações / Restrições Gerais

Como realizar a chamada da API REST

Parâmetros de Entrada PUT:

Situações Tratadas

Checklist de suporte da aplicação

Anexos