Should Stop

Should Stop

Tipo: should-stop  ·  Paquete: Core Activities v1.0.8  ·  Salida: bool

Desde: v1.0.5

Devuelve verdadero cuando alguien pidió Detener la ejecución: desde el portal de Zoan Cloud, desde el Designer o desde la bandeja del Agent. Sirve para que el proceso pare en un punto seguro —antes de tomar el siguiente elemento, entre dos pasos— y cierre limpio, en vez de quedar a medias.

No detiene nada por sí sola: tú decides dónde consultarla y qué hacer si devuelve verdadero (normalmente salir del bucle con Break y dejar que el cierre corra).

Cómo funciona

• Responde al instante, sin esperar: puedes consultarla en cada vuelta de un bucle sin costo.
• Una vez pedida la detención, devuelve true en todas las consultas siguientes de esa ejecución, también dentro de playbooks y procesos invocados.
• Cada vez que devuelve true deja en el log: Se pidió detener: terminando de forma ordenada.

Detener y Terminar

Acción	Qué hace	Cómo queda la ejecución
Detener	Pide al robot que pare cuando termine lo que está haciendo. El proceso lo ve con Should Stop.	Detenida (stopped)
Terminar	Corta la ejecución de inmediato. Lo que estaba haciendo queda a medias; el finally de un Try / Catch tiene unos segundos para cerrar lo abierto.	Cancelada (cancelled)

Ver Estados y ciclo de vida.

Parámetros requeridos

Ninguno.

Parámetros opcionales

Ninguno.

Salida

Tipo	Descripción
bool	true si se pidió detener la ejecución; false si no.

Ejemplo

Procesar una lista y parar limpio si alguien pide detener:

For Each   items = elementos   itemVariable = elemento
 └─ activities:
      Should Stop   → output: detener
      If   condition = detener
       └─ then:
            Log     message = "Se pidió detener: quedan elementos sin trabajar."
            Break                     // no se toma el siguiente elemento
      Invoke Playbook   path = "ProcesarElemento.json"   input = { elemento: elemento }

El elemento en curso siempre termina; el siguiente no empieza, y lo que venga después del bucle (la bitácora, el cierre de la aplicación) se ejecuta con normalidad.

Process Queue ya lo hace solo

Process Queue consulta la detención antes de tomar cada item: termina el que está procesando y deja el resto en la cola. No necesitas Should Stop dentro de su cuerpo.

Si el proceso nunca la consulta

Un proceso que no usa Should Stop (ni Process Queue) no se entera de que se pidió detener y sigue hasta el final. En ese caso el portal muestra «Deteniendo…» y, pasados unos minutos, ofrece Terminar.

Errores comunes

Esta actividad no puede fallar: siempre devuelve true o false.

Actividades relacionadas

• Break — salir del bucle al detectar la detención.
• Try / Catch — el finally corre también si la ejecución se termina.
• Process Queue — respeta la detención por sí sola.