¶ 1. Visão Geral
Nosso sistema de notificações do T6 permite visualizarmos com uma ampla gama de detalhamento as execuções realizadas, como cargas de dados, publicações do cubo e processos do workflow. Possibilitando visualizar o status da execução, o horário detalhado de início e fim e o tempo total da execução, e, em caso de erros durante a execução, será exibida a listagem dos erros, possibilitando selecionar um erro específico e verificar seu detalhamento.
¶ 2. Funcionalidades
Dentre as novas funcionalidades adicionadas no sistema de notificações, estão:
- Detalhamento completo da ação disparada;
- Possibilidade de cancelar um processo que está rodando com falha e corrigi-lo antes da conclusão;
- Possibilidade de fazer o download do arquivo de carga de dados utilizado
- Exibição de barra de status, exibindo a porcentagem até a conclusão;
- Raia com possíveis ações, que serão diferente a depender da ação disparada.
- Notificações customizadas, onde o usuário pode criar uma notificação com uma mensagem personalizada para um grupo de usuários ou um usuário específico.
- Menções de usuários através das Notificações.
¶ 3. Utilização
Para utilizarmos o sistema de notificações, precisaremos realizar uma ação que gere uma notificação, a partir de uma carga de dados, uma publicação do cubo ou realizar um processo do workflow.
Ao clicarmos em 
no canto superior da tela do T6, será exibido um panel na lateral com a listagem das notificações geradas pelo sistema e uma barra de status com a porcentagem executada, dentre elas teremos algumas possibilidades:
: Será exibido caso a ação disparada esteja sendo executada sem nenhuma falha até o momento;
: Será exibido caso a ação disparada seja executada e finalizada com sucesso;
: Será exibido caso a ação disparada esteja sendo executada com falhas;
: Será exibido caso a ação disparada tenha sido executada e finalizada, porém com falhas;
: Será exibido caso a a ação disparada tenha um ou mais erros que impossibilitam a sua execução e finalização.
Ao clicarmos em uma notificação, será aberta uma nova aba no T6, exibindo o detalhamento completo da ação disparada.
No caso de um erro que impossibilite a execução, a aba aberta exibirá, o título da ação disparada; uma breve explicação informando que a execução não foi realizada por erro; qual usuário disparou a ação; o status de erro; a data e hora detalhada de início da execução e um quadro informando o detalhamento do erro.
Se a notificação de erro for direcionada a um usuário Gestor ou Administrador, será exibida a stacktrace do erro, possibilitando uma análise mais detalhada do erro ocorrido. Caso contrário, será exibida uma mensagem de erro orientando o usuário a entrar em contato com o administrador, sem exibir a stacktrace do erro.
¶ 3.1. Publicação do Cubo
Ao publicarmos o cubo após a criação de uma ou mais fórmulas, o sistema exibirá uma notificação. Ao clicarmos na notificação, será aberta uma nova aba, na qual podemos visualizar o detalhamento das ações realizadas pelo sistema ao publicarmos o cubo.
Neste tela temos:
- O nome da ação realizada;
- O usuário que disparou tal ação;
- O status da ação;
- Data e hora em que a ação foi realizada pelo usuário;
- Data e hora em que a ação foi finalizada;
- Duração total para conclusão da ação;
No caso das fórmulas, temos também os seguintes cards informativos:
Conforme o exemplo acima, em cada card temos:
- No canto superior esquerdo, uma numeração informando o valor anterior à publicação que gerou a notificação;
- No centro do card teremos o valor atual no momento da publicação e ao lado deste valor teremos 3 possibilidades:
- Caso o valor não tenha sofrido alteração, o card ficará amarelo e com um traço, representando que não houveram alterações naquele valor ao publicarmos o cubo;
- Caso haja acréscimo no valor, o card ficará vermelho e com uma seta apontando para cima, representando que houve um acréscimo naquele valor ao publicarmos o cubo, que afeta o desempenho do sistema de forma negativa;
- Caso haja redução no valor, o card ficará verde e com uma seta apontando para baixo, representando um decréscimo no valor ao publicarmos o cubo, que afeta o desempenho do sistema de forma positiva;
Para mais informações quanto às fórmulas no T6, acesse: Fórmulas e Funções
Logo abaixo, temos uma listagem com todos os passos realizados pelo sistema ao publicarmos o cubo, e ao lado de cada passo temos o tempo de duração de cada ação, representados em milissegundos;
¶ 3.2. Carga de Dados
Ao executarmos uma carga de dados, o sistema exibe uma notificação. Ao clicarmos na notificação, é aberta uma nova aba, na qual podemos visualizar o detalhamento das ações realizadas pelo sistema ao executarmos a carga de dados.
Em caso de sucesso, a tela exibirá somente:
- O nome da ação realizada;
- O usuário que disparou tal ação;
- O status da ação;
- Data e hora em que a ação foi realizada pelo usuário;
- Data e hora em que a ação foi finalizada;
- Duração total para conclusão da ação;
- Botão para download do arquivo utilizado para a carga de dados
Em caso de execução concluída com falha por erro no mapeamento, além dos itens citados anteriormente, teremos também:
Um card onde está informado o nome do mapeamento realizado, o código de erro gerado, e um botão Corrigir mapeamento:
Ao clicarmos em Corrigir mapeamento seremos direcionados para uma nova aba no T6, contendo o formulário de dados utilizado para a carga de dados, permitindo fazermos as correções necessárias no formulário.
Podemos também fazer as alterações através do arquivo CSV utilizado para a carga, corrigindo as linhas que geraram erros e executando a carga novamente.
Logo abaixo do card, temos uma listagem das falhas encontradas na execução da carga de dados e seu detalhamento;
¶ 3.3. Processos do Workflow
Ao atribuir uma task do Workflow a um usuário o sistema exibe uma notificação na qual o usuário é informado que uma tarefa foi atribuída a ele. Ao clicarmos na notificação, é aberta uma nova aba, onde será exibido o nome do objeto associado à tarefa, o tempo restante para a conclusão da tarefa e a data em que a tarefa foi atribuída ao usuário.
Ao clicar na tarefa, o usuário é redirecionado para o objeto associado à tarefa, onde poderá realizar as ações necessárias e concluir ou recusar a tarefa.
¶ 4. Notificações Customizadas
Nos dá a possibilidade de um usuário poder enviar uma mensagem a um grupo de usuários, ou, a um usuário específico quando está realizando uma atividade, com isso, podemos criar uma notificação onde podemos colocar qualquer informação e não somente as da aplicação.
Nossas notificações ficam salvas em tabelas do banco de dados que iniciam com REP_NOTIFICATION, as informações que ficam armazenadas na tabela REP_NOTIFICATION são as informações gerais de uma notificação.
Na tabela REP_NOTIFICATION temos as seguintes colunas:
| Coluna | Descrição | Valor |
|---|---|---|
codNotification |
Identificador incremental, o qual é gerado automaticamente ao gerar uma notificação | - |
codNotificationType |
Identificador de notificação que vem da tabela REP_NOTIFICATION_TYPE |
cubepublish = 1; error = 2; scenariocopy = 3; workflowstarter = 4; system = 5; workflowaction = 6; powerbi = 7; custom = 8 |
flgState |
Estado da notificação | Unknown = 0; Running = 1; Finished = 2; Canceled = 3; Error = 4; Stopped = 5 |
codUser |
Identificador do usuário que criou a notificação | - |
dscObjectID |
Identificador de objeto que está associado à notificação | - |
dscObjectName |
Nome do objeto que está associado à notificação | - |
dscTitle |
Título da mensagem exibida na notificação | - |
dscMessage |
Corpo da mensagem exibida na notificação | - |
dscDetails |
Detalhes da mensagem exibida na notificação | - |
datStart |
Data de início da notificação | - |
datEnd |
Data de finalização da notificação | - |
Temos também a tabela REP_NOTIFICATION_USER, na qual podemos informar qual usuário gostaríamos que fosse notificado para a notificação criada.
Em uma notificação customizada nós vamos preencher um registro na tabela REP_NOTIFICATION e um registro, ou mais, na tabela REP_NOTIFICATION_USER.
¶ 4.1. Como Funciona a Entrega das Notificações
As notificações customizadas são entregues em tempo real utilizando SignalR, uma conexão persistente mantida entre o navegador do usuário e o servidor do T6.
Quando a API de notificação é chamada:
- O servidor consulta a tabela
REP_NOTIFICATION_USERpelos destinatários que ainda não leram a notificação; - Para cada destinatário, verifica se o usuário possui uma conexão SignalR ativa (uma sessão de navegador aberta na aplicação T6);
- Se o usuário estiver conectado, o servidor envia uma mensagem de push instruindo o cliente a atualizar sua lista de notificações;
- Se nenhum destinatário definido estiver conectado no momento, nenhum push em tempo real é realizado via SignalR — não há overhead adicional para a aplicação; as notificações permanecem registradas no banco e serão exibidas normalmente quando o usuário se conectar ou atualizar a lista.
O usuário será notificado somente uma vez. Após ler a notificação, ela não será exibida novamente.
¶ 4.2. Inserindo Notificações Customizadas
Para inserirmos uma notificação customizada, vamos precisar acessar nosso banco de dados e realizar uma inserção na tabela REP_NOTIFICATION, por exemplo:
INSERT INTO REP_NOTIFICATION (codNotificationType, flgState, codUser, dscObjectID, dscObjectName, dscTitle, dscMessage, dscDetails, datStart, datEnd)
VALUES
(8, 2, 1, NULL, NULL, 'Título de Exemplo', 'Exemplo do corpo da mensagem na notificação', 'Exemplo de detalhes', GETUTCDATE(), GETUTCDATE())
E precisaremos também realizar uma inserção na tabela REP_NOTIFICATION_USER, por exemplo:
INSERT INTO REP_NOTIFICATION_USER (codNotification, codUser)
SELECT TOP 1 codNotification AS codNotification, 1 AS codUser FROM REP_NOTIFICATION ORDER BY codNotification DESC
Sempre que formos criar uma notificação customizada, precisamos primeiro fazer o INSERT na tabela
REP_NOTIFICATIONpara termos o código da notificação que utilizaremos no INSERT da tabelaREP_NOTIFICATION_USER.
¶ 4.3. Chamando a Notificação Customizada
O usuário será notificado somente uma vez, assim que a notificação for lida pelo usuário, o mesmo não receberá mais a mesma notificação.
Para chamar a notificação, utilizaremos a seguinte API: .../API/Notification/Notify?notificationCode=****, onde os **** serão substituídos pelo código da notificação que criamos anteriormente.
A notificação somente será gerada para os usuários definidos no INSERT da tabela REP_NOTIFICATION_USER que estejam logados no momento da chamada da API, caso não tenha nenhum usuário logado no momento da chamada, a notificação simplesmente não será entregue, até que um dos usuários definidos faça login no T6.
A Notificação customizada será exibida da seguinte forma:
Ao clicarmos sob a notificação, teremos um maior detalhamento, exibindo o usuário que disparou a notificação, a data de início e a data de finalização:
¶ 5. Menção de Usuários através das Notificações
Usuários podem ser mencionados em notificações customizadas utilizando a sintaxe @nomeusuario no campo dscMessage da tabela REP_NOTIFICATION.
Usuários podem receber notificações de menção através de detalhes em células de um formulário, onde o usuário é mencionado utilizando a sintaxe @nomeusuario dentro do detalhe da célula.
Ao ser mencionado, o usuário receberá uma notificação do tipo Menção seguido no nome do objeto onde o usuário foi mencionado, por exemplo, se o usuário for mencionado em um detalhe de célula de um formulário do cubo uma notificação semelhante a esta será exibida:
Ao clicar em Visualizar, caso o usuário tenha acesso ao formulário onde foi mencionado, ele será redirecionado para o formulário na célula onde foi mencionado, com o painel de detalhes aberto.
Caso contrário, uma mensagem de erro será exibida informando que o usuário não tem acesso ao objeto onde foi mencionado.
¶ 6. Q&A
Perguntas Frequentes
1. O que é o sistema de notificações do T6?
O sistema de notificação do T6 é um sistema que permite visualizar com detalhamento as execuções realizadas, como cargas de dados, publicações do cubo e processos do workflow, mostrando status, horários de início/fim, tempo total e detalhes de erros.
2. Como acesso as notificações?
Para acessar as notificações no T6, clique no ícone de sino no canto superior da tela do T6 para exibir um painel lateral com a listagem das notificações.
3. Quais são os diferentes status de notificação?
As notificações no T6 podem ter os seguintes status:
Executando;
Sucesso (executada e finalizada com sucesso);
Executando com falha;
Executado com falha;
Erro (impossibilita execução).
4. O que significa cada cor dos cards informativos na notificação exibida após a publicação do cubo?
As cores dos cards informativos na notificação após a publicação do cubo indicam o seguinte:
Amarelo com traço: sem alteração no valor;
Vermelho com seta para cima: acréscimo no valor;
Verde com seta para baixo: decréscimo no valor;
5. O que posso fazer quando uma carga de dados exibe notificação de falha?
Após acessar a notificação, você pode clicar em Corrigir mapeamento para ir ao formulário de dados e fazer correções necessárias, ou corrigir o arquivo CSV utilizado e executar a carga novamente.
6. Posso fazer download do arquivo usado na carga de dados através da notificação?
Sim. Após acessar a notificação, você pode clicar no botão de download disponível para o arquivo utilizado na carga de dados.
7. O que são notificações customizadas?
Notificações customizadas são notificações que permitem a um usuário enviar mensagens personalizadas para grupos de usuários ou usuários específicos, não limitadas apenas às informações da aplicação.
8. Como criar uma notificação customizada?
Para criar notificações customizadas, é necessário inserir registros diretamente nas tabelas do banco de dados, seguindo a estrutura específica descrita na documentação (Notificações Customizadas).
9. Como chamo uma notificação customizada?
Para chamar uma notificação customizada, utilize a API: .../api/Notification/Notify?notificationCode=**** onde **** é o código da notificação criada anteriormente.
10. Quando o usuário recebe a notificação customizada?
Após realizar a chamada da API, caso o(s) usuário(s) alvo esteja(m) logado(s) no momento da chamada, ele(s) será(ão) notificado(s).
Se não houver usuários logados, a notificação não será entregue até que alguém faça login.
11. É possível cancelar um processo em execução através da notificação?
Sim, após acessar a notificação é possível cancelar um processo que está rodando com falha e corrigi-lo antes da conclusão.
12. O que mostra a barra de status na notificação?
Quando a notificação exibe a barra de status, ela mostra a porcentagem de conclusão até a finalização do processo (carga de dados, publicações do cubo, etc.).