Befehlszeilenprogramm für die Tableau-Datenextraktion
Sie können die Extraktion von aktualisierten Aufgaben mit dem Tableau Data Extract-Dienstprogramm für Befehlszeilen automatisieren. Mit Tableau Desktop wird dieses Befehlszeilenprogramm geliefert, über das Sie veröffentlichte Extraktdatenquellen aktualisieren oder ihnen Daten aus einer Datei hinzufügen können.
Für die Verwendung des Tableau Data Extract-Dienstprogramms gilt Folgendes:
Es ist in Tableau Desktop unter Windows verfügbar und kann nur auf einem Windows-System ausgeführt werden.
Sie ist in der Testversion von Tableau Desktop nicht verfügbar.
Sie können es für Extraktdatenquellen ohne OAuth verwenden.
Sie können es nur zur Aktualisierung von Einzelverbindungs-Datenquellen verwenden. Es funktioniert nicht für Mehrfachverbindungs-Datenquellen.
Veraltet ab Oktober 2022: Dieses Dienstprogramm ist in späteren Versionen aufgrund der Notwendigkeit von Multi-Faktor-Authentifizierung(Link wird in neuem Fenster geöffnet) in Tableau Cloud nicht verfügbar. Zum Aktualisieren von Datenquellen oder virtuellen Verbindungsdaten, auf die Tableau Cloud nicht direkt zugreifen kann, verwenden Sie stattdessen Tableau Bridge. Weitere Informationen finden Sie unter Einrichten eines Bridge-Aktualisierungszeitplans(Link wird in neuem Fenster geöffnet).
Zum Initialisieren eines Aktualisierungsauftrags mithilfe eines Skripts verwenden Sie tabcmd (refreshextracts(Link wird in neuem Fenster geöffnet)) oder die REST API (Run Extract Refresh Task(Link wird in neuem Fenster geöffnet)).
Dienstprogramm ausführen
Öffnen Sie als Administrator ein Eingabeaufforderungsfenster, und wechseln Sie zum bin-Verzeichnis von Tableau Desktop. Beispiel:
cd C:\Program Files\Tableau\Tableau 2022.4\binVerwenden Sie einen der folgenden Befehle und fügen Sie die in den folgenden Tabellen beschriebenen Parameter hinzu.
tableau refreshextracttableau addfiletoextract
Hinweis: Geben Sie bei der Ausführung des Dienstprogramms in der Befehlszeile oder in Skripts immer tableau an, nie tableau.exe.
Hinweis: Zur Fehlerbehebung überprüfen Sie die Protokolle in der Datei "tableaucom.txt" im Ordner "\Eigenes Tableau-Repository\Logs".
Hinweis: Geben Sie in Umgebungen mit mehreren Websites die Website an, auf die sich der Befehl bezieht.
Syntax und Parameter für den Befehle tableau refreshextract
Verwenden Sie tableau refreshextract, um einen Extrakt in Tableau Server oder Tableau Cloud zu aktualisieren. Beim Aktualisieren eines Extrakts werden alle Änderungen, die seit der letzten Aktualisierung an der Datenquelle durchgeführt wurden, für den vorhandenen Extrakt übernommen.
Sie können hilfreiche Informationen für diesen Befehl anzeigen, indem Sie in der Windows-Eingabeaufforderung den folgenden Befehl eingeben:
tableau help refreshextract
Verwenden von Parametern
Alle Optionen weisen eine vollständige Form auf, die mit doppelten Bindestrichen verwendet wird (z. B.
--server).Einige Optionen weisen auch eine Kurzform auf, die mit einem einfachen Bindestrich verwendet wird (Beispiel:
-s).Wenn der Wert für eine Option Leerzeichen enthält, schließen Sie ihn in Anführungsstriche ein.
Bei der Quelle, die aktualisiert werden soll, muss es sich um die originale Datenquelle handeln, nicht um einen Extrakt (
.hyper).
tableau refreshextract – Befehlsoptionen
| Kurzform | Vollständige Form | Beschreibung |
--source-username <user name> | Ein gültiger Benutzername für die Verbindung mit der Datenquelle. Verwenden Sie diese Option zusammen mit
Hinweis: Beim Aktualisieren eines veröffentlichten Extrakts müssen Sie auch dann den Benutzernamen und das entsprechende Kennwort angeben, wenn die Datenquelle ursprünglich mit eingebetteten Anmeldeinformationen veröffentlicht wurde. | |
--source-password "<password>" | Das Kennwort für den Benutzer der Datenquelle. | |
oder
| Pfad- und Dateiname für die auf dem Server zu aktualisierende Datenquelle. Beispiel: Zur Aktualisierung einer Datenquelle mit mehreren Dateien übergeben Sie den Pfad zu einem Ordner, der die Datendateien enthält. Beispiel: Geben Sie den Pfad im UNC-Format an, wenn die Datei über Netzwerkfreigabe bereitgestellt wird. | |
--force-full-refresh | Wenn normalerweise schrittweise Aktualisierungen für die Datenquelle vorgesehen sind, können Sie mit dieser Option eine vollständige Aktualisierung des Extrakts erzwingen. Wird diese Option nicht verwendet, wird eine inkrementelle Aktualisierung durchgeführt. Nicht alle Datenquellen unterstützen inkrementelle Aktualisierungen. | |
-s <server http address> | --server <URL> | Die URL für den Tableau Server, auf dem die Daten veröffentlicht werden. Geben Sie für Tableau Cloud die URL |
-t <site id> | --site <siteid> | Geben Sie in Umgebungen mit mehreren Websites die Website an, auf die sich der Befehl bezieht. Verwenden Sie dieses Argument in Tableau Cloud, wenn Ihr Benutzername mehreren Sites zugeordnet ist. Wenn Sie in Tableau Server keine Site angeben, wird die Site "Default" (Standard) verwendet. Die Site-ID ist unabhängig vom Site-Namen und ist in der URL enthalten, wenn Sie die Site in einem Browser aufrufen. Wenn zum Beispiel die URL der Seite, die nach der Anmeldung bei Tableau Cloud angezeigt wird, die folgende ist: https://online.tableau.com/t/vernazza/views lautet die Site-ID vernazza. |
--datasource <datasource> | Der Name der Datenquelle, wie er in Tableau Server oder Tableau Cloud veröffentlicht wurde. | |
--project <projectname> | Das Projekt, zu dem die Datenquelle gehört. Wird diese Option nicht angegeben, wird angenommen, dass es sich um das Standardprojekt handelt. Wenn das anzugebende Projekt ein untergeordnetes Projekt ist, das innerhalb einer Projekthierarchie verschachtelt ist, müssen Sie diesen Parameter zusammen mit dem Parameter | |
--parent-project-path path/to/project | Wenn sich ein Projekt, in dem die Datenquelle veröffentlicht wird, nicht auf der obersten Ebene einer Projekthierarchie befindet, sollten Sie diesen Parameter zusammen mit dem Parameter Verwenden Sie den Schrägstrich ( Geben Sie beispielsweise für ein Projekt mit dem Namen "Sandbox" im Projekt "Social" unter der obersten Ebene "Marketing" Folgendes ein:
| |
-u <user name> | --username <username> | Gültiger Tableau Server- oder Tableau Cloud-Benutzer. |
-p "<password>" | --password "<password>" | Das Kennwort für den angegebenen Tableau Server- oder Tableau Cloud-Benutzer. |
--proxy-username <username> | Der Benutzername für einen Proxyserver. | |
--proxy-password "<password>" | Das Kennwort für einen Proxyserver. | |
-c "<path and file name>" | --config-file "<path and file name>" | Pfad und Dateiname einer Datei mit Konfigurationsoptionen für den Befehl. Setzen Sie den Pfad immer in doppelte Anführungszeichen. Weitere Informationen finden Sie unten im Abschnitt Verwenden einer Konfigurationsdatei. |
Beispiel für den Befehl "tableau refreshextract"
Mit dem folgenden Befehl wird der auf dem Tableau Server am Standort veröffentlichte Extrakt "CurrentYrOverYrStats" aktualisiert. Dieser Befehl enthält folgende Informationen:
- Den Namen von Tableau Server
- Den Benutzernamen und das Kennwort für den Server
- Den Namen des Projekts
- Den Namen der zu aktualisierenden Datenquelle sowie den Benutzernamen und das Kennwort für die Datenquelle.
C:\Program Files\Tableau\Tableau 2022.4\bin>tableau refreshextract --server https://our_server_name --username OurServerSignIn --password "OurServerPwd" --project "New Animations" --datasource "CurrentYrOverYrStats" --source-username OurDatabaseSignIn --source-password "OurDatabasePassword"
Mit dem folgenden Befehl wird ein über Tableau Cloud veröffentlichter Extrakt namens CurrentYrOverYrStats aktualisiert. Dieser Befehl enthält folgende Informationen:
- Benutzername und Kennwort für Tableau Cloud
- Site und Projektnamen für Tableau Cloud
- Die Datenquelle, die in diesem Fall von einem cloudbasierten Datenquellenanbieter gehostet wird (z. B. Salesforce.com), und den Benutzernamen und das Kennwort für die Anmeldung bei der gehosteten Datenquelle
C:\Program Files\Tableau\Tableau 2022.4\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"
Zum Aktualisieren des Extrakts einer dateibasierten Datenquelle geben Sie den Pfad zur ursprünglichen Datei an, aus der Sie den Extrakt erstellt haben. Geben Sie den Pfad im UNC-Format statt als verbundenes Laufwerk an, wenn die Datei über Netzwerkfreigabe bereitgestellt wird.
C:\Program Files\Tableau\Tableau 2022.4\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"
Syntax für "tableau addfiletoextract"
Verwenden Sie tableau addfiletoextract, um den Inhalt einer Datei an einen in Tableau Server oder Tableau Cloud veröffentlichten Extrakt anzufügen. Mit diesem Befehl werden zwei Dateien miteinander kombiniert.
Wenn Sie lediglich einen vorhandenen Extrakt mit den neuesten Änderungen aktualisieren möchten, verwenden Sie stattdessen den Befehl refreshextract. Die Verwendung von addfiletoextract zum Aktualisieren eines vorhandenen Extrakts führt dazu, dass die Daten dupliziert werden.
Sie können hilfreiche Informationen für diesen Befehl anzeigen, indem Sie in der Windows-Eingabeaufforderung den folgenden Befehl eingeben:
tableau help addfiletoextract
Alle Optionen weisen eine vollständige Form auf, die mit doppelten Bindestrichen verwendet wird (z. B. --server). Einige Optionen weisen auch eine Kurzform auf, die mit einem einfachen Bindestrich verwendet wird (Beispiel: -s). Wenn der Wert für eine Option Leerzeichen enthält, schließen Sie ihn in Anführungsstriche ein.
tableau addfiletoextract – Befehlsoptionen
| Kurzform | Vollständige Form | Beschreibung |
--file <path and file name> | Pfad und Dateiname der Datendatei mit anzufügenden Daten. Die Datei kann aus Excel, Access, einer Tableau-Datenextraktion oder aus einer Textdatei mit Trennzeichen stammen. Sie darf nicht kennwortgeschützt sein. Verwenden Sie das UNC-Format, wenn die Datei über Netzwerkfreigabe bereitgestellt wird. Beispiel: | |
-s <server http address> | --server <URL> | Die URL für den Tableau Server, auf dem die Daten veröffentlicht werden. Geben Sie für Tableau Cloud die URL |
-t <site id> | --site <site id> | Geben Sie in Umgebungen mit mehreren Websites die Website an, auf die sich der Befehl bezieht. In Tableau Cloud müssen Sie dieses Argument verwenden, wenn Ihr Benutzername mehreren Sites zugeordnet ist. Wenn Sie in Tableau Server keine Site angeben, wird die Site "Default" (Standard) verwendet. |
--datasource <datasource> | Der Name der Datenquelle, wie er in Tableau Server oder Tableau Cloud veröffentlicht wurde. | |
--project <projectname> | Das Projekt, zu dem die Datenquelle gehört. Wird diese Option nicht angegeben, wird angenommen, dass es sich um das Standardprojekt handelt. Wenn das anzugebende Projekt ein untergeordnetes Projekt ist, das innerhalb einer Projekthierarchie verschachtelt ist, müssen Sie diesen Parameter zusammen mit dem Parameter | |
--parent-project-path path/to/project | Wenn sich ein Projekt, in dem die Datenquelle veröffentlicht wird, nicht auf der obersten Ebene einer Projekthierarchie befindet, sollten Sie diesen Parameter zusammen mit dem Parameter Verwenden Sie den Schrägstrich ( Geben Sie beispielsweise für ein Projekt mit dem Namen "Sandbox" im Projekt "Social" unter der obersten Ebene "Marketing" Folgendes ein:
| |
-u <username> | --username <username> | Gültiger Tableau Server- oder Tableau Cloud-Benutzer. |
-p "<password>" | --password "<password>" | Das Kennwort für den angegebenen Tableau Server- oder Tableau Cloud-Benutzer. |
--proxy-username <username> | Der Benutzername für einen Proxyserver. | |
--proxy-password "<password>" | Das Kennwort für einen Proxyserver. | |
-c "<path and filename>" | --config-file "<path and filename>" | Pfad und Dateiname einer Datei mit Konfigurationsoptionen für den Befehl. Setzen Sie den Pfad immer in doppelte Anführungszeichen. Weitere Informationen finden Sie unten im Abschnitt Verwenden einer Konfigurationsdatei. |
Beispiel für den Befehl "tableauaddfiletoextract"
C:\Program Files\Tableau\Tableau 2022.4\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 2022.4\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"
Verwenden einer Konfigurationsdatei
Sie können einen Text-Editor wie z. B. Notepad oder Text Edit verwenden, um eine Konfigurationsdatei zu erstellen, die für tableau refreshextract oder tableau addfiletoextract geeignet ist. Eine Konfigurationsdatei kann hilfreich sein, wenn Sie dieselbe Datenquelle voraussichtlich regelmäßig aktualisieren müssen. Anstatt jedes Mal dieselben Optionen einzugeben, wenn Sie einen Befehl ausführen möchten, können Sie einfach die Konfigurationsdatei verwenden. Eine Konfigurationsdatei hat außerdem den Vorteil, dass Benutzernamen und Kennwörter nicht in der Befehlszeile angegeben werden.
Erstellen der Konfigurationsdatei
Nehmen wir an, Sie haben eine Datei mit der Bezeichnung config.txt erstellt und im Dokumentenordner gespeichert. Diese Datei enthält die unten gezeigten Parameterinformationen.
Für einen Extrakt, der auf einem Tableau Server veröffentlicht wird:
server=https://our_server_name
username=OurServerSignIn
password=OurServerPwd
project=New Animations
datasource=CurrentYrOverYrStats
Für einen Extrakt von einer gehosteten Datenquelle, der in Tableau Cloud veröffentlicht wird, wobei server https://online.tableau.com ist:
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
Verweisen Sie in der Befehlszeile auf die Konfigurationsdatei
Führen Sie nach dem Erstellen der Konfigurationsdatei den Befehl tableau refreshextract oder tableau addfiletoextract aus, indem Sie in der Befehlszeile als einzige Option den Verweis auf die Konfigurationsdatei angeben. Die Syntax ist wie folgt:
tableau refreshextract --config-file "<path>"
Um den Extrakt für das Beispiel zu aktualisieren, das wir unter Erstellen der Konfigurationsdatei beschrieben haben, würden Sie den folgenden Befehl ausführen (achten Sie darauf, dass Sie sich dabei im bin-Verzeichnis Ihrer Version von Tableau Desktop befinden):
C:\Program Files\Tableau\Tableau 2022.4\bin>tableau refreshextract --config-file "C:\Users\user1\Documents\config.txt"
Syntaxunterschiede für Konfigurationsdateien
Die Syntax zum Angeben von Optionen in einer Konfigurationsdatei weicht in folgender Hinsicht von der ansonsten für die Befehlszeile verwendeten Syntax ab:
- Die Bezeichnungen für die Optionen beginnen nicht mit Gedanken- oder Bindestrichen.
- Sie verwenden ein Gleichheitszeichen (ohne Leerzeichen), um Optionswerte für die Optionsbezeichnungen anzugeben.
- Werte müssen (und dürfen auch nicht) in Anführungszeichen eingeschlossen werden, auch dann nicht, wenn die Werte Leerzeichen enthalten (wie beispielsweise für die Option
projectim zuvor beschriebenen Beispiel).
Verwenden der Windows-Aufgabenplanung zum Aktualisieren von Extrakten
Sie können die Windows-Aufgabenplanung zusammen mit dem Befehlszeilenprogramm für die Tableau-Datenextraktion verwenden, um automatisch regelmäßige Aktualisierungen für die Tableau Desktop-Datenquellen innerhalb der Unternehmens-Firewall vorzunehmen. Sie können eine Aufgabe so konfigurieren, dass sie einmal pro Tag, einmal pro Woche, einmal pro Monat oder nach einem bestimmten Systemereignis ausgeführt wird. Sie können die Aufgabe beispielsweise beim Start des Computers ausführen lassen.
Weitere Informationen hierzu finden Sie auf der Seite Aufgabenplanung: So wird's gemacht(Link wird in neuem Fenster geöffnet) in der Microsoft TechNet-Bibliothek.