Objetivo
Este documento tem por objetivo auxiliar no entendimento dos processos que ocorrem no Smart Link Client
implementado no produto Datasul
.
Processos:
- Recebimento e Reconhecimento de mensagens.
- Processamento e Geração de mensagens de resposta.
- Publicação de mensagens.
- Envio de mensagens.
- Saneamento de mensagens.
Antes de prosseguir certifique-se que já realizou a leitura da página principal Integração Datasul x Smart Link. Nesta página estão os conceitos principais para entendimento correto dos componentes envolvidos na integração.
Para acompanhamento das mensagens utilize o programa Gerenciador de Mensagens do Smart Link (html.smart-link-manager), sendo especificamente para troca de mensagens entre os componentes Datasul e Smart Link Client
.
O acompanhamento completo da troca de mensagens abrangendo os componentes TOTVS Apps
e Smart Link Server
é por meio de ferramentas administrativas em nuvem TOTVS, que possui acesso restrito.
Recebimento e Reconhecimento de mensagens
O recebimento de uma mensagem ocorrerá através da troca de mensagem entre o Smart Link Server
e o Smart Link Client
. Neste processo é utilizada a estratégia de ACK
e NACK,
indicando para o Smart Link Server
se a mensagem foi reconhecida.
O Smart Link Client
realiza validações iniciais antes de enviar a mensagem para reconhecimento no produto Datasul
.
- Validação da existência da mensagem.
- Validação da existência da configuração
totvs.appserver.
- Configuração obrigatória do serviço que é utilizada para comunicação com o produto
Datasul
.
- Configuração obrigatória do serviço que é utilizada para comunicação com o produto
- Validação da existência do
identificador do tenant.
- Configuração recuperada automaticamente na inicialização do serviço.
- Ocorrendo alguma inconsistência:
- É realizado o envio de mensagem do erro ocorrido para o
Smart Link Server.
- A mensagem é encaminhada para
DLQ (Dead-Letter Queue
)
.
- É realizado o envio de mensagem do erro ocorrido para o
Após as validações serem executadas com sucesso, é realizado o envio da mensagem para reconhecimento no produto Datasul
.
- Mensagem reconhecida:
É enviada ACK
- Mensagem não reconhecida:
- A mensagem é encaminhada para
DLQ (Dead-Letter Queue
)
. - É realizado o envio de mensagem do erro ocorrido para o
Smart Link Server.
- A mensagem é encaminhada para
O reconhecimento de uma mensagem ocorrerá através da troca de mensagem entre o Smart Link Client
e o produto Datasul
, sendo que essa troca de mensagem é realizada diretamente com o Servidor de Aplicação Progress do ambiente Datasul
.
O produto Datasul
realizará suas validações em duas etapas, sendo elas:
Validações de responsabilidade Framework:
- Validação do
Schema
da mensagem. - Validação de integração com
TOTVS Apps
. - Validação de valores requiridos na mensagem.
- Validação do tipo da mensagem.
- Validação da audiência da mensagem, caso a mensagem tenha audiência.
- Validação da existência do objeto de negócio utilizado no reconhecimento da mensagem. Este objeto é desenvolvido pelo segmento responsável pela mensagem.
Validações de responsabilidade Segmentos:
- Validação do conteúdo da mensagem.
- É neste momento que o objeto desenvolvido pelo segmento indica se a mensagem é reconhecida.
Após as validações serem executadas, é retornado o resultado do reconhecimento para o Smart Link Client
, e assim seguindo o fluxo para encaminhamento do resultado para o Smart Link Server
.
No produto Datasul
, a situação da mensagem será Reconhecida ou Não Reconhecida.
Para mais informações sobre situações das mensagens acesse a documentação do programa Gerenciador de Mensagens do Smart Link (html.smart-link-manager)
Acesso restrito aos participantes TOTVS.
Para informações sobre o desenvolvimento de um programa de reconhecimento de mensagem acesse a documentação.
O processamento de uma mensagem ocorrerá através da troca de mensagem entre o Smart Link Client
e o produto Datasul
, sendo que essa troca de mensagem é realizada diretamente com o Servidor de Aplicação Progress do ambiente Datasul
.
- O agendamento automaticamente ocorre a cada 5 minutos no componente
Smart Link Client.
- Somente as mensagens recebidas e que estejam com a situação Reconhecida ou Reprocessar são aptas para processamento.
- Para o processamento que ocorre no produto
Datasul
, é respeitado o usuário e empresa registrado na mensagem recebida. - Caso aconteça alguma inconsistência no processo:
- É realizada a reversão da operação.
- A situação da mensagem é alterada para Processamento com erro.
- O processamento é realizado pelo objeto desenvolvido pelo segmento.
- A geração de uma mensagem de resposta ocorrerá no processamento do objeto desenvolvido pelo segmento.
- Após a operação ser finalizada com sucesso, as mensagens de resposta ficam aguardando o processo de envio de mensagens.
Acesso restrito aos participantes TOTVS.
Para informações sobre o desenvolvimento de um programa processador e gerador de mensagem de resposta acesse a documentação.
Para mais informações sobre situações das mensagens acesse a documentação do programa Gerenciador de Mensagens do Smart Link (html.smart-link-manager)
Publicação de mensagens
A publicação de mensagens é o procedimento utilizado pelas rotinas do produto Datasul para a troca de mensagens com a plataforma TOTVS Apps
.
- A rotina do
Datasul
faz o uso de um método para publicação de mensagem, disponibilizado em uma Classe Framework. - A mensagem publicada é registrada no produto Datasul, tendo a sua situação Reconhecida.
- A mensagem registrada aguarda ser enviada, que acontece no processo de envio de mensagens.
Acesso restrito aos participantes TOTVS.
Para informações sobre o desenvolvimento de um programa publicador de mensagem acesse a documentação.
Envio de mensagens
É o procedimento para realizar o envio das mensagens registradas no produto Datasul
.
- O processo de envio é solicitado pelo componente
Smart Link Client
que possui um agendamento interno do serviço- É executado automaticamente a cada 5 minutos.
- O processo ocorre somente para as mensagens publicadas ou de resposta, e que estejam com a situação Reconhecida ou Reenviar.
- A situação da mensagem é atualizada para Enviada ou Envio com erro.
- Este procedimento é a última etapa da troca de mensagens entre os componentes (
Datasul e Smart Link Client
), deste modo permitindo que a mensagem chegue até ao componenteSmart Link Server
eTOTVS Apps
.
Para mais informações sobre situações das mensagens acesse a documentação do programa Gerenciador de Mensagens do Smart Link (html.smart-link-manager)
Saneamento de mensagens
É o procedimento que ocorre visando eliminar registros de mensagens que atingiram um período de histórico, e contenham alguma das situações permitidas para eliminação.
Situações de mensagens permitidas para eliminação:
- Finalizada.
- Não reconhecida.
- Abandonada.
- Enviada (Somente para mensagem Publicada)
Período de histórico padrão:
- 90 dias.
- Internamente as mensagens são registradas por Data e Tempo.
O processo de saneamento é solicitado pelo componente Smart Link Client
, que possui um agendamento interno do serviço que é executado automaticamente a cada 5 minutos. A execução do saneamento ocorre no produto Datasul
.
Para mais informações sobre situações das mensagens acesse a documentação do programa Gerenciador de Mensagens do Smart Link (html.smart-link-manager)