Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Atualização guia de marca

Índice

Índice
outlinetrue
exclude.*ndice
stylenone


Objetivo

...

No TOTVS Fluig Plataforma

Nota

Disponível a partir da versão 1.2.0 do Fluig

Índice

Índice

Objetivo

A partir da versão 1.2.0 é possível criar novas formas de envio de notificações para os usuários do Fluig. Isto pode ser feito através de aplicativos . Estes aplicativos que podem ser instalados no Fluig e, a Plataforma. A partir daí , o sistema utilizará o aplicativo para enviar notificações. Este tutorial tem o objetivo de guia visa orientar e mostrar passo-a-passo como criar, instalar e utilizar um aplicativo de envio de notificações no Fluig Plataforma.


Projeto de exemplo

...

Para facilitar o entendimento e desenvolvimento de aplicativos, foi gerado um projeto de exemplo. Neste projeto, foi implementado um aplicativo que salva as notificações em arquivos ".txt"mostra no LOG a mensagem recebida. Para testá-lo, basta seguir os seguintes passos :

...

abaixo:

  1. Baixar o projeto: Clique aqui ou faça um clone do repositório http://git.fluig.com/projects/SAMPLES/repos/notifications/browse (projeto "alert-sender-sample")Configurar no arquivo "/alert-sender-sample-impl/src/main/resources/config.properties" a pasta onde o aplicativo irá salvar as notificações
  2. Compilar o projeto (é um projeto padrão maven, para compilar, executar "mvn clean install" na raíz do projeto)
  3. Fazer deploy do arquivo "/alert-sender-sample-server/target/alert-sender-sample-server.ear" em um servidor com o Fluig instalado
  4. Acessar o a plataforma Fluig e gerar eventos que enviem notificações (ex. apoiar um post)
Deverão ser criados arquivos ".txt" com as notificações geradas na pasta configurada no passo 2.

...

  1. .
    Deverá aparecer no LOG do Fluig os dados do alerta.


Informações

Este projeto de exemplo pode servir de base para implementação de aplicativos reais de envio de notificações.

 

...

Para trabalhar com aplicativos de envio de notificações no Fluig, é necessário criar um projeto Java que será publicado no servidor do produto. Este projeto deve importar a API de Notificações, com o seguinte trecho de código no arquivo "pom.xml":

Bloco de código
languagehtml/xml
<dependency>
	<groupId>com.fluig</groupId>
	<artifactId>foundation-alert-api</artifactId> 
	<version>1.2.0</version>
	<scope>compile</scope>
</dependency>


Cadastro de aplicativos no Fluig Plataforma através da API de Notificações

...

Para que um aplicativo possa ser utilizado pelo TOTVS Fluig Plataforma para enviar notificações, este deve ser cadastrado na Central de Notificações do sistema. Para isto, é necessário realizar uma chamada ao método "com.totvs.technology.foundation.alert.service.AlertAppSenderService.registerApplication()", presente na API de Notificações do Fluig. postar uma mensagem em uma fila JMS. Abaixo um exemplo de código que realiza esta chamada, que pode ser encontrado em alert-sender-sample/impl/src/main/java/com/fluig/StartupLoader.java:

Bloco de código
languagejava
@EJB(lookup = AlertAppSenderService.JNDI_REMOTE_NAME)
private AlertAppSenderService appSenderService;


public void registerMyApplicationApplicationpackage com.fluig;
import java.util.HashMap;
import javax.annotation.PostConstruct;
import javax.ejb.Singleton;
import javax.ejb.Startup;
import javax.jms.JMSException;
import javax.jms.ObjectMessage;
import javax.jms.Queue;
import javax.jms.QueueConnection;
import javax.jms.QueueConnectionFactory;
import javax.jms.QueueSender;
import javax.jms.QueueSession;
import javax.naming.InitialContext;
import javax.naming.NamingException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
 * Registra o aplicatico como listener para os alertas.
 */
@Startup
@Singleton
public class StartupLoader {
	private transient Logger log = LoggerFactory.getLogger(StartupLoader.class);
	/*
	 * Nome da fila que será usada para receber os alertas.
	 */
	private static final String QUEUE = "AlertSenderSampleQueue";
	/**
	 * ID do tenante para o qual será registrado. Quando houver mais de um
	 * tenante, deverá fazer uma chamada para cada tenante.
	 */
	private static final Long TENANT_ID = 10097l;
	@PostConstruct
	private void startup() {
		log.info("Inicializando aplicativo");
		try {
			InitialContext ic = new InitialContext();
	appSenderService
		.registerApplication(
			"MyApplication",
			"My custom application to send notifications",
			"java:global/myapp/my-app-sender/MySenderService!com.totvs.technology.foundation.alert.sender.AlertSenderApp",
			myTenantId);
					Queue q = (Queue) ic
					.lookup("java:global/TOTVSTechAsyncQueue");
			QueueConnectionFactory factory = (QueueConnectionFactory) ic
					.lookup("java:global/FluigRemoteXAConnectionFactory");
			QueueConnection connection = factory.createQueueConnection();
			QueueSession session = null;
			QueueSender sender = null;
			try {
				session = connection.createQueueSession(false,
						javax.jms.Session.AUTO_ACKNOWLEDGE);
				sender = session.createSender(q);
				HashMap<String, Object> values = new HashMap<String, Object>();
				// Código do aplicativo.
				values.put("applicationKey", "alert.app.sender.sample");
				// Chave da descrição do aplicativo.
				values.put("descriptionKey",
						"alert.app.sender.sample.description");
				// ID do tenante.
				values.put("tenantId", TENANT_ID);
				ObjectMessage msg = session.createObjectMessage();
				msg.setObject(values);
				msg.setStringProperty("action", "registerAlertAppSender");
				sender.send(msg);
				log.info("Inicialização do aplicativo OK");
			} finally {
				if (sender != null) {
					sender.close();
				}
				if (session != null) {
					session.close();
				}
				if (connection != null) {
					connection.close();
				}
			}
		} catch (NamingException ex) {
			log.error("Nao foi possivel registrar o serviço de notificação via whatsapp");
			ex.printStackTrace();
		} catch (JMSException ex) {
			log.error("Nao foi possivel registrar o serviço de notificação via whatsapp");
			ex.printStackTrace();
		}
	}
}

Os parâmetros necessários são:

  1. applicationKey: É uma string que será o identificador único para o aplicativo. Através desta string a Central de Notificações fará todo o gerenciamento do aplicativo.
  2. descriptiondescriptionKey: É a descrição do aplicativo. Pode ser um texto plano ou uma chave para tradução (ex: app.my.application). Para que seja feita a tradução, a chave deve estar previamente cadastrada no módulo I18n, no bundle "foundation_alert". Caso seja inserido um texto plano, este será exibido sem tradução.
  3. jndiName: É o nome JNDI que a Central de Notificações utilizará para fazer lookup e invocar o aplicativo para envio de notificações.
  4. tenantId: O id do tenant onde o aplicativo será instalado.


Informações

É uma Uma boa prática é fazer o cadastro do aplicativo no momento do deploy no servidor ou no momento da criação de um novo tenant. O projeto de exemplo já contém código com este comportamento.

...


Configurações de envio de notificações por usuário

...

Quando um novo aplicativo for instalado na Central de Notificações, todos os usuários do tenant poderão configurar se desejam ou não receber notificações através do aplicativo. Isto pode ser feito na tela de configurações. Por padrão, ao instalar um novo aplicativo, todos os usuários do tenant passarão a receber notificações através daquele aplicativo. Abaixo o exemplo da tela de configurações depois de instalado o projeto de exemplo.

Image Modified


Enviando notificação através do aplicativo

...

Para que a Central de Notificação do TOTVS Fluig Plataforma invoque o aplicativo para enviar notificações, o aplicativo deve obrigatoriamente implementar a interface "com.totvs.technology.foundation.alert.sender.AlertSenderApp" da API de notificações. No cadastro do aplicativo, o JNDI informado deve ser o nome para fazer lookup desta implementação. Abaixo um exemplo  simples de implementação desta interfacecriar um MDB que ouve a fila registrada. Abaixo temos um exemplo simples de MDB:

Bloco de código
languagejava
@Statelesspackage com.fluig;
import java.io.Serializable;
import java.util.Map;
import javax.ejb.ActivationConfigProperty;
import javax.ejb.EJB;
import javax.ejb.MessageDriven;
import javax.ejb.TransactionAttribute;
import javax.ejb.TransactionAttributeType;
import javax.jms.JMSException;
import javax.jms.Message;
import javax.jms.MessageListener;
import javax.jms.ObjectMessage;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
 * Esta é a classe que será chamada pela Central de Notificações para enviar
 * alertas por este aplicativo.
 */
@MessageDriven(name = "myapptopic/MySenderServiceFluigNotificationTopic", mappedName = "FluigNotificationTopic", activationConfig = {
		@ActivationConfigProperty(propertyName = "acknowledgeMode", propertyValue = "Auto-acknowledge"),
		@ActivationConfigProperty(propertyName = "destinationType", propertyValue = "javax.jms.Topic"),
		@ActivationConfigProperty(propertyName = "destination", propertyValue = "myapp/MySenderService"FluigNotificationTopic")
})
public class MySenderServiceBeanAlertSampleMDBBean implements AlertSenderAppMessageListener {
	private static final Logger log = LoggerFactory
			.getLogger(AlertSampleMDBBean.class);
	@EJB(lookup = TxtSenderService.JNDI_REMOTE_NAME)
	private TxtSenderService service;
	@Override
	@TransactionAttribute(TransactionAttributeType.NOT_SUPPORTED)
	public void send(final Long alertId onMessage(final Message message) {
		if (message instanceof ObjectMessage) {
			final ObjectMessage msg = (ObjectMessage) message;
			try {
				final Serializable obj = msg.getObject();
				if (log.isDebugEnabled()) {
					log.debug("AlertSenderSampleQueue.onMessage - obj: " + obj);
		/* Meu código de envio da notificação */
						}
				service.sendAlert((Map<String, Object>) obj);
				if (log.isDebugEnabled()) {
					log.debug("AlertSenderSampleQueue.onMessage - FIM");
				}
			} catch (final JMSException ex) {
				log.error(ex.getMessage(), ex);
			}
		}
	}
}

Quando o usuário receber um alerta, a Central de Notificações vai validar se aquele usuário está configurado para receber notificações por este aplicativo. Caso esteja, a Central postará uma mensagem na fila cadastrada para o aplicativo.



Desabilitando aplicativos de envio de Notificações

...

É possível desabilitar qualquer aplicativo de envio, exceto a própria Central de Notificações da plataforma Fluig. Atualmente este serviço está disponível na API Pública da plataforma Fluig. Uma vez desabilitado, o sistema não invocará o método "send()", através do lookup do JNDI cadastrado para o aplicativomais o aplicativo para envio de notificações, e também não o exibirá mais na tela de configurações.