Tableau Prep-hjälp

Stöds endast i Tableau Prep Builder.

Du kan köra ditt flöde från kommandoraden för att uppdatera flödet i stället för att köra flödet från Tableau Prep Builder. Med denna metod kan du köra ett flöde i taget. Detta alternativ är tillgängligt både på Windows- och Mac-datorer med Tableau Prep Builder installerat.

Obs! Om du använder inloggningsbaserad licenshantering (LBLM) ska du se till att du öppnar Tableau Prep regelbundet. Annars kan leasingavtalet löpa ut, vilket gör att flöden som körs via kommandoraden inte fungerar. Du kan även kontakta din administratör och ändra din leasingperiod till maximal längd. Mer information finns i Inloggningsbaserad licenshantering(Länken öppnas i ett nytt fönster).

Anslutningsbegränsningar:

• JDBC- eller ODBC-anslutningar: Flöden som innehåller dessa anslutningar kan från och med version 2019.2.3 köras från kommandoraden.
• Molnanslutningar: Flöden som innehåller molnanslutningar, till exempel Google BigQuery, kan inte köras från kommandoraden. Kör istället flödet manuellt eller kör flödet enligt ett schema i Tableau Server eller Tableau Cloud med Tableau Prep Conductor. Mer information finns i Håll flödesdata uppdaterade.
• Enkel inloggningsautentisering: Flöden som körs från kommandoraden stöds inte om du använder enkel inloggningsautentisering. Du kan köra flöden från Tableau Prep Builder istället.
• Flerfaktorsautentisering: Tableau Prep Command Line Interface (CLI) stöder inte Tableau med flerfaktorsautentisering (MFA). Se den här artikeln(Länken öppnas i ett nytt fönster) i Tableaus kunskapsbas för mer information.

För Windows-datorer kan du även schemalägga den här processen med Windows schemaläggaren. Mer information finns i Schemaläggaren(Länken öppnas i ett nytt fönster) i Microsoft Online-hjälpen.

När du kör flöden från kommandoraden uppdaterar Tableau Prep Builder alla utmatningar för flödet med hjälp av inställningarna för de utmatningssteg som anges i Tableau Prep Builder. Information om hur du anger dina utmatningsplatser finns i Skapa dataextraktfiler och publicerade datakällor(Länken öppnas i ett nytt fönster). Mer information om hur du ställer in dina skrivalternativ (version 2020.2.1 och senare) finns i Anpassa skrivalternativ.

Innan flödet körs

För att köra flödet från kommandoraden behöver du administratörsbehörighet för den dator du kör flödet på och du behöver följande information:

• Sökvägen där Tableau Prep Builder är installerad.

• Om du ansluter till databaser och publicerar utmatningsfiler till en server eller en databas (version 2020.3.1 och senare) skapar du en .json-fil som innehåller alla nödvändiga inloggningsuppgifter.

• Sökvägen där filen Tableau Flow (.tfl) finns.

Krav på .json-inloggningsfilen

Obs! Det krävs inga .json-inloggningsfiler om flödet ansluter till och matar ut till lokala filer, filer som lagras i en nätverksresurs eller inmatningsfiler som använder Windows-autentisering (SSPI). Mer information om Windows-inloggning finns i SSPI-modell(Länken öppnas i ett nytt fönster) i Microsoft Online-hjälpen.

Tableau Prep Builder använder information från flödesfilen och från .json-filen för att köra flödet vid fjärranslutningar. Till exempel databasnamnet för dina fjärranslutningar och projektnamnet för dina utmatningsfiler kommer från flödet och servernamnet och inloggningsuppgifterna kommer från .json-filen.

• Om du planerar att återanvända filen placerar du den i en mapp där den inte kommer att skrivas över av Tableau Prep Builder-installationsprocessen.
• Om du kör ett flöde som innehåller något av följande måste du inkludera en .json-fil som innehåller de inloggningsuppgifter som krävs för att ansluta.
  • Ansluter till databasfiler eller publicerade datakällor.
  • Utmatningen publiceras på en server eller i en databas (version 2020.3.1 och senare).
  • Flödet innehåller skriptsteg för Rserve eller TabPy. .json-filen måste innehålla de inloggningsuppgifter som krävs för att ansluta till dessa tjänster. Om du vill ha mer information, se matriskraven för din version nedan.
• De inloggningsuppgifter som anges i ditt flöde och de inloggningsuppgifter som ingår i din .json-fil måste matcha, annars kommer flödet inte att köras.
• När du kör processen används och uppdateras värddatornamnet, porten och användarnamnet för att hitta den matchande anslutningen i Tableau-flödesfilen (.tfl) innan du kör processen. Port-ID och webbplats-ID är valfria om denna information inte krävs av dina anslutningar.

• Om du ansluter till en publicerad datakälla inkluderar du värdnamn, contentUrl och port (80 för http och 443 för https) i ingångsanslutningarna. Värdnamnet krävs för att hitta den matchande anslutningen i Tableau-flödesfilen (.tfl) och contentUrl och port används för att upprätta anslutningen till servern.

• Om du ansluter till Tableau Cloud inkluderar du porten (80 eller 443) i ingångsanslutningarna för den podd som du ansluter till. Se även till att du inkluderar motsvarande poddprefix med online.tableau.com i serveranslutningens URI. Mer information om Tableau Cloud finns i Tableau Bridge-anslutningar till Tableau Cloud(Länken öppnas i ett nytt fönster) i Tableau Cloud-hjälpen.
• (version 2021.4.1 och senare) Om du inkluderar parametrar i ditt flöde kan du skapa och inkludera en .json-fil med parameteråsidosättning i kommandoraden för att ändra parametervärden från de aktuella standardvärdena. Mer information finns i Kör flöden som innehåller parametervärden.

Beroende på din Tableau Prep Builder-version kan dina inloggningsuppgifter formateras på olika sätt. Klicka på fliken nedan för att se inloggningsformatet för din Tableau Prep Builder version.

{
    "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"
	}
   } 
  ]
}

Tips när du skapar din inloggningsfil

För att undvika fel när flödet körs ska du se till att din inloggningsfil följer dessa riktlinjer:

• Om du använder Tableau Prep Builder version 2018.2.2 till och med 2018.3.1 ska du alltid inkludera matriserna ”inputConnections” och ”outputConnections” även om flödet inte har fjärranslutningar för inmatning eller utmatning. Lämna matriserna tomma.

  Om du använder Tableau Prep Builder version 2018.3.2 och senare behöver du inte inkludera den tomma matrisen.

  • Har du ingen fjärranslutning för inmatning? Inkludera den här syntaxen längst upp i .json-filen

    {
     "inputConnections":[
      ],

  • Har du ingen fjärranslutning för utmatning? Inkludera den här syntaxen längst ned i .json-filen

  "outputConnections":[
    ]
  }

• Inget port-ID för inmatningsanslutningen eller porten anges som en del av servernamnet.

  Om det inte finns något port-ID för din anslutning, inkludera inte "port":xxxx, referensen i .json-filen, inte ens "port": "". Om port-ID ingår i servernamnet, inkludera port-ID i värdnamnet. Exempel: "hostname": "mssql.example.lan,1234"

• När du refererar till "serverUrl": ska du inte inkludera ”/” i slutet av adressen. Använd till exempel "serverUrl": "http://server" och inte "serverUrl": "http://server/".

• Om du har flera inmatnings- eller utmatningsanslutningar inkluderar du inloggningsuppgifterna för var och en av dem i filen.

• Om du ansluter till publicerade datakällor ska du se till att du inkluderar värdnamnet och contentUrl i inmatningsanslutningarna.

Kör flödet

Viktigt: Exemplen nedan inkluderar namnändringen för ”Tableau Prep” version 2019.1.2 till ”Tableau Prep Builder”. Om du använder en tidigare version av produkten bör du använda "Tableau Prep” istället.

1. Öppna kommandotolken eller terminalkommandotolken (MacOS) som administratör.

2. Kör ett av följande kommandon med hjälp av syntaxen som visas nedan.

   • Flödet ansluter till lokala filer eller till filer som lagras i en nätverksresurs och publicerar till lokala filer, filer lagrade på en nätverksresurs eller använder Windows-autentisering:

     Obs! Om du ansluter till eller matar ut filer som är lagrade i en nätverksresurs använder du UNC-formatet för sökvägen: namnet \\server\path\file. Det får inte vara lösenordsskyddat.

     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

   • Flödet ansluter till databaser eller publicerar till en server

     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

   • Flödesfilen eller inloggningsfilen lagras på en nätverksresurs (använd UNC-formatet för sökvägen: \\server\path\file-namn):

     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: Mappa nätverksresursen till /Volumes i Sökaren så att den är beständig och använd sedan /Volumes/.../[your file] för att ange sökvägen:

     /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

För vanliga fel och lösningar se Vanliga fel när kommandoraden används för att köra flöden.

Kör flödet med inkrementell uppdatering aktiverad

Stöds i Tableau Prep Builder version 2020.2.1 och senare och webben från och med version 2020.4. Inkrementell uppdatering stöds för närvarande inte vid skrivning av flödesutdata till Microsoft Excel.

Om du inte har Tableau Prep Conductor aktiverat på din server för att schemalägga dina flödeskörningar kan du köra flödet med inkrementell uppdatering från kommandoraden. Inkludera bara parametern --incrementalRefresh i din kommandorad som visas i exemplet nedan.

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

Om inmatningsstegen i ditt flöde har inkrementell uppdatering aktiverad och de inkrementella uppdateringsparametrarna är rätt konfigurerade gör Tableau Prep Builder följande:

• Alla inmatningar i flödet som har inkrementell uppdatering aktiverad kommer att köra alla motsvarande utmatningar med inkrementell uppdatering.
• Om ingen inmatning i flödet har inkrementell uppdatering aktiverad kommer alla utmatningar att köras med fullständig uppdatering. Ett meddelande visar information om uppdateringsmetoden.
• Om vissa inmatningar i flödet har inkrementell uppdatering aktiverad kommer motsvarande utmatningar att köras med inkrementell uppdatering. De andra utmatningarna kommer att köras med fullständig uppdatering och ett meddelande visar information om uppdateringsmetoden.

För information om hur du konfigurerar flöden för att använda inkrementell uppdatering, se Uppdatera flödesdata med inkrementell uppdatering.Uppdatera flödesdata med inkrementell uppdatering

Kommandoalternativ

Om du vill visa hjälpalternativen inkluderar du -h i kommandoraden.

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	

Syntaxexempel

Kommandoraderna nedan visar fyra olika exempel för att köra ett flöde med följande kriterier:

• Tableau Prep Builder version: 2022.1.1

  Viktigt: Exemplen nedan inkluderar namnändringen för Tableau Prep version 2019.1.2 till Tableau Prep Builder. Om du använder en tidigare version av produkten bör du använda "Tableau Prep” istället.

• Flödesnamn: Flow1.tfl

• Flödesplats: C:\Users\jsmith\Documents\My Tableau Prep Builder Repository\Flows

• Inloggningsfilens namn: Flow 1.json

• Inloggningsfilens plats: C:\Users\jsmith\Desktop\Flow credentials

• Inloggningsfilens plats lagrad på en nätverksresurs: \tsi.lan\files\Flow credentials

Flödet ansluter till och publicerar till lokala filer

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

Flödet ansluter till och publicerar till lokala filer och använder det korta formuläret för inkrementell uppdatering

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

Flödet ansluter till databaser och publicerar till en server

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

Flödet publiceras till en server och inloggningsfilen lagras på en nätverksresurs

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