tabcmd

Observação: O utilitário de linha de comando tabcmd versão 2.0 está disponível em Tabcmd do Tableau(O link abre em nova janela). Essa nova versão permite executar comandos tabcmd no MacOS e Linux e autenticar usando tokens de acesso pessoal (PATs). A versão 2.0 é baseada em endpoints públicos disponíveis no Tableau Server Client (TSC) baseado em Python. Essa versão mais recente tem suporte limitado ao Tableau Server.

O Tableau fornece o utilitário de linha de comando tabcmd que pode ser usado para automatizar tarefas de administração do site no seu site do Tableau Server. Por exemplo, criar ou excluir usuários, projetos e grupos.

Observação: nas versões do Tableau anteriores a 2024.1, o tabcmd versão 1 não funciona para exportar visualizações.

Esse utilitário está incluso no Tableau Server e é instalado automaticamente nos nós do servidor. Também é possível executá-lo de outros computadores, mesmo aqueles que não fazem parte da sua instalação do Tableau Server, mas para fazer isso é necessário baixar o instalador do tabcmd do site do Tableau. Para obter mais informações, consulte Instalar tabcmd abaixo.

Instalar tabcmd

Observação: estas instruções são para instalar o utilitário de linha de comando tabcmd 1.0. Para instalar o utilitário de linha de comando tabcmd 2.0, vá para Tableau tabcmd(O link abre em nova janela) (nova janela).

Ao atualizar o Tableau Server ou o Tableau Cloud para uma nova versão, se uma versão atualizada do tabcmd for exigida, é possível baixá-la da página de Versões do Tableau Server, no site do Tableau.

Para o Tableau Server , recomendamos que você baixe a versão que corresponde à versão do seu servidor. Para o Tableau Cloud, recomendamos que você sempre baixe a versão mais recente para evitar problemas causados por incompatibilidades de versão. Em ambos os casos, usar uma versão desatualizada do tabcmd pode causar erros e resultados imprevisíveis.

  1. Abra um navegador da Web e vá para a página Versões do Tableau Server.(O link abre em nova janela) Acesse esta página mesmo que você use o Tableau Online.

  2. Se você estiver usando:

    Em ambos os casos, se as informações expandidas mostrarem as versões de manutenção, selecione a mais recente ou a que corresponde à versão de seu servidor.

    Selecione a versão do servidor que você usa (versão mais recente do Tableau Cloud)

    Você será redirecionado à página de notas de versão, chamada Problemas resolvidos, onde poderá ler sobre as melhorias de segurança e os problemas resolvidos.

  3. Nos problemas resolvidos, navegue até a seção Baixar arquivos e selecione o link de download do tabcmd compatível com o computador no qual você executará os comandos. 

    Selecione o instalador tabcmd para o computador em que você o usará (32 ou 64 bits)

    As etapas restantes se referem a este computador como "o computador do tabcmd”.

  4. Salve o instalador no computador do tabcmd ou em uma localização acessível a partir daquele computador (um drive montado, por exemplo).

  5. Conclua as etapas de instalação como adequado para o sistema operacional do computador do tabcmd.

    • Windows

      Por padrão, tabcmd é instalado em C:\Program Files\Tableau\Tableau Server\<version>\extras\Command Line Utility. É possível alterar isso durante a instalação e recomendar a instalação do tabcmd em uma pasta chamada tabcmd na raiz da unidade C:\ (C:\tabcmd). Isso pode facilitar a localização e a execução e acomodará algumas limitações com o sistema operacional Windows, se você adicionar o diretório tabcmd ao Windows PATH.

      Observação: o programa de instalação do tabcmd não adiciona o diretório tabcmd à variável PATH do Windows. Você pode adicionar manualmente, ou incluir o caminho completo para tabcmd sempre que chamá-lo.

      É possível instalar o tabcmd de duas maneiras no Windows:

      • Clique duas vezes no instalador para seguir as etapas na interface do usuário:

        1. Aceite o contrato de licença.

        2. Se você quiser instalar em um local não padrão, clique em Personalizar e digite ou navegue até o local em que deseja instalar o tabcmd.

        3. Clique em Instalar.

          Se o prompt do Windows Defender Firewall ou Controle de conta do usuário for exibido, clique em Permitir acesso.

      • Execute o instalador no prompt de comando:

        1. Abra um prompt de comando como um administrador no computador do tabcmd.

        2. Navegue até o diretório onde você copiou o instalador do tabcmd.

        3. Instale o tabcmd:

          tableau-setup-tabcmd-tableau-<version_code>-x64.exe /quiet ACCEPTEULA=1

          Para instalar em um local não padrão:

          tableau-setup-tabcmd-tableau-<version_code>-x64.exe /quiet ACCEPTEULA=1 INSTALLDIR="<path\to\install\directory>"

          Por exemplo:

          tableau-setup-tabcmd-tableau-<version_code>-x64.exe /quiet ACCEPTEULA=1 INSTALLDIR="C:\tabcmd"

          Para obter uma lista completa das opções da linha de comando que você pode usar com o instalador do tabcmd, execute o instalador com um /?. Para obter mais informações sobre as opções da linha de comando do instalador do tabcmd, consulte Instalar switches e propriedades do tabcmd (Windows).

      O programa de Configuração do tabcmd cria registros em C:\Users\<user>\AppData\Local\Temp que você pode usar, se tiver problemas para instalar o tabcmd. Os registros usam a convenção de nomenclatura Tableau_Server_Command_Line_Utility_(<version_code>)_##############.log.

    • Linux

      Observação: para executar o tabcmd em um computador Linux, você deve instalar o Java 11. Em sistemas semelhantes ao RHEL, ele será instalado como uma dependência ao instalar o tabcmd. Em sistemas Ubuntu, você precisa instalar o Java 11 separadamente, se ele ainda não estiver instalado.

      A partir de julho de 2022, as distribuições Debian não são mais aceitas. Para obter mais informações, consulte a postagem da Comunidade do Tableau(O link abre em nova janela).

      1. Faça logon como um usuário com acesso sudo ao computador do tabcmd.

      2. Navegue até o diretório onde você copiou o pacote de .rpm ou .deb baixado.

        • Em distribuições em RHEL, incluindo o CentOS, execute o comando a seguir:

          sudo yum install tableau-tabcmd-<version>.noarch.rpm

        • Em Ubuntu, execute o seguinte comando:

          sudo apt-get install ./tableau-tabcmd-<version>_all.deb

    Para desinstalar o tabcmd de um computador Linux, consulte a documentação da variedade Linux que você está executando.

  6. (Opcional) Adicione o local totalmente qualificado onde o tabcmd está instalado no caminho do sistema para permitir que você execute comandos tabcmd sem alterar para esse local ou especificar o local com cada comando. As etapas para fazer isso dependem do tipo e da versão do sistema operacional. Para obter mais informações, consulte PATH_(variável).

Como usar o tabcmd

As etapas básicas para usar o tabcmd são as seguintes:

  1. Abra o prompt de comando como um administrador.

    Observação: não use o PowerShell para executar comandos tabcmd no Windows. O uso do PowerShell pode causar um comportamento inesperado.

  2. Em um computador com Windows, se o tabcmd foi instalado em um computador que não seja o nó inicial, altere para o diretório em que o tabcmd foi instalado.

    Em um computador com Linux, não é necessário mudar para o diretório de instalação.

  3. Execute o comando tabcmd.

Ao usar o tabcmd, você deve estabelecer uma sessão de servidor autenticado. A sessão identifica o site do servidor ou do Tableau Cloud e o usuário que a executa. Você pode iniciar uma sessão primeiro e especificar seu comando em seguida, ou você pode iniciar uma sessão e executar o comando de uma vez.

Importante: caso esteja usando o tabcmd para executar mais de uma tarefa, você deve executar uma tarefa após a outra (em série), em vez de ao mesmo tempo (em paralelo).

Os comandos (como login) e as opções (como -s, -u, etc.) não diferenciam maiúsculas de minúsculas, mas os valores fornecidos por você (como User@Example.com) diferenciam maiúsculas de minúsculas.

Exemplos

O comando a seguir demonstra como iniciar uma sessão com o Tableau Server chamada tabserver.mycompany.com:

tabcmd login -s http://tabserver.mycompany.com -u admin -p mypassword

O próximo exemplo mostra um comando que exclui uma pasta de trabalho chamada Sales_Workbook:

tabcmd delete "Sales_Workbook" 

Confira aqui como fazer tudo o que foi descrito acima com um comando; observe que não é preciso usar login aqui:

tabcmd delete "Sales_Workbook" -s http://tabserver.mycompany.com -u admin -p mypassword 

Um Tableau Server pode executar vários sites. Quando uma pasta de trabalho está no site Padrão de um servidor de vários sites, não é preciso especificar Padrão, o comando acima é suficiente. No entanto, se o comando se aplicar somente a algo em um site diferente do Padrão, você deverá especificar a ID desse site (consulte logon). Este é o mesmo comando para uma pasta de trabalho que está no site West Coast Sales (ID de site wsales):

tabcmd delete "Sales_Workbook" -s http://tabserver.mycompany.com -t wsales -u admin -p mypassword 

As opções -s, -t, -u, e -p estão entre as variáveis globais do tabcmd, que podem ser usadas com qualquer comando.

Para obter mais informações, consulte Comandos tabcmd.

Mensagens e registros de status

Quando um comando for bem-sucedido, o tabcmd retornará um código de status de zero. Uma mensagem de erro completa para códigos de status diferentes de zero é impressa para stderr. Além disso, as mensagens de progresso ou informativas podem ser impressas para stdout.

Um registro completo chamado tabcmd.log que inclui depuração, progresso e mensagens de erro é gravado em <home dir>/.tableau/tabcmd/.

Importante: o suporte do Tableau não consegue solucionar problemas que só são reproduzíveis em scripts personalizados. Para obter ajuda com seus scripts personalizados, visite os fóruns da comunidade do Tableau.

Agradecemos seu feedback!Seu feedback foi enviado. Obrigado!