Sentencia de Notificación¶

Las frases de notificación son una utilidad para gestionar alertas automáticas, ya sea a través de advertencias en pantalla, notificaciones push o envío de correos electrónicos. Consiste en automatizar un proceso para añadir registros a las tablas del sistema Notices, Notices_Users y/o Mails_Outbox. Para utilizar las frases de notificación debemos definir 2 cosas: una sentencia de notificación y una tarea cron.

La sentencia de notificación: consiste en definir consultas en SQL que nos proporcionarán la información para incluir en las tablas de notificación.
La tarea cron: se utiliza para definir cuándo queremos que se generen las notificaciones.

Notificaciones¶

Es la forma en que el sistema puede enviar notificaciones push o mostrar alertas en la pantalla. Esto se muestra con una lista en un ícono que se ilumina cuando el usuario tiene mensajes no leídos. Para generar una notificación, es suficiente con añadir un registro en la tabla "Notices", y si necesitamos que la notificación se muestre para un grupo de usuarios, debemos añadirlos como registros en la tabla "Notices_Users".

Para que funcione, el cron UpdateNoticeBadge debe estar activo.

Frases¶

En primera instancia, definiremos una sentencia de notificación indicando una descripción, una tarea cron y la cadena de conexión (base de datos donde se realizarán las consultas SQL).

Frases de Notificación¶

Utiliza la sentencia de notificación para seleccionar qué campos se colocarán en la Tabla de Notificaciones.

Recuerda que la tabla de notificaciones funciona de manera similar a un nodo de navegación.

SQL

SELECT 'Nuevas acciones pendientes' as <b>Title</b>,
'Tienes una nueva acción pendiente' as <b>Message</b>,
cast(getdate() as smallDatetime) as <b>ReminderTime</b>, 
cast(Dateadd(WEEK,1,getdate()) as smalldatetime) as <b>ExpiryTime</b>, 
'app' as <b>MethodName</b>, 
0 as <b>AllUsers</b>, 
'object' as <b>TypeId</b>, 
'action' as <b>ObjectName</b>, 
'EstadoAcción=0' as <b>ObjectWhere</b>, 
'list' as <b>PageTypeId</b>, 
EmployeeId as <b>CurrentReference</b>
FROM ...

Propiedad	Descripción	Requerido
Title	Título de la notificación	✓
Message	El mensaje de la notificación, para el cual deberá usar marcado HTML	✓
MethodName	Notificación App, notificación Push, PushMobile solo para notificaciones en dispositivos móviles o Pushweb solo para notificaciones en navegadores web	✓
ReminderTime	Fecha y hora en la que se enviará la notificación	✓
ExpiryTime	Fecha y hora en la que la notificación expirará	✓
AllUsers	Enviar la notificación a todos los usuarios; si se establece en false, recuerde rellenar la sentencia de usuarios de la notificación	✓
TypeId	Uno de los tipos de nodo válidos: Enlace a objeto (object), Enlace a página (page), Proceso (process), Texto (text), etc.	✓
CurrentReference	Valor correspondiente al campo «Reference» del usuario de Flexygo. Puede contener múltiples valores separados por “;”. Con esto se evita tener que indicar una sentencia de usuarios.
UserId	Valor correspondiente al campo «Id» del usuario de Flexygo. Puede contener múltiples valores separados por “;”. Con esto se evita tener que indicar una sentencia de usuarios. Si se utiliza el campo CurrentReference, no es necesario especificarlo.
AfterClickEvent	Código JavaScript que se ejecutará después de hacer clic en la notificación
CssClass	Clase CSS aplicada a la notificación
ObjectName	Nombre del objeto si necesita enlazar a uno al hacer clic
ObjectWhere	Condición (where) del objeto si necesita enlazar a uno al hacer clic
PageTypeId	Id del tipo de página si necesita enlazar a una al hacer clic
PageName	Nombre de la página si necesita enlazar a una al hacer clic
ReportName	Nombre del informe si necesita enlazar a uno al hacer clic
ReportParams	Parámetros del informe si necesita enlazar a uno al hacer clic
ProcessName	Nombre del proceso si necesita enlazar a uno al hacer clic
Params	Parámetros del proceso si necesita enlazar a uno al hacer clic
HelpId	Id de la página de ayuda si necesita enlazar a una al hacer clic
URL	Una URL si necesita enlazar a ella al hacer clic
TableName	Nombre de la tabla si necesita enlazar a una al hacer clic

Ejemplo: "Próximas ofertas que expiran"

SQL

SELECT 'Ofertas que expiran esta semana ' + CAST(DATEPART (week, getdate())  AS varchar) AS [Título],
'Tienes ' +  
CASE WHEN count(1)=1 THEN 'una oferta que expira en los próximos 7 días'  
ELSE CAST (count(1) AS varchar) + ' ofertas que expiran en los próximos 7 días' END AS [Mensaje], 
CAST(getdate() AS smallDatetime) AS HoraRecordatorio, 
CAST(Dateadd(dd,1,getdate()) AS smalldatetime) AS HoraExpiración, 
0 AS TodasLosUsuarios, 
EmployeeId AS referenciaActual, 
'app' AS NombreMétodo, 
'object' AS IdTipo, 
'current' AS IdObjetivo, 
'list' AS IdTipoPágina, 
'offers' AS NombreObjeto, 
'Offers.sellbydate BETWEEN ( ''' + convert(varchar(10),GETDATE(),112) + ''' ) 
      AND DATEADD (WEEK, 1, ''' + convert(varchar(10),GETDATE(),112) + ''') 
      AND (Offers.State = 0)  AND (Offers.EmployeeId={{referenciaActual}})' as ObjetoDonde
FROM (
    SELECT Offers.IdOferta, Offers.EmployeeId as EmployeeId
    FROM Offers
    WHERE Offers.SellByDate BETWEEN CAST(GETDATE() as date) AND dateadd(DAY,7, CAST(GETDATE() as date))
    AND (Offers.State = 0) AND Offers.SellByDate is not null
    ) AS Asignado
GROUP BY EmployeeId

sentencia de notificación de Usuario¶

Si no has utilizado la referencia al usuario en la declaración principal de notificación, puedes establecer qué usuarios recibirán la notificación usando una consulta SQL, en la que puedes especificar el identificador de usuario (IdUsuario) o la referencia (ReferenciaActual).

Utiliza "sentencia de notificación de Usuario" para seleccionar qué IdUsuario debería recibir la notificación. Recuerda que el IdUsuario debe obtenerse de la Base de Datos de Configuración.

SQL

SELECT UserId FROM ... WHERE ...

A veces el usuario no está definido en nuestro modelo de datos, entonces podemos usar la referencia al usuario.

SQL

SELECT EmployeeId AS CurrentReference FROM ... WHERE ...

Propiedad	Descripcion	RRequeridoequired
CurrentReference	Referencia de AspNetUsers	✓
UserId	ID de Usuario de AspNetUsers	✓

Ejemplo: "Próximas ofertas que expiran"

SQL

SELECT distinct 1 as UserId, 
EmployeeId as CurrentReference
FROM ( 
    SELECT Offers.IdOferta, Offers.EmployeeId AS EmployeeId
          FROM Offers
          WHERE Offers.SellByDate BETWEEN cast(GETDATE() as date) AND dateadd(DAY,7, cast(GETDATE() as date))
          AND (Offers.State =0) AND Offers.SellByDate is not null
    ) AS Assigned
GROUP BY EmployeeId

Sentencia de Actualización¶

Utiliza una sentencia de actualización si es necesario después de llenar las tablas de correos o avisos. En el caso de que la notificación no esté dirigida a todos los usuarios, sino a un grupo específico, debemos indicar a qué usuarios. Ya sea identificándolos utilizando el identificador de usuario del sistema (UserId) o la referencia a él en el modelo de datos (Referencia).

SQL

UPDATE Mytable\_Log SET NotifiedError = 1 WHERE HASError = 1 AND NotifiedError = 0

Sentencia de Correo¶

Utiliza la Sentencia de Correo para seleccionar qué campos se colocarán en la Tabla Mails_Outbox.

SQL

SELECT 'dmi@flx.com' AS FromEmail, 
'David' AS FromName,
'Acciones pendientes nuevas' AS Subject,
'Tienes nuevas acciones pendientes' AS Body, 
CAST(GETDATE() AS smallDatetime) AS SendDate,
'johnpaul@beatdomain.com' AS [To],
'3E0A3AA1-0B56-4091-9736-200964B2D1F4|C49953C3-2BE8-4591-9601-99BDF77B1028' AS attachments
FROM ...

Propiedad	Descripción	Requerido
FromEmail	Correo electrónico del remitente	✓
To	Correo electrónico del destinatario	✓
Subject	Asunto del Correo	✓
Body	Cuerpo del Correo	✓
FromName	Nombre del Remitente
CC	Copia (correo) Carbono
CCO or BCC	Copia (correo) Carbono Oculta
UserId	ID de Usuario del Remitente
SendDate	Fecha utilizada por cron para enviar el correo
ReplyTo	Correo electrónico de Respuesta a
ObjectName	Enlace para hacer clic en un objeto
ObjectWhere	Enlace para hacer clic en un objeto
Attachments	Lista de Guid de documentos del gestor de documentos separados por tuberías \|

Sentencia de Sms¶

(Para poder usarlo, es necesario habilitar la integración, para más información consulta la ayuda de abh sms.)

Utiliza la Sentencia de Sms para seleccionar qué campos se colocarán en la Tabla Sms_Outbox.

SQL

SELECT
'684352406' as Phone
,'Tienes nuevas acciones pendientes' as Text
, cast(getdate() as smallDatetime) as SendDate
FROM ....

Propiedad	Descripcion	Requerido
Phone	Teléfono del remitente	✓
Text	Texto de Sms	✓
UserId	ID de Usuario del Remitente
SendDate	Fecha utilizada por cron para enviar el correo
ObjectName	Enlace para hacer clic en un objeto
ObjectWhere	Enlace para hacer clic en un objeto

Tareas Cron¶

Finalmente, debemos crear una nueva tarea cron e indicar un nombre, un grupo de trabajo (por defecto "Defaultgroup"), una breve descripción, habilitado... A continuación, seleccionamos el horario de disparo. En las opciones de proceso debemos poner el proceso BuildMailandNotifications y ejecutarlo como el usuario administrador. En el nombre del proceso pondremos SysNoticeSentences y en el objeto Where pondremos el filtro de la sentencia que acabamos de crear (SentenceId = 'myalert')

Ve el video sobre la creación de la tarea cron:

Acerca de los procesos estándar¶

Una vez que se definen las sentencias, el cronjob completa las tablas mencionadas. Luego, otros procesos estándar son responsables de notificar por correo o pantalla. Para enviar alertas, hay un proceso estándar que cada minuto analiza los registros añadidos a las tablas Notices y Notices_Users y los procesa para enviar alertas. Esto lo realiza otro cronjob llamado UpdateNoticeBadge. Para enviar los correos electrónicos, hay un proceso estándar que cada minuto analiza los registros añadidos a la tabla Mails_Outbox y los procesa para enviar los correos electrónicos. Esto lo realiza otro cronjob llamado SendOutBoxEmails.