Vernieuwingstaken voor extracten automatiseren vanaf de opdrachtregel
U kunt extractvernieuwingstaken automatiseren met behulp van het Tableau-opdrachtregelhulpprogramma voor data-extractie. Dit is een opdrachtregelhulpprogramma dat bij Tableau Desktop wordt geleverd en waarmee u gepubliceerde extractdatabronnen kunt vernieuwen of data uit een bestand kunt toevoegen.
Vereisten voor het gebruik van het Tableau-opdrachtregelhulpprogramma voor data-extractie zijn onder meer:
Het programma is beschikbaar voor Tableau Desktop op Windows en kan alleen op een Windows-systeem worden uitgevoerd.
Het is niet beschikbaar in de proefversie van Tableau Desktop.
U kunt het programma gebruiken voor extractdatabronnen die geen OAuth gebruiken.
U kunt deze alleen gebruiken om databronnen met één verbinding te vernieuwen. Het werkt niet voor databronnen met meerdere verbindingen.
Verouderd oktober 2022: Dit hulpprogramma is niet beschikbaar in hogere releases vanwege de meervoudige verificatie(Link wordt in een nieuw venster geopend)vereiste in Tableau Cloud. Om databronnen of virtuele verbindingen te vernieuwen waar Tableau Cloud niet direct bij kunt, kunt u in plaats daarvan Tableau Bridge gebruiken. Zie Een Bridge-vernieuwingsschema instellen(Link wordt in een nieuw venster geopend) voor meer informatie.
Om vernieuwingstaken te starten met behulp van een script, gebruikt u tabcmd refreshextracts(Link wordt in een nieuw venster geopend) of REST API Extractvernieuwingstaak uitvoeren(Link wordt in een nieuw venster geopend).
Het hulpprogramma uitvoeren
Open de opdrachtprompt als beheerder en ga naar de bin directory van Tableau Desktop. Bijvoorbeeld:
cd C:\Program Files\Tableau\Tableau 2022.4\binGebruik een van de volgende opdrachten en voeg daarbij de parameters toe die in de onderstaande tabellen worden beschreven.
tableau refreshextracttableau addfiletoextract
Opmerking: Geef bij het gebruik van het hulpprogramma altijd tableau op in de opdrachtregel of in scripts, nooit tableau.exe.
Opmerking: Om problemen op te lossen, controleert u de logboeken in het bestand tableaucom.txt in de map \My Tableau Repository\Logs.
Opmerking: Geef in een omgeving met meerdere sites de site op waarop de opdracht van toepassing is.
Syntaxis en parameters voor de opdracht tableau refreshextract
Gebruik tableau refreshextract om een extract op Tableau Server of Tableau Cloud te vernieuwen. Wanneer u een extract vernieuwt, worden alle wijzigingen die sinds de laatste verversing in de databron zijn aangebracht, in een bestaand extract bijgewerkt.
Voor hulp bij deze opdracht typt u de volgende opdracht bij de opdrachtprompt van Windows:
tableau help refreshextract
Parameters gebruiken
Alle opties hebben een volledige vorm die u gebruikt met een dubbel streepje (bijvoorbeeld
--server).Sommige opties hebben ook een korte vorm die u gebruikt met een enkel streepje (bijvoorbeeld
-s).Als de waarde voor een optie spaties bevat, plaatst u deze tussen aanhalingstekens.
De bron die wordt vernieuwd, moet de oorspronkelijke databron zijn, geen extract (
.hyper).
tableau refreshextract-opdrachtopties
| Korte vorm | Volledige vorm | Beschrijving |
--source-username <user name> | Een geldige gebruikersnaam voor de databronverbinding. Gebruik deze optie met
Opmerking: U moet de gebruikersnaam en het wachtwoord opgeven wanneer u een gepubliceerd extract vernieuwt, zelfs als de databron oorspronkelijk met ingesloten referenties is gepubliceerd. | |
--source-password "<password>" | Het wachtwoord voor de gebruiker van de databron. | |
of
| Pad en bestandsnaam voor de databron die op de server moet worden vernieuwd. Bijvoorbeeld: Als u een databron met meerdere bestanden wilt vernieuwen, geeft u het pad door naar een map die de databestanden bevat. Bijvoorbeeld: Als het bestand zich op een netwerkshare bevindt, gebruikt u de UNC-notatie voor het pad: | |
--force-full-refresh | Als de databron is ingesteld voor incrementele vernieuwingen, gebruikt u deze optie om een volledige extractvernieuwing af te dwingen. Als deze optie niet is opgenomen, wordt een incrementele vernieuwing uitgevoerd. Niet alle databronnen ondersteunen incrementele vernieuwing. | |
-s <server http address> | --server <URL> | De URL voor de Tableau Server waarop de data worden gepubliceerd. Voor Tableau Cloud geeft u |
-t <site id> | --site <siteid> | In een omgeving met meerdere sites geeft u de site op waarop de opdracht van toepassing is. Gebruik dit argument voor Tableau Cloud als uw gebruikersnaam aan meer dan één site is gekoppeld. Als u voor Tableau Server geen site opgeeft, wordt uitgegaan van de standaardsite. De site-ID is onafhankelijk van de sitenaam en wordt aangegeven in de URL wanneer u de site in een browser bekijkt. Als bijvoorbeeld de URL voor de pagina die u ziet nadat u zich hebt aangemeld bij Tableau Cloud https://online.tableau.com/t/vernazza/views is, dan is de site-ID vernazza. |
--datasource <datasource> | De naam van de databron, zoals gepubliceerd op Tableau Server of Tableau Cloud. | |
--project <projectname> | Het project waartoe de databron behoort. Als deze optie niet is opgenomen, wordt uitgegaan van het standaardproject. Als het project dat u wilt opgeven een onderliggend project is dat is genest binnen een projecthiërarchie, moet u deze parameter gebruiken samen met de | |
--parent-project-path path/to/project | Als een project waarnaar de databron is gepubliceerd zich niet op het hoogste niveau van een projecthiërarchie bevindt, gebruikt u deze parameter samen met de Gebruik het slash-teken ( Bijvoorbeeld, voor een project met de naam Sandbox, in project Social, onder Marketing op het hoogste niveau:
| |
-u <user name> | --username <username> | Geldige Tableau Server- of Tableau Cloud-gebruiker. |
-p "<password>" | --password "<password>" | Het wachtwoord voor de opgegeven Tableau Server- of Tableau Cloud-gebruiker. |
--proxy-username <username> | De gebruikersnaam voor een proxyserver. | |
--proxy-password "<password>" | Het wachtwoord voor een proxyserver. | |
-c "<path and file name>" | --config-file "<path and file name>" | Pad- en bestandsnaaminformatie voor een bestand met configuratieopties voor de opdracht. Plaats het pad altijd tussen dubbele aanhalingstekens. Zie Een configuratiebestand gebruiken hieronder voor meer informatie. |
Voorbeeld van de opdracht tableau refreshextract
De volgende opdracht vernieuwt een extract met de naam CurrentYrOverYrStats dat is gepubliceerd naar Tableau Cloud. Met deze opdracht wordt het volgende gespecificeerd:
- Tableau Cloud-gebruikersnaam en wachtwoord.
- Site- en projectnamen van Tableau Cloud.
- De databron, die in dit geval wordt gehost door een cloudgebaseerde databronprovider (bijvoorbeeld Salesforce.com), en de gebruikersnaam en het wachtwoord om aan te melden bij de gehoste databron.
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 een extract van een op een bestand gebaseerde databron te vernieuwen, geeft u het pad op naar het oorspronkelijke bestand waarvan u het extract hebt gemaakt. Als het bestand zich op een netwerkshare bevindt, gebruikt u de UNC-indeling in plaats van een toegewezen station.
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"
Syntaxis voor tableau addfiletoextract
Gebruik tableau addfiletoextract om bestandsinhoud toe te voegen aan een extract dat is gepubliceerd op Tableau Server of Tableau Cloud. Met deze opdracht worden de twee bestanden gecombineerd.
Als u een bestaand extract eenvoudigweg wilt bijwerken met de laatste wijzigingen, gebruikt u in plaats daarvan de opdracht refreshextract. Als u addfiletoextract gebruikt om een bestaand extract bij te werken, wordt de data niet bijgewerkt maar gedupliceerd.
Voor hulp bij deze opdracht typt u de volgende opdracht bij de opdrachtprompt van Windows:
tableau help addfiletoextract
Alle opties hebben een volledige vorm die u gebruikt met een dubbel streepje (bijvoorbeeld --server). Sommige opties hebben ook een korte vorm die u gebruikt met een enkel streepje (bijvoorbeeld -s). Als de waarde voor een optie spaties bevat, plaatst u deze tussen aanhalingstekens.
Opties van de opdracht tableau addfiletoextract
| Korte vorm | Volledige vorm | Beschrijving |
--file <path and file name> | Pad- en bestandsnaaminformatie voor het databestand met de toe te voegen data. Het bestand kan afkomstig zijn uit Excel, Access, een Tableau-dataextract of een tekstbestand met scheidingstekens. Er kan geen wachtwoordbeveiliging worden toegepast. Gebruik UNC-indeling als het bestand zich op een netwerkshare bevindt. Bijvoorbeeld: | |
-s <server http address> | --server <URL> | De URL voor de Tableau Server waarop de data worden gepubliceerd. Voor Tableau Cloud geeft u |
-t <site id> | --site <site id> | In een omgeving met meerdere sites geeft u de site op waarop de opdracht van toepassing is. Voor Tableau Cloud moet u dit argument opnemen als uw gebruikersnaam aan meer dan één site is gekoppeld. Als u voor Tableau Server geen site opgeeft, wordt uitgegaan van de standaardsite. |
--datasource <datasource> | De naam van de databron, zoals gepubliceerd op Tableau Server of Tableau Cloud. | |
--project <projectname> | Het project waartoe de databron behoort. Als deze optie niet is opgenomen, wordt uitgegaan van het standaardproject. Als het project dat u wilt opgeven een onderliggend project is dat is genest binnen een projecthiërarchie, moet u deze parameter gebruiken samen met de | |
--parent-project-path path/to/project | Als een project waarnaar de databron is gepubliceerd zich niet op het hoogste niveau van een projecthiërarchie bevindt, gebruikt u deze parameter samen met de Gebruik het slash-teken ( Bijvoorbeeld, voor een project met de naam Sandbox, in project Social, onder Marketing op het hoogste niveau:
| |
-u <username> | --username <username> | Geldige Tableau Server- of Tableau Cloud-gebruiker. |
-p "<password>" | --password "<password>" | Het wachtwoord voor de opgegeven Tableau Server- of Tableau Cloud-gebruiker. |
--proxy-username <username> | De gebruikersnaam voor een proxyserver. | |
--proxy-password "<password>" | Het wachtwoord voor een proxyserver. | |
-c "<path and filename>" | --config-file "<path and filename>" | Pad- en bestandsnaaminformatie voor een bestand met configuratieopties voor de opdracht. Plaats het pad altijd tussen dubbele aanhalingstekens. Zie Een configuratiebestand gebruiken hieronder voor meer informatie. |
Voorbeeld van de opdracht tableau addfiletoextract
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"
Een configuratiebestand gebruiken
U kunt een gewone teksteditor gebruiken, zoals Kladblok of Text Edit, om een configuratiebestand te maken dat u kunt gebruiken met tableau refreshextract of tableau addfiletoextract. Een configuratiebestand kan handig zijn als u verwacht dat u in de loop van de tijd regelmatig dezelfde databron moet bijwerken. In plaats van dat u telkens dezelfde opties moet typen wanneer u een opdracht uitvoert, geeft u het configuratiebestand op. Een configuratiebestand heeft als bijkomend voordeel dat gebruikersnamen en wachtwoorden niet op de opdrachtregel worden weergegeven.
Het configuratiebestand maken
Stel bijvoorbeeld dat u een bestand met de naam config.txt hebt gemaakt en dit hebt opgeslagen in uw map Documenten. In het bestand hebt u de onderstaande parametergegevens opgenomen.
Voor een extract uit een gehoste databron, dat gepubliceerd is naar Tableau Cloud, waarbij de server https://online.tableau.com is:
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
Naar het configuratiebestand vanaf de opdrachtregel verwijzen
Nadat u het configuratiebestand hebt gemaakt, voert u de opdracht tableau refreshextract of tableau addfiletoextract uit, waarbij u naar het configuratiebestand verwijst als de enige optie die u op de opdrachtregel kunt gebruiken, en waarbij u het pad naar het configuratiebestand tussen dubbele aanhalingstekens plaatst. De syntaxis is als volgt:
tableau refreshextract --config-file "<path>"
Om bijvoorbeeld het in het voorbeeld opgegeven extract in de sectie Het configuratiebestand maken te vernieuwen, voert u de volgende opdracht uit (zorg er daarbij voor dat u in de bin directory voor uw versie van Tableau Desktop werkt):
C:\Program Files\Tableau\Tableau 2022.4\bin>tableau refreshextract --config-file "C:\Users\user1\Documents\config.txt"
Syntaxisverschillen voor configuratiebestanden
De syntaxis voor het opgeven van opties in een configuratiebestand verschilt op de volgende manieren van de syntaxis die u op de opdrachtregel gebruikt:
- Optienamen beginnen niet met koppeltekens of streepjes.
- U gebruikt een gelijkteken (zonder spaties) om optienamen van optiewaarden te scheiden.
- Aanhalingstekens zijn niet nodig (of toegestaan) rond waarden, zelfs niet als ze spaties bevatten (zoals bij de optie
projectin het eerder getoonde voorbeeld).
Windows Taakplanner gebruiken om extracten te vernieuwen
U kunt Windows Taakplanner in combinatie met het Tableau-opdrachtregelhulpprogramma voor data-extractie gebruiken om regelmatige updates naar Tableau Cloud-databronnen binnen uw bedrijfsfirewall te automatiseren. U kunt configureren dat een taak eenmaal per dag, week, maand of na een specifieke systeemgebeurtenis uit wordt gevoerd. U kunt bijvoorbeeld instellen dat de taak wordt uitgevoerd wanneer de computer opstart.
Zie de Taakplannerhandleiding(Link wordt in een nieuw venster geopend) (in het Engels) in de Microsoft TechNet-bibliotheek voor meer informatie.