tabcmd

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: o utilitário tabcmd está incluído com o Tableau Server, no entanto, seu instalador não. Se quiser executá-lo em um computador diferente do nó do servidor inicial, é necessário baixar o instalador no site do Tableau. Para obter mais informações, consulte Instalar tabcmd abaixo.

Instalar tabcmd

Ao atualizar o Tableau Server ou o Tableau Online 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, no site do Tableau, para evitar problemas causados por incompatibilidades de versão. Usar uma versão desatualizada do tabcmd pode causar erros e resultados imprevisíveis.

  1. Abra um navegador da Web e acesse a página Versões do Tableau Server (faça isso mesmo se usar o Tableau Online).

  2. Para o Tableau Online: selecione a versão mais recente.

    Para o Tableau Server (Windows ou Linux): selecione a versão que corresponde à versão do seu servidor.

    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.

    Select the server version you use (latest release for Tableau Online)

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

    Observação: se precisar do instalador tabcmd para uma versão do Tableau Server anterior a 10.1, ele é fornecido na instalação do servidor. Consulte a observação acima.

  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. 

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

    Select the tabcmd installer for the computer you'll use it on (32- or 64-bit)

  4. Salve o instalador no computador do tabcmd ou em uma localização acessível a partir daquele computador .

  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.

    • Linux
      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 e Debian, execute o seguinte comando:

          sudo gdebi -n tableau-tabcmd-<version>_all.deb

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.

  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 Online 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 C:\Users\<username>\AppData\Local\Tableau.

Outros artigos nesta seção

Agradecemos seu feedback! Ocorreu um erro ao enviar o feedback. Tente novamente ou envie-nos uma mensagem.