ER_FRWJOI01-256_Monitor_EAI_Menu_Principal_e_Dashboard

Informações Gerais

Objetivo

Implementar o menu principal do monitor EAI, o qual dará acesso às funcionalidades de monitoramento. Dentre as funcionalidades, será implementada a tela de dashboard, que mostrará, através de gráficos, a situação das mensagens recebidas e enviadas. Este desenvolvimento é parte do projeto de implementação de um monitor de EAI que seja compatível com todas as implementações de EAI (baseados em mensagem única) disponíveis nos principais ERPs TOTVS.

Definição da Regra de Negócio

Visão geral

A TOTVS dispõe de uma plataforma de integração (EAI) entre seus principais produtos que se baseia num conceito chamado "Mensagem Única", que recebe este nome devido o fato das estruturas de dados que trafegam entre os produtos serem as mesmas. Por exemplo, a estrutura de dados referente à entidade "cliente" é a mesma tanto para o ERP Protheus quanto para o ERP Datasul, quando for necessário a integração desta entidade entre ambos.

Entretanto, apesar da estrutura de dados ser a mesma para os ERPs, em relação aos mecanismos que realizam a integração entre os ERPs - os "engines" de EAI - isso não acontece, de forma que cada implementação possui uma forma de configuração e monitoramento. Desta maneira, o gerenciamento de integrações em clientes que possuem ERPs TOTVS de várias linhas (Protheus, RM, Datasul e Logix) exige conhecimento dos detalhes de cada "engine", para que essa tarefa será realizada de maneira eficaz.

Sendo assim, o desenvolvimento presente faz parte de uma iniciativa de padronização da plataforma de EAI nos produtos TOTVS, cujo um dos principais objetivos é justamente reduzir a complexidade no gerenciamento das integrações através da implementação de um conceito único em todas as linhas, começando pelo monitoramento.

O projeto de monitoramento de EAI único está baseado em duas frentes: serviços de monitoramento e interface. A frente relativa a serviços de monitoramento tem por objetivo padronizar as APIs que serão utilizadas para realizar o acompanhamento das mensagens trafegadas entre os ERPs que estiverem integrados utilizando o conceito de Mensagem Única. Com isso, a consulta de mensagens recebidas utilizará um mesmo formato de API, que estará implementado em todas as linhas de produto TOTVS que possuam plataforma de integração. Para saber mais, consulte o link disponível no campo Outros da seção Informações Gerais acima.

A frente relativa à interface tem por objetivo fornecer um local único, para todas as linhas de produto TOTVS, no que diz respeito a monitoramento e configuração da plataforma de integração EAI. O componente de interface utilizará os serviços de monitoramento disponibilizados pelos ERPs para realizar as tarefas previstas.

Menu principal

O menu principal da interface de monitoramento (que de agora em diante, chamaremos "monitor EAI") é o primeiro item a ser realizado. A partir dele será possível acionar as tarefas de monitoramento necessárias para o acompanhamento da integração entre os produtos TOTVS. Posteriormente, ao monitor EAI, serão acrescentadas as funcionalidades de configuração e diagnóstico das integrações.

Os itens que compõem o menu principal são os seguintes:

• Dashboard: proverá um painel com gráficos e dados sumarizados que reflitam o estado da integração em determinado período.
• Transações: totalizará as mensagens recebidas ou enviadas por entidade trafegada (transação).
• Mensagens: listará as mensagens trafegadas entre os produtos, permitindo detalhá-las quando necessário.
• Aplicativo Interno: mostrará dados do aplicativo interno, incluindo as transações que ele suporta.
• Aplicativo Externo: mostrará os aplicativos com os quais o aplicativo interno faz integração.
• Rotas de Envio: exibirá as rotas de envio configuradas entre o aplicativo interno e os aplicativos externos.

Dashboard

A tela de dashboard será a primeira funcionalidade implementada do monitor EAI, a qual proverá as seguintes informações:

• Quantidade de mensagens com erro;
• Quantidade de mensagens pendentes (em processamento);
• Quantidade de mensagens finalizadas;
• Gráfico de mensagens por transação, com erro;
• Gráfico de mensagens por transação, pendentes;
• Gráfico de mensagens por transação, finalizadas;
• Gráfico de mensagens por status;
• Gráfico de mensagens por aplicativo (interno e externos);
• Gráfico de mensagens por contexto;

A tela disporá de filtros que permitirão alterar os valores exibidos conforme a necessidade do usuário. São eles:

• Filtro por aplicativo, que permitirá selecionar o aplicativo remetente das mensagens. Deixando o campo em branco, serão consideradas todas as mensagens, independente do aplicativo de origem.
  
• Filtro por data, que disporá de 4 opções: hoje, 7 dias, 30 dias e informado. Esta última opção permitirá ao usuário informar a data inicial e final do período, desde que este não ultrapasse o total de 30 dias. Não será possível deixar o filtro em branco. O valor padrão será "hoje".
  
• Filtro por contexto, que permitirá selecionar o contexto informado nas mensagens. Deixando o campo em branco, serão consideradas todas as mensagens, independente do contexto informado nelas.

Abaixo segue o detalhamento de como cada informação listada será gerada e mostrada na tela do Dashboard: 

Quantidade de mensagens com erro: corresponde ao total de mensagens do tipo BusinessMessage, enviadas e recebidas, com status igual a malformed, refused, notdelivered, businesserror, cuja data de geração esteja dentro do período informado no filtro por data, e contexto igual ao do respectivo filtro, quando informado.

O valor exibido será a somatória das quantidades retornadas pelo serviço REST /totvseai/monitor/v1/msgs/summary/sending?category=error com as quantidades retornadas pelo serviço /totvseai/monitor/v1/msgs/summary/receiving?category=error. Os resultados dos dois serviços são necessários para compor o valor final.

As URLs das requisições serão complementadas de acordo com os filtros informados pelo usuário conforme segue: 

• &date=<data_inicial>:<data_final>. Os valores em <data_inicial> e <data_final> devem estar de acordo com o filtro selecionado, tendo como referência a data de hoje. Logo, se no filtro for informado "7 dias", <data_inicial> deve conter a data correspondente a hoje menos sete dias. Em <data_final> deve constar a data de hoje. 
• &context=<contexto>. Estará presente quando o usuário selecionar um valor diferente de branco no filtro correspondente. 

Exemplos: 

Mensagens com erro, no período de 7 dias:

• /totvseai/monitor/v1/msgs/summary/sending?category=error&date=2016-09-08:2016-09-15 
• /totvseai/monitor/v1/msgs/summary/receiving?category=error&date=2016-09-08:2016-09-15
  

Mensagens com erro, do contexto "financeiro", na data de hoje (15/09/2016):

• /totvseai/monitor/v1/msgs/summary/sending?category=error&date=2016-09-15:2016-09-15
• /totvseai/monitor/v1/msgs/summary/receiving?category=error&date=2016-09-15:2016-09-15

Quantidade de mensagens pendentes: corresponde ao total de mensagens do tipo BusinessMessage, enviadas e recebidas, com status igual a received, recognized, validated ou delivering, cuja data de geração esteja dentro do período informado no filtro por data, e contexto igual ao do respectivo filtro, quando informado. O valor exibido será a somatória das quantidades retornadas pelo serviço REST /totvseai/monitor/v1/msgs/summary/sending?category=in-process com as quantidades retornadas pelo serviço /totvseai/monitor/v1/msgs/summary/receiving?category=in-process.

As URLs serão complementadas da mesma forma que no item Quantidade de mensagens com erro. Nos respectivos exemplos, o valor em category deve ser substituído por in-process.

Quantidade de mensagens finalizadas: corresponde ao total de mensagens do tipo BusinessMessage, enviadas e recebidas, com status igual a delivered ou processed, cuja data de geração esteja dentro do período informado no filtro por data, e contexto igual ao do respectivo filtro, quando informado. O valor exibido será a somatória das quantidades retornadas pelo serviço REST /totvseai/monitor/v1/msgs/summary/sending?category=success com as quantidades retornadas pelo serviço /totvseai/monitor/v1/msgs/summary/receiving?category=success.

As URLs são complementadas da mesma forma que no item Quantidade de mensagens com erro. Nos respectivos exemplos, o valor em category deve ser substituído por success.

Gráfico de mensagens por transação, com erro: é gerado a partir dos totais retornados pelo serviço /totvseai/monitor/v1/msgs/summary/transactions

Gráfico de mensagens por transação, pendentes:

Gráfico de mensagens por transação, finalizadas:

Gráfico de mensagens por status:

Gráfico de mensagens por aplicativo (interno e externos):

Gráfico de mensagens por contexto:

Detalhes de implementação

O menu principal, assim como todo o monitor EAI, será desenvolvido para plataforma Web, utilizando HTML e JavaScript. Os componentes, visuais e não visuais, serão providos pelo TOTVS HTML Framework, o qual está sendo o fundamento para as novas telas desenvolvidas nos ERPs TOTVS.

Além do conhecimento em HTML e JavaScript, será necessário um certo domínio em CSS, AngularJS e RequireJS, para melhor desempenho na construção das telas.

Opcional

Protótipo de Tela

<Caso necessário inclua protótipos de telas com o objetivo de facilitar o entendimento do requisito, apresentar conceitos e funcionalidades do software>.

Protótipo 01

Opcional

Fluxo do Processo

<Nesta etapa incluir representações gráficas que descrevam o problema a ser resolvido e o sistema a ser desenvolvido. Exemplo: Diagrama - Caso de Uso, Diagrama de Atividades, Diagrama de Classes, Diagrama de Entidade e Relacionamento e Diagrama de Sequência>. 

Opcional

Dicionário de Dados

Arquivo ou Código do Script: AAA – Negociação Financeira / *Versao=CP.2014.12_03*/

(Opcional)

Grupo de Perguntas

<Informações utilizadas na linha Protheus>.

Nome: FINSRF2

(Opcional)

Consulta Padrão

<Informações utilizadas na linha Protheus>

Consulta: AMB

(Opcional)

Estrutura de Menu

<Informações utilizadas na linha Datasul>.

Procedimentos

Programas

Cadastro de Papéis

<O cadastro de papéis é obrigatório para os projetos de desenvolvimento FLEX a partir do Datasul 10>.

<Lembrete: o nome dos papeis em inglês descrito neste ponto do documento, devem ser homologados pela equipe de tradução>.