Relação de Tipos de Abono - allowanceTypes - INTEGRAÇÃO PONA050API

Sistemas Envolvidos

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

• Protheus (módulo de Ponto Eletrônico): Módulo responsável pela gestão da assiduidade e marcações/apontamentos de horários de trabalho do funcionário, dentre outros cadastros pertinentes aos colaboradores.
• Quírons - NG

Integração

O objetivo desta integração é permitir que a área do RH ou área responsável pelas marcações/apontamentos de horário, envie os dados do cadastro de tipos de abono 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 inclui as informações de cadastros de tipos de abono 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 Quírons é 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(P6_USERLGI) ou alteração (P6_USERLGA) 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 e 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 serão enviados novamente. Caso seja  solicitado uma atualização, somente os dados com data igual ou posterior a data informada, serão transmitidos;
  • 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 ele 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:

• 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 Ponto Eletrônico com os dados do cadastro de Tipo de abono 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 Abono.

Cadastro

Esta integração contempla apenas a consulta e envio dos dados de Tipos de Abono.

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 Abono.

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 abono desejados.

• Preenchimento do EndPoint da API PONA050API;
• Utilizar a chamada do método Get e do Serviço allowanceTypes;
• 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â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/v2/allowanceTypes/

Response da API:

{
    "items": [
        {
            "branchId": "D MG    ",
            "code": "009",
            "companyId": "T1",
            "name": "ABONO INTEGRAL",
            "id": "T1|D MG    |009|"
        },
        {
            "branchId": "D MG    ",
            "code": "107",
            "companyId": "T1",
            "name": "ABONO ATRASO",
            "id": "T1|D MG    |107|"
        },
        {
            "branchId": "D MG    ",
            "code": "114",
            "companyId": "T1",
            "name": "ABONO FALTAS",
            "id": "T1|D MG    |114|"
        },
        {
            "branchId": "D MG    ",
            "code": "115",
            "companyId": "T1",
            "name": "ABONO 1/2 FALTA",
            "id": "T1|D MG    |115|"
        }
    ],
    "hasNext": false
}

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

{
    "code": 400,
    "detailedMessage": "Campo USERLGA não foi encontrado: Entidade (SP6)",
    "helpUrl": "https://tdn.totvs.com/x/BJuMHw",
    "message": "Campo USERLGA não foi encontrado: Entidade (SP6)"
}

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

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

Relação de Centros de Custos - payrollCostCenter - INTEGRAÇÃO GPEA002API 

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 pelo controle de centros de custos, envie os dados do cadastro de centro de custo 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 inclui as informações de cadastros de centro de custo 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 Quírons é 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(CTT_USERGI) ou alteração (CTT_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 e 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 serão enviados novamente. Caso seja  solicitado uma atualização, somente os dados com data igual ou posterior a data informada, serão transmitidos;
  • 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 ele 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:

• 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 Gestão de Pessoal com os dados de Centro de Custo 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 centro de custo.

Cadastro

Esta integração contempla apenas a consulta e envio dos dados de cadastro de centro de custo.

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 centro de custo.

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 RESTMatrícula não existe no Protheus(SRA).

Para realizar a integração com o parceiro TOTVS é necessário as informações básicas de consulta para retorno dos centros de custos desejados.

• Preenchimento do EndPoint da API GPEA002API;
• Utilizar a chamada do método Get e do Serviço payrollcostcenter;
• 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â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/payrollcostcenter/

Response da API:

Response PayrollCostCenter

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

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.

Relação de Turnos de Trabalho workingShift - INTEGRAÇÃO PONA080API 

Sistemas Envolvidos

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

• Protheus (módulo  Ponto Eletrônico):  Módulo responsável pela gestão da assiduidade e marcações/apontamentos de horários de trabalho do funcionário, dentre outros cadastros pertinentes aos colaboradores.
• Quírons - NG

Integração

O objetivo desta integração é permitir que a área do RH ou área responsável pelas marcações/apontamentos de horário, envie os dados do cadastro de turnos de trabalho 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 inclui as informações de cadastros de turnos de trabalho 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 Quírons é 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(R6_USERLGI) ou alteração (R6_USERLGA) 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 e 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 serão enviados novamente. Caso seja  solicitado uma atualização, somente os dados com data igual ou posterior a data informada, serão transmitidos;
  • 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 ele 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:

• 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 Ponto Eletrônico com os dados do cadastro de Tipo de abono devidamente inseridos.

O objetivo desta integração é permitir que a área do RH ou área responsável pelos benefícios, envie os dados do cadastro de turnos para o sistema da NG e assim reduzir o trabalho de inclusão manual de todas as informações dentro do sistema.

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 Turnos de Trabalho.

Cadastro

Esta integração contempla apenas a consulta e envio dos dados de Turnos de Trabalho.

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 Turnos de Trabalho.

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 abono desejados.

• Preenchimento do EndPoint da API PONA080API;
• Utilizar a chamada do método Get e do Serviço workingShift;
• 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â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/workingShift/

Response da API:

Response WorkingShift

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

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.

Relação de Funções - positions  - INTEGRAÇÃO GPEA030API

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 pelo cadastro de funções do funcionário, envie os dados do cadastro de funções 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 inclui as informações de cadastros de funções 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 Quírons é 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(RJ_USERLGI) ou alteração (RJ_USERLGA) 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 e 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 serão enviados novamente. Caso seja  solicitado uma atualização, somente os dados com data igual ou posterior a data informada, serão transmitidos;
  • 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 ele 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:

• 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 Gestão de Pessoal com os dados do cadastro de funções 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 funções.

Cadastro

Esta integração contempla apenas a consulta e envio dos dados de funções.

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 funções.

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 das funções desejados.

• Preenchimento do EndPoint da API GPEA030API;
• Utilizar a chamada do método Get e do Serviço positions;
• 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â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/positions/

Response da API:

Response Positions

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

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.

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

• 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 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;
• 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â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:

Response LeaveOfAbsenceTypes

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

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.

Relação de Tipos de Estabilidade stabilityType - INTEGRAÇÃO GPES053API

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 períodos de estabilidade dos funcionários, envie os dados do cadastro de tipos de estabilidade 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 inclui as informações de cadastros de tipos de estabilidade 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 Quírons é 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(RCC_USERGI) ou alteração (RCC_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 e 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 serão enviados novamente. Caso seja  solicitado uma atualização, somente os dados com data igual ou posterior a data informada, serão transmitidos;
  • 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 ele 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:

• 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 Gestão de Pessoal com os dados do cadastro de estabilidade 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 Estabilidade

Cadastro

Esta integração contempla apenas a consulta e envio dos dados de Tipos de Estabilidade.

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 Estabilidade.

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;

Atenção

Importante: Devido à característica da rotina de Manutenção de Tabelas (GPEA320) em que a cada alteração os registros são regravados, o campo RCC_USERGA de todos os registros daquela filial serão renovado a cada manutenção efetuada.

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 estabilidade desejados.

• Preenchimento do EndPoint da API GPES053API;
• Utilizar a chamada do método Get e do Serviço stabilityTypes;
• 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â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/stabilityType/

Response da API:

Response StabilityTypes

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

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.

Relação de Treinamentos - classes - INTEGRAÇÃO TRMA050API 

Sistemas Envolvidos

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

• Protheus (módulo Treinamentos): Módulo responsável pela gestão dos cursos, treinamentos dentre outros cadastros pertinentes aos colaboradores.
• Quírons - NG

Integração

O objetivo desta integração é permitir que a área do RH ou área responsável pelos agendamentos de treinamento, envie os dados do cadastro de treinamento 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 inclui as informações de cadastros de treinamentos 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 Quírons é 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(RA2_USERGI) ou alteração (RA2_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 e 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 serão enviados novamente. Caso seja  solicitado uma atualização, somente os dados com data igual ou posterior a data informada, serão transmitidos;
  • 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 ele 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:

• 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 Gestão de Pessoal com os dados do cadastro de treinamentos 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 treinamentos.

Cadastro

Esta integração contempla apenas a consulta e envio dos dados de treinamentos.

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 treinamentos.

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 treinamentos desejados.

• Preenchimento do EndPoint da API TRMA050API;
• Utilizar a chamada do método Get e do Serviço classes;
• 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â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/v2/classes/

Response da API:

Response classes

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

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.

Controle de Adicionais - additional -  INTEGRAÇÃO GPEAADIAPI  

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.

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.

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

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.

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

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

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

Controle de Estabilidade - stabilityControl - INTEGRAÇÃO GPEA923API -

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:

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

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

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

{
    "code": 500,
    "detailedMessage": "Ocorreu uma falha no retorno da informação.",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": Descrição do erro.
}

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

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

{
    "code": 500,
    "detailedMessage": "Ocorreu uma falha no retorno da informação.",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": Descrição do erro.
}

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

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

{
    "code": 500,
    "detailedMessage": "Ocorreu uma falha no retorno da informação.",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": Descrição do erro.
}

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

Controle de Abonos - AllowanceControl - INTEGRAÇÃO PONA350API 

Sistemas Envolvidos

• Protheus (módulo de Ponto Eletrônico): Módulo responsável pela gestão da assiduidade e marcações/apontamentos de horários de trabalho do funcionário, 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 Abono de marcações de ponto 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 Abono.
  • 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 de Lançamentos de Pré-Abono do funcionário no módulo SIGAPON;

Fora do escopo

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

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 Ponto Eletrônico (SIGAPON) com suas entidades base, devidamente populadas por dados que no momento da integração serão utilizados na criação do registro de abono. (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 Ponto Eletrônico, no processo de cadastramento (inclusão/alteração/exclusão) de abonos de marcações de horário de ponto.

Cadastro

Esta integração contempla apenas o cadastramento(inclusão/alteração/exclusão) do Abono dentro do módulo SIGAPON.

Processos

O Sistema requisitante enviará as informações via json para a interface de integração, desta forma serão atualizados os dados de abono de marcações dentro do cadastro de pré abono 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 registro de Abono.

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

"companyId":"T1",
"branchId": "D MG 01 ",
"employeeId":"T1|D MG 01 |160001",
"code": "T1|D MG |114",
"startDate": "2020-06-02T10:10:10",
"endDate": "2020-06-10T10:10:10",
"startTime": "10:10",
"endTime": "19:10",
"id": "T1;D MG 01 ;T1|D MG 01 |160001;2020-06-03T13:00:00.000Z;10:10;T1|D MG|107"

{
    "code": 400,
    "detailedMessage": "Verifique o conteúdo da TAG (startDate) pois a data não está no formato 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": 500,
    "detailedMessage": "Ocorreu uma falha no retorno da informação.",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": Descrição do erro.
}

"companyId":"T1",
"branchId": "D MG 01 ",
"employeeId":"T1|D MG 01 |160001",
"code": "T1|D MG |114",
"startDate": "2020-06-02T10:10:10",
"endDate": "2020-06-10T10:10:10",
"startTime": "10:10",
"endTime": "19:10",
"id": "T1;D MG 01 ;T1|D MG 01 |160001;2020-06-03T13:00:00.000Z;10:10;T1|D MG|107"

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

{
    "code": 500,
    "detailedMessage": "Ocorreu uma falha no retorno da informação.",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": Descrição do erro.
}

"companyId":"T1",
"branchId": "D MG 01 ",
"employeeId":"T1|D MG 01 |160001",
"code": "T1|D MG |114",
"startDate": "2020-06-02T10:10:10",
"endDate": "2020-06-10T10:10:10",
"startTime": "10:10",
"endTime": "19:10",
"id": "T1;D MG 01 ;T1|D MG 01 |160001;2020-06-03T13:00:00.000Z;10:10;T1|D MG|107"

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

{
    "code": 500,
    "detailedMessage": "Ocorreu uma falha no retorno da informação.",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": Descrição do erro.
}

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

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

{
    "code": 500,
    "detailedMessage": "Ocorreu uma falha no retorno da informação.",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": Descrição do erro.
}

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.

Solicitação de Treinamento - trainingNecessity - INTEGRAÇÃO GPEA923API

Sistemas Envolvidos

• Protheus (módulo Treinamento): Módulo responsável pela gestão de cursos e treinamentos realizados pelos colaboradores.

• Quírons - NG

Integração

O objetivo desta integração é permitir que o RH ou área responsável pela Gestão de Treinamentos dos Colaboradores no Protheus, receba os dados do Controle de Solicitações de Treinamento 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 Solicitação de Treinamento.
  • 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 de solicitações de necessidade de treinamento do funcionário no módulo SIGATRM;

Fora do escopo

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

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 Treinamento (SIGATRM) com suas entidades base, devidamente populadas por dados que no momento da integração serão utilizados na criação do registro de solicitação de necessidade de treinamento. (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 Treinamento, no processo de cadastramento (inclusão/alteração/exclusão) de solicitação de Necessidade de Treinamento.

Cadastro

Esta integração contempla apenas o cadastramento(inclusão/alteração/exclusão) da solicitação de necessidade de treinamento dentro do módulo SIGATRM.

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 solicitações de necessidade de treinamentos 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, 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 solicitação de treinamento.

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

{
    "companyId": "T1",
    "branchId": "D MG 01 ",
    "trainingNecessityCode": "T1|D MG    |0001",
    "employeeId": "T1|D MG 01 |160001",
    "id": "T1;D MG 01 ;T1|D MG 01 |160001;T1|D MG    |0001"
}

{
    "code": 400,
    "detailedMessage": "Erro na validacao do recebimento da mensagem",
    "helpUrl": "https://tdn.totvs.com/x/BJuMHw",
    "message": "Verifique o conteudo da TAG (trainingNecessityCode) pois nao foi possivel encontrar esta informacao no Protheus.\r\n"
}

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

{
    "companyId": "T1",
    "branchId": "D MG 01 ",
    "trainingNecessityCode": "T1|D MG    |0001",
    "employeeId": "T1|D MG 01 |160001",
    "id": "T1;D MG 01 ;T1|D MG 01 |160001;T1|D MG    |0001"
}

{
    "code": 400,
    "detailedMessage": "Informação trainingNecessityId ausente ou inválida.",
    "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."
}

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

{
    "code": 400,
    "detailedMessage": "Informação trainingNecessityId ausente ou inválida.",
    "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."
}

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.