Interface
Monitoramento de Mensagens.
Interface
A interface possibilita ao usuário realizar operações sobre as mensagens trafegadas no TOTVS | ESB bem como visualizar os indicadores por meio de gráficos. A interface do TOTVS | ESB Monitor está dividida em 4 seções distintas em seqüência de cima para baixo: filtros, gráficos, tabela e barra de botões. A seguir, serão descritas cada uma dessas seções.
Filtros
A área de filtros situa-se no painel superior do TOTVS | ESB Monitor. Trata-se de uma área para configurar parâmetros de busca de mensagens trafegadas no TOTVS | ESB. Os resultados são retornados na tabela situada no painel central. O usuário pode filtrar os dados necessários para fazer a busca de suas respectivas mensagens com a ajuda dos parâmetros: Diagram e Date.
| Campo | Descrição |
|---|---|
| Diagram | Mostra os diagramas criados no by You Studio e carregados pelo TOTVS | ESB. |
| Date | Contêm os campos para data e hora inicial bem como data e hora final. |
Para visualizar as mensagens oriundas do filtro configurado, clica-se no botão Apply situado a direita do painel. É possível configurar outros filtros para uma busca mais detalhada acessando o link Advanced Filter. Ao clicar, abrirá uma tela central contendo os campos listados e descritos abaixo. Para aplicar os parâmetros, deve-se clicar em Apply.
| Campo | Descrição |
|---|---|
| ID | Identificador original da mensagem. |
| UniqueID | Identificador único da mensagem. |
| Component | São os senders dos diagramas. |
| Document Type | Tipo de arquivo que vai receber a mensagem. |
| From | Nome do arquivo STD que busca a informação da origem do documento. |
| To | Nome do arquivo STD que busca a informação de destino do documento. |
| Document Number | Nome do arquivo STD que busca a informação do número do documento. Está relacionado ao tipo da mensagem. Ex.: Se a mensagem for do tipo pedido, o número do documento será o número de pedido. |
| Show Related | Quando selecionamos a opção Persist de algum componente Sender no diagrama, o monitor captura o SourceID de seu Receiver e grava na base de dados para informar o relacionamento entre as mensagens. Sendo assim, quando selecionamos a opção Show Related são mostradas as mensagens relacionadas. |
| Messages Without Out | São mensagens que não originaram outras mensagens. |
Gráficos
Os gráficos servem para obter uma visão geral das mensagens processadas no TOTVS | ESB. São utilizados como indicadores para monitoramento das mensagens e captura de informações relevantes à administração do TOTVS | ESB. Nessa seção tem-se dois gráficos descritos abaixo:
- Messages by period - Trata-se de um gráfico de linhas demonstrando as mensagens trafegadas por período. O período corresponde aos parâmetros aplicados no painel superior e inicialmente assumirá a quantidade de mensagens por data (mensagens/data). Ao clicar no gráfico, o TOTVS | ESB Monitor irá assumir como filtro a data selecionada no gráfico ajustando os outros elementos da tela exibindo as mensagens da nova data. Com o novo filtro acionado, o gráfico em linha exibirá as mensagens da data selecionada por hora (mensagens/hora).
- Messages by status - Trata-se de um gráfico em formato pizza demonstrando o percentual de mensagens trafegadas por status durante um determinado período. O período corresponde aos parâmetros aplicados no painel superior. Ao clicar em uma divisão do gráfico, o TOTVS | ESB Monitor irá assumir como filtro o status de mensagem selecionado no gráfico ajustando os outros elementos da tela exibindo as mensagens no status selecionado. Com o novo filtro acionado, o gráfico exibirá as mensagens para o status selecionado.
Tabela
O painel central contêm uma tabela, ou "Related Messages", possuindo como finalidade mostrar o resultado da busca filtrada em uma planilha de mensagens contendo informações detalhadas. Na parte superior da listagem contêm os botões de paginação possibilitando a navegação nas páginas da tabela. Pode-se clicar um dos números para ir diretamente a página desejada.
Os botões de setas situados nas extremidades esquerda e direita tratam-se de atalhos para a primeira página e a última página, respectivamente. Os botões de setas situados imediatamente à esquerda e direita dos números de páginas são atalhos para página anterior e próxima respectivamente.
Ainda na parte superior, tem-se uma caixa de seleção do número de resultados a serem exibidos na tabela. O usuário poderá escolher uma das opções para visualizar um maior número de mensagens na listagem.
| Nota |
|---|
| Por padrão, são visualizados 10 (dez) mensagens na planilha. |
A cada linha da tabela representa uma mensagem trafegada no TOTVS | ESB. As colunas disponíveis na tabela demonstram informações detalhadas para cada mensagem. As colunas estão discriminadas abaixo.
| Campo | Descrição |
|---|---|
| ID | Número sequencial designado para cada mensagem. |
| Source ID | Código da mensagem que deu origem a mensagem atual (Mensagens Relacionadas). |
| Unique ID | Identificação única para cada mensagem. |
| Status | Status atual da mensagem. |
| From | Campo onde seu valor é designado através da propriedade Origin Document do componente DOCIdentifier no diagrama. |
| To | Campo onde seu valor é designado através da propriedade Target Document do componente DOCIdentifier no diagrama. |
| Document Type | Campo onde seu valor é designado através da propriedade Document Type do componente DOCIdentifier no diagrama. |
| Document Number | Campo onde seu valor é designado através da propriedade Document Number do componente DOCIdentifier no diagrama. |
| Diagram | Nome do Diagrama. |
| Component | Nome do componente. |
| Type | Informações sobre o tipo da mensagem. |
| Received At | Data e hora em que a mensagem foi recebida. |
| Size | Tamanho do arquivo. |
Barra de botões
A barra de botões possibilita ao usuário algumas ações relativas ao controle de mensagens no TOTVS | ESB. Os botões disponíveis são: Details, View, Reprocess, View Error. Ainda na extremidade direita possui opções para exportação dos dados contidos na tabela. A exportação poderá ser realizada em formato das extensões .xls e .pdf. A seguir será demonstrada a funcionalidade de cada botão.
- Details: Exibe uma tela contendo os detalhes da mensagem selecionada. Os campos disponíveis são:
Campo Descrição ID Número sequencial designado para cada mensagem. Status Status atual da mensagem. Type Informações sobre o tipo da mensagem. Document Number Campo onde seu valor é designado através da propriedade Document Number do componente. From Campo onde seu valor é designado através da propriedade Origin Document do componente. To Campo onde seu valor é designado através da propriedade Target Document do componente. Diagram Nome do Diagrama. Component Nome do componente. Date Data e hora em que a mensagem foi recebida.
- View: Mostra o conteúdo da mensagem trafegada no TOTVS | ESB com as informações contidas na tabela abaixo. Caso a mensagem esteja em formato XML, será demonstrado em modo formatado. Se a mensagem estiver mal formada, o visualizador exibe um alerta com informações sobre onde esta a má formação. Através do botão Copy to clipboard é possível copiar o conteúdo da mensagem para a área de memória do sistema operacional.
Campo Descrição Diagram Nome do diagrama. Status Status atual da mensagem. Message Mensagem que é processada pela transação.
- Reprocess: Marca a mensagem selecionada para ser reprocessada pelo TOTVS | ESB.
Nota Quando uma mensagem for reprocessada o TOTVS | ESB reiniciará esse processo a partir do seu ponto inicial no diagrama.
- View Error: Em caso de erros no processamento da mensagem no TOTVS | ESB, a mensagem será marcada com o status de "ERROR" e essa funcionalidade permite visualizar detalhes técnicos.
- Export: Permite exportar a tabela em formato de planilha Excel cuja extensão é .xls facilitando o manuseio das informações. Ainda, é possível exportar a tabela em formato Portable Document Format cuja extensão é .pdf.