...

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 personalizadas através da API de Notificações do produto.

É possível criar aplicativos, widgets, dentre outros, etc. que criem e enviem notificações personalizadas, além de fazer este processo através de aplicações externas, utilizando a API Pública do 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 da empresa (tenant). Para fazer este mesmo processo através da API Pública do fluig, consulte a documentação clicando aqui. As notificações enviadas pelo aplicativo são exibidas tanto na web, como nos dispositivos móveis.  

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 holerite já está disponível".

...

Entendendo os conceitos para criação de notificações personalizadas

...

É 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 personalizadas, é 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 fluig. O evento contém todas as configurações das notificações.

...

Para criar notificações personalizadas, é 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

...

• Apenas para administradores: Indica se aquele tipo de notificação é exclusivo para administradores da empresa (tenant).

Notificações

As notificações devem ser criadas 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:

...

• 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 à ela. As ações possuem os seguintes atributos:

...

• Tipo: Existem atualmente dois tipos de ações:
  
  1. MAIN: É a ação principal. O sistema exibirá na Central de Notificações esta ação como ação de destaque.
  2. 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

...

1. moduleKey: Chave única de identificação do módulo
2. 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".
3. tenantId: Id do tenant para qual o módulo está sendo criado.

...

Cadastrando eventos de Notificações

...

1. eventKey - String única que representa o evento no fluig.
2. required - Indica se o evento é requerido. Caso seja, o usuário não conseguirá configurar para não receber notificações do evento.
3. 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".
4. 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".
5. 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".
6. 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 sistema mostrará a foto do último usuário que enviou a notificação.
7. moduleId - Módulo ao qual pertence este evento
8. grouped - Indica se a notificação pode ser agrupada por ação e objeto.
9. canRemove - Indica se a notificação pode ser removida.
10. removeAfterExecAction - Indica se a notificação é removida após ser executada uma ação.
11. onlyAdmin - Indica se o evento é válido somente para usuários administradores.
12. tenantId - Empresa (tenant) para a qual o evento está sendo cadastrado.

...

@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);
				
	}
}

...