Nodo ASE Appointment

Este nodo permite la interacción con la plataforma Appointment Scheduling Enterprise (ASE) para programar, reprogramar, buscar o cancelar citas calendarizadas y de demanda espontánea. En la plataforma Studio podrás usar el nodo ASE Appointment, desde la categoría Engageware.

En el vídeo te mostraremos cómo acceder y los parámetros para configurarlo:

 Aquí puedes descargar un ejemplo de un flujo con los nodos de la categoría Engageware.

Debajo encontrarás la descripción de las propiedades que utilizarás en el proceso y los outputs de cada acción.

Propiedades:

1. Name (opcional): es el nombre opcional del nodo. Desde aquí, puedes cambiar el valor predeterminado. 

2. Credentials (obligatorias): son las credenciales del Engageware Appointment Schedule Enterprise service. Se pueden guardar múltiples credenciales, pero solo una puede estar activa.
   
   En la configuración se solicitará:

   • Instance URL: la URL del entorno.

   • Username: el usuario para consumo de la API (credenciales del usuario de API).

   • Password: la contraseña del usuario de API.

3. Action (obligatoria): son los tipos de operación disponibles.

   • Book: programa una cita en una fecha y hora específicas, según los criterios proporcionados.

     • Client External ID (obligatoria): es el ID del cliente creado previamente. Si se creó con un ID personalizado, por ejemplo, con un email, debe proporcionarse este dato tal como se creó.

     • Start Date Time (obligatoria): indica la fecha y hora de inicio de la cita (para programar o reprogramar), en formato ISO 8601.

     • Send Notification (opcional): envía un correo electrónico al cliente sobre la cita utilizando plantillas personalizables desde la plataforma Appointment Scheduling Enterprise (ASE).

     • Criteria Properties: son las propiedades para programar la cita, como las respuestas a preguntas específicas o las alertas por SMS.

       • SMS Phone Number: es el número de teléfono en formato internacional: +{codigo_pais} {codigo_acceso_celular_pais}{numero_celular}, por ejemplo: +54911XXXXXXXX.

       • SMS Enabled (boolean): el completar este campo, se habilita el envío de un SMS con la confirmación al número configurado. Esta función requiere activación a través de un ticket de Service Request.

   • Enqueue: programa una cita de demanda espontánea (ad hoc), según los criterios proporcionados.

     • Client External ID (obligatoria): es el ID del cliente creado previamente.

     • Send Notification (opcional): envía un correo electrónico al cliente sobre la cita.

     • Criteria Properties: son las propiedades para programar la cita.

       • SMS Phone Number: es el número de teléfono en formato internacional.

       • SMS Enabled (boolean): habilita el envío de un SMS con la confirmación al número configurado. 

   • Rebook: permite reprogramar una cita manteniendo el número de confirmación.

     • Start Date Time (obligatoria): fecha y hora en formato ISO 8601.

     • Confirmation Number (obligatoria): código identificador de la cita, obtenido al agendar.

     • Resource Availability Required (obligatoria):

       • True: requiere disponibilidad del recurso, y además se removerá de los disponibles.

       • False: no requiere disponibilidad del recurso, pero también se removerá de los disponibles.

     • Send Notification (opcional):

       • Modification: envía por correo electrónico al cliente los detalles modificados de una cita específica.

       • Reassign: envía por correo electrónico al recurso o recursos los detalles de la reasignación de una cita específica.

     • Criteria Properties (opcional): propiedades que pueden modificarse en la reprogramación de la cita, como respuestas o alertas por SMS.

   • Get By Client: busca citas por ID de cliente en un rango de fechas.

     • Client External ID (obligatoria): ID del cliente creado con anterioridad

     • Start Date Time (obligatoria): fecha y hora de inicio de búsqueda en formato ISO 8601.

     • End Date Time (obligatoria): fecha y hora de fin de búsqueda en formato ISO 8601.

   • Get By Confirmation Number: busca una cita por el identificador obtenido al agendar. 

     • Confirmation Number (obligatoria): el código identificador de la cita, obtenido al agendar.  

   • Cancel: cancela una cita específica.

     • Confirmation Number (obligatoria): código identificador de la cita, obtenido al agendar.  

     • Send Notification (opcional): habilita el envío de los detalles de la cancelación de cita por correo electrónico al cliente.

 Outputs: 

1. msg.payload.metadata.EW_ASE_BookAppointmentResponse: devuelve el número de confirmación de la cita si se realiza correctamente. En caso de error, se devolverá la propiedad "error".

2. msg.payload.metadata.EW_ASE_BookAdHocAppointmentResponse: devuelve el número de confirmación de la cita de demanda espontánea si se realiza correctamente. En caso de error, se devolverá la propiedad "error".

3. msg.payload.metadata.EW_ASE_RebookAppointmentResponse: devuelve el número de confirmación de la cita reprogramada si se realiza correctamente. En caso de error, se devolverá la propiedad "error".

4. msg.payload.metadata.EW_ASE_GetAppointmentByClientExternalIdResponse: devuelve las citas correspondientes al cliente en caso de éxito. En caso de error, se devolverá la propiedad "error".

5. msg.payload.metadata. EW_ASE_GetAppointmentByConfirmationNumberResponse: devuelve la cita correspondiente al confirmation number en caso de éxito. En caso de error, se devolverá la propiedad "error".  

6. msg.payload.metadata.EW_ASE_CancelAppointmentResponse: devuelve el estado 0 si la cancelación se realiza correctamente. En caso de error, se devolverá la propiedad "error".