Uso de parámetros en plantillas y Respuestas rápidas
Para asignar un valor a una variable de un notebook de forma interactiva, el analista puede definir parámetros en las plantillas y en las Respuestas rápidas. Un parámetro es una variable declarada de forma específica que, cuando se ejecuta el notebook, muestra una ventana que solicita su valor al analista. De esta forma, Cytomic Orion acelera la asignación de valores a las variables del notebook sin necesidad de que el analista edite o modifique su código.
Al ejecutar un notebook creado a partir de una plantilla con parámetros definidos, se muestra una ventana de petición de parámetros similar a la figura Ventana de solicitud de parámetros en una plantilla. En esta ventana el analista escribe los valores de los parámetros que recibirá el notebook.
Formato de un parámetro
El formato para definir un parámetro en una plantilla es el siguiente:
|
|
Por cada línea que exista en la plantilla con el formato indicado, se añade una entrada en la ventana de petición de parámetros. Si se indica un parámetro de tipo lista, se mostrará una caja de texto donde introducir los diferentes parámetros separados por retorno de carro.
Añadir parámetros a una plantilla o Respuesta rápida
Para añadir parámetros a una plantilla, sigue los pasos mostrados a continuación:
En la primera celda añade una línea por cada parámetro con el formato indicado.
Los tipos de parámetros admitidos son:
| Tipo | Descripción |
|---|---|
|
string |
Cadena de caracteres. |
|
int |
Números enteros. |
|
date |
Fechas. |
|
list |
Listas de elementos de tipo cadena de caracteres. |
|
MUID |
Desplegable con la entidad de interés MUID. |
|
client |
Desplegable con la entidad de interés cliente. |
|
MD5 |
Desplegable con la entidad de interés MD5. |
Asignación automática del valor de los parámetros según el contexto
Al ejecutar un notebook con parámetros, el analista debe asignar manualmente el valor de cada uno de ellos en la ventana de petición de parámetros. En notebooks con muchos parámetros definidos, esta tarea puede llegar a ser larga. Para acelerar la asignación de valores, Cytomic Orion es capaz de leer el contexto de la entidad de interés a partir de la cual se lanza el notebook. Por ejemplo, si el analista lanza un notebook a partir de un indicio, Cytomic Orion es capaz de leer los campos de ese indicio en particular y cargar su contenido en los parámetros apropiados de la ventana de petición de parámetros.
Para que Cytomic Orion pueda relacionar un campo de una entidad de interés con un parámetro concreto definido en el notebook a ejecutar, es necesario que se cumplan los requisitos siguientes:
-
Que el nombre del parámetro y el nombre del campo coincidan.
-
Que el parámetro esté declarado con un tipo básico (int o string).
Por ejemplo, el analista define un notebook que requiere como entrada el MUID de un equipo. Para acelerar la introducción del MUID cuando el notebook es invocado desde un indicio, declarará el parámetro con el nombre “MUID” de tipo string, ya que es así como se llama el campo que contiene el MUID del equipo en los indicios generados por Cytomic Orion.
Asignación de valores por defecto a los parámetros
El formato para asignar en una plantilla un valor por defecto a un parámetro es el siguiente:
|
|
La asignación automática de valores a los parámetros según el contexto de la entidad, tiene prioridad sobre la asignación de valores por defecto. De esta forma, cuando se abre el notebook y se muestra la ventana de petición de parámetros, si no es posible rellenar el parámetro con el contexto, se añade el valor por defecto indicado en la declaración del parámetro. Igualmente, si un notebook tiene parámetros asignados por defecto, y a su vez el valor de esos mismos parámetros puede asignarse automáticamente desde el contexto de la entidad, el valor que finalmente se aplicará será el generado por el contexto de la entidad.