(Tabla de contenidos, TBA)
...
| Table of Contents |
|---|
En este tutorial, explicaremos cómo invocar ejecuciones de Notebook desde FlowEngine:.
With the new node Con el nuevo nodo "Notebook Launcher", we can now execute complete Notebooks or just the paragraphs that we need, in an orderly manner.
...
Let's see how we can use that node. To do this, we will follow the following steps:
Select the "FlowEngine Management" option from the menu:
...
Select the domain belonging to your user:
...
Once you are in the domain, drag a node of type "Notebook Launcher" to the flow and double click on it to see its properties.The following are the base properties:
Name: The name that you want the node to have when viewing it within the flow.
Onesait Platform Notebook: In this list, will select the Notebook on which you want to work.
Workflow mode: If it is active active, it allows the execution with the dependencies as they are represented in the flow. For example, take the following flow:If the "check" is active, paragraph 3 will be executed when 1 and 2 are. If it is deactivated, paragraph 3 will be executed when any of the others do.
Inputs & Execution: In this tab, select from among the execution modes:
Execute entire notebook:
If this "check" is activated, the entire notebook will be executed, following the paragraph order defined therein.
If it is deactivated, then the single paragraph execution mode is open, showing the following properties:Input Paragraph selecion: Selection of the paragraph we want to execute. The paragraph's ID will appear along with its title in parentheses (if it has been defined).Input Parameters mapping: If the paragraph has input parameters configured, they will appear for you to fill in. Their values can be informed in different ways:msg: From a field of the preeding msg.flow: From a global variable to the Flow.global: From a global variable.string: As a fixed character string.number: As a fixed number.boolean: As a fixed true/false logical value.timestamp: As a fixed timestamp.
Outputs: This tab also changes depending on whether we want to run the entire notebook or just one node.
Execution of a single paragraph: If the Execute entire notebook check is deactivated, the output configuration (outputs) is disabled. Since a single node is executed, the output will be unique.
Complete execution: If the Execute entire notebook check is marked, the following options will appear to define outputs:Enable Paragraph Output: If we mark it, it allows us to define different outputs with the results of the paragraphs we select.Split Outputs: The multi output selector is enabled.Outputs Number: It allows you to choose the number of outputs that you want in the nodeOutput Parameters mapping: For each output you have defined, you can select the paragraph whose result will be displayed by that output.The result would be the following:If we hover over the node's exit pins, we can see the paragraph to which it belongs.
...
Once the node is configured, we can see the defined outputs, which will have the following structure:
...
In the msg.payload.body, we will find the following result fields:
...
Title: Title of the executed paragraph..
...
Text: Contents of the executed paragraph.
...
User: User.
...
dateUpdated: Date of last paragraph update.
...
config: Paragraph configuration parameters.
...
settings: Displays the paragraph's input parameters and variables.
...
results: Contains the execution result.
code: Indicates whether the execution has been correct
msg: Array with the results of the paragraph execution. Each element will mark the type of data (type) and the result (data).
...
ahora podemos ejecutar Notebooks completos, o sólo los párrafos que necesitemos, de manera ordenada.
...
Veamos cómo podemos usar ese nodo. Para ello, seguiremos los siguientes pasos:
Elige la opción "Gestión de FlowEngine" del menú:
Elige el dominio perteneciente a tu usuario:
Una vez que estés en el dominio, arrastra un nodo de tipo "Notebook Launcher" al flujo y haz doble clic sobre él para ver sus propiedades.
Name: el nombre que quieras que tenga el nodo cuando lo veas dentro del flujo.
Onesait Platform Notebook: En esta lista, selecciona el Cuaderno sobre el que deseas trabajar.
Workflow mode: Si está activo, permite la ejecución con las dependencias tal como se representan en el flujo. Por ejemplo, tome el siguiente flujo:
Si el "check" está activo, el párrafo 3 se ejecutará cuando el 1 y el 2 se ejecuten. Si está desactivado, el párrafo 3 se ejecutará cuando cualquiera de los otros lo haga.
Inputs & Execution: En esta pestaña, selecciona entre los modos de ejecución:
Execute entire notebook (Ejecutar todo el notebook):
Si se activa este "check", se ejecutará todo el cuaderno, siguiendo el orden de párrafos definido en el mismo.
Si está desactivado, entonces el modo de ejecución de párrafo único está abierto, mostrando las siguientes propiedades:
Input Paragraph selecion (Selección de párrafo de entrada): Selección del párrafo que queremos ejecutar. El ID del párrafo aparecerá junto con su título entre paréntesis (si se ha definido).
Input Parameters mapping (Mapeo de Parámetros de Entrada): Si el párrafo tiene parámetros de entrada configurados, aparecerán para que los rellenes. Sus valores se pueden informar de diferentes maneras:
msg: De un campo del msg anterior.
flow: De una variable global al Flow.
global: De una variable global.
string: Como una cadena de caracteres fija.
number: Como un número fijo.
boolean: Como un valor lógico verdadero/falso fijo.
timestamp: Como una marca de tiempo fija.
Outputs: esta pestaña también cambia dependiendo de si queremos ejecutar todo el cuaderno o solo un nodo.
Ejecución de un solo párrafo: Si el check Execute entire notebook (Ejecutar todo el cuaderno) está desactivado, la configuración de outputs (salidas) está deshabilitada. Dado que se ejecuta un solo nodo, la salida será única.
Ejecución completa: Si se marca el check Ejecutar todo el cuaderno, aparecerán las siguientes opciones para definir las salidas:
Enable Paragraph Output (Habilitar Salida de Párrafo): Si la marcamos, nos permite definir diferentes salidas con los resultados de los párrafos que seleccionemos.
Split Outputs (Salidas divididas): El selector de salida múltiple está habilitado.
Outputs Number (Número de Salidas): Permite elegir el número de salidas que quieres en el nodo.
Output Parameters mapping (Asignación de parámetros de salida): Para cada output que hayas definido, puedes seleccionar el párrafo cuyo resultado mostrará esa salida.
El resultado sería el siguiente:
...
Si pasamos el cursor sobre los pines de salida del nodo, podemos ver el párrafo al que pertenece.
...
Una vez que el nodo esté configurado , podemos ver las salidas definidas, las cuales tendrán la siguiente estructura:
...
En el msg.payload.body, encontraremos los siguientes campos de resultado:
Title:: Título del párrafo ejecutado.
Text: Contenido del párrafo ejecutado.
User: Usuario.
dateUpdated: Fecha de la última actualización del párrafo.
config: Parámetros de configuración del párrafo.
settings: Muestra los parámetros y variables de entrada del párrafo.
results: Contiene el resultado de la ejecución.
code: Indica si la ejecución ha sido correcta.
msg: Array con los resultados de la ejecución del párrafo. Cada elemento marcará el tipo de dato (type) y el resultado (data).
El resto de campos son informativos sobre cuándo se realizó la ejecución y el tiempo que tardó.