Notificaciones en Jitterbit App Builder

Descripción general

Las notificaciones son mensajes que App Builder envía a los usuarios de tu aplicación cuando ocurre un evento, como un clic en un botón o una verificación programada. Una notificación se puede entregar como un correo electrónico, un mensaje de texto, una alerta dentro de la aplicación o una notificación push, y opcionalmente puede permitir que el destinatario responda navegando a una página o activando un evento.

Esta página describe los tres pasos necesarios para configurar notificaciones en tus aplicaciones:

1. Configurar un servidor de notificaciones
   Configura el servidor utilizado para entregar notificaciones.

2. Crear una notificación
   Define el contenido del mensaje y el objeto utilizado para enviarlo.

3. Agregar opciones de respuesta
   Opcionalmente, permite que los destinatarios respondan navegando a una página o activando un evento.

Esta página también incluye tutoriales completos de todo el proceso, con dos ejemplos: una notificación dentro de la aplicación y un mensaje SMS.

Para mensajes enviados por administradores a múltiples usuarios a la vez, en lugar de ser activados por un evento de la aplicación, consulta Notificaciones del sistema.

Paso 1: Configurar un servidor de notificaciones

Antes de poder enviar una notificación, debes configurar al menos un servidor de notificaciones para el método de entrega que planeas usar. App Builder admite los siguientes métodos de entrega:

• Correo electrónico, enviado a través de un servidor SMTP.

• SMS (mensaje de texto), enviado a través de Twilio.

• Dentro de la aplicación (alerta de App Builder), una ventana emergente que se muestra al destinatario mientras inicia sesión en la aplicación.

• Push, enviado a través de Jitterbit Blabber, para aplicaciones que utilizan el Jitterbit Wrapper o un wrapper personalizado, o a través de OneSignal, para aplicaciones móviles nativas que utilizan tu propia cuenta de OneSignal.

Para ver y administrar servidores de notificaciones, selecciona IDE > Notification Servers:

La lista de servidores consta de las siguientes columnas:

• Nombre: El nombre del servidor.

• Tipo: El tipo de notificación que se puede configurar con ese servidor.

• Descripción: Una breve descripción.

• URI: La URI (si aplica).

• Estado: El estado actual del servidor.

Haz doble clic en cualquier fila o haz clic en el ícono al final para ver y editar los detalles de un servidor determinado. Todos los servidores excepto Dentro de la aplicación requieren configuración antes de usarlos:

• SMTP (Correo electrónico) requiere que se completen la dirección de remitente, la URI y las secciones de Seguridad.
• Blabber, OneSignal y SMS requieren que se complete la sección de Seguridad.

Paso 2: Crear una notificación

Crear una notificación significa crear una regla de negocio con su Propósito establecido en Notificación, desde la pestaña Notificaciones del Banco de Trabajo de la Aplicación. La regla define el contenido del mensaje de la notificación y selecciona el objeto de datos público (Método de Entrega) utilizado para enviarlo, como Correo electrónico, Mensaje de texto, Alerta de App Builder o Notificación Push.

Para crear una notificación:

1. Navega a Banco de Trabajo de la Aplicación > Notificaciones.
2. Haz clic en + Notificación.
3. Asígnale un Nombre.
4. Confirma que Propósito es Notificación.
5. Selecciona el Método de Entrega que deseas usar. Cada método de entrega envía una notificación a través de un objeto de datos público específico, que determina los detalles de la notificación. Si el objeto de datos que necesitas no está disponible, es posible que tengas que crear 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 Crear.

Hacer clic en Crear abre el Generador de Reglas en modo de edición, donde defines las columnas que utiliza la notificación, de la misma manera que cuando editas cualquier otra regla de negocio. Para las columnas disponibles en cada método de entrega, consulta Objetos de datos públicos por método de entrega a continuación.

Objetos de datos públicos por método de entrega

Cada método de entrega envía una notificación a través de un objeto de datos público específico — un conjunto predefinido de columnas que determina detalles como el destinatario, remitente y comportamiento de entrega. El Método de Entrega que selecciones cuando crees una notificación determina a qué objeto de datos público deben asignarse las columnas de tu notificación, en la definición mvSQL del Rule Builder.

Las siguientes secciones describen las columnas disponibles para cada objeto de datos público, además de las columnas comunes a todos ellos.

Columnas comunes

Estas columnas son comunes a todos los objetos de datos públicos descritos a continuación:

Correo electrónico

Las columnas para el objeto de datos público Email son las siguientes:

Las notificaciones enviadas por correo electrónico pueden incluir archivos adjuntos de muchos tipos de archivo, como .pdf, .docx, .txt o .xlsx, utilizando las columnas Attachment() y FileDataSourceId descritas a continuación. App Builder adjunta archivos del directorio data/pdf de forma predeterminada, o del directorio especificado por FileDataSourceId.

Si la notificación contiene opciones, la columna AppBuilderUrl especifica la URL utilizada al generar enlaces a esas opciones. Si no se proporciona AppBuilderUrl, App Builder recurre a la URL predeterminada del sitio del servidor, configurada desde IDE > Security Providers > More (desde el panel de Configuración) > Sites. Para más información, consulta Sitios y alias.

Mensaje de Texto

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

Alerta de App Builder

Las columnas del objeto de datos público Alerta de App Builder son las siguientes. Este objeto es similar, pero no idéntico, al objeto de datos público Notification_Create.

Notificación Push

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

Escribir el mensaje de notificación

Para escribir el mensaje de la notificación, haz clic en la pestaña Notificaciones de nuevo y selecciona tu notificación del panel Reglas de Notificación. Ingresa el mensaje en el campo Body del panel Mensaje; este campo es obligatorio, y el evento de notificación falla con un error si se deja vacío.

El mensaje admite sustituciones usando la sintaxis {{fieldname}}, que App Builder reemplaza con el valor de columna correspondiente cuando se envía la notificación. Por ejemplo, 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 obligatorios. 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}}. Una bandera HTML opcional trata el marcado HTML en el valor como texto plano, por ejemplo {{fieldname|HTML}} sustituye un valor de <b>Jitterbit</b> como Jitterbit.

Para la mayoría de los mensajes, editar el campo Body de texto plano es suficiente. Si necesitas un formato personalizado más allá del texto plano, haz clic en Más > Editar HTML para editar directamente el HTML subyacente del mensaje.

Para emails, también debe especificarse un Subject, que también admite sustituciones; como el campo Body, dejarlo vacío hace que el evento de notificación falle con un error.

Traducciones

Si tu aplicación admite varios idiomas, también puedes traducir una notificación. Tres campos admiten esto: el Body de la notificación, su Subject (para emails) y el Name de cada opción de respuesta. En lugar de ingresar texto literal en estos campos, ingresa una clave de traducción; App Builder busca el valor para el idioma del destinatario en el paquete de traducciones de la aplicación cuando se envía la notificación.

Debes agregar manualmente estas claves de traducción al paquete de traducciones de la aplicación; App Builder no las importa automáticamente.

Si editas el mensaje usando More > Edit HTML, agrega la clave de traducción como una cadena de texto sin formato en lugar de HTML, o la búsqueda fallará.

Para más información sobre cómo configurar idiomas y paquetes de traducciones, consulta Translations.

Step 3: Add response options

Una notificación puede incluir opcionalmente una o más opciones de respuesta que permiten al destinatario responder. Una notificación sin opciones es puramente informativa: App Builder no realiza un seguimiento de la respuesta y no se agregan enlaces al mensaje.

Cuando una notificación tiene una o más opciones, App Builder realiza un seguimiento automático de la respuesta del destinatario. Para correos electrónicos y alertas de App Builder, cada opción es un enlace en el que se puede hacer clic para volver a App Builder. Para SMS, el destinatario responde con el Nombre de la opción para seleccionarla.

Los enlaces de notificación vencen después de 7 días y no se pueden configurar para que duren más tiempo.

Para agregar una opción de respuesta a una notificación:

1. En el panel Options de la notificación, haz clic en el botón + Option.
2. Establece Index para determinar el orden de la opción en relación con otras opciones.
3. Establece Name para identificar la opción. Para una opción SMS Reply, este es también el texto que el destinatario debe responder.
4. Establece Option Type en Link o SMS Reply.
5. Para una opción Link, selecciona la página a la que vincular en Link To Page. La página debe estar marcada como Public en su configuración Edge Case.
6. Haz clic en Save.

Si navegas a la página seleccionada en Link To Page, se completa la respuesta para una opción Link. Si esa página también tiene un evento de lógica empresarial vinculado a ella, el evento se ejecuta antes de que se represente la página, y completar la respuesta también depende de que ese evento se ejecute correctamente. Consulta Data object event binding a continuación para ver las restricciones que se aplican a ese evento.

Data object event binding

Cuando la página vinculada en el campo Link To Page de una opción de respuesta también tiene un evento de lógica empresarial vinculado a ella, ese evento debe pertenecer al primer panel de la página (el panel con el índice más bajo, en la posición superior izquierda) o al objeto de datos público de la página, si uno está definido. Los eventos que pertenecen a cualquier otro panel de la página no se pueden vincular a una opción de respuesta.

Por ejemplo, considera una página apilada con dos grupos uno al lado del otro: el primero, con índice 10, contiene los paneles Customer y CustomerAddress, y el segundo, con índice 20, contiene los paneles Employee y EmployeeAddress:

Customer es el primer panel de la página, por lo que sus eventos son elegibles. CustomerAddress, Employee y EmployeeAddress no son elegibles, ya que ninguno de ellos es el primer panel de la página.

App Builder también solo permite vincular a eventos personalizados, no a eventos del sistema. Por ejemplo, no puedes vincular a los eventos Save, Insert, Update o Delete.

Cuando se completa el evento vinculado, App Builder redirige al destinatario a la página, pero en ese momento se pierden los mensajes posteriores o los resultados de validación del evento, ya que App Builder no los muestra al destinatario para eventos a nivel de página. Puedes solucionar esto mostrando datos en los paneles de la página que cambien según si el evento se ejecutó correctamente. Por la misma razón, una advertencia de validación simplemente impide que el evento se ejecute, porque no hay mecanismos para que el destinatario la acepte o rechace.

En este punto, ya tienes todo lo que necesitas para crear una notificación: un servidor para entregarla, una regla que defina su mensaje y datos, y, opcionalmente, una o más opciones de respuesta.

Full walkthroughs

Los siguientes ejemplos te guían a través de todo el proceso de creación de una notificación, desde la configuración de un método de entrega hasta la adición de una opción de respuesta. El primer ejemplo utiliza App Builder Alert como método de entrega; el segundo utiliza Text Message (SMS).

Configuración de notificación de ejemplo

Este ejemplo añade una notificación de aprobación de cliente a la página Customers de una aplicación hipotética llamada Northwinds, utilizando App Builder Alert como método de entrega.

1. Crea la notificación y establece su método de entrega:

   1. Navega a App Workbench.
   2. Haz clic en Notifications.
   3. Haz clic en + Notification.
   4. Asígnale un Name. Por ejemplo: CustomersRequestApprovalAlert.
   5. Confirma que Purpose es Notification.

   6. Selecciona App Builder Alert como Delivery Method.

      Nota

      Si no ves este objeto de datos disponible, crea una conexión de fuente de datos a App Builder (Sealed) para la aplicación en la que estás trabajando.

   7. Haz clic en Create.

2. Define el mvSQL de la notificación, asignando la tabla Customers a las columnas que el objeto App Builder Alert necesita:

   1. Haz clic en el botón +Tables.
   2. Añade tu tabla Select From, que en este caso es Customers.

   3. Añade las siguientes columnas y haz clic en la pestaña Columns para definir:

      Column	Alias	Target
      'all'	To	To
      "C".CustomerId	CustomerId	Binding()
      "C".CustomerName	CustomerName

      Nota

      CustomerName se añade aquí para que pueda utilizarse posteriormente como parámetro de sustitución en el mensaje de notificación.

3. Escribe el mensaje de la notificación:

   1. Navega a App Workbench.
   2. Haz clic en Notifications.
   3. Selecciona la notificación que creaste en el paso 1, que en nuestro ejemplo es CustomerRequestApprovalAlert.

   4. Introduce el mensaje en el campo Body, por ejemplo:

      Please review the following customer:
      Customer: {{CustomerName}}

   5. Haz clic en el icono e introduce cualquier Technical Help para ayudar a explicar la notificación a otros desarrolladores.

4. (Opcional) Añade una opción de respuesta que se vincula a una página:

   1. Desde la página App Workbench > Notifications, 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 Review.
      3. Selecciona el valor Link To Page. En este ejemplo, vincula a la página Customers. Si la página a la que deseas vincular no aparece, asegúrate de que esté marcada como Public en su configuración de Edge Case.
      4. Haz clic en Save.

5. Este ejemplo asume que la página Customers ya está marcada como Public, con un evento denominado Request Approval definido en su primer panel. Vincula ese evento al enlace de la opción, para que se ejecute cuando el destinatario lo siga:

   1. Navega al evento del objeto de datos.
   2. Haz clic en el icono Business Logic.
   3. Haz clic en el botón Events.
   4. Selecciona el evento. Por ejemplo: Request Approval.
   5. Haz clic en Register Existing desde el panel Actions.
   6. Selecciona Notification como Action Type.
   7. Selecciona la notificación que creamos en el paso anterior. Por ejemplo: CustomerRequestApprovalAlert.
   8. Haz clic en Save.
   9. Verifica que los Explicit Bindings sean correctos. Por ejemplo: CustomerId - CustomerId.

6. Prueba la notificación. Navega a tu página y haz clic en el botón que ejecuta el evento de notificación. Todos los usuarios de App Builder que hayan iniciado sesión deberían ver una ventana emergente con el mensaje de notificación.

Configuración de notificación SMS de ejemplo

Este ejemplo añade la misma notificación de aprobación de cliente a la misma página Customers, utilizando Text Message (SMS) como método de entrega.

1. Configura la seguridad de App Builder, para que App Builder pueda autenticar las respuestas SMS entrantes de Twilio:

   1. Navega a IDE > Security Providers.
   2. Haz clic en + Security Provider.
      1. Introduce un Name (p. ej. Http Basic Auth).
      2. Selecciona HTTP Basic Authentication como Type.
      3. Haz clic en Enabled para habilitar.
      4. Haz clic en Save.
   3. Navega a IDE > User Management.
      1. En el panel Users, localiza el usuario que deseas autenticar cuando llegue una respuesta SMS. Haz doble clic en la fila del usuario o haz clic en el icono al final de la misma. Se abre el diálogo User.

1. Haz clic en Más > Claves. Se abre el diálogo Claves.
2. Haz clic en Crear. Se abre el diálogo Generar Clave.
3. Selecciona el proveedor Http Basic Auth creado anteriormente.
4. Haz clic en Guardar.

1. Configura Twilio para enviar y recibir mensajes SMS:

   1. Crea un servicio de mensajería:

      1. Inicia sesión en tu cuenta de Twilio.
      2. Ve a Communications Cloud > Programmable SMS.
      3. Haz clic en Messaging Services.
      4. Crea un nuevo Messaging Service (Notificaciones, bidireccional) y adjunta un número de teléfono de Twilio a él.
      5. Anota el MessagingServiceSid. Se utilizará para la configuración más adelante.
      6. Habilita la opción Process Inbound Message.
      7. Ingresa la siguiente URL de Solicitud, reemplazando <username>, <secret_key> y <your_AppBuilder_Server> con tus valores: https://<username>:<secret_key>@<your_AppBuilder_Server>/webhook/v1/vinyl/bridge_inbound

   2. Recopila las credenciales de Twilio:

      1. Ve a Console Dashboard > Settings.
      2. Anota las siguientes credenciales activas:
         • Account Sid
         • Auth Token

2. Conecta App Builder a Twilio, utilizando las credenciales recopiladas en el paso anterior:

   1. Ve a IDE > Servidores de Notificación.
   2. Haz doble clic en la fila SMS.
   3. Añade la siguiente configuración:
      • Nombre de Usuario: Ingresa tu Account Sid de Twilio.
      • Contraseña: Ingresa tu Auth Token de Twilio.
      • MessagingServiceSid: Ingresa tu MessagingServiceSid de Twilio.

3. Establece la URL del sitio web que App Builder utiliza al generar enlaces en el mensaje SMS:

   1. Ve a IDE > Proveedores de Seguridad.
   2. Bajo Configuración, haz clic en Más > Sitios.
   3. Haz clic en + Sitio.
   4. Establece el valor de URL en la URL de tu sitio web. Por ejemplo: https://vinyl.jitterbit.com.
   5. Haz clic en Guardar.

4. Ahora, crea y configura la notificación SMS en sí, siguiendo el mismo proceso general que el ejemplo anterior, pero esta vez, en lugar de App Builder Alert, selecciona Mensaje de Texto como el Método de Entrega:

   1. Crea la notificación y establece su método de entrega:

      1. Ve a App Workbench > Notificaciones.
      2. Haz clic en + Notificación.
      3. Asígnale un Nombre.
      4. Selecciona Notificación como el Propósito.

      5. Selecciona Mensaje de Texto como el Método de Entrega.

         Nota

         Si no ves este objeto de datos disponible, crea una conexión de fuente de datos a App Builder (Sealed) para la aplicación en la que estés trabajando.

      6. Haz clic en Crear.

   2. Define el mvSQL de la notificación, asignando las columnas de número de teléfono y cliente al objeto Mensaje de Texto:

      1. Haz clic en el botón +Tabla y añade la tabla que requiere la regla. Por ejemplo, Customers.

      2. Haz clic en la pestaña Columnas y añade las siguientes columnas:

         Columna	Alias	Destino
         '+15551112222' (reemplaza con tu número de teléfono)	To()	To()
         "C".CustomerId	CustomerId	Binding()
         "C".CustomerName	CustomerName

         Nota

         CustomerName se añade aquí para poder utilizarse más adelante como parámetro de sustitución en el mensaje de notificación.

   3. Redacta el mensaje y añade dos opciones de respuesta: una a la que el destinatario pueda responder por SMS, y otra que enlace a una página:

5. Haz clic en la pestaña Notificaciones. 2. Ingresa el siguiente mensaje en el campo Cuerpo:

       ```
       Reply {{1}} to approve {{CustomerName}}. Review {{Review}}
       ```
   
   3.  Haz clic en el botón **+ Opción** del panel **Opciones**:
       1.  Establece **Índice** en `10`.
       2.  Establece **Nombre** en **Review**.
       3.  Selecciona la página a la que deseas vincular. En nuestro ejemplo, nos vincularemos a la página **Customer** de Northwinds. Si la página que deseas vincular no aparece, asegúrate de que esté marcada como **Pública** en su configuración de **Caso extremo**.
       4.  Establece el **Tipo de opción** en **Vínculo**.
       5.  Haz clic en **Guardar**.
   
   4.  Haz clic en el botón **+ Opción** del panel **Opciones**:
       1.  Establece **Índice** en `20`.
       2.  Establece **Nombre** en **1**.
       3.  Selecciona la página a la que deseas vincular. En nuestro ejemplo, nos vincularemos a la página **Customer** de Northwinds y ejecutaremos el evento `Approve`.
       4.  Establece el **Tipo de opción** en **Respuesta SMS**.
       5.  Haz clic en **Guardar**.
   

   1. Este ejemplo asume que la página Clientes ya está marcada como Pública, con un evento denominado Solicitar aprobación definido en su primer panel. Vincula ese evento a la opción Vínculo para que se ejecute cuando el destinatario la siga:

      1. Ve al evento para el objeto de datos.
      2. Haz clic en el icono Lógica empresarial.
      3. Haz clic en el botón Eventos.
      4. Selecciona el evento. Por ejemplo: Solicitar aprobación.
      5. Haz clic en Registrar existente del panel Acciones.
      6. Selecciona Notificación como el Tipo de acción.
      7. Selecciona la notificación que creamos en el paso anterior. Por ejemplo: Customer_RequestApprovalSms.
      8. Haz clic en Guardar.
      9. Verifica que los Enlaces explícitos sean correctos. Por ejemplo: CustomerId - CustomerId.

   2. Prueba la notificación. Ve a tu página y haz clic en el botón que ejecuta el evento de notificación.

Notificaciones del sistema

A diferencia de las notificaciones descritas anteriormente en esta página, que App Builder envía automáticamente a un destinatario específico cuando ocurre un evento empresarial, las notificaciones del sistema son mensajes de difusión que un administrador envía manualmente o programa para enviar posteriormente a un grupo de usuarios a la vez, por ejemplo, todos con acceso a una aplicación o un grupo de seguridad o rol específico. Los administradores utilizan notificaciones del sistema para cosas como ventanas de mantenimiento planeado o actualizaciones de aplicaciones, que no es necesario vincular a un registro específico o desencadenar por un evento.

Las notificaciones del sistema se muestran a los usuarios activos y permanecen en su Centro de notificaciones (en el menú de hamburguesa) hasta que se descartan o vencen. Las notificaciones del sistema forman parte de la característica Mantenimiento y solo admiten alertas en la aplicación. También son específicas del entorno: a diferencia de las notificaciones de aplicación, que se promueven con tu código entre entornos, una notificación del sistema debe recrearse en cada entorno.

Para configurar una notificación del sistema, selecciona IDE > Mantenimiento y luego selecciona la pestaña Notificaciones (disponible desde App Builder 4.44) y sigue estos pasos:

1. En el panel Notificaciones programadas, haz clic en el botón Programar o enviar ahora.

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

   • Para: Haz clic en el campo y luego selecciona uno de lo siguiente:

     • 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.

       • Grupos de seguridad.

       • Los 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 posteriormente (por ejemplo, una hora antes de una actualización de aplicación planeada).

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

3. Body: El contenido del mensaje que se muestra a los usuarios.

4. Haz clic en el botón Send o Schedule.

Un servicio en segundo plano envía las notificaciones programadas. De forma predeterminada, el servicio se ejecuta con la cuenta del Service User. Para cambiar qué usuario ejecuta el servicio, sigue estos pasos:

1. Selecciona IDE > Maintenance, luego selecciona la pestaña Settings.

2. Haz clic en el menú Background Notification User y luego selecciona el usuario que ejecutará el servicio.