Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|
Índice |
---|
Especificação | |||
Produto | TOTVS | Módulo | EAI |
Segmento Executor | Framework | ||
Projeto1 | DEAI1 | IRM/EPIC1 | |
Requisito/Story/Issue1 | DEAI1-2657 | Subtarefa1 | DEAI1-2648 |
Chamado/Ticket2 | |||
País | ( ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colombia ( X ) TODOS. | ||
Outros | <Caso necessário informe outras referências que sejam pertinentes a esta especificação. Exemplo: links de outros documentos ou subtarefas relacionadas>. |
Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos).
Documentar a relação entre um Adapter e sua Mensagem no padrão TOTVS de Mensagem Única.
Informações | ||
---|---|---|
| ||
Este documento leva em consideração que o leitor tenha um conhecimento prévio da mensagem padronizada TOTVS. Caso algum termo não esteja suficientemente descrito aqui, recomenda-se consultar o documento Entendendo a Mensagem Padronizada. |
Com a padronização das integrações entre os ERPs da TOTVS, foi definida uma mensagem única que estabelece algumas diretrizes que devem ser seguidas por todas as linhas que operem integrações dentro do ecossistema TOTVS.
Os termos "DEVE", "NÃO DEVE", "REQUERIDO", "PODE", "NÃO PODE", "DEVERIA", "NÃO DEVERIA", "RECOMENDADO", "NÃO RECOMENDADO" e "OPCIONAL" devem ser interpretados como descritos na BCP-14, RFC-2119 e RFC-8174.
Em termos gerais, ficou definido que cada mensagem única deva ter um único adapter, para cada ERP envolvido, ou seja, o relacionamento entre a mensagem e o adapter é de um para um.
Todas as linhas deverão adequar seus adapters para que não exista mais de um código fonte relacionado a uma mesma mensagem padronizada.
Desta forma garantiremos que não haverão conflitos nos EAIs, como ter mais de um adapter processando uma mesma mensagem padronizada para cenários distintos.
A dinâmica envolvida no processamento de mensagens (envio e recebimento) pode ser entendida como similar ao funcionamento de um serviço, onde cada endpoint com seu nome único é um ponto de entrada da mensagem padronizada e o adapter é o seu serviço.
Por sua definição, cada mensagem padronizada é considerada como um serviço, similar a uma API REST, e assim sendo, deve possuir apenas um ponto de entrada. Seguindo esta analogia, o adapter é o equivalente ao código da API, que deve ser único.
Os adapters deverão Todos os adapters poderão estar preparados para orquestrar chamadas internas com base no conteúdo de negócio da mensagem e de acordo com a necessidade de cada linha. Esta orquestração não pode ser exposta para quem está consumindo os adaptersas suas regras.
O EAI é um sistema de roteamento de mensagens entre os ERPs da TOTVS, não compete a este sistema, analisar o conteúdo de negócio de cada mensagem afim de roteá-la para um ou outro adapter de acordo com o cenário de negócio de cada mensagem padronizada, esta dinâmica de funcionamento . O adapter equivalente será identificado com base no conteúdo do cabeçalho da mensagem. A orquestração da chamada de rotinas compete ao segmento que implemente o adapter e este deverá orquestrar o tratamento da regra de negócio específica para cada cenário distinto que uma mensagem padronizada possa apresentaras implementará internamente no adapter.
A estrutura básica de uma integração se dá com as seguintes entidades.
Informações | ||
---|---|---|
| ||
Cenário de processamento de notas fiscais (mensagem INVOICE) Atualmente a mensagem é utilizada para tratar duas situações
O erro de negócio ocorre por existirem dois adapters lidando com uma mesma mensagem. A solução para este cenário é que exista apenas um código fonte relacionado ao adapter INVOICE em todas as linhas, orquestrando a chamada para a rotina A, que lida com a Situação 1 ou a rotina B, que lida com a Situação 2, de acordo com o conteúdo de negócio da mensagem. |
Informações | ||
---|---|---|
| ||
Cenário de renegociação de financiamento Foi criado um contrato de financiamento de 12 parcelas, onde 6 já foram pagas e o cliente deseja renegociar o contrato para quitar o restante em 8 parcelas. Para que esta renegociação seja efetuada, 3 passos devem ser executados, sendo eles:
A solução para este cenário é que exista apenas um código fonte relacionado ao adapter de renegociação de contrato em todas as linhas, orquestrando a chamada para as rotinas de baixa, cancelamento e criação de contrato para realização da renegociação do contrato. |
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|