Utilitário de linha de comando da Extração de dados do Tableau
É possível automatizar tarefas de atualização de extração ao usar o Utilitário de linha de comando da extração de dados do Tableau. Este é um utilitário da linha de comando fornecido com o Tableau Desktop. Ele permite atualizar fontes de dados de extração publicadas ou anexar dados a elas a partir de um arquivo.
Estes são os requisitos para usar o utilitário da linha de comando da Extração de dados do Tableau:
Está disponível com o Tableau Desktop no Windows e pode ser executado somente em um sistema Windows.
Ele não está disponível com a versão de teste do Tableau Desktop.
É possível usá-lo para fontes de dados de extração que não usam o OAuth.
Use o utilitário para atualizar somente as fontes de dados de conexão única. Não funciona em fontes de dados de várias conexões.
Obsoleto em outubro de 2022: este utilitário não está disponível em versões posteriores devido ao requisito de autenticação multifator(O link abre em nova janela) em Tableau Cloud. Para atualizar as fontes de dados ou os dados de conexões virtuais que o Tableau Cloud não pode acessar diretamente, use o Tableau Bridge. Para obter mais informações, consulte Configurar uma agenda de atualização do Bridge(O link abre em nova janela).
Para iniciar trabalhos de atualização usando um script, use tabcmd refreshextracts(O link abre em nova janela) ou a API REST Executar tarefa de atualização de extração(O link abre em nova janela).
Executar o utilitário
Abra o prompt de comando como administrador e mude para o diretório bin do Tableau Desktop. Por exemplo:
cd C:\Program Files\Tableau\Tableau 2022.4\binUse um dos comandos a seguir, adicionando os parâmetros descritos nas tabelas abaixo.
tableau refreshextracttableau addfiletoextract
Observação: Ao executar o utilitário, sempre especifique tableau na linha de comando ou em scripts; nunca tableau.exe.
Observação:para solucionar problemas, verifique os registros no arquivo tableaucom.txt na pasta \Meu repositório do Tableau\Logs.
Observação: em um ambiente com vários sites, especifique o site a que o comando aplica-se.
Sintaxe e parâmetros do comando tableau refreshextract
Use tableau refreshextract para atualizar uma extração no Tableau Server ou Tableau Cloud. A atualização de uma extração atualiza uma extração existente com qualquer modificação que tenha sido feita na fonte de dados desde a atualização mais recente.
Para ver a ajuda desse comando, no prompt de comando do Windows, digite o seguinte comando:
tableau help refreshextract
Usando parâmetros
Todas as opções têm uma forma completa usada por você com um hífen duplo (por exemplo,
--server).Algumas opções também têm uma forma curta usada por você com um hífen simples (por exemplo,
-s).Se o valor de uma opção contiver espaços, coloque-o entre aspas.
A fonte que está sendo atualizada deve ser a fonte de dados original, não uma extração (
.hyper).
Opções do comando tableau refreshextract
| Forma curta | Forma completa | Descrição |
--source-username <user name> | Um nome de usuário válido para a conexão de fonte de dados. Use esta opção com
Observação: É necessário fornecer o nome do usuário e senha ao atualizar uma extração publicada, mesmo se a fonte de dados foi publicada originalmente com credenciais inseridas. | |
--source-password "<password>" | A senha do usuário da fonte de dados. | |
ou
| Nome do caminho e arquivo da fonte de dados a ser atualizada no servidor. Por exemplo: Para atualizar uma fonte de dados de vários arquivos, passe o caminho para uma pasta que contenha os arquivos de dados. Por exemplo: Se o arquivo estiver em um compartilhamento de rede, use o formato UNC para o caminho: | |
--force-full-refresh | Caso a fonte de dados esteja configurada para atualizações incrementais, use essa opção para forçar uma atualização de extração completa. Caso essa opção não esteja incluída, é realizada uma atualização incremental. Nem todas as fontes de dados oferecem suporte à atualização incremental. | |
-s <server http address> | --server <URL> | A URL do Tableau Server em que os dados são publicados. Para o Tableau Cloud, especifique |
-t <site id> | --site <siteid> | Em um ambiente com vários sites, especifica o site a que o comando aplica-se. No Tableau Cloud, use esse argumento caso o seu nome de usuário esteja associado a mais de um site. No Tableau Server, se você não especificar um site, o site padrão será considerado. A ID do site independe do nome do site e é indicada na URL quando você exibe o site em um navegador. Por exemplo, caso o URL da página vista por você após a entrada no Tableau Cloud seja https://online.tableau.com/t/vernazza/views A ID do site é vernazza. |
--datasource <datasource> | O nome da fonte de dados, conforme publicado no Tableau Server ou no Tableau Cloud. | |
--project <projectname> | O projeto ao qual a fonte de dados pertence. Caso essa opção não esteja incluída, é considerado o projeto padrão. Se o projeto que deseja especificar for um projeto secundário aninhado em uma hierarquia de projeto, é necessário usar este parâmetro junto com o parâmetro | |
--parent-project-path path/to/project | Se o projeto no qual a fonte de dados é publicada não estiver no nível superior de uma hierarquia de projeto, use este parâmetro junto com Use a barra ( Por exemplo, para um projeto chamado Sandbox, no social do projeto, no Marketing de nível superior:
| |
-u <user name> | --username <username> | O usuário do Tableau Server ou do Tableau Cloud válido. |
-p "<password>" | --password "<password>" | A senha do usuário do Tableau Server ou do Tableau Cloud especificado. |
--proxy-username <username> | O nome do usuário para um servidor proxy. | |
--proxy-password "<password>" | A senha para um servidor proxy. | |
-c "<path and file name>" | --config-file "<path and file name>" | Informações de caminho e nome de arquivo para um arquivo que contém opções de configuração do comando. Sempre coloque o caminho entre aspas duplas. Para obter mais informações, consulte Usando um arquivo config. |
Comando tableau refreshextract de exemplo
O comando a seguir atualiza uma extração chamada CurrentYrOverYrStats que foi publicada no Tableau Server no local. Esse comando especifica o seguinte:
- O nome do Tableau Server.
- Nome de usuário e senha do servidor.
- Nome do projeto.
- O nome da fonte de dados a ser atualizada, além do nome de usuário e da senha da fonte de dados.
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"
O comando a seguir atualiza uma extração chamada CurrentYrOverYrStats publicada no Tableau Cloud. Esse comando especifica o seguinte:
- Usuário e senha do Tableau Cloud.
- Nomes de site e projeto do Tableau Cloud.
- A fonte de dados que, neste caso, é hospedada por um fornecedor de fonte de dados com base em nuvem (por exemplo, Salesforce.com) e o nome de usuário e a senha para entrar na fonte de dados hospedada.
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"
Para atualizar uma extração de fonte de dados baseada em arquivo, forneça o caminho para o arquivo original a partir do qual você criou a extração. Se o arquivo estiver em um compartilhamento de rede, use o formato UNC em vez de uma unidade mapeada.
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"
Sintaxe de tableau addfiletoextract
Use tableau addfiletoextract para acrescentar o conteúdo do arquivo a uma extração publicada no Tableau Server ou no Tableau Cloud. Esse comando integra os dois arquivos.
Caso você queira simplesmente atualizar uma extração existente com as alterações mais recentes, use o comando refreshextract. O uso de addfiletoextract para atualizar uma extração existente duplicará os dados, na verdade.
Para ver a ajuda desse comando, no prompt de comando do Windows, digite o seguinte comando:
tableau help addfiletoextract
Todas as opções têm uma forma completa usada por você com um hífen duplo (por exemplo, --server). Algumas opções também têm uma forma curta usada por você com um hífen simples (por exemplo, -s). Se o valor de uma opção contiver espaços, coloque-o entre aspas.
Opções do comando tableau addfiletoextract
| Forma curta | Forma completa | Descrição |
--file <path and file name> | Informações de caminho e nome de arquivo para o arquivo de dados que contém dados a serem anexados. O arquivo pode ser do Excel, Access, uma extração de dados do Tableau ou um arquivo de texto delimitado. Ele não pode ser protegido por senha. Use o formato UNC caso o arquivo esteja em um compartilhamento de rede. Por exemplo, | |
-s <server http address> | --server <URL> | A URL do Tableau Server em que os dados são publicados. Para o Tableau Cloud, especifique |
-t <site id> | --site <site id> | Em um ambiente com vários sites, especifica o site a que o comando aplica-se. No Tableau Cloud, você deve incluir esse argumento caso o seu nome de usuário esteja associado a mais de um site. No Tableau Server, se você não especificar um site, o site padrão será considerado. |
--datasource <datasource> | O nome da fonte de dados, conforme publicado no Tableau Server ou no Tableau Cloud. | |
--project <projectname> | O projeto ao qual a fonte de dados pertence. Caso essa opção não esteja incluída, é considerado o projeto padrão. Se o projeto que deseja especificar for um projeto secundário aninhado em uma hierarquia de projeto, é necessário usar este parâmetro junto com o parâmetro | |
--parent-project-path path/to/project | Se o projeto no qual a fonte de dados é publicada não estiver no nível superior de uma hierarquia de projeto, use este parâmetro junto com Use a barra ( Por exemplo, para um projeto chamado Sandbox, no social do projeto, no Marketing de nível superior:
| |
-u <username> | --username <username> | O usuário do Tableau Server ou do Tableau Cloud válido. |
-p "<password>" | --password "<password>" | A senha do usuário do Tableau Server ou do Tableau Cloud especificado. |
--proxy-username <username> | O nome do usuário para um servidor proxy. | |
--proxy-password "<password>" | A senha para um servidor proxy. | |
-c "<path and filename>" | --config-file "<path and filename>" | Informações de caminho e nome de arquivo para um arquivo que contém opções de configuração do comando. Sempre coloque o caminho entre aspas duplas. Para obter mais informações, consulte Usando um arquivo config. |
Comando tableau tableauaddfiletoextract de exemplo
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"
Usando um arquivo config
É possível usar um editor de texto sem formatação como, por exemplo, Bloco de Notas ou Text Edit para criar um arquivo config (de configuração) que pode ser usado com tableau refreshextract ou tableau addfiletoextract. Um arquivo de configuração poderá ser útil se você esperar atualizar a mesma fonte de dados regularmente. Em vez de precisar digitar as mesmas opções sempre que executa um comando, você especifica o arquivo de configuração. Um arquivo de configuração também tem a vantagem de não expor nomes de usuário e senhas na linha de comando.
Criar o arquivo config
Por exemplo, digamos que você tenha criado um arquivo chamado config.txt e salvado na pasta Documentos. E, no arquivo, você incluiu as informações de parâmetro mostradas abaixo.
Para uma extração publicada no Tableau Server:
server=https://our_server_name
username=OurServerSignIn
password=OurServerPwd
project=New Animations
datasource=CurrentYrOverYrStats
Para uma extração de uma fonte de dados hospedada, publicada no Tableau Cloud, em que server é 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
Referenciar o arquivo de configuração a partir da linha de comando
Depois de criar o arquivo de configuração, você executa o comando tableau refreshextract ou tableau addfiletoextract, apontando para o arquivo de configuração como a única opção usada na linha de comando e colocando o caminho do arquivo de configuração entre aspas. A sintaxe é a seguinte:
tableau refreshextract --config-file "<path>"
Por exemplo, para atualizar a extração especificada no exemplo da seção Criar o arquivo config, você executaria o seguinte comando (verificando se está trabalhando no diretório bin da versão do Tableau Desktop):
C:\Program Files\Tableau\Tableau 2022.4\bin>tableau refreshextract --config-file "C:\Users\user1\Documents\config.txt"
Diferenças de sintaxe para arquivos de configuração
A sintaxe para especificar opções dentro de um arquivo de configuração é diferente da sintaxe usada na linha de comando no seguinte sentido:
- Os nomes de opção não começam com traços ou hifens.
- Você usa um sinal de igualdade (sem espaços) para separar nomes de opção dos valores de opção.
- As aspas não são necessárias (ou permitidas) em torno de valores, mesmo quando incluem espaços (como acontece com a opção
projectno exemplo mostrado anteriormente).
Usar o Agendador de Tarefas do Windows para atualizar extrações
É possível usar o Agendador de Tarefas do Windows, além do Utilitário de linha de comando Extração de Dados do Tableau, para automatizar atualizações regulares feitas em fontes de dados de Tableau Desktop dentro do seu firewall corporativo. Você pode configurar uma tarefa para ocorrer uma vez ao dia, uma vez por semana, uma vez por mês ou depois de um determinado evento do sistema. Por exemplo, execute a tarefa quando o computador for iniciado.
Para saber mais, consulte a página Agendador de tarefas - Como...(O link abre em nova janela) na biblioteca Microsoft TechNet.