INTEGRAÇÃO BeneficiariesDataContent - Serviço genérico para retorno das informações de 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  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

Dados

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 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 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)
  • Esta integração entre o 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 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 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.

Pré-requisitos instalação/implantação/utilização

• Versões mínima do TOTVS Datasul: 12.1.25;
• Possuir acesso à Internet, caso o sistema que venha a utilizar a integração com a aplicação TOTVS Datasul que faça uso da mesma;
• Estrutura de rede estável, para que haja tráfego de dados sem interrupção;
• TOTVS Datasul devidamente configurado e serviço Rest habilitado em seu server.

Para habilitar a integração, você deverá proceder da seguinte forma:

• BS0080 - Acessar o benefício que deseja integrar, caso ele ainda não exista, realizar o cadastro e selecionar uma das opções encontradas no campo “Tipo Contrato DIVICOM” – Assistência Médica ou Assistência Odontológica;
• BS0500 - Vincular o benefício ao estabelecimento que de acordo com a característica do mesmo, serão habilitadas pastas diferentes para receber informações;
• BS0520 – Vincular o benefício ao funcionário desejado, utilizando o botão “Formar”;
• BS0450 – Cadastrar o contrato de serviço e relacionar ao Prestador, bem como o Tipo de Plano (Assistência Médica ou Assistência Odontológica);
• BS0460 – Relacionar os benefícios com o contrato do prestador de serviço.

Image Removed

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

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

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

Folha de Pagamento

É necessário que o FP3020 esteja calculado.

Image Removed

Coparticipação

É necessária a utilização do programa BS0470 para que através de um arquivo, realize a importação das informações necessárias.

Image Removed

Beneficiários

É necessária a utilização dos seguintes programas: 

BS0460 – Relacionar os benefícios com o contrato do prestador de serviço;

BS0520 - Manutenção Benefícios do Funcionário.

Image Removed

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

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 (FP1760) e Cadastro de Benefícios (BS0080) e retornar os dados para o requisitante.

Para que a Divicom possa ter acesso a dados referentes a Folha de Pagamento, Coparticipação, Funcionários e Beneficiários, você deverá considerar os pré-requisitos descritos abaixo:

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

TipoParâmetro

Valor Default

Integer

Integer

20

String

A autenticação será do tipo 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:

Para a realização de testes, foi utilizado a ferramenta POSTMAN e após a configuração do server TOTVS Datasul e da API Rest, a  requisição deverá ser semelhante a imagem abaixo:

Estrutura: {protocolo}://{host:porta}/{rest}/api/rh/v1/BeneficiariesDataContent/

Exemplo: http://187.94.56.228:8080/api/rh/v1/BeneficiariesDataContent?companyId=10&branchId=180&product=DIVICOM

Retorno da API:

{
    "data": {
        "total": 1,
        "items": [
            {
                "MedicalAssistanceCard": "",
                "MaritalState": "C",
                "IdentityNumberEmitterAgency": "SSP",
                "DentalAssistanceCardCode": "",
                "BenefitsVendorCode": "11",
                "beneficiaryWeight": "84",
                "identityNumber": "253428221",
                "code": "6503",
                "MotherName": "TERESA ROSELI BELARMINO MARIANNO",
                "beginDate": "2013-10-01T00:00:00",
                "ContractNumberCode": "C-UNI-123456",
                "EmployeeCode": "6503",
                "BenefitCPF": "15538279880",
                "id": "10|180|6503",
                "DegreeOfRelatedness": "T",
                "Name": "NERO PINHEIRO",
                "Birth": "1975-04-03T00:00:00.000",
                "SUSCardCode": "898000496776012",
                "RegistryType": "0",
                "companyKey": "10",
                "Gender": "M",
                "BornAlive": "1",
                "branch": "180",
                "FinalDate": "9999-12-01T00:00:00",
                "BenefitVendorSegmentCode": "1",
                "beneficiaryTall": "1,78",
                "BenefitCode": "300"
            }
        ],
        "hasNext": true
    },
    "length": null,
    "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.

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

17006

Parâmetro 'product' incorreto.

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

Image Removed

O parâmetro 'companyId' incorreto.

Image Removed

O parâmetro 'branchId' incorreto.

Image Removed

Image Removed

Erro

Mensagem

Solução

Nenhum registro localizado.

Image Removed

Importante

O campo de Estado Civil é inicializado com a opção "Não informado" por padrão no FP1760. Para garantir que as informações do dependente estejam corretas, é importante que o campo seja ajustado antes de realizar a integraçã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.