Histórico da Página
CONTEÚDO
- Visão Geral
- Detalhamento
- Tela Integrações
- Integrações Disponíveis
- Outras Ações / Consultar Pedidos
- Outras Ações / Comunicar Pedidos
- Outras Ações / Gerar Pedidos
- Tela Pedidos da Integração
- Classe para Gravar os Pedidos
- Classe para Comunicar com a Integração
- Schedules
- Gravar Pedidos
- Comunicar Pedidos
- Tabelas utilizadas
01. VISÃO GERAL
A integração do produto TOTVS Saúde Planos Linha Protheus tem como objetivo, enviar dados dos Beneficiários e Empresas para que possam ser tratados pelos serviços utilizados nos sistemas parceiros da TOTVS.
A comunicação entre as partes será realizada via comunicação API REST.
02. DETALHAMENTO
O processo de integração funcionará no seguinte panorama, que serão detalhados abaixo:
- A tabela de Integrações (B7E), será utilizada para cadastrar todas integrações realizadas entre o Protheus e o sistema parceiro, até o momento as integrações que estão homologadas são:
- Cadastro de Beneficiários
- Cadastro de Empresas.
- A tabela de Pedidos da Integração (B7F), será utilizada para guardar todos os pedidos a serem enviadas, já enviados ou com problema de envio para cada integração cadastrada.
- A Carga dos pedidos da integração para envio, será feita manualmente através do botão Gerar Pedidos da Tela de Integrações ou via schedule (O processo de schedule será apresentado no tópico 7).
- A comunicação será feita manualmente através do botão Comunicar da Tela de Pedidos da Integração, ou poderá ser feita uma comunicação de todos os pedidos pendentes de envio de cada integração, pelo botão Comunicar Pedidos da tela de Integrações. A comunicação também será feita via schedule (O processo de schedule será apresentado no tópico 7).
03. TELA INTEGRAÇÕES
Ao acessar a rotina de Integrações (PLMapIntegra), será possível cadastrar novas integrações, a tela de inclusão terá os seguintes campos a serem preenchidos:
Detalhes dos campos da Integração
| Campo | Descrição | Preenchimento |
|---|---|---|
Operadora | Código da Operadora do sistema. | Obrigatório. |
| Codigo Integ. | Código Incremental das Integrações. | Preenchimento automático, não editável . |
| Descrição | Descrição da Integração. | Obrigatório. |
| Alias Prima. | Tabela do cadastro que será utilizada para envio. | Obrigatório, essa tabela será detalhado o preenchimento no próximo tópico. |
| EndPoint | Endereço de comunicação da API do sistema parceiro. | Opcional no cadastro, mas necessário para comunicação dos pedidos. |
| Ativo | Definição se a Integração está ativa, essa informação é usada em alguns processo do sistema. | Obrigatório. |
| Máximo Envio | Quantidade máxima de tentativas de comunicação, antes de cancelar o pedido, caso não tenha sucesso. | Obrigatório. |
| Classe Stamp | Classe do sistema que será utilizada para gravar os pedidos via schedule. | Opcional no cadastro, mas necessário para realizar a gravação dos pedidos via schedule, será detalhado o preenchimento no próximo tópico. |
| Classe Comu. | Classe do sistema que será utilizada para montagem do json da integração, além da comunicação. | Opcional no cadastro, mas necessário para a comunicação dos pedidos, será detalhado o preenchimento no próximo tópico. |
| Login Auten. | Login para autenticar no sistema parceiro da Integração. | Opcional no cadastro, mas necessário para comunicação dos pedidos. |
| Senha Auten. | Senha para autenticar no sistema parceiro da Integração. | Opcional no cadastro, mas necessário para comunicação dos pedidos. |
| EndPoint Aut | Endereço de comunicação da API de Autenticação do sistema parceiro. | Opcional no cadastro, mas necessário para comunicação dos pedidos. |
| Bearer Aut. | Bearer utilizado pelo sistema para autenticação na API do sistema parceiro. | Não editável, o sistema utiliza esse campo para controle interno ao realizar a comunicação. |
| Cookie Aut. | Cookie utilizado pelo sistema para autenticação na API do sistema parceiro. | Não editável, o sistema utiliza esse campo para controle interno ao realizar a comunicação. |
| Tempo Expe. | Tempo de Expiração do Bearer e Cookie. | Não editável, o sistema utiliza esse campo para controle interno ao realizar a comunicação. |
| Perg. Gerar | Pergunte (SX1) do sistema para gerar os pedidos | Opcional no cadastro, mas necessário no botão Gerar Pedidos, esse pergunte será para os filtros da geração, será detalhado o preenchimento no próximo tópico. |
a. INTEGRAÇÕES DISPONÍVEIS
As Integrações disponíveis para cadastrar são:
Cadastro de Empresas
| Sistema Parceiro | Alias Prima. | Classe Stamp | Classe Comu. | Perg. Gerar |
|---|---|---|---|---|
| HealthMap | BG9 | PLMapStpEmpre | PLMapJsEmpre | PLR660 |
Cadastro de Beneficiários
| Sistema Parceiro | Alias Prima. | Classe Stamp | Classe Comu. | Perg. Gerar |
|---|---|---|---|---|
| HealthMap | BA1 | PLMapStpBenef | PLMapJsBenef | PLR660 |
Essas são informações a serem preenchidas no cadastro da Integração para cada sistema parceiro.
b. OUTRAS AÇÕES / CONSULTAR PEDIDOS
Através dessa opção, será possível visualizar os pedidos da Integração posicionada, ao clicar será aberto um outro browser com os pedidos.
c. OUTRAS AÇÕES / COMUNICAR PEDIDOS
Através dessa opção, será possível realizar a comunicação de todos os pedidos, com o status pendente de envio e erro de envio da Integração posicionada. Ao clicar, o sistema irá perguntar:
Finalizado o processo, será apresentado um resumo da comunicação:
d. OUTRAS AÇÕES / GERAR PEDIDOS
Através dessa opção, será possível gerar uma carga de pedidos para a Integração posicionada. Ao clicar, o sistema irá apresentar o pergunte (SX1) cadastrado na Integração.
Por exemplo, no pergunte dessa Integração, será informado o Grupo/Empresa De e o Grupo/Empresa Até:
Confirmando, será feita a geração dos pedidos de acordo com os parâmetros informados.
Card documentos Informacao Se já houver algum pedido com o status pendente de envio ou erro de envio, o sistema não irá gerar um novo pedido, devido o pedido ainda está em aberto, entende-se como um pedido encerrado, aquele com o status Envio Realizado ou Envio Cancelado. Titulo Importante
Finalizado o processo, será apresentado um resumo da geração:
04. TELA PEDIDOS HEALTHMAP
Tela em MVC da tabela BZZ (Pedidos), que será acessada através do botão outras ações da tela de Integrações HealthMap. O Browser dos pedidos será filtrado de acordo com a integração posicionada, ou seja, se for acessado via Integração do cadastro de beneficiários, só será exibido os pedidos relacionados ao cadastro de beneficiários na tabela BZZ e assim também para o cadastro de Empresas.
Aberto o Browser dos pedidos, no menu terá a opção de Alterar, Visualizar, Excluir, Cancelar e Comunicar (Inclusão será feita somente via Classe de Coleta de Dados):
- Comunicar Pedido: Será feito o envio manual do Pedido para a HealthMap.
- Cancelar Pedido: Será alterado o status do pedido para 3-Envio Cancelado.
- Alterar/Visualizar Pedido: A tela irá mostrar os dados do pedido, além dos dados da integração, somente para visualização. (Alteração da tabela BXX somente pela tela de Integrações HealthMap como mostrado no tópico 3)
(Imagem ilustrativa, alterar para imagem do produto quando desenvolvido)
Detalhes dos Campos da tabela BZZ:
| Campo | Descrição |
|---|---|
| Operadora | Operadora do Sistema |
| Cod. Integração | Código de relacionamento com a tabela de Integrações |
| Cod. Pedido | Código Incremental dos Pedidos |
| Alias | Tabela chave do pedido para ser utilizado na busca de dados |
| Chave | Chave de busca do Alias para posicionar nos registros |
| Dt. Inclusão | Data de Inclusão do Pedido |
| Dt. Comunicação | Data em que foi realizado a comunicação com a HealthMap |
| Status | Status do Pedido: 0-Pendente de Envio; 1-Envio Realizado; 2-Erro de Envio; 3-Envio Cancelado |
| Tent. Envio | Tentativas de Comunicação com o HealthMap |
| Json Envio | JSON enviado para o HealthMap |
05. CLASSE PARA GRAVAR OS PEDIDOS
A classe PLMapGrvPed, irá verificar as integração da HealthMap (Tabela BXX) se os Alias relacionados ao Cadastro de Beneficiários ou Empresa tiveram alguma alteração de acordo com o campo S_T_A_M_P_ das tabelas. Se houver alteração, será feito uma busca na tabela de pedido (BZZ) pelos campos: Cod. Integração + Alias Primário + Chave (Corresponde os dados que identificam o Beneficiário ou Empresa), para saber se tem algum pedido daquele Beneficiário ou Empresa pendente para não haver duplicidade de envio de dados.
Essa Classe possuirá alguns métodos como:
- Método para receber as configurações da tabela de Integração da HealthMap (Tabela BXX)
- Método para buscar via Query os beneficiários ou Empresas que tiveram alteração de acordo com o S_T_A_M_P_, retornado somente os dados da chave do alias primário configurado para Beneficiário ou Empresa.
- Método para verificar se o Alias Primário + Chave já constam pedido em aberto.
- Método para gravar o pedido (Tabela BZZ) com o Alias Primário + Chave de cada Beneficiário ou Empresa encontrado com alteração.
Será criado um schedule, onde poderá ser configurado a quantidade de vezes em que a classe PLMapGrvPed, irá buscar e gravar os pedidos de acordo com as integrações.
06. CLASSE PARA COMUNICAR COM O HEALTHMAP
Criado os pedidos, será feito a comunicação com a HealthMap pela Classe PLMapComPed, que herda métodos da classe PLSRest.
Mas antes de comunicar, será feito a montagem do json de cada pedido através da classe PLMapBenef para o Cadastro de Beneficiários e PLMapEmpre para o Cadastro de Empresas.
Essas classe de montagem do Json possuirá alguns métodos como:
- Método para posicionar nas tabelas necessárias para montagem do Json, atráves da chave do alias primário.
- Método para montagem do Json de acordo com a documentação de layout da HealthMap de cada Integração.
Caso possua métodos em comum para montagem do Json, será criado a classe PLMapJson (se necessário)
Feito a montagem do Json, será instanciado a classe de comunicação para envio do Json para a HealthMap.
A Classe de comunicação PLMapComPed possuirá alguns métodos como:
- Método para atualizar status do pedido, se foi enviado com sucesso ou ocorreu erro de envio.
- Método para autenticação com o HealthMap.
- Método para configurar da comunicação.
Será criado um schedule, onde poderá ser configurado a quantidade de vezes em que a classe PLMapComPed, irá realizar o envio dos pedidos pendentes para a HealthMap.
07. TABELAS UTILIZADAS
- BXX (Integrações HealthMap)
- BZZ (Pedidos HealthMap)
- BA1 (Cadastro dos Beneficiários)
- BA3 (Cadastro das Famílias)
Necessário adicionar as tabelas utilizadas no desenvolvimento
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas