INTEGRAÇÃO BeneficiariesCoparticipation - Serviço genérico para retorno das informações de

Coparticipação dos beneficiá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  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 possibilitar a automatização e 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 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 a área responsável pelos benefícios, envie os dados de coparticipações para o sistema da DIVICOM 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, inclui as informações das coparticipaçõ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 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 será responsável pela requisição e transformação da informação recebida;
  • Na requisição, o parceiro deverá informar através do preenchimento do parâmetro datemodified se deseja uma carga completa (deixar o parâmetro vazio) ou somente os dados que pertencem ao período informado(preenchendo a data). Caso seja solicitada a carga, todos os dados deverão ser enviados novamente. Caso a data seja informada, somente os dados com data de pagamento pertinente a data informada, serão transmitidos;
  • O filtro de data (datemodified) será informada a cada requisição, 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;
  • Para evitar duplicidades, quando dois registros forem repetidos o sistema irá considerar apenas o retorno de um deles, de acordo com a chave de identificação da tabela(retorno da propriedade id).

Escopo

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

• Consulta de coparticipações dos planos de saúde (médico e odontológico), para titular e dependente;

Fora do escopo

• Automatização de Cadastramento de Coparticipações.
• O serviço de disponibilização de dados de coparticipações apenas retorna os dados solicitados, não cabendo à API tratar a informação depois de ser entregue ao solicitante;

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.

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 seu o cadastro de Prestador de coparticipações Serviço devidamente preenchido.

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, onde será analisada pela equipe de suporte da Totvs.

Fluxo das Informações

Esta integração traz a funcionalidade exclusivamente de cadastro de coparticipação

Cadastro

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

Processos

A DIVICOM realizará o consumo da API com dados básicos que serão utilizados como parâmetros para consultar a base de coparticipações e retornar um conjunto de informações pertinentes ao Cadastro de Coparticipação 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 Protheus, para isso o usuário deverá acessar o ERP e efetuar as devidas ações manualmente.

• 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 o programa de importação de Coparticipações (BS0470) executado com as informações provenientes da administradora do Plano.

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

Fluxo das Informações

Esta integração traz a funcionalidade exclusivamente de cadastro de coparticipação

Cadastro

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

Processos

A DIVICOM realizará o consumo da API com dados básicos que serão utilizados como parâmetros para consultar a base de coparticipações e retornar um conjunto de informações pertinentes ao Cadastro de Coparticipação 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 TOTVS Datasul, para isso o usuário deverá acessar o ERP e efetuar as devidas ações manualmente.

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

• Preenchimento do EndPoint da API ApiBeneficiariesCoparticipation;
• Utilizar a chamada do método Get e do Serviço BeneficiariesCoparticipation;
• Preenchimento dos parâmetros obrigatórios da API;

Formatos de Data

As

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

• Preenchimento do EndPoint da API GPEA003API;
• Utilizar a chamada do método Get e do Serviço BeneficiariesCoparticipation;
• 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:ss

Parâmetros de Entrada:

A autenticação será do tipo Basic Authorization e será obrigatório (configuração do parâmetro Security = 1 no arquivo appserver.ini)Basic Authorization e será obrigatório a utilização de um usuário e senha válido no TOTVS Datasul.

Parâmetros e Chamada do Método:

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

{protocolo}://{host:porta}/{rest}/{api}/rh/v1/BeneficiariesCoparticipation/

Exemplo: http://localhost:8034/rest187.94.56.228:8080/api/rh/v1/BeneficiariesCoparticipation?companyId=10&branchId=180&product=DIVICOM

Response da API:

{
    "itemsdata": [{
        {
    "total": 1,
        "EmployeeCodeitems": "000006",[
            "DependentCode": "00",
{
                "SpecialtyNameMedicalAssistanceCard": "81",
                "companyKeyMaritalState": "T1|D MG 01 ",
"C",
                "ServiceProviderNameIdentityNumberEmitterAgency": "S016 ISSP",
                "ServiceProviderIdDentalAssistanceCardCode": "46942851000154",
                "CoparticipationValueBenefitsVendorCode": "99.0011",
                "EmployeeNamebeneficiaryWeight": "84"FUNCIONARIO,
 TESTE API COPART. ",
            "DependentNameidentityNumber": "253428221"FUNCIONARIO,
 TESTE API COPART. ",
            "branchcode": "D6503",
  MG 01 ",
            "DegreeEmployeeDependencyMotherName": ""TERESA ROSELI BELARMINO MARIANNO",
                "OccurrencyDatebeginDate": "20152013-1110-17T0001T00:00:00",
                "CoparticipationDescriptionContractNumberCode": "C-UNI-123456",
                "ServiceProviderContractTypeEmployeeCode": "16503",
                "InternationalCodeDiseasesBenefitCPF": "Z88.115538279880",
                "AmountUseid": "110|180|6503",
            "YearMonthReference    "DegreeOfRelatedness": "201901T",
                "ServiceTypeName": "3NERO PINHEIRO",
                "ServiceProviderContractBirth": "1975-04-03T00:00:00.000",
                "ServiceProviderSUSCardCode": "001898000496776012",
                "idRegistryType": "T1|D MG 01 |000006|2015-11-17T00:00:00|1|001|1|  |410|201901"
"0",
                 }"companyKey": "10",
        {
            "EmployeeCodeGender": "000006M",
                "DependentCodeBornAlive": "011",
                "SpecialtyNamebranch": "19180",
                "companyKeyFinalDate": "T1|D MG 01 ",
"9999-12-01T00:00:00",
                "ServiceProviderNameBenefitVendorSegmentCode": "S016 I1",
                "ServiceProviderIdbeneficiaryTall": "469428510001541,78",
                "CoparticipationValueBenefitCode": "9999.00300",
            "EmployeeName": "FUNCIONARIO TESTE API COPART. ",
}
         ],
        "DependentNamehasNext": "DEPENDENTE 001",true
            "branch": "D MG 01 ",
        },
    "DegreeEmployeeDependencylength": "F"null,
            "OccurrencyDate"messages": "2015-11-17T00:00:00",
            "CoparticipationDescription": "",
            "ServiceProviderContractType": "1",
            "InternationalCodeDiseases": "Z88.1",
            "AmountUse": "1",
            "YearMonthReference": "201901",
            "ServiceType": "10",
            "ServiceProviderContract": "",
            "ServiceProvider": "001",
            "id": "T1|D MG 01 |000006|2015-11-17T00:00:00|1|001|2|01|504|201901"
        }
    ],
    "hasNext": true,
    "total": 4
}

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

Agrupamento de Empresa, Unidade de negócio e Filial.

Filial referente a coparticipação lançada.

Chave única que identifica os registros dos lançamentos de coparticipações. Se for período aberto usa o índice 4(RHOT10_UNQ) da tabela RHO e se for período fechado usa o índice 3(RHPT10_UNQ) da tabela RHP.

EmployeeCode

Matrícula do Funcionário.

EmployeeName

Nome do Funcionário.

DependentCode

 Código identificador do Dependente.

DependentName

Nome do Beneficiário.

DegreeEmployeeDependency

Grau de dependência do Funcionário

OccurrencyDate

Data de ocorrência do lançamento da coparticipação para o beneficiário.

ServiceProvider

Identificador do Prestador de Serviço.

ServiceProviderContractType

Tipo de Contrato do Prestador de Serviço indicado no lançamento da Coparticipação do Beneficiário: 1 - Assistência Médica | 2 - Assistência Odontológica | 3 - VR | 4 - VA | 5 - VT | 9 - Outros

Se período aberto usa o campo RHO_VLRFUN  e se fechado usa o campo RHP_VLRFUN.

CoparticipationValue

Valor referente ao lançamento da coparticipação do beneficiário.

YearMonthReference

Ano e mês de referência do pagamento do lançamento da coparticipação do beneficiário.

Se período aberto usa o campo RHO_CID  e se fechado usa o campo RHP_CID.

SpecialtyName

Código internacional de Doenças lançado na coparticipação do beneficiário

InternationalCodeDiseases

Nome da especialidade do Prestador de Serviço referente ao lançamento da coparticipação do beneficiário.

ServiceType

Tipo de Atendimento informado pelo Prestador de Serviço no lançamento da Coparticipação do Beneficiário: 1 - Eletivo | 2 - PS | 3 - Exame | 4 - PAC | 5 - Material/Medicamento | 6 - Internação | 7 - Terapia | 8 - Taxa/Diária| 9 - Case | 10 - Reembolso | 11 - Remoção | 12 - Não Informado | 13 - Ambulatório

CoparticipationDescription

Descrição da Coparticipação referente ao lançamento no histórico do beneficiário.

AmountUse

Quantidade de utilização de coparticipação por parte do beneficiário e seus dependentes.

ServiceProviderContract

Número do Contrato do Prestador de Serviço indicado no lançamento da Coparticipação do Beneficiário

ServiceProviderId

CNPJ do Prestador de Serviço referente ao lançamento da coparticipação do beneficiário

ServiceProviderName

Nome do Prestador de Serviço referente ao lançamento da coparticipação 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 RHO_CDESPE, RHO_CID, RHO_TPATEN, RHP_CDESPE, RHP_CID e HP_TPATEN são obrigatórios.

Habilitar os campos RHO_CDESPE, RHO_CID, RHO_TPATEN, RHP_CDESPE, RHP_CID e HP_TPATEN.

{
   "code": 400,
   "detailedMessage": "",
   "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
   "message": "Os campos RHO_CDESPE, RHO_CID, RHO_TPATEN, RHP_CDESPE, RHP_CID e HP_TPATEN são obrigatórios."
}

O Produto é um parâmetro obrigatório.

{
   "code": 400,
   "detailedMessage": "",
   "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
   "message": "O parâmetro product é obrigatório."
}

A Filial é um parâmetro obrigatório.

{
   "code": 400,
   "detailedMessage": "",
   "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
   "message": "O parâmetro branchId é obrigatório."
}

Mensagens de Pós-Validação

Erro

Mensagem

Solução

Nenhum registro localizado.

{
   "code": 400,
   "detailedMessage": "",
   "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
   "message": "Nenhum registro localizado."
}

Tratamento de Erros Inesperados(TRY/CATCH):

[]
}

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 TOTVS Datasul, desta forma cada produto utilizará os campos pertinentes aos seus ambientes.

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	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
17006	Empresa/Estabelecimento inválidos!	Informar valores válidos no TOTVS Datasul para os parâmetros companyId e branchID	Image Added

Mensagens de Pós-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.

Anexos