Histórico da Página
INTEGRAÇÃO
GPEA001APIBeneficiariesDataContent -
ServiçoServiço genérico para retorno das informações de
Plano de Saúde do Microsiga ProtheusBeneficiários do TOTVS Datasul
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 que torne possível 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
- Protheus Datasul (módulo Gestão de Pessoal): Módulo responsável pela gestão dos dados dos funcionários, folha de pagamento, benefícios, 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 cadastros, enviem seus dados para o sistema da DIVICOM e assim reduz 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, inclui as informações dos beneficiários 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 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 Datasul 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 deve ter habilitado um LOG de alteração(RHK_USERGA e RHL_USERGA) de alteração de registros a fim de controlar os dados a serem integrados;
- Na requisição, o parceiro deve informar a data referente às alterações dos dados que deseja obter, através do preenchimento do parâmetro datemodified e, se desejar uma carga completa, deve deixar o parâmetro sem preenchimento. Caso seja solicitada a carga, todos os dados do cadastro serão 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 (quantidade de registros) e qual página ela solicita;
- Cabe a integração informar se existem mais páginas a serem solicitadas.
Escopo
Por intermédio desta integração estará disponível a seguinte funcionalidade:
- Consulta de Beneficiários de do Funcionário (para Plano de Saúde e Plano Odontológico);
Pré-requisitos instalação/implantação/utilização
- Versões mínima do Protheusdo TOTVS Datasul: 12.1.25;
- Possuir acesso à Internet, caso o sistema que venha a utilizar a integração com a aplicação Protheus TOTVS Datasul que faça uso da mesma;
- Estrutura de rede estável, para que haja tráfego de dados sem interrupção;
- Protheus TOTVS Datasul devidamente configurado e serviço Rest habilitado em seu server.
- Campos RHK_USERGA e RHL_USERGA devem estar habilitados.
Fora do escopo
Fora do escopo
- Automatização de Cadastramento de Beneficiários;
- O serviço de disponibilização de dados de Beneficiários apenas retorna os dados solicitados, não cabendo à API tratar a informação depois de ser entregue ao solicitante.
- Dependentes que não fazem uso do benefício de Plano de Saúde e Plano Odontológico não serão transmitidos.
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 TOTVS Datasul no formato apresentado na seguinte documentação (Exemplo de Configuração de Webservice Datasul REST)
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 Dependentes Serviço devidamente preenchido.
- Módulo Gestão de Pessoal com o cadastro de Planos Contratos Prestador de Saúde Ativos 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.
Controle de Versão
O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução
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 ProtheusDatasul, onde será analisada pela equipe de suporte da TotvsTOTVS.
Fluxo das Informações
Esta integração traz a funcionalidade exclusivamente de cadastro de Beneficiários de Plano de Saúde e Plano Odontológico.
Cadastro
Esta integração contempla apenas a consulta e envio dos dados de cadastro de Beneficiários de Plano de Saúde e Plano Odontológico.
Processos
A DIVICOM realizará o consumo da API com dados básicos que serão utilizados como parâmetros para consultar a base de beneficiários e retornar um conjunto de informações pertinentes ao Cadastro de Dependentes (GPEA020FP1760) e Cadastro de Planos de Saúde Ativos (GPEA001Benefícios (BS0080) e retornar os dados 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 beneficiários desejados;
- Preenchimento do EndPoint da API GPEA001APIBeneficiariesDataContent;
- Utilizar a chamada do método Get e do Serviço BeneficiariesDataContent;
- 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 | Tipo | Parâmetro | Valor Default | Descrição |
page | 1 | Sim | Integer | query | 1 | Página que está sendo requisitada para o retorno. |
pageSize | 1 | Não | Integer | query | 200020 | Quantidade de beneficiários de Beneficiários que será retornado por página. |
product | PROTHEUSDIVICOM | Sim | String | query | Parâmetro de entrada para processamento das informações (Fixo DIVICOM). | |
datemodified | 2019-01-01T00:00:00 | Não | String | query | Data que será utilizada como filtro para trazer beneficiários Beneficiários com data de alteração (RHK_USERGA e RHL_USERGA) alteração maior ou igual ao informado. | |
branchId | D MG 01180 | Sim | String | query | Filial que será utilizada no filtro da consulta de Beneficiários. | |
companyId | T110 | Sim | String | query | Empresa que será utilizada no filtro da consulta de Beneficiários. |
A autenticação será do tipo Basic Authorization e será obrigatório (configuração do parâmetro Security = 1 no arquivo appserver.ini).
Página do Serviço REST:
a utilização de um usuário e senha válido no TOTVS Datasul.
Parâmetros e Chamada do Método:
Para a realização de testes, foi utilizado a ferramenta POSTMAN e após a configuração do server Protheus e da API Rest, a requisição deverá ser semelhante a imagem abaixo:
Estrutura: {protocolo}://{host:porta}/{rest}/{api}/rh/v1/BeneficiariesDataContent/
Exemplo: http://localhost:8034/rest187.94.56.228:8080/api/rh/v1/BeneficiariesDataContent/?companyId=10&branchId=180&product=DIVICOM
Retorno da API:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "itemsdata": [{ { "total": 1, "identityNumberitems": "", [ { "MaritalState": "", "BenefitCPFMedicalAssistanceCard": "10084068809", "companyKeyMaritalState": "T1|D MG 01 ", "C", "IdentityNumberEmitterAgency": "SSP", "ContractNumberCodeDentalAssistanceCardCode": "", "BenefitVendorSegmentCodeBenefitsVendorCode": "111", "branchbeneficiaryWeight": "84"D, MG 01 ", "BenefitCodeidentityNumber": "01253428221", "BeneficiaryTallcode": "6503", "beginDate "MotherName": "012015TERESA ROSELI BELARMINO MARIANNO", "BenefitVendorInternalIdbeginDate": "2013-10-01T00:00:00", "codeContractNumberCode": "01C-UNI-123456", "FinalDateEmployeeCode": "6503" , ", "BirthBenefitCPF": "2000-01-01T00:00:00", "15538279880", "MotherNameid": "10|180|6503", "BornAliveDegreeOfRelatedness": "1T", "DentalAssistanceCardCodeName": "NERO PINHEIRO", "Birth": "1975-04-03T00:00:00.000", "EmployeeInternalIdSUSCardCode": "898000496776012", "BenefitsVendorCode "RegistryType": "0010", "NamecompanyKey": "10"DEPENDENTE, 001 "Gender": "M", "SUSCardCodeBornAlive": "1267778459364 1", "Genderbranch": "M180", "DegreeOfRelatednessFinalDate": "F9999-12-01T00:00:00", "EmployeeCodeBenefitVendorSegmentCode": "0000061", "RegistryTypebeneficiaryTall": "1,78", "MedicalAssistanceCardBenefitCode": "300"96845712333 ", } "BeneficiaryWeight": ""], "BenefitInternalIdhasNext": "",true }, "ContractNumberInternalIdlength": ""null, "FoodCardsCode": "", "id": "D MG 01 |000006|01|1|001|1|01", "MealCardsCode": "" } ], "hasNext": true, "total": 10 } |
Dados utilizados da API
Por ser uma estrutura única para todos os produtos, há dados que existem em um produto (RM) e não existe no Protheus, desta forma cada produto utilizará os campos pertinentes aos seus ambientes.
CAMPOS PROTHEUS
PROPRIEDADES API REST
DESCRIÇÃO
Código do Beneficiário
Chave única do Beneficiário, concatenação dos campos de chave única existente na tabela RHK, índice 3(RHK_UNQ), caso seja um titular ou RHL, índice 4(RHL_UNQ), caso seja um Dependente.
BenefitsVendorCode
Identificador do Fornecedor de Benefícios
BenefitVendorInternalId
Identificador Interno do Fornecedor de Benefícios
BenefitVendorSegmentCode
Código do tipo de segmento do fornecedor do Benefício: 1 - Assistência Médica | 2 - Assistência Odontológica
BenefitCode
Código do Benefício
BenefitInternalId
Identificador Interno do Benefício
beginDate
Início da vigência do Benefício ao beneficiário
FinalDate
Fim da vigência do Benefício ao beneficiário
ContractNumberCode
Código do Contrato do Plano de Saúde
ContractNumberInternalId
Identificador interno do Contrato
EmployeeCode
Identificador do Funcionário
EmployeeInternalId
Identificador interno do Funcionário
RegistryType
Tipo do Registro do Beneficiário
DegreeOfRelatedness
Grau de parentesco do dependente com o Titular: T - Titular, C - Casado, D - desquitado, E - União Estável, I - Divorciado, O - Outros, P - Separado, S - Solteiro, V - Viúvo
Name
Nome do Beneficiário
BenefitCPF
CPF do Beneficiário
MotherName
Nome da Mãe do beneficiário titular
Gender
Sexo do beneficiário: M - Masculino, F - Feminino
MaritalState
Estado Civil C - Casado | D - Desquitado | E - União Estável | I - Divorciado | O - Outros | P - Separado | S - Solteiro | V - Viúvo
Birth
Data de aniversário do beneficiário
identityNumber
Identidade da pessoa (RG)
IdentityNumberEmitterAgency
Órgão emissor da identidade da pessoa (RG)
MedicalAssistanceCard
Número do Cartão de Assistência Médica
DentalAssistanceCardCode
Número do Cartão de Assistência Odontológica
FoodCardsCode
Número do Cartão para Alimentação
MealCardsCode
Número do Cartão para Refeição
SUSCardCode
Número do Cartão do SUS
BornAlive
Flag que determina se o beneficiário foi nascido vivo: 1 - Nascido Vivo , 0 - Não Nascido Vivo
BeneficiaryWeight
Peso em (gr) do Beneficiário
BeneficiaryTall
Altura em (cm) do beneficiá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 Protheus:
Mensagens de Pré-Validação
Erro
Mensagem
Solução
400
"Os campos RHK_USERGA, RHL_USERGA, RHK_MATSAU, RHK_MATODO, RHK_CNS, RHL_MATSAU, RHL_MATODO e RHL_CNS são obrigatórios e não foram encontrados.
Habilitar pelo configurador os campos citados na mensagem de Erro.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"code": 400,
"detailedMessage": "",
"helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
"message": "Os campos RHK_USERGA, RHL_USERGA, RHK_MATSAU, RHK_MATODO, RHK_CNS, RHL_MATSAU, RHL_MATODO e RHL_CNS são obrigatórios e não foram encontrados."
} |
O parâmetro product é obrigatório.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"code": 400,
"detailedMessage": "",
"helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
"message": "O parâmetro product é obrigatório."
} |
O parâmetro branchId é obrigatório
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"code": 400,
"detailedMessage": "",
"helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
"message": "O parâmetro branchId é obrigatório."
} |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"code": 400,
"detailedMessage": "",
"helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
"message": "O parâmetro companyId é obrigatório."
} |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"code": 400,
"detailedMessage": "",
"helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
"message": "Se preenchido, o parâmetro datemodified deve estar no formato: '2019-05-01T18:25:43'."
} |
Filial não encontrada para os valores informados de empresa e Filial: XX X XX XX
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"code": 400,
"detailedMessage": "",
"helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
"message": "Filial não encontrada para os valores informados de empresa e Filial: X1 D MG 01"
} |
Mensagens de Pós-Validação
Erro
Mensagem
Solução
Nenhum registro localizado.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"code": 400,
"detailedMessage": "",
"helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
"message": "Nenhum registro localizado."
} |
Tratamento de Erros Inesperados(TRY/CATCH):
language | js |
---|---|
theme | Confluence |
title | companyId |
"messages": []
} |
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 Datasul, desta forma cada produto utilizará os campos pertinentes aos seus ambientes.
CAMPOS DATASUL | PROPRIEDADES API REST | DESCRIÇÃO |
---|---|---|
prestdor_contrat_benefic.cdn_empresa | companyKey | Informação referente a Empresa do funcionário/beneficiário no Produto TOTVS Datasul |
prestdor_contrat_benefic.cdn_estab | branch | Informação referente ao Estabelecimento do funcionário/beneficiário no Produto TOTVS Datasul |
prestdor_contrat_benefic.cdn_funcionario | code | Informação referente a Matrícula do Funcionário no Produto TOTVS Datasul |
Chave única do Beneficiário, concatenação dos campos de chave única existente na tabela "prestdor_contrat_benefic" (prestdor_contrat_benefic.cdn_empresa | prestdor_contrat_benefic.cdn_estab | prestdor_contrat_benefic.cdn_funcionario) | id | Concatenação entre o Código da Empresa + Código do Estabelecimento + Código do Funcionário, separando as informações por | (pipe) |
prestdor_contrat_benefic.cdn_prestdor_serv | BenefitsVendorCode | Informação referente ao Código do Prestador de Serviço do benefício do Funcionário no Produto TOTVS Datasul |
Vazio | BenefitVendorInternalId | Identificador Interno do Fornecedor de Benefícios |
prestdor_contrat_benefic.idi_contrat_prestdor | BenefitVendorSegmentCode | Código do tipo de segmento do fornecedor do Benefício: 1 - Assistência Médica | 2 - Assistência Odontológica |
prestdor_contrat_benefic.cdn_beneficio | BenefitCode | Código do Benefício informado no TOTVS Datasul |
Vazio | BenefitInternalId | Identificador Interno do Benefício |
prestdor_contrat_benefic.num_ano_mes_inic_valid | beginDate | Data de início do benefício ao Funcionário, no formato DataTime |
prestdor_contrat_benefic.num_ano_mes_term_valid | FinalDate | Data de fim do benefício ao Funcionário, no formato DataTime |
prestdor_contrat_benefic.cod_contrat_prestdor | ContractNumberCode | Código do Contrato referente ao benefício relacionado ao Funcionário |
Vazio | ContractNumberInternalId | Identificador interno do Contrato |
prestdor_contrat_benefic.cdn_funcionario | EmployeeCode | Código do Funcionário relacionado ao benefício |
Vazio | EmployeeInternalId | Identificador interno do Funcionário |
prestdor_contrat_benefic.cdn_depend_func | RegistryType | Código do Dependente dentro do Datasul HCM. Quando for o títular (funcionário), o código será 0 (zero) |
depend_func.idi_grau_depen_func | DegreeOfRelatedness | Grau de parentesco do dependente com o Titular: T - Titular, C - Casado, D - desquitado, E - União Estável, I - Divorciado, O - Outros, P - Separado, S - Solteiro, V - Viúvo |
depend_func.nom_depend_func ou rh_pessoa_fisic.nom_pessoa_fisic | Name | Nome do Dependente do Funcionário no FP1760. Se for o títular (funcionário) será buscado o nome da Pessoa Física no FP1440 |
SUBSTRING(depend_func.cod_livre_1,01,20) ou rh_pessoa_fisic.cod_id_feder | BenefitCPF | CPF do Dependente no FP1760. Se for o títular (funcionário) será buscado o CPF da Pessoa Física no FP1440 |
SUBSTRING(depend_func.cod_livre_2,01,100) ou rh_pessoa_fisic.nom_mae_pessoa_fisic | MotherName | Nome da mãe do Dependente no FP1760. Se for o títular (funcionário) será buscado o Nome da Mãe da Pessoa Física no FP1440 |
depend_func.idi_sexo ou rh_pessoa_fisic.idi_sexo | Gender | Gênero (sexo) do Dependente no FP1760. Se for o títular (funcionário) será buscado o Sexo da Pessoa Física no FP1440 |
depend_func.num_livre_2 ou rh_pessoa_fisic.idi_estado_civil | MaritalState | Estado Civil do Dependente no FP1760. Se for o títular (funcionário) será buscado o Estado Civil da Pessoa Física no FP1440 |
depend_func.dat_nascimento ou rh_pessoa_fisic.dat_nascimento | Birth | Data de Nascimento do Dependente do Funcionário no FP1760. Se for o títular (funcionário) será buscado o Data de Nascimento da Pessoa Física no FP1440 |
rh_pessoa_fisic.cod_id_estad_fisic | identityNumber | Carteira de Identidade no FP1440, quando títular (funcionário) |
rh_pessoa_fisic.cod_orgao_emis_id_estad | IdentityNumberEmitterAgency | Orgão Emissor no FP1440, quando títular (funcionário) |
benefic_func.cod_cart_plano_saude | MedicalAssistanceCard | Número da Carteira de Saúde do Dependente no FP0520 |
benefic_func.cod_cart_plano_odonto | DentalAssistanceCardCode | Número do Cartão de Assistência Odontológica no FP0520 |
Vazio | FoodCardsCode | Número do Cartão para Alimentação |
Vazio | MealCardsCode | Número do Cartão para Refeição |
compl_pessoa_fisic.cod_cartao_nac_saude | SUSCardCode | Número do Cartão SUS do títular (funcionário) |
Valor Default "1" | BornAlive | Para o Datasul será um valor fixo (1), pois não se cadastra um dependente quando ele não Nasce Vivo |
rh_pessoa_fisic.vli_peso_pessoa / 100 | BeneficiaryWeight | Peso no FP1440 |
rh_pessoa_fisic.val_estatur_pessoa | BeneficiaryTall | Estatura no FP1440 |
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 Datasul:
Mensagens de Pré-Validação
Erro | Mensagem | Solução | API RESPONSE |
17006 | Parâmetro 'product' incorreto. | Informar DIVICOM de forma fixa no parâmetro 'product'. | |
17006 | O parâmetro companyId incorreto. | Preencher o parâmetro companyId. | |
17006 | O parâmetro branchId incorreto. | Preencher o parâmetro branchId. | |
17006 | Empresa/Estabelecimento inválidos! | Informar valores válidos no TOTVS Datasul para os parâmetros companyId e branchID |
Mensagens de Pós-Validação
Erro | Mensagem | Solução | API RESPONSE |
17006 | Nenhum registro localizado. | Favor informar corretamente os parâmetros para que os dados do TOTVS Datasul sejam corretamente retornados. |
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.