Passo 4 - Configurar Integração Cadastral

Visão Geral

A Integração Cadastral tem como objetivo efetuar a comunicação e transferência de dados entre o TOTVS Saúde Portal Autorizador e o Protheus PLS, com a finalidade de manter os dados íntegros e atualizados para a utilização.

Serão transferidos os dados de atualizações cadastrais dos beneficiários, os cadastros e as atualizações dos produtos, e as alterações e configurações dos procedimentos, materiais, exames, etc.

Configurando a integração

Para efetuar a integração entre o Protheus PLS e o TOTVS Saúde Portal Autorizador é necessário que alguns procedimentos sejam executados. Algumas configurações devem ser feitas dentro do Configurador (SIGACFG) do Protheus, para instruções sobre como utilizar o Configurador (SIGACFG) acesse o documento Framework - Protheus 12

Dicionário de dados

Certifique-se que seu ambiente esteja com as ultimas atualizações disponíveis no portal de Expedição Contínua Protheus - Linha Microsiga Protheus - TDN (totvs.com).

Para a listagem das tabelas acesse o link: Tabelas utilizadas na integração com o TOTVS Saúde Portal Autorizador

Pacote de atualização

Certifique-se que seu ambiente esteja com as ultimas atualizações disponíveis no portal de Expedição Contínua Protheus - Linha Microsiga Protheus - TDN (totvs.com).

Para a listagem dos fontes utilizados acesse o link: Fontes utilizados na integração com o TOTVS Saúde Portal Autorizador - Home Soluções Saúde - TDN

Configuração de Parâmetros

Para que a integração com o TOTVS Saúde Portal Autorizador funcione corretamente é necessário que os parâmetros abaixo estejam configurados no Configurador (SIGACFG).

Parâmetro	MV_PLSHAT
Descrição	Habilita a integração com o TOTVS Saúde Portal Autorizador. 1 habilita a integração e 0 desabilita a Integração.
Tipo	Caractere
Conteúdo	1

Parâmetro	MV_PHATURL
Descrição	Indica o endereço do endpoint de integração do TOTVS Saúde Portal Autorizador
Tipo	Caractere
Conteúdo	Preencher com: https://hat.totvs.com.br/api/healthcare/hat/

Parâmetro	MV_PHATLOG
Descrição	Registra as informações das transações feitas pela integração com o TOTVS Saúde Portal Autorizador. 1 Habilita o log da integração com o TOTVS Saúde Portal Autorizador e 0 desabilita o log integração com o TOTVS Saúde Portal Autorizador.
Tipo	Caractere
Conteúdo	1

Parâmetro	MV_PSVCLOG
Descrição	Habilita log para serviços do PLS (0=Desativado / 1=Ativado)
Tipo	Caractere
Conteúdo	1

Parâmetro	MV_PHATTOK
Descrição	Token de autorização do TOTVS Saúde Portal Autorizador.
Tipo	Caractere
Conteúdo	Preencher com o token gerado na tela Configurações de integração do portal de administração. Somente os números, sem os traços ( - ). Configurar Chave de Autenticação das Integrações (Master Token) e Dados de integração

Parâmetro	MV_PHATIDT
Descrição	ID do tenant da operadora no TOTVS Saúde Portal Autorizador.
Tipo	Caractere
Conteúdo	Preencher com o id do tenant apresentado na tela Configurações de integração do portal de administração. Configurar Chave de Autenticação das Integrações (Master Token) e Dados de integração

Parâmetro	MV_PHATNMT
Descrição	Nome do tenant da operadora no TOTVS Saúde Portal Autorizador.
Tipo	Caractere
Conteúdo	Preencher com o nome do tenant apresentado na tela Configurações de integração do portal de administração. Configurar Chave de Autenticação das Integrações (Master Token) e Dados de integração

Menus do Sistema

Criar os menus abaixo no Configurador (SIGACFG) dentro do módulo Plano de saúde (Módulo 33) para gerenciar os pedidos de integração

PLSA274 - Gerenciamento dos pedidos de integração

Campo	Valor
Desc. Portugues	Geren. Ped. Integra
Programa	PLSA274
Status	Habilitado
Módulo	Plano de Saúde
Tipo	Função Protheus

PLSA275 - Endpoints de integração

Campo	Valor
Desc. Portugues	End. Integr. HAT
Programa	PLSA275
Status	Habilitado
Módulo	Plano de Saúde
Tipo	Função Protheus

PLSA277 - Erros Pedidos HAT

Campo	Valor
Desc. Portugues	Erros Pedidos HAT
Programa	PLSA277
Status	Habilitado
Módulo	Plano de Saúde
Tipo	Função Protheus

PLSA417 - Gestão de lotes do HAT

Campo	Valor
Desc. Portugues	Gestao Lotes HAT
Programa	PLSA417
Status	Habilitado
Módulo	Plano de Saúde
Tipo	Função Protheus

Carregar as transações - PLSA275 - Endpoints de integração

Acesse a rotina PLSA275 - Endpoints de integração no menu do Totvs Saúde Protheus e clique no botão Carregar Transações para que os endpoints de integração sejam carregados.

Configuração no APPSERVER.INI

É necessário criar um ambiente para cada empresa e nesse ambiente serem informadas as chaves JEMP, JFIL, EMPROBOXML e FILROBOXML, configurar uma porta REST, uma porta WS e os Jobs de processamento.

Importante

Caso o ambiente possua um Broker, para correto funcionamento, os appservers deverão estar abaixo de um BROKER WS.

Atenção: Não recomendamos a utilização de um broker HTTP, pois esse retorna uma resposta de redirecionamento (302) e caso se adicione a tag USING_COOKIES=0 o broker irá direcionar o tráfego apenas para um appserver sem realizar o balanceamento da carga..

Exemplo .ini Broker Web Service

[GENERAL]
; configuracao recomendada para gravacao de log
ConsoleLog=1
ConsoleLogDate = 0 

[BALANCE_WEB_SERVICES]
LOCAL_SERVER_PORT=4000            ; porta de entrada do Broker HTTP
REMOTE_SERVER_01=127.0.0.1 5000   ; ip e porta do Broker WebServices encadeado

; etc
; a chave REMOTE_SERVER_xx aceita letras e números para identificar servidores,
; por exemplo REMOTE_SERVER_0A, REMOTE_SERVER_XY, etc, e as chaves
; podem estar em qualquer ordem
 
; nome do serviço Windows, caso seja utilizado
; (não pode conter espaços)
SERVICE_NAME=XXX_TOTVS_BALANCE_WS_001
 
; (opcional, disponível a partir de 01/dez/2017)
; "display name" do serviço Windows
SERVICE_DISPLAY_NAME = "BROKER SERVICE"

Recomendamos que haja um appserver para cada funcionalidade. Sendo assim necessários 3 appservers: 1 Rest, 1 Portal e 1 JOB/Schedule
Abaixo exemplos de configuração do appserver.ini para o ambiente de uma empresa de cada serviço:

Appserver REST

appserver.ini

;------------------------------------------------------------------------------
;Para cada empresa é necessário haver uma configuração específica de ambiente 
;------------------------------------------------------------------------------
[PROCUCAO_EMP01] 
SourcePath=C:\Protheus\PROCUCAO_EMP01\apo
RootPath=C:\Protheus\PROCUCAO_EMP01\protheus_data
StartPath=\system\
#Informações utilizadas para identificar a CodigoEmpresa e filial pelos jobs
EMPROBOXML=CodigoEmpresa
FILROBOXML=CodigoFilial
JEMP=CodigoEmpresa
JFIL=CodigoFilial 
...

[ONSTART]
JOBS=HTTPJOB,HTTPREST
Refreshrate=120

;--------------------------------
;------------- REST -------------
;--------------------------------
[HTTPJOB]
MAIN=HTTP_START
ENVIRONMENT=PROCUCAO_EMP01

[HTTPV11]
Enable=1
Sockets=HTTPREST

[HTTPREST] 
Port=Porta
IPsBind=Endereco
URIs=URIHTML
SECURITY=1
MaxQueue=10
SSL2=0
SSL3=0
TLS1=0
BUGS=0
State=0
Verbose=0
HSM=0
Module=
Certificate=
Certificate2=
Key=
Key2=
PassPhrase=  

[URIHTML]
URL=/rest
PrepareIn=CodigoEmpresa,CodigoFilial
Instances=1,5
AllowOrigin=*
CORSEnable=1

Appserver Portal:

appserver.ini

;------------------------------------------------------------------------------
;Para cada empresa é necessário haver uma configuração específica de ambiente 
;------------------------------------------------------------------------------
[PROCUCAO_EMP01] 
SourcePath=C:\Protheus\PROCUCAO_EMP01\apo
RootPath=C:\Protheus\PROCUCAO_EMP01\protheus_data
StartPath=\system\
#Informações utilizadas para identificar a CodigoEmpresa e filial pelos jobs
EMPROBOXML=CodigoEmpresa
FILROBOXML=CodigoFilial
JEMP=CodigoEmpresa
JFIL=CodigoFilial 
...

[ONSTART]
JOBS=JOB_PP
Refreshrate=120
;--------------------------------
;--------- Web Service ----------
;--------------------------------

[http]
enable=1
path=E:\protheus\PROCUCAO_EMP01\Protheus_data
port=Porta
INSTANCES=1,10
ENVIRONMENT=PROCUCAO_EMP01
SESSIONTIMEOUT=TempoDeTimeout
SECURITY=1

[Endereco:Porta]
ENABLE=1
PATH=E:\protheus\PROCUCAO_EMP01\Protheus_data\Web\PP
ENVIRONMENT=PROCUCAO_EMP01
INSTANCENAME=pp 
RESPONSEJOB=JOB_PP
JEMP=CodigoEmpresa 
JFIL=CodigoFilial
UPLOADPATH=E:\protheus\PROCUCAO_EMP01\Protheus_data\TISS\upload
TPACESSO=1
INSTANCES=5,10,3,3

[JOB_PP]
TYPE=WEBEX
ENVIRONMENT=PROCUCAO_EMP01
INSTANCES=5,10,3,3
PREPAREIN=CodigoEmpresa,CodigoFilial
SIGAWEB=PP
INSTANCENAME=PP
ONSTART=STARTWEBEX
ONCONNECT=CONNECTWEBEX
ONEXIT=FINISHWEBEX
WEBSERVICELOCATION=http://Endereco:Porta/ws

[Endereco:Porta/ws]
ENABLE=1
PATH=E:\protheus\PROCUCAO_EMP01\Protheus_data\Web\Ws
ENVIRONMENT=PROCUCAO_EMP01
INSTANCENAME=ws
RESPONSEJOB=JOB_WS
DEFAULTPAGE=wsindex.apw
;;SESSIONTIMEOUT=30

[JOB_WS]
TYPE=WEBEX
ENVIRONMENT=PROCUCAO_EMP01
INSTANCES=1,10,3,3
SIGAWEB=WS
INSTANCENAME=ws
ONSTART=__WSSTART
ONCONNECT=__WSCONNECT
PREPAREIN=CodigoEmpresa,CodigoFilial

Appserver JOB:

appserver.ini

;------------------------------------------------------------------------------
;Para cada empresa é necessário haver uma configuração específica de ambiente 
;------------------------------------------------------------------------------
[PROCUCAO_EMP01] 
SourcePath=C:\Protheus\PROCUCAO_EMP01\apo
RootPath=C:\Protheus\PROCUCAO_EMP01\protheus_data
StartPath=\system\
#Informações utilizadas para identificar a CodigoEmpresa e filial pelos jobs
EMPROBOXML=CodigoEmpresa
FILROBOXML=CodigoFilial
JEMP=CodigoEmpresa
JFIL=CodigoFilial 
...

[ONSTART]
JOBS=IMPXML,XML_ROBOT,PJobHatXML,PLSYNCAUTH,PLSYNCLIAT,PLSYNCTREX,PJobPlsHat
Refreshrate=120

;$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
;$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$   JOBS INTEGRACAO HAT $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
;$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$

#Job responsavel por realizar a importação dos XML's para o Protheus
[IMPXML]
Enviroment=PROCUCAO_EMP01
Main=XmlImport
 
;Job responsavel por processar os XML's baixados
[XML_ROBOT]
ENVIRONMENT=PROCUCAO_EMP01
main=xmlroute
 
#Job responsavel por verificar se existem arquivos XML para baixar e realizar o download
[PJobHatXML]
ENVIRONMENT=PROCUCAO_EMP01
INSTANCES=1,1
main=PJobHatXML
 
#Job responsavel por integrar as guias de autorização e as guias canceladas
[PLSYNCAUTH]
ENVIRONMENT=PROCUCAO_EMP01
MAIN=PLSYNCAUTH
INSTANCES=1,1
 
#Job responsavel por integrar as guias de anexos clinicos e as guias de anexos canceladas
[PLSYNCLIAT]
ENVIRONMENT=PROCUCAO_EMP01
MAIN=PLSYNCLIAT
INSTANCES=1,1
 
#Job responsavel por integrar as guias de prorrogação de internação e as prorrogações canceladas
[PLSYNCTREX]
ENVIRONMENT=PROCUCAO_EMP01
MAIN=PLSYNCTREX
INSTANCES=1,1
  
#Job resposavel por realizar a integração de dados
[PJobPlsHat]
main=PJobPlsHat
ENVIRONMENT=PROCUCAO_EMP01
INSTANCES=1,1

[FWSCHDMANAG]
Main=FWSCHDMANAG
Environment=PROCUCAO_EMP01

[FWSCHDQUEUE]
Main=FWSCHDQUEUE
Environment=PROCUCAO_EMP01
 
;$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
;$$$$$$$$$$$$$$$$$$$$$$  FIM DA CONFIGURACAO DAS JOBS DE INTEGRACAO HAT $$$$$$$$$$$$$$$$$$$$$$$
;$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$

Alerta de risco: fique atento ao utilizar o parâmetro de configuração com a chave Security=0, pois isso fará com que as integrações (APIs) não exijam autenticação, consequentemente dados do seu ambiente poderão ser consultados sem qualquer controle de autorização.

Obs.: também deve ser adicionada a chave PREPAREIN=<CodigoGrupoEmpresa>,<CodigoEmpresa><CodigoFilial> na sessão que é chamada na chave URIs do [HTTPURI], no APPSERVER.ini. Para mais informações: Configuração do REST Protheus para uso com os aplicativos Mobile.

Para mais informações sobre o PJobHatXML consulte o documento disponível em: https://tdn.totvs.com/pages/viewpage.action?pageId=636318321

IMPORTANTE: O job PLSHAT(PJobPlsHat) necessita de algumas configurações e campos adicionais, para mais informações acesse o documento disponível em: DT Implementação Jobs Integração PLS x HAT

Logs das funções e chaves da sessão ambiente

Durante a execução das funções, são utilizadas as chaves JEMP, JFIL, EMPROBOXML e FILROBOXML configuradas na sessão [AMBIENTE/ENVIROMENT] do APPSERVER.INI.

A seguir está a lista de quais funções utilizam quais chaves, junto com quais logs são gerados durante sua execução.

Função	Chaves	Logs
PLSYNCAUTH	JEMP e JFIL	authorizations authorizations - cancelamento
PLSYNCLIAT	JEMP e JFIL	clinicalattachments clinicalattachments - cancelamento
PLSYNCTREX	JEMP e JFIL	treatmentextensions treatmentextensions - cancelamento
PJOBHATXML	EMPROBOXML e FILROBOXML	plsxmldownload.log
XMLIMPORT	EMPROBOXML e FILROBOXML	logs no console do appserver
XMLROUTE	EMPROBOXML e FILROBOXML	logs no console do appserver

Integração autorizações, anexo clinico e prorrogação.

Para realizar a integração, basta fazer a chamada das rotinas conforme configuração mostrada no passo 4.1 - Configurar Integração Cadastral

Função	Descrição
PLSYNCAUTH	Responsável por realizar a integração das Autorizações.
PLSYNCLIAT	Responsável por realizar a integração dos Anexo Clinico.
PLSYNCTREX	Responsável por realizar a integração das prorrogações.

Observação.:

Os cancelamentos serão considerados quando bea_cancel = 1 e TrackingStatus = 1.
TrackingStatus recebe valor 1,2,3 e 4,
- 1 = Processado com sucesso os atendimentos.
- 3 = Erro no processamento dos atendimentos.
- 2 = Processado com sucesso os cancelamentos.
- 4 = Erro no processamento dos cancelamentos.

Os logs gerados do processamento estão na pasta logpls/data do dia.

IMPORTANTE

As guias integradas via API, não geram movimentação nas tabelas de processamento de contas (BD5, BD6 e BD7)

Authorizations, Authorizations - cancelamento, ClinicalAttachments, ClinicalAttachments - cancelamento, TreatmentExtensions e TreatmentExtensions - cancelamento

Siga para o passo Passo 5 - Envio de Acesso aos Prestadores para continuar a implantação;

Atalhos

Árvore de páginas

Visão Geral

Configurando a integração

Dicionário de dados

Pacote de atualização

Configuração de Parâmetros

Menus do Sistema

PLSA274 - Gerenciamento dos pedidos de integração

PLSA275 - Endpoints de integração

PLSA277 - Erros Pedidos HAT

PLSA417 - Gestão de lotes do HAT

Carregar as transações - PLSA275 - Endpoints de integração

Configuração no APPSERVER.INI

Logs das funções e chaves da sessão ambiente

Integração autorizações, anexo clinico e prorrogação.