Páginas filhas
  • TOTVS Datasul X DIVICOM - Folha

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

INTEGRAÇÃO

GPEA011API

PayrollControl - Consulta de

Pagamentos de Plano Médico e Odontológico

lançamentos na Folha de Pagamento do Funcionário

Contexto de negócio (Introdução)

Cada vez mais o mercado exige que as operações complexas e manipulação de dados sejam ainda mais ágeis e com custos reduzidos. Com o RH não é diferente, os processos cada vez mais complexos e com muitas inovações e prestadores de serviços no ramo de benefícios para administrar dentro do RH, empresas e  softwares especialistas na administração de benefícios estão cada vez mais presentes no mercado e foi neste contexto que surgiu a necessidade da criação de uma interface para que possibilite automatizar o envio dos dados que hoje são realizados manualmente do ERP para o softwares especialista, seja feito através de uma interface de integração.


Sistemas Envolvidos

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

  • Protheus Datasul (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.
  • DIVICOM (Sistema Especialista): Empresa com ampla experiência em gestão de benefícios, sendo pioneira na Administração de benefícios e com atuação no mercado desde 1996 tendo atendido mais de 1.000.000 de clientes.(Dados extraídos do site do próprio parceiro,mais informações).

Integração

O objetivo desta integração é permitir que a área do RH ou área responsável pelos benefícios, envie os dados de funcionários para o sistema da DIVICOM e assim redução no 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 dos funcionários 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 Esta integração entre o Protheus TOTVS Datasul e o HUB (Sistema DIVICOM) é 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 TOTVS Datsul 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(RHS_USERLGI\RHR_USERLGI) ou alteração (RHS_USERLGARHS_USERLGI) inclusão ou alteração 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 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;

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

  • Consulta de pagamentos de planos lançamentos na folha de pagamento do funcionário, referente a Benefícios (Planos de assistência médica e odontológica;);


draw.io DiagrambordertrueviewerToolbartruefitWindowfalsediagramNameDIVICOM X Protheus - Folha de PagamentosimpleViewerfalsewidthdiagramWidth673revision1

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 TOTVS Datasul com sua arquitetura devidamente estruturada.
  • Módulo Gestão de Pessoal com o cadastro de Prestador de Serviço devidamente preenchido.
  • Módulo Gestão de Pessoal com o cadastro de Contratos Prestador de Serviço devidamente preenchido.
  • Módulo Gestão de Pessoal com o cadastro de Funcionários devidamente preenchido.
  • Módulo Gestão de Pessoal com o cadastro de Beneficiários (Dependentes) devidamente preenchido.
  • Módulo Gestão de Pessoal com o cadastro de Benefícios devidamente preenchido.
  • Módulo Gestão de Pessoal com os dados de Assistência Médica e Odontológica devidamente calculados.

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 MicroSiga Protheus, TOTVS Datasul onde será analisada pela equipe de suporte da TotvsTOTVS.

Fluxo das Informações

Esta integração traz a funcionalidade exclusivamente para Calculo de Plano de Saúde e Histórico de Calculo de Saúde

Cadastro

Esta integração contempla apenas a consulta e envio dos dados de Calculo de Plano de Saúde e Histórico de Calculo de Saúde.

Processos

A DIVICOM 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 Calculo de Plano de Saúde e Histórico de Calculo de Saúde para o requisitante.

Limitações / Restrições Gerais

  • A integração não contemplará inclusão,alteração e exclusão de registros no ProtheusTOTVS Datasul, 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 funcionários desejados.

  • Preenchimento do EndPoint da API GPEA011API ApiPayrollControl;
  • Utilizar a chamada do método Get e do Serviço employeedatacontent PayrollControl;
  • 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âmetro

Valor de Exemplo

Obrigatório

TipoParâmetro

Valor Default

Descrição
page1Sim

Integer

query
Página que está sendo requisitada.
pageSize1Não

Integer

query

100

Quantidade de funcionários por página.
product
PROTHEUS
DIVICOMSim

String

query
Valor FIXO
datemodified2001-01-01T18:25:43NãoStringquery
Data que será utilizada como filtro para trazer funcionários com data de alteração(RA_USERLGA)
branchId
D MG 01
180SimStringquery
Estabelecimento que será utilizada no filtro da consulta de Folha.
companyId
T1
10SimStringquery

authorization

não será informado pelos parâmetros REST

Empresa que será utilizada no filtro da consulta de Folha.

providerType

ASimString
headerConfiguração do parâmetro 

Security = 1 no arquivo appserver.ini

query

Tipo de Contrato que será utilizado no filtro da consulta - 1 (Assistência Médica), 2 (Assistência Odontológica) ou A (Ambos)

Image Removed

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 TOTVS Datasul a API Rest, a requisição deverá ser semelhante a imagem abaixo:

{protocolo}://{host}/{api}//rh/v1/payrollcontrol/

Exemplo: http://187.94.56.228:8080/api/rh/v1/PayrollControl?branchId=180&product=DIVICOM&companyId=10&page=1&providerType=A&datemodified=2017-01-01T01:01:00&pageSize=20

Response da API:


Bloco de código
languagecpp
themeConfluence
titleResponse PayrollControl
{
    "data": {
        "total": 1,
        "items": [
            {
                "originalRecordBranch": "1 - Titular180",
         "code       "CompanyKey": "00084010",
          "internalIdCode      "ProductCode": "T1|D MG 01 |000840",
"300",
                "MovimentDate": "2019-06-09T15:40:00.000",
                "contractCodeInternalIdCode": "",
                "companyKeyPaymentDate": "T1|D MG 01 ",
31/12/14",
                "Code": "6503",
                "paymentDateContractCode": "2018C-01-31T00:00:00UNI-123456",
                "payrollIdentifierProviderCode": "48011",
                "paymentAmountPaymentAmount": "50         5.00",
                "movimentDateId": "2018-10-17T00:00:00",
                "providerCodeProviderType": "0011-Assistência Médica",
                "paymentPeriodOriginalRecord": "201801",
      "branch": "D MG 01 ",
      "idPayrollIdentifier": "T1|D MG 01 |000840|201801|1|  10|180|6503|2014|12|1|2|001|2|01|4809|0",
                "providerTypePaymentPeriod": "2 - Ass. Odontologica"201710"
            }
        ],
        "productCodehasNext": "01"true
    }],
    "hasNextlength": falsenull,
    "totalmessages": 1[]
}


Dados utilizados da API

Por ser uma estrutura única para todos os produtos, há dados que existem em um produto (RM e/ou Protheus) e não existe no ProtheusTOTVS Datasul, desta forma cada produto utilizará os campos pertinentes aos seus ambientes.


CAMPOS
PROTHEUS
DATASULPROPRIEDADES API RESTDESCRIÇÃO
RA_FILIALbranchFilialRA_MATcodeMatriculaRHS_DATA \ RHS_DATAmovimentDateData do MovimentoEmpresa + "|" + RA_FILIAL + "|" + RA_MATinternalIdCodeChave Interna do FuncionárioRHS_ORIGEM / RHR_ORIGEMoriginalRecordRegistro de OrigemRHS_CODFOR \ RHR_CODFORproviderCodeCódigo do FornecedorRHS_TPFORN / RHR_TPFORNproviderTypeTipo de FornecedorTABELA S074contractCodeCódigo do contratoRHS_PLANO / RHR_PLANOproductCodeCódigo do PlanoRHS_PD / RHR_PDpayrollIdentifierCódigo da VerbaRHS_VLRFUN / RHR_COMPPGpaymentAmountValor PagoRHS_DATPGT / RHR_COMPPGpaymentDateData do PagamentoRHS_COMPPG / RHR_COMPPGpaymentPeriodPeríodo do PagamentoEMPRESA + "|"+ RA_FILIAL + "|" +RA_MAT + "|" + _COMPPG + "|" + _ORIGEM + "|" + _CODIGO + "|" +  TP_PLAN + "|" + _TPFORN + "|" + _CODFOR + "|" + _TPPLAN+ "|" +  _PLANO + "|"  + _PDidId interno do registro no protheus
OBS: Campos da propriedade ID, que possuem o caractere inicial como "_" representa campos de mesmo nome que fazem parte tanto da tabela RHR quanto RHS.
prestdor_contrat_benefic.cdn_estabBranchNo Datasul HCM esta informação é o código do Estabelecimento da tabela Funcionário (FP1500)
prestdor_contrat_benefic.cdn_empresaCompanyKeyInformação referente ao código da Empresa
VazioIdNão utilizado para a linha Datasul
prestdor_contrat_benefic.cdn_funcionariocodeCódigo do Funcionário cadastrado no programa FP1500
VaziointernalIdCodeNão utilizado para a linha Datasul
prestdor_contrat_benefic.dat_ult_atualizmovimentDateData referente a data da última alteração do benefício no funcionário
VaziooriginalRecordNão utilizado para a linha Datasul
prestdor_contrat_benefic.cdn_prestdor_servproviderCodeCódigo do Prestador de Serviço do evento da Folha de Pagamento do Funcionário
prestdor_contrat_benefic.idi_contrat_prestdor - Descrição do idi_contrat_prestdorproviderTypeJunção do código + descrição do Tipo de Contrato
prestdor_contrat_benefic.cod_contrat_prestdorcontractCodeCódigo do Contrato referente ao Prestador do Benefício
predtdor_contrat_benefic.cod_beneficioproductCodeCódigo do Benefício relacionado ao Funcionário
movto_calcul_func.cdn_empresa | movto_calcul_func.cdn_estab | movto_calcul_func.cdn_funcionario | movto_calcul_func.num_ano_refer_fp | movto_calcul_func.num_mes_refer_fp | movto_calcul_func.idi_tip_fp | movto_calcul_func.qti_parc_habilit_calc_fp | movto_calcul_func.num_seq_movto_calcul_fppayrollIdentifierChave única que identifica o Movimento da Folha calculada para o Funcionário
movto_calcul_func.val_calcul_efppaymentAmountValor pago pelo Funcionário
movto_calcul_func.dat_pagto_salariopaymentDateData do pagamento que o Funcionário realizou
movto_calcul_func.num_ano_refer_fp + movto_calcul_func.num_mes_refer_fppaymentPeriodPeríodo referente ao movimento de pagamento do funcionário

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 ProtheusTOTVS Datasul:

Mensagens de Pré-Validação

Erro

Mensagem

Solução

400

Campo RHS_USERLGA / RHR_USERLGA não foi encontrado.

Bloco de código
languagecpp
themeConfluence
titleCampos _USERLGA/_USERLGI
{
   "code": 400,
   "detailedMessage": "Falha ao validar as informações básicas da assinatura. Informação: product",
   "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
   "message": "Campo RHS_USERLGA não foi encontrado."
}
400

O Produto é um parâmetro obrigatório.

Bloco de código
languagecpp
themeConfluence
titleQuando o campo produto está em branco
{
   "code": 400,
   "detailedMessage": "Falha ao validar as informações básicas da assinatura. Informação: product",
   "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
   "message": "Falha ao validar as informações básicas da assinatura. Informação: product"
}
400

A Filial é um parâmetro obrigatório.

Bloco de código
languagecpp
themeConfluence
titleQuando o campo branchId está em branco.
{
   "code": 400,
   "detailedMessage": "Falha ao validar as informações básicas da assinatura. Informação: branchId",
   "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
   "message": "Falha ao validar as informações básicas da assinatura. Informação: branchId"
}
400O Grupo de Empresa é um parâmetro obrigatório  Bloco de código
languagecpp
themeConfluence
titleErro quando campo companyId está vazio.
{ "code": 400, "detailedMessage": "Falha ao validar as informações básicas da assinatura. Informação: companyId", "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ", "message": "Falha ao validar as informações básicas da assinatura. Informação: companyId" }
API RESPONSE

17006

Parâmetro 'product' incorreto.

Informar DIVICOM de forma fixa no parâmetro 'product'.

Image Added

17006

O parâmetro 'companyId' incorreto.

Preencher o parâmetro 'companyId'.

Image Added

17006

O parâmetro 'branchId' incorreto.

Preencher o parâmetro 'branchId'.

Image Added

17006Empresa/Estabelecimento inválidos!Informar valores válidos no TOTVS Datasul para os parâmetros companyId e branchID 

Image Added

17006O parâmetro 'providerType' incorreto.

Informar o Tipo de Contrato com um valor correto, conforme abaixo:

1 (Assistência Médica), 2 (Assistência Odontológica) ou A (Ambos)

Image Added

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