Invoke Playbook

Invoke Playbook

Type: invoke-playbook  ·  Package: Core Activities v1.0.0

Runs another playbook of the same project, optionally passing input data to it and receiving its results back. It’s the tool to break a large automation into small pieces and reuse logic: instead of copying and pasting the same group of activities in multiple places, you put it in a sub-playbook and invoke it.

How it works

1. Runs the playbook indicated in path, passing it the values of input.
2. The sub-playbook runs from start to finish with its own variable space (it does not see or modify those of the playbook that called it).
3. Upon completion, its outputs are mapped to variables of the current playbook according to outputs.
4. If the sub-playbook fails, the invocation fails (catchable with Try / Catch).

Required parameters

Parameter	Editor	Description
path	selector de playbook	The child playbook to run. relative path within the project.

Optional parameters

Parameter	Editor	Description
input	tickets	Values that the sub-playbook receives, as nombre: valor pairs.
outputs	salidas	Mapping the child’s outputs to variables of the current playbook.

Example

For each invoice, invoke a sub-playbook that processes it and returns a status:

For Each   items = = facturas   itemVariable = factura
 └─ activities:
      Invoke Playbook
        path    = "procesar-factura.json"
        input   = = { factura: factura, reintentos: 3 }
        outputs = = { estado: estadoProcesamiento }
      Log   level = info   message = = "Factura procesada: " + estadoProcesamiento

• input: The child receives factura and reintentos as input variables.
• outputs: The estado output of the child is saved in the estadoProcesamiento variable of the parent.

Cada playbook tiene sus propias variables

The sub-playbook does not share variables with the caller. Communication is only through input (to the child) and outputs (back to the parent). This keeps each piece insulated and reusable. See Scope of variables.

The parent variable that receives an output (estadoProcesamiento in the example) must be declared in the parent in order to receive the value.

Only relative paths within the project

path must be a relative path to the project; no absolute paths or .. segments are allowed. This prevents a playbook from executing files outside of its project. To expose an output from the sub-playbook, it declares it with the Set Output activity.

Related activities

• Variables — how inputs are passed and outputs received.
• Try / Catch — handle failure of a sub-playbook.
• Designer Overview — projects with multiple playbooks.