sc_send_notification('title', 'message', 'destiny_type', 'to', 'from', 'link', 'dtexpire', 'profile')

La macro sc_send_notification permite enviar notificaciones a los usuarios del sistema de forma dinámica.

 

Descripción de los Parámetros

Parámetro Descripción Ejemplo
title =>

Parámetro obligatorio que recibe el título de la notificación que será enviada.

El texto puede ser proporcionado entre comillas, utilizando variables o langs.

Usando variable
$title_not = "título del mensaje";
'title' => $title_not

Texto directo en la macro o con lang
'title' => 'título del mensaje' o 'title' => '{lang_titulo_notificacion}' 
message =>

Parámetro obligatorio que recibe el cuerpo del mensaje de notificación que será enviado.

Este parámetro permite el uso de textos con o sin formato HTML y puede ser proporcionado entre comillas, variables o lang.

Usando variable
$msg_not = "Cuerpo del mensaje de notificación";
'message' => $msg_not

Texto directo en la macro
'message' => 'Cuerpo del mensaje de notificación'
destiny_type =>

Parámetro obligatorio que define qué datos deben ser proporcionados en el parámetro to para el envío de la notificación.

Los valores que deben ser proporcionados son:

  • 'user' - Define que el parámetro to deberá recibir el login de los usuarios que deben recibir el mensaje de notificación.
  • 'group' - Define que el parámetro to deberá recibir los nombres de los grupos, del módulo de seguridad, que deben recibir el mensaje de notificación. Esta opción está disponible solo en sistemas que utilizan el módulo de seguridad por grupo.
  • 'all' - Define que todos los usuarios del sistema deben recibir el mensaje de notificación. En este caso, el parámetro to debe ser pasado como vacío.
  • 'profile' - Define que el parámetro to deberá recibir el nombre de los perfiles creados en el sistema de notificación, en la aplicación Enviar notificación, que deben recibir el mensaje.
 Ejemplo de cómo el parámetro debe ser informado
'destiny_type' => 'user'

Los valores aceptados son: user, group, all y profile
to =>

Define los usuarios del sistema que deben recibir la notificación, dentro del universo informado en el parámetro destiny_type.

  • Al informar destiny_type =>'user' - El desarrollador debe proporcionar una lista del login de los usuarios que deben recibir la notificación. Los valores informados deben estar separados por punto y coma (;).
  • Al informar destiny_type => 'group' - El desarrollador debe proporcionar la lista de grupos de usuarios, del módulo de seguridad, que deben recibir la notificación.
  • Al informar destiny_type => 'all' - En este caso, todos los usuarios del sistema deben recibir la notificación y el parámetro to debe recibir valor vacío.
  • destiny_type => 'profile' - El desarrollador debe informar el nombre de los perfiles creados en el sistema de notificación, en la aplicación Enviar notificación, que deben recibir el mensaje.

En todos los casos, los valores informados deben estar separados por punto y coma (;)

Ejemplo al utilizar destiny_type =>'user'
'to' => 'joao;pedro;carlos'

Ejemplo al utilizar destiny_type =>'group'
'to' => 'empleados;administradores'

Ejemplo al utilizar destiny_type =>'all'
'to' => ''

Ejemplo al utilizar destiny_type =>'profile'
'to' => 'nombre_grupo_de_envío1;nombre_grupo_de_envío2'
from =>

Parámetro obligatorio que define el usuario del sistema que está enviando la notificación.

Este parámetro acepta solo un valor a la vez y puede ser definido proporcionando directamente el nombre de un usuario o a través de una variable.

 'from' => 'admin'
link =>

Parámetro opcional que recibe un enlace para acceder a una aplicación del sistema o una URL externa.

El texto puede ser proporcionado entre comillas, utilizando variables.

Proporcionando una URL externa
'link' => 'https://scriptcase.com.br/'

Proporcionando una aplicación del sistema
'link' => 'app_name'
dtexpire =>

Parámetro opcional que define el día y hora en que la notificación expirará y dejará de ser exhibida en el ícono de acceso rápido del menú. Al alcanzar la fecha, el usuario podrá acceder al mensaje solo a través de la aplicación de inbox.

El formato de la fecha y hora debe ser: YYYY-MM-DD HH:MM:SS

 'dtexpire' => '2024-10-02 23:59:59'
profile =>

Parámetro obligatorio que debe recibir el nombre del perfil que el desarrollador informó al crear el módulo de notificación en la interfaz de Scriptcase.

 'profile' => 'samples_notification'

 

Ejemplo

$title = 'Nuevo usuario';
$msg = 'Usuario: ' . $struser . ' registrado en el sistema';

sc_send_notification([
    'title' => $title,
    'message' => $msg,
    'destiny_type' => 'user',
    'to' => 'admin',
    'from' => 'admin',
    'link' => '',
    'dtexpire' => '2024-10-02 23:59:59',    
    'profile' => 'samples_profile_name',
]);