Crear y usar parámetros en flujos
Compatible con Tableau Prep Builder versión 2021.4.1 y posteriores, y en la web en Tableau Server y Tableau Cloud versión 2021.4.0 y posteriores
Nota: El contenido de este tema se aplica a los flujos de creación en Tableau Prep Builder y en la web, a menos que se indique específicamente. Para obtener más información acerca de la creación de flujos en la web, consulte Tableau Prep en la web en la ayuda de Tableau Server(El enlace se abre en una ventana nueva) y Tableau Cloud(El enlace se abre en una ventana nueva).
Si a menudo reutiliza flujos utilizando diferentes datos con el mismo esquema, puede crear y aplicar usuario parámetros de usuario a sus flujos para realizar una transición sencilla entre escenarios. Un parámetro es un valor global de marcador de posición, como un número, un valor de texto o un valor booleano que puede reemplazar un valor constante en un flujo.
En lugar de crear y mantener varios flujos, ahora puede crear un flujo y usar parámetros para ejecutar el flujo con sus diferentes conjuntos de datos. Por ejemplo, puede crear un parámetro para varias regiones de ventas y luego aplicar un valor de parámetro a la ruta del archivo de entrada para ejecutar el flujo utilizando solo los datos de esa región.
A partir de Tableau Prep Builder y Tableau Cloud versión 2023.2, también puede agregar parámetros del sistema al archivo o al nombre de salida de la fuente de datos publicada para agregar automáticamente una marca de tiempo cada vez que ejecuta el flujo.
¿Dónde puedo aplicar parámetros?
Puede aplicar parámetros de usuario a nombres de archivos, rutas, nombres de tablas, expresiones de filtro y campos calculados, según el tipo de paso. A partir de la versión 2022.1.1, incluso puede incluir valores de anulación de parámetros al ejecutar flujos mediante la API de REST. Para obtener más información, consulte Métodos de flujo(El enlace se abre en una ventana nueva) en la ayuda de la API de REST de Tableau.
Puede aplicar parámetros del sistema (versión 2023.2 y posteriores) a los nombres de salida para tipos de salida de origen de datos publicados y archivos.
La siguiente tabla enumera las ubicaciones donde puede aplicar parámetros para cada tipo de paso.
Tipo de paso | Ubicación del parámetro |
---|---|
Entrada | Parámetros de usuario:
|
Resultado | Parámetros del usuario o del sistema:
|
Limpiar, Filas nuevas, Tabla dinámica, Unir filas, Unir columnas | Parámetros de usuario:
|
Agregación | Parámetros de usuario:
|
Script | Parámetros de usuario:
|
Predicción | Parámetros de usuario:
|
Crear parámetros de usuario
Los parámetros de usuario son específicos del flujo donde se utilizan. Cree parámetros desde el menú superior, luego defina los valores que se aplican a ellos. También puede definir parámetros que acepten todos los valores, lo que significa que cualquier usuario de flujo puede indicar cualquier valor al ejecutar el flujo.
Puede hacer que los valores de los parámetros de flujo sean obligatorios u opcionales. Al ejecutar el flujo, se solicita a los usuarios que especifiquen los valores de los parámetros. Los valores de los parámetros requeridos deben especificarse antes de que el usuario pueda ejecutar el flujo. Se pueden indicar valores de parámetros opcionales o puede aceptar el valor actual (predeterminado). Luego, los valores de los parámetros se aplican a la ejecución de flujo en todos los lugares donde se usa ese parámetro.
Nota: Para ejecutar o programar flujos que incluyen parámetros en Tableau Server o Tableau Cloud, su administrador debe habilitar la configuración del parámetro de flujo en su servidor. Para obtener más información, consulte Crear flujos e interactuar con ellos en Internet en la ayuda de Tableau Server(El enlace se abre en una ventana nueva) o Tableau Cloud(El enlace se abre en una ventana nueva).
En el menú superior, haga clic en el parámetro y luego haga clic en Crear parámetro.
En el cuadro de diálogo Crear parámetro, indique un nombre y una descripción (opcional). El nombre del parámetro debe ser exclusivo. Este es el valor que se muestra en la interfaz de usuario cuando agrega un parámetro.
Si incluye una descripción, los usuarios pueden ver esta información al situar el cursor (a partir de la versión 2022.1.1) sobre la lista de parámetros y dónde se usan los parámetros.
Seleccione uno de los siguientes tipos de datos. Los valores de los parámetros deben coincidir con el tipo de datos que seleccione.
- Número (entero o decimal)
- Cadena
- Booleano
Especifique los valores permitidos. Estos son los valores que los usuarios pueden indicar en el parámetro.
Todo: esta opción permite a los usuarios escribir cualquier valor para el parámetro, incluso cuando se ejecuta el flujo.
Nota: El uso de esta opción para los parámetros que se pueden usar en los pasos de entrada y salida puede ser un riesgo para la seguridad. Por ejemplo, las consultas de SQL personalizado que permiten especificar cualquier valor pueden exponer sus activos de datos a ataques de inyección de SQL.
- Lista: indique una lista de valores entre los que los usuarios pueden elegir al aplicar el parámetro. Para indicar varios valores, pulse Entrar después de cada entrada.
- (opcional) Seleccione Solicitar selección en el momento de la ejecución (Solicitar valor en el momento de la ejecución en versiones anteriores). Esto hace que el parámetro sea obligatorio. Se requiere que el usuario indique un valor al ejecutar o programar el flujo.
Especifique un valor actual. Este es un valor obligatorio y actúa como un valor predeterminado para el parámetro.
- Todo: indique un valor.
- Lista: Tableau usa el primer valor de su lista. Utilice la opción desplegable para cambiarlo.
- Booleano: seleccione True o False.
- Haga clic en Aceptar para guardar el parámetro.
Cambiar el valor predeterminado del parámetro de usuario
Cuando crea un parámetro de usuario, debe especificar un valor actual (predeterminado). Si se incluye un parámetro en un flujo, este valor se utiliza para:
- Ejecutar consultas de SQL personalizado definidas en un paso de entrada.
- Rellenar los parámetros opcionales que no se especifican en el momento de la ejecución.
- Reemplazar el parámetro como un valor estático en los pasos guardados (versión 2022.1.1 y posteriores).
- Reemplazar el parámetro como un valor estático en las rutas de archivo al publicar flujos con conjuntos de datos empaquetados.
Puede cambiar el valor en cualquier momento. Desde el menú superior puede editar el parámetro o usar el botón Establecer en la lista de parámetros. Desde dentro del flujo, puede usar el botón Establecer en cualquier lugar donde se aplique el parámetro. Cuando hace esto, restablece el valor actual (predeterminado) del parámetro en todos los lugares donde se usa ese parámetro, incluso en consultas de SQL personalizado.
Editar parámetros de usuario
- En el menú superior, haga clic en el icono Parámetro.
- Haga clic en Editar parámetro.
En el cuadro de diálogo Editar parámetro, realice los cambios y haga clic en Aceptar.
Restablecer valores predeterminados de parámetros de usuarios
Para restablecer rápidamente el valor predeterminado del parámetro, use el botón Establecer. El botón le muestra un conteo que indica el número de lugares en el flujo donde se usa el parámetro.
Para resaltar los pasos en el flujo que usan el parámetro, haga clic en Ver en flujo en el cuadro de diálogo del parámetro. Si solo hay un lugar donde se usa el parámetro, se lo lleva directamente a ese paso con el panel de perfil abierto.
- Aplique una de las siguientes opciones:
En el menú superior, haga clic en el icono Parámetro. Utilice esta opción para restablecer los valores de los parámetros utilizados en cualquier parte del flujo, o cuando se utilizan en filtros y campos calculados.
Haga clic en el parámetro donde se aplica en el flujo. Puede utilizar esta opción para los parámetros que se utilizan en nombres de archivo, rutas de archivo, nombres de tabla, SQL personalizado y scripts anteriores y posteriores al SQL.
- Seleccione o especifique el valor del parámetro.
Haga clic en Establecer para aplicar el cambio.
Aplicar parámetros a su flujo
Después de crear parámetros de usuario, puede aplicarlos a varios lugares a lo largo de su flujo, según el tipo de paso. Cuando se ejecuta el flujo, los valores de los parámetros se aplican a esa ejecución de flujo para producir la salida para el escenario de datos específico.
Los parámetros del sistema (versión 2023.2 y posteriores) se generan automáticamente cuando ejecuta el flujo. Simplemente aplíquelos al nombre de su paso de salida y cada vez que se ejecuta el flujo, el parámetro se actualiza dinámicamente con la fecha u hora de inicio de la ejecución del flujo.
Aplicar parámetros a los pasos de entrada
En un paso de entrada, puede usar parámetros de usuario para reemplazar un nombre de archivo, secciones de su ruta de archivo, un nombre de tabla de base de datos o cuando usa SQL personalizado.
Nombre de archivo o ruta de archivo
Esta opción no está disponible al editar o crear flujos en la web.
Puede incluir parámetros de usuario en la ruta de su archivo con algunas excepciones. A partir de la versión 2022.1.1, también puede ver una vista previa de los valores de los parámetros.
Excepciones
- A partir de la versión 2022.1.1, puede programar y ejecutar flujos en la web que incluyan parámetros en la ruta de archivo de entrada. Si usa una versión anterior, ejecute flujos en Tableau Prep Builder o desde la línea de comandos.
Para incluir parámetros en la ruta del archivo al publicar flujos en la web, se requiere una conexión de archivo directa. De lo contrario, el parámetro se convierte en un valor estático mediante el Valor actual .
Nota: las conexiones directas de archivos requieren que las ubicaciones de los archivos estén incluidas en la lista segura de su organización. Para obtener más información, consulte Lista de ubicaciones seguras de entrada y salida(El enlace se abre en una ventana nueva) en la ayuda de Tableau Server.
Aplicar un parámetro de usuario a un nombre de archivo o ruta
- En la pestaña Configuración, en la ruta del archivo, coloque el cursor en la ubicación donde desea agregar el parámetro.
Haga clic en el icono de parámetro y seleccione su parámetro.
Ver una vista previa del valor del parámetro. El valor actual (predeterminado) se muestra en la vista previa. Se le pedirá que seleccione o especifique el valor del parámetro cuando ejecute el flujo.
Tabla de base de datos
Cuando se utilizan parámetros de usuario en los nombres de las tablas, el nombre completo de la tabla debe ser el usuario parámetro. Actualmente, no se admite el uso de parámetros para partes de un nombre de tabla.
Nota: Aún no se admite el uso de un parámetro para el nombre de una tabla en una conexión de entrada de Google BigQuery.
- En la pestaña Configuración, en el campo Tabla, haga clic en el menú desplegable.
Seleccione Usar parámetro, después, seleccione el parámetro de la lista.
SQL personalizado
- En el panel Conexiones, haga clic en SQL personalizado.
En la pestaña SQL personalizado, escriba o pegue la consulta en el cuadro de texto.
Haga clic en el icono de parámetro y seleccione su parámetro.
Haga clic en Ejecutar para ejecutar su consulta. No se le pedirá que especifique un valor de parámetro hasta que ejecute el flujo. En su lugar, la consulta se ejecutará inicialmente utilizando el valor actual del parámetro.
Nota: si el parámetro se usa en otra parte del flujo y se restablece el valor actual, ese cambio puede afectar a su consulta.
Aplicar parámetros de usuario a los pasos de salida
En un paso de salida, puede aplicar parámetros de usuario en los siguientes lugares:
- Nombre de archivo
- Secciones en su ruta de su archivo
- Nombre de la fuente de datos publicada
- Nombre de la tabla de base de datos
- Nombre de la hoja de trabajo de Microsoft Excel (versión 2022.1.1 y posteriores)
- Scripts de SQL personalizado que se ejecutan antes o después de escribir datos de salida de flujo en una base de datos (versión 2022.1.1 y posteriores)
Nombre de archivo o ruta de archivo
Esta opción de salida no está disponible al crear o editar flujos en la web
- En el panel Salida, seleccione Archivo de la lista desplegable Guardar salida en.
En el campo Nombre o Ubicación, haga clic en el icono de parámetro y seleccione su parámetro.
Para la ruta del archivo, coloque el cursor en la ubicación donde desea agregar el parámetro.
Cuando ejecute el flujo, se le pedirá que especifique los valores de su parámetro.
Nombre de la fuente de datos publicada
- En el panel Salida, en la lista desplegable Guardar salida en, seleccione Fuente de datos publicada.
En el campo Nombre, haga clic en el icono de parámetro y seleccione su parámetro.
Cuando ejecute el flujo, se le pedirá que especifique los valores de su parámetro.
Tabla de base de datos y SQL personalizado antes y después
- En la pestaña Salida, en la lista desplegable Guardar salida en, seleccione Tabla de base de datos.
En el campo Tabla, seleccione Usar parámetro y, después, seleccione el parámetro de la lista.
(Opcional) Haga clic en la pestaña SQL personalizado. A partir de la versión 2022.1.1, puede especificar un script de SQL con parámetros para ejecutar antes y después de que los datos se escriban en la tabla. Para incluir un parámetro, haga clic en Insertar parámetro y seleccione su parámetro.
Para obtener más información sobre el uso de scripts de SQL al escribir salidas a una base de datos, consulte Guardar datos de salida de flujo en bases de datos externas
Nota: los parámetros utilizados en los scripts de SQL deben eliminarse manualmente. Consulte Eliminar parámetros de usuario manualmente para obtener más información.
Cuando ejecute el flujo, se le pedirá que especifique los valores de su parámetro.
Aplicar parámetros de sistema a los pasos de salida
En un paso de salida, puede usar parámetros de sistema de fecha y hora en los siguientes lugares:
- Nombre de archivo
- Nombre de la fuente de datos publicada
Nombre de archivo
Esta opción de salida no está disponible al crear o editar flujos en la web
- En el panel Salida, seleccione Archivo de la lista desplegable Guardar salida en.
En el campo Nombre, haga clic en el parámetro y seleccione entre los siguientes parámetros de fecha o tiempo de ejecución. Puede combinar múltiples parámetros del sistema para crear cualquier marca de tiempo que necesite.
Fecha de ejecución
- Fecha: AAAA-MM-DD, AAAAMMDD, DD-MM-AAAA
- Mes: Nombre del mes, Número del mes
- Número de semana
- Número de trimestre
- Año
Tiempo de ejecución
- AAAA-MM-DD_HH-MM-SS (24 horas)
- AAAAMMDD_HHMMSS (24 horas)
Cuando ejecuta el flujo, Tableau Prep aplica el tiempo de ejecución de inicio del flujo utilizando su zona horaria local o la zona horaria del servidor.
Nombre de la fuente de datos publicada
- En el panel Salida, en la lista desplegable Guardar salida en, seleccione Fuente de datos publicada.
En el campo Nombre, haga clic en el parámetro y seleccione entre los siguientes parámetros de fecha o tiempo de ejecución. Puede combinar múltiples parámetros del sistema para crear cualquier marca de tiempo que necesite.
Fecha de ejecución
- Fecha: AAAA-MM-DD, AAAAMMDD, DD-MM-AAAA
- Mes: Nombre del mes, Número del mes
- Número de semana
- Número de trimestre
- Año
Tiempo de ejecución
- AAAA-MM-DD_HH-MM-SS (24 horas)
- AAAAMMDD_HHMMSS (24 horas)
Cuando ejecuta el flujo, Tableau Prep aplica el tiempo de ejecución de inicio del flujo utilizando su zona horaria local o la zona horaria del servidor.
Aplicar parámetros de usuario para filtrar cálculos
Utilice parámetros de usuario para filtrar datos a lo largo de su flujo. Filtre su conjunto de datos en el paso de entrada o aplique parámetros de filtro en el nivel de valor de paso o campo. Por ejemplo, use un parámetro de filtro para indicar solo datos para una región específica o filtrar datos en un paso a un departamento específico.
Nota: a partir de la versión 2022.1, puede usar copiar y pegar para reutilizar cálculos de filtros con parámetros en otros flujos cuando el mismo parámetro existe con el mismo nombre y tipo de datos.
- Desde el paso de entrada o la barra de herramientas del panel de perfil, haga clic en Filtrar valores. Para agregar un filtro de parámetro a un campo, desde Más opciones seleccione Filtros > Cálculo.
En el editor de cálculo Agregar filtro, escriba el nombre del parámetro para seleccionarlo de la lista (el parámetro se muestra en violeta), luego haga clic en Guardar para guardar su filtro.
Cuando ejecute el flujo, se le pedirá que especifique los valores de su parámetro.
Aplicar parámetros de usuario a los campos calculados
Use parámetros de usuario para reemplazar valores constantes en los cálculos que usa a lo largo de su flujo. Puede aplicar parámetros de cálculo en el nivel de valor de campo o de paso.
Nota: a partir de la versión 2022.1, puede usar copiar y pegar para reutilizar cálculos con parámetros en otros flujos cuando el mismo parámetro existe con el mismo nombre y tipo de datos.
- En la barra de herramientas del panel de perfil, haga clic en Crear campo calculado. Para agregar un parámetro a un cálculo en un campo, desde el menú Más opciones, seleccione Crear campo calculado > Cálculo personalizado.
En el editor de cálculo Añadir campo, especifique su cálculo, escriba el nombre del parámetro para seleccionarlo de la lista; luego haga clic en Guardar para guardar su cálculo.
Cuando ejecute el flujo, se le pedirá que especifique los valores de su parámetro.
Eliminar parámetros de usuario
Para eliminar parámetros de usuario que ya no necesita, haga clic en Eliminar parámetro en el cuadro de diálogo Editar parámetro. Esto elimina cualquier instancia del parámetro utilizado en todo el flujo y lo reemplaza con el valor actual del parámetro. Esta acción no se puede deshacer.
Nota: las opciones para eliminar parámetros en un flujo varían según su versión. Utilice las instrucciones a continuación para la versión 2022.1 y posteriores. Utilice Eliminar parámetros de usuario manualmente para versiones anteriores y para eliminar parámetros utilizados en scripts de SQL personalizado que se ejecutan antes o después de escribir la salida a una base de datos.
- En el menú superior, haga clic en menú desplegable del icono de parámetro , luego haga clic en Editar parámetro para el parámetro que desea eliminar.
En el cuadro de diálogo Editar parámetro, haga clic en Eliminar parámetro .
En el diálogo de confirmación, haga clic de nuevo en Eliminar parámetro. Puede hacer clic en Ver en flujo para resaltar los pasos e investigar dónde se usa el parámetro antes de eliminarlo.
Se aplica a la versión 2021.4.4 y anteriores y a los parámetros utilizados en scripts de SQL personalizado anteriores y posteriores
Antes de que pueda eliminar un parámetro de usuario de su lista de parámetros, primero debe buscar y eliminar todas las instancias de los parámetros de su flujo, incluso desde el panel Cambios.
- En el menú superior, haga clic en el menú desplegable del icono de parámetro .
Para el parámetro que desea eliminar, haga clic en Ver en flujo para buscar todas las instancias donde el parámetro se usa en el flujo.
Si el parámetro no se utiliza en ninguna parte del flujo, vaya al paso 4.
- Para cada paso en el que se utilice el parámetro, elimine el parámetro, incluida la eliminación de los cambios enumerados en el panel Cambios.
- En el menú superior, haga clic en el menú desplegable del icono de parámetro y para el parámetro que desea eliminar, haga clic en Editar parámetro.
En el cuadro de diálogo Editar parámetro, haga clic en Eliminar parámetro .
El parámetro se reemplazará con el valor actual del parámetro.
Ejecutar flujos con parámetros
Ejecutar flujos que incluyen parámetros es lo mismo que ejecutar flujos que no los tienen, excepto que se solicita a los usuarios que especifiquen valores de parámetros de usuario en el momento de la ejecución o cuando añadan el flujo a un programa en Tableau Server o Tableau Cloud.
Los parámetros del sistema se aplican automáticamente cuando se ejecuta el flujo.
Si un parámetro de usuario está marcado como obligatorio, los usuarios deben especificar un valor antes de poder ejecutar el flujo. Si un parámetro es opcional, los usuarios pueden especificar un valor o aceptar el valor actual del parámetro de forma predeterminada.
Los parámetros obligatorios son aquellos que tienen la casilla de verificación Solicitar selección en el momento de la ejecución (Solicitar valor en el momento de la ejecución en versiones anteriores) seleccionada.
Si ejecuta flujos utilizando la interfaz de línea de comandos y desea anular los valores de los parámetros actuales (predeterminados), cree un archivo .json de anulación de parámetros e incluya la sintaxis -p --parameters en su línea de comandos. Para obtener más información, consulte Actualizar los archivos de salida del flujo desde la línea de comandos.
Ejecutar flujos manualmente
Cuando ejecuta un flujo desde Tableau Prep Builder o manualmente en Tableau Server o Tableau Cloud, el cuadro de diálogo Parámetros se abre al hacer clic en Ejecutar.
- Introduzca o seleccione los valores de los parámetros de usuario. Si hay parámetros opcionales en el flujo, puede especificar los valores en este momento o aceptar el valor del parámetro actual (predeterminado).
- Haga clic en Ejecutar flujo para ejecutar el flujo.
Para obtener más información sobre la ejecución de flujos, consulte Publicar un flujo en Tableau Server o Tableau Cloud.
Ejecutar flujos según un programa
Cuando programe flujos para que se ejecuten en Tableau Server o Tableau Cloud, deberá indicar los valores de los parámetros de usuario requeridos al programar los flujos.
En la pestaña Tareas nuevas o Tareas vinculadas, en la sección Establecer parámetros, escriba o seleccione los valores de los parámetros. Si hay parámetros opcionales en el flujo, puede escribir los valores en este momento o dejar el campo vacío para usar el valor del parámetro actual (predeterminado).
- Haga clic en Crear tareas para programar su flujo.