Aide de Tableau Prep

Pris en charge dans Tableau Prep Builder uniquement.

Vous pouvez exécuter votre flux depuis la ligne de commande pour actualiser votre sortie de flux au lieu d’exécuter le flux depuis Tableau Prep Builder. Vous pouvez exécuter un flux à la fois à l’aide de cette méthode. Cette option est disponible à la fois sur les ordinateurs Windows et Mac sur lesquels Tableau Prep Builder est installé.

Remarque : si vous utilisez la gestion des licences basée sur la connexion (LBLM), assurez-vous d’ouvrir périodiquement Tableau Prep. Sinon, le bail peut expirer, provoquant l’échec des flux exécutés via la ligne de commande. Vous pouvez également contacter votre administrateur pour modifier la durée de votre bail sur la durée maximale. Pour plus d’informations, consultez la section Gestion des licences basée sur la connexion(Le lien s’ouvre dans une nouvelle fenêtre).

Limitations du connecteur :

• Connecteurs JDBC ou ODBC : les flux qui incluent ces connecteurs peuvent être exécutés depuis la ligne de commande à compter de la version 2019.2.3.
• Connecteurs dans le nuage : les flux qui incluent des connecteurs dans le nuage, tels que Google BigQuery, ne peuvent pas être exécutés depuis la ligne de commande. Au lieu de cela, exécutez le flux manuellement ou exécutez le flux de manière programmée dans Tableau Server ou Tableau Cloud à l’aide de Tableau Prep Conductor. Pour plus d’informations, consultez Actualiser les données de flux.
• Authentification SSO : l’exécution de flux à partir de la ligne de commande n’est pas prise en charge si vous utilisez l’authentification SSO. Vous pouvez exécuter les flux depuis Tableau Prep Builder à la place.
• Authentification multifacteur : l’interface en ligne de commande (CLI) de Tableau Prep ne prend pas en charge Tableau avec l’authentification multifacteur (MFA). Pour en savoir plus, consultez cet article(Le lien s’ouvre dans une nouvelle fenêtre) dans la Base de connaissances de Tableau.

Pour les ordinateurs Windows, vous pouvez également programmer ce processus à l’aide du Planificateur de tâches Windows. Pour plus d’informations, consultez Planificateur de tâches(Le lien s’ouvre dans une nouvelle fenêtre) dans l’aide en ligne de Microsoft.

Lorsque vous exécutez des flux depuis la ligne de commande, Tableau Prep Builder actualise toutes les sorties du flux à l’aide des paramètres des étapes de sortie spécifiées dans Tableau Prep Builder. Pour savoir comment spécifier vos emplacements de sortie, consultez Créer des fichiers d’extrait de données et des sources de données publiées(Le lien s’ouvre dans une nouvelle fenêtre). Pour plus d’informations sur la configuration de vos options d’écriture (version 2020.2.1 et versions ultérieures), consultez Configurer les options d’écriture.

Avant d’exécuter le flux

Pour exécuter le flux depuis la ligne de commande, vous aurez besoin de privilèges d’administrateur sur l’ordinateur où vous exécutez le flux et vous aurez besoin des renseignements suivants :

• Chemin d’accès sur lequel Tableau Prep Builder est installé.

• En cas de connexion à des bases de données et de publication de fichiers de sortie sur un serveur ou une base de données (version 2020.3.1 et versions ultérieures), créez un fichier d’identifiants .json qui inclut toutes les informations d’identification nécessaires.

• Chemin d’accès hébergeant le fichier de flux Tableau (.tfl).

Exigences du fichier d’identifiants .json

Remarque : les fichiers d’identifiants .json ne sont pas requis si le flux se connecte et envoie la sortie à des fichiers locaux, à des fichiers stockés sur un partage réseau ou à des fichiers de données entrantes utilisant l’authentification Windows (SSPI). Pour plus d’informations sur l’authentification Windows, consultez Modèle SSPI(Le lien s’ouvre dans une nouvelle fenêtre) dans l’aide en ligne de Microsoft.

Tableau Prep Builder utilise l’information du fichier de flux et du fichier .json d’identifiants pour exécuter le flux dans le cas de connexions distantes. Par exemple, le nom de la base de données pour vos connexions à distance et le nom du projet pour vos fichiers de sortie proviennent du flux, et le nom du serveur et les identifiants de connexion proviennent du fichier d’identifiants .json.

• Si vous comptez réutiliser le fichier, placez-le dans un dossier où il ne sera pas écrasé par le processus d’installation de Tableau Prep Builder.
• Si vous exécutez un flux qui comprend l’un des éléments suivants, vous devez inclure un fichier .json qui inclut les identifiants requis pour vous connecter.
  • Connectez-vous à des fichiers de base de données ou des sources de données publiées.
  • La sortie est publiée sur un serveur ou sur une base de données ( depuis la version 2020.3.1).
  • Le flux inclut des étapes de script pour Rserve ou TabPy. Le fichier .json doit inclure les informations d’identification requises pour se connecter à ces services. Pour plus d’informations, consultez les exigences du tableau pour votre version ci-dessous.
• Les identifiants spécifiés dans votre flux et ceux inclus dans votre fichier .json doivent correspondre, sinon le flux ne s’exécutera pas.
• Lorsque vous exécutez le processus, le nom d’hôte, le port et le nom d’utilisateur sont utilisés pour trouver la connexion correspondante dans le fichier de flux Tableau (.tfl) et mis à jour avant l’exécution du processus. L’ID de port et l’ID de site sont facultatifs si vos connexions ne requièrent pas cette information.

• Si vous vous connectez à une source de données publiée, incluez les valeurs hostname, contentUrl et port (80 pour http et 443 pour https) dans les connexions d’entrée. Le nom d’hôte est nécessaire pour trouver la connexion correspondante dans le fichier de flux Tableau (. tfl). Quant à contentUrl et au port, ils servent à établir la connexion au serveur.

• Si vous vous connectez à Tableau Cloud, incluez le port (80 ou 443) dans les connexions d’entrée pour le module auquel vous vous connectez et dans l’URl de connexion au serveur, assurez-vous d’inclure le préfixe de module correspondant avec online.tableau.com. Pour plus d’informations sur Tableau Cloud, consultez Connexions Tableau Bridge à Tableau Cloud(Le lien s’ouvre dans une nouvelle fenêtre) dans l’aide en ligne de Tableau Cloud.
• (version 2021.4.1 et ultérieure) Si vous incluez des paramètres dans votre flux, vous pouvez créer et inclure un fichier .json de remplacement des paramètres dans la ligne de commande pour modifier les valeurs des paramètres à partir des valeurs par défaut actuelles. Pour plus d’informations, consultez Exécuter des flux qui incluent des valeurs de paramètre.

Selon votre version de Tableau Prep Builder, vos identifiants peuvent être mis en forme différemment. Cliquez sur l’onglet ci-dessous pour afficher le format des identifiants pour votre version 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"
	}
   } 
  ]
}

Conseils pour la création de votre fichier d’identifiants

Pour éviter des erreurs lors de l’exécution du flux, assurez-vous que votre fichier d’identifiants suit ces recommandations :

• Si vous utilisez Tableau Prep Builder version 2018.2.2 à 2018.3.1, incluez toujours les lignes « inputConnections » et « outputConnections » même si le flux ne dispose pas de connexions distantes pour les données entrantes ou sortantes. Laissez simplement ces lignes vides.

  Si vous utilisez Tableau Prep Builder version 2018.3.2 et versions ultérieures, vous n’avez pas besoin d’inclure la ligne vide.

  • Pas de connexion d’entrée distante? Incluez cette syntaxe en haut du fichier .json

    {
     "inputConnections":[
      ],

  • Pas de connexion de sortie distante? Incluez cette syntaxe en bas du fichier .json

  "outputConnections":[
    ]
  }

• L’ID de port pour votre connexion d’entrée ou le port n’est pas spécifié dans le nom du serveur.

  S’il n’y a pas d’ID de port pour votre connexion, n’incluez pas la référence "port":xxxx, dans le fichier .json, pas même "port": "". Si l’ID de port est inclus dans le nom du serveur, incluez l’ID de port dans le nom d’hôte. Par exemple "hostname": "mssql.example.lan,1234"

• Lorsque vous référencez "serverUrl":, n’incluez pas un signe « / » à la fin de l’adresse. Par exemple, utilisez "serverUrl": "http://server", et non "serverUrl": "http://server/".

• Si vous avez plusieurs connexions à des données entrantes ou sortantes, incluez les identifiants pour chacun dans le fichier.

• Si vous vous connectez à des sources de données publiées, assurez-vous d’inclure le nom d’hôte et contentUrl dans les connexions d’entrée.

Exécuter le flux

Important : les exemples ci-dessous incluent le changement de nom de la version 2019.1.2 de « Tableau Prep » en « Tableau Prep Builder ». Si vous utilisez une version antérieure du produit, utilisez plutôt « Tableau Prep ».

1. Ouvrez l’invite de commande ou l’invite de commande du terminal (MacOS) en tant qu’administrateur.

2. Exécutez l’une des commandes suivantes en utilisant la syntaxe indiquée ci-dessous.

   • Le flux se connecte aux fichiers locaux ou aux fichiers stockés sur un partage réseaux et publie sur les fichiers locaux, les fichiers stockés sur un partage réseau, ou utilise l’authentification Windows :

     Remarque : si vous vous connectez ou envoyez la sortie à des fichiers stockés sur un partage réseau, utilisez le format UNC pour le chemin d’accès : \\server\path\file name. Il ne peut pas être protégé par un mot de passe.

     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

   • Le flux se connecte aux bases de données ou publie sur un serveur :

     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

   • Le fichier de flux ou le fichier d’identifiants est stocké sur un partage réseau (utilisez le format UNC pour le chemin d’accès : \\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 : Mappez le partage réseau à /Volumes dans le Finder afin qu’il soit persistant, puis utilisez /Volumes/.../[your file] pour spécifier le chemin d’accès :

     /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

Pour des informations sur les erreurs courantes et leurs solutions, consultez Erreurs courantes en cas d’utilisation de la ligne de commande pour exécuter des flux.

Exécuter le flux avec l’actualisation incrémentielle activée

Pris en charge dans Tableau Prep Builder version 2020.2.1 et versions ultérieures, et en ligne à partir de la version 2020.4. L’actualisation incrémentielle n’est actuellement pas prise en charge lors de l’écriture de sorties de flux dans Microsoft Excel.

Si vous n’avez pas activé Tableau Prep Conductor sur votre serveur pour planifier l’exécution de vos flux, vous pouvez exécuter votre flux à l’aide d’actualisations incrémentielles depuis la ligne de commande. Il suffit d’inclure le paramètre --incrementalRefresh dans votre ligne de commande comme indiqué dans l’exemple ci-dessous.

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 l’actualisation incrémentielle est activée pour les étapes de saisie de votre flux et que les paramètres d’actualisation incrémentielle sont correctement configurés, Tableau Prep Builder procèdera comme suit :

• Toutes les entrées du flux pour lesquelles l’actualisation incrémentielle est activée exécuteront toutes les sorties correspondantes en utilisant l’actualisation incrémentielle.
• Si l’actualisation incrémentielle n’a été activée pour aucune entrée dans le flux; toutes les sorties seront exécutées à l’aide d’une actualisation complète. Un message affiche les détails de la méthode d’actualisation.
• Si l’actualisation incrémentielle est activée pour certaines entrées dans le flux, les sorties correspondantes s’exécuteront à l’aide d’une actualisation incrémentielle. Les autres sorties seront exécutées à l’aide d’une actualisation complète et un message affichera les détails de la méthode d’actualisation.

Pour plus d’informations sur la configuration des flux de manière à utiliser l’actualisation incrémentielle, consultez Actualiser les données de flux à l’aide d’une actualisation incrémentielle

Options de commande

Si vous souhaitez afficher les options d’aide, incluez -h dans la ligne de commande.

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	

Exemples de syntaxe

Les lignes de commande ci-dessous affichent quatre exemples différents d’exécution d’un flux à l’aide des critères suivants :

• Tableau Prep Builder version : 2022.1.1

  Important : les exemples ci-dessous incluent le changement de nom de Tableau Prep version 2019.1.2 en « Tableau Prep Builder ». Si vous utilisez une version antérieure du produit, utilisez plutôt « Tableau Prep ».

• Nom du flux : Flow1.tfl

• Emplacement du flux : C:\Users\jsmith\Documents\Mon référentiel Tableau Prep Builder\Flows

• Nom du fichier d’identifiants : Flow 1.json

• Emplacement du fichier d’identifiants : C:\Users\jsmith\Desktop\Flow credentials

• Emplacement du fichier d’identifiants stockés sur un partage réseau : \tsi.lan\files\Flow credentials

Le flux se connecte aux fichiers locaux et publie sur les fichiers locaux

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

Le flux se connecte à des fichiers locaux et publie sur ces fichiers, et utilise la forme courte pour l’actualisation incrémentielle

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

Le flux se connecte aux bases de données et publie sur un serveur

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

Le flux publie sur un serveur et le fichier d’identifiants est stocké sur un partage réseau

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