Ayuda de Tableau Prep

Compatible solo con Tableau Prep Builder.

Puede ejecutar el flujo desde la línea de comandos para actualizar la salida de flujo en lugar de ejecutar el flujo desde Tableau Prep Builder. Puede ejecutar un flujo a la vez utilizando este método. Esta opción está disponible tanto en equipos Windows como Mac donde esté instalado Tableau Prep Builder.

Nota: Si utiliza la administración de licencias basada en el inicio de sesión (LBLM), asegúrese de abrir Tableau Prep periódicamente. De lo contrario, el préstamo puede expirar y provocar que los flujos que se ejecutan a través de la línea de comandos fallen. También puede ponerse en contacto con su administrador para cambiar la duración de su préstamo a la duración máxima. Para obtener más información, consulte Administración de licencias basadas en inicio de sesión(El enlace se abre en una ventana nueva).

Limitaciones del conector:

• Conectores JDBC u ODBC: los flujos que incluyen estos conectores se pueden ejecutar desde la línea de comandos a partir de la versión 2019.2.3.
• Conectores de nube: los flujos que incluyen conectores de nube, como Google BigQuery, no se pueden ejecutar desde la línea de comandos. En lugar de eso, ejecute el flujo manualmente o ejecútelo en un programa de Tableau Server o Tableau Cloud mediante Tableau Prep Conductor. Para obtener más información, consulte Mantenga los datos de flujo actualizados.
• Autenticación de inicio de sesión único: la ejecución de flujos desde la línea de comandos no es compatible si usa la autenticación de inicio de sesión único. En su lugar, puede ejecutar flujos desde Tableau Prep Builder.
• Autenticación multifactor: la interfaz de línea de comandos (CLI) de Tableau Prep no es compatible con Tableau con autenticación multifactor (MFA). Para obtener más información, consulte este artículo(El enlace se abre en una ventana nueva) de la Base de conocimientos de Tableau.

En equipos Windows, también puede usar el Programador de tareas de Windows para programar este proceso. Para obtener más información, consulte Programador de tareas(El enlace se abre en una ventana nueva) en las páginas de ayuda en línea de Microsoft.

Al ejecutar flujos desde la línea de comandos, Tableau Prep Builder actualiza todas las salidas del flujo utilizando la configuración de los pasos de salida especificados en Tableau Prep Builder. Para obtener más información sobre cómo especificar sus ubicaciones de salida, consulte Crear archivos de extracción de datos y fuentes de datos publicadas(El enlace se abre en una ventana nueva). Para obtener información sobre cómo establecer las opciones de escritura (versión 2020.2.1 y posteriores), consulte Configurar opciones de escritura.

Antes de ejecutar el flujo

Para ejecutar el flujo desde la línea de comandos, necesitará privilegios de administrador en el equipo donde está ejecutando el flujo y necesitará la siguiente información:

• La ruta donde está instalado Tableau Prep Builder.

• Si se va a conectar a bases de datos y publicar archivos de salida en un servidor o a una base de datos (versión 2020.1.1 y posteriores), se necesita un archivo de credenciales .json que incluya todas las credenciales necesarias.

• La ruta en la que se encuentre el archivo de flujo de Tableau (.tfl).

Requisitos del archivo .json de credenciales

Nota: los archivos de credenciales .json no son necesarios si el flujo tiene su entrada y salida en archivos locales, archivos almacenados en la red o archivos de entrada que usen la autenticación de Windows (SSPI). Para obtener más información sobre la Autenticación de Windows, consulte SSPI Model(El enlace se abre en una ventana nueva) en la ayuda en línea de Microsoft.

Tableau Prep Builder usa la información del archivo de flujo y el archivo .json de credenciales para ejecutar el flujo cuando tenga conexiones remotas. Por ejemplo, el nombre de la base de datos de sus conexiones remotas y el nombre del proyecto de sus archivos de salida provienen del flujo, y el nombre del servidor y las credenciales de inicio de sesión provienen del archivo .json de credenciales.

• Si tiene previsto volver a utilizar el archivo, colóquelo en una carpeta en la que el proceso de instalación de Tableau Prep Builder no lo sobrescriba.
• Si está ejecutando un flujo que incluye cualquiera de los siguientes, debe incluir un archivo .json que incluya las credenciales necesarias para conectarse.
  • Conexiones a archivos de bases de datos o a fuentes de datos publicadas.
  • La salida se publica en un servidor o en una base de datos (versión 2020.3.1 y posteriores).
  • El flujo incluye pasos de script para Rserve o TabPy. El archivo .json debe incluir las credenciales necesarias para conectarse a estos servicios. Para obtener más información, consulte los requisitos de la matriz para su versión a continuación.
• Las credenciales especificadas en el flujo y las credenciales incluidas en el archivo .json deben coincidir, de lo contrario el flujo no se ejecutará.
• Cuando ejecuta el proceso, el nombre del host, puerto y nombre del usuario se utilizan para encontrar la conexión coincidente en el archivo de flujo de Tableau (.tlf) y se actualizan antes de ejecutar el proceso. El ID de puerto y de sitio son opcionales si sus conexiones no requieren esta información.

• Si está conectándose a una fuente de datos publicada, incluya el nombre del host, la URL del contenido y el puerto (80 para http y 443 para https) en las conexiones de entrada. El nombre del host es necesario para encontrar la conexión coincidente en el archivo de flujo de Tableau (.tlf). La URL del contenido y el puerto se utilizan para establecer la conexión al servidor.

• Si se conecta a Tableau Cloud, incluya el puerto (80 o 443) en las conexiones de entrada del pod al que se está conectando y en la URL de conexiones del servidor, asegúrese de incluir el prefijo del pod correspondiente junto con online.tableau.com. Para obtener más información acerca de Tableau Cloud, consulte Conexiones de Tableau Bridge a Tableau Cloud(El enlace se abre en una ventana nueva)en la sección de ayuda de Tableau Cloud.
• (versión 2021.4.1 y posteriores) Si incluye parámetros en su flujo, puede crear e incluir un archivo .json de anulación de parámetros en la línea de comando para cambiar los valores de los parámetros de los valores predeterminados actuales. Para obtener más información, consulte Ejecutar flujos que incluyen valores de parámetros.

Dependiendo de su versión de Tableau Prep Builder, su información de credenciales puede tener un formato diferente. Haga clic en la pestaña siguiente para ver el formato de credenciales de su versión de Tableau Prep Builder.

{
    "Parameter 1": Value 1,
    "Number Parameter": 40,
    "Boolean Parameter": True
}				

 "\[Tableau Prep Builder install location]\Tableau Prep Builder <version>\scripts"\tableau-prep-cli.bat -t "path\to\[your flow file name].tfl" -p|--parameters parameters.override.json

/Applications/Tableau\ Prep\ Builder\ [Tableau Prep Builder version].app/Contents/scripts/./tableau-prep-cli -t path/to/[your flow file name].tfl -p|--parameters parameters.override.json

{
 "tableauServerConnections":[
   {
    "serverUrl":"https://my.server",
    "contentUrl": "mysite",
    "port":443,
    "username": "jsmith",
    "password": "passw0rd$"
   }
 ]
}				

{
 "tableauServerConnections":[
   {
    "serverUrl":"https://my.server",
    "contentUrl": "mysite",
    "port":443,
    "username": "jsmith",
    "password": "passw0rd$"
   }
],
 "databaseConnections":[
   {
    "hostname":"example123.redshift.amazonaws.com",
    "port":"5439",
    "username":"jsmith",
    "password":"p@s$w0rd!"
   }
 ]
}

{
 "extensions": [
    {
	  "extensionName": "rSupport",
	  "regular": {
		"host": "localhost",
		"port": "9000",
		"username": "jsmith"
	},
	"sensitive": {	
	  "password": "pwd"	
	}
   },
   {
	"extensionName": "pythonSupport",
	"regular": {
	  "host": "localhost",
	  "port": "9000"
	},
	"sensitive": {
	}
   }
 ],										
 "databaseConnections":[
   {
    "hostname":"example123.redshift.amazonaws.com",
    "port": "5439",
    "username": "jsmith",
    "password": "p@s$w0rd!"
   },
   {
    "hostname":"mysql.mydb.tsi.lan",
    "port": "3306",
    "username": "jsmith",
    "password": "mspa$$w0rd"
   }
 ]
}			

{
 "databaseConnections":[
{
  "hostname":"example123.redshift.amazonaws.com",
  "port": "5439",
  "username": "jsmith",
  "password": "p@s$w0rd!"
 },
 {
   "hostname":"mysql.mydb.tsi.lan",
   "port": "3306",
   "username": "jsmith",
   "password": "mspa$$w0rd"
  }
 ]
}			

{ 
  "inputConnections":[
    {
     "hostname":"https://my.server",
     "contentUrl": "mysite",
     "port":443,								
     "username": "jsmith",
     "password": "passw0rd$"
    }
 ],
  "outputConnections":[
    {
     "serverUrl":"https://my.server",
     "contentUrl":"mysite",
     "username":"jsmith",
     "password":"passw0rd$"
    }
 ]
}

{ 
  "inputConnections":[
    {
     "hostname":"mysql.example.lan",
     "port":1234,
     "username": "jsmith",				
     "password": "passw0rd"
  },
    {
     "hostname":"Oracle.example.lan",
     "port":5678,
     "username": "jsmith",				
     "password": "passw0rd" 
  }
], 
  "outputConnections":[
    {
     "serverUrl":"http://my.server",
     "contentUrl":"mysite",
     "username":"jsmith",
     "password":"passw0rd$"
    } 
  ]
}

{ 
  "inputConnections":[
    {
     "hostname":"mysql.example.lan",
     "port":1234,
     "username": "jsmith",				
     "password": "passw0rd"
  }
], 
  "extensions":[
    {
     "extensionName":"rSupport",
     "credentials":{
     "password":"pwd",
    }
  },
   {
	"extensionName" : "pythonSupport",
	"credentials": {
	"password": "pwd"
	}
   } 
  ]
}

Consejos para crear su archivo de credenciales

Para evitar errores al ejecutar el flujo, asegúrese de que su archivo de credenciales siga estas directrices:

• Si usa una versión de Tableau Prep Builder comprendida entre la 2018.2.2 y la 2018.3.1, incluya siempre las matrices “inputConnections” y “outputConnections”, aunque el flujo no tenga conexiones remotas para entradas ni salidas. Deje esas matrices en blanco.

  Si usa Tableau Prep Builder versión 2018.3.2 o posteriores, no es necesario que incluya la matriz en blanco.

  • ¿No hay ninguna conexión remota de entrada? Incluya esta sintaxis en la parte superior del archivo .json.

    {
     "inputConnections":[
      ],

  • ¿No hay ninguna conexión remota de salida? Incluya esta sintaxis en la parte inferior del archivo .json.

  "outputConnections":[
    ]
  }

• No hay ningún ID de puerto para su conexión de entrada o el puerto se ha especificado como parte de un nombre de servidor

  Si no hay un ID de puerto para su conexión, no incluya la referencia "port":xxxx, en el archivo .json, ni siquiera "port": "". Si el ID de puerto está incluido en el nombre del servidor, incluya el ID de puerto en el nombre de host. Por ejemplo: "hostname": "mssql.example.lan,1234"

• Al referirse a "serverUrl":, no incluya "/" al final de la dirección. Por ejemplo, use "serverUrl": "http://server" y no "serverUrl": "http://server/".

• Si tiene varias conexiones de entrada y salida, incluya las credenciales de cada una en el archivo.

• Si se conecta a fuentes de datos publicadas, asegúrese de incluir hostname y contentUrl en las conexiones de entrada.

Ejecutar el flujo

Importante: en los ejemplos siguientes, se incluye el cambio de nombre de “Tableau Prep” versión 2019.1.2 a “Tableau Prep Builder”. Si usa una versión anterior del producto, use “Tableau Prep” en su lugar.

1. Abra el símbolo del sistema o el símbolo del sistema del terminal (MacOS) como administrador.

2. Ejecute uno de los siguientes comandos mediante la sintaxis que viene a continuación.

   • El flujo se conecta a archivos locales o almacenados en un recurso compartido de la red y se publica en archivos locales, archivos almacenados en un recurso compartido de la red, o bien usa la Autenticación de Windows:

     Nota: si se conecta a archivos guardados en un recurso compartido de la red o se genera en ellos, use el formato UNC para la ruta: \\server\path\file name. No puede estar protegida con contraseña.

     Windows

      "\[Tableau Prep Builder install location]\Tableau Prep Builder <version>\scripts"\tableau-prep-cli.bat -t "path\to\[your flow file name].tfl"

     Mac

     /Applications/Tableau\ Prep\ Builder\ [Tableau Prep Builder version].app/Contents/scripts/./tableau-prep-cli -t path/to/[your flow file name].tfl

   • El flujo se conecta a bases de datos o se publica en un servidor:

     Windows

     "\[Tableau Prep Builder install location]\Tableau Prep Builder <version>\scripts"\tableau-prep-cli.bat -c "path\to\[your credential file name].json" -t "path\to\[your flow file name].tfl"

     Mac

     /Applications/Tableau\ Prep\ Builder\ [Tableau Prep Builder version].app/Contents/scripts/./tableau-prep-cli -c path/to/[your credential file name].json -t path/to/[your flow file name].tfl

   • El archivo de flujo o de credenciales se almacena en un recurso compartido de la red (use el formato UNC para la ruta: \\server\path\file name):

     Windows

     "\[Tableau Prep Builder install location]\Tableau Prep Builder <version>\scripts"\tableau-prep-cli.bat -c "\server\path\[your credential file name].json" -t "\server\path\[your flow file name].tfl"

     Mac: asigne el recurso compartido de la red a /Volumes en Finder para que sea persistente y luego use /Volumes/.../[your file] para especificar la ruta:

     /Applications/Tableau\ Prep\ Builder\ [Tableau Prep Builder version].app/Contents/scripts/./tableau-prep-cli -c /Volumes/.../[your credential file name].json -t path/to/[your flow file name].tfl

Para ver errores y resoluciones comunes, consulte Errores comunes al utilizar la línea de comandos para ejecutar flujos.

Ejecutar el flujo con la actualización incremental habilitada

Compatible con la versión 2020.2.1 y posteriores de Tableau Prep Builder, y en la web a partir de la versión 2020.4. La actualización incremental no es compatible actualmente cuando se escriben salidas de flujo en Microsoft Excel.

Si no tiene Tableau Prep Conductor habilitado en el servidor para programar las ejecuciones de flujo, puede ejecutar el flujo mediante la actualización incremental desde la línea de comandos. Simplemente incluya el parámetro --incrementalRefresh en la línea de comandos como se muestra en el ejemplo siguiente.

Windows

 "\[Tableau Prep Builder install location]\Tableau Prep Builder <version>\scripts"\tableau-prep-cli.bat --incrementalRefresh -t "path\to\[your flow file name].tfl"

Mac

/Applications/Tableau\ Prep\ Builder\ [Tableau Prep Builder version].app/Contents/scripts/./tableau-prep-cli --incrementalRefresh -t path/to/[your flow file name].tfl

Si los pasos de entrada del flujo tienen habilitada la actualización incremental y los parámetros de actualización incremental están configurados correctamente, Tableau Prep Builder hará lo siguiente:

• Todas las entradas del flujo que tienen habilitada la actualización incremental ejecutarán todas las salidas correspondientes mediante la actualización incremental.
• Si ninguna entrada en el flujo tiene habilitada la actualización incremental, todas las salidas se ejecutarán mediante la actualización completa. Un mensaje mostrará los detalles del método de actualización.
• Si algunas entradas del flujo tienen habilitada la actualización incremental, las salidas correspondientes se ejecutarán mediante la actualización incremental. El resto de salidas se ejecutarán mediante la actualización completa y un mensaje mostrará los detalles del método de actualización.

Para obtener más información sobre cómo configurar flujos para usar la actualización incremental, consulte Actualizar datos de flujo mediante la actualización incremental

Opciones de comando

Si desea ver las opciones de ayuda, incluya -h en la línea de comandos.

usage: tableau-prep-cli [-c <arg>] [-d]  [-h] [-t <arg>]

-c,--connections <arg>        Path to a file with all connection information

-d,--debug                    This option is for debugging

-dsv,--disableSslValidation   Disable SSL validation

-h,--help                     Print usage message

-inc,--incrementalRefresh     Run incremental refresh for all outputs that are configured to support it

-t,--tflFile <arg>            The Tableau Prep Builder flow file	

Ejemplos de sintaxis

En la línea de comandos que aparece a continuación se muestran cuatro ejemplos diferentes para ejecutar un flujo mediante el uso de los siguientes criterios:

• Versión de Tableau Prep Builder: 2022.1.1

  Importante: en los ejemplos siguientes, se incluye el cambio de nombre de “Tableau Prep” versión 2019.1.2 a “Tableau Prep Builder”. Si usa una versión anterior del producto, use “Tableau Prep” en su lugar.

• Nombre del flujo: Flow1.tfl

• Ubicación de flujos: C:\Usuarios\jsmith\Documentos\Mi Repositorio de Tableau Prep Builder\Flujos

• Nombre del archivo de credenciales: Flow 1.json

• Ubicación del archivo de credenciales: C:\Users\jsmith\Desktop\Flow credentials

• Ubicación del archivo de credenciales almacenado en un recurso compartido de la red: \tsi.lan\files\Flow credentials

El flujo se conecta a archivos locales y se publica en ellos.

Windows

"\Program Files\Tableau\Tableau Prep Builder 2022.1.1\scripts"\tableau-prep-cli.bat -t "\C:\Users\jsmith\Documents\My Tableau Prep Builder Repository\Flows\Flow1.tfl"

Mac

/Applications/Tableau\ Prep\ Builder\ 2022.1.1.app/Contents/scripts/./tableau-prep-cli -t /Users/jsmith/Documents/My\ Tableau\ Prep\ Builder\ Repository/Flows.Flow1.tfl

El flujo se conecta y publica en archivos locales y utiliza la forma corta de actualización incremental

Windows

"\Program Files\Tableau\Tableau Prep Builder 2022.1.1\scripts"\tableau-prep-cli.bat -inc -t "\C:\Users\jsmith\Documents\My Tableau Prep Builder Repository\Flows\Flow1.tfl"

Mac

/Applications/Tableau\ Prep\ Builder\ 2022.1.1.app/Contents/scripts/./tableau-prep-cli -inc -t /Users/jsmith/Documents/My\ Tableau\ Prep\ Builder\ Repository/Flows.Flow1.tfl

El flujo se conecta a bases de datos y se publica en un servidor.

Windows

"\Program Files\Tableau\Tableau Prep Builder 2022.1.1\scripts"\tableau-prep-cli.bat -c "\C:\Users\jsmith\Desktop\Flow credentials\Flow1.json" -t "\C:\Users\jsmith\Documents\My Tableau Prep Builder Repository\Flows\Flow1.tfl"

Mac

/Applications/Tableau\ Prep\ Builder\ 2022.1.1.app/Contents/scripts/./tableau-prep-cli -c /Users/jsmith/Desktop/Flow\ credentials/Flow1.json -t /Users/jsmith/Documents/My\ Tableau\ Prep\ Builder\ Repository/Flows.Flow1.tfl

El flujo se publica en un servidor y el archivo de credenciales se almacena en un recurso compartido de la red.

Windows

"\Program Files\Tableau\Tableau Prep Builder 2022.1.1\scripts"\tableau-prep-cli.bat -c "\\tsi.lan\files\Flow credentials\Flow1.json" -t "\C:\Users\jsmith\Documents\My Tableau Prep Builder Repository\Flows\Flow1.tfl"

Mac

/Applications/Tableau\ Prep\ Builder\ 2022.1.1.app/Contents/scripts/./tableau-prep-cli -c /Volumes/files/Flow\ credentials/Flow1.json -t /Users/jsmith/Documents/My\ Tableau\ Prep\ Builder\ Repository/Flows.Flow1.tfl