Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|
Especificação | |||
Produto | TOTVS | Módulo | EAI |
Segmento Executor | Framework | ||
Projeto1 | FRMJOI01 | IRM1 | Evolução EAI |
Requisito1 | FRMJOI01-238 | Subtarefa1 | FRMJOI01-256 |
País | ( X ) Brasil ( ) Argentina ( ) México ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colômbia ( ) Outro _____________. | ||
Outros | ER_FRWJOI01-3_Serviços_para_monitoramento_de_EAI |
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.
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.
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:
A tela de dashboard será a primeira funcionalidade implementada do monitor EAI, a qual proverá as seguintes informações:
A tela disporá de filtros que permitirão alterar os valores exibidos conforme a necessidade do usuário. São eles:
Nota |
---|
O valor informado no filtro de aplicativo não será aplicado aos itens Quantidade de mensagens com erro, Quantidade de mensagens pendentes, Quantidade de mensagens finalizadas, Gráfico com a quantidade de mensagens por status. Na tela, será exibido, junto ao valor do item o texto "Aplicativo ignorado". |
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 "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/sending?category=error
"com as quantidades retornadas pelo serviço
"/totvseai/monitor/v1/receiving?category=error
". Essas URLs serão complementadas. 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:
Exemplos:
Mensagens com erro, no período de 7 dias:
Mensagens com erro, do contexto "financeiro", na data de hoje (15/09/2016):
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/sending?category=in-process com as quantidades retornadas pelo serviço /totvseai/monitor/v1/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/sending?category=success com as quantidades retornadas pelo serviço /totvseai/monitor/v1/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:
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:
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.
<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
<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>.
Arquivo ou Código do Script: AAA – Negociação Financeira / *Versao=CP.2014.12_03*/
Índice | Chave |
01 | <FI9_FILIAL+FI9_IDDARF+FI9_STATUS> |
02 | <FI9_FILIAL+FI9_FORNEC+ FI9_LOJA+FI9_EMISS+FI9_IDDARF> |
03 | <FI9_FILIAL+FI9_FORNEC+ FI9_LOJA+FI9_PREFIX+FI9_NUM+FI9_PARCEL+FI9_TIPO> |
Campo | <AAA_PERESP> |
Tipo | <N> |
Tamanho | <6> |
Valor Inicial | <Varia de acordo com o tipo informado. Por exemplo, quando o campo “tipo” for date, neste campo pode ser informado uma data>. |
Mandatório | Sim ( ) Não ( ) |
Descrição | <Referência Mínima para Cálculo> |
Título | <Ref.Calc.> |
Picture | <@E999.99> |
Help de Campo | <Informar o % que o aluno pagará em dinheiro. Esse % poderá ser alterado durante a negociação> |
<Informações utilizadas na linha Protheus>.
Nome: FINSRF2
X1_ORDEM | 01 |
X1_PERGUNT | Emissão De |
X1_TIPO | D |
X1_TAMANHO | 8 |
X1_GSC | G |
X1_VAR01 | MV_PAR01 |
X1_DEF01 | Comum |
X1_CNT01 | '01/01/08' |
X1_HELP | Data inicial do intervalo de emissões das guias de DARF a serem consideradas na seleção dos dados para o relatório |
<Informações utilizadas na linha Protheus>
Consulta: AMB
Descrição | Configurações de Planejamento |
Tipo | Consulta Padrão |
Tabela | “AMB” |
Índice | “Código” |
Campo | “Código”; ”Descrição” |
Retorno | AMB->AMB_CODIGO |
<Informações utilizadas na linha Datasul>.
Procedimentos
Procedimento |
|
|
|
Descrição | (Max 40 posições) | (Max 40 posições) | (Max 40 posições) |
Módulo |
|
|
|
Programa base |
|
|
|
Nome Menu | (Max 32 posições) | (Max 32 posições) | (Max 32 posições) |
Interface | GUI/WEB/ChUI/Flex | GUI/WEB/ChUI/Flex | GUI/WEB/ChUI/Flex |
Registro padrão | Sim | Sim | Sim |
Visualiza Menu | Sim/Não | Sim/Não | Sim/Não |
Release de Liberação |
|
|
|
Programas
Programa |
|
|
|
Descrição | (Max 40 posições) | (Max 40 posições) | (Max 40 posições) |
Nome Externo |
|
|
|
Nome Menu/Programa | (Max 32 posições) | (Max 32 posições) | (Max 32 posições) |
Nome Verbalizado[1] | (Max 254 posições) | (Max 254 posições) | (Max 254 posições) |
Procedimento |
|
|
|
Template | (Verificar lista de opções no man01211) | (Verificar lista de opções no man01211) | (Verificar lista de opções no man01211) |
Tipo[2] | Consulta/Manutenção/ Relatório/Tarefas | Consulta/Manutenção/ Relatório/Tarefas | Consulta/Manutenção/ Relatório/Tarefas |
Interface | GUI/WEB/ChUI/Flex | GUI/WEB/ChUI/Flex | GUI/WEB/ChUI/Flex |
Categoria[3] |
|
|
|
Executa via RPC | Sim/Não | Sim/Não | Sim/Não |
Registro padrão | Sim | Sim | Sim |
Outro Produto | Não | Não | Não |
Visualiza Menu | Sim/Não | Sim/Não | Sim/Não |
Query on-line | Sim/Não | Sim/Não | Sim/Não |
Log Exec. | Sim/Não | Sim/Não | Sim/Não |
Rotina (EMS) |
|
|
|
Sub-Rotina (EMS) |
|
|
|
Localização dentro da Sub Rotina (EMS) |
|
|
|
Compact[4] | Sim/Não | Sim/Não | Sim/Não |
Home[5] | Sim/Não | Sim/Não | Sim/Não |
Posição do Portlet[6] | 0 – Top Left 1 – Top Right 2 – Bottom Left 3 – Bottom Right | 0 – Top Left 1 – Top Right 2 – Bottom Left 3 – Bottom Right | 0 – Top Left 1 – Top Right 2 – Bottom Left 3 – Bottom Right |
Informar os papeis com os quais o programa deve ser vinculado |
|
|
|
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>.
Código Papel | (máx 3 posições) |
Descrição em Português* |
|
Descrição em Inglês* |
|
[1] Nome Verbalizado é obrigatório para desenvolvimentos no Datasul 10 em diante.
[2] Tipo é obrigatório para desenvolvimento no Datasul 10 em diante
[3] Categorias são obrigatórias para os programas FLEX.
[4] Obrigatório quando o projeto for FLEX
[5] Obrigatório quando o projeto for FLEX
[6] Obrigatório quando o projeto for FLEX
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|