Mudanças entre as edições de "Disponibilização de Link de Boleto Financeiro"

De GeoSales
Ir para navegação Ir para pesquisar
 
(19 revisões intermediárias pelo mesmo usuário não estão sendo mostradas)
Linha 17: Linha 17:
  
 
== Solução ==
 
== Solução ==
Será desenvolvida uma evolução na rotina de Títulos do Mobile para consumir o novo campo da tabela SE1 que armazenará o link do boleto financeiro.
+
Será desenvolvida uma evolução na rotina de Títulos do Portal e Mobile para consumir o novo campo da tabela TITULO do ERP que armazenará o link do boleto financeiro.
  
Quando existir um link válido para o título, o Mobile disponibilizará funcionalidades que permitam ao usuário:
+
Quando existir um link válido para o título, o Portal e Mobile disponibilizará funcionalidades que permitam ao usuário:
  
 
* Visualizar o boleto utilizando o navegador padrão do dispositivo;
 
* Visualizar o boleto utilizando o navegador padrão do dispositivo;
* Compartilhar o link do boleto através dos recursos nativos do sistema operacional (WhatsApp, E-mail, SMS ou outros aplicativos compatíveis).
+
* Compartilhar o link do boleto através dos recursos nativos do sistema operacional, em ambiente Web por e-mail e já em Mobile (WhatsApp, E-mail ou outros aplicativos compatíveis).
  
 
A solução utilizará exclusivamente o link disponibilizado pelo ERP, não sendo responsável pela geração, alteração ou armazenamento do boleto.
 
A solução utilizará exclusivamente o link disponibilizado pelo ERP, não sendo responsável pela geração, alteração ou armazenamento do boleto.
Linha 29: Linha 29:
 
A implementação compreenderá as seguintes atividades:
 
A implementação compreenderá as seguintes atividades:
  
* Adequação da integração entre Protheus e Mobile para disponibilização do novo campo da tabela SE1;
+
* Adequação da integração entre ERP e Mobile para disponibilização do novo campo da tabela;
 
* Inclusão do novo atributo no serviço/API responsável pela sincronização dos títulos financeiros;
 
* Inclusão do novo atributo no serviço/API responsável pela sincronização dos títulos financeiros;
 
* Alteração da tela de consulta de Títulos do Mobile para exibição da opção de boleto quando houver link disponível;
 
* Alteração da tela de consulta de Títulos do Mobile para exibição da opção de boleto quando houver link disponível;
Linha 41: Linha 41:
  
 
=== Escopo Incluso ===
 
=== Escopo Incluso ===
* Consumo do novo campo da tabela SE1.
+
* Consumo do novo campo da tabela de titulo.
* Disponibilização do link no Mobile.
+
* Disponibilização do link no Portal e Mobile.
 
* Visualização do boleto através do navegador do dispositivo.
 
* Visualização do boleto através do navegador do dispositivo.
 
* Compartilhamento do link utilizando aplicativos instalados no aparelho.
 
* Compartilhamento do link utilizando aplicativos instalados no aparelho.
Linha 58: Linha 58:
 
* Representante Comercial
 
* Representante Comercial
 
* Supervisor Comercial
 
* Supervisor Comercial
* ERP Protheus
+
* ERP  
 
* API de Integração
 
* API de Integração
* Aplicação Mobile
+
* Aplicação Portal/Mobile
 
* Instituição Financeira (provedora do boleto)
 
* Instituição Financeira (provedora do boleto)
  
 
== Pré-condições ==
 
== Pré-condições ==
 
* O título financeiro deverá existir no ERP.
 
* O título financeiro deverá existir no ERP.
* O campo de link do boleto deverá estar preenchido na tabela SE1.
+
* O campo de link do boleto deverá estar preenchido na tabela Título.
 
* O dispositivo deverá possuir acesso à internet para abertura do boleto.
 
* O dispositivo deverá possuir acesso à internet para abertura do boleto.
 
* O usuário deverá possuir permissão para acessar a rotina de Títulos.
 
* O usuário deverá possuir permissão para acessar a rotina de Títulos.
Linha 75: Linha 75:
 
'''[RN2] -''' Caso o campo do boleto esteja vazio, nenhuma opção de visualização ou compartilhamento deverá ser apresentada.
 
'''[RN2] -''' Caso o campo do boleto esteja vazio, nenhuma opção de visualização ou compartilhamento deverá ser apresentada.
  
'''[RN3] -''' O Mobile apenas consumirá o link disponibilizado pelo ERP, não realizando qualquer validação sobre sua composição.  
+
'''[RN3] -''' O Portal e Mobile apenas consumirá o link disponibilizado pelo ERP, não realizando qualquer validação sobre sua composição.  
  
 
'''[RN4] -''' A visualização do boleto ocorrerá utilizando o navegador padrão do dispositivo.  
 
'''[RN4] -''' A visualização do boleto ocorrerá utilizando o navegador padrão do dispositivo.  
Linha 85: Linha 85:
 
'''[RN7] -''' A funcionalidade não permitirá edição do link pelo usuário.
 
'''[RN7] -''' A funcionalidade não permitirá edição do link pelo usuário.
  
'''[RN8] -''' O comportamento deverá ser compatível com dispositivos Android e iOS, conforme versões suportadas pelo Mobile.
+
'''[RN8] -''' O comportamento deverá ser compatível com portal e dispositivos Android e iOS, conforme versões suportadas pelo Mobile, no caso de ambiente web o compartilhamento por e-mail e no mobile pode ser usado e-mail, WhatsApp, Telegram e outras possibilidades de acordo com o sistema operacional do Smartphone.
  
== Regras de Negócio ==
+
== Regras de Integração ==
  
  
'''[RI1] -''' O ERP Protheus disponibilizará o novo campo contendo a URL do boleto na tabela SE1.
+
'''[RI1] -''' O ERP disponibilizará o novo campo contendo a URL do boleto na tabela TITULO.
  
 
'''[RI2] -''' A API de integração deverá disponibilizar o novo atributo em seu retorno JSON durante a sincronização dos títulos.
 
'''[RI2] -''' A API de integração deverá disponibilizar o novo atributo em seu retorno JSON durante a sincronização dos títulos.
Linha 105: Linha 105:
  
 
== Fluxograma ==
 
== Fluxograma ==
[[Arquivo:Diagrama_disponibilidade_link_boleto.png|800px]]
+
 
 +
'''Fluxo Resumido'''
 +
 
 +
'''1.''' O ERP gera ou recebe o link do boleto e grava o endereço na tabela Titulo.
 +
 
 +
'''2.''' A API de integração disponibiliza o campo de link no retorno dos títulos financeiros.
 +
 
 +
'''3.''' O Mobile sincroniza os títulos e armazena o link do boleto.
 +
 
 +
'''4.''' O usuário acessa a rotina de Títulos.
 +
 
 +
'''5.''' O sistema identifica que o título possui um link de boleto.
 +
 
 +
'''6.''' O usuário pode escolher entre:
 +
 
 +
* Visualizar o boleto, abrindo o navegador do dispositivo; ou
 +
 
 +
* Compartilhar o link utilizando um aplicativo compatível instalado no aparelho.
 +
 
 +
'''7.''' O cliente recebe o acesso ao boleto sem necessidade de uma nova consulta ao ERP.
 +
 
 +
[[Arquivo:Diagrama_disponibilidade_link_boleto.png|1100px]]
  
 
== Aprovação ==
 
== Aprovação ==

Edição atual tal como às 18h26min de 21 de julho de 2026

Histórico de Alterações

Data Quem Comentários
21/07/2026 Renato Lima Criação do documento

Necessidade

A CONTRATANTE está implementando um processo para geração de boletos financeiros por meio de uma instituição financeira, onde o boleto será disponibilizado através de um link armazenado no ERP Protheus.

Para suportar esse novo processo, será criado um campo na tabela SE1 responsável por armazenar a URL do boleto gerado. Entretanto, atualmente o Mobile não disponibiliza essa informação aos usuários da equipe comercial.

A necessidade consiste em evoluir a rotina de Títulos do Mobile para consumir esse campo do ERP, permitindo que o representante comercial visualize o boleto ou compartilhe seu link diretamente com o cliente, reduzindo o tempo de atendimento e facilitando o processo de cobrança.

Solução

Será desenvolvida uma evolução na rotina de Títulos do Portal e Mobile para consumir o novo campo da tabela TITULO do ERP que armazenará o link do boleto financeiro.

Quando existir um link válido para o título, o Portal e Mobile disponibilizará funcionalidades que permitam ao usuário:

  • Visualizar o boleto utilizando o navegador padrão do dispositivo;
  • Compartilhar o link do boleto através dos recursos nativos do sistema operacional, em ambiente Web por e-mail e já em Mobile (WhatsApp, E-mail ou outros aplicativos compatíveis).

A solução utilizará exclusivamente o link disponibilizado pelo ERP, não sendo responsável pela geração, alteração ou armazenamento do boleto.

Implementação

A implementação compreenderá as seguintes atividades:

  • Adequação da integração entre ERP e Mobile para disponibilização do novo campo da tabela;
  • Inclusão do novo atributo no serviço/API responsável pela sincronização dos títulos financeiros;
  • Alteração da tela de consulta de Títulos do Mobile para exibição da opção de boleto quando houver link disponível;
  • Implementação da funcionalidade de abertura do link utilizando navegador externo;
  • Implementação da funcionalidade de compartilhamento utilizando os recursos nativos do dispositivo;
  • Tratamento de situações onde o título não possua boleto disponível.

Documentos relacionados

Escopo

Escopo Incluso

  • Consumo do novo campo da tabela de titulo.
  • Disponibilização do link no Portal e Mobile.
  • Visualização do boleto através do navegador do dispositivo.
  • Compartilhamento do link utilizando aplicativos instalados no aparelho.
  • Tratamento para títulos sem boleto.

Escopo Não Incluso

  • Geração do boleto financeiro.
  • Alterações na instituição financeira.
  • Alterações na lógica financeira do ERP.
  • Armazenamento ou edição do link no Mobile.
  • Controle de expiração ou validade do boleto.
  • Impressão de boletos.

Atores

  • Representante Comercial
  • Supervisor Comercial
  • ERP
  • API de Integração
  • Aplicação Portal/Mobile
  • Instituição Financeira (provedora do boleto)

Pré-condições

  • O título financeiro deverá existir no ERP.
  • O campo de link do boleto deverá estar preenchido na tabela Título.
  • O dispositivo deverá possuir acesso à internet para abertura do boleto.
  • O usuário deverá possuir permissão para acessar a rotina de Títulos.
  • A sincronização entre ERP e Mobile deverá estar concluída.

Regras de Negócio

[RN1] - A funcionalidade será disponibilizada somente para títulos que possuam link de boleto preenchido.

[RN2] - Caso o campo do boleto esteja vazio, nenhuma opção de visualização ou compartilhamento deverá ser apresentada.

[RN3] - O Portal e Mobile apenas consumirá o link disponibilizado pelo ERP, não realizando qualquer validação sobre sua composição.

[RN4] - A visualização do boleto ocorrerá utilizando o navegador padrão do dispositivo.

[RN5] - O compartilhamento utilizará os mecanismos nativos do sistema operacional, respeitando os aplicativos instalados no aparelho.

[RN6] - Caso o link esteja inválido ou indisponível, a mensagem retornada será proveniente do navegador ou da instituição financeira, não sendo tratada pela aplicação Mobile.

[RN7] - A funcionalidade não permitirá edição do link pelo usuário.

[RN8] - O comportamento deverá ser compatível com portal e dispositivos Android e iOS, conforme versões suportadas pelo Mobile, no caso de ambiente web o compartilhamento por e-mail e no mobile pode ser usado e-mail, WhatsApp, Telegram e outras possibilidades de acordo com o sistema operacional do Smartphone.

Regras de Integração

[RI1] - O ERP disponibilizará o novo campo contendo a URL do boleto na tabela TITULO.

[RI2] - A API de integração deverá disponibilizar o novo atributo em seu retorno JSON durante a sincronização dos títulos.

[RI3] - O Mobile deverá armazenar localmente o link recebido juntamente com os demais dados do título.

[RI4] - Durante a sincronização, caso o link seja alterado no ERP, o Mobile deverá atualizar a informação local.

[RI5] - O consumo do novo campo deverá manter compatibilidade com clientes que ainda não possuam a funcionalidade implementada, tratando o campo como opcional.

[RI6] - A integração deverá preservar integralmente a URL recebida, sem alterações ou formatações.

[RI7] - O Mobile deverá abrir exatamente a URL disponibilizada pela integração, sem redirecionamentos ou manipulações adicionais.

Fluxograma

Fluxo Resumido

1. O ERP gera ou recebe o link do boleto e grava o endereço na tabela Titulo.

2. A API de integração disponibiliza o campo de link no retorno dos títulos financeiros.

3. O Mobile sincroniza os títulos e armazena o link do boleto.

4. O usuário acessa a rotina de Títulos.

5. O sistema identifica que o título possui um link de boleto.

6. O usuário pode escolher entre:

  • Visualizar o boleto, abrindo o navegador do dispositivo; ou
  • Compartilhar o link utilizando um aplicativo compatível instalado no aparelho.

7. O cliente recebe o acesso ao boleto sem necessidade de uma nova consulta ao ERP.

Diagrama disponibilidade link boleto.png

Aprovação

Considero aprovada a documentação da funcionalidade especificada acima, e autorizo a implementação da mesma no Sistema GeoSales, em nome da Organização a qual estou vinculado.

GeoSales

Setor Aprovado Por Data
Integração - GeoSales dd/mm/aaaa

Empresa solicitante

Setor Aprovado Por Data Assinatura
Gerente TI - Cliente Pessoa que aprovou 00/00/0000
Gerente de Projeto - Cliente Pessoa que aprovou 00/00/0000
Gerente Comercial - Cliente Pessoa que aprovou 00/00/0000