Comandos tabcmd

Você pode usar os seguintes comandos com a ferramenta de linha de comando tabcmd no Tableau Online:

Importante: para garantir a disponibilidade e evitar interrupções com o Tableau Online, certifique-se de atualizar seu cliente tabcmd para uma versão posterior à versão 2020.2 antes de janeiro de 2022. As versões tabcmd são compatíveis com versões anteriores da API e não devem exigir alterações de código. Para obter mais informações, consulte Instalar tabcmd.

addusers group-name

Adiciona usuários ao grupo especificado.

Exemplo

tabcmd addusers "Development" --users "users.csv"

Opções

--users

Adiciona os usuários do arquivo .csv conhecido ao grupo especificado. O arquivo deve ser uma lista simples com um nome de usuário por linha. Os nomes de usuário não diferenciam letras maiúsculas de minúsculas. Os usuários já devem ter sido criados no Tableau Online.

Se usar esse comando em arquivos.csv grandes no Tableau Server, um administrador de servidor pode habilitar configurações que ajudem a melhorar o desempenho.

Para obter mais informações, consulte Diretrizes do arquivo de importação CSV.

--[no-]complete

Quando definida como complete, essa opção exige que todas as linhas sejam válidas para que qualquer alteração seja bem-sucedida. Se não especificada, --complete será usada.

Opções globais

As opções abaixo são usadas por todos os comandos tabcmd. As opções --server, --user e --password são exigidas pelo menos uma vez para iniciar a sessão. Um token de autenticação é armazenado, de modo que comandos subsequentes possam ser executados sem que essas opções sejam incluídas. Esse token permanece válido por cinco minutos após ter sido usado pelo último comando.

-h, --help

Exibe a ajuda do comando.

Observação: alguns comandos listados podem não ser aplicáveis ao usar o tabcmd com o Tableau Online.

-s, --server

A URL Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-u, --user

O nome de usuário do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-p, --password

A senha do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

--password-file

Permite que a senha seja armazenada no arquivo .txt fornecido, em vez de na linha de comando para aumento da segurança.

-t, --site

Indica que o comando se aplica ao site especificado pela Tableau Online ID do site, entre aspas simples e duplas. Use essa opção caso o usuário especificado esteja associado a mais de um site. A ID de site diferencia maiúsculas e minúsculas ao usar um token de autenticação em cache. Se as letras não corresponderem, você pode ser solicitado a fornecer uma senha, mesmo que o token ainda seja válido.

--no-prompt

Quando especificada, o comando não solicitará uma senha. Se nenhuma senha válida for fornecida, o comando falhará.

--[no-]cookie

Quando especificada, a ID da sessão é salva no logon para que os comandos subsequentes não precisem fazer logon. Use o prefixo no- para não salvar a ID da sessão. A sessão é salva por padrão.

--timeout

Aguarda o número especificado de segundos para que o servidor conclua o processamento do comando. Por padrão, o processo aguardará até que o servidor responda.

--

Especifica o final das opções na linha de comando. Use -- para indicar ao tabcmd que tudo que estiver após -- não deve ser interpretado como uma definição de opção e, em vez disso, pode ser interpretado como um valor para o comando. Isso é útil caso precise especificar um valor no comando que inclui um hífen. O exemplo a seguir mostra como é possível usar -- em um comando tabcmd, onde -430105/Sheet1 é um valor obrigatório para o comando export.

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

createextracts

Cria extrações para uma pasta de trabalho ou fonte de dados publicada.

Opções

-d, --datasource

O nome da fonte de dados de destino para a criação de extração.

--embedded-datasources

Uma lista de nomes das fontes de dados inseridas separadas por espaço na pasta de trabalho destino. Coloque nomes de fontes de dados entre aspas duplas se contiverem espaços. Disponível somente ao criar extrações para uma pasta de trabalho.

--encrypt

Criar extração criptografada.

--include-all

Inclua todas as fontes de dados inseridas na pasta de trabalho de destino. Disponível somente ao criar extrações para a pasta de trabalho.

--parent-project-path

Caminho do projeto principal que contém o recurso de destino. Deve especificar o nome do projeto com --projeto.

--project

O nome do projeto que contém o recurso de destino. Necessário somente se a - pasta de trabalho ou - fonte de dados for especificada. Se não especificado, o projeto padrão 'Default' será usado.

-u, -url

O nome canônico do recurso conforme ele aparece na URL.

-w, -workbook

O nome da pasta de trabalho de destino para a criação de extração.

Opções globais

As opções abaixo são usadas por todos os comandos tabcmd. As opções --server, --user e --password são exigidas pelo menos uma vez para iniciar a sessão. Um token de autenticação é armazenado, de modo que comandos subsequentes possam ser executados sem que essas opções sejam incluídas. Esse token permanece válido por cinco minutos após ter sido usado pelo último comando.

-h, --help

Exibe a ajuda do comando.

Observação: alguns comandos listados podem não ser aplicáveis ao usar o tabcmd com o Tableau Online.

-s, --server

A URL Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-u, --user

O nome de usuário do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-p, --password

A senha do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

--password-file

Permite que a senha seja armazenada no arquivo .txt fornecido, em vez de na linha de comando para aumento da segurança.

-t, --site

Indica que o comando se aplica ao site especificado pela Tableau Online ID do site, entre aspas simples e duplas. Use essa opção caso o usuário especificado esteja associado a mais de um site. A ID de site diferencia maiúsculas e minúsculas ao usar um token de autenticação em cache. Se as letras não corresponderem, você pode ser solicitado a fornecer uma senha, mesmo que o token ainda seja válido.

--no-prompt

Quando especificada, o comando não solicitará uma senha. Se nenhuma senha válida for fornecida, o comando falhará.

--[no-]cookie

Quando especificada, a ID da sessão é salva no logon para que os comandos subsequentes não precisem fazer logon. Use o prefixo no- para não salvar a ID da sessão. A sessão é salva por padrão.

--timeout

Aguarda o número especificado de segundos para que o servidor conclua o processamento do comando. Por padrão, o processo aguardará até que o servidor responda.

--

Especifica o final das opções na linha de comando. Use -- para indicar ao tabcmd que tudo que estiver após -- não deve ser interpretado como uma definição de opção e, em vez disso, pode ser interpretado como um valor para o comando. Isso é útil caso precise especificar um valor no comando que inclui um hífen. O exemplo a seguir mostra como é possível usar -- em um comando tabcmd, onde -430105/Sheet1 é um valor obrigatório para o comando export.

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

creategroup group-name

Cria um grupo. Use addusers para adicionar usuários após a criação do grupo.

Exemplo

tabcmd creategroup "Development"

Opções globais

As opções abaixo são usadas por todos os comandos tabcmd. As opções --server, --user e --password são exigidas pelo menos uma vez para iniciar a sessão. Um token de autenticação é armazenado, de modo que comandos subsequentes possam ser executados sem que essas opções sejam incluídas. Esse token permanece válido por cinco minutos após ter sido usado pelo último comando.

-h, --help

Exibe a ajuda do comando.

Observação: alguns comandos listados podem não ser aplicáveis ao usar o tabcmd com o Tableau Online.

-s, --server

A URL Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-u, --user

O nome de usuário do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-p, --password

A senha do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

--password-file

Permite que a senha seja armazenada no arquivo .txt fornecido, em vez de na linha de comando para aumento da segurança.

-t, --site

Indica que o comando se aplica ao site especificado pela Tableau Online ID do site, entre aspas simples e duplas. Use essa opção caso o usuário especificado esteja associado a mais de um site. A ID de site diferencia maiúsculas e minúsculas ao usar um token de autenticação em cache. Se as letras não corresponderem, você pode ser solicitado a fornecer uma senha, mesmo que o token ainda seja válido.

--no-prompt

Quando especificada, o comando não solicitará uma senha. Se nenhuma senha válida for fornecida, o comando falhará.

--[no-]cookie

Quando especificada, a ID da sessão é salva no logon para que os comandos subsequentes não precisem fazer logon. Use o prefixo no- para não salvar a ID da sessão. A sessão é salva por padrão.

--timeout

Aguarda o número especificado de segundos para que o servidor conclua o processamento do comando. Por padrão, o processo aguardará até que o servidor responda.

--

Especifica o final das opções na linha de comando. Use -- para indicar ao tabcmd que tudo que estiver após -- não deve ser interpretado como uma definição de opção e, em vez disso, pode ser interpretado como um valor para o comando. Isso é útil caso precise especificar um valor no comando que inclui um hífen. O exemplo a seguir mostra como é possível usar -- em um comando tabcmd, onde -430105/Sheet1 é um valor obrigatório para o comando export.

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

createproject project-name

Cria um projeto.

Exemplo

tabcmd createproject -n "Quarterly_Reports" -d "Workbooks showing quarterly sales reports."

Opções

-n, --name

Especifica o nome do projeto que você deseja criar.

--parent-project-path

Especifica o nome do projeto principal para o projeto aninhado, como indicado na opção -n. Por exemplo, para especificar um projeto denominado "aninhado" que existe em um projeto "Principal", use a seguinte sintaxe: --parent-project-path "Main" -n "Nested".

-d, --description

Especifica uma descrição para o projeto.

Opções globais

As opções abaixo são usadas por todos os comandos tabcmd. As opções --server, --user e --password são exigidas pelo menos uma vez para iniciar a sessão. Um token de autenticação é armazenado, de modo que comandos subsequentes possam ser executados sem que essas opções sejam incluídas. Esse token permanece válido por cinco minutos após ter sido usado pelo último comando.

-h, --help

Exibe a ajuda do comando.

Observação: alguns comandos listados podem não ser aplicáveis ao usar o tabcmd com o Tableau Online.

-s, --server

A URL Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-u, --user

O nome de usuário do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-p, --password

A senha do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

--password-file

Permite que a senha seja armazenada no arquivo .txt fornecido, em vez de na linha de comando para aumento da segurança.

-t, --site

Indica que o comando se aplica ao site especificado pela Tableau Online ID do site, entre aspas simples e duplas. Use essa opção caso o usuário especificado esteja associado a mais de um site. A ID de site diferencia maiúsculas e minúsculas ao usar um token de autenticação em cache. Se as letras não corresponderem, você pode ser solicitado a fornecer uma senha, mesmo que o token ainda seja válido.

--no-prompt

Quando especificada, o comando não solicitará uma senha. Se nenhuma senha válida for fornecida, o comando falhará.

--[no-]cookie

Quando especificada, a ID da sessão é salva no logon para que os comandos subsequentes não precisem fazer logon. Use o prefixo no- para não salvar a ID da sessão. A sessão é salva por padrão.

--timeout

Aguarda o número especificado de segundos para que o servidor conclua o processamento do comando. Por padrão, o processo aguardará até que o servidor responda.

--

Especifica o final das opções na linha de comando. Use -- para indicar ao tabcmd que tudo que estiver após -- não deve ser interpretado como uma definição de opção e, em vez disso, pode ser interpretado como um valor para o comando. Isso é útil caso precise especificar um valor no comando que inclui um hífen. O exemplo a seguir mostra como é possível usar -- em um comando tabcmd, onde -430105/Sheet1 é um valor obrigatório para o comando export.

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

createsiteusers filename.csv

Adiciona usuários a um site, com base nas informações fornecidas em um arquivo de valores separados por vírgula (CSV). Se o usuário ainda não tiver sido criado no servidor, o comando cria o usuário antes de adicioná-lo ao site.

O arquivo CSV deve conter um ou mais nomes de usuário e também pode incluir (para cada usuário) senha, nome completo, tipo de licença, nível de administrador, publicador (sim/não) e endereço de e-mail. Pra obter informações sobre o formato do arquivo CSV, consulte Diretrizes do arquivo de importação CSV.

Como uma alternativa à inclusão de permissões a nível do administrador ou publicador no arquivo CSV, é possível transmitir informações a nível de acesso ao incluir a opção --role e especificar a função no site que deseja atribuir aos usuários listados no arquivo CSV.

Por padrão, os usuários são adicionados ao site no qual você está logado. Para adicionar usuários a um site diferente, inclua a opção global --site e especifique esse site. (Você deve ter permissões para criar os usuários no site especificado.)

Exemplo

tabcmd createsiteusers "users.csv" --role "Explorer"

Opções

--admin-type

Preterido. Em vez disso, use a opção --role.

--auth-type

Define o tipo de autenticação (TableauID ou SAML) para todos os usuários no arquivo .csv. Se não for especificada, o padrão é TableauID.

Observação: Para usar a autenticação do SAML, o próprio site deve estar habilitado também para SAML. Para obter informações, consulte Habilitar autenticação SAML em um site.

--[no-]complete

Preterido. Comportamento de erro padrão: se houver mais de 3 erros em um espaço de dez linhas, então o comando falhará.

--no-publisher

Preterido. Em vez disso, use a opção --role.

--nowait

Não espera que os trabalhos assíncronos sejam concluídos.

--publisher

Preterido. Em vez disso, use a opção --role.

--role

Especifica uma função no site para todos os usuários no arquivo .csv. Quando você deseja atribuir funções no site usando a opção --role, crie um arquivo CSV separado para cada função no site.

Os valores válidos são: ServerAdministrator, SiteAdministratorCreator, SiteAdministratorExplorer, SiteAdministrator, Creator, ExplorerCanPublish, Publisher, Explorer, Interactor, Viewer e Unlicensed.

O padrão é Unlicensed para novos usuários e inalterado para usuários existentes. Os usuários são adicionados como não licenciados também no caso de uma instalação de servidor com base em usuário e se o comando createsiteusers criar um novo usuário, mas você já tiver atingido o limite de número de licenças para usuários.

Observação: em um Tableau Server de vários sites, se você deseja atribuir a função no site ServerAdministrator usando a opção --role, use o comando createusers em vez do createsiteusers.

--silent-progress

Não exibe mensagens de progresso para o comando.

Opções globais

As opções abaixo são usadas por todos os comandos tabcmd. As opções --server, --user e --password são exigidas pelo menos uma vez para iniciar a sessão. Um token de autenticação é armazenado, de modo que comandos subsequentes possam ser executados sem que essas opções sejam incluídas. Esse token permanece válido por cinco minutos após ter sido usado pelo último comando.

-h, --help

Exibe a ajuda do comando.

Observação: alguns comandos listados podem não ser aplicáveis ao usar o tabcmd com o Tableau Online.

-s, --server

A URL Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-u, --user

O nome de usuário do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-p, --password

A senha do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

--password-file

Permite que a senha seja armazenada no arquivo .txt fornecido, em vez de na linha de comando para aumento da segurança.

-t, --site

Indica que o comando se aplica ao site especificado pela Tableau Online ID do site, entre aspas simples e duplas. Use essa opção caso o usuário especificado esteja associado a mais de um site. A ID de site diferencia maiúsculas e minúsculas ao usar um token de autenticação em cache. Se as letras não corresponderem, você pode ser solicitado a fornecer uma senha, mesmo que o token ainda seja válido.

--no-prompt

Quando especificada, o comando não solicitará uma senha. Se nenhuma senha válida for fornecida, o comando falhará.

--[no-]cookie

Quando especificada, a ID da sessão é salva no logon para que os comandos subsequentes não precisem fazer logon. Use o prefixo no- para não salvar a ID da sessão. A sessão é salva por padrão.

--timeout

Aguarda o número especificado de segundos para que o servidor conclua o processamento do comando. Por padrão, o processo aguardará até que o servidor responda.

--

Especifica o final das opções na linha de comando. Use -- para indicar ao tabcmd que tudo que estiver após -- não deve ser interpretado como uma definição de opção e, em vez disso, pode ser interpretado como um valor para o comando. Isso é útil caso precise especificar um valor no comando que inclui um hífen. O exemplo a seguir mostra como é possível usar -- em um comando tabcmd, onde -430105/Sheet1 é um valor obrigatório para o comando export.

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

delete workbook-name ou datasource-name

Exclui do servidor a pasta de trabalho ou fonte de dados especificada.

Esse comando captura o nome da pasta de trabalho ou fonte de dados como está no servidor, e não o nome do arquivo de quando ele foi publicado.

Exemplo

tabcmd delete "Sales_Analysis"

Opções

-r, --project

O nome do projeto que contém a pasta de trabalho ou a fonte de dados a ser excluída. Caso não esteja especificado, o projeto “Padrão” será adotado.

--parent-project-path

Especifica o nome do projeto principal para o projeto aninhado, como indicado na opção -r. Por exemplo, para especificar um projeto denominado "aninhado" que existe em um projeto "Principal", use a seguinte sintaxe: --parent-project-path "Main" -r "Nested".

--workbook

O nome da pasta de trabalho que você deseja excluir.

--datasource

O nome da fonte de dados que você deseja excluir.

Opções globais

As opções abaixo são usadas por todos os comandos tabcmd. As opções --server, --user e --password são exigidas pelo menos uma vez para iniciar a sessão. Um token de autenticação é armazenado, de modo que comandos subsequentes possam ser executados sem que essas opções sejam incluídas. Esse token permanece válido por cinco minutos após ter sido usado pelo último comando.

-h, --help

Exibe a ajuda do comando.

Observação: alguns comandos listados podem não ser aplicáveis ao usar o tabcmd com o Tableau Online.

-s, --server

A URL Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-u, --user

O nome de usuário do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-p, --password

A senha do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

--password-file

Permite que a senha seja armazenada no arquivo .txt fornecido, em vez de na linha de comando para aumento da segurança.

-t, --site

Indica que o comando se aplica ao site especificado pela Tableau Online ID do site, entre aspas simples e duplas. Use essa opção caso o usuário especificado esteja associado a mais de um site. A ID de site diferencia maiúsculas e minúsculas ao usar um token de autenticação em cache. Se as letras não corresponderem, você pode ser solicitado a fornecer uma senha, mesmo que o token ainda seja válido.

--no-prompt

Quando especificada, o comando não solicitará uma senha. Se nenhuma senha válida for fornecida, o comando falhará.

--[no-]cookie

Quando especificada, a ID da sessão é salva no logon para que os comandos subsequentes não precisem fazer logon. Use o prefixo no- para não salvar a ID da sessão. A sessão é salva por padrão.

--timeout

Aguarda o número especificado de segundos para que o servidor conclua o processamento do comando. Por padrão, o processo aguardará até que o servidor responda.

--

Especifica o final das opções na linha de comando. Use -- para indicar ao tabcmd que tudo que estiver após -- não deve ser interpretado como uma definição de opção e, em vez disso, pode ser interpretado como um valor para o comando. Isso é útil caso precise especificar um valor no comando que inclui um hífen. O exemplo a seguir mostra como é possível usar -- em um comando tabcmd, onde -430105/Sheet1 é um valor obrigatório para o comando export.

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

deleteextracts

Exclui extrações para uma pasta de trabalho ou fonte de dados publicada.

Opções

-d, --datasource

O nome da fonte de dados de destino para a exclusão de extração.

--embedded-datasources

Uma lista de nomes das fontes de dados inseridas separadas por espaço na pasta de trabalho destino. Coloque nomes de fontes de dados entre aspas duplas se contiverem espaços. Disponível somente ao excluir extrações para uma pasta de trabalho.

--encrypt

Criar extração criptografada.

--include-all

Inclua todas as fontes de dados inseridas na pasta de trabalho de destino.

--parent-project-path

Caminho do projeto principal que contém o recurso de destino. Deve especificar o nome do projeto com --projeto.

--project

O nome do projeto que contém o recurso de destino. Necessário somente se a - pasta de trabalho ou - fonte de dados for especificada. Se não especificado, o projeto padrão 'Default' será usado.

-u, -url

O nome canônico do recurso conforme ele aparece na URL.

-w, -workbook

O nome da pasta de trabalho de destino para a exclusão de extração.

Opções globais

As opções abaixo são usadas por todos os comandos tabcmd. As opções --server, --user e --password são exigidas pelo menos uma vez para iniciar a sessão. Um token de autenticação é armazenado, de modo que comandos subsequentes possam ser executados sem que essas opções sejam incluídas. Esse token permanece válido por cinco minutos após ter sido usado pelo último comando.

-h, --help

Exibe a ajuda do comando.

Observação: alguns comandos listados podem não ser aplicáveis ao usar o tabcmd com o Tableau Online.

-s, --server

A URL Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-u, --user

O nome de usuário do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-p, --password

A senha do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

--password-file

Permite que a senha seja armazenada no arquivo .txt fornecido, em vez de na linha de comando para aumento da segurança.

-t, --site

Indica que o comando se aplica ao site especificado pela Tableau Online ID do site, entre aspas simples e duplas. Use essa opção caso o usuário especificado esteja associado a mais de um site. A ID de site diferencia maiúsculas e minúsculas ao usar um token de autenticação em cache. Se as letras não corresponderem, você pode ser solicitado a fornecer uma senha, mesmo que o token ainda seja válido.

--no-prompt

Quando especificada, o comando não solicitará uma senha. Se nenhuma senha válida for fornecida, o comando falhará.

--[no-]cookie

Quando especificada, a ID da sessão é salva no logon para que os comandos subsequentes não precisem fazer logon. Use o prefixo no- para não salvar a ID da sessão. A sessão é salva por padrão.

--timeout

Aguarda o número especificado de segundos para que o servidor conclua o processamento do comando. Por padrão, o processo aguardará até que o servidor responda.

--

Especifica o final das opções na linha de comando. Use -- para indicar ao tabcmd que tudo que estiver após -- não deve ser interpretado como uma definição de opção e, em vez disso, pode ser interpretado como um valor para o comando. Isso é útil caso precise especificar um valor no comando que inclui um hífen. O exemplo a seguir mostra como é possível usar -- em um comando tabcmd, onde -430105/Sheet1 é um valor obrigatório para o comando export.

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

deletegroup group-name

Exclui do servidor um grupo especificado.

Exemplo

tabcmd deletegroup "Development"

Opções globais

As opções abaixo são usadas por todos os comandos tabcmd. As opções --server, --user e --password são exigidas pelo menos uma vez para iniciar a sessão. Um token de autenticação é armazenado, de modo que comandos subsequentes possam ser executados sem que essas opções sejam incluídas. Esse token permanece válido por cinco minutos após ter sido usado pelo último comando.

-h, --help

Exibe a ajuda do comando.

Observação: alguns comandos listados podem não ser aplicáveis ao usar o tabcmd com o Tableau Online.

-s, --server

A URL Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-u, --user

O nome de usuário do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-p, --password

A senha do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

--password-file

Permite que a senha seja armazenada no arquivo .txt fornecido, em vez de na linha de comando para aumento da segurança.

-t, --site

Indica que o comando se aplica ao site especificado pela Tableau Online ID do site, entre aspas simples e duplas. Use essa opção caso o usuário especificado esteja associado a mais de um site. A ID de site diferencia maiúsculas e minúsculas ao usar um token de autenticação em cache. Se as letras não corresponderem, você pode ser solicitado a fornecer uma senha, mesmo que o token ainda seja válido.

--no-prompt

Quando especificada, o comando não solicitará uma senha. Se nenhuma senha válida for fornecida, o comando falhará.

--[no-]cookie

Quando especificada, a ID da sessão é salva no logon para que os comandos subsequentes não precisem fazer logon. Use o prefixo no- para não salvar a ID da sessão. A sessão é salva por padrão.

--timeout

Aguarda o número especificado de segundos para que o servidor conclua o processamento do comando. Por padrão, o processo aguardará até que o servidor responda.

--

Especifica o final das opções na linha de comando. Use -- para indicar ao tabcmd que tudo que estiver após -- não deve ser interpretado como uma definição de opção e, em vez disso, pode ser interpretado como um valor para o comando. Isso é útil caso precise especificar um valor no comando que inclui um hífen. O exemplo a seguir mostra como é possível usar -- em um comando tabcmd, onde -430105/Sheet1 é um valor obrigatório para o comando export.

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

deleteproject project-name

Exclui do servidor um projeto especificado.

Ao usar tabcmd, só é possível especificar projetos de nível superior na hierarquia de um projeto. Para automatizar tarefas que deseja realizar em um projeto incluso em um projeto principal, use a chamada a API REST(O link abre em nova janela) equivalente do Tableau.

Exemplo

tabcmd deleteproject "Designs"

Opção

--parent-project-path

Especifica o nome do projeto principal para o projeto aninhado, como indicado no comando. Por exemplo, para especificar um projeto denominado "Designs" que existe em um projeto "Principal", use a seguinte sintaxe: --parent-project-path "Main" "Designs".

Opções globais

As opções abaixo são usadas por todos os comandos tabcmd. As opções --server, --user e --password são exigidas pelo menos uma vez para iniciar a sessão. Um token de autenticação é armazenado, de modo que comandos subsequentes possam ser executados sem que essas opções sejam incluídas. Esse token permanece válido por cinco minutos após ter sido usado pelo último comando.

-h, --help

Exibe a ajuda do comando.

Observação: alguns comandos listados podem não ser aplicáveis ao usar o tabcmd com o Tableau Online.

-s, --server

A URL Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-u, --user

O nome de usuário do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-p, --password

A senha do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

--password-file

Permite que a senha seja armazenada no arquivo .txt fornecido, em vez de na linha de comando para aumento da segurança.

-t, --site

Indica que o comando se aplica ao site especificado pela Tableau Online ID do site, entre aspas simples e duplas. Use essa opção caso o usuário especificado esteja associado a mais de um site. A ID de site diferencia maiúsculas e minúsculas ao usar um token de autenticação em cache. Se as letras não corresponderem, você pode ser solicitado a fornecer uma senha, mesmo que o token ainda seja válido.

--no-prompt

Quando especificada, o comando não solicitará uma senha. Se nenhuma senha válida for fornecida, o comando falhará.

--[no-]cookie

Quando especificada, a ID da sessão é salva no logon para que os comandos subsequentes não precisem fazer logon. Use o prefixo no- para não salvar a ID da sessão. A sessão é salva por padrão.

--timeout

Aguarda o número especificado de segundos para que o servidor conclua o processamento do comando. Por padrão, o processo aguardará até que o servidor responda.

--

Especifica o final das opções na linha de comando. Use -- para indicar ao tabcmd que tudo que estiver após -- não deve ser interpretado como uma definição de opção e, em vez disso, pode ser interpretado como um valor para o comando. Isso é útil caso precise especificar um valor no comando que inclui um hífen. O exemplo a seguir mostra como é possível usar -- em um comando tabcmd, onde -430105/Sheet1 é um valor obrigatório para o comando export.

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

deletesiteusers filename.csv

Exclui os usuários do site no qual você está logado. Os usuários que serão removidos são especificados em um arquivo que contém uma lista simples de um nome de usuário por linha. (Nenhuma informação adicional é necessária além do nome do usuário.)

Por padrão, se o servidor tiver apenas um site ou se o usuário pertencer a apenas um site, o usuário também é removido do servidor. Em uma instalação do Tableau Server Enterprise, se o servidor contiver vários sites, os usuários que recebem a função de site de Administrador de servidor são removidos do site, mas não do servidor.

Se o usuário possui conteúdo, a função de usuário é alterada para Não licenciado, mas ele não será removido do servidor ou site. O conteúdo ainda é propriedade desse usuário. Para remover o usuário completamente, você deve alterar o proprietário do conteúdo e, em seguida, tentar removê-lo novamente.

Exemplo

tabcmd deletesiteusers "users.csv"

Opções globais

As opções abaixo são usadas por todos os comandos tabcmd. As opções --server, --user e --password são exigidas pelo menos uma vez para iniciar a sessão. Um token de autenticação é armazenado, de modo que comandos subsequentes possam ser executados sem que essas opções sejam incluídas. Esse token permanece válido por cinco minutos após ter sido usado pelo último comando.

-h, --help

Exibe a ajuda do comando.

Observação: alguns comandos listados podem não ser aplicáveis ao usar o tabcmd com o Tableau Online.

-s, --server

A URL Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-u, --user

O nome de usuário do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-p, --password

A senha do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

--password-file

Permite que a senha seja armazenada no arquivo .txt fornecido, em vez de na linha de comando para aumento da segurança.

-t, --site

Indica que o comando se aplica ao site especificado pela Tableau Online ID do site, entre aspas simples e duplas. Use essa opção caso o usuário especificado esteja associado a mais de um site. A ID de site diferencia maiúsculas e minúsculas ao usar um token de autenticação em cache. Se as letras não corresponderem, você pode ser solicitado a fornecer uma senha, mesmo que o token ainda seja válido.

--no-prompt

Quando especificada, o comando não solicitará uma senha. Se nenhuma senha válida for fornecida, o comando falhará.

--[no-]cookie

Quando especificada, a ID da sessão é salva no logon para que os comandos subsequentes não precisem fazer logon. Use o prefixo no- para não salvar a ID da sessão. A sessão é salva por padrão.

--timeout

Aguarda o número especificado de segundos para que o servidor conclua o processamento do comando. Por padrão, o processo aguardará até que o servidor responda.

--

Especifica o final das opções na linha de comando. Use -- para indicar ao tabcmd que tudo que estiver após -- não deve ser interpretado como uma definição de opção e, em vez disso, pode ser interpretado como um valor para o comando. Isso é útil caso precise especificar um valor no comando que inclui um hífen. O exemplo a seguir mostra como é possível usar -- em um comando tabcmd, onde -430105/Sheet1 é um valor obrigatório para o comando export.

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

export

Exporta uma exibição ou pasta de trabalho do Tableau Online e a salva em um arquivo. Esse comando também pode exportar apenas os dados usados para uma exibição. Os dados de visualização são exportados no nível de resumo. Para exportar dados detalhados, você deve usar a interface de usuário do Tableau Server. Para obter detalhes, consulte Baixar exibições e pastas de trabalho(O link abre em nova janela).

Observe o seguinte quando for usar esse comando:

  • Permissões: Para exportar, você deve ter a permissão Exportar imagem. Por padrão, essa permissão é autorizada ou herdada para todas as funções, embora as permissões possam ser definidas por pasta de trabalho ou exibição.

  • Exportando dados: Para exportar apenas os dados para uma exibição, use a opção --csv. Ela exporta os dados de resumo usados em uma exibição para um arquivo .csv.

  • Como especificar a exibição, a pasta de trabalho ou os dados a serem exportados:

    • Use parte da URL para identificar o que será exportado, especialmente a cadeia de caracteres "workbook/view" já que ela aparece na URL da pasta de trabalho ou da exibição. Não use o “nome amigável” e exclua a ID de sessão :iid=<n> do final da URL.

      Por exemplo, a exibição de amostra do Tableau Temperaturas globais na pasta de trabalho Regional tem uma URL parecida com essa: <server_name>/#/views/Regional/GlobalTemperatures?:iid=3

      Para exportar a exibição Global Temperatures, use a cadeia de caracteres Regional/GlobalTemperatures.

      Nãouse Regional/Global Temperatures ou Regional/GlobalTemperatures?:iid=3.

    • Se o servidor executa vários sites e a exibição ou a pasta de trabalho está em um site que não seja o Padrão, use -t <site_id>.

    • Para exportar uma pasta de trabalho, obtenha a cadeia de caracteres da URL ao abrir uma exibição da pasta e a inclua na cadeia que for usar.

      No exemplo acima, para exportar a pasta de trabalho Regional, use a cadeia de caracteres Regional/GlobalTemperatures.

    • Para exportar uma pasta de trabalho, ela deve ter sido publicada com a opção Mostrar planilhas como guias selecionada na caixa de diálogo Publicar do Tableau Desktop.

      Observação: não é possível exportar a pasta de trabalho do Tableau que contém as exibições administrativas(O link abre em nova janela).

    • Para filtrar os dados que você baixa, adicione um filtro de parâmetro usando este formato:

      ?<filter_name>=value

      ou, se filtrar em um parâmetro e esse parâmetro tiver um nome de exibição que corresponda ao nome de uma medida ou dimensão:

      ?Parameters.<filter_name>=value

  • O formato do arquivo salvo: Suas opções de formato dependem do que está sendo exportado. Uma pasta de trabalho somente pode ser exportada como um PDF, usando o argumento --fullpdf. É possível exportar uma exibição como um PDF (--pdf) ou um PNG (--png).

  • O nome e o local do arquivo salvo (opcional): Se você não informar um nome, ele será derivado do nome de exibição ou pasta de trabalho. Se você não informar um local, o arquivo será salvo em seu diretório de trabalho atual. Caso contrário, você poderá especificar um caminho completo ou um que seja relativo ao seu diretório de trabalho atual.

    Observação: você deve incluir uma extensão de nome de arquivo, por exemplo, .csv ou .pdf. O comando não adiciona automaticamente uma extensão ao nome de arquivo que você fornece.

  • Objetos de página da Web do painel não incluídos em exportações para PDF: Um painel pode conter opcionalmente um objeto de página da Web. Se você estiver executando uma exportação para PDF de um painel que contém um objeto de página da Web, esse objeto não será incluído no PDF.

  • Caracteres não-ASCII e não padrão e exportações de PDF: se você tiver exportando uma exibição ou pasta de trabalho com um nome que inclua um caractere fora do conjunto de caracteres ASCII ou não padrão, será necessário codificar o caractere com URL (ou codificar com percentual).

    Por exemplo, se o seu comando inclui a cidade Zürich, é necessário codificá-lo com URL como Z%C3%BCrich:

    tabcmd export "/Cities/Sheet1?locationCity=Z%C3%BCrich" -fullpdf

Limpeza do cache para usar dados em tempo real

Opcionalmente, você pode adicionar o parâmetro de URL ?:refresh=yes para forçar uma consulta de dados atualizados em vez de extrair os resultados do cache. Se você estiver usando o tabcmd com seu próprio script e o parâmetro de URL refresh estiver sendo muito usado, isso poderá prejudicar o desempenho. É recomendável usar refresh somente quando dados em tempo real são necessários, por exemplo, em um painel único em vez de uma pasta de trabalho inteira.

Exemplos

Exibições

tabcmd export "Q1Sales/Sales_Report" --csv -f "Weekly-Report.csv"

tabcmd export -t Sales "Sales/Sales_Analysis" --pdf -f "C:\Tableau_Workbooks\Weekly-Reports.pdf"

tabcmd export "Finance/InvestmentGrowth" --png

tabcmd export "Finance/InvestmentGrowth?:refresh=yes" --png

Pastas de trabalho

tabcmd export "Q1Sales/Sales_Report" --fullpdf

tabcmd export "Sales/Sales_Analysis" --fullpdf --pagesize tabloid -f "C:\Tableau_Workbooks\Weekly-Reports.pdf"

Opções

-f, --filename

Salva o arquivo com o nome de arquivo e extensão fornecidos.

--csv

Somente exibição. Exporte os dados da exibição (dados de resumo) no formato.csv.

--pdf

Somente exibição. Exportar como PDF.

--png

Somente exibição. Exportar como imagem em formato.png.

--fullpdf

Somente pasta de trabalho. Exportar como PDF. É preciso que a pasta de trabalho tenha sido publicada com a opção Mostrar planilhas como guias habilitada.

--pagelayout

Define a orientação da página (landscape ou portrait) do PDF exportado. Se não especificada, sua configuração do Tableau Desktop será usada.

--pagesize

Define o tamanho da página do PFD exportado como o seguinte: unspecified, letter, legal, note folio, tabloid, ledger, statement, executive, a3, a4, a5, b4, b5 ou quarto. O padrão é letter.

--width

Define a largura em pixels. O padrão é 800 px.

--height

Define a altura em pixels. O padrão é 600 px.

Opções globais

As opções abaixo são usadas por todos os comandos tabcmd. As opções --server, --user e --password são exigidas pelo menos uma vez para iniciar a sessão. Um token de autenticação é armazenado, de modo que comandos subsequentes possam ser executados sem que essas opções sejam incluídas. Esse token permanece válido por cinco minutos após ter sido usado pelo último comando.

-h, --help

Exibe a ajuda do comando.

Observação: alguns comandos listados podem não ser aplicáveis ao usar o tabcmd com o Tableau Online.

-s, --server

A URL Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-u, --user

O nome de usuário do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-p, --password

A senha do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

--password-file

Permite que a senha seja armazenada no arquivo .txt fornecido, em vez de na linha de comando para aumento da segurança.

-t, --site

Indica que o comando se aplica ao site especificado pela Tableau Online ID do site, entre aspas simples e duplas. Use essa opção caso o usuário especificado esteja associado a mais de um site. A ID de site diferencia maiúsculas e minúsculas ao usar um token de autenticação em cache. Se as letras não corresponderem, você pode ser solicitado a fornecer uma senha, mesmo que o token ainda seja válido.

--no-prompt

Quando especificada, o comando não solicitará uma senha. Se nenhuma senha válida for fornecida, o comando falhará.

--[no-]cookie

Quando especificada, a ID da sessão é salva no logon para que os comandos subsequentes não precisem fazer logon. Use o prefixo no- para não salvar a ID da sessão. A sessão é salva por padrão.

--timeout

Aguarda o número especificado de segundos para que o servidor conclua o processamento do comando. Por padrão, o processo aguardará até que o servidor responda.

--

Especifica o final das opções na linha de comando. Use -- para indicar ao tabcmd que tudo que estiver após -- não deve ser interpretado como uma definição de opção e, em vez disso, pode ser interpretado como um valor para o comando. Isso é útil caso precise especificar um valor no comando que inclui um hífen. O exemplo a seguir mostra como é possível usar -- em um comando tabcmd, onde -430105/Sheet1 é um valor obrigatório para o comando export.

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

get url

Obtém o recurso de Tableau Online que é representado pela URL (parcial) especificada. O resultado é retornado como um arquivo.

Observe o seguinte quando for usar esse comando:

  • Permissões: para obter um arquivo, você deve ter a permissão Baixar/salvar na Web como. Por padrão, essa permissão é autorizada ou herdada para todas as funções, embora as permissões possam ser definidas por pasta de trabalho ou exibição.

  • Especificando uma exibição ou pasta de trabalho para obter: você pode especificar uma exibição para obter usando a cadeia de caracteres "/views/<workbookname>/<viewname>.<extension>"e especificar uma pasta de trabalho para obter usando a cadeia de caracteres "/workbooks/<workbookname>.<extension>". Substitua <workbookname> e <viewname> com os nomes da pasta de trabalho e exibição, à medida que aparecem na URL, quando você abre a exibição em um navegador e substitui <extension> pelo tipo de arquivo que deseja salvar. Não use a ID da sessão no final da URL (?:iid=<n>) ou o nome "amigável"da pasta de trabalho ou exibição.

    Por exemplo, ao abrir Totais regionais de uma exibição em uma pasta de trabalho chamada Resumo de métricas, a URL ficará parecida com:

    /views/MetricsSummary_1/RegionalTotals?:iid=1

    Use a cadeia de caracteres /views/MetricsSummary_1/RegionalTotals.<extension> para obter a exibição.

    Use a cadeia de caracteres /workbooks/MetricsSummary_1.<extension> para obter a pasta de trabalho.

  • Extensão do arquivo: a URL deve incluir uma extensão de arquivo. A extensão determina o que é retornado. Uma exibição pode ser retornada no formato PDF, PNG ou CSV (somente dados de resumo). Uma pasta de trabalho do Tableau retorna como TWB se ele se conectar a uma fonte de dados publicada ou usar uma conexão ativa, ou um TWBX caso se conecte a uma extração de dados.

    Observação: se você estiver baixando uma exibição para um arquivo PDF ou PNG e incluir um parâmetro --filename com a extensão .pdf ou .png, não será necessário incluir uma extensão .pdf ou .png na URL.

  • O nome e o local do arquivo salvo (opcional): o nome que você usa para --filename deve incluir a extensão do arquivo. Se você não informar um nome e extensão de arquivo, ambos serão derivados da cadeia de caracteres de URL. Se você não informar um local, o arquivo será salvo em seu diretório de trabalho atual. Caso contrário, você poderá especificar um caminho completo ou um que seja relativo ao seu diretório de trabalho atual.

  • Tamanho do PNG (opcional): se o arquivo salvo estiver em PNG, você poderá especificar o tamanho, em pixels, na URL.

Limpeza do cache para usar dados em tempo real

Opcionalmente, você pode adicionar o parâmetro de URL ?:refresh=yes para forçar uma consulta de dados atualizados em vez de extrair os resultados do cache. Se você estiver usando o tabcmd com seu próprio script, usar demais o parâmetro refresh poderá ter um impacto negativo sobre o desempenho. É recomendável usar refresh somente quando dados em tempo real são necessários, por exemplo, em um painel único em vez de uma pasta de trabalho inteira.

Exemplos

Exibições

tabcmd get "/views/Sales_Analysis/Sales_Report.png" --filename "Weekly-Report.png"

tabcmd get "/views/Finance/InvestmentGrowth.pdf" -f "Q1Growth.pdf"

tabcmd get "/views/Finance/InvestmentGrowth" -f "Q1Growth.pdf"

tabcmd get "/views/Finance/InvestmentGrowth.csv"

tabcmd get "/views/Finance/InvestmentGrowth.png?:size=640,480" -f growth.png

tabcmd get "/views/Finance/InvestmentGrowth.png?:refresh=yes" -f growth.png

Pastas de trabalho

tabcmd get "/workbooks/Sales_Analysis.twb" -f "C:\Tableau_Workbooks\Weekly-Reports.twb"

Opções globais

As opções abaixo são usadas por todos os comandos tabcmd. As opções --server, --user e --password são exigidas pelo menos uma vez para iniciar a sessão. Um token de autenticação é armazenado, de modo que comandos subsequentes possam ser executados sem que essas opções sejam incluídas. Esse token permanece válido por cinco minutos após ter sido usado pelo último comando.

-h, --help

Exibe a ajuda do comando.

Observação: alguns comandos listados podem não ser aplicáveis ao usar o tabcmd com o Tableau Online.

-s, --server

A URL Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-u, --user

O nome de usuário do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-p, --password

A senha do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

--password-file

Permite que a senha seja armazenada no arquivo .txt fornecido, em vez de na linha de comando para aumento da segurança.

-t, --site

Indica que o comando se aplica ao site especificado pela Tableau Online ID do site, entre aspas simples e duplas. Use essa opção caso o usuário especificado esteja associado a mais de um site. A ID de site diferencia maiúsculas e minúsculas ao usar um token de autenticação em cache. Se as letras não corresponderem, você pode ser solicitado a fornecer uma senha, mesmo que o token ainda seja válido.

--no-prompt

Quando especificada, o comando não solicitará uma senha. Se nenhuma senha válida for fornecida, o comando falhará.

--[no-]cookie

Quando especificada, a ID da sessão é salva no logon para que os comandos subsequentes não precisem fazer logon. Use o prefixo no- para não salvar a ID da sessão. A sessão é salva por padrão.

--timeout

Aguarda o número especificado de segundos para que o servidor conclua o processamento do comando. Por padrão, o processo aguardará até que o servidor responda.

--

Especifica o final das opções na linha de comando. Use -- para indicar ao tabcmd que tudo que estiver após -- não deve ser interpretado como uma definição de opção e, em vez disso, pode ser interpretado como um valor para o comando. Isso é útil caso precise especificar um valor no comando que inclui um hífen. O exemplo a seguir mostra como é possível usar -- em um comando tabcmd, onde -430105/Sheet1 é um valor obrigatório para o comando export.

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

logon

Um usuário do Tableau Online faz logon.

Use as opções globais --server, --site, --username, --password para criar uma sessão.

Observação: quando você usa o comando tabcmd login, não é possível usar o logon único (SSO, single-sign-on) do SAML, mesmo se o site estiver configurado para usar o SAML. Para entrar, você deve inserir o nome de usuário e senha de um usuário criado no seu site. Você terá as permissões do usuário do Tableau Server pelo qual está logado.

Se quiser fazer logon usando as mesmas informações que já foram usadas para criar uma sessão, basta especificar a opção --password. Serão usados o nome de usuário e servidor armazenados no cookie.

Se o servidor estiver usando uma porta diferente de 80 (o padrão), você deverá especificá-la.

Você só precisa da opção --site (-t) quando o servidor está executando vários sites e você está se conectando a um site que não seja o padrão. Se você não fornecer uma senha, uma será solicitada. Se a opção --no-prompt for especificada e nenhuma senha for fornecida, o comando falhará.

Após o logon, a sessão continuará até expirar no servidor ou até que o comando logout seja executado.

Exemplo

Faça logon no site do Tableau Online usando a ID do site especificada:

tabcmd login -s https://online.tableau.com -t siteID -u user@email.com -p password

Opções

-s, --server

Se o comando for executado de um computador com o Tableau Server que faça parte da rede, é possível usar http://localhost. Caso contrário, especifique a URL do computador, por exemplo, http://bigbox.myco.com ou http://bigbox.

Se o servidor estiver usando SSL, você precisará especificar https:// na URL do computador.

No Tableau Online especifique a URL https://online.tableau.com.

-t, --site

Inclua essa opção caso o servidor tenha vários sites e você esteja fazendo logon em um site que não seja o padrão.

A ID do site é usada na URL para identificá-lo com exclusividade. Por exemplo, um site chamado West Coast Sales pode ter uma ID west-coast-sales.

-u, --username

O nome de usuário do usuário que faz o logon. Para o Tableau Online, o nome de usuário é o endereço de e-mail do usuário.

-p, --password

Senha do usuário especificada para --username. Se você não fornecer uma senha, uma será solicitada.

--password-file

Permite que a senha seja armazenada no arquivo fornecido filename.txt em vez de na linha de comando para aumento da segurança.

-x, --proxy

Use para especificar o servidor proxy HTTP e a porta (Host:Porta) para a solicitação de tabcmd.

--no-prompt

Não solicite uma senha. Se nenhuma senha for especificada, o comando login falhará.

--cookie

Salva a ID de sessão no logon. Os comandos subsequentes não exigirão logon. Este valor é o padrão para o comando.

--no-cookie

Não salve as informações de ID da sessão após um logon bem-sucedido. Os comandos subsequentes exigirão logon.

--timeout SECONDS

O número de segundos que o servidor deve esperar antes de processar o comando login. Padrão: 30 segundos.

Opções globais

As opções abaixo são usadas por todos os comandos tabcmd. As opções --server, --user e --password são exigidas pelo menos uma vez para iniciar a sessão. Um token de autenticação é armazenado, de modo que comandos subsequentes possam ser executados sem que essas opções sejam incluídas. Esse token permanece válido por cinco minutos após ter sido usado pelo último comando.

-h, --help

Exibe a ajuda do comando.

Observação: alguns comandos listados podem não ser aplicáveis ao usar o tabcmd com o Tableau Online.

-s, --server

A URL Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-u, --user

O nome de usuário do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-p, --password

A senha do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

--password-file

Permite que a senha seja armazenada no arquivo .txt fornecido, em vez de na linha de comando para aumento da segurança.

-t, --site

Indica que o comando se aplica ao site especificado pela Tableau Online ID do site, entre aspas simples e duplas. Use essa opção caso o usuário especificado esteja associado a mais de um site. A ID de site diferencia maiúsculas e minúsculas ao usar um token de autenticação em cache. Se as letras não corresponderem, você pode ser solicitado a fornecer uma senha, mesmo que o token ainda seja válido.

--no-prompt

Quando especificada, o comando não solicitará uma senha. Se nenhuma senha válida for fornecida, o comando falhará.

--[no-]cookie

Quando especificada, a ID da sessão é salva no logon para que os comandos subsequentes não precisem fazer logon. Use o prefixo no- para não salvar a ID da sessão. A sessão é salva por padrão.

--timeout

Aguarda o número especificado de segundos para que o servidor conclua o processamento do comando. Por padrão, o processo aguardará até que o servidor responda.

--

Especifica o final das opções na linha de comando. Use -- para indicar ao tabcmd que tudo que estiver após -- não deve ser interpretado como uma definição de opção e, em vez disso, pode ser interpretado como um valor para o comando. Isso é útil caso precise especificar um valor no comando que inclui um hífen. O exemplo a seguir mostra como é possível usar -- em um comando tabcmd, onde -430105/Sheet1 é um valor obrigatório para o comando export.

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

logout

Faz logout no servidor.

Exemplo

tabcmd logout

publish filename.twb(x), filename.tds(x), or filename.hyper

Publica a pasta de trabalho (.twb(x)), fonte de dados (.tds(x)) ou extração (.hyper) especificadas no Tableau Online.

Por padrão, se você estiver publicando uma pasta de trabalho, todas as planilhas da pasta de trabalho serão publicadas sem nomes de usuário ou senhas de banco de dados.

As permissões inicialmente atribuídas à pasta de trabalho ou fonte de dados são copiadas do projeto onde o arquivo é publicado. As permissões para o recurso publicado podem ser alteradas depois que o arquivo for publicado. 

Se a pasta de trabalho contiver filtros de usuário, será preciso especificar uma das opções de miniatura.

Exemplo

tabcmd publish "analysis_sfdc.hyper" -n "Sales Analysis"
--oauth-username "user-name" --save-oauth

Se o arquivo não estiver no mesmo diretório de tabcmd, inclua o caminho completo do arquivo.

Exemplo

tabcmd publish "\\computer\volume\Tableau Workbooks\analysis_sfdc.hyper" -n "Sales Analysis" --oauth-username "username" --save-oauth

Opções

-n, --name

Nome da pasta de trabalho ou fonte de dados no servidor. Se omitida, a pasta de trabalho, fonte de dados ou extração de dados terá o nome do arquivo.

-o, --overwrite

Substitui a pasta de trabalho, fonte de dados ou extração de dados se ela já existir no servidor.

-r, --project

Publica a pasta de trabalho, fonte de dados ou extração de dados no projeto especificado. Publica no projeto “padrão” se não for especificado.

--parent-project-path

Especifica o nome do projeto principal para o projeto aninhado, como indicado na opção -r. Por exemplo, para especificar um projeto denominado "aninhado" que existe em um projeto "Principal", use a seguinte sintaxe: --parent-project-path "Main" -r "Nested".

--db-username

Use essa opção para publicar um nome de usuário de banco de dados com a pasta de trabalho, fonte de dados ou extração de dados.

Se você se conectar aos dados por meio de uma conexão OAuth protegida e acessar o token, use a opção--oauth-username.

--db-password

Use essa opção para publicar uma senha de banco de dados com a pasta de trabalho, fonte de dados ou extração.

--save-db-password

Armazena a senha de banco de dados fornecida no servidor.

--oauth-username

Endereço de e-mail da conta do usuário. Conecta o usuário por meio de uma conexão OAuth pré-configurada, caso o usuário já tenha um token de acesso salvo para a fonte de dados na nuvem especificada em --name. Os tokens de acesso são gerenciados nas preferências do usuário.

Para conexões OAuth existentes com a fonte de dados, use essa opção em vez de --db-username e --db-password.

--save-oauth

Salva a credencial especificada por --oauth-username como credencial inserida na pasta de trabalho ou fonte de dados publicada.

Subsequentemente, quando o publicador ou administrador do servidor faz logon no servidor e edita a conexão dessa pasta de trabalho ou fonte de dados, as configurações da conexão mostrarão essa credencial OAuth como inserida no conteúdo.

Se quiser agendar atualizações de extração após publicar, você precisará incluir essa opção em --oauth-username. Isso é análogo a usar --save-db-password com uma conexão de banco de dados tradicional.

--thumbnail-username

Se a pasta de trabalho contiver filtros de usuário, as miniaturas serão geradas com base no que o usuário especificado pode ver. Não pode ser especificada quando a opção --thumbnail-group estiver definida.

--thumbnail-group

Se a pasta de trabalho contiver filtros de usuário, as miniaturas serão geradas com base no que o grupo especificado pode ver. Não pode ser especificada quando a opção --thumbnail-username estiver definida.

--tabbed

Quando uma pasta de trabalho com exibições com guias é publicada, cada planilha torna-se uma guia que os visualizadores podem usar para navegar pela pasta de trabalho. Observe que essa configuração substituirá qualquer segurança no nível de planilha.

--append

Anexa o arquivo de extração à fonte de dados existente.

--replace

Usa o arquivo de extração para substituir a fonte de dados existente.

--disable-uploader

Desabilita o carregador de arquivos incremental.

--restart

Reinicia o upload do arquivo.

Opções globais

As opções abaixo são usadas por todos os comandos tabcmd. As opções --server, --user e --password são exigidas pelo menos uma vez para iniciar a sessão. Um token de autenticação é armazenado, de modo que comandos subsequentes possam ser executados sem que essas opções sejam incluídas. Esse token permanece válido por cinco minutos após ter sido usado pelo último comando.

-h, --help

Exibe a ajuda do comando.

Observação: alguns comandos listados podem não ser aplicáveis ao usar o tabcmd com o Tableau Online.

-s, --server

A URL Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-u, --user

O nome de usuário do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-p, --password

A senha do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

--password-file

Permite que a senha seja armazenada no arquivo .txt fornecido, em vez de na linha de comando para aumento da segurança.

-t, --site

Indica que o comando se aplica ao site especificado pela Tableau Online ID do site, entre aspas simples e duplas. Use essa opção caso o usuário especificado esteja associado a mais de um site. A ID de site diferencia maiúsculas e minúsculas ao usar um token de autenticação em cache. Se as letras não corresponderem, você pode ser solicitado a fornecer uma senha, mesmo que o token ainda seja válido.

--no-prompt

Quando especificada, o comando não solicitará uma senha. Se nenhuma senha válida for fornecida, o comando falhará.

--[no-]cookie

Quando especificada, a ID da sessão é salva no logon para que os comandos subsequentes não precisem fazer logon. Use o prefixo no- para não salvar a ID da sessão. A sessão é salva por padrão.

--timeout

Aguarda o número especificado de segundos para que o servidor conclua o processamento do comando. Por padrão, o processo aguardará até que o servidor responda.

--

Especifica o final das opções na linha de comando. Use -- para indicar ao tabcmd que tudo que estiver após -- não deve ser interpretado como uma definição de opção e, em vez disso, pode ser interpretado como um valor para o comando. Isso é útil caso precise especificar um valor no comando que inclui um hífen. O exemplo a seguir mostra como é possível usar -- em um comando tabcmd, onde -430105/Sheet1 é um valor obrigatório para o comando export.

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

refreshextracts workbook-name or datasource-name

Faz uma atualização completa ou incremental de extrações que pertencem à pasta de trabalho ou fonte de dados especificada.

Esse comando captura o nome da pasta de trabalho ou fonte de dados como ele aparece no servidor, e não o nome do arquivo quando ele foi publicado. Apenas um administrador ou o proprietário da pasta de trabalho ou fonte de dados tem permissão para executar essa operação.

Observações: 

Exemplos

tabcmd refreshextracts --datasource sales_ds

tabcmd refreshextracts --project "Sales External" --datasource sales_ds

tabcmd refreshextracts --project "Sales External" --parent-project-path "Main" --project "Sales External" --datasource sales_ds

tabcmd refreshextracts --workbook "My Workbook"

tabcmd refreshextracts --url SalesAnalysis

tabcmd refreshextracts --workbook "My Workbook" --addcalculations

tabcmd refreshextracts --datasource sales_ds --removecalculations

Opções

--incremental

Executa a operação de atualização incremental.

--synchronous

Adiciona a operação de atualização completa à fila usada pelo processador em segundo plano para ser executada assim que o processador em segundo plano estiver disponível. Se um processador em segundo plano estiver disponível, a operação é executada imediamente. A operação de atualização aparece no relatório de Tarefas em segundo plano.

Durante uma atualização síncrona, o tabcmd mantém uma conexão em tempo real com o servidor, enquanto a operação de atualização está em andamento, sondando a cada segundo até que o trabalho em segundo plano esteja concluído.

--workbook

O nome da pasta de trabalho que contém extrações para atualização. Se a pasta de trabalho tiver espaços no nome, coloque-o entre aspas.

--datasource

O nome da fonte de dados que contém extrações para atualização.

--project

" --workbook ou --datasource para identificar uma pasta de trabalho ou fonte de dados em um projeto que não seja o padrão. Caso não esteja especificado, o projeto Padrão será adotado.

--parent-project-path

Especifica o nome do projeto principal para o projeto aninhado, como indicado na opção --project.

Por exemplo:

  • Para especificar um projeto denominado "aninhado" que existe em um projeto "Principal", use a seguinte sintaxe:
  • --parent-project-path "Main" --project "Nested"
  • Para especificar um projeto chamado "Aninhado2" que está aninhado dentro do projeto "Aninhado": 
  • --parent-project-path "Main/Nested" --project "Nested2"

--url

O nome da pasta de trabalho conforme ele aparece no URL. Uma pasta de trabalho publicada como “Análise de vendas” tem um nome de URL “SalesAnalysis”.

--addcalculations

Use com --workbook para materializar os cálculos na extração inserida da pasta de trabalho ou --datasource para materializar os cálculos na fonte de dados de extração. Adiciona a operação à consulta usada pelo processo do processador em segundo plano. Se um processador em segundo plano estiver disponível, a operação é executada imediatamente. Essa operação aparece na exibição administrativa Tarefas em segundo plano para extrações .

--removecalculations

Use com --workbook ou --datasource para remover cálculos que foram materializados previamente. Adiciona a operação à consulta usada pelo processo do processador em segundo plano. Se um processador em segundo plano estiver disponível, a operação é executada imediatamente. Essa operação aparece na exibição administrativa Tarefas em segundo plano para extrações .

Opções globais

As opções abaixo são usadas por todos os comandos tabcmd. As opções --server, --user e --password são exigidas pelo menos uma vez para iniciar a sessão. Um token de autenticação é armazenado, de modo que comandos subsequentes possam ser executados sem que essas opções sejam incluídas. Esse token permanece válido por cinco minutos após ter sido usado pelo último comando.

-h, --help

Exibe a ajuda do comando.

Observação: alguns comandos listados podem não ser aplicáveis ao usar o tabcmd com o Tableau Online.

-s, --server

A URL Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-u, --user

O nome de usuário do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-p, --password

A senha do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

--password-file

Permite que a senha seja armazenada no arquivo .txt fornecido, em vez de na linha de comando para aumento da segurança.

-t, --site

Indica que o comando se aplica ao site especificado pela Tableau Online ID do site, entre aspas simples e duplas. Use essa opção caso o usuário especificado esteja associado a mais de um site. A ID de site diferencia maiúsculas e minúsculas ao usar um token de autenticação em cache. Se as letras não corresponderem, você pode ser solicitado a fornecer uma senha, mesmo que o token ainda seja válido.

--no-prompt

Quando especificada, o comando não solicitará uma senha. Se nenhuma senha válida for fornecida, o comando falhará.

--[no-]cookie

Quando especificada, a ID da sessão é salva no logon para que os comandos subsequentes não precisem fazer logon. Use o prefixo no- para não salvar a ID da sessão. A sessão é salva por padrão.

--timeout

Aguarda o número especificado de segundos para que o servidor conclua o processamento do comando. Por padrão, o processo aguardará até que o servidor responda.

--

Especifica o final das opções na linha de comando. Use -- para indicar ao tabcmd que tudo que estiver após -- não deve ser interpretado como uma definição de opção e, em vez disso, pode ser interpretado como um valor para o comando. Isso é útil caso precise especificar um valor no comando que inclui um hífen. O exemplo a seguir mostra como é possível usar -- em um comando tabcmd, onde -430105/Sheet1 é um valor obrigatório para o comando export.

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

removeusers group-name

Remove usuários do grupo especificado.

Exemplo

tabcmd removeusers "Development" --users "users.csv"

Opções

--users

Remove os usuários no arquivo.csv fornecido do grupo especificado. O arquivo deve ser uma lista simples com um nome de usuário por linha.

Se usar esse comando em arquivos.csv grandes no Tableau Server, um administrador de servidor pode habilitar configurações que ajudem a melhorar o desempenho. Para mais informações, consulte Diretrizes do arquivo de importação CSV

--[no-]complete

Exige que todas as linhas sejam válidas para que qualquer alteração seja bem-sucedida. Se não especificada, --complete será usada.

Opções globais

As opções abaixo são usadas por todos os comandos tabcmd. As opções --server, --user e --password são exigidas pelo menos uma vez para iniciar a sessão. Um token de autenticação é armazenado, de modo que comandos subsequentes possam ser executados sem que essas opções sejam incluídas. Esse token permanece válido por cinco minutos após ter sido usado pelo último comando.

-h, --help

Exibe a ajuda do comando.

Observação: alguns comandos listados podem não ser aplicáveis ao usar o tabcmd com o Tableau Online.

-s, --server

A URL Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-u, --user

O nome de usuário do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-p, --password

A senha do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

--password-file

Permite que a senha seja armazenada no arquivo .txt fornecido, em vez de na linha de comando para aumento da segurança.

-t, --site

Indica que o comando se aplica ao site especificado pela Tableau Online ID do site, entre aspas simples e duplas. Use essa opção caso o usuário especificado esteja associado a mais de um site. A ID de site diferencia maiúsculas e minúsculas ao usar um token de autenticação em cache. Se as letras não corresponderem, você pode ser solicitado a fornecer uma senha, mesmo que o token ainda seja válido.

--no-prompt

Quando especificada, o comando não solicitará uma senha. Se nenhuma senha válida for fornecida, o comando falhará.

--[no-]cookie

Quando especificada, a ID da sessão é salva no logon para que os comandos subsequentes não precisem fazer logon. Use o prefixo no- para não salvar a ID da sessão. A sessão é salva por padrão.

--timeout

Aguarda o número especificado de segundos para que o servidor conclua o processamento do comando. Por padrão, o processo aguardará até que o servidor responda.

--

Especifica o final das opções na linha de comando. Use -- para indicar ao tabcmd que tudo que estiver após -- não deve ser interpretado como uma definição de opção e, em vez disso, pode ser interpretado como um valor para o comando. Isso é útil caso precise especificar um valor no comando que inclui um hífen. O exemplo a seguir mostra como é possível usar -- em um comando tabcmd, onde -430105/Sheet1 é um valor obrigatório para o comando export.

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

runschedule schedule-name

Executa a agenda especificada.

Esse comando captura o nome da agenda como está no servidor.

Esse comando não está disponível para o Tableau Online.

Observação: este método falhará e resultará em um erro se o Administrador do servidor tiver desativado a configuração Executar agora para o site. Para obter mais informações, consulte Configurações do Tableau Server(O link abre em nova janela).

Exemplo

tabcmd runschedule "5AM Sales Refresh"

Opções globais

As opções abaixo são usadas por todos os comandos tabcmd. As opções --server, --user e --password são exigidas pelo menos uma vez para iniciar a sessão. Um token de autenticação é armazenado, de modo que comandos subsequentes possam ser executados sem que essas opções sejam incluídas. Esse token permanece válido por cinco minutos após ter sido usado pelo último comando.

-h, --help

Exibe a ajuda do comando.

Observação: alguns comandos listados podem não ser aplicáveis ao usar o tabcmd com o Tableau Online.

-s, --server

A URL Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-u, --user

O nome de usuário do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

-p, --password

A senha do Tableau Online, que é exigida pelo menos uma vez para iniciar a sessão.

--password-file

Permite que a senha seja armazenada no arquivo .txt fornecido, em vez de na linha de comando para aumento da segurança.

-t, --site

Indica que o comando se aplica ao site especificado pela Tableau Online ID do site, entre aspas simples e duplas. Use essa opção caso o usuário especificado esteja associado a mais de um site. A ID de site diferencia maiúsculas e minúsculas ao usar um token de autenticação em cache. Se as letras não corresponderem, você pode ser solicitado a fornecer uma senha, mesmo que o token ainda seja válido.

--no-prompt

Quando especificada, o comando não solicitará uma senha. Se nenhuma senha válida for fornecida, o comando falhará.

--[no-]cookie

Quando especificada, a ID da sessão é salva no logon para que os comandos subsequentes não precisem fazer logon. Use o prefixo no- para não salvar a ID da sessão. A sessão é salva por padrão.

--timeout

Aguarda o número especificado de segundos para que o servidor conclua o processamento do comando. Por padrão, o processo aguardará até que o servidor responda.

--

Especifica o final das opções na linha de comando. Use -- para indicar ao tabcmd que tudo que estiver após -- não deve ser interpretado como uma definição de opção e, em vez disso, pode ser interpretado como um valor para o comando. Isso é útil caso precise especificar um valor no comando que inclui um hífen. O exemplo a seguir mostra como é possível usar -- em um comando tabcmd, onde -430105/Sheet1 é um valor obrigatório para o comando export.

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

Agradecemos seu feedback!