Notificaciones en Jitterbit App Builder

Introducción

Las notificaciones son mensajes enviados a los usuarios de la aplicación que han iniciado sesión cuando ocurre algo. Pueden enviarse a través de los siguientes métodos:

• Correo electrónico

• SMS (utilizando el servicio de Twilio)

• Alerta de App Builder (un popup dentro de la aplicación que aparece cuando el usuario ha iniciado sesión en una aplicación)

Las notificaciones del sistema son tipos de notificaciones enviadas por administradores del sistema a usuarios seleccionados cuando ocurre algo, generalmente un evento que afecta a múltiples usuarios.

Desde App Builder 4.44, puedes seleccionar IDE > Mantenimiento (Beta), luego seleccionar la pestaña Notificaciones para ver y gestionar las notificaciones.

Notificaciones

Un mensaje de notificación puede tener múltiples opciones que definen cómo el usuario puede responder.

Para correos electrónicos y alertas de App Builder, se incluyen URLs en el mensaje que enlazan de vuelta a App Builder.

Para SMS, los usuarios pueden responder con el nombre de la opción para ejecutar el evento asociado.

Los enlaces de notificación están activos durante 7 días, después de los cuales expiran y ya no están activos. (Este tiempo de expiración no se puede cambiar.)

Cuando hay opciones presentes en una notificación, la respuesta del usuario es rastreada automáticamente por App Builder.

Las notificaciones pueden incluir archivos adjuntos de muchos tipos de archivo (por ejemplo, .PDF, .DOCX, .TXT, .XLSX, etc.). Si estás utilizando archivos adjuntos, la notificación utilizará el directorio data/pdf si no se especifica otro directorio. Alternativamente, si especificas un FileDataSourceId, esta es la ubicación donde App Builder buscará el(los) archivo(s) adjunto(s).

Para utilizar los objetos de datos públicos requeridos para la notificación, tu aplicación requiere que App Builder (Sellado) esté configurado como una fuente de datos disponible para la aplicación. Además de ser una fuente de datos disponible para la aplicación, necesitas establecer o configurar un enlace entre las fuentes de datos.

App Builder utilizará la información de URL especificada en la regla de notificación, si está disponible. Si no se encuentra, App Builder recurrirá y utilizará la URL predeterminada del sitio del servidor. El valor predeterminado del sitio del servidor se configura desde IDE > Proveedores de seguridad > Más (desde el panel de configuración) > Sitios. Para más información sobre sitios y URL, consulta el artículo Sitios y alias.

Opciones

Las notificaciones pueden tener 0 o más opciones. Cuando no hay opciones, no se espera respuesta del usuario. En este caso, la respuesta del usuario no se rastrea y no se añaden enlaces al mensaje saliente. Esto se considera una notificación Informativa.

Cuando una notificación contiene 1 o más opciones, se envía un mensaje con enlaces URL que permiten al usuario responder de alguna manera. La respuesta del usuario al mensaje (es decir, qué opción seleccionó) se rastrea mediante la notificación.

Configuración

Las opciones de notificación se pueden configurar de dos maneras:

1. Enlace a página: Se proporciona un enlace que permite al usuario navegar a una página. Navegar con éxito a la página se considera una respuesta completa a la opción.

2. Ejecutar evento de página: Se proporciona un enlace que envía al usuario a una página y ejecuta un evento específico antes de que se renderice la página. La respuesta del usuario se considera completa una vez que se activa el evento.

Para que una página sea elegible para cualquiera de estas opciones, la página debe estar marcada como Compartida.

Ejemplo

Un Administrador puede ejecutar un evento que cause que se envíe un correo electrónico a un usuario. El correo electrónico tiene algo de texto y los siguientes tres botones:

1. Revisar: Al hacer clic, el usuario es llevado a una página específica.

2. Aprobar: Al hacer clic, el usuario es llevado a una página diferente y ejecuta un evento contra algunos objetos de datos en la página.

3. Rechazar: Al hacer clic, el usuario es llevado a una página diferente y ejecuta un evento contra los objetos de datos de la misma página o de una página diferente.

El evento debe ejecutarse antes de que se renderice la página, ya que puede afectar los datos que se encuentran en los paneles de la página. Para ejecutar un evento, el desarrollador de la aplicación debe hacer lo siguiente:

• Configurar la Enlace a página como Compartida.

• Incluir el evento en el Objeto de Datos para la página, o como una de las fuentes de datos de panel de una sola fila en la página. (Una ilustración adicional de este punto está disponible en la sección de Vinculación de Eventos de Objetos de Datos a continuación.)

Vinculación de eventos de objeto de datos

App Builder limita los eventos que se pueden vincular a un enlace. Esta limitación solo permite eventos que pertenecen a un Objeto de Datos o Tabla que está vinculado a un panel de fila única no vinculado en la página de destino. Por ejemplo, considera una página que tiene 6 paneles de fila única:

• Customer → CustomerAddress → CustomerMap
• Employee → EmployeeAddress → EmployeeMap

En este ejemplo, los paneles Customer y Employee no están vinculados a ningún otro panel en la página. Por lo tanto, un desarrollador puede elegir eventos de las fuentes de datos de esos dos paneles (junto con un objeto de datos de página si se especifica).

App Builder también limita los eventos que se pueden vincular a eventos no del sistema. Por ejemplo, el desarrollador no puede vincular de regreso a los eventos de Guardar, Insertar, Actualizar o Eliminar.

Registro de notificaciones

Vinculación a una notificación

La página de Registro de Notificaciones en App Builder permite al desarrollador vincular una Notificación a una aplicación. Esta es una relación de 1 a 1. Se puede configurar información adicional sobre el mensaje de notificación dentro del registro de notificación.

Creación de mensajes

El mensaje de notificación se puede definir en la sección de Plantilla de la página de Registro de Notificaciones. Este es el contenido principal de la notificación en sí.

Se realizan sustituciones en la Plantilla y utilizan la sintaxis {{fieldname}}. Las sustituciones pueden agregar una bandera url opcional para indicar que el valor es una URL y requiere codificación de URL, por ejemplo, {{fieldname|url}}.

Para la sustitución, el cuerpo puede contener:

Hola {{CustomerName}},

En este ejemplo, CustomerName debe estar contenido en las columnas de la regla de notificación junto con los otros campos requeridos.

Para correos electrónicos, se puede especificar un Asunto en la página de Registro de Notificaciones. El campo Asunto también admite sustituciones.

Traducciones

Las notificaciones admiten traducciones rudimentarias. Hay tres campos que se utilizan para las traducciones:

1. Opción de Notificación Nombre.

2. Mensaje de Registro de Notificación Mensaje.

3. Asunto de Registro de Notificación Asunto (para correos electrónicos).

Al crear el mensaje de notificación, el Constructor de Aplicaciones intentará encontrar traducciones para cada uno de estos campos, asumiendo que su contenido especifica la clave de traducción correspondiente. El desarrollador también necesita agregar las claves al paquete de traducción para la aplicación manualmente (actualmente no se importan automáticamente para una aplicación). Se debe tener cuidado con el campo Plantilla para agregar la clave de traducción como una cadena sin procesar y no como HTML. Hay un ícono de "código" en la parte inferior derecha del campo Plantilla de Registro de Notificación que permite editar directamente la cadena.

Limitaciones

1. El evento ejecutado en el enlace de opción pertenece a los Datos de Página o a un Objeto de Datos de Panel de Fila Única. Actualmente, no mostramos ningún resultado de validación ni mensajes posteriores para eventos a nivel de página. En otras palabras, el evento se ejecuta primero, cuando se completa, el usuario es redirigido a su página. Cuando llegan a su página, los resultados del evento se pierden. Por lo tanto, si el evento tiene un mensaje posterior o falla en la validación, el sistema no mostrará esos resultados al usuario final. El desarrollador puede eludir esto fácilmente mostrando datos en sus paneles que cambian según la ejecución exitosa de un evento.

   Debido a la limitación anterior, las advertencias de validación harán que un evento no se ejecute. No tenemos una interfaz de usuario que permita al usuario aceptar o rechazar la advertencia.

2. La tabla Archivo de una fuente de datos de Amazon S3 no puede ser extraída por una regla de Notificación.

Objetos de datos públicos de notificación

Los objetos de datos públicos utilizados como objetivos de Notificación se definen a continuación.

Columnas comunes

Estas columnas son comunes en los objetos de datos públicos de Notificación:

Email

El Email objeto de datos públicos es similar pero no completamente consistente con la funcionalidad del Plugin de Email SMTP. Las columnas para el objeto de datos públicos Email son las siguientes:

Mensaje de texto

El objeto de datos público Mensaje de Texto se utiliza para enviar SMS. Las columnas del objeto de datos público Mensaje de Texto son las siguientes:

Alerta de App Builder

El objeto de datos público Alerta de App Builder es similar pero no completamente consistente con el objeto de datos público Crear_Notificación. Las columnas del objeto de datos público Alerta de App Builder son las siguientes:

Notificación push

El objeto de datos público de Notificación Push permite que la notificación envíe una notificación push a un Usuario. Las columnas del objeto de datos público de Notificación Push son las siguientes:

Configuración de notificaciones

Ejemplo de configuración de notificaciones

Estos son los pasos necesarios para configurar una notificación. (Este ejemplo muestra cómo agregar una Notificación de Aprobación de Cliente a la página de Clientes de Northwinds.)

1. Crear notificación: Crea una regla que apunte a un objeto de datos público de notificación:

   1. Navega a App Workbench.
   2. Haz clic en Notifications.
   3. Haz clic en + Notification.
   4. Asigna un Nombre. Por ejemplo CustomersRequestApprovalAlert.
   5. Confirma que el Propósito es Notification.
   6. Selecciona App Builder Alert como el Objetivo. Si no ves este objeto de datos disponible, crea una conexión de Fuente de Datos a App Builder (Sellado) para la aplicación en la que estás trabajando.
   7. Haz clic en Save.

2. Define mvSQL de la notificación:

   1. Haz clic en el botón +Tables.
   2. Agrega tu tabla 'select from'. Por ejemplo Customers.

   3. Agrega las siguientes columnas y haz clic en la pestaña Columnas para definir:

      Columna	Alias	Objetivo
      all	To	To
      "C".CustomerId	CustomerId	Binding()
      "C".CustomerName	CustomerName

      Nota

      Ten en cuenta que agregamos CustomerName para que podamos usarlo más tarde como un parámetro de sustitución en nuestro mensaje de Notificación.

3. Define opciones de notificación:

   1. Navega a App Workbench.
   2. Haz clic en Notifications.
   3. Selecciona la Regla de Negocio de Notificación. Por ejemplo: CustomerRequestApprovalAlert.

   4. Ingresa la información del Mensaje para la Notificación en el campo Body.

      Por ejemplo: Por favor revisa el siguiente cliente:

      Cliente: {{CustomerName}}

   5. Haz clic en el ícono de lápiz e ingresa cualquier Ayuda Técnica para ayudar a explicar la Notificación a otros desarrolladores.

4. (Opcional) Define una página de destino y un evento de pre-lanzamiento para ejecutar:

   1. Desde la página App Workbench > Notfications, selecciona la Notificación.
   2. Haz clic en el botón + Option.
   3. Crea una nueva opción:
      1. Establece Index en 10.
      2. Establece Name en Revisar.
      3. Selecciona el valor Link to Page. En nuestro ejemplo, enlazaremos a la página 'Customer' de Northwinds. Si la página a la que deseas enlazar no aparece, asegúrate de que esté marcada como "Shared" en la Configuración de Casos Especiales.
   4. Haz clic en el checkmark para guardar el registro.

5. Registrar notificación con un evento: Registrar Notificación como una Acción con un Evento. En este caso, asumimos que el Evento está asociado con un botón en la página de lanzamiento. También asumiremos que el evento se llama 'Solicitud de Aprobación'.

   1. Navegar al Evento para el Objeto de Datos.
   2. Hacer clic en el ícono de Lógica de Negocios.
   3. Hacer clic en el botón Eventos.
   4. Seleccionar el Evento. Por ejemplo: Solicitud de Aprobación.
   5. Hacer clic en Registrar Existente desde el panel de Acciones.
   6. Seleccionar Notificación como el Tipo de Acción.
   7. Seleccionar la Notificación que creamos en el paso anterior. Por ejemplo: AlertaSolicitudAprobaciónCliente.
   8. Hacer clic en Guardar.
   9. Verificar que los Vínculos Explícitos sean correctos. Por ejemplo: IdCliente - IdCliente.

6. Probar: En este punto, la Notificación está completamente configurada. Navegar a tu página y hacer clic en el botón que ejecuta el evento de notificación. Todos los usuarios de App Builder en el sistema deberían ver un pop-up con el mensaje de notificación.

Ejemplo de configuración de notificación SMS

Estos son los pasos necesarios para configurar una notificación SMS. (Este ejemplo muestra cómo agregar una Notificación de Aprobación de Cliente a la página de Clientes de Northwinds.)

1. Configurar la seguridad de App Builder

   1. Navegar a IDE > Proveedores de Seguridad.
   2. Hacer clic en + Autenticación de Usuario en el panel de Autenticación de Usuario.
      1. Ingresar un Nombre (por ejemplo, Autenticación Básica Http).
      2. Seleccionar Autenticación Básica HTTP como el Tipo.
      3. Hacer clic en Habilitado para habilitar.
      4. Hacer clic en Guardar.
   3. Navegar a IDE > Gestión de Usuarios.
      1. Hacer doble clic en el registro de Usuario que deseas autenticar cuando llegue una respuesta SMS.
      2. Ten en cuenta que este Usuario debe tener acceso a lo siguiente:
         • Aplicación de App Builder.
         • El Evento que se ejecutará en la notificación misma.
   4. Hacer clic en el ícono de Claves desde Autenticación.
   5. Hacer clic en Crear.
   6. Seleccionar el proveedor Autenticación Básica Http creado anteriormente.
   7. Hacer clic en Guardar.

   Nota

   La "Clave" secreta que se crea para este proveedor. La combinación del Nombre de Usuario y la Clave secreta se utilizará al configurar Twilio.

2. Configurar Twilio:

   1. Crear servicio de mensajería:

      1. Inicia sesión en tu cuenta de Twilio.
      2. Navega a Communications Cloud > Programmable SMS.
      3. Haz clic en Messaging Services.
      4. Crea un nuevo Servicio de Mensajería (Notificaciones, bidireccional) y adjunta un número de teléfono de Twilio.
      5. Anota el MessagingServiceSid. Esto se utilizará para la configuración más adelante.
      6. Habilita la opción "Process Inbound Message".
      7. Ingresa la siguiente URL de Solicitud:
         • https://<username>:<secret_key>@<your_vinyl_server>/webhook/v1/vinyl/bridge_inbound
         • Ejemplo: https://admin:P124asfgOmkA@vinyl.zudy.com/webhook/v1/vinyl/bridge_inbound

   2. Reúne las credenciales de Twilio

      1. Navega a Console Dashboard > Settings.
      2. Anota las credenciales en VIVO:
         • Account Sid
         • Auth Token

3. Configurar el punto final de SMS:

   1. Navega a IDE > Notification Servers.
   2. Haz doble clic en el registro 'SMS'.
   3. Agrega la siguiente configuración:
      • User Name: Twilio Account Sid
      • Password: Twilio Auth Token
      • MessagingServiceSid: Twilio Messaging Service Sid

4. Configurar la URL del sitio web:

   1. Navega a IDE > Security Providers.
   2. En Configuración haz clic en More > Sites.
   3. Haz clic en + Site.
   4. Establece el valor de la URL en la URL de tu sitio web. Por ejemplo: https://vinyl.zudy.com.
   5. Haz clic en Save.

5. Configurar la notificación de SMS:

   1. Crear notificación: Crea una regla que apunte a un objeto de datos públicos de notificación:

      1. Navega a App Workbench > Notifications.
      2. Haz clic en + Notification.
      3. Asigna un Nombre.
      4. Selecciona Notification como el Propósito.
      5. Selecciona Text Message como el Objetivo. Si no ves este objeto de datos disponible, crea una conexión de Fuente de Datos a App Builder (Sellado) para la aplicación en la que estás trabajando.
      6. Haz clic en Save.

   2. Definir notificación mvSQL:

      1. Haga clic en el botón +Tabla y agregue la Tabla que requiere la Regla. Ejemplo: Customers.

      2. Haga clic en la pestaña Columnas y agregue las siguientes columnas:

         Columna	Alias	Objetivo
         '+15551112222' (reemplazar con su número de teléfono)	To()	To()
         "C".CustomerId	CustomerId	Binding()
         "C".CustomerName	CustomerName

         Nota

         Agregamos "CustomerName" para que más tarde podamos usarlo como un parámetro de sustitución en nuestro mensaje de Notificación.

   3. Definir opciones de notificación: Además de definir la información del Mensaje, definiremos dos opciones para este ejemplo de Notificación. Una que se activa al responder al SMS, otra que es un enlace a una página:

      1. Haga clic en la pestaña de navegación Notificación.

      2. Ingrese el siguiente mensaje en el Cuerpo del Mensaje:

         Responda {{1}} para aprobar {{CustomerName}}. Revise {{Review}}
         

      3. Haga clic en el botón +Opción del panel de Opciones:

         1. Establezca Índice en 10.
         2. Establezca Nombre en Revisión.
         3. Seleccione la página a la que vincular. En nuestro ejemplo, vincularemos a la página 'Cliente' de Northwinds. Si la página a la que desea vincular no aparece, asegúrese de que esté marcada como "Compartida" en la Configuración de Casos Especiales.
         4. Establezca el Tipo de Opción en 'Enlace'.
      4. Haga clic en el botón +Opción del panel de Opciones
         1. Establezca Índice en 20.
         2. Establezca Nombre en 1.
         3. Seleccione la página a la que vincular. En nuestro ejemplo, vincularemos a la página 'Cliente' de Northwinds y ejecutaremos el evento 'Aprobar'.
         4. Establezca el Tipo de Opción en 'Respuesta SMS'.

   4. Registrar Notificación como una Acción con un Evento. En este caso, asumimos que el Evento está asociado con un botón en la página de lanzamiento. También asumiremos que el evento se llama 'Solicitar Aprobación':

6. Navega al Evento para el objeto de datos.

7. Haz clic en el ícono de Lógica de Negocios.
8. Haz clic en el botón Eventos.
9. Selecciona el Evento. Por ejemplo: Solicitar Aprobación.
10. Haz clic en Registrar Existente desde el panel de Acciones.
11. Selecciona Notificación como el Tipo de Acción.
12. Selecciona la Notificación que creamos en el paso anterior. Por ejemplo: Customer_RequestApprovalSms.
13. Haz clic en Guardar.

14. Verifica que los Vínculos Explícitos sean correctos. Por ejemplo: E.g. CustomerId - CustomerId.

15. Configurar notificación push: Las notificaciones push se configuran de manera similar a otras notificaciones en App Builder. El Administrador del servidor de App Builder debe configurar correctamente el punto final de Notificación Push para que funcionen como se espera. Si estás configurando Notificaciones Push con la API de Blabber, debes descargar la aplicación complementaria de iOS, iniciar sesión en el servidor correspondiente con las credenciales adecuadas y habilitar las notificaciones push en la propia aplicación. Además, se requiere una clave API para completar la configuración.

16. Probar: En este punto, la Notificación está completamente configurada. Navega a tu página y haz clic en el botón que ejecuta el evento de notificación.

Notificaciones del sistema

Las notificaciones del sistema se muestran a los usuarios activos y permanecen en su Centro de Notificaciones (bajo el menú hamburguesa) cuando se descartan.

Los administradores pueden enviar notificaciones del sistema de inmediato o programarlas para que se envíen.

Para configurar una notificación del sistema, sigue estos pasos:

1. Selecciona IDE > Mantenimiento (Beta), luego selecciona la pestaña Notificaciones.

2. En el panel de Notificaciones Programadas, haz clic en el botón Programar o Enviar Ahora.

3. En el diálogo de Notificación, ingresa valores para los siguientes campos:

   • Para: Haz clic en el menú, luego selecciona una de las siguientes opciones:

     • Todos

     • Un grupo de usuarios basado en lo siguiente:

       • Su acceso a una aplicación o fuente de datos otorgado por sus grupos o roles.

       • Grupo de seguridad.

       • Roles de la fuente de datos.

   • De: Define quién envió la notificación (generalmente el usuario del servicio).

   • Programar Para: (Opcional) Programa una notificación para que se envíe más tarde (por ejemplo, una hora antes de una actualización de aplicación planificada).

   • Expira En: Una fecha/hora en la que la notificación expira y ya no se mostrará a los usuarios. En este momento, los usuarios que han visto y desestimado el mensaje tienen la notificación eliminada de sus centros de notificación.

   • Cuerpo: El contenido del mensaje mostrado a los usuarios.

4. Haz clic en el botón Enviar o Programar.

Un servicio en segundo plano envía notificaciones programadas. Por defecto, el servicio es ejecutado por la cuenta de Usuario del Servicio. Para cambiar qué usuario ejecuta el servicio, sigue estos pasos:

1. Selecciona IDE > Mantenimiento (Beta), luego selecciona la pestaña Configuraciones.

2. Haz clic en el menú Usuario de Notificación en Segundo Plano, luego selecciona el usuario para ejecutar el servicio.