Atualizar arquivos de saída de fluxo a partir da linha de comando

Observação: o conteúdo neste tópico só se aplica ao Tableau Prep Builder.

É possível executar o fluxo a partir da linha de comando para atualizar a saída de fluxo em vez de executar o fluxo a partir do Tableau Prep Builder. Você pode executar um fluxo de cada vez usando esse método. Essa opção está disponível em computadores com Windows ou Mac onde o Tableau Prep Builder está instalado.

Observação: se você usar autenticação Single Sign-On, não será possível execução de fluxos da linha de comando. Em vez disso, é possível executar os fluxos do Tableau Prep Builder.

Limitações do conector:

  • Conectores JDBC ou ODBC: os fluxos que incluem esses conectores podem ser executados pela linha de comando a partir da versão 2019.2.3.
  • Conectores de nuvem: os fluxos que incluem conectores de nuvem, como o Google BigQuery, não podem ser executados pela linha de comando. Em vez disso, execute o fluxo manualmente ou em uma agenda no Tableau Server ou no Tableau Online usando o Tableau Prep Conductor. Para obter mais informações, consulte Manter dados de fluxo atualizados.

Para computadores Windows, também é possível agendar esse processo usando o Agendador de tarefas do Windows. Para obter mais informações, consulte Agendador de tarefas(Link opens in a new window) na ajuda on-line da Microsoft.

Ao executar fluxos a partir da linha de comando, o Tableau Prep Builder atualiza todas as saídas do fluxo usando as configurações das etapas de saída especificadas no Tableau Prep Builder. Para obter mais informações sobre como especificar os locais de saída, consulte Criar arquivos de extração de dados e fontes de dados publicadas(Link opens in a new window). Para obter informações sobre como definir as opções de gravação (versão 2020.2.1 e posteriores), consulte Configurar opções de gravação.

Antes de executar o fluxo

Para executar o fluxo a partir da linha de comando, você precisará de privilégios de administrador na máquina onde está executando o fluxo, e precisará das seguintes informações:

  • O caminho onde o Tableau Prep Builder está instalado.

  • Se você estiver se conectando a bancos de dados e publicando arquivos de saída em um servidor ou um banco de dados (versão 2020.3.1 e posterior), crie um arquivo .json de credenciais que inclua todas as credenciais necessárias.

  • O caminho onde o arquivo de fluxo do Tableau (.tfl) está localizado.

Requisitos de arquivos de credenciais .json

Observação: os arquivos de credenciais .json não são necessários se o fluxo se conectar a ou resultar em arquivos de saída, arquivos armazenados em um compartilhamento de rede ou arquivos de entrada que usam a Autenticação do Windows (SSPI). Para obter mais informações sobre a Autenticação do Windows, consulte Modelo SSPI(Link opens in a new window) na ajuda on-line da Microsoft.

O Tableau Prep Builder usa informações do arquivo de fluxo e do arquivo .json de credenciais para executar o fluxo quando você tiver conexões remotas. Por exemplo, o nome do banco de dados das conexões remotas e o nome do projeto dos arquivos de saída são provenientes do fluxo; o nome do servidor e as credenciais de logon são provenientes do arquivo .json de credenciais.

  • Caso planeje reusar o arquivo, coloque-o em uma pasta onde ele não seja substituído pelo processo de instalação do Tableau Prep Builder.
  • Se você estiver executando um fluxo que abranja qualquer uma das situações abaixo, precisará acrescentar um arquivo .json que contenha as credenciais necessárias para se conectar.
    • Conexão com arquivos de banco de dados ou fontes de dados publicadas.
    • A saída é publicada em um servidor ou em um banco de dados (versão 2020.3.1 e posteriores).
    • O fluxo inclui etapas de script para Rserve ou TabPy. O arquivo .json deve incluir as credenciais necessárias para se conectar a esses serviços. Para obter mais informações, consulte os requisitos de matriz da sua versão abaixo.
  • As credenciais especificadas no fluxo e as credenciais incluídas no seu arquivo .json devem coincidir; caso contrário, o fluxo não será executado.
  • Ao executar o processo, o nome de host, a porta e o nome de usuário são usados para encontrar a conexão correspondente no arquivo de fluxo do Tableau (tfl) e atualizados antes de executar o processo. A ID da porta e a ID do site são opcionais se suas conexões não solicitarem essas informações.
  • Se estiver se conectando a uma fonte de dados publicada, inclua hostname, contentUrl e porta (80 para http e 443 para https) nas conexões de entrada. O nome do host é necessário para localizar a conexão correspondente no arquivo de fluxo do Tableau (TFL), e o contentUrl e a porta são usados para estabelecer a conexão com o servidor.

  • Se você se conectar ao Tableau Online, inclua a porta (80 ou 443) nas conexões de entrada do pod ao qual você está conectando. Para obter mais informações sobre o Tableau Online, consulte as Conexões do Tableau Bridge com o Tableau Online(Link opens in a new window) na Ajuda do Tableau Online.

Dependendo da sua versão do Tableau Prep Builder, suas informações de credencial podem ser formatadas de forma diferente. Clique na guia abaixo para visualizar o formato de credencial para sua versão do Tableau Prep Builder.

Dependendo de suas conexões, inclua suas credenciais de servidor ou banco de dados ou de ambos. Quando seu fluxo se conecta a e resulta no mesmo servidor ou banco de dados, você só precisa incluir um único bloco no arquivo .json. Se você se conectar a um servidor ou banco de dados que usa diferentes credenciais, use uma matriz delimitada por vírgula.

Conexões de servidor Conexões de banco de dados Conexões Rserver ou Tableau Python

Nome do bloco de conexão: "tableauServerConnections"

Inclua os seguintes dados na matriz:

  • serverUrl (nome do servidor)
  • contentUrl (ID do site. Isso aparece depois de /site/ na URL do Tableau Server ou do Tableau Online. Por exemplo, "https://my.server/#/site/mysite", defina "contentUrl": "mysite".))
  • porta (ID da porta)
  • username
  • senha

Nome do bloco de conexão: "databaseConnections"

Inclua os seguintes dados na matriz:

  • hostname (nome do servidor)
  • porta (ID da porta)
  • username
  • senha

Só inclua essa matriz se o seu fluxo tiver etapas de script para R ou TabPy.

Nome do bloco de conexão: "extensions"

Inclua os seguintes dados na matriz:

  • extensionName: especifique "rSupport" ou "pythonSupport"
  • regular: inclua "host" e "port". Você também pode incluir "username" (nome de usuário) ou "sslCertificate" (conteúdo do seu arquivo público .pem codificado como cadeia de caracteres base64) se aplicável.
  • sensitive: inclua "password" se você usar uma senha. Caso contrário, inclua uma matriz em branco.

Observação: ContentUrl é sempre necessário no arquivo .json para conexões do servidor. Se estiver se conectando a um site padrão, por exemplo, "https://my.server/#/site/", defina ContentUrl como em branco. Por exemplo, "contentUrl": ""

Exemplos

Esta seção mostra exemplos diferentes de arquivos de credenciais que você pode criar usando os requisitos de credenciais .json.

Conectar-se a um servidor

Este exemplo mostra um arquivo de credenciais .json que se conecta a e resulta em uma conexão de servidor que usa as mesmas credenciais:

{
 "tableauServerConnections":[
   {
    "serverUrl":"https://my.server",
    "contentUrl": "mysite",
    "port":443,
    "username": "jsmith",
    "password": "passw0rd$"
   }
 ]
}				

Conectar-se a uma conexão de servidor e saída para uma conexão de banco de dados

Este exemplo mostra um arquivo de credenciais .json que se conecta a um servidor e resulta em uma conexão de banco de dados:

{
 "tableauServerConnections":[
   {
    "serverUrl":"https://my.server",
    "contentUrl": "mysite",
    "port":443,
    "username": "jsmith",
    "password": "passw0rd$"
   }
],
 "databaseConnections":[
   {
    "hostname":"example123.redshift.amazonaws.com",
    "port":"5439",
    "username":"jsmith",
    "password":"p@s$w0rd!"
   }
 ]
}

O fluxo inclui conexões de script Rserve e TabPy e saídas para uma conexão de banco de dados

Este exemplo mostra um arquivo de credenciais .json que inclui credenciais Rserve e TabPy e resulta em uma conexão a um banco de dados:

{
 "extensions": [
    {
	  "extensionName": "rSupport",
	  "regular": {
		"host": "localhost",
		"port": "9000",
		"username": "jsmith"
	},
	"sensitive": {	
	  "password": "pwd"	
	}
   },
   {
	"extensionName": "pythonSupport",
	"regular": {
	  "host": "localhost",
	  "port": "9000"
	},
	"sensitive": {
	}
   }
 ],										
 "databaseConnections":[
   {
    "hostname":"example123.redshift.amazonaws.com",
    "port": "5439",
    "username": "jsmith",
    "password": "p@s$w0rd!"
   },
   {
    "hostname":"mysql.mydb.tsi.lan",
    "port": "3306",
    "username": "jsmith",
    "password": "mspa$$w0rd"
   }
 ]
}			

Conectar a e resultar em diferentes conexões de banco de dados

Este exemplo mostra um arquivo de credenciais .json que se conecta a e resulta em diferentes conexões de banco de dados:

{
 "databaseConnections":[
{
  "hostname":"example123.redshift.amazonaws.com",
  "port": "5439",
  "username": "jsmith",
  "password": "p@s$w0rd!"
 },
 {
   "hostname":"mysql.mydb.tsi.lan",
   "port": "3306",
   "username": "jsmith",
   "password": "mspa$$w0rd"
  }
 ]
}			

Digite uma matriz para suas conexões de entrada e saída.

Observação: se você usar o Tableau Prep Builder versão 2018.2.2 à 2018.3.1, sempre inclua as matrizes "inputConnections" e "outputConnections", mesmo se o fluxo não tiver conexões remotas para entradas e saídas. Deixe essas matrizes em branco. Se você estiver usando o Tableau Prep Builder versão 2018.3.2 e posteriores, não será necessário incluir matrizes em branco.

Conexões de entrada Conexões de saída Conexões Rserver ou Tableau Python
  • hostname (nome do servidor)
  • contentUrl (sempre necessário para fontes de dados publicadas. Consulte Conexões de saída para obter a descrição.)
  • porta (ID da porta)
  • username
  • senha
  • serverUrl
  • contentUrl (ID do site. Isso aparece depois de /site/ na URL do Tableau Server ou do Tableau Online. Por exemplo, "https://my.server/#/site/mysite", defina "contentUrl": "mysite".)
  • username
  • senha

Só inclua essa matriz se o seu fluxo tiver etapas de script para R ou TabPy que requerem uma senha.

  • extensionName: especifique "rSupport" ou "pythonSupport"
  • credentials: incluir "password” (senha).

Exemplos

Esta seção mostra dois exemplos diferentes de arquivos de credenciais que você pode criar usando os requisitos de credenciais .json.

Conectar a uma fonte de dados publicada

Este exemplo mostra um arquivo de credenciais .json que se conecta a uma fonte de dados publicada e produz dados para um servidor que inclui uma ID do site

Observação: se inputConnection ou outputConnection usar o site Padrão, por exemplo, "https://my.server/#/site/”, defina ContentUrl como em branco. Por exemplo, "contentUrl": ""

{ 
  "inputConnections":[
    {
     "hostname":"https://my.server",
     "contentUrl": "mysite",
     "port":443,								
     "username": "jsmith",
     "password": "passw0rd$"
    }
 ],
  "outputConnections":[
    {
     "serverUrl":"https://my.server",
     "contentUrl":"mysite",
     "username":"jsmith",
     "password":"passw0rd$"
    }
 ]
}

Conectar a dois bancos de dados

Este exemplo mostra um arquivo de credenciais .json que se conecta ao MySQL e Oracle e os dados de saída são enviados a um servidor que inclui uma ID de site.

{ 
  "inputConnections":[
    {
     "hostname":"mysql.example.lan",
     "port":1234,
     "username": "jsmith",				
     "password": "passw0rd"
  },
    {
     "hostname":"Oracle.example.lan",
     "port":5678,
     "username": "jsmith",				
     "password": "passw0rd" 
  }
], 
  "outputConnections":[
    {
     "serverUrl":"http://my.server",
     "contentUrl":"mysite",
     "username":"jsmith",
     "password":"passw0rd$"
    } 
  ]
}

O fluxo inclui etapas de script para Rserve e TabPy e se conecta a um banco de dados

O exemplo a seguir mostra um arquivo de credenciais .json que inclui a senha para serviços Rserve e TabPy e se conecta ao MySQL.

{ 
  "inputConnections":[
    {
     "hostname":"mysql.example.lan",
     "port":1234,
     "username": "jsmith",				
     "password": "passw0rd"
  }
], 
  "extensions":[
    {
     "extensionName":"rSupport",
     "credentials":{
     "password":"pwd",
    }
  },
   {
	"extensionName" : "pythonSupport",
	"credentials": {
	"password": "pwd"
	}
   } 
  ]
}

Dicas para criar seu arquivo de credenciais

Para evitar erros ao executar o fluxo, certifique-se de que seu arquivo de credenciais siga as diretrizes a seguir:

  • Se você usar o Tableau Prep Builder versão 2018.2.2 à 2018.3.1, sempre inclua as matrizes "inputConnections" e "outputConnections", mesmo se o fluxo não tiver conexões remotas para entradas e saídas. Deixe essas matrizes em branco.

    Se estiver usando o Tableau Prep Builder versão 2018.3.2 e posteriores, não é necessário incluir a matriz em branco.

    • Nenhuma conexão de entrada remota? Inclua esta sintaxe no início do arquivo .json

      {
       "inputConnections":[
        ],
    • Nenhuma conexão de saída remota? Inclua esta sintaxe no fim do arquivo .json

    • "outputConnections":[
        ]
      }
  • Não há ID de porta para sua conexão de entrada ou a porta está especificada como parte do nome do servidor.

    Se não houver ID de porta para sua conexão, não inclua a referência "port":xxxx, no arquivo .json, nem mesmo "port": "". Se a ID de porta estiver incluída no nome do servidor, inclua-a no nome do host. Por exemplo, "hostname": "mssql.example.lan,1234"

  • Ao fazer referência ao "serverUrl": não inclua uma "/" no fim do endereço. Por exemplo, use este "serverUrl": "http://server", não este "serverUrl": "http://server/".

  • Se você tiver várias conexões de entrada e saída, inclua as credenciais de cada uma no arquivo.

  • Se estiver se conectando a fontes de dados publicadas, inclua o nome do host e contentUrl nas conexões de entrada.

Executar o fluxo

Importante: os exemplos abaixo incluem a alteração do nome de "Tableau Prep" versão 2019.1.2 para "Tableau Prep Builder". Se estiver usando uma versão anterior do produto, use o "Tableau Prep".

  1. Abra o prompt de comando ou o prompt de comando Terminal (MacOS) como um Administrador.

  2. Execute um dos seguintes comandos usando a sintaxe mostrada abaixo.

    • O fluxo se conecta a arquivos locais ou arquivos armazenados em um compartilhamento de rede e publica a arquivos locais, arquivos armazenados em um compartilhamento de rede ou usa a autenticação do Windows:

      Observação: se você estiver se conectando a ou gerando arquivos armazenados em um compartilhamento de rede, use o formato UNC para o caminho: \\server\path\file name. Ele não pode ser protegido por senha.

      Windows

                                           "\[Tableau Prep Builder install location]\Tableau Prep Builder <version>\scripts"\tableau-prep-cli.bat -t "path\to\[your flow file name].tfl"
                                      

      Mac

                                          /Applications/Tableau\ Prep\ Builder\ [Tableau Prep Builder version].app/Contents/scripts/./tableau-prep-cli -t path/to/[your flow file name].tfl
                                      
    • O fluxo se conecta a bancos de dados ou publica em um servidor:

      Windows

                                          "\[Tableau Prep Builder install location]\Tableau Prep Builder <version>\scripts"\tableau-prep-cli.bat -c "path\to\[your credential file name].json" -t "path\to\[your flow file name].tfl"
                                      

      Mac

                                          /Applications/Tableau\ Prep\ Builder\ [Tableau Prep Builder version].app/Contents/scripts/./tableau-prep-cli -c path/to/[your credential file name].json -t path/to/[your flow file name].tfl
                                      
    • O arquivo de fluxo ou arquivo de credenciais estão armazenados em um compartilhamento de rede (use o formato UNC para o caminho: \\server\path\file name):

      Windows

                                          "\[Tableau Prep Builder install location]\Tableau Prep Builder <version>\scripts"\tableau-prep-cli.bat -c "\server\path\[your credential file name].json" -t "\server\path\[your flow file name].tfl"
                                      

      Mac: mapeie o compartilhamento de rede para /Volumes no Finder para que seja persistente, em seguida use /Volumes/.../[your file] para especificar o caminho:

                                          /Applications/Tableau\ Prep\ Builder\ [Tableau Prep Builder version].app/Contents/scripts/./tableau-prep-cli -c /Volumes/.../[your credential file name].json -t path/to/[your flow file name].tfl
                                      

Para erros e soluções comuns, consulte Erros comuns ao usar a linha de comando para executar fluxos.

Executar o fluxo com a atualização incremental ativada (versão 2020.2.1 e posteriores)

Se você não tiver o Tableau Prep Conductor ativado no servidor para agendar as execuções de fluxo, poderá executar o fluxo usando a atualização incremental a partir da linha de comando. Basta incluir o parâmetro --incrementalRefresh na linha de comando, como mostrado no exemplo abaixo.

Windows

                     "\[Tableau Prep Builder install location]\Tableau Prep Builder <version>\scripts"\tableau-prep-cli.bat --incrementalRefresh -t "path\to\[your flow file name].tfl"
                

Mac

                    /Applications/Tableau\ Prep\ Builder\ [Tableau Prep Builder version].app/Contents/scripts/./tableau-prep-cli --incrementalRefresh -t path/to/[your flow file name].tfl
                

Se as etapas de entrada no fluxo tiverem a atualização incremental ativada e os parâmetros de atualização incremental estiverem configurados corretamente, o Tableau Prep Builder fará o seguinte:

  • Todas as entradas no fluxo que tenham a atualização incremental ativada executarão todas as saídas correspondentes usando a atualização incremental.
  • Se nenhuma entrada no fluxo tiver a atualização incremental ativada, todas as saídas serão executadas usando a atualização completa. Uma mensagem mostrará detalhes sobre o método de atualização.
  • Se algumas entradas no fluxo tiverem a atualização incremental ativada, as saídas correspondentes serão executadas usando a atualização incremental. As outras saídas serão executadas usando a atualização completa e uma mensagem mostrará detalhes sobre o método de atualização.

Para obter mais informações sobre a configuração de fluxos para usar a atualização incremental, consulte Atualizar dados de fluxo usando a atualização incremental

Opções de comando

Caso deseje exibir as opções de ajuda, inclua -h na linha de comando.

Opções de comando Descrição Observações
-c , --connections <arg> O caminho da conexão para o arquivo de credenciais. Requer o caminho onde o arquivo de credenciais está localizado.
-d, --debug Depure o processo do fluxo. Inclua essa opção para visualizar mais informações para ajudar a solucionar um problema com a atualização do fluxo. Os arquivos de registro estão armazenados em: My Tableau Prep Builder Repository\Command Line Repository\Logs
-dsv, --disableSslValidation Desabilitar a validação de SSL (MacOS) Ao executar fluxos usando a linha de comando no MacOS, uma caixa de diálogo pode solicitar o usuário e a senha das chaves. A partir da versão 2019.3.2 do Tableau Prep Builder, você pode passar esse parâmetro adicional para desabilitar essa caixa de diálogo de chaves. Por exemplo: /Applications/Tableau\ Prep\ Builder\ [Tableau Prep Builder version].app/Contents/scripts/./tableau-prep-cli -dsv -c path/to/[your credential file name].json -t path/to/[your flow file name].tfl
-h, --help Veja a ajuda para as opções de sintaxe

A opção de ajuda ou um erro de sintaxe mostra as seguintes informações:

usage: tableau-prep-cli [-c <arg>] [-d]  [-h] [-t <arg>]
-c,--connections <arg>        Path to a file with all connection information
-d,--debug                    This option is for debugging
-dsv,--disableSslValidation   Disable SSL validation
-h,--help                     Print usage message
-inc,--incrementalRefresh     Run incremental refresh for all outputs that are configured to support it
-t,--tflFile <arg>            The Tableau Prep Builder flow file	
-inc, --incrementalRefresh Execute a atualização incremental em todas as saídas configuradas para usá-la.

Inclua essa opção para executar a atualização incremental em todas as entradas configuradas para usá-la. A atualização incremental permite que o Tableau Prep Builder recupere e processe apenas novas linhas, em vez de todas as linhas do fluxo.

As definições de configuração da atualização incremental nas etapas de entrada determinam quais saídas de fluxo podem ser executadas de forma incremental. Todas as outras saídas serão executadas usando a atualização completa e uma mensagem mostrará detalhes sobre o método de atualização.

Para obter mais informações sobre a execução de fluxos usando a atualização incremental, consulte Atualizar dados de fluxo usando a atualização incremental.

-t, --tflFile <arg> O arquivo de fluxo .tfl Requer o caminho onde o arquivo de fluxo .tfl está localizado.

Exemplos de sintaxe

As linhas de comando abaixo mostram quatro exemplos diferentes para executar um fluxo usando o critério a seguir:

  • Tableau Prep Builder versão: 2020.3.1

    Importante: os exemplos abaixo incluem a alteração do nome de Tableau Prep versão 2019.1.2 para Tableau Prep Builder. Se estiver usando uma versão anterior do produto, use o "Tableau Prep".

  • Nome do fluxo: Flow1.tfl

  • Local do fluxo: C:\Users\jsmith\Documents\My Tableau Prep Builder Repository\Flows

  • Nome do arquivo de credenciais: Flow 1.json

  • Local do arquivo de credenciais: C:\Users\jsmith\Desktop\Flow credentials

  • Local do arquivo de credenciais armazenados em um compartilhamento de rede: \tsi.lan\files\Flow credentials

O fluxo se conecta a e publica em arquivos locais

Windows

                    "\Program Files\Tableau\Tableau Prep Builder 2020.3.1\scripts"\tableau-prep-cli.bat -t "\C:\Users\jsmith\Documents\My Tableau Prep Builder Repository\Flows\Flow1.tfl"
                

Mac

                    /Applications/Tableau\ Prep\ Builder\ 2020.3.1.app/Contents/scripts/./tableau-prep-cli -t /Users/jsmith/Documents/My\ Tableau\ Prep\ Builder\ Repository/Flows.Flow1.tfl
                

O fluxo se conecta e publica em arquivos locais e usa a forma curta da atualização incremental

Windows

                    "\Program Files\Tableau\Tableau Prep Builder 2020.3.1\scripts"\tableau-prep-cli.bat -inc -t "\C:\Users\jsmith\Documents\My Tableau Prep Builder Repository\Flows\Flow1.tfl"
                

Mac

                    /Applications/Tableau\ Prep\ Builder\ 2020.3.1.app/Contents/scripts/./tableau-prep-cli -inc -t /Users/jsmith/Documents/My\ Tableau\ Prep\ Builder\ Repository/Flows.Flow1.tfl
                

O fluxo se conecta a bancos de dados e publica em um servidor

Windows

                    "\Program Files\Tableau\Tableau Prep Builder 2020.3.1\scripts"\tableau-prep-cli.bat -c "\C:\Users\jsmith\Desktop\Flow credentials\Flow1.json" -t "\C:\Users\jsmith\Documents\My Tableau Prep Builder Repository\Flows\Flow1.tfl"
                

Mac

                    /Applications/Tableau\ Prep\ Builder\ 2020.3.1.app/Contents/scripts/./tableau-prep-cli -c /Users/jsmith/Desktop/Flow\ credentials/Flow1.json -t /Users/jsmith/Documents/My\ Tableau\ Prep\ Builder\ Repository/Flows.Flow1.tfl
                

O fluxo publica em um servidor e o arquivo de credenciais é armazenado em um compartilhamento de rede

Windows

                    "\Program Files\Tableau\Tableau Prep Builder 2020.3.1\scripts"\tableau-prep-cli.bat -c "\\tsi.lan\files\Flow credentials\Flow1.json" -t "\C:\Users\jsmith\Documents\My Tableau Prep Builder Repository\Flows\Flow1.tfl"
                

Mac

                    /Applications/Tableau\ Prep\ Builder\ 2020.3.1.app/Contents/scripts/./tableau-prep-cli -c /Volumes/files/Flow\ credentials/Flow1.json -t /Users/jsmith/Documents/My\ Tableau\ Prep\ Builder\ Repository/Flows.Flow1.tfl
                
Agradecemos seu feedback! Ocorreu um erro ao enviar o feedback. Tente novamente.