Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

01. DADOS GERAIS

Produto:

TOTVS Saúde Planos

Linha de Produto:

Linha Protheus 

Segmento:

Saúde

Módulo:Faturamento
Função:Monitor de Inadimplência
Issue :DSAUBE-26610

02. SITUAÇÃO/REQUISITO

Desenvolver uma rotina que permita aos usuários visualizar os beneficiários inadimplentes, juntamente com os respectivos títulos em aberto. A rotina também deverá identificar os beneficiários que atendem aos critérios estabelecidos pela Resolução Normativa nº 593, possibilitando sua categorização conforme diferentes status.

03. SOLUÇÃO

1. O que é o Monitor de Inadimplência?

O Monitor de Inadimplência é uma ferramenta desenvolvida para permitir que usuários visualizem, acompanhem e registrem informações sobre beneficiários de planos de saúde que possuem faturas vencidas. O sistema também identifica aqueles que se enquadram na RN nº 593 da ANS, norma que regulamenta o cancelamento de contratos por inadimplência.

2. Funcionalidades do Sistema

  • Consulta de beneficiários inadimplentes.

  • Visualização de títulos em aberto.

  • Registro de interações realizadas com os beneficiários.

  • Envio de e-mail de notificação de inadimplência.

  • Filtros específicos da RN 593.

3. Parâmetros (SX6)

A rotina leva em consideração dois parâmetros para retornar os títulos:

  • MV_PLSTIT - Tipo do título (campo E1_TIPO)

  • MV_PLPFE11 - Prefixo do título (campo E1_PREFIXO)

4. Estrutura da Interface

> Parte Superior: Dados do Beneficiário

  • Matrícula

  • Nome do Beneficiário

  • Código do Cliente (SA1)

  • Código da Loja Relacionado ao Cliente (SA1)

  • Nome do Cliente (SA1)

  • Nome Social

  • Data de Internação

  • Matrícula Antiga

  • Operadora

  • Empresa

  • Contrato

  • Subcontrato

> Parte Inferior Esquerda: Títulos em Atraso

  • Prefixo

  • Número do Título

  • Vencimento

  • Dias em Atraso

  • Valor

  • Vencimento Real

  • Emissão

  • Mês Base

  • Ano Base

  • Parcela

  • Tipo

  • Número do Lote de Cobrança

  • Contrato

  • Subcontrato

  • Código do Cliente

  • Loja do Cliente

> Parte Inferior Direita: Contatos Realizados

  • Confirmação de recebimento do contato

  • Data do contato

  • Hora do contato

  • Origem do contato

  • Matrícula do beneficiário posicionado

  • Motivo do contato

  • Data da criação do registro no sistema

  • Hora da criação do registro no sistema

5. Passo a Passo das Funcionalidades

Opção de Menu Novo Filtro

  1. Clique no botão Novo Filtro.

  2. Uma janela com um formulário será exibida.

  3. Preencha os dados conforme a necessidade.

  4. Clique em OK.

Nota

Quanto menos parâmetros informados, maior pode ser o tempo de processamento devido à quantidade de registros retornados.

Opção de Menu Atualizar Dados

  1. Clique no botão Atualizar Dados.

  2. O sistema irá recarregar os dados com base nos parâmetros preenchidos anteriormente.

Nota

Utilize esta funcionalidade sempre após registrar uma interação manualmente, garantindo a atualização correta dos filtros da RN 593. Sempre que uma interação for inserida manualmente, uma mensagem será exibida no topo da tela como lembrete para atualizar os dados.


Opção de Menu Enviar Notificação de Inadimplência

  1. Selecione uma ou mais linhas na tabela da esquerda.

  2. Clique no botão Enviar Notificação de Inadimplência.

  • Antes de enviar o e-mail, o sistema verifica se o campo de e-mail do beneficiário selecionado (BA1_EMAIL) está preenchido e válido. Além disso, caso o cliente vinculado ao beneficiário também deva receber o e-mail, o sistema verifica se o e-mail do cliente (A1_EMAIL) está disponível e em conformidade com o padrão esperado.
  • Se um ou mais endereços de e-mail estiverem ausentes ou inválidos, uma janela de aviso será exibida informando o problema.


     3. Clicando em Não! O sistema exibirá uma lista contendo os beneficiários e os clientes que estão com alguma não conformidade no e-mail. No caso abaixo, o e-mail não foi configurado.

 


      4. Ao confirmar a ação clicando em 'Sim', o sistema exibirá uma janela solicitando que o usuário escolha se o envio dos e-mails deve ser feito apenas para o titular ou para o titular e o cliente.


      5. Clicando em uma das opções, o sistema iniciará o processo de envio dos e-mails. 


  • Caso ocorram falhas em um ou mais envios, será exibida uma lista contendo apenas os detalhes do erro e os dados dos respectivos beneficiários que não receberam o e-mail, os que não estiverem na lista foram enviados com sucesso. 


  • Se ao final do processo de envio dos e-mails, não ocorrer nenhum erro, o sistema irá apresentar apenas a mensagem confirmando o envio.


Nota

Toda configuração relacionada ao layout do e-mail, remetente e assunto do e-mail são configurados na rotina Gerenciador de Contas de E-mail, clique no link para acessar a documentação completa DT Gerenciador de Contas de E-mail.

Opção de Menu Documentação

  • Exibe a documentação do monitor de inadimplência.

Opção de Menu Filtros RN 593

📝 Como funciona?

  • Ao abrir o Monitor, todos os beneficiários inadimplentes são exibidos, independentemente da RN 593.

  • Os filtros RN 593 refinam os dados carregados, mantendo apenas os que atendem à norma.

✅ Premissas para atender a RN 593:

  1. Cobrança no nível da família (BA3_COBNIV == '1)

  2. Data-base do contrato >= 01/12/2024 (BA3_DATBAS)

  3. Dois ou mais títulos em atraso, sendo um com 50 dias ou mais

🔽 Filtros Disponíveis

  • Mais de 50 Dias de Atraso Sem Envio de Notificação

    • Deve atender todas as premissas

    • Não possuir interações registradas

    • ❌ Não estar internado (BE4_DTDIGI)


  • Mais de 50 Dias de Atraso Com Prazo de Retorno Expirado

    • Atender todas as premissas

    • Possuir interações

    • A última interação ocorreu há 10 dias ou MAIS

    • ❌ Não estar internado (BE4_DTDIGI)


  • Mais de 50 Dias de Atraso Dentro do Prazo de Retorno

    • Atender todas as premissas

    • Possuir interações

    • A última interação ocorreu há 10 dias ou MENOS

    • ❌ Não estar internado (BE4_DTDIGI)


  • Beneficiários Inadimplentes Internados
    • Atender todas as premissas
    • Se enquadrar em uma das regras acima.
    • O beneficiário titular ou dependente deve estar internado com base no campo BE4_DTDIGI.


Nota

A data de digitação é usada porque em algumas situações há o atraso na atualização do status de internação no sistema (BE4_DATPRO). Isso evita o risco de enviar cobrança a beneficiários internados.


  • Limpar Filtro

    • Desfaz o último filtro e restaura a exibição de todos os inadimplentes.


Informações

📚 Clique no link para mais informações sobre a RN 593: Resolução Normativa 593 - ANS

8. Seção Contatos Realizados

A seção de Contatos Realizados é onde ficam registradas todas as interações com o cliente, seja quando a empresa entra em contato com o beneficiário ou quando o beneficiário entra em contato com a empresa.

Essa seção é extremamente importante, pois influencia diretamente a análise dos beneficiários que se enquadram na RN 593. Com base nas informações inseridas nessa área, o sistema determina em qual filtro da RN 593 o beneficiário será exibido.

Os dados podem ser inseridos manualmente, através da inserção direta utilizando ReckLock ou através de métodos desenvolvidos especificamente para a gravação dos dados de contatos realizados conforme o item 12. Inserção de Dados na Tabela de Contatos Realizados (BRZ) deste documento.

Manualmente é possível incluir, alterar, visualizar e excluir um registro.


  1. Para incluir um registro, clique no botão incluir e insira os dados referentes ao contato realizado.

Campos disponíveis:

📩 Cont. Conf ? (BRZ_CNFCON)

  • Indica se o recebimento do contato foi confirmado, conforme o meio de comunicação utilizado.
    Valores possíveis:

      > 0 – Recebimento não confirmado

      > 1 – Recebimento confirmado

📅 Data do Contato (BRZ_DATCON)

  • Data em que o contato com o beneficiário foi realizado.

Hora do Contato (BRZ_HORCON)

  • Horário em que o contato foi efetuado.

🗓️ Data de Criação (BRZ_DATCRI)

  • Data em que o registro foi criado na tabela.

🕒 Hora de Criação (BRZ_HORCRI)

  • Horário em que o registro foi inserido na tabela.

9. Criação de Botões Customizados

Através do Ponto de entrada PLMON001, é possível criar botões na rotina, permitindo a criação de quantos botões forem necessários com as funcionalidades desejadas.

> É necessário retornar um array bidimensional.

  • Na primeira posição: descrição do botão.

  • Na segunda posição: bloco de código com a função a ser executada.


Bloco de código
languagecpp
themeRDark
titleExemplo de implementação
linenumberstrue
function PLMON001()
     LOCAL aMenu := {}
     AADD(aMenu, {"Teste Botão 1", {||U_botao1()}})
     AADD(aMenu, {"Teste Botão 2", {||U_botao2()}})
return aMenu


10. Ponto de Entrada do Status de Contato

Através do Ponto de entrada PLMON002, é possível criar status relacionados à tabela de contatos realizados (BRZ).

  • Primeira posição: condição do status

  • Segunda posição: cor

  • Terceira posição: descrição

Bloco de código
languagecpp
themeRDark
titleExemplo de implementação
linenumberstrue
Function PLMON002()
   LOCAL aStatus := {}
   AADD(aStatus, {"BRZ_DATCON < dDataBase .AND. BRZ_CNFCON == '0'", "BLUE", "Data anterior a hoje"})
RETURN aStatus



  • Para realizar customizações na seção de contatos realizados, será necessário seguir as regras de ponto de entrada MVC. Em MVC criamos um único ponto de entrada e este é chamado em vários momentos dentro da aplicação desenvolvida. Este ponto de entrada único deve ser uma user function chamada PLREASONCON que é o ID do modelo de dados do grid de contatos realizados.


Informações

📚 Para mais informações sobre como utilizar ponto de entrada em MVC, consulte o documento: https://tdn.totvs.com/display/public/framework/AdvPl+utilizando+MVC


11. Recuperar Seleção de Beneficiários

 

  • Os beneficiários selecionados no mark browse não podem ser passados diretamente como parâmetro para botões customizados ou em customizações relacionadas aos contatos realizados. Para contornar essa limitação, foi disponibilizado um método estático que retorna um objeto JSON contendo a lista dos beneficiários selecionados.
  • Com a utilização desse método, a lista dos beneficiários selecionados na tela estará disponível em qualquer fonte, função ou método customizado enquanto o monitor de inadimplência estiver aberto.

Sintaxe

DelinquencyInterface:getSelecBeneficiaries()

Retorno

Nome

Tipo

Descrição

oJson

Json

Retorna um objeto json com a seguinte estrutura



Bloco de código
languageyml
themeRDark
titleExemplo de Utilização
linenumberstrue
oJSelecBeneficiaries := delinquency.monitor.DelinquencyInterface():getSelecBeneficiaries()

//O objeto retorna os seguintes atributos

//dados do beneficiário
//oJSelecBeneficiaries[nPosicao]["beneficiarie"]["register"] - Matrícula completa do beneficiário
//oJSelecBeneficiaries[nPosicao]["beneficiarie"]["name"    ] - Nome do beneficiário
//oJSelecBeneficiaries[nPosicao]["beneficiarie"]["email"]    - E-mail do beneficiário

//dados do cliente
//oJSelecBeneficiaries[nPosicao]["client"]["code" ] - Código do cliente e loja
//oJSelecBeneficiaries[nPosicao]["client"]["name" ] - Nome do cliente
//oJSelecBeneficiaries[nPosicao]["client"]["email"] - e-mail do cliente

    

12. Inserção de Dados na Tabela de Contatos Realizados (BRZ)

Dependendo da quantidade de contatos que precisam ser registrados — como no caso do envio de e-mails em massa para diversos beneficiários, onde é necessário gerar um registro de contato para cada envio —, é comum que customizações precisem lidar com essa geração em larga escala.

Para facilitar esse processo, criamos uma solução simplificada que exige apenas os dados dinâmicos obrigatórios a serem gravados. Essa abordagem reduz a complexidade e torna o processo mais ágil.

Utilizamos um conjunto de métodos desenvolvidos com foco em objetividade e performance, tendo como base a classe FWBulk, que permite inserções em massa com alta eficiência.


Bloco de código
languageyml
themeRDark
titleExemplo de Utilização
linenumberstrue
//Instancia a classe de serviços
oMonitorService := totvs.protheus.health.delinquency.monitor.DelinquencyService():New()

// Cria o objeto bulk
oMonitorService:createBulkContact()

For nSendMail := 1 To 100

	//Nesse momento os dados são gravados em um objeto mas serão efetivamente gravados na tabela quando somar 1000 registros inseridos no objeto
	//ou a cada execução do método flushBulkContact
   self:oMonitorService:insertDataBulkContact("00010001123456011", "01", "E-mail enviado para o beneficiário")
Next

//efetua a gravação dos dados contidos no objeto na tabela BRZ
oMonitorService:flushBulkContact()


Sintaxe

DelinquencyService:insertDataBulkContact(< cBenefRegister >, < cTypeContact >, < cDescriptionContact >)

Parâmetros

Nome

Tipo

Descrição

Obrigatório

cBenefRegister CaracterMatrícula do beneficiário que será registrada no campo Matrícula (BRZ_MATRIC).X
cTypeContact CaracterCódigo do tipo de contato, conforme a tabela genérica SX5 (código TY), que será registrado no campo Origem Cont. (BRZ_ORICON).X
cDescriptionContact CaracterDescrição do contato que será registrada no campo  Motivo (BRZ_MOTIVO).X

Retorno

Nome

Tipo

Descrição

lRet

booleano

true - Em caso de sucesso.

false - Em caso de erro.

Nota

Ambos os métodos retornam true em caso de sucesso e false em caso de falha. Quando ocorre um erro, o sistema registra os detalhes no arquivo de log monitorInadimplencia.log, localizado no diretório logpls.


Os campos abaixo serão gravados da seguinte forma a cada inserção de dados no objeto através do método insertDataBulkContact:

Cont. Conf? (BRZ_CNFCON) - Por padrão será gravado com o valor 0 (Recebimento não confirmado).

Data Contato (BRZ_DATCON) - Irá gravar a data em que o registro foi gerado. 

Hora Contato (BRZ_HORCON) - Irá gravar a hora em que o registro foi gerado. 

Data Criação (BRZ_DATCRI) - Irá gravar a data em que o registro foi gerado. 

Hora Criação (BRZ_HORCRI) -  Irá gravar a hora em que o registro foi gerado. 

13. Consulta a Tabelas Temporárias

Os dois grids (beneficiários e títulos) utilizam tabelas temporárias. Para ter acesso utilizando a sintaxe ADVPL, use o alias BENEINAD (beneficiários) e BENEFINA (títulos).

Bloco de código
languageyml
themeRDark
titleExemplo de Utilização
linenumberstrue
cMatricula := BENEINAD->(BA1_CODINT + BA1_CODEMP + BA1_MATRIC + BA1_TIPREG + BA1_DIGITO)
cTitulo    := BENEFINA->E1_NUM 


Os campos disponíveis na tabela temporária BENEINAD são:

  • BA1_NOMUSR – Nome completo do beneficiário.

  • BA1_NOMSOC – Nome social do beneficiário (caso aplicável).

  • BA1_CODINT – Código da operadora ou entidade interna.

  • BA1_CODEMP – Código da empresa.

  • BA1_MATRIC – Matrícula da família do beneficiário.

  • BA1_TIPREG – Tipo de registro (ex: titular, dependente, etc.).

  • BA1_DIGITO – Dígito verificador da matrícula.

  • BA1_CONEMP – Código do contrato associado à família.

  • BA1_VERCON – Versão do contrato.

  • BA1_SUBCON – Código do subcontrato).

  • BA1_VERSUB – Versão do subcontrato.

  • BA1_MATANT – Matrícula anterior da família.

  • BA1_EMAIL – E-mail de contato do beneficiário.

  • BA3_CODCLI – Código do cliente associado à família.

  • BA3_LOJA – Código da loja do cliente.

  • BA3_DATBAS – Data de inclusão da família no sistema.

  • BA3_COBNIV – Indica se a cobrança é feita no nível da família.

Os campos disponíveis na tabela temporária BENEFINA são:

  • E1_VENCTO – Data de vencimento do título.

  • E1_EMISSAO – Data de emissão do título.

  • E1_VENCREA – Data de vencimento real.

  • E1_PREFIXO – Prefixo do documento.

  • E1_NUM – Número do documento.

  • E1_PARCELA – Número da parcela do título.

  • E1_TIPO – Tipo do título (ex: duplicata, boleto, etc.).

  • E1_VALOR      – Valor total do título.

  • E1_MESBASE – Mês de referência relacionado ao título.

  • E1_ANOBASE – Ano de referência relacionado ao título.

  • E1_PLNUCOB – Código do lote de cobrança em que o título foi gerado.

  • E1_CONEMP – Código do contrato da empresa.

  • E1_VERCON – Versão do contrato.

  • E1_SUBCON – Código do subcontrato.

  • E1_VERSUB – Versão do subcontrato.

  • E1_CLIENTE – Código do cliente relacionado ao título.

  • E1_LOJA – Código da loja do cliente.

  • BM1_CODINT – Código da operadora ou entidade interna.

  • BM1_CODEMP – Código da empresa.

  • BM1_MATRIC – Matrícula do beneficiário.

  • BM1_TIPREG – Tipo de registro do beneficiário.

  • BM1_DIGITO – Dígito verificador da matrícula.

  • BM1_MATUSU – Código do usuário relacionado à matrícula.

Em casos em que os dados das tabelas temporárias precisem ser utilizadas diretamente em uma query, em um join com outra tabela do sistema por exemplo, se faz necessário informar o nome real da tabela no banco de dados, pois o alias não funciona para tabelas temporárias. Dessa forma, disponibilizamos dois métodos que basicamente retornam o nome real das tabelas temporárias de beneficiário e do financeiro naquele momento (o nome muda dinamicamente a cada execução da rotina ou atualização da tela).

Sintaxe (tabela beneficiários BENEINAD)

DelinquencyService:realNameBeneficiaries()


Retorno

Nome

Tipo

Descrição

cAlias

Caracter

Retorna o nome real da tabela temporária no banco de dados.

Bloco de código
languageyml
themeRDark
titleExemplo de Utilização
linenumberstrue
cRealTable := totvs.protheus.health.delinquency.monitor.DelinquencyService():realNameBeneficiaries()
oExecQuery := FWExecStatement():New()

//não é necessário utilizar o campo D_E_L_E_T_ pois a temporária possui apenas registros ativos
cSQL := " SELECT *"
cSQL += " FROM " + cRealTable

oExecQuery:SetQuery( cSQL )

cAliasTemp := oExecQuery:OpenAlias()


Sintaxe (tabela de Titulos BENEFINA)

DelinquencyService:realNameInvoices()

Retorno

Nome

Tipo

Descrição

cAlias

Caracter

Retorna o nome real da tabela temporária no banco de dados

Bloco de código
languageyml
themeRDark
titleExemplo de Utilização
linenumberstrue
cRealTable := totvs.protheus.health.delinquency.monitor.DelinquencyService():realNameInvoices()
oExecQuery := FWExecStatement():New()

//não é necessário utilizar o campo D_E_L_E_T_ pois a temporária possui apenas registros ativos
cSQL := " SELECT *"
cSQL += " FROM " + cRealTable

oExecQuery:SetQuery( cSQL )

cAliasTemp := oExecQuery:OpenAlias()

cTitulo := (cAliasTemp)->E1_NUM

14. Ambiente Com Banco de Dados Oracle

O monitor de inadimplência utiliza tabelas temporárias para armazenar tanto os dados dos beneficiários quanto os títulos em aberto. No entanto, o banco de dados Oracle possui uma particularidade: os dados inseridos em uma tabela temporária durante uma seção não ficam visíveis em outras sessões.

Por esse motivo, quando for necessário acessar os dados para depuração ou implementar pontos de entrada, deve-se configurar o parâmetro MV_DEBMONT como true (.T.). Quando esse parâmetro está ativado — e somente no Oracle — são criadas duas tabelas físicas:

  • BENEFINA_COPY, com os dados dos beneficiários (grid superior)

  • BENEINAD_COPY, com os títulos em aberto (grid inferior esquerdo).

Essas tabelas são recriadas sempre que a rotina é encerrada e reaberta. Além disso, qualquer novo filtro ou atualização também provoca a exclusão e recriação das tabelas com os dados atualizados.

Nota
  • O uso dessa funcionalidade pode impactar negativamente a performance da rotina, portanto, deve ser utilizado com cautela.

  • Essas tabelas são cópias das tabelas temporárias geradas no momento da execução da rotina. Portanto, qualquer alteração feita diretamente nelas não será refletida nas tabelas temporárias utilizadas internamente pela seção criada pelo programa para manipulação dos dados.

04. DEMAIS INFORMAÇÕES

Atualização do Dicionário de Dados

inclusão de itens da tabela BRZ no Arquivo SX3:

Campo

Tipo

Tamanho

Decimal

Titulo

Descrição

Picture

Validação

Relação

F3

Trigger

Usado

Obrigatório

Exibe Browser

Visual

Contexto

CBox

Inicializa Browse (INIBRW)

Help

BRZ_FILIALCaracter80

Filial    

Filial do Sistema




SimNãoNão



Filial do Sistema  

BRZ_CNFCONCaracter10

Cont. Conf ?  

Confirma contato?

"0"

SimSimSimAlteraReal0=Recebimento Não Confirmado;1=Recebimento Confirmado

Indica se o recebimento do contato foi confirmado, conforme o meio de comunicação utilizado.

BRZ_DATCONData80

Data Contato

Data de contato




SimSimSimAlteraReal

Data em que o contato com o beneficiário foi realizado.

BRZ_HORCONCaracter  50

Hora Contato

Hora de contato99:99VAZIO() .OR. validateTimeFormat(M->BRZ_HORCON)


SimSimSimAlteraReal

Hora em que o contato foi realizado.

BRZ_ORICONCaracter20

Origem cont.

Origem do contato99VAZIO() .OR. ExistCpo("SX5","TY"+M->BRZ_ORICON)
TY    SSimSimSimAlteraReal

Origem do contato.

BRZ_ORIDESCaracter300

Desc. Origem

Descrição origem

If( !EMPTY(M->BRZ_ORICON), FWGetSX5( "TY", M->BRZ_ORICON)[1][4], "")

SimNãoSimVisualVirtual
If( !EMPTY(M->BRZ_ORICON), FWGetSX5( "TY", M->BRZ_ORICON)[1][4], "") 

Descrição da origem.

BRZ_MATRICCaracter170

Matrícula

Matrícula beneficiário

BENEINAD->(BA1_CODINT + BA1_CODEMP + BA1_MATRIC + BA1_TIPREG + BA1_DIGITO)

SimNãoNãoVisualReal
BENEINAD->(BA1_CODINT + BA1_CODEMP + BA1_MATRIC + BA1_TIPREG + BA1_DIGITO)

Matrícula completa do beneficiário.

BRZ_NOMUSRCaracter700

Beneficiário

Nome beneficiário

If( !EMPTY(M->BRZ_MATRIC), POSICIONE("BA1",2,XFILIAL("BA1")+M->BRZ_MATRIC, "BA1_NOMUSR"), "")

SimNãoNãoVisualReal
BENEINAD->BA1_NOMUSR

Nome do beneficiário.

BRZ_MOTIVOMemo2540

Mot. Contato

Motivo do contato




SimSimNãoAltera Real

Motivo do contato.

BRZ_DATCRIData80

Data Criação

Data de criação

dDataBase

SimNãoSimVisualReal

Data de criação do registro.

BRZ_HORCRICaracter80

Hora Criação

Hora criação

TIME()

SimNãoSimVisual Real

Hora de criação do registro.