Integrações

Páginas filhas
  • Controle de Estabilidade - stabilityControl

stabilityControl - INTEGRAÇÃO GPEA923API - Controle de Estabilidade

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 o RH ou área responsável pelo Gestão de Pessoal do Protheus, receba os dados do Controle de Estabilidade 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 Estabilidade.
    • 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 Período de Estabilidade do funcionário no módulo SIGAGPE;

Fora do escopo

  • Automatização de consultas de Período de Estabilidade,
  • Importação de base cadastral - dados do Funcionário,
  • Informações do Período de Estabilidade que não se enquadram dentro da tabela de Período de Estabilidade

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:

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 estabilidade. (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 Período de Estabilidade.

Cadastro

Esta integração contempla apenas o cadastramento(inclusão/alteração/exclusão) do Período de Estabilidade 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 Período de Estabilidade 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 Período de Estabilidade.

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




Parâmetros de Entrada POST:

Parâmetro

Valor de Exemplo

Obrigatório

Tipo

Valor Default

Descrição
authorization usuario:senhaSim

header


autenticação é requerida para o funcionamento correto da API em casos de ambientes com autenticação Http Basic.
content{
"companyId":"T1",
"branchId": "D MG 01 ",
"employeeId":"T1|D MG 01 |160001",
"startDate": "2020-06-02T10:10:10",
"stabilityCode": "T1|D MG |S01"
}		Simbody

Estrutura json com informações do período de estabilidade do funcionário:

Dados de preparação de ambiente:

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

Dados de Período de Estabilidade:

  • employeeId: Informação pertinente ao funcionário.
  • startDate: Data do Início do Período de Estabilidade.
  • endDate: Data do Final do Período de Estabilidade.
  • stabilityCode: Tipo de Estabilidade registrado.

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}/api/rh/v1/stabilityControl


Dados utilizados da API

Por ser uma estrutura única para todas as linhas, cada linha utilizará os campos pertinentes aos seus ambientes.

Propriedade API RESTCAMPO PROTHEUSDESCRIÇÃOFormato
companyId
Informações de acesso ao sistema, campo contém informação do grupo de empresa
branchIdRFX_FILIALInformações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial"D MG 01 "
employeeIdRFX_MATChave do Funcionário"T1|D MG 01 |000001"
startDateRFX_DATAIData de Início do Período"2020-01-01T18:25:43"
endDateRFX_DATAFData de término do Período"2020-01-01T18:25:43"
stabilityCode

RFX_TPESTB

Chave do Tipo de Estabilidade"T1|D MG |S01"

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
201Registro criado.
{
    "companyId": "T1",
    "branchId": "D MG 01 ",
    "startDate": "2020-01-01T18:25:43",
    "employeeId": "T1|D MG 01 |000001",
    "stabilityCode": "T1|D MG    |S01",
    "id": "T1;D MG 01 ;T1|D MG 01 |000001;2020-01-01T18:25:43;T1|D MG    |S01"
}
400Erro na validação do recebimento da mensagem.Verificar se as propriedades json obrigatórias (companyID , branchId , employeeId, startDate, stabilityCode) estão preenchidas.
{
    "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."
}
500

Ocorreu uma falha no retorno da informação.

É necessário avaliar se o servidor está funcionando corretamente.
{
    "code": 500,
    "detailedMessage": "Ocorreu uma falha no retorno da informação.",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": Descrição do erro.
}

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.


Parâmetros de Entrada PUT:

Parâmetro

Valor de Exemplo

Obrigatório

Tipo

Valor Default

Descrição
authorization usuario:senhaSim

header


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

T1;D MG 01 ;T1|D MG 01 |160001;2020-06-18T10:10:10;T1|D MG |S01

Simrequest

Composição da string a ser enviada, deve ser ser composta por "GRUPO DE EMPRESA;FILIAL;CHAVEFUNCIONARIO;DATA DE INÍCIO; CHAVE TIPODEESTABILIDADE".

content

{
"companyId":"T1",
"branchId": "D MG 01 ",
"employeeId":"T1|D MG 01 |160001",
"startDate": "2020-06-02T10:10:10",

"endDate": "2020-06-02T10:10:10",
"stabilityCode": "T1|D MG |S01"
}

simbody

Estrutura json com informações do perído de estababilidade:

Dados de preparação de ambiente:

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

Dados de Período de Estabilidade:

  • employeeId: Informação pertinente ao funcionário.
  • startDate: Data do Início do Período de Estabilidade.
  • stabilityCode: Tipo de Estabilidade registrado.

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}/api/rh/v1/stabilityControl{stabilityId}



Dados utilizados da API

Por ser uma estrutura única para todas as linhas, cada linha utilizará os campos pertinentes aos seus ambientes.

Propriedade API RESTCAMPO PROTHEUSDESCRIÇÃOFormato
companyId
Informações de acesso ao sistema, campo contém informação do grupo de empresa
branchIdRFX_FILIALInformações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial"D MG 01"
employeeIdRFX_MATChave do Funcionário."T1|D MG 01 |000001"
startDateRFX_DATAIData do Início do Período"2020-01-01T18:25:43"
startDateRFX_DATAFData do final do Período"2020-01-01T18:25:43"
stabilityCodeRFX_TPESTBChave do Tipo de Estabilidade"T1|D MG |S01"

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.

{
"companyId":"T1",
"branchId": "D MG 01 ",
"employeeId":"T1|D MG 01 |160001",
"startDate": "2020-06-02T10:10:10",
"endDate": "2020-06-03T10:10:10",
"stabilityCode": "T1|D MG |S01",
"id": "T1;D MG 01 ;2020-06-02T10:10:10;10:10;T1|D MG 01 |160001"
}

400

Erro na validação do recebimento da mensagem.

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

  1. Dados de Empresa e Filial,
  2. Dados de Filial e Matrícula,
  3. Formato da Data de Início,
  4. Tipo de Estabilidade.
{
    "code": 400,
    "detailedMessage": "Informação stabilityId 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.
{
    "code": 500,
    "detailedMessage": "Ocorreu uma falha no retorno da informação.",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": Descrição do erro.
}


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.



Parâmetros de Entrada DELETE:

Parâmetro

Valor de Exemplo

Obrigatório

Tipo

Valor Default

Descrição
authorization usuario:senhaSim

header


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

T1;D MG 01 ;T1|D MG 01 |160001;2020-06-18T10:10:10;T1|D MG |S01

Simquery

Composição da string a ser enviada, deve ser ser composta por "GRUPODEEMPRESA;FILIAL;CHAVEFUNCIONARIO;DATAINICIO;CHAVETIPODEESTABILIDADE".

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}/api/rh/v1/stabilityControl{stabilityId}

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
200Operação realizada com sucesso.Registro foi deletado com sucesso.
{
    "code": "200",
    "description": "Operação realizada com sucesso!"
}

400

Erro na validação do recebimento da mensagem.

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

  1. Dados de Empresa e Filial,
  2. Dados de Filial e Matrícula,
  3. Formato da Data de Início,
  4. Tipo de Estabilidade.
{
    "code": 400,
    "detailedMessage": "Informação stabilityId 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.
{
    "code": 500,
    "detailedMessage": "Ocorreu uma falha no retorno da informação.",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": Descrição do erro.
}


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.


Anexos