Skapa och använd parametrar i flöden
Stöds i Tableau Prep Builder version 2021.4.1 och senare och på webben i Tableau Cloud och Tableau Server version 2021.4.0 och senare
Obs! Innehållet i detta ämne gäller för att skriva flöden i Tableau Prep Builder och på webben, såvida inte annat uttryckligen anges. Mer information om hur du redigerar flöden på webben finns i Tableau Prep på webben i hjälpen för Tableau Server(Länken öppnas i ett nytt fönster) och Tableau Cloud(Länken öppnas i ett nytt fönster).
Om du återanvänder flöden ofta med olika data med samma schema kan du skapa och tillämpa användarparametrar på dina flöden för att enkelt växla mellan scenarier. En parameter är ett globalt platshållarvärde, till exempel en siffra, ett textvärde eller ett booleskt värde som kan ersätta ett konstant värde i ett flöde.
Istället för att bygga och underhålla flera flöden kan du nu bygga ett flöde och använda parametrar för att köra flödet med dina olika datauppsättningar. Du kan till exempel skapa en parameter för olika försäljningsregioner och sedan tillämpa ett parametervärde för inmatningsfilens sökväg och köra flödet med bara den regionens data.
Från och med Tableau Prep Builder- och Tableau Cloud-version 2023.2 kan du också lägga till systemparametrar till filens eller den publicerade datakällans utdatanamn för att automatiskt lägga till en tidsstämpel varje gång du kör flödet.
Var kan jag tillämpa parametrar?
Du kan tillämpa användarparametrar på filnamn, sökvägar, tabellnamn, filteruttryck och beräknade fält, beroende på stegtyp. Från och med version 2022.1.1 kan du även inkludera värden för åsidosättning av parametrar när du kör flöden med hjälp av REST API. Mer information finns i Flödesmetoder(Länken öppnas i ett nytt fönster) i Tableau REST API-hjälpen.
Du kan tillämpa systemparametrar (version 2023.2 och senare) på utdatanamn för filer och publicerade datakällor.
I följande tabell anges de platser där du kan tillämpa parametrar för varje stegtyp.
Stegtyp | Parameterplats |
---|---|
Indata | Användarparametrar:
|
Utdata | Användar- eller systemparametrar:
|
Rensa, Nya rader, Pivotera, Koppla, Förena | Användarparametrar:
|
Aggregera | Användarparametrar:
|
Skript | Användarparametrar:
|
Prognos | Användarparametrar:
|
Skapa användarparametrar
Användarparametrar är specifika för flödet där de används. Skapa parametrar från den översta menyn och definiera sedan de värden som gäller för dem. Du kan även definiera parametrar som accepterar alla värden, vilket innebär att alla flödesanvändare kan ange valfritt värde när de kör flödet.
Du kan göra parametervärden för flöden obligatoriska eller valfria. När du kör flödet uppmanas användarna att ange parametervärdena. Obligatoriska parametervärden måste anges innan användaren kan köra flödet. Valfria parametervärden kan anges eller så kan du acceptera det aktuella (standard) värdet. Parametervärdena tillämpas sedan på flödeskörningen överallt där parametern används.
Obs! För att köra eller schemalägga flöden som inkluderar parametrar på Tableau Server eller Tableau Cloud måste din administratör aktivera inställningen Flödesparametrar på din server. Mer information finns i Skapa och interagera med flöden på webben i Tableau Server(Länken öppnas i ett nytt fönster)- eller Tableau Cloud(Länken öppnas i ett nytt fönster)-hjälpen.
Klicka på ikonen Parameter på den översta menyn och klicka sedan på Skapa parameter.
I dialogrutan Skapa parameter anger du ett namn och en beskrivning (valfritt). Parameternamnet måste vara unikt. Detta är värdet som visas i användargränssnittet när du lägger till en parameter.
Om du inkluderar en beskrivning kan användarna se denna information genom att hålla muspekaren över (från och med version 2022.1.1) parameterlistan och var parametrarna används.
Välj en av följande datatyper. Parametervärdena måste matcha datatypen som du väljer.
- Antal (heltal eller decimal)
- Sträng
- Booleskt
Ange Tillåtna värden. Dessa är de värden som användarna kan ange i parametern.
Alla: Med det här alternativet kan användare skriva in valfritt värde för parametern, även när flödet körs.
Obs! Det kan utgöra en säkerhetsrisk att använda detta alternativ för parametrar som kan användas i in- och utmatningssteg. Anpassade SQL-frågor som tillåter att något värde matas in kan till exempel utsätta dina datatillgångar för SQL-injektionsattacker.
- Lista: Ange en lista över värden som användare kan välja mellan när de använder parametern. Om du vill ange flera värden trycker du på Retur efter varje post.
- (valfritt) Välj Kräv val vid körningstid (Fråga efter värde vid körningstid i tidigare versioner). Detta gör att parametern krävs. Användaren måste ange ett värde när flödet körs eller schemaläggs.
Ange ett Aktuellt värde. Detta är ett obligatoriskt värde och fungerar som ett standardvärde för parametern.
- Alla: Ange ett värde.
- Lista: Tableau använder det första värdet i din lista. Använd alternativen i listrutan för att ändra det.
- Boolesk: Välj Sant eller Falskt.
- Klicka på OK för att spara parametern.
Ändra användarparameterns standardvärde
När du skapar en användarparameter måste du ange ett aktuellt (standard) värde. Om en parameter ingår i ett flöde används detta värde för att:
- Köra anpassade SQL-frågor som definierats i ett inmatningssteg.
- Fylla i valfria parametrar som inte specificeras vid körningstid.
- Ersätt parametern som ett statiskt värde i sparade steg (version 2022.1.1 och senare).
- Ersätt parametern som ett statiskt värde i filsökvägar vid publicering av flöden med paketerade datauppsättningar.
Du kan ändra värdet när du vill. Du kan redigera parametern eller använda knappen Ställ in i parameterlistan på den översta menyn. Du kan använda knappen Ställ in i flödet var som helst där parametern tillämpas. När du gör detta återställer den parameterns aktuella (standard) värde överallt där parametern används, även i anpassade SQL-frågor.
Redigera användarparametrar
- Klicka på ikonen Parameter på den översta menyn.
- Klicka på Redigera parameter.
I dialogrutan Redigera parameter gör du eventuella ändringar och klickar sedan på OK.
Återställ standardvärden för användarparameter
För att snabbt återställa parameterns standardvärde, använd knappen Ställ in. Knappen visar en räkning som anger antalet platser i flödet där parametern används.
Om du vill markera vilka steg i flödet som använder parametern klickar du på Visa i flöde i dialogrutan Parameter. Du går direkt till det steget om det bara finns en plats där parametern används med rutan Profil öppen.
- Gör något av följande:
Klicka på ikonen Parameter på den översta menyn. Använd det här alternativet för att återställa parametervärden som används var som helst i flödet, eller när de används i filter och i beräknade fält.
Klicka på parametern där den tillämpas i flödet. Du kan använda det här alternativet för parametrar som används i filnamn, filsökvägar, tabellnamn, anpassad SQL och före och efter SQL-skript.
- Välj eller ange parametervärdet.
Klicka på Ställ in för att tillämpa ändringen.
Tillämpa parametrar på ditt flöde
När du har skapat användarparametrar kan du tillämpa dem på olika platser under hela flödet, beroende på stegtypen. När flödet körs tillämpas parametervärdena på det flödet för att producera utdata för det specifika datascenariot.
Systemparametrar (version 2023.2 och senare) genereras automatiskt när du kör flödet. Tillämpa dem helt enkelt på namnet på utmatningssteget så uppdateras parametern dynamiskt med datum och tid för flödets körstart, varje gång flödet körs.
Tillämpa parametrar på inmatningssteg
Du kan använda användarparametrar för att ersätta ett filnamn, delar av filsökvägen, ett databastabellnamn eller när du använder Anpassad SQL i ett inmatningssteg.
Filnamn eller filsökväg
Det här alternativet är inte tillgängligt när du redigerar flöden på webben.
Du kan inkludera användarparametrar i din filsökväg, med vissa undantag. Från och med version 2022.1.1 kan du även se en förhandsgranskning av parametervärdena.
Undantag
- Från och med version 2022.1.1 kan du schemalägga och köra flöden på webben som innehåller parametrar i sökvägen till indatafilen. Om du använder en tidigare version kör du flöden i Tableau Prep Builder eller från kommandoraden.
Det kräver att du har en direkt filanslutning om du ska kunna inkludera parametrar i filsökvägen vid publicering av flöden till webben. Annars konverteras parametern till ett statiskt värde med Aktuellt värde.
Obs! Direkta filanslutningar kräver att filplatserna är inkluderade i organisationens säkerhetslista. Mer information finns i Säkerhetslista för in- och utdataplatser(Länken öppnas i ett nytt fönster) i Tableau Server-hjälpen.
Tillämpa en användarparameter på ett filnamn eller en sökväg
- På fliken Inställningar i filsökvägen placerar du markören på den plats där du vill lägga till parametern.
Klicka på parameterikonen och välj din parameter.
Visa en förhandsgranskning av parametervärdet. Aktuellt (standard) värde visas i förhandsgranskningen. Du uppmanas att välja eller ange parametervärdet när du kör flödet.
Databastabell
När användarparametrar används i tabellnamn måste hela tabellnamnet vara parametern. För närvarande stöds inte användning av parametrar för delar av ett tabellnamn.
Obs! Det finns ännu inte något stöd för användning av en parameter för ett tabellnamn i en Google BigQuery-inmatningsanslutning.
- Klicka på listrutan i fältet Tabell på fliken Inställningar.
Välj Använd parameter och välj sedan parametern i listan.
Anpassad SQL
- Klicka på Anpassad SQL i rutan Anslutningar.
Skriv eller klistra in frågan i textrutan på fliken Anpassad SQL.
Klicka på parameterikonen och välj din parameter.
Klicka på Kör för att köra din fråga. Du kommer inte att uppmanas att ange ett parametervärde tills du kör flödet. Frågan körs istället initialt med parametern Aktuellt värde.
Obs! Om parametern används någon annanstans i flödet och Aktuellt värde återställs kan den ändringen påverka din fråga.
Tillämpa användarparametrar på utmatningssteg
I ett utmatningssteg kan du tillämpa användarparametrar på följande platser:
- Filnamn
- Avsnitt av din filsökväg
- Publicerat datakällsnamn
- Databastabellens namn
- Microsoft Excel-kalkylbladsnamn (version 2022.1.1 och senare)
- Anpassade SQL-skript som körs före eller efter att flödesdata skrivs till en databas (version 2022.1.1 och senare)
Filnamn eller filsökväg
Det här utmatningsalternativet är inte tillgängligt när du skapar eller redigerar flöden på webben.
- Välj Fil i listrutan Spara utdata till i rutan Utdata.
Klicka på parameterikonen i fältet Namn eller Plats och välj din parameter.
För filsökvägen placerar du markören på den plats där du vill lägga till parametern.
När du kör flödet uppmanas du att ange parametervärden.
Publicerat datakällsnamn
- Välj Publicerad datakälla i rutan Utdata i listrutan Spara utdata till.
Klicka på parameterikonen och välj din parameter i fältet Namn.
När du kör flödet uppmanas du att ange parametervärden.
Databastabell och före och efter anpassad SQL
- Välj Databastabell i listrutan Spara utdata till på fliken Utdata.
Välj Använd parameter i fältet Tabell och välj sedan parametern i listan.
(Valfritt) Klicka på fliken Anpassad SQL. Från och med version 2022.1.1 kan du ange ett SQL-skript med parametrar att köra Före och Efter att data skrivs till tabellen. Om du vill inkludera en parameter klickar du på Infoga parameter och väljer din parameter.
Mer information om hur du använder SQL-skript när du skriver utdata till en databas finns i Spara flödesutdata till externa databaser.
Obs! Du måste manuellt ta bort parametrar som används i SQL-skript. Mer information finns i Ta bort användarparametrar manuellt.
När du kör flödet uppmanas du att ange parametervärden.
Tillämpa systemparametrar på utmatningssteg
I ett utmatningssteg kan du tillämpa systemparametrar för datum och tid på följande platser:
- Filnamn
- Publicerat datakällsnamn
Filnamn
Det här utmatningsalternativet är inte tillgängligt när du skapar eller redigerar flöden på webben.
- Välj Fil i listrutan Spara utdata till i rutan Utdata.
I fältet Namn klickar du på parameterikonen och väljer bland följande kördatums- eller körtidsparametrar. Du kan kombinera flera systemparametrar för att skapa vilken tidsstämpel du än behöver.
Kördatum
- Datum: ÅÅÅÅ-MM-DD, ÅÅÅMMDD, DD-MM-ÅÅÅÅ
- Månad: månadsnamn, månadsnummer
- Veckonummer
- Kvartalsnummer
- Årsnummer
Körtid
- ÅÅÅÅ-MM-DD_HH-MM-SS (24 timmar)
- ÅÅÅÅMMDD_HHMMSS (24 timmar)
När du kör flödet tillämpar Tableau Prep flödesstarttiden med din lokala tidszon eller serverns tidszon.
Publicerat datakällsnamn
- Välj Publicerad datakälla i rutan Utdata i listrutan Spara utdata till.
I fältet Namn klickar du på parameterikonen och väljer bland följande kördatums- eller körtidsparametrar. Du kan kombinera flera systemparametrar för att skapa vilken tidsstämpel du än behöver.
Kördatum
- Datum: ÅÅÅÅ-MM-DD, ÅÅÅMMDD, DD-MM-ÅÅÅÅ
- Månad: månadsnamn, månadsnummer
- Veckonummer
- Kvartalsnummer
- Årsnummer
Körtid
- ÅÅÅÅ-MM-DD_HH-MM-SS (24 timmar)
- ÅÅÅÅMMDD_HHMMSS (24 timmar)
När du kör flödet tillämpar Tableau Prep flödesstarttiden med din lokala tidszon eller serverns tidszon.
Tillämpa användarparametrar på filterberäkningar
Använd användarparametrar för att filtrera data under hela flödet. Filtrera datauppsättningen i inmatningssteget eller använd filterparametrar på steg- eller fältvärdesnivån. Använd till exempel en filterparameter för att endast mata in data för en specifik region eller filterdata i ett steg till en specifik avdelning.
Obs! Från och med version 2022.1 kan du använda Kopiera och Klistra in för att återanvända filterberäkningar med parametrar i andra flöden när samma parameter finns med samma namn och datatyp.
- Från inmatningssteget eller verktygsfältet i rutan Profil väljer du Filtrera värden. Om du vill lägga till ett parameterfilter i ett fält väljer du menyn Fler alternativ och sedan Filter > Beräkning.
I beräkningsredigeraren Lägg till skriver du in namnet på parametern för att välja den i listan (parametern visas i lila) och klickar sedan på Spara för att spara filtret.
När du kör flödet uppmanas du att ange parametervärden.
Tillämpa användarparametrar på beräknade fält
Använd användarparametrar för att ersätta konstanta värden i beräkningar som du använder under hela flödet. Du kan tillämpa beräkningsparametrar på steg- eller fältvärdesnivå.
Obs! Från och med version 2022.1 kan du använda Kopiera och Klistra in för att återanvända beräkningar med parametrar i andra flöden när samma parameter finns med samma namn och datatyp.
- Klicka på Skapa beräknat fält från verktygsfältet i rutan Profil. Om du vill lägga till en parameter i en beräkning på ett fält väljer du menyn Fler alternativ och sedan Skapa beräknat fält > Anpassad beräkning.
I beräkningsredigeraren Lägg till fält, ange din beräkning och skriv in namnet på parametern för att välja den i listan och klicka sedan på Spara för att spara beräkningen.
När du kör flödet uppmanas du att ange parametervärden.
Ta bort användarparametrar
Om du vill ta bort användarparametrar som du inte längre behöver klickar du på Ta bort parameter i dialogrutan Redigera parameter. Detta tar bort varje instans av parametern som används under hela flödet och ersätter den med parameterns aktuella värde. Åtgärden kan inte ångras.
Obs! Alternativen för att ta bort parametrar i ett flöde varierar beroende på din version. Använd instruktionerna nedan för version 2022.1 och senare. Använd Ta bort användarparametrar manuellt för tidigare versioner och för att ta bort parametrar som används i anpassade SQL-skript som körs före eller efter att utdata skrivs till en databas.
- Klicka på listrutan för parameterikonen på den översta menyn och sedan på Redigera parameter för den parameter du vill ta bort.
Klicka på Ta bort parameter i dialogrutan Redigera parameter.
Klicka på Ta bort parameter igen i bekräftelsedialogrutan. Innan du tar bort parametern kan du klicka på Visa i flöde för att markera stegen och undersöka var den används.
Gäller version 2021.4.4 och tidigare och för parametrar som används före och efter anpassade SQL-skript.
Innan du kan ta bort en användarparameter från din parameterlista måste du först hitta och ta bort alla instanser av parametrarna från flödet, även från rutan Ändringar.
- Klicka på parameterikonens listruta på den översta menyn.
Klicka på Visa i flöde för den parameter du vill ta bort för att hitta alla instanser där parametern används i flödet.
Om parametern inte används någonstans i flödet går du till steg 4.
- Ta bort parametern för varje steg där parametern används. Ta även bort alla ändringar som anges i rutan Ändringar .
- Klicka på listrutan för parameterikonen på den översta menyn och för parametern du vill ta bort klickar du på Redigera parameter.
Klicka på Ta bort parameter i dialogrutan Redigera parameter.
Parametern ersätts med parameterns Aktuella värde.
Kör flöden med parametrar
Att köra flöden som inkluderar parametrar görs på samma sätt som att köra flöden som inte har dem, förutom att användarna uppmanas att ange användarparametervärden vid körning eller när de lägger till flödet i ett schema i Tableau Server eller Tableau Cloud.
Systemparametrar tillämpas automatiskt när flödet körs.
Om en användarparameter markeras som obligatorisk måste användarna ange ett värde innan de kan köra flödet. Om en parameter är valfri kan användaren som standard ange ett värde eller acceptera parameterns aktuella värde.
Obligatoriska parametrar har kryssrutan Kräv val vid körningstid (Fråga efter värde vid körningstid i tidigare versioner) markerad.
Om du kör flöden med kommandoradsgränssnittet och vill åsidosätta de aktuella (förvalda) parametervärdena, skapar du en parameter som åsidosätter .json-filen och inkluderar syntaxen -p --parametrar i kommandoraden. Mer information finns i Uppdatera flödesutdatafiler från kommandoraden.
Kör flöden manuellt
När du kör ett flöde från Tableau Prep Builder eller manuellt i Tableau Server eller Tableau Cloud öppnas dialogrutan Parametrar när du klickar på Kör.
- Ange eller välj användarparametervärden. Om det finns valfria parametrar i flödet kan du ange värdena vid denna tidpunkt eller acceptera det aktuella (standard) parametervärdet.
- Klicka på Kör flöde för att köra flödet.
Mer information om hur man kör flöden finns i Publicera ett flöde i Tableau Server eller Tableau Cloud.
Kör flöden enligt ett schema
När du schemalägger flöden som ska köras på Tableau Server eller Tableau Cloud måste du ange obligatoriska användarparametervärden när du schemalägger flödena.
Ange eller välj parametervärdena på fliken Nya uppgifter eller Länkade uppgifter i avsnittet Ställ in parametrar. Om det finns valfria parametrar i flödet kan du ange värdena vid denna tidpunkt eller lämna fältet tomt för att använda det aktuella (standard) parametervärdet.
- Klicka på Skapa uppgifter för att schemalägga ditt flöde.