Node ASE Appointment

This node allows interaction with the Appointment Scheduling Enterprise (ASE) platform to schedule, reschedule, search, or cancel scheduled and walk-in appointments. In the Studio platform, you can use the ASE Appointment node from the Engageware category.

 In the video, we’ll show you how to access it and the parameters to configure it:

 Here you can download a sample flow with nodes from the Engageware category. 

Below you will find the description of the properties you will use in the process and the outputs of each action.

Properties:

1. Name (optional): This is the optional name of the node. From here, you can change the default value.

2. Credentials (required): These are the credentials for the Engageware Appointment Schedule Enterprise service. Multiple credentials can be stored, but only one can be active.

   In the configuration you’ll be asked for:

   • Instance URL: The environment URL.

   • Username: The user for API consumption (API user credentials).

   • Password: The API user password.

3. Action (required): These are the available operation types.

   • Book: Schedules an appointment at a specific date and time according to the criteria provided.

     • Client External ID (required): The ID of the previously created client. If created with a custom ID (e.g., email), it must be provided exactly as created.

     • Start Date Time (required): The appointment start date and time (for scheduling or rescheduling) in ISO 8601 format.

     • Send Notification (optional): Sends an email to the client about the appointment using customizable templates from the Appointment Scheduling Enterprise (ASE) platform.

     • Criteria Properties: Criteria for scheduling the appointment, such as responses to specific questions or SMS alerts.

       • SMS Phone Number: the phone number in international format: +{country_code}{mobile_access_code}{cell_number}, e.g., +54911XXXXXXXX.

       • SMS Enabled (boolean): When filled in, this enables sending an SMS confirmation to the configured number. This feature requires activation via a Service Request ticket.

   • Enqueue: Schedules a walk-in (ad hoc) appointment according to the criteria provided.

     • Client External ID (required): The ID of the client created previously.

     • Send Notification (optional): Sends an email to the client about the appointment.

     • Criteria Properties: The criteria for scheduling the appointment.

       • SMS Phone Number: The phone number in international format.

       • SMS Enabled (boolean): Enables sending an SMS confirmation to the configured number.

   • Rebook: Reschedules an appointment while keeping the confirmation number.

     • Start Date Time (required): Date and time in ISO 8601 format.

     • Confirmation Number (required): The identifier code of the appointment, obtained when scheduling.

     • Resource Availability Required (required):

       • True: Requires resource availability, and it will also be removed from available slots.

       • False: Does not require resource availability, but it will still be removed from available slots.

     • Send Notification (optional):

       • Modification: Sends modified appointment details by email to the client.

       • Reassign: Sends reassignment details by email to the resources associated with the appointment.

     • Criteria Properties (optional): Properties that can be modified when rescheduling, such as responses or SMS alerts.

   • Get By Client: Searches for appointments by client ID within a date range.

     • Client External ID (required): The client ID created previously.

     • Start Date Time (required): The start date and time of the search in ISO 8601 format.

     • End Date Time (required): The end date and time of the search in ISO 8601 format.

   • Get By Confirmation Number: Searches for an appointment using its identifier obtained when scheduling.

     • Confirmation Number (required): The appointment identifier code, obtained when scheduling.

   • Cancel: Cancels a specific appointment.

     • Confirmation Number (required): The appointment identifier code, obtained when scheduling.

     • Send Notification (optional): Sends appointment cancellation details by email to the client.

Outputs: 

1. msg.payload.metadata.EW_ASE_BookAppointmentResponse: Returns the confirmation number if successful. If there’s an error, the property "error" will be returned.

2. msg.payload.metadata.EW_ASE_BookAdHocAppointmentResponse: Returns the confirmation number of the walk-in appointment if successful. If there’s an error, "error" will be returned.

3. msg.payload.metadata.EW_ASE_RebookAppointmentResponse: Returns the confirmation number of the rescheduled appointment if successful. If there’s an error, "error" will be returned.

4. msg.payload.metadata.EW_ASE_GetAppointmentByClientExternalIdResponse: Returns the client’s appointments if successful. If there’s an error, "error" will be returned.

5. msg.payload.metadata.EW_ASE_GetAppointmentByConfirmationNumberResponse: Returns the appointment for the given confirmation number if successful. If there’s an error, "error" will be returned.

6. msg.payload.metadata.EW_ASE_CancelAppointmentResponse: Returns status 0 if the cancellation is successful. If there’s an error, "error" will be returned.