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

Contexto de negócio (Introdução)

Cada vez mais o mercado exige que as operações complexas e manipulação de dados ainda mais ágeis e com custos reduzidos. Com o RH não é diferente, os processos cada vez mais complexos e com muitas variáveis a serem analisadas nos processos de segurança e medicina do trabalho, os profissionais de saúde precisam de agilidade na hora de controlar processos funcionais da empresa.

Com essa necessidade e a importância desta área dentro da empresa, softwares especialistas em medicina e segurança do trabalho estão cada vez mais presentes no mercado e foi neste contexto que surgiu a necessidade da criação de uma interface para que possibilitasse automatizar cadastros e rotinas de funcionais dentro do ERP através de uma interface de integração.

Dentro deste cenário, tornou-se importante controlar os registros de afastamentos e ausências do funcionário dentro de um contexto totalmente integrado.

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:

• Cadastramento 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.

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.

{
    "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"
}

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.

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

{
 "companyId": "T1",
 "branchId": "D MG 01 ",
 "startDate": "2020-01-01T18:25:43",
 "stabilityCode": "123"
}

{
    "code": "201",
    "description": "Registro criado."
}

{
    "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."
}

{
    "code": 400,
    "detailedMessage": "VerifiqueDe-Para ode conteúdoEmpresa/Filial danão TAGencontrado (employeeId) pois não foi possível encontrar esta informação no Protheus'na base.\r\n",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": "Erro na validação do recebimento da mensagem."
}

{
    "codeerrorCode": 400500,
    "detailedMessageerrorMessage": "VerifiqueOcorreu o conteúdo da TAG (startDate) pois a data não estáuma falha no formatoretorno correto: 'YYYY-MM-DDTHH:MM:SS'\r\n",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": "Erro na validação do recebimento da mensagem."
}

{
    "code": 400,
    "detailedMessage": "Verifique o conteúdo da TAG (stabilityCode) pois não foi possível encontrar esta informação no Protheus.\r\n",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": "Erro na validação do recebimento da mensagem."
}

{
    "code": 400,
    "detailedMessage": "Verifique o conteúdo da TAG (employeeId) pois ela é obrigatória para a manipulação deste processo.\r\n\r\n",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": "Erro na validação do recebimento da mensagem."
}

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