Histórico da Página

CONTEÚDO

1. Visão Geral
2. Detalhamento
3. Tela Integrações 
   1. Integrações Disponíveis
   2. Outras Ações / Consultar Pedidos
   3. Outras Ações / Comunicar Pedidos
   4. Outras Ações / Gerar Pedidos Em Massa
   5. Outras Ações / Gerar Pedidos Pelo STAMP
   6. Outras Ações / Status dos Pedidos
4. Tela Pedidos da Integração
   1. Comunicar
5. Schedules
   
   1. Gravar Pedidos
   2. Comunicar Pedidos
6. Tabelas Utilizadas
7. Dicionário de Dados

01. VISÃO GERAL

Âncora
VIS VIS

A integração do produto TOTVS Saúde Planos Linha Protheus tem como objetivo, enviar dados dos Beneficiários e Empresas do sistema 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

Âncora
DET DET

O processo de integração funcionará no seguinte panorama, que serão detalhados abaixo:

1. 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:
   1. Cadastro de Beneficiários.
   2. Cadastro de Empresas.
      
      
2. A tabela de Pedidos da Integração (B7F), será utilizada para guardar todos os pedidos a serem enviados, já enviados ou com problema de envio para cada integração cadastrada.
   
   
3. 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 5).
   
   
4. 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 5).

03. TELA INTEGRAÇÕES

Âncora
INT INT

Ao acessar a rotina de Integrações (PLMapIntegra), será mostrado o browser com todas as Integrações cadastrada, a tela de inclusão terá os seguintes campos a serem preenchidos:

...

Detalhes dos campos da Integração:

a. INTEGRAÇÕES DISPONÍVEIS 

Âncora
INTDIS INTDIS

As Integrações disponíveis para cadastrar são:

Essas são informações a serem preenchidas no cadastro da Integração para cada sistema parceiro.

...

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.

...

Essas são informações a serem preenchidas no cadastro da Integração para cada sistema parceiro.

b. OUTRAS AÇÕES / CONSULTAR PEDIDOS

Âncora
INTCON INTCON

Finalizado o processo, será apresentado um resumo da comunicação:

Image Removed

...

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

Image Removed

Confirmando, será feita a geração dos pedidos de acordo com os parâmetros informados.

visualizar os pedidos da Integração posicionada, ao clicar será aberto um outro browser com os pedidos.

c. OUTRAS AÇÕES / COMUNICAR PEDIDOS

Âncora
INTCOM INTCOM

Através dessa opção, será possível realizar a comunicação de todos os pedidos, Card documentosInformacao Se já houver algum pedido com o status pendente de envio ou e erro de envio da Integração posicionada. Ao clicar, 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.TituloImportanteirá perguntar:

Image Added

Finalizado o processo, será apresentado será apresentado um resumo da geraçãocomunicação:

Image Removed

...

Ao consultar os pedidos da Integração através do botão Consultar Pedidos da Rotina de Integração, será exibido um browser com todos os pedidos daquela Integração.

O pedido poderá ser incluído manualmente através do botão Incluir da rotina, pelo Gerar Pedidos da rotina de Integrações ou via schedule. Os dados que fazem parte do pedido são:

Image Removed

Detalhes dos campos do pedido:

...

Operadora

...

Image Added

d. OUTRAS AÇÕES / GERAR PEDIDOS EM MASSA

Âncora
INTGER INTGER

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

Image Added

Confirmando, será feita a geração dos pedidos em massa de acordo com os parâmetros informados.

Finalizado o processo, será apresentado um resumo da geração:

Image Added

e. OUTRAS AÇÕES / GERAR PEDIDOS PELO STAMP

Âncora
INTGERSTP INTGERSTP

Através dessa opção, será possível gerar uma carga de pedidos através do campo STAMP, esse botão é semelhante ao schedule PLMAPGRVSCHE.

Ao clicar, o sistema irá apresentar o pergunte PLRMPSTAMP (SX1), como mostra a imagem abaixo:

Image Added

Deverá ser informado a Operadora e a Data do STAMP para o filtro.

Confirmando, será feita a geração dos pedidos de acordo com as alterações, exclusões ou inclusões nas tabelas utilizadas pela Integração naquele período informado.

Finalizado o processo, será apresentado um resumo da geração:

Image Added

f. OUTRAS AÇÕES / STATUS DOS PEDIDOS

Âncora
INTSTATUS INTSTATUS

Através dessa opção, é possível consultar o status dos pedidos da Integração posicionada:

Image Added

Sendo:
Pendente de Envio: B7F_STATUS = 0
Envio Realizado: B7F_STATUS = 1
Erro de Envio: B7F_STATUS = 2
Envio Cancelado: B7F_STATUS = 3

04. TELA PEDIDOS DA INTEGRAÇÃO

Âncora
PED PED

Ao consultar os pedidos da Integração através do botão Consultar Pedidos da Rotina de Integração, será exibido um browser com todos os pedidos daquela Integração.

O pedido poderá ser incluído manualmente através do botão Incluir da rotina, pelo Gerar Pedidos da rotina de Integrações ou via schedule. Os dados que fazem parte do pedido são:

Image Added

Detalhes dos campos do pedido:

Os dados da tela inferior, correspondem a Integração, somente para visualização. Para Altera-los deverá ser utilizada a rotina de Integrações.  

a. COMUNICAR

Âncora
PEDCOM PEDCOM

Através do botão Comunicar da rotina de pedidos, será feito o envio manual do pedido posicionado, essa opcional é somente para enviar um pedido, caso queria enviar todos os pedido, deverá ser utilizado o botão Comunicar Pedidos da tela de Integrações, como mostra o tópico 3.c.

Clicando, o sistema irá perguntar:

Image Added

Confirmando, caso o sistema realize a comunicação com sucesso com a Integração, será apresentado a mensagem:

Image Added

Validações para o Envio do Pedido

1. A Integração do pedido deverá está ativa.
2. Deverá ser informado o Endpoint da Integração.
3. Deverá ser informada a classe de Comunicação na Integração.
4. Pedido com o status 1 - Envio Realizado e 3 - Cancelado, não será feita a comunicação.
5. Tentativas de envio maior que a quantidade máxima da Integração, não será feita a comunicação.
6. Data de Inclusão do Pedido maior que a data do Sistema. Nessa situação é porque foi programado para o pedido ser enviado somente em determinado dia, Exemplo: Bloqueio futuro de Beneficiários.

Resultados da Comunicação

1. Pedido enviado com sucesso, o status do pedido passará a ser 1 - Envio Realizado.
2. Falha ao realizar a autenticação com a Integração, nesse caso deverá ser analisado o Endpoint, Login e senha da Autenticação se estão corretos.
3. Falha no envio do pedido, o status do pedido passará a ser 2 - Erro de Envio, nesse caso deverá analisar o EndPoint da Integração e também o JSON de retorno.

05. SCHEDULE 

Âncora
SCH SCH

Além do processo manualmente para gravação do pedidos e comunicação, os mesmo poderão ser feito de forma automática via schedule.

a. GRAVAR PEDIDOS

Âncora
SCHGRV SCHGRV

A gravação dos pedidos da Integração será feita pelo schedule PLMapGrvSche. Diferentemente do processo manual, onde é configurado os parâmetros para a geração, pelo schedule a busca é feito pelo campo STAMP de cada tabela, ou seja, será gravado somente os registros que sofreram alguma alteração de cadastro.

Em um primeiro momento para envio de uma carga de pedidos, o ideal é utilizar a opção Gerar Pedidos da tela de Integrações, o schedule irá manter os dados atualizados com o sistema parceiro, quando houver alguma alteração cadastral.

A configuração do schedule é feita pelo modulo Configurador (SIGACFG):

Image Added

Rotina: PLMAPGRVSCHE
Parâmetros: Código da Operadora do sistema

O resultado do schedule, poderá ser acessado pelo log: /logpls/data/plmapgrvsche.log

Image Added

b. COMUNICAR PEDIDOS

Âncora
SCHCOM SCHCOM

A comunicação dos pedidos, assim como a gravação além de ser feita manualmente pela Rotina de Integração, poderá ser realizada pelo schedule PLMapComSche. O sistema irá comunicar todos pedidos com o status 0 - Pendente de Envio e 2 - Erro de Envio de todas as Integrações Ativas.

A configuração do schedule é feita pelo modulo Configurador (SIGACFG):

Image Added

Rotina: PLMAPCOMSCHE
Parâmetros: Código da Operadora do sistema

O resultado do schedule, poderá ser acessado pelo log: /logpls/data/plmapcomsche.log

Image Added

06. TABELAS UTILIZADAS

Âncora
TAB TAB

• B7E (Integrações)
• B7F (Pedidos da Integração)

07. DICIONÁRIO DE DADOS

Âncora
DICIO DICIO

Atualização do Arquivo SX2 (Tabelas):

Atualização do Arquivo SX3 (Campo): 

Atualização do Arquivo SIX (Índices): 

Atualização do Arquivo SX9 (Relacionamento): 

Atualização do Arquivo SX1 (Pergunte): 

Os dados da tela inferior, correspondem a Integração, somente para visualização. Para Altera-los deverá ser utilizada a rotina de Integrações.  

...

Através do botão Comunicar da rotina de pedidos, será feito o envio manual do pedido posicionado, essa opcional é somente para enviar um pedido, caso queria enviar todos os pedido, deverá ser utilizado o botão Comunicar Pedidos da tela de Integrações, como mostra o tópico 3.c.

Clicando, o sistema irá perguntar:

Image Removed

Confirmando, caso o sistema realize a comunicação com sucesso com a Integração, será apresentado a mensagem:

Image Removed

Validações para o Envio do Pedido

1. A Integração do pedido deverá está ativa.
2. Deverá ser informado o Endpoint da Integração.
3. Deverá ser informada a classe de Comunicação na Integração.
4. Pedido com o status 1 - Envio Realizado e 3 - Cancelado, não será feita a comunicação.
5. Tentativas de envio maior que a quantidade máxima da Integração, não será feita a comunicação.

Resultados da Comunicação

1. Pedido enviado com sucesso, o status do pedido passará a ser 1 - Envio Realizado.
2. Falha ao realizar a autenticação com a Integração, nesse caso deverá ser analisado o Endpoint, Login e senha da Autenticação se estão corretos.
3. Falha no envio do pedido, o status do pedido passará a ser 2 - Erro de Envio, nesse caso deverá analisar o EndPoint da Integração e também o JSON de retorno.

...

Além do processo manualmente para gravação do pedidos e comunicação, os mesmo poderão ser feito de forma automática via schedule.

...

A gravação dos pedidos da Integração será feita pelo schedule PLMapGrvSche. Diferentemente do processo manual, onde é configurado os parâmetros para a geração, pelo schedule a busca é feito pelo campo STAMP de cada tabela, ou seja, será gravado somente os registros que sofreram alguma alteração de cadastro.

Em um primeiro momento para envio de uma carga de pedidos, o ideal é utilizar a opção Gerar Pedidos da tela de Integrações, o schedule irá manter os dados atualizados com o sistema parceiro, quando houver alguma alteração cadastral.

A configuração do schedule é feita pelo modulo Configurador (SIGACFG):

Image Removed

Rotina: PLMAPGRVSCHE
Parâmetros: Código da Operadora do sistema

O resultado do schedule, poderá ser acessado pelo log: /logpls/data/plmapgrvsche.log

Image Removed

...

A comunicação dos pedidos, assim como a gravação além de ser feita manualmente pela Rotina de Integração, poderá ser realizada pelo schedule PLMapComSche. O sistema irá comunicar todos pedidos com o status 0 - Pendente de Envio e 2 - Erro de Envio de todas as Integrações Ativas.

A configuração do schedule é feita pelo modulo Configurador (SIGACFG):

Image Removed

Rotina: PLMAPCOMSCHE
Parâmetros: Código da Operadora do sistema

O resultado do schedule, poderá ser acessado pelo log: /logpls/data/plmapcomsche.log

Image Removed

...