Evento OnSave de formulario (referencia de API de cliente) en aplicaciones basadas en modelos

El evento ocurre cuando: OnSave

• El usuario selecciona el botón Guardar o Actualizar en la barra de comandos, incluso cuando no hay datos modificados para guardar.
• El código ejecuta el método formContext.data.entity.save , incluso cuando no hay datos modificados para guardar.
• El usuario navega fuera del formulario y hay datos sin guardar en el formulario.
• La opción Autoguardado está habilitada, 30 segundos después de que los datos han cambiado y hay datos sin guardar en el formulario.
• El código ejecuta el método formContext.data.save y hay datos sin guardar en el formulario.
• El código ejecuta el método formContext.data.refresh pasando un valor verdadero como primer parámetro y hay datos sin guardar en el formulario.

Nota

El evento para registros de cita, cita recurrente o actividad de servicio realizará la operación de guardado y usará el mensaje para persistir el cambio en lugar de OnSave o Book . Create Update Debido a esto, los controladores de eventos OnSave y PostSave para estas tablas no funcionarán.

Para determinar qué botón se hizo clic para guardar, utilice el método getSaveMode .

Puede cancelar la acción de guardar mediante el método preventDefault en el objeto de argumentos del evento. Se puede acceder al método preventDefault mediante el método getEventArgs que forma parte del contexto de ejecución. El contexto de ejecución se transfiere automáticamente al controlador de eventos del formulario.

Compatibilidad con el controlador de eventos asincrónico

El evento OnSave tiene la capacidad de esperar a que se cumplan las promesas devueltas por los controladores de eventos antes de guardar, lo que permite que el evento sea asincrónico ("async"). OnSave

El evento se vuelve asíncrono cuando el controlador del evento devuelve una promesa. OnSave OnSave El guardado del registro ocurre cuando se resuelve cada promesa devuelta por un controlador. Para las promesas que se devuelven, hay un límite de 10 segundos para cada promesa, después de eso, la plataforma considera que las promesas están vencidas. Este tiempo de espera se aplica según la promesa. Por ejemplo, si tenemos cinco promesas devueltas, el tiempo total de espera es de 50 segundos.

Si la promesa se rechaza o se agota el tiempo de espera, la operación de guardado continúa comportándose de manera similar a los errores de secuencia de comandos actuales. Utilice el método preventDefault dentro del objeto de argumentos de evento en ese controlador en particular si desea evitar que el evento de guardar ocurra si hay un error de script/una promesa rechazada o si el controlador agota el tiempo de espera.

También puede Cancelar realizar la operación de guardar independientemente del error en el controlador o sin usar el método preventDefault dentro del objeto de argumentos del evento. Si se llama a este método, el evento Async OnSave espera a que se resuelvan todas las promesas, pero no se guardará. Llamar a este método significa que se ejecutará la lógica dentro de .then() y .catch() .

El evento espera que se devuelva una promesa por controlador. OnSave Si se requieren múltiples promesas, se recomienda Encapsular todas las promesas en el método y devolver la única promesa resultante. Promise.all() Para varios controladores que devuelven una promesa, le recomendamos que cree un controlador que llame a todos los eventos y devuelva una única promesa que encapsule todas las promesas requeridas. Esta práctica es para minimizar los tiempos de espera causados por el tiempo de espera.

Escenario de ejemplo sobre cuándo usar controladores OnSave asíncronos

Considere la posibilidad de crear una tarea de servicio de orden de trabajo, debe validar que el activo del cliente seleccionado tenga la misma cuenta que aparece en la orden de trabajo. La obtención de la cuenta en la orden de trabajo y el activo del cliente son procesos asincrónicos y deben completarse antes de que se pueda realizar la validación.

En este escenario, dado que hay varios procesos asincrónicos y ambas llamadas devuelven una única promesa envolviéndolas en el método Promise.all() .

Nota

El método preventDefault sólo se puede utilizar de forma sincrónica.

Por ejemplo:

 function myHandler() {
    return Promise.all([getWorkOrderPromise, getCustomerAssetPromise]).then((values) => {
        var workOrder = values[0];
        var customerAsset = values[1];
        // Perform validation
        if (isValid(workOrder, customerAsset)) {
            return Promise.resolve();
        }
        return Promise.reject(new Error("Validation failed for the work order and customer asset"));
   });
 }

Habilitar Async OnSave usando la configuración de la aplicación

Para usar controladores onSave asíncronos, debe habilitarlos a través de una configuración de aplicación.

1. Vaya a https://make.powerapps.com.

2. Asegúrese de seleccionar el entorno correcto.

3. Seleccione Aplicaciones en el panel de navegación izquierdo.

4. Seleccionar la aplicación y luego Seleccionar ... (puntos suspensivos). Seleccione Editar.

5. Seleccione Configuración en la barra de comandos.

6. Cuando se abra el cuadro de diálogo, aparecerán las siguientes opciones: Seleccionar Características.

7. Activar el controlador Async onSave.

8. Seleccione Guardar.

   

Tiempos de espera de OnSave asincrónico

Cuando se utiliza un controlador async, el formulario espera a que se cumpla la promesa devuelta por el controlador. OnSave Para garantizar que el formulario se guarde completamente de manera oportuna, el controlador generará una excepción de tiempo de espera después de 10 segundos para informarle que debe ajustar el controlador async para obtener un mejor rendimiento. OnSave

Hay escenarios en los que es necesario pausar el controlador durante más de 10 segundos. OnSave Un ejemplo es abrir un diálogo y esperar la entrada del usuario antes de guardar. Para asegurarse de que la operación asincrónica espere a que se resuelva la promesa, utilice el método disableAsyncTimeout .

Nota

Debes llamar disableAsyncTimeout antes de cualquier declaración await o llamada async.

Por ejemplo:

async function myHandler(context) {  
     context.getEventArgs().disableAsyncTimeout();
     // The 10000ms time out will not be disabled if the above line does not come before all async awaits
     await Xrm.Navigation.openConfirmDialog({ text: "Are you sure you want to save?" });
 }

Cuando se llama a disableAsyncTimeout , no se aplica el tiempo de espera para ese controlador. Continúa esperando que se cumpla la promesa de ese manejador.

Este patrón debe usarse con precaución ya que podría afectar el rendimiento del guardado del formulario.

Artículos relacionados

cuadrícula Evento OnSave
Eventos (referencia de la API de cliente)
Eventos en formularios y cuadrículas en aplicaciones basadas en modelos