Controle de Afastamentos/Ausências - leaveOfAbsenceControl - INTEGRAÇÃO GPEA240API -

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 Afastamentos/Ausências 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 Afastamentos/Ausências.
- 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:

Manutenção do controle de afastamentos/ausências do funcionário no módulo SIGAGPE;

Fora do escopo

Automatização de consultas de controle de afastamentos,
Importação de base cadastral - dados do Funcionário,
Informações do controle de afastamentos que não se enquadram dentro da tabela de controle de afastamentos.

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 afastamento/ausências. (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 cadastramento (inclusão/alteração/exclusão) de Afastamento/Ausências.

Cadastro

Esta integração contempla apenas o cadastramento(inclusão/alteração/exclusão) do cadastro de Afastamento/Ausências dentro do módulo SIGAGPE.

Processos

O Sistema requisitante enviará as informações via json para a interface de integração, desta forma será gerado um novo registro na tabela de Afastamentos/Ausências no Protheus, caso tenha êxito na geração do registro, será retornada a mesma estrutura de json recebida, acompanhada de uma nova tag chamada id, 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 afastamento.

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 GPEA240API;
Utilizar a chamada do método Post, Put e Delete e do Serviço leaveOfAbsenceControl;
Preenchimento dos parâmetros obrigatórios da API.

Totvs custom tabs box

tabs	POST,PUT,DELETE
ids	POST,PUT,DELETE

Totvs custom tabs box items

default	no
referencia	POST

Parâmetros de Entrada POST:

Parâmetro

Valor de Exemplo

Obrigatório

Tipo

Valor Default

Descrição

authorization

usuario:senha

Sim

header

autenticação é importante para o funcionamento correto da API em casos de ambientes com autenticação Http Basic.

content

request da api

Sim

body

Estrutura json com informações de cadastro do currículo:

Propriedades Obrigatórias:

Dados de preparação de ambiente:

companyId: Grupo de empresa
branchId: Empresa+Unidade de negócio+Filial

Dados de controle de afastamentos:

employeeId: Informação pertinente ao funcionário.
startDate: Data inicial do afastamento.
endDate: Data final do afastamento.
leaveOfAbsenceCode: Código do tipo de afastamento.
internationalDiseaseClassification: Código internacional de doenças.
classEntityRegistrationCode: Número do registro do profissional
doctorName: Nome do profissional.
classEntityState: Estado do profissional.
classEntity: Tipo de registro do profissional.

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/leaveOfAbsenceControl

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.

Propriedade API REST	CAMPO PROTHEUS	DESCRIÇÃO	Formato
companyId		Informações de acesso ao sistema, campo contém informação do grupo de empresa
branchId	R8_FILIAL	Informações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial	"D MG 01 "
employeeId	R8_MAT	Chave do Funcionário	"T1\|D MG 01 \|160001"
startDate	R8_DATAINI	Data inicial do afastamento	"20200101"
endDate	R8_DATAFIM	Data final do afastamento	"20200101"
leaveOfAbsenceCode	R8_TIPOAFA	Chave do tipo de afastamento	"T1\|D MG \|005"
internationalDiseaseClassification	R8_CID	Código internacional de doenças.	"A07.8"
classEntityRegistrationCode	R8_CRMMED	Número do registro do profissional	"123123"
doctorName	R8_NMMED	Nome do profissional.	"doctorName"
classEntityState	R8_UFCRM	Estado do profissional.	"MG"
classEntity	R8_IDEOC	Tipo de registro do profissional.	"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

201

Registro criado.

Registro incluído com sucesso.

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

{
    "branchId": "D MG 01 ",
    "startDate": "2020-06-05T10:10:10",
    "endDate": "2020-06-05T19:10:10",
    "employeeId": "T1|D MG 01 |160001",
    "leaveOfAbsenceCode": "T1|D MG    |005",
    "classEntityState": "SP",
    "companyId": "T1",
    "classEntityRegistrationCode": "123123",
    "doctorName": "doctorName Alves",
    "id": "T1;D MG 01 ;T1|D MG 01 |160001;2020-06-05T10:10:10;00:00;2020-06-05T19:10:10;T1|D MG    |005",
    "classEntity": "2",
    "internationalDiseaseClassification": "A07.8"
}

400

Erro na validação do recebimento da mensagem.

Verificar se as propriedades json companyId ou branchId estão preenchidas com conteúdo válido.

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

{
    "code": 400,
    "detailedMessage": "De-Para de Empresa/Filial não encontrado na base.\r\n",
    "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.

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 é importante para o funcionamento correto da API em casos de ambientes com autenticação Http Basic.
leaveOfAbsenceId	T1;D MG 01 ;T1\|D MG 01 \|160001;2020-06-01T10:10:10;00:00;2020-06-02T19:10:10;T1\|D MG \|005	Sim	request	""	Composição da string a ser enviada, deve ser ser composta por "GRUPODEEMPRESA\|R8_FILIAL\|CHAVEFUNCIONARIO\|DATAINICIAL\|HORAINICIAL\|DATAFINAL\|CODIGOAFASTAMENTO".
content	layout json	sim	body	""	Estrutura json com informações de cadastro do currículo: Propriedades Obrigatórias: *Dados de preparação de ambiente:* companyId: Grupo de empresa branchId: Empresa+Unidade de negócio+Filial *Dados de controle de afastamentos:* employeeId: Informação pertinente ao funcionário. startDate: Data inicial do afastamento. endDate: Data final do afastamento. leaveOfAbsenceCode: Código do tipo de afastamento. internationalDiseaseClassification: Código internacional de doenças. classEntityRegistrationCode: Número do registro do profissional doctorName: Nome do profissional. classEntityState: Estado do profissional. classEntity: Tipo de registro do profissional.

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/leaveOfAbsenceControl

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.

Propriedade API REST	CAMPO PROTHEUS	DESCRIÇÃO	Formato
companyId		Informações de acesso ao sistema, campo contém informação do grupo de empresa
branchId	RFX_FILIAL	Informações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial
employeeId	R8_MAT	Chave do Funcionário	"T1\|D MG 01 \|160001"
startDate	R8_DATAINI	Data inicial do afastamento	"20200101"
endDate	R8_DATAFIM	Data final do afastamento	"20200101"
leaveOfAbsenceCode	R8_TIPOAFA	Chave do tipo de afastamento	"T1\|D MG \|005"
internationalDiseaseClassification	R8_CID	Código internacional de doenças.	"A07.8"
classEntityRegistrationCode	R8_CRMMED	Número do registro do profissional	"123123"
doctorName	R8_NMMED	Nome do profissional.	"doctorName"
classEntityState	R8_UFCRM	Estado do profissional.	"MG"
classEntity	R8_IDEOC	Tipo de registro do profissional.	"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

200

Atualizado com sucesso.

Registro alterado com sucesso.

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

{
    "branchId": "D MG 01 ",
    "startDate": "2020-06-05T10:10:10",
    "endDate": "2020-06-05T19:10:10",
    "employeeId": "T1|D MG 01 |160001",
    "leaveOfAbsenceCode": "T1|D MG    |005",
    "classEntityState": "SP",
    "companyId": "T1",
    "classEntityRegistrationCode": "123123",
    "doctorName": "doctorName Alves",
    "id": "T1;D MG 01 ;T1|D MG 01 |160001;2020-06-05T10:10:10;00:00;2020-06-05T19:10:10;T1|D MG    |005",
    "classEntity": "2",
    "internationalDiseaseClassification": "A07.8"
}

400

Erro na validação do recebimento da mensagem.

Verificar se as propriedade json leaveOfAbsenceId está preenchida e com dados válidos no pacote enviado.

Dados de Empresa e Filial,
Dados de Filial e Matrícula,
Formato da Data de Início,

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

{
    "code": 400,
    "detailedMessage": "Informação leaveOfAbsenceId 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.

Totvs custom tabs box items

default	no
referencia	DELETE

Parâmetros de Entrada DELETE:

Parâmetro	Valor de Exemplo	Obrigatório	Tipo	Valor Default	Descrição
authorization	usuario:senha	Sim	header	""	autenticação é importante para o funcionamento correto da API em casos de ambientes com autenticação Http Basic.
leaveOfAbsenceId	T1;D MG 01 ;T1\|D MG 01 \|160001;2020-06-01T10:10:10;00:00;2020-06-02T19:10:10;T1\|D MG \|005	Sim	query	""	Composição da string a ser enviada, deve ser ser composta por "GRUPODEEMPRESA\|R8_FILIAL\|CHAVEFUNCIONARIO\|DATAINICIAL\|HORAINICIAL\|DATAFINAL\|CODIGOAFASTAMENTO"

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/leaveOfAbsenceControl

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

200

Registro foi deletado com sucesso.

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

{
    "code": "200",
    "description": "Opera��o realizada com sucesso!"
}

400

Erro na validação do recebimento da mensagem.

Verificar se as propriedade json leaveOfAbsenceId está preenchida e com dados válidos no pacote enviado.

Dados de Empresa e Filial,
Dados de Filial e Matrícula,
Formato da Data de Início,
Formato da Hora de Inicio
Codigo do Tipo de Afastamento.

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

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

500

Erro no acesso ao Endpoint.

É 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 55

Nova versão 56

Chave

Controle de Afastamentos/Ausências - leaveOfAbsenceControl - INTEGRAÇÃO GPEA240API -

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

Situações Tratadas

Parâmetros de Entrada PUT:

Situações Tratadas

Parâmetros de Entrada DELETE:

Situações Tratadas

Checklist de suporte da aplicação

Anexos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 55

Nova versão 56

Chave

Controle de Afastamentos/Ausências - leaveOfAbsenceControl - INTEGRAÇÃO GPEA240API -

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

Situações Tratadas

Parâmetros de Entrada PUT:

Situações Tratadas

Parâmetros de Entrada DELETE:

Situações Tratadas

Checklist de suporte da aplicação

Anexos