Utilitaire de ligne de commande Tableau Data Extract

Vous pouvez automatiser les tâches d'actualisation d'extrait à l'aide de l'utilitaire de ligne de commande Tableau Data Extract. Il s'agit d'un utilitaire de ligne de commande livré avec Tableau Desktop, qui vous permet d'actualiser les sources de données d'un extrait publiées ou de leur ajouter des données à partir d'un fichier.

Voici les exigences pour l'utilisation de l'utilitaire de ligne de commande Tableau Data Extract :

  • Cet utilitaire est disponible avec Tableau Desktop sur Windows et peut uniquement s'exécuter sur un système Windows.

  • Il n’est pas disponible avec la version d’évaluation de Tableau Desktop.

  • Vous pouvez l'utiliser pour les sources de données d'un extrait qui n'utilisent pas OAuth.

  • Vous pouvez l'utiliser pour actualiser les sources de données mono-connexion uniquement. Il ne fonctionne pas pour les sources de données multiconnexion.

Avant d'exécuter l'utilitaire

Lorsque vous procédez à une actualisation d'extrait ou à un ajout de données sur des extraits créés dans Tableau 10.4 et versions antérieures (à savoir un extrait .tde), l'extrait est automatiquement mis à niveau à un extrait .hyper. Si la mise à niveau à un extrait .hyper présente de nombreux avantages, vous ne pourrez toutefois pas ouvrir l'extrait avec les versions antérieures de Tableau Desktop.

Pour plus d'informations, consultez Mise à niveau d'extraits vers le format .hyper.

Exécuter l'utilitaire

  1. Ouvrez une invite de commande en tant qu'administrateur et accédez au répertoire bin de Tableau Server. Par exemple :

    cd C:\Program Files\Tableau\Tableau 2021.3\bin

  2. Utilisez l'une des commandes suivantes en y ajoutant l'un des paramètres décrtis dans les tableaux ci-dessous.

    • tableau refreshextract

    • tableau addfiletoextract

Remarque : Lorsque vous utilisez l'utilitaire, spécifiez systématiquement tableau à la ligne de commande ou dans les scripts, et jamais tableau.exe.

Remarque : pour dépanner, vérifiez les journaux dans le fichier tableaucom.txt du dossier \My Tableau Repository\Logs.

Remarque : dans un environnement multi-sites, spécifiez le site auquel la commande s'applique.

Syntaxe et paramètres de la commande tableau refreshextract

Utilisez tableau refreshextract pour actualiser un extrait sur Tableau Server ou Tableau Online. L'actualisation d'un extrait entraîne la mise à jour d'un extrait existant à l'aide des modifications réalisées dans la source de données depuis la dernière actualisation.

Pour obtenir de l'aide sur cette commande, saisissez la commande suivante à l'invite de commande :

tableau help refreshextract

Utilisation de paramètres

  • Toutes les options disposent d'une forme complète présentant un double tiret (par exemple, --server).

  • Certaines options disposent d'une forme courte présentant un seul tiret (par exemple, -s).

  • Si la valeur d'une option contient des espaces, placez-la entre guillemets.

  • La source en cours d'actualisation doit être la source de données d'origine, et non un extrait .tde.

tableau refreshextract command options

Forme courte Forme complète Description
  --source-username <user name>

Nom d'utilisateur valide pour la connexion à la source de données.

Utilisez cette option avec --source-password, ou utilisez

--original-file au lieu des options de nom d'utilisateur et de mot de passe.

Remarque : Vous devez fournir le nom d'utilisateur et le mot de passe lors de l'actualisation d'un extrait publié, même si la source de données a été initialement publiée avec des informations d'identification intégrées.

  --source-password "<password>"

Mot de passe de l'utilisateur de la source de données.

 

--original-file <path and file name>

ou

--original-file <path and folder name>

Chemin et nom de fichier de la source de données à actualiser sur le serveur. Par exemple : --original-file c:\folder\file.csv

Pour actualiser une source de données multi-fichiers, transmettez le chemin à un dossier qui contient les fichiers de données. Par exemple : --original-file c:\folder.

Si le fichier se trouve sur un partage réseau, utilisez le format UNC pour le chemin d'accès : \\server\path\filename.csv

  --force-full-refresh

Si la source de données est configurée pour des actualisations incrémentielles, utilisez cette option pour forcer une actualisation complète de l'extrait. Si cette option n'est pas incluse, l'actualisation réalisée est de type incrémentiel. Toutes les sources de données ne prennent pas en charge l'actualisation incrémentielle.

-s <server http address> --server <URL>

L'URL du serveur Tableau sur lequel les données sont publiées.

Pour Tableau Online, spécifiez https://online.tableau.com.

-t <site id> --site <siteid>

Dans un environnement présentant plusieurs sites, indique celui auquel la commande s'applique. Pour Tableau Online, utilisez cet argument si votre nom d'utilisateur est associé à plusieurs sites. Pour Tableau Server, si vous ne spécifiez aucun site, le site Par défaut est utilisé.

L'ID du site est indépendant de son nom et est indiqué dans l'URL lorsque vous le consultez dans un navigateur. Par exemple, si l'URL de la page qui s'affiche après vous être connecté dans Tableau Online est

https://online.tableau.com/t/vernazza/views

l'ID du site est vernazza.

  --datasource <datasource>

Le nom de la source de données, tel qu'il est publié vers Tableau Server ou Tableau Online.

  --project <projectname>

Projet auquel appartient la source de données. Si cette option n'est pas incluse, le projet par défaut est utilisé.

Si le projet que vous souhaitez spécifier est un projet enfant imbriqué dans une hiérarchie de projet, vous devez utiliser ce paramètre en même temps que le paramètre --parent-project-path.

  --parent-project-path path/to/project

Si un projet sur lequel la source de données est publiée ne se trouve pas au niveau supérieur d'une hiérarchie de projet, utilisez ce paramètre en même temps que le paramètre --project pour spécifier le chemin d'accès au projet imbriqué.

Utilisez le caractère de barre oblique (/) pour délimiter les niveaux de projet dans la hiérarchie. Utilisez le caractère de barre oblique inverse (\) pour l'échappement des instances de caractères de barre oblique ou barre oblique inverse dans les noms de projet.

Par exemple, pour un projet intitulé Sandbox, dans le projet Social, sous Marketing de niveau supérieur :

--project Sandbox --parent-project-path Marketing/Social

-u <user name> --username <username>

Utilisateur Tableau Server ou Tableau Online valide.

-p "<password>" --password "<password>"

Le mot de passe de l'utilisateur spécifique de Tableau Server ou de Tableau Online.

  --proxy-username <username>

Nom d'utilisateur pour un serveur proxy.

  --proxy-password "<password>"

Mot de passe pour un serveur proxy.

-c "<path and file name>" --config-file "<path and file name>"

Informations de chemin d'accès et de dénomination d'un fichier contenant des options de configuration relatives à la commande. Placez toujours le chemin entre des guillemets droits doubles. Pour plus d'informations, consultez Utilisation d'un fichier de configuration ci-dessous.

Syntaxe de la commande tableau refreshextract

Les commandes suivantes actualisent un extrait dont le nom est CurrentYrOverYrStats qui a été publié sur un serveur Tableau Server local. Cette commande spécifie ce qui suit :

  • Le nom de votre serveur Tableau Server.
  • Nom d'utilisateur et mot de passe pour le serveur.
  • Nom du projet.
  • Le nom de la source de données à actualiser, ainsi que le nom d'utilisateur et le mot de passe de la source de données.

C:\Program Files\Tableau\Tableau 2021.3\bin>tableau refreshextract --server https://our_server_name --username OurServerSignIn --password "OurServerPwd" --project "New Animations" --datasource "CurrentYrOverYrStats" --source-username OurDatabaseSignIn --source-password "OurDatabasePassword"

La commande suivante actualise un extrait dont le nom est CurrentYrOverYrStats qui a été publié vers Tableau Online. Cette commande spécifie ce qui suit :

  • Nom d'utilisateur et mot de passe Tableau Online.
  • Noms des sites et des projets Tableau Online.
  • La source de données, hébergée dans ce cas par un fournisseur de sources de données basées sur le Cloud (par exemple, Salesforce.com) et le nom d'utilisateur et le mot de passe permettant de se connecter à la source de données hébergée.

C:\Program Files\Tableau\Tableau 2021.3\bin>tableau refreshextract --server https://online.tableau.com --username email@domain.com --password "OurServerPwd" --site vernazza --project "New Animations" --datasource "CurrentYrOverYrStats" --source-username database_user@hosted_datasource_provider.com --source-password "db_password"

Pour actualiser un extrait de source de données basé sur un fichier, fournissez le chemin d'accès au fichier d'origine à partir duquel vous avez créé l'extrait. Si le fichier se trouve sur un partage réseau, utilisez le format UNC plutôt qu'un lecteur mappé.

C:\Program Files\Tableau\Tableau 2021.3\bin>tableau refreshextract --server https://online.tableau.com --username email@domain.com --password "OurServerPwd" --site vernazza --project "New Animations" --datasource "CurrentYrOverYrStats" --original-file "\\server\path\filename.csv"

Syntaxe de tableau addfiletoextract

Utilisez tableau addfiletoextract pour ajouter le contenu d'un fichier à un extrait publié sur Tableau Server ou Tableau Online. Cette commande associe les deux fichiers.

Si vous souhaitez simplement mettre à jour un extrait existant à l'aide des toutes dernières modifications, utilisez plutôt la ligne de commande refreshextract. L'utilisation de la commande addfiletoextract pour mettre à jour un extrait existant entraîne la duplication des données.

Pour obtenir de l'aide sur cette commande, saisissez la commande suivante à l'invite de commande :

tableau help addfiletoextract

Toutes les options disposent d'une forme complète présentant un double tiret (par exemple, --server). Certaines options disposent d'une forme courte présentant un seul tiret (par exemple, -s). Si la valeur d'une option contient des espaces, placez-la entre guillemets.

options de la commande tableau addfiletoextract

Forme courte Forme complète Description
  --file <path and file name>

Informations de chemin d'accès et de dénomination du fichier de données contenant les données à ajouter. Il peut s'agir d'un fichier Excel ou Access, d'un extrait de données Tableau ou d'un fichier texte délimité. Elles ne peuvent pas être protégées par un mot de passe. Si le fichier se trouve sur un partage réseau, utilisez le format UNC. Par exemple, \\server\path\filename.csv

-s <server http address> --server <URL>

L'URL du serveur Tableau sur lequel les données sont publiées.

Pour Tableau Online, spécifiez https://online.tableau.com.

-t <site id> --site <site id>

Dans un environnement présentant plusieurs sites, indique celui auquel la commande s'applique. Pour Tableau Online, intégrez cet argument si votre nom d'utilisateur est associé à plusieurs sites. Pour Tableau Server, si vous ne spécifiez aucun site, le site Par défaut est utilisé.

  --datasource <datasource>

Le nom de la source de données, tel qu'il est publié vers Tableau Server ou Tableau Online.

  --project <projectname>

Projet auquel appartient la source de données. Si cette option n'est pas incluse, le projet par défaut est utilisé.

Si le projet que vous souhaitez spécifier est un projet enfant imbriqué dans une hiérarchie de projet, vous devez utiliser ce paramètre en même temps que le paramètre --parent-project-path.

  --parent-project-path path/to/project

Si un projet sur lequel la source de données est publiée ne se trouve pas au niveau supérieur d'une hiérarchie de projet, utilisez ce paramètre en même temps que le paramètre --project pour spécifier le chemin d'accès au projet imbriqué.

Utilisez le caractère de barre oblique (/) pour délimiter les niveaux de projet dans la hiérarchie. Utilisez le caractère de barre oblique inverse (\) pour l'échappement des instances de caractères de barre oblique ou barre oblique inverse dans les noms de projet.

Par exemple, pour un projet intitulé Sandbox, dans le projet Social, sous Marketing de niveau supérieur :

--project Sandbox --parent-project-path Marketing/Social

-u <username> --username <username>

Utilisateur Tableau Server ou Tableau Online valide.

-p "<password>" --password "<password>"

Le mot de passe de l'utilisateur spécifique de Tableau Server ou de Tableau Online.

  --proxy-username <username>

Nom d'utilisateur pour un serveur proxy.

  --proxy-password "<password>"

Mot de passe pour un serveur proxy.

-c "<path and filename>" --config-file "<path and filename>"

Informations de chemin d'accès et de dénomination d'un fichier contenant des options de configuration relatives à la commande. Placez toujours le chemin entre des guillemets droits doubles. Pour plus d'informations, consultez Utilisation d'un fichier de configuration ci-dessous.

Exemple de commande tableau addfiletoextract

C:\Program Files\Tableau\Tableau 2021.3\bin>tableau addfiletoextract --server https://our_server_name --username OurServerSignIn --password "OurServerPwd" --project "New Animations" --datasource "CurrentYrOverYrStats" --file "C:\Users\user1\Documents\DataUploadFiles\AprMay.csv"

C:\Program Files\Tableau\Tableau 2021.3\bin>tableau addfiletoextract --server https://online.tableau.com --username email@domain.com --password "OurServerPwd" --site vernazza --project "New Animations" --datasource "CurrentYrOverYrStats" --file "C:\Users\user2\Documents\DataUploadFiles\AprMay.csv"

Utilisation d'un fichier de configuration

Utilisez un éditeur de texte, tel que le Bloc-notes ou TextEdit, pour créer un fichier config (configuration) qu'il est possible d'utiliser soit avec tableau refreshextract, soit avec tableau addfiletoextract. Vous pouvez utiliser un fichier config si vous envisagez de mettre à jour plusieurs fois la même source de données. Au lieu d'avoir à saisir les mêmes options à chaque exécution de commande, spécifiez le fichier config. L'utilisation d'un fichier config a également pour avantage de ne pas exposer les noms d'utilisateur et mots de passe sur la ligne de commande.

Création du fichier config

Par exemple, imaginons que vous avez créé un fichier appelé config.txt et que vous l'avez enregistré dans votre dossier Documents. Dans le fichier, vous avez inclus les informations de paramètres ci-dessous.

Pour un extrait publié sur Tableau Server :

server=https://our_server_name
username=OurServerSignIn
password=OurServerPwd
project=New Animations
datasource=CurrentYrOverYrStats

Pour un extrait provenant d'une source de données hébergée publié sur Tableau Online, où server est https://online.tableau.com :

server=https://online.tableau.com
site=vernazza
username=email@domain.com
password=OurPassword
project=New Animations
datasource=CurrentYrOverYrStats
source-username=database_user@hosted_datasource_provider.com
source-password=db_password

Faire référence au fichier config à partir de la ligne de commande

Après avoir créé le fichier config, exécutez la commande tableau refreshextract ou tableau addfiletoextract, en pointant sur le fichier config comme seule option à utiliser sur la ligne de commande et en plaçant le chemin du fichier config entre des guillemets droits doubles. La syntaxe est la suivante :

tableau refreshextract --config-file "<path>"

Par exemple, pour actualiser l'extrait spécifié dans l'échantillon présent dans la sectionCréation du fichier config , exécutez la commande suivante (en vous assurant d'utiliser le répertoire bin de votre version de Tableau Desktop) :

C:\Program Files\Tableau\Tableau 2021.3\bin>tableau refreshextract --config-file "C:\Users\user1\Documents\config.txt"

Différences de syntaxe pour les fichiers config

La syntaxe permettant de spécifier les options dans un fichier config est différente de celle utilisée sur la ligne de commande :

  • Les noms d'options ne commencent pas par des tirets ou des traits d'union.
  • Utilisez un signe égal (sans espace) pour séparer les noms des valeurs d'options.
  • L'utilisation de guillemets n'est pas nécessaire (ni autorisée) pour les valeurs, même lorsqu'elles intègrent des espaces (comme pour l'option project de l'exemple montré précédemment).

Utiliser le planificateur de tâches de Windows pour actualiser des extraits

Il est possible d'utiliser le planificateur de tâches de Windows, en association avec l'utilitaire de ligne de commande d'extraits de données Tableau, pour automatiser des mises à jour régulières de sources de données Tableau Desktop dans votre pare-feu d'entreprise. Il est possible de configurer une tâche de sorte qu'elle s'effectue une fois par jour, par semaine ou par mois, ou après un événement système en particulier. Par exemple; la tâche peut s'exécuter au démarrage de l'ordinateur.

Pour en savoir plus, consultez la page Planificateur de tâches - Comment...(Le lien s’ouvre dans une nouvelle fenêtre) de la bibliothèque Microsoft TechNet.

Merci de vos commentaires !