Commandes de tabcmd

Cette section présente les différentes commandes pouvant être utilisées par l'outil de ligne de commande tabcmd :

addusers nom-groupe get url
creategroup nom-groupe listsites
createproject nom-projet login
createsite nom-site logout
createsiteusers nomfichier.csv publish nomfichier.twb(x) ou nomfichier.tds(x)
createusers nomfichier.csv refreshextracts nom-classeur ou nom-sourcedonnées
delete nom-classeur ou nom-sourcedonnées removeusers nom-groupe
deletegroup nom-groupe runschedule nom-programmation
deletesite nom-site set paramètre
deleteusers nomfichier.csv syncgroup nom-groupe
editsite nom site version
export  
   
   

addusers nom-groupe

Ajoute les utilisateurs répertoriés dans l'argument --users au groupe portant le nom-groupe donné.

Exemple

tabcmd addusers "Development" --users "users.csv"
Option (forme courte) Option (forme longue) Argument Description
  
--users
nomfichier.csv Ajoute les utilisateurs du fichier donné au groupe spécifié. Le fichier doit se composer d'une simple liste avec un nom d'utilisateur par ligne. Les utilisateurs doivent déjà être créés dans Tableau Server. Voir également Directives relatives aux fichiers CSV.
  
--[no-]complete
  Lorsqu'elle est définie sur complete, cette option requiert que toutes les lignes soient valides pour que les modifications prennent effet. Sinon, --complete est utilisé.
 

creategroup nom-groupe

Crée un groupe portant le nom donné. Utilisez les commandes addusers (groupes locaux) et syncgroup (groupes Active Directory) pour ajouter des utilisateurs après la création du groupe.

Exemple

tabcmd creategroup "Development"
 

createproject nom-projet

Crée un projet portant le nom donné.

Exemple

tabcmd createproject -n "Quarterly_Reports" -d "Workbooks showing quarterly sales reports."
Option (forme courte) Option (forme longue) Argument Description
-n --name nom Spécifiez le nom du projet que vous souhaitez créer.
-d --description description Indiquez une description pour le projet.
 

createsite nom-site

Crée un site portant le nom donné.

Exemple

tabcmd createsite "Sales"
 

createsiteusers nomfichier.csv

Cette commande permet d'autoriser les administrateurs de contenu à ajouter des utilisateurs à un site. Cela permet de créer des utilisateurs pour le site actuel en utilisant le fichier CSV (valeurs séparées par des virgules) donné. Le fichier peut contenir les colonnes suivantes, dans l'ordre indiqué ci-dessous :

  1. Username

  2. Password

  3. Full Name

  4. License Level (interactor/viewer/unlicensed)

  5. Administrator (content/none)

  6. Publisher (yes/true/1 ou no/false/0)

Le fichier peut contenir moins de colonnes. Par exemple, il peut se composer d'une simple liste avec un nom d'utilisateur par ligne. Lorsque le serveur utilise l'authentification Active Directory, la colonne Password est ignorée. Des guillemets droits peuvent être utilisés si une valeur contient des virgules. Pour plus d'informations, reportez-vous à Directives relatives aux fichiers CSV.

Exemple

tabcmd createsiteusers "users.csv" --license "Interactor" --publishers
Option (forme courte) Option (forme longue) Argument Description
  --nowait   Permet de ne pas attendre que les tâches asynchrones soient terminées.
  --silent-progress   Permet de ne pas afficher les messages de progression pour les tâches asynchrones.
  --license Interactor, Viewer ou Unlicensed Définit le niveau de licence par défaut pour tous les utilisateurs. Ce paramètre peut être remplacé par la valeur du fichier CSV.
  --admin-type Content ou None Affecte ou supprime le droit d'administration de contenu pour tous les utilisateurs du fichier CSV. Ce paramètre peut être remplacé par la valeur du fichier CSV. La valeur par défaut est None pour les nouveaux utilisateurs et reste inchangée pour les utilisateurs existants. Vous ne pouvez pas créer un administrateur système ou modifier les droits d'un administrateur système avec la commande createsiteusers (utilisez plutôt createusers).
  --[no-]publishers   Affecte ou supprime le droit de publication pour tous les utilisateurs du fichier CSV par défaut. Ce paramètre peut être remplacé par la valeur du fichier CSV. La valeur par défaut est no pour les nouveaux utilisateurs et reste inchangée pour les utilisateurs existants.
  --[no-]complete   Ce paramètre définit si toutes les lignes doivent être valides pour que les modifications prennent effet. L'option --complete est utilisée par défaut.
 

createusers nomfichier.csv

Crée les utilisateurs répertoriés dans le fichier CSV (valeurs séparées par des virgules) donné. Seuls les administrateurs système peuvent utiliser cette commande. Le fichier peut contenir les colonnes suivantes, dans l'ordre indiqué ci-dessous :

  1. Username

  2. Password

  3. Full Name

  4. License Level (interactor/viewer/unlicensed)

  5. Administrator (system/content/none)

  6. Publisher (yes/true/1 ou no/false/0)

Le fichier peut contenir moins de colonnes. Par exemple, il peut se composer d'une simple liste avec un nom d'utilisateur par ligne. Lorsque le serveur utilise l'authentification Active Directory, la colonne Password doit être vide. Des guillemets droits peuvent être utilisés si une valeur contient des virgules. Pour plus d'informations, reportez-vous à Directives relatives aux fichiers CSV.

Exemple

tabcmd createusers "users.csv" --license "Interactor" --publishers
Option (forme courte) Option (forme longue) Argument Description
  --nowait   Permet de ne pas attendre que les tâches asynchrones soient terminées.
  --silent-progress   Permet de ne pas afficher les messages de progression pour les tâches asynchrones.
  --license Interactor, Viewer ou Unlicensed Définit le niveau de licence par défaut pour tous les utilisateurs. Ce paramètre peut être remplacé par la valeur du fichier CSV.
  --admin-type System, Content ou None Affecte ou supprime le droit Admin pour tous les utilisateurs du fichier CSV par défaut. Ce paramètre peut être remplacé par la valeur du fichier CSV. La valeur par défaut est None pour les nouveaux utilisateurs et reste inchangée pour les utilisateurs existants.
  --[no-]publishers   Affecte le droit de publication à tous les utilisateurs du fichier CSV par défaut. Ce paramètre peut être remplacé par la valeur du fichier CSV. La valeur par défaut est no pour les nouveaux utilisateurs et reste inchangée pour les utilisateurs existants.
  --[no-]complete   Requiert que toutes les lignes soient valides pour que les modifications prennent effet. L'option --complete est utilisée par défaut.
 

delete nom-classeur ou nom-sourcedonnées

Supprime le classeur ou la source de données spécifié du serveur. Cette commande utilise le nom du classeur ou de la source de données tel qu'il est spécifié sur le serveur, et non le nom du fichier lors de sa publication.

Exemple

tabcmd delete "Sales_Analysis"
Option (forme courte) Option (forme longue) Argument Description
-r --project Nom du projet Nom du projet contenant le classeur ou la source de données que vous souhaitez supprimer. Si aucun nom n'est spécifié, le projet « Par défaut » est utilisé.
  --workbook Nom de classeur Nom du classeur que vous souhaitez supprimer.
  --datasource Nom de la source de données Nom de la source de données que vous souhaitez supprimer.
 

deletegroup nom-groupe

Supprime le groupe portant le nom-groupe donné sur le serveur.

Exemple

tabcmd deletegroup "Development"
 

deletesite nom-site

Supprime le site portant le nom de site donné sur le serveur.

Exemple

tabcmd deletesite "Development"
 

deleteusers nomfichier.csv

Supprime les utilisateurs répertoriés dans le fichier CSV (valeurs séparées par des virgules) donné. Le fichier doit se composer d'une simple liste avec un nom d'utilisateur par ligne.

Exemple

tabcmd deleteusers "users.csv"
Option (forme courte) Option (forme longue) Argument Description
  --[no-]complete   Lorsqu'elle est définie sur --complete, cette option requiert que toutes les lignes soient valides pour que les modifications prennent effet. Sinon, --complete est utilisé.
 

editsite nom site

Cette commande permet de changer le nom d'un site ou le nom de son dossier Web. Elle permet également d'autoriser ou de refuser le droit aux administrateurs de contenu d'ajouter et supprimer des utilisateurs. Si les administrateurs de contenu disposent des droits de gestion des utilisateurs, vous pouvez définir le nombre d'utilisateurs qu'ils peuvent ajouter à un site.

Exemples

tabcmd editsite wc_sales -n "West Coast Sales"

tabcmd editsite wc_sales --url "wsales"

tabcmd editsite wsales --content-mode

tabcmd editsite wsales --user-quota 50
Option (forme courte) Option (forme longue) Argument Description
-n --site-name Nouveau nom du site Changez le nom du site.
-r --url Nouvel espace de nom de l'URL du site Changez l'espace de nom de l'URL du site. Dans l'interface utilisateur, il est désigné par « ID de site ».
-n --[no-]content-mode   Cette option permet ou interdit aux administrateurs de contenu (qui sont membres du site) d'ajouter des utilisateurs au site.
  --user-quota   Définit le nombre maximum d'utilisateurs pouvant être membres du site.
 

export

Permet d'exporter une vue ou un classeur à partir de Tableau Server et de l'enregistrer dans un fichier. Lisez les points suivants avant d'utiliser cette commande :

  • Autorisations : Pour pouvoir exporter, vous devez bénéficier de l'autorisation d'Exportation d'une image. Par défaut, la valeur de cette autorisation est définie sur Autorisée ou Héritée pour tous les rôles, mais elle peut être définie par classeur ou par vue.

  • La vue, le classeur ou les données à exporter : Vous pouvez les définir avec la chaîne "workbook/view" telle qu'elle apparaît dans l'URL du classeur ou de la vue. Le seul nom du fichier ne suffit cependant pas. Par exemple, pour exporter l'exemple de vue Tableau intitulé Investment Growth du classeur Finance, vous devez utiliser la chaîne Finance/InvestmentGrowth. Utilisez l'option -t <site_id> si le serveur exécute plusieurs sites et que la vue ou le classeur se trouve sur un site autre que le site par défaut.

    Pour exporter un classeur, vous devez également inclure un nom de vue valide à la chaîne. Pour exporter le classeur Finance de l'exemple précédent, vous devez utiliser la chaîne Finance/InvestmentGrowth. Enfin, pour exporter un classeur, l'option Afficher les feuilles sous forme d'onglets doit être sélectionnée dans la boîte de dialogue Publier de Tableau Desktop au moment de sa publication.

  • Format du fichier sauvegardé: Les formats proposés dépendent du contenu exporté. Un classeur ne peut être exporté qu'en PDF, en utilisant l'argument --fullpdf . Une vue peut être exportée au format PDF (--pdf) et PNG (--png). Vous pouvez également exporter les données qu'elle contient dans un fichier CVS (--csv).

  • Nom et emplacement du fichier sauvegardé (facultatif) : Si vous ne définissez pas de nom pour le fichier, celui-ci sera nommé automatiquement à partir du nom de la vue ou du classeur. Si vous ne définissez pas d'emplacement, le fichier sera sauvegardé dans le répertoire de travail courant. Vous pouvez également spécifier un chemin absolu ou relatif au répertoire de travail courant.

Exemples

Vues

tabcmd export "Q1Sales/Sales_Report" --csv -f "Weekly-Report"

tabcmd export -t Sales "Sales/Sales_Analysis" --pdf -f "C:\Tableau_Workbooks\Weekly-Reports"

tabcmd export "Finance/InvestmentGrowth" --png

Classeurs

tabcmd export "Q1Sales/Sales_Report" --fullpdf

tabcmd export -t Sales "Sales/Sales_Analysis" --fullpdf --pagesize tabloid -f "C:\Tableau_Workbooks\Weekly-Reports"
Option (forme courte) Option (forme longue) Argument Description
-f --filename Nom du fichier enregistré Enregistre le fichier avec le nom donné.
  --csv   Disponible pour les vues uniquement. Exportez les données de la vue au format CSV.
  --pagelayout landscape, portrait Définit l'orientation de page du PDF exporté. Si cette option n'est pas définie, les paramètres Tableau Desktop seront utilisés.
  --pagesize unspecified, letter, legal, note folio, tabloid, ledger, statement, executive, a3, a4, a5, b4, b5, quatro Définit la taille de page du PDF exporté. La valeur par défaut est letter.
  --pdf   Disponible pour les vues uniquement. Permet d'exporter au format PDF.
  --png   Disponible pour les vues uniquement. Permet d'exporter en tant qu'image au format PNG.
  --fullpdf   Disponible pour les classeurs uniquement. Permet d'exporter au format PDF. L'option Afficher les feuilles sous forme d'onglets doit être activée au moment de la publication du classeur.

get url

L'utilisation d'une chaîne URL en tant que paramètre génère une requête HTTP « GET » de Tableau Server. Un fichier contenant le résultat de la requête est généré. Lisez les points suivants avant d'utiliser cette commande :

  • Autorisations : Pour récupérer un fichier, vous devez disposer de l'autorisation de Télécharger le fichier. Par défaut, la valeur de cette autorisation est définie sur Autorisée ou Héritée pour tous les rôles, mais elle peut être définie par classeur ou par vue.

  • Extension du fichier : La chaîne URL du fichier que vous souhaitez récupérer doit préciser l'extension du fichier ("/views/Finance/InvestmentGrowth.pdf", par exemple). L'extension (par exemple, .pdf) détermine la nature du fichier généré. Pour une vue, vous pouvez utiliser les formats PDF, PNG, CSV (données uniquement), ou XML (informations uniquement). Pour un classeur, vous pouvez utiliser les formats TWB ou TWBX. Pour choisir l'extension à utiliser, vous pouvez utiliser un navigateur Web pour accéder à l'élément de Tableau Server qui vous intéresse, et ajouter l'extension à la fin de l'URL.

  • Nom et emplacement du fichier sauvegardé (facultatif) : Le nom spécifié pour l'option --filename doit inclure une extension. Si vous ne définissez ni nom ni extension pour le fichier, ils seront créés automatiquement à partir de la chaîne URL. Si vous ne définissez pas d'emplacement, le fichier sera sauvegardé dans le répertoire de travail courant. Vous pouvez également spécifier un chemin absolu ou relatif au répertoire de travail courant.

Exemples

Vues

tabcmd get "/views/Sales_Analysis/Sales_Report.png" --filename "Weekly-Report.png"

tabcmd get "/views/Finance/InvestmentGrowth.pdf" -f "Q1Growth.pdf"

tabcmd get "/views/Finance/InvestmentGrowth.csv"

Classeurs

tabcmd get "/workbooks/Sales_Analysis.twb" -f "C:\Tableau_Workbooks\Weekly-Reports.twb"

tabcmd get "/workbooks/Sales.xml"

Autre

tabcmd get "/users.xml" --filename "UserList.xml"
Option (forme courte) Option (forme longue) Argument Description
-f --filename Nom du fichier enregistré Enregistre le fichier avec le nom donné.
 

listsites

Renvoie une liste des sites auxquels appartient l'utilisateur connecté.

Exemple

tabcmd listsites -u corman -pw P@ssword!
 

login

Permet de se connecter au serveur. Utilisez les options générales --server, --site, --username et --password pour créer une session. Si vous souhaitez vous connecter à l'aide des mêmes informations que celles utilisées pour créer une session, spécifiez simplement l'option --password. Le serveur et le nom d'utilisateur stockés dans le cookie seront utilisés.

Si le serveur utilise un port autre qu'un port 80 (par défaut), il faudra l'indiquer.

Vous n'avez besoin que de l'option --site si le serveur exécute plusieurs sites et que vous êtes connecté à un site autre que le site par défaut. Si vous n'en fournissez pas, un mot de passe vous sera demandé. Si l'option --no-prompt est spécifiée et qu'aucun mot de passe n'est fourni, la commande échoue.

Une fois connecté, la session reste ouverte jusqu'à son expiration sur le serveur ou jusqu'à l'émission de la commande logout.

Exemple

tabcmd login -s http://sales-server -t Sales -u administrator -p p@ssw0rd!

tabcmd login -s https://sales-server -t Sales -u administrator -p p@ssw0rd!

tabcmd login -s http://sales-server:8000 -t Sales -u administrator -p p@ssw0rd!
 

logout

Permet de se déconnecter du serveur.

Exemple

tabcmd logout
 

publish nomfichier.twb(x) ou nomfichier.tds(x)

Publie le classeur (.twb(x)) ou la source de données (.tds(x)) spécifié dans Tableau Server. Par défaut, toutes les feuilles du classeur sont publiées sans nom d'utilisateur ou mot de passe de base de données.

Exemple

tabcmd publish "analysis.twbx" -n "Sales_Analysis" --db-user "jsmith" --db-password "p@ssw0rd"
Option (forme courte) Option (forme longue) Argument Description
-n --name Nom du classeur ou de la source de données sur le serveur. S'il n'est pas indiqué, le classeur ou la source de données sera nommé après filename.
-o --overwrite   Remplace le classeur ou la source de données qui se trouve déjà sur le serveur.
-r --project Nom du projet Publie le classeur ou la source de données dans le projet spécifié. Si aucun projet n'est spécifié, le classeur est publié dans le projet « Par défaut ».
  --db-username   Cette option permet de publier un nom d'utilisateur de base de données avec le classeur ou la source de données.
  --db-password   Cette option permet de publier un mot de passe de base de données avec le classeur ou la source de données.
  --save-db-password   Enregistre le mot de passe de base de données fourni sur le serveur.
  --thumbnail-username   Si le classeur contient des filtres utilisateur, les miniatures seront générées en fonction de ce que peut voir l'utilisateur spécifié. Ne peut être spécifié lorsque l'option --thumbnail-group est définie.
  --thumbnail-group   Si le classeur contient des filtres utilisateur, les miniatures seront générées en fonction de ce que peut voir le groupe spécifié. Ne peut être spécifié lorsque l'option --thumbnail-username est définie.
  --tabbed   Lorsqu'un classeur avec des vues présentant des onglets est publié, chaque feuille devient un onglet dont les utilisateurs peuvent se servir pour naviguer dans le classeur. Notez que ce paramètre remplace la sécurité au niveau des feuilles.

Si le classeur contient des filtres utilisateur, l'une des options de miniatures doit être spécifiée.

 

refreshextracts nom-classeur ou nom-sourcedonnées

Effectue une actualisation complète ou incrémentielle d'extraits appartenant au classeur ou à la source de données spécifié. Cette commande utilise le nom du classeur ou de la source de données tel qu'il est apparaît sur le serveur, et non le nom du fichier lors de sa publication.

Exemples

tabcmd refreshextracts --datasource sales_ds

tabcmd refreshextracts --workbook "My Workbook"

tabcmd refreshextracts --url SalesAnalysis
Option (forme courte) Option (forme longue) Argument Description
  --incremental   Exécute l'opération d'actualisation incrémentielle.
  --synchronous   Effectue immédiatement une actualisation complète au premier plan.
  --workbook Nom du classeur Nom du classeur contenant les extraits à actualiser. Si le nom du classeur comporte des espaces, placez-le entre guillemets.
  --datasource Nom d'une source de données Nom de la source de données contenant les extraits à actualiser.
  --project Nom du projet Utilisez cette option avec --workbook ou --datasource afin d'identifier un classeur ou une source de données dans un projet autre que Par défaut. Si aucun nom n'est spécifié, le projet Par défaut est utilisé.
  --url Nom URL d'un classeur Nom du classeur tel qu'il apparaît dans l'URL. Le nom URL d'un classeur publié en tant que « Sales Analysis » est « SalesAnalysis ».
 

removeusers nom-groupe

Supprime les utilisateurs répertoriés dans l'argument --users du groupe portant le nom-groupe donné.

Exemple

tabcmd removeusers "Development" --users "users.csv"
Option (forme courte) Option (forme longue) Argument Description
  --users nomfichier.csv Supprime les utilisateurs du fichier donné du groupe spécifié. Le fichier doit se composer d'une simple liste avec un nom d'utilisateur par ligne.
  --[no-]complete   Requiert que toutes les lignes soient valides pour que les modifications prennent effet. Sinon, --complete est utilisé.
 

runschedule nom-programmation

Exécute la programmation spécifiée. Cette commande utilise le nom de la programmation tel qu'il est spécifié sur le serveur.

Exemple

tabcmd runschedule "5AM Sales Refresh"
 

set paramètre

Active le paramètre spécifié sur le serveur. Vous trouverez des détails sur chaque paramètre sur la page Maintenance du serveur. Pour désactiver un paramètre, placez un point d'exclamation devant son nom. Vous pouvez activer ou désactiver les paramètres suivants :

  • embedded_credentials

  • public_users_list

  • remember_passwords_forever

Exemple

tabcmd set embedded_credentials
 

syncgroup nom-groupe

Synchronise le groupe portant le nom-groupe donné avec Active Directory. Cette commande peut également permettre de créer un autre groupe sur le serveur, basé sur un groupe Active Directory existant.

Exemple

tabcmd syncgroup "Development"
Option (forme courte) Option (forme longue) Argument Description
  --license viewer interactor unlicensed Définit le niveau de licence pour tous les utilisateurs du groupe.
  --administrator system content none Affecte ou supprime les droits Administrateur de tous les utilisateurs du groupe. Il existe plusieurs types d'administrateur : les administrateurs système, les administrateurs de contenu ou les non administrateurs. La valeur par défaut est non administrateur (les nouveaux utilisateurs ne disposent d'aucun droit administrateur) et les droits des utilisateurs existants sont inchangés.
  --[no-]publisher   Affecte ou supprime le droit de publication pour tous les utilisateurs du groupe. Si rien n'est spécifié, ce droit n'est pas affecté aux nouveaux utilisateurs et les utilisateurs existants restent inchangés.
  --[no-]complete   Requiert que toutes les lignes soient valides pour que les modifications prennent effet. Sinon, --complete est utilisé.
  --silent-progress   Supprime les messages de progression.
 

version

Imprime les informations de version pour l'installation actuelle de l'utilitaire tabcmd.

Exemple

tabcmd version