Tableau Data Extract Command-Line Utility

Gäller för: Tableau Desktop

Det går att automatisera uppgifter för extraktuppdatering med hjälp av Tableau Data Extract Command-Line Utility. Detta är ett kommandoradsverktyg som levereras med Tableau Desktop, genom vilket du kan uppdatera publicerade extraktionsdatakällor eller lägga till data till dem från en fil.

Kraven för att använda Tableau Data Extract Command-Line inkluderar följande:

Det är tillgängligt med Tableau Desktop på Windows och kan endast köras på ett Windows-system.
Det är inte tillgängligt med provversionen av Tableau Desktop.
Det kan användas för extraktionsdatakällor som inte använder OAuth.
Det kan endast användas för att uppdatera datakällor med en enda anslutning. Det fungerar inte för datakällor med flera anslutningar.

Inaktuellt oktober 2022: Det här verktyget är inte tillgängligt i senare versioner på grund av kravet på flerfaktorsautentisering(Länken öppnas i ett nytt fönster) i Tableau Cloud. Använd istället Tableau Bridge för att uppdatera datakällor eller data i virtuella anslutningar som Tableau Cloud inte kan komma åt direkt. Mer information finns i Konfigurera ett uppdateringsschema för Bridge(Länken öppnas i ett nytt fönster).

För att initiera uppdateringsjobb med ett skript kan du använda tabcmd refreshextracts(Länken öppnas i ett nytt fönster) eller REST API:et Kör extraktuppdatering(Länken öppnas i ett nytt fönster).

Köra verktyget

Öppna kommandotolken som administratör och ändra till Tableau Desktop-klasskatalogen. Till exempel:
cd C:\Program Files\Tableau\Tableau 2022,4\bin
Använd något av följande kommandon och lägg till de parametrar som beskrivs i tabellerna nedan.
- tableau refreshextract
- tableau addfiletoextract

Obs! När du använder verktyget ska du alltid ange tableau på kommandoraden eller i skript, aldrig tableau.exe.

Obs! Vid felsökning kontrollerar du loggarna i filen tableaucom.txt i mappen\Min Tableau-lagringsplats\Loggar.

Obs! I en miljö med flera webbplatser anger du den webbplats som kommandot gäller för.

Syntax och parametrar för kommandot tableau refreshextract

Använd tableau refreshextract för att uppdatera ett extrakt på Tableau Server eller Tableau Cloud. Uppdatering av ett extrakt uppdaterar ett befintligt extrakt med eventuella ändringar som har gjorts i datakällan sedan den senaste uppdateringen.

Om du vill se hjälpavsnittet för detta kommando ska du skriva in följande kommando i kommandotolken i Windows:

tableau help refreshextract

Använda parametrar

Alla alternativ har en fullständig form som du använder med ett dubbelt bindestreck (t.ex. --server).
Vissa alternativ har en kort form som du använder med ett enkelt bindestreck (t.ex. -s).
Om värdet för ett alternativ innehåller mellanslag ska det inneslutas av citattecken.
Källan som uppdateras måste vara den ursprungliga datakällan och inte ett extrakt (.hyper)

kommandoalterntiv för tableau refreshextract

Kort form	Fullständig form	Beskrivning
	`--source-username <user name>`	Ett giltigt användarnamn för att ansluta till datakällan. Använd det här alternativet med `--source-password`, eller använd `--original-file` istället för alternativen för användarnamn och lösenord. Obs! Du måste ange användarnamn och lösenord när du uppdaterar ett publicerat extrakt, även om datakällan ursprungligen publicerades med inbäddade inloggningsuppgifter.
	`--source-password "<password>"`	Lösenordet för datakällans användare.
	`--original-file <path and file name>` eller `--original-file <path and folder name>`	Sökväg och filnamn för datakällan som ska uppdateras på servern. Till exempel: `--original-file c:\folder\file.csv` Om du vill uppdatera en datakälla med flera filer skickar du sökvägen till en mapp som innehåller datafilerna. Exempel: `--original-file c:\folder`. Om filen finns på en nätverksresurs använder du UNC-formatet för sökvägen: `\\server\path\filename.csv`
	`--force-full-refresh`	Om datakällan är konfigurerad för inkrementella uppdateringar använder du det här alternativet för att tvinga fram en fullständig extraktuppdatering. Om detta alternativ inte inkluderas utförs en inkrementell uppdatering. Inte alla datakällor stöder inkrementell uppdatering.
`-s <server http address>`	`--server <URL>`	URL-adressen för Tableau-servern där data publiceras. För Tableau Cloud anger du `https://online.tableau.com`.
`-t <site id>`	`--site <siteid>`	I en miljö med flera webbplatser anger detta vilken webbplats kommandot gäller för. För Tableau Cloud använder du det här argumentet om ditt användarnamn är kopplat till mer än en webbplats. Om du inte anger en webbplats för Tableau Server förutsätts att du vill använda standardwebbplatsen. Platsens ID är oberoende av platsnamn och det visas i URL:en när du tittar på platsen i en webbläsare. Om till exempel URL:en för sidan du ser efter att ha loggat in på Tableau Cloud är https://online.tableau.com/t/vernazza/views är webbplatsens ID vernazza.
	`--datasource <datasource>`	Namnet på datakällan, som det publicerades på Tableau Server eller Tableau Cloud.
	`--project <projectname>`	Projektet som datakällan tillhör. Om detta alternativ inte inkluderas antar programmet att du vill använda standardprojektet. Om projektet som du vill ange är ett underordnat projekt inom en projekthierarki, måste du använda denna parameter tillsammans med parametern `--parent-project-path`.
	`--parent-project-path path/to/project`	Om ett projekt har en datakälla som inte publiceras på översta nivån av en projekthierarki, ska du använda denna parameter tillsammans med parametern `--project` för att ange sökvägen till ett underordnat projekt. Använd snedstreck (`/`) för att avgränsa projektnivåer i hierarkin. Använd omvänt snedstreck (`\`), för att undvika snedstreck eller omvända snedstreck i projektnamn. Till exempel för ett projekt som heter Sandlåda, i projektet Social, under den översta nivån Marknadsföring: `--project Sandbox --parent-project-path Marketing/Social`
`-u <user name>`	`--username <username>`	Giltig användare av Tableau Server eller Tableau Cloud.
`-p "<password>"`	`--password "<password>"`	Lösenordet för den angivna användaren av Tableau Server eller Tableau Cloud.
	`--proxy-username <username>`	Användarnamnet för en proxyserver.
	`--proxy-password "<password>"`	Lösenordet för en proxyserver.
`-c "<path and file name>"`	`--config-file "<path and file name>"`	Information om sökväg och filnamn för en fil som innehåller konfigurationsalternativ för kommandot. Inneslut alltid sökvägen med dubbla citattecken. Mer information finns i Använda en konfigurationsfil nedan.

Exempel på kommandot tableau refreshextract

Följande kommando uppdaterar ett extrakt med namnet CurrentYrOverYrStats som har publicerats lokalt i Tableau Server. Det här kommandot anger följande:

Namnet på din Tableau-server.
Användarnamn och lösenord för servern.
Projektnamn.
Namnet på datakällan som ska uppdateras, samt datakällans användarnamn och lösenord.

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"

Följande kommando uppdaterar ett extrakt med namnet CurrentYrOverYrStats som har publicerats i Tableau Cloud. Det här kommandot anger följande:

Tableau Cloud-användare och lösenord.
Tableau Cloud-webbplats och projektnamn.
Datakällan, som i detta fall finns på en molnbaserad datatjänstleverantör (till exempel Salesforce.com), samt användarnamn och lösenord för inloggning på den värdbaserade datakällan.

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"

Om du vill uppdatera ett extrakt av en filbaserad datakälla anger du sökvägen till den ursprungliga filen som du skapade extraktet från. Om filen finns på en nätverksresurs använder du UNC-formatet istället för en mappad enhet.

Syntax för tableau addfiletoextract

Använd tableau addfiletoextract för att lägga till filinnehåll i ett extrakt som har publicerats på Tableau Server eller Tableau Cloud. Det här kommandot kombinerar de två filerna.

Om du bara vill uppdatera ett befintligt extrakt med de senaste ändringarna använder du kommandot refreshextract istället. När addfiletoextract används för att uppdatera ett befintligt extrakt dupliceras data istället.

Om du vill se hjälpavsnittet för detta kommando ska du skriva in följande kommando i kommandotolken i Windows:

tableau help addfiletoextract

Alla alternativ har en fullständig form som du använder med ett dubbelt bindestreck (t.ex. --server). Vissa alternativ har en kort form som du använder med ett enkelt bindestreck (t.ex. -s). Om värdet för ett alternativ innehåller mellanslag ska det inneslutas av citattecken.

Kommandoalternativ för tableau addfiletoextract

Kort form	Fullständig form	Beskrivning
	`--file <path and file name>`	Information om sökväg och filnamn för datafilen som innehåller data som ska läggas till. Filen kan vara från Excel, Access, ett Tableau-dataextrakt eller en avgränsad textfil. Den får inte vara lösenordsskyddad. Använd UNC-format om filen finns på en nätverksresurs. Till exempel: `\\server\path\filename.csv`
`-s <server http address>`	`--server <URL>`	URL-adressen för Tableau-servern där data publiceras. För Tableau Cloud anger du `https://online.tableau.com`.
`-t <site id>`	`--site <site id>`	I en miljö med flera webbplatser anger detta vilken webbplats kommandot gäller för. För Tableau Cloud måste du inkludera detta argument om ditt användarnamn är kopplat till mer än en webbplats. Om du inte anger en webbplats för Tableau Server förutsätts att du vill använda standardwebbplatsen.
	`--datasource <datasource>`	Namnet på datakällan, som det publicerades på Tableau Server eller Tableau Cloud.
	`--project <projectname>`	Projektet som datakällan tillhör. Om detta alternativ inte inkluderas antar programmet att du vill använda standardprojektet. Om projektet som du vill ange är ett underordnat projekt inom en projekthierarki, måste du använda denna parameter tillsammans med parametern `--parent-project-path`.
	`--parent-project-path path/to/project`	Om ett projekt har en datakälla som inte publiceras på översta nivån av en projekthierarki, ska du använda denna parameter tillsammans med parametern `--project` för att ange sökvägen till ett underordnat projekt. Använd snedstreck (`/`) för att avgränsa projektnivåer i hierarkin. Använd omvänt snedstreck (`\`), för att undvika snedstreck eller omvända snedstreck i projektnamn. Till exempel för ett projekt som heter Sandlåda, i projektet Social, under den översta nivån Marknadsföring: `--project Sandbox --parent-project-path Marketing/Social`
`-u <username>`	`--username <username>`	Giltig användare av Tableau Server eller Tableau Cloud.
`-p "<password>"`	`--password "<password>"`	Lösenordet för den angivna användaren av Tableau Server eller Tableau Cloud.
	`--proxy-username <username>`	Användarnamnet för en proxyserver.
	`--proxy-password "<password>"`	Lösenordet för en proxyserver.
`-c "<path and filename>"`	`--config-file "<path and filename>"`	Information om sökväg och filnamn för en fil som innehåller konfigurationsalternativ för kommandot. Inneslut alltid sökvägen med dubbla citattecken. Mer information finns i Använda en konfigurationsfil nedan.

Exempel på kommandot tableau addfiletoextract

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"

Använda en konfigurationsfil

Du kan använda en redigerare för oformaterad text, till exempel Anteckningar eller Text Edit, för att skapa en konfigurationsfil som du kan använda med tableau refreshextract eller tableau addfiletoextract. En konfigurationsfil kan vara praktisk om det är troligt att du kommer att uppdatera samma datakälla regelbundet. Istället för att behöva skriva samma alternativ varje gång du kör ett kommando anger du konfigurationsfilen. En konfigurationsfil har också fördelen att den inte visar användarnamn och lösenord på kommandoraden.

Skapa konfigurationsfilen

Vi tänker oss att har skapat en fil som heter config.txt och sparat den i mappen Dokument. Och i den filen har du inkluderat parameterinformationen som visas nedan.

För ett extrakt publicerat på Tableau Server:

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

För ett extrakt från en värdbaserade datakälla som har publicerats på Tableau Cloud, där servern är 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

Referera till konfigurationsfilen från kommandoraden

När du har skapat konfigurationsfilen kör du kommandot tableau addfiletoextract eller tableau refreshextract. pekar på konfigurationsfilen som det enda alternativet på kommandoraden och omsluter konfigurationsfilen sökväg med dubbla citattecken. Syntax är enligt följande:

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

Om du till exempel vill uppdatera det extrakt som anges i exemplet i avsnittet Skapa konfigurationsfilen, kör du följande kommando (se till att du arbetar i klasskatalogen för den version av Tableau Desktop du kör):

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

Syntaxskillnader för konfigurationsfiler

Syntaxen för att ange alternativ i en konfigurationsfil skiljer sig från den syntax som används på kommandoraden på följande sätt:

Alternativnamn börjar inte med tankstreck eller bindestreck.
Du använder ett likhetstecken (utan mellanslag) för att skilja alternativnamn från alternativvärden.
Citattecken behövs inte (och är inte tillåtna) runt värden, inte ens när de innehåller mellanslag (som för alternativet project i exemplet ovan).

Använda schemaläggaren i Windows för att uppdatera extrakt

Du kan använda schemaläggaren i Windows tillsammans med Tableau Data Extract Command-Line Utility för att automatisera regelbundna uppdateringar av Tableau Desktop-datakällor från din företagsbrandvägg. Du kan konfigurera en uppgift så att den inträffar en gång per dag, vecka eller månad, eller efter en specifik systemhändelse. Till exempel kan uppgiften köras när datorn startas upp.

Läs mer på sidan Task Scheduler How To...(Länken öppnas i ett nytt fönster) i Microsoft TechNet-biblioteket.

Tillbaka till toppen

Tack för din feedback!

Din feedback har skickats in. Tack!

Hjälp om Tableau Desktop och webbredigering