Histórico da Página
Índice
| Índice | ||||||
|---|---|---|---|---|---|---|
|
Objetivo
...
Além das notificações padrões da plataforma
| Nota |
|---|
Disponível a partir da versão 1.2.0 do Fluig |
Índice
| Índice |
|---|
Objetivo
A partir da versão 1.2, além das notificações padrão do Fluig, é possível criar novos tipos de notificações customizadas, personalizadas através da API de Notificações do produto.
É possível criar aplicativos, widgets etc., etc que criem e enviem notificações customizadaspersonalizadas, além de fazer este processo através de aplicações externas, utilizando a API Pública do da plataforma Fluig.
Este tutorial tem o objetivo de mostrar passo - a - passo como criar um aplicativo que cria uma notificação customizada e envia para os usuários do da empresa (tenant). Para fazer este mesmo processo através da API Pública do da plataforma Fluig, consulte a documentação clicando aqui. As notificações enviadas pelo aplicativo são exibidas tanto na web, como nos dispositivos móveis.
| Informações | ||
|---|---|---|
| ||
As notificações da plataforma possuem uma limitação de até 600 caracteres. |
Projeto de exemplo
...
Para facilitar o entendimento e desenvolvimento deste tutorial, foi gerado um projeto de exemplo. Neste projeto, foi implementado um aplicativo que cria uma notificação customizada, simulando um aviso do RH Online: "Seu holerit holerite já está disponível". Este projeto é
| Informações |
|---|
Lembrando que este projeto é apenas um exemplo, não |
...
tendo sido implementada nenhuma integração real com o sistema RH Online. |
Para testar o projeto, realizar os seguintes passos:
| Aviso |
|---|
Não executar estes passos em produção! |
...
| Deck of Cards | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
| Nota |
|---|
É recomendada a leitura de todo este material, mesmo |
...
que o desenvolvedor |
...
utilize o projeto de exemplo como base. Este tutorial apresenta conceitos importantes para trabalhar corretamente com notificações dentro do TOTVS Fluig Plataforma. |
...
Entendendo os conceitos para criação de notificações
...
personalizadas
...
Módulos de Notificações
...
Os módulos de notificação são apenas agrupadores, para que as notificações semelhantes se apresentem agrupadas para o usuário.
Os módulos padrão do Fluig TOTVS Fuig Plataforma são:
Colaboração (: notificações de apoiar, comentar, etc), Documentos (notificações .
Documentos: notificações de indicação de leitura, atualização de versão, etc), Processos (notificações .
Processos: notificações de movimentação de processo, tarefas atrasadas, etc) e Portal (notificações .
Portal: notificações de alteração no layout de páginas, etc).
É possível criar novos módulos de notificações. No projeto exemplo, é criado um novo módulo chamado "Notificações de RH".
Eventos de Notificações
...
Antes de criar notificações customizadaspersonalizadas, é importante que fique claro o conceito de "Eventos de Notificações". Um evento é uma representação de alguma ação que pode gerar notificações no na platafdorma Fluig. O evento contém todas as configurações das notificações.
Por exemplo, o evento de notificação "LIKE" possui o formato padrão de todas as notificações do tipo ":
- Fulano curtiu o post
...
- Olha que post bacana...
". Através do evento o usuário pode configurar o recebimento de notificações. Por exemplo: eu posso é possível configurar o recebimento das notificações do tipo "SHARE" por e-mail e SMS, as notificações do tipo "LIKE" apenas pela Central de Notificações do da plataforma Fluig, e não receber nenhuma notificação do tipo "FOLLOW_REQUEST_ACCEPTED".
Para configurar este recebimento, o usuário deve acessar a tela de configurações de notificações:
Para criar notificações customizadaspersonalizadas, é necessário criar novos eventos de notificações. No projeto exemplo, é criado um novo evento chamado "Holerit disponível no RH online".
Atributos de Eventos de Notificações
...
Como dito anteriormente, um evento contém as configurações das notificações. Estas configurações são:
- Requerido: Indica Indica se o usuário pode deixar de receber as notificações relacionadas ao evento. Se o evento for requerido, o usuário deverá obrigatoriamente receber as notificações referentes a ele. Um exemplo de notificação obrigatória é a solicitação de participação em uma comunidade. Obrigatoriamente o moderador da comunidade deve receber todos os pedidos de participação.
- Agrupado: Indica se as notificações daquele evento são agrupadas por objeto. Caso a notificação seja agrupada, o sistema irá exibir assim: "Fulano, Beltrano, Ciclano e mais 5 pessoas apoiaram o post 'Post do Fulano de Tal...'". Caso a notificação não seja agrupada, o sistema gerará uma notificação nova para cada vez que uma ação for gerada sobre um objeto. OBSObservação: Notificações agrupadas não podem ter ações associadas.
- Pode ser removido: Indica se a notificação pode ser removida pelo usuário. Caso não possa, o sistema não deixará o usuário remover a notificação, até que seja executada alguma das ações disponibilizadas.
- Remove após executar uma ação: Se configurada desta forma, após realizar alguma ação, o sistema excluirá automaticamente a notificação. Caso contrário, o sistema exibirá a notificação com uma mensagem informando a ação já executada. Por exemplo: "Fulano que quer seguir você. (Você já aceitou esta requisição)". O sistema então permitirá que o usuário remova aquela notificação.
- Apenas para administradores: Indica se aquele tipo de notificação é exclusivo para administradores do da empresa (tenant).
Notificações
...
As notificações devem ser criadas obrigatóriamente obrigatoriamente com um evento associado. Desta forma a Central de Notificações poderá fazer o gerenciamento de criação, envio e exibição da notificação. As notificações criadas contém alguns objetos associados, que são:
- Usuários que enviaram a notificação: Uma notificação pode ter nenhum, um ou vários usuário usuários que enviaram a enviaramnotificação. Na criação da notificação pode ser informado nenhum ou um usuário que está enviando. Caso a notificação seja agrupada, a Central de Notificações fará o agrupamento automaticamente.
- Objeto associado: Uma notificação pode ter ou não um objeto associado. O objeto pode ser um post, um documento, ou qualquer objeto existente dentro ou fora do sistema. Na criação da notificação pode ser informado ou não um objeto associado.
- Lugar onde foi gerada: Uma notificação pode conter ou não a informação de onde ela foi gerada. Um lugar pode ser uma comunidade, um processo, ou qualquer lugar existente dentro ou fora do sistema. Na criação da notificação pode ser informado ou não um lugar associado.
- Ações: São as ações disponibilizadas por uma notificação. Confira a seguir uma documentação detalhada.
- Metadados: São dados do tipo chave-valor que podem ser associados à notificação. Eles podem ser utilizados por aplicativos customizados de envio de notificações.
Ações de Notificações
...
Uma notificação pode disponibilizar uma ou mais ações. Estas ações são informadas no momento da criação da notificação. As ações são individuais por notificação, não sendo associadas ao evento relacionado a à ela. As ações possuem os seguintes atributos:
- Tipode integração: Indica o tipo de integração que será utilizado para executar aquela ação. Atualmente o a plataforma Fluig suporta três tipos de integraçãointegrações:
- JMS: Ao executar aquela ação o sistema irá disparar uma mensagem JMS com os dados da ação. A mensagem JMS disparada é do tipo "EXECUTE_ALERT_ACTION_EVENT". Cabe ao desenvolvedor implementar uma rotina que se conecte ao tópico "TOTVSTechIntegrationListenerTopic", ouça estas mensagens e execute efetivamente as ações.
- HTTP: Ao executar aquela ação, o sistema fará uma chamada HTTP a uma URL cadastrada no momento da criação da notificação. Os métodos HTTP suportados atualmente são GET e POST. Cabe ao desenvolvedor disponibilizar um serviço que responda naquela URL e execute efetivamente a ação.
- NONE: Ao executar aquela ação o sistema a marcará como executada, mas não realizará nenhuma ação.
- Tipo: Existem atualmente dois tipos de ação.ações:
- MAIN: É a ação principal. O sistema exibirá na Central de Notificações esta ação como ação de destaque.
- DEFAULT: É uma ação padrão. O sistema exibirá como ação comum, sem destaque.
Utilizando a API de Notificações para criar eventos customizados
...
Existem duas formas de utilização da API de Notificações do TOTVS Fluig Plataforma: através do módulo interno do Fluig "foundation-alert-api" , interno ao Fluig, e através da API Pública. Este tutorial mostra contém um exemplo utilizando -se o módulo "foundation-alert-api". Para mais informações sobre a API Pública, clique aqui.
Para criação de um aplicativo interno ao à plataforma Fluig que utilize a API de Notificações, é necessário criar um projeto Java (padrão mavenMaven) e adicionar o seguinte trecho de código no arquivo "pom.xml":
| Bloco de código | ||
|---|---|---|
| ||
<dependency>
<groupId>com.fluig</groupId>
<artifactId>foundation-alert-api</artifactId>
<version>1.2.0</version>
<scope>compile</scope>
</dependency> |
Cadastrando módulos de Notificações
...
Para criação de um novo módulo de notificações, é necessário realizar uma chamada ao método "registerModule", da interface "com.totvs.technology.foundation.alert.service.AlertModuleService". Um exemplo de chamada deste método segue abaixo:
...
- moduleKey: Chave única de identificação do módulo
- description: É a descrição do módulo. Pode ser um texto plano ou uma chave para tradução. Para que a tradução funcione, a chave deve estar previamente cadastrada no serviço I18n, no bundle "foundation_alert".
- tenantId: Id do tenant para qual o módulo está sendo criado.
Cadastrando eventos de Notificações
...
Para criação de um novo evento de notificações, é necessário realizar uma chamada ao método "createEvent", da interface "com.totvs.technology.foundation.alert.service.AlertEventService". Um exemplo de chamada deste método segue abaixo:
...
Os parâmetros para execução do método são:
- eventKey - String única que representa o evento no Fluig.
- required - Indica se o evento é requerido. Caso seja, o usuário não conseguirá configurar para não receber notificações do evento.
- descriptionKey - Descrição do evento. Pode ser um texto plano ou uma chave para obter descrição traduzida no I18n. Caso queira utilizar a tradução, a chave deve estar previamente cadastrada no I18n, no bundle "foundation_alert".
- singleDescriptionKey - Descrição da ação feita por um usuário. Pode ser um texto plano ou uma chave para obter descrição traduzida no I18n. Caso queira utilizar a tradução, a chave deve estar previamente cadastrada no I18n, no bundle "foundation_alert".
- groupDescriptionKey - Descrição da ação feita por por vários usuários. Pode ser um texto plano ou uma chave para obter a descrição traduzida no I18n. Caso queira utilizar a tradução, a chave deve estar previamente cadastrada no I18n, no bundle "foundation_alert".
- eventIcon - Ícone que representa o evento (opcional). Este ícone será exibido pelo sistema em notificações que não tenham um usuário que a enviou. Caso tenha um usuário "enviador", o sistema exibirá a foto deste usuário. Caso haja mais de um usuário "enviador", o o sistema mostrará a foto do último usuário que enviou a notificação.
- moduleId - Módulo ao qual pertence este evento
- grouped - Indica se a notificação pode ser agrupada por ação e objeto.
- canRemove - Indica se a notificação pode ser removida.
- removeAfterExecAction - Indica se a notificação é removida após ser executada uma ação.
- onlyAdmin - Indica se o evento é válido somente para usuários administradores.
- tenantId - Tenant para o Empresa (tenant) para a qual o evento está sendo cadastrado.
Enviando Notificações
:Para enviar uma notificação é necessário realizar uma chamada ao método "sendAlert", da interface "com.totvs.technology.foundation.alert.service.AlertService". Um exemplo de chamada deste método segue abaixo:
| Bloco de código | ||
|---|---|---|
| ||
@Stateless(name = "AlertCreator", mappedName = "AlertCreator")
public class AlertCreator {
@EJB(lookup = AlertService.JNDI_REMOTE_NAME)
private AlertService alertService;
public void sendHoleritAlert() {
alertService.sendAlert("MY_EVENT", loginUserThatSendsTheNotification, loginUserThatIsGoingToReceiveTheNotification, objectAttached, placeWhereTheEventOccurs, actions, metadata);
}
} |
Os parâmetros
para execução do método são:para execução do método são:
- eventKey - Chave do evento cadastrado para envio de notificações.
- loginSender - login do usuário que envia a notificação. (opcional)
- loginReceiver - login do usuário que irá receber a notificação.
- object - objeto associado à notificação (opcional) - implementação padrão para a interface "AlertObject" é a classe "com.totvs.technology.foundation.alert.GenericAlertObject", da API de Notificações do Fluig.
- place - lugar onde a notificação foi gerada (opcional) - objeto e lugar são tratados com a mesma estrutura de dados - implementação
- padrão para a interface "AlertObject" é a classe "com.totvs.technology.foundation.alert.GenericAlertObject", da API de Notificações do Fluig.
- actions - ações disponibilizadas pela notificação (opcional) -
- implementação padrão para a interface "
- AlertAction" é a classe "com.totvs.technology.foundation.alert.GenericAlertAction", da API de Notificações do Fluig.
- metadata - metadados da notificação (opcional).
Desabilitando eventos de Notificações
É possível desabilitar qualquer evento de notificações. Atualmente este serviço está disponível na API Pública da plataforma Fluig. Uma vez desabilitado, o sistema não gerará mais nenhuma notificação para aquele tipo de evento, e também não o exibirá mais na tela de configurações.
| Nota | ||
|---|---|---|
| ||
Obrigatoriamente o valor informado deve ser um formulário. Outros tipos de documentos não serão tratados e ocorrerá erro na execução do evento. |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas