Ajuda do Tableau Server no Windows

Você pode executar comandos tsm no nó inicial (o nó onde o TSM está instalado) ou em qualquer nó adicional no cluster.

Para executar comandos tsm, é necessário abrir um prompt de comando do Windows. Não use o PowerShell para executar comandos tsm. O uso do PowerShell pode causar um comportamento inesperado.

1. Abra o prompt de comando do Windows com uma conta que seja membro do grupo de Administradores em um nó no cluster.

2. Execute o comando desejado. Se você estiver executando o comando de um nó diferente do nó inicial, inclua a opção -s para especificar a URL do nó inicial por nome (não por endereço IP) e inclua a porta do TSM, 8850.

   Para ver a versão do TSM e do Tableau Server no nó inicial:

   tsm version

   Para ver a versão do TSM e do Tableau Server de um nó adicional:

   tsm version -s https://<inital_node_name>:8850

   Por exemplo:

   tsm version -s https://myTableauHost:8850

backgrounder.failure_threshold_for_run_prevention

Valor padrão: 5

O número de falhas consecutivas de uma assinatura, uma extração ou um trabalho de execução de fluxo antes da suspensão do trabalho. A suspensão de trabalhos que falham continuamente ajuda a preservar os recursos do processador em segundo plano para outros trabalhos. Para desabilitar a suspensão de tarefas em segundo plano que falham, defina como -1.

backgrounder.log.level

Versão: adicionado na versão 2020.3.0

Valor padrão: info

O nível de registro para o método do processador em segundo plano. Pode ser configurado dinamicamente. Portanto, se você estiver apenas alterando, não será necessário reiniciar o Tableau Server. Para obter mais informações, consulte Alterar níveis de registro.

backgrounder.restrict_serial_collections_to_site_level

Valor padrão: false

No Tableau Server, você pode agendar atualizações de extração, assinaturas ou fluxos para serem executados periodicamente. Esses itens agendados são chamados de tarefas. O processo do Processador em segundo plano inicia instâncias exclusivas dessas tarefas para executá-las no horário agendado. As instâncias exclusivas das tarefas iniciadas como resultado são chamadas de trabalhos.

Essa configuração afeta os agendamentos configurados para serem executados em série. Por padrão, quando uma agenda é configurada para ser executada em série, todos os trabalhos que usam essa programação serão executados em série. Quando essa configuração é definida paratrue, os trabalhos executados em sites diferentes podem ser executados em paralelo. Os trabalhos para tarefas agendadas no mesmo site continuarão a ser executadas em série.

O exemplo abaixo ilustra este cenário:

O Tableau Server inclui uma programação chamada "Diariamente" para executar trabalhos todos os dias às 7h. A programação "Diária" está configurada para ser executada em série. Os sites "RH" e "Folha de pagamento" têm, cada um, várias tarefas agendadas que usam a agenda "Diariamente". Quando esta configuração é definida paratrue, os trabalhos para essas tarefas agendadas no site "RH" podem ser executados em paralelo com os trabalhos no site "Folha de pagamento", enquanto os trabalhos no mesmo site ainda serão executados apenas em série.

backgrounder.timeout.single_subscription_notify

Versão: adicionado na versão 2021.2.

Valor padrão: 1800 segundos (30 minutos)

Este é o tempo máximo permitido especificado em segundos para concluir um único trabalho de assinatura.

backgrounder.timeout.sync_ad_group

Versão: adicionado na versão 2021.1.23, 2021.2.21, 2021.3.20, 2021.4.15, 2022.1.11, 2022.3.3, 2023.1.

Valor padrão: 14400 segundos (4 horas)

Este é o tempo máximo permitido, especificado em segundos, para concluir uma sincronização de grupo do Active Directory. Isso se aplica á sincronizações de grupo agendadas feitas pelo serviço de processador em segundo plano e impede que sincronizações de execução longa sejam executadas indefinidamente. Isso não afeta as sincronizações de grupo feitas usando a interface do usuário do Tableau Server ou a API REST.

backgrounder.vInstances_max_overflow_queue_size

Versão: adicionado na versão 2022.1.2.

Valor padrão: 1000

O número máximo de trabalhos que podem estar na fila secundária. Ima fila secundária é criada quando o número de trabalhos em execução está no limite de simultaneidade definido. O máximo padrão é definido como 1.000 trabalhos - o que significa que, se houver mais de 1.000 trabalhos quando o limite de simultaneidade for atingido, mais de 1.000 trabalhos não serão enfileirados. Use o comando backgrounder.vInstance_max_overflow_queue_size tsm para fazer alterações no tamanho máximo da fila de estouro.

Os valores devem ser especificados em números inteiros.

backup.zstd.thread_count

Versão: adicionado na versão 2021.1.0 Essa chave é dinamicamente configurável. Para obter mais informações, consulte Alterações de topologia dinâmica do Tableau Server.

Valor padrão: 2

O número de segmentos que devem ser usado ao criar um backup.

O aumento desse número pode melhorar o desempenho do backup, mas recomendamos que a contagem de segmentos não exceda o número de quatro processadores lógicos no computador Tableau Server.

basefilepath.backuprestore

Valor padrão: C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\backups\

O local em que o comando tsm maintenance backup cria o backup. Esse também é o local onde o arquivo de backup deve estar quando restaurado usando o comando tsm maintenance restore ou o comando tsm maintenance send-logs. Depois de definir isso, você deve executar o comando tsm maintenance validate-backup-basefilepath (disponível na versão 2022.1 e posterior) para verificar se as permissões estão definidas corretamente para o local. Para obter mais informações, consulte tsm File Paths.

basefilepath.log_archive

Valor padrão: C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\log-archives\

O local em que o comando tsm maintenance ziplogs cria o arquivo compactado. Para obter mais informações, consulte tsm File Paths.

basefilepath.site_export.exports

Valor padrão: C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\siteexports\

O local em que o comando tsm sites export cria o arquivo de exportação. Para obter mais informações, consulte tsm File Paths.

basefilepath.site_import.exports

Valor padrão: C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\siteimports\

O local em que o comando tsm sites import espera que o arquivo de importação esteja localizado. Para obter mais informações, consulte tsm File Paths.

clustercontroller.log.level

Versão: adicionado na versão 2020.3.0

Valor padrão: info

O nível de registro para o Controlador de cluster. Pode ser configurado dinamicamente. Portanto, se você estiver apenas alterando, não será necessário reiniciar o Tableau Server. Para obter mais informações, consulte Alterar níveis de registro.

databaseservice.max_database_deletes_per_run

Versão: adicionado na versão 2021.2.

Valor padrão: null

Use esta opção para ajustar o número máximo de ativos externos inseridos (bancos de dados e tabelas) que podem ser excluídos a cada vez que é executado o processo em segundo plano, controlado por features.DeleteOrphanedEmbeddedDatabaseAsset. Se esta opção for deixada em branco, o número máximo padrão de ativos externos inseridos que podem ser excluídos é 100.

Para obter mais informações, consulte features.DeleteOrphanedEmbeddedDatabaseAsset.

dataserver.log.level

Versão: adicionado na versão 2020.3.0

Valor padrão: info

O nível de registro para o Servidor de dados. Pode ser configurado dinamicamente. Portanto, se você estiver apenas alterando, não será necessário reiniciar o Tableau Server. Para obter mais informações, consulte Alterar níveis de registro.

dataserver_<n>.port

Porta em que a instância do servidor de dados (especificada por "<n>") é executada.

excel.shadow_copy_all_remote.enabled

Versão: adicionado nas versões 2019.1.5, 2019.2.1.

Valor padrão: false

Controla se o Tableau Server cria uma "shadow copy" de uma planilha do Excel compartilhada (.xlxs ou .xlxm) que está sendo usada como fonte de dados dinâmica. Quando ativada, essa opção impede que os usuários do Excel vejam um "Erro de violação de compartilhamento" e uma mensagem que o arquivo está em uso. Essa opção pode ter um impacto no desempenho com arquivos grandes do Excel. Se os usuários do Excel não precisarem editar o arquivo compartilhado, não será necessário habilitar essa opção.

Observação: o Tableau Server sempre tenta criar uma “shadow copy” de um arquivo .xls. Essa opção não altera esse comportamento.

extractservice.command.execution.timeout

Versão: adicionado na versão 2021.4.

Valor padrão: 7200 segundos

Define o valor de tempo limite para o tempo de execução de atualização da extração VConn.

Exemplo: tsm configuration set -k extractservice.command.execution.timeout -v <timeout_in_seconds> --force-keys

Observação: Você deve usar a opção --force-keys para alterar este valor.

features.ActiveMQ

Versão: adicionado na versão 2021.4.

Valor padrão: true

Controla se o Tableau Server usa o serviço Apache ActiveMQ (Serviço de mensagens do Tableau Server) para o mecanismo interno de mensagens.

features.DeleteOrphanedEmbeddedDatabaseAsset

Versão: adicionado na versão 2021.2.

Valor padrão: true

Controla um processo em segundo plano, para o Tableau Catalog (ou a API de metadados do Tableau), que exclui ativos externos inseridos (bancos de dados e tabelas) que não estão mais associados ao conteúdo downstream do Tableau. Esse processo é executado todos os dias às 22:00:00 UTC (horário universal coordenado) e pode excluir no máximo 100 ativos externos por dia até que não haja mais ativos externos sem conexões com o conteúdo downstream do Tableau. Você pode definir esta opção para false e interromper a execução desse processo. Como alternativa, você também pode ajustar o número máximo de ativos integrados externos que podem ser excluídos usando databaseservice.max_database_deletes_per_run .

Para obter mais informações, consulte Solucionar problemas de conteúdo ausente.

features.IdentityMigrationBackgroundJob

Versão adicionado na versão 2022.1. O valor padrão foi alterado para false nas versões 2021.4.22, 2022.1.18, 2022.3.10, 2023.1.6 e 2023.3.

Valor padrão: false

Controla o processo que executa a migração de identidade. Quando definido para true, a migração de identidade é executada em implantações existentes imediatamente após a atualização do Tableau Server para a versão 2022.1 (ou posterior) e a restauração de um backup do Tableau Server versão 2021.4 (ou anterior). Definido como false (padrão) para desabilitar a migração de identidade.

Por exemplo, para iniciar a migração de identidade, execute o seguinte:

tsm configuration set -k features.IdentityMigrationBackgroundJob -v true

Para obter mais informações, consulte Sobre a migração de identidade.

Observação: se a migração de identidade estiver desabilitada, o Tableau Server não poderá usar o Serviço de identidade para armazenar e gerenciar informações de identidade do usuário. Usar o Serviço de identidade é um pré-requisito para determinados recursos como pools de identidades.

features.IdentityPools

Versão: adicionado na versão 2023.1.

Valor padrão: false

Um componente do recurso de grupos de identidades que precisa ser habilitado se você executar uma nova instalação do Tableau Server. Requer feature.NewIdentityMode e wgserver.authentication.legacy_identity_mode.enabled. Defina como true para habilitar a geração de pools de identidade. Defina como false (padrão) para desabilitar pools de identidade.

Por exemplo, para habilitar os pools de identidades, execute o seguinte:

tsm configuration set -k features.IdentityPools -v true
tsm configuration set -k features.NewIdentityMode -v true
tsm configuration set -k wgserver.authentication.legacy_identity_mode.enabled -v false
tsm pending-changes apply

Para obter mais informações, consulte Solucionar problemas de pools de identidade.

features.MessageBusEnabled

Versão: adicionado na versão 2019.4.

Valor padrão: true

Controla se o Tableau Server usa o novo mecanismo interno de mensagens.

features.NewIdentityMode

Versão adicionado na versão 2022.1.

Valor padrão: false. O valor padrão foi alterado de true para false em 2023.1.6.

Um pré-requisitos de capacidade de pools de identidades. Requer wgserver.authentication.legacy_identity_mode.enabled ser definido para false para desabilitar pools de identidades. Definido como true para desabilitar pools de identidades.

tsm configuration set -k features.IdentityPools -v true
tsm configuration set -k features.NewIdentityMode -v true
tsm configuration set -k wgserver.authentication.legacy_identity_mode.enabled -v false
tsm pending-changes apply

Para obter mais informações, consulte Solucionar problemas de pools de identidade.

features.PasswordlessBootstrapInit

Valor padrão: true

Controla se o Tableau Server permite credenciais inseridas em arquivos boostrap. Quando habilitada (o padrão), as credenciais inseridas são incluídas no arquivo bootstrap, a menos que você especifique que elas não devem ser incluídas. Defina como false se as credenciais nunca devam ser incluídas em qualquer arquivo bootstrap que você gerar. Para obter mais informações sobre como gerar arquivos bootstrap, consulte tsm topology nodes get-bootstrap-file.

Essa opção foi adicionada com a versão do Tableau Server 2019.3.

features.PasswordReset

Versão: descontinuado na versão 2024.2. Para versões 2024.2 e posteriores, use vizportal.password_reset.

Valor padrão: false

Aplica-se apenas aos servidores que usam autenticação local. Defina como truepara permitir que os usuários redefinam suas senhas com a opção "Esqueci a senha" na página de logon.

filestore.empty_folders_reaper.enabled

Versão: adicionado em 2020.x (2020.1.14, 2020.2.11, 2020.3.6, 2020.4.2) e 2021.1.x. O valor padrão foi alterado para true em 2021.2.

Valor padrão: true

Habilita o trabalho que "colhe" (remove) pastas vazias do Filestore.

filestore_empty_folders_reap.frequency_s

Versão: adicionado em 2020.x (2020.1.14, 2020.2.11, 2020.3.6, 2020.4.2).

Valor padrão: 86400 (24 horas)

Especifica, em minutos, com que frequência executar o trabalho que remove as pastas vazias do Filestore.

features.Hyper_DisallowTDEPublishing

Versão: o padrão é true começando na versão 2023.1.0. Descontinuado em Tableau Server 2024.2.

Valor padrão: true

Especifica se os usuários podem fazer upload de arquivos no formato .tde. Esse formato foi substituído pelo formato .hyper a partir da versão 10.5 do Tableau Server, mas não teve o carregamento bloqueado. A partir da Versão 2024.3, os arquivos no formato .tde não são mais utilizáveis. Os arquivos foram convertidos automaticamente para o formato .hyper se uma das várias ações fosse executada. Para obter mais informações, consulte Atualização de extrações para o formato .hyper.

filestore.log.level

Versão: adicionado na versão 2020.3.0

Valor padrão: info

O nível de registro do Armazenamento de arquivos. Pode ser configurado dinamicamente. Portanto, se você estiver apenas alterando, não será necessário reiniciar o Tableau Server. Para obter mais informações, consulte Alterar níveis de registro.

filestore.reapemptyfoldersholdoffms

Versão: adicionado em 2020.x (2020.1.14, 2020.2.11, 2020.3.6, 2020.4.2). Isso ainda não está disponível em 2021.1.

Valor padrão:300000 (5 minutos)

Especifica, em milissegundos, a quantidade de tempo de espera antes de remover as pastas vazias do Filestore.

floweditor.max_datafile_upload_size_in_kb

Versão: adicionado na versão 2020.4

Valor padrão: 1048576

Para criação de fluxo na Web do Tableau Prep, o tamanho máximo dos arquivos de texto delimitados (por exemplo, CSV ou TXT) que podem ser carregados no Tableau Server.

gateway.external_url

Versão: adicionado na versão 2023.1.

Valor padrão: Null

Obrigatório quando a autenticação OpenID Connect (OIDC) é configurada no TSM durante a configuração do Tableau Server ou com pools de identidades. Especifica a URL do Tableau Server usada pelo provedor de identidade (IdP) para redirecionar os usuários que se autenticam no Tableau. A URL externa do gateway é a mesma URL que você especificou como a URL de redirecionamento com seu IdP, que é usada para fins de correspondência.

Por exemplo, para redirecionar o IdP associado à configuração de autenticação OIDC para o Tableau Server, http://myco, execute o seguinte comando:

tsm configuration set -k gateway.external_url -v http://myco

gateway.http.hsts

Valor padrão: false

O cabeçalho do HTTP Strict Transport Security (HSTS) força os navegadores a usarem o HTTPS no domínio onde ele está habilitado.

gateway.httpd.loglevel

Versão: adicionado em 2021.3.0.

Valor padrão: notice

Especifica o nível de registro para o Gateway (servidor Apache HTTPD). Por padrão, ele é definido como notice. Outras opções incluem debug, info, warning, error. Se você alterar o nível de registro, esteja ciente do impacto potencial no uso e no desempenho do espaço em disco. Como prática recomendada, retorne o nível de registro ao padrão depois de reunir as informações necessárias. Para obter informações detalhadas sobre o registro do Apache, consulte a documentação do HTTP do Apache(O link abre em nova janela).

gateway.httpd.shmcb.size

Versão: adicionado em 2021.4

Valor padrão: 2048000

Especifica a quantidade de memória em bytes para o buffer circular ao usar o tipo de armazenamento shmcb. Essa chave de configuração não se aplica ao usar o tipo de armazenamento dbm.

gateway.httpd.socache

Versão: adicionado em 2021.4

Valor padrão: shmcb

Especifica o tipo de armazenamento do Cache de Sessão SSL global/entre processos. Por padrão, isso é definido como shmcb, com outra opção dbm configurável. Para obter mais informações sobre os tipos de armazenamento shmcb e dbm, consulte Diretiva SSLSessionCache(O link abre em nova janela) no site da Web Apache.

gateway.log.level

Versão: adicionado na versão 2020.3.0

Valor padrão: info

O nível de registro do Gateway. Pode ser configurado dinamicamente. Portanto, se você estiver apenas alterando, não será necessário reiniciar o Tableau Server. Para obter mais informações, consulte Alterar níveis de registro.

hyper.log_queries

Valor padrão: true

Quando definido como true, as informações de consulta são registradas.

As informações de consulta são registradas por padrão. Se, contudo, você perceber que os arquivos de registro são muito grandes para a quantidade de espaço em disco disponível, é possível definir como false para desativar o registro das informações de consulta. O Tableau recomenda deixar essa configuração definida como true.

hyper.session_memory_limit

Valor padrão: 0(o que significa ilimitado)

Controla o consumo máximo de memória que uma consulta individual pode ter. Especifique o número de bytes. Acrescente a letra "k" ao valor para indicar kilobytes, "m" para indicar megabytes e "g" para indicar gigabytes ou "m" para indicar terabytes.

Por exemplo, para definir o limite de memória para 900 megabytes, execute o seguinte comando:

tsm configuration set -k hyper.session_memory_limit -v 900m.

Como alternativa, para especificar o limite de memória da sessão como uma porcentagem da memória geral do sistema disponível, execute o seguinte comando:

tsm configuration set -k hyper.session_memory_limit -v 90%.

Reduzir esse valor pode ajudar quando uma consulta estiver usando quantidades excessivas de memória e fazendo com que outras consultas falhem por um longo período de tempo. Ao reduzir o limite, a única consulta grande falharia (ou recorreria à transferência se a transferência não estiver desativada) e não teria um impacto negativo em outras consultas.

hyper.srm_cpu_limit_percentage

Valor padrão (em percentual): 75

Especifica o uso máximo de CPU por hora permitido pelo Hyper. Se excedido, o Mecanismo de dados reiniciará sozinho para minimizar o impacto em outros processos no computador.

Por padrão, o Mecanismo de dados será reiniciado se tiver uma média de uso superior a 75% da CPU em uma hora. Esse valor não deve ser alterado, exceto ao trabalhar com o Suporte do Tableau ou se você estiver executando o Processador de dados em um nó de servidor dedicado. Se o Mecanismo de dados estiver sendo executado em um nó dedicado, você poderá aumentar com segurança esse valor para 95% para aproveitar ao máximo o hardware de computador disponível. Para obter detalhes sobre como executar o Mecanismo de dados em um nó dedicado, consulte Otimizar para ambientes - com muitas consultas de extração.

Para aumentar para 95%:

tsm configuration set -k hyper.srm_cpu_limit_percentage -v 95 --force-keys

tsm pending-changes apply

Para redefinir isso para o padrão de 75%:

tsm configuration set -k hyper.srm_cpu_limit_percentage -v 75 --force-keys

tsm pending-changes apply

hyper_standalone.consistent_hashing.enabled

Valor padrão: true

Aumenta a chance de que a extração de uma consulta já esteja armazenada em cache. Se o nó com a extração armazenada em cache não puder suportar carga adicional, você será encaminhado para um novo nó e a extração será carregada em cache no novo nó. Isso resulta em uma melhor utilização do sistema porque as extrações só serão carregadas na memória se houver carga que justifique a necessidade.

indexandsearchserver.vmopts

Versão: adicionado na versão 2022.1.

Valor padrão: -Xmx<default_value> -Xms<default_value>

O valor padrão é baseado na quantidade de memória do sistema e consiste em 3,125% da RAM total do sistema.

Controla o tamanho da pilha do Index and Search Server. Como o valor padrão é dimensionado automaticamente, use essa opção para substituir o valor padrão somente quando absolutamente necessário. Acrescente a letra "k" ao valor para indicar kilobytes, "m" para indicar megabytes e "g" para indicar gigabytes. Como regra geral, defina o tamanho da pilha inicial (-Xms) igual ao tamanho da pilha máxima (-Xmx) para minimizar as coletas de lixo.

jmx.security.enabled

Versão: adicionado na versão 2022.1.

Valor padrão: false

O JMX está desativado por padrão, portanto, o JMX seguro também está desativado. Se você estiver ativando o JMX, recomendamos que você ative o JMX seguro.

Isso está definido paratrue e ativa o JMX seguro com SSL e autenticação básica de nome de usuário/senha para acesso somente leitura quando você executa o comando tsm maintenance jmx enable e responde y quando solicitado a ativar os recursos de segurança para JMX:

tsm maintenance jmx enable
We do not recommend you enable JMX unsecured on a production environment. Would you like to enable security features for JMX?
(y/n): y

jmx.ssl.enabled

Versão: adicionado na versão 2022.1.

Valor padrão: true

Impõe SSL para JMX. Essa opção tem como padrão true mas não tem efeito a menos que jmx.security.enabled também esteja definido para true. Para habilitar a segurança de JMX, execute o comando tsm maintenance jmx enable. Responda y quando solicitado a deixar o SSL ativado ou n para desativar o SSL:

tsm maintenance jmx enable
...
Would you like to enable SSL?
(y/n): n

jmx.ssl.require_client_auth

Versão: adicionado na versão 2022.1.

Valor padrão: false

Isso está definido paratrue quando você executar o comando tsm maintenance jmx enable e responde y quando solicitado a exigir autenticação de cliente (mTLS):

tsm maintenance jmx enable
...
Would you like to require client authentication (mTLS)?
(y/n): y

Para concluir a configuração, você deve ter um certificado de cliente e colocá-lo no local correto em seu computador cliente.

jmx.ssl.user.name

Versão: adicionado na versão 2022.1.

Valor padrão: tsmjmxuser

Isso é definido quando você instala ou atualiza o Tableau Server.

jmx.ssl.user.password

Versão: adicionado na versão 2022.1.

Valor padrão: <generated>

Isso é definido quando você instala ou atualiza o Tableau Server.

jmx.user.access

Versão: adicionado na versão 2022.1.

Valor padrão: readonly

Você pode alterar isso para readwrite quando você executar o comando tsm maintenance jmx enable e responder y quando solicitado a adicionar o acesso readwrite :

tsm maintenance jmx enable
...
JMX access is readonly by default. Would you like to add readwrite access?
(y/n): y

licensing.login_based_license_management.default_requested_duration_seconds

Valor padrão: 0

Defina como a duração (em segundos) que a licença baseada em login de um usuário offline sem conexão ao Tableau Server antes de ser solicitado a ativar novamente. Esta duração será sempre atualizada quando o Tableau Desktop estiver em uso e puder se conectar ao Tableau Server.

licensing.login_based_license_management.enabled

Valor padrão: true

Defina como true para habilitar o gerenciamento de licenças baseadas em logon. Definido como false para desabilitar o gerenciamento de licenças baseadas em logon.

Observação: para usar gerenciamento de licenças baseadas em logon, você deve ativar uma chave do produto habilitada para gerenciamento de licenças baseadas em logon. Você pode usar tsm licenses list para ver quais chaves do produto têm o gerenciamento de licenças baseadas em logonhabilitado.

licensing.login_based_license_management.max_requested_duration_seconds

Valor padrão: 7776000

Defina como a duração máxima (em segundos) que a licença baseada em login de um usuário pode estar offline sem conexão ao Tableau Server antes de ser solicitado a ativar o Tableau novamente. O valor máximo é 7776000 segundos (90 dias). Esta duração será sempre atualizada quando o Tableau Desktop estiver em uso e puder se conectar ao Tableau Server.

metadata.ingestor.blocklist

Valor padrão: null

Quando configurado, o Tableau Catalog bloqueia o conteúdo especificado de ser ingerido. Para especificar qual conteúdo bloquear, você deve identificar os valores de lista de bloqueio, que é uma combinação tanto da ID do site, do tipo de conteúdo quanto da ID de conteúdo do conteúdo que deseja bloquear, com base em arquivos de log "não interativos" do servidor. Os valores da lista de bloqueio devem ser separados por vírgula.

Importante: você só deve usar esta opção por indicação do Suporte do Tableau.

Por exemplo, você pode usar tsm configuration set --force-keys -k metadata.ingestor.blocklist para bloquear a ingestão de uma combinação de fontes de dados, pastas de trabalho e fluxos usando o seguinte comando:

tsm configuration set --force-keys -k metadata.ingestor.blocklist -v "sites/1/datasources/289, sites/2/datasources/111, sites/1/workbooks/32, sites/3/workbooks/15, sites/1/flows/13, sites/1/flows/18”

Para validar o conteúdo bloqueado, revise os arquivos de registro "não interativos" do servidor para os seguintes eventos:

• Skipping ingestion for
• Successfully updated blocklist to

Por exemplo:

Skipping ingestion for contentType [Workbook], contentId [sites/1/datasources/289], siteDisabled [false], swallowEvent [false], contentBlocked [true]

Skipping ingestion for contentType [Workbook], contentId [sites/3/workbooks/15], siteDisabled [false], swallowEvent [false], contentBlocked [true]

e

Successfully updated blocklist to: [sites/1/datasources/289, sites/1/workbooks/32, sites/2/datasources/111]

metadata.ingestor.pipeline.throttleEventsEnable

Valor padrão: false

Controla se a indexação de conteúdo novo e atualizado, também chamada de eventos, é regulada em todos os sites do servidor. Por padrão, essa limitação fica desligada. Para ligar a limitação de eventos, altere esta configuração para true com o seguinte comando: 

tsm configuration set -k metadata.ingestor.pipeline.throttleEventsEnable -v true --force-keys

Para obter mais informações sobre a limitação do evento, consulte Ativar o Tableau Catalog.

metadata.ingestor.pipeline.throttleLimit

Valor padrão: 20

Quando a limitação do evento é ativada, ela é o número máximo de itens de conteúdo novos e atualizados que podem ser indexados durante um período de tempo especificado. Quando o limite especificado é atingido para um item específico, a indexação é adiada.

Por padrão, o limite é definido para 20 e não pode ser definido como inferior a 2. Você pode usar o seguinte comando para alterar o limite: 

tsm configuration set -k metadata.ingestor.pipeline.throttleLimit -v 25 --force-keys

Eventos limitados podem ser identificados nos arquivos de registro "não interativos" do servidor como ingestor event flagged for removal by throttle filter.

metadata.ingestor.pipeline.throttlePeriodLength

Valor padrão: 20

Quando a limitação do evento é ativada, este é o período, em minutos, um número máximo especificado de indexação de itens de conteúdo novo e atualizado pode ser indexado. Uma vez alcançado o tempo especificado, a indexação de qualquer conteúdo novo e atualizado adicional é adiada.

Por padrão, o limite é definido para 30 minutos. Você pode usar o seguinte comando para alterar o horário:

tsm configuration set -k metadata.ingestor.pipeline.throttlePeriodLength -v PT45M --force-keys

metadata.query.limits.time

Valor padrão: 20

Este é o maior tempo permitido, em segundos, para que uma consulta do Catalog ou da API de metadados seja executada, antes que o tempo limite seja atingido e a consulta cancelada. O Tableau recomenda aumentar gradativamente o tempo limite para no máximo 60 segundos, usando o seguinte comando:

tsm configuration set -k metadata.query.limits.time –v PT30S --force-keys

Importante: essa opção só deve ser alterada se você observar o erro descrito aqui, Mensagens de tempo limite e limite de nós excedidos. O aumento do tempo limite pode utilizar mais CPU por mais tempo, o que pode afetar o desempenho das tarefas em todo o Tableau Server. O aumento do tempo limite também pode causar maior utilização de memória, o que pode causar problemas no contêiner de microsserviços interativo quando as consultas são executadas paralelamente.

metadata.query.limits.count

Valor padrão: 20000

Este é o número de objetos (que podem mapear vagamente o número de resultados de consulta) que o Catalog pode retornar, antes que o limite de nós seja ultrapassado e a consulta cancelada. O Tableau recomenda aumentar gradativamente o limite para no máximo 100.000, usando o seguinte comando:

tsm configuration set -k metadata.query.limits.count –v 3000 --force-keys

Importante: essa opção só deve ser alterada se você observar o erro descrito aqui, Mensagens de tempo limite e limite de nós excedidos. O aumento do limite de nós pode causar maior utilização de memória, o que pode causar problemas no contêiner de microsserviços interativo quando as consultas são executadas paralelamente.

metadata.query.throttling.enabled

Versão: adicionado na versão 2023.3

Valor padrão: true

Controla se a limitação de consulta de API de metadados(O link abre em nova janela) está habilitada. A otimização de consultas da API de metadados é um recurso projetado para evitar que as respostas da API de um servidor prejudiquem o desempenho geral. Quando definido para true (o padrão), se uma solicitação à API de metadados exceder o limite definido, um erro RATE_EXCEEDED é retornado.

Se os usuários da API de metadados estiverem tendo erros frequentes de RATE_EXCEEDED, um administrador pode tentar ajustar a limitação usando as configurações metadata.query.throttling.tokenRefilledPerSecond e metadata.query.throttling.queryCostCapacity. Como alternativa, o administrador pode desabilitar totalmente a limitação definindo o valor metadata.query.throttling.enabled para false. No entanto, isso impediria os benefícios de proteção de desempenho do recurso.

metadata.query.throttling.queryCostCapacity

Versão: adicionado na versão 2023.3

Valor padrão: 20000000

Um número que representa a capacidade da API de metadados(O link abre em nova janela) para responder perguntas. Cada solicitação à API de metadados tem um custo calculado que é subtraído desse número quando é executado. (Usando um modelo de token bucket, esta é a quantidade máxima de tokens que podem estar no bucket.)

Se os usuários da API de metadados estiverem vendo erros RATE_EXCEEDED, um administrador poderá ajustar as configurações de limitação. Eles deveriam ajustar metadata.query.throttling.tokenRefilledPerSecond e testar os resultados antes de tentar ajustar metadata.query.throttling.queryCostCapacity. Como alternativa, o administrador pode desabilitar totalmente a limitação definindo metadata.query.throttling.enabled para false. No entanto, isso impediria os benefícios de proteção de desempenho do recurso.

metadata.query.throttling.tokenRefilledPerSecond

Versão: adicionado na versão 2023.3

Valor padrão: 5555

Um número que representa a quantidade de capacidade da consulta de API de metadados(O link abre em nova janela) regenerada a cada segundo. (Usando um modelo de token bucket, este é o número de tokens que são colocados no bucket a cada segundo.)

Se os usuários da API de metadados estiverem vendo erros RATE_EXCEEDED, um administrador poderá ajustar as configurações de limitação. Eles deveriam ajustar metadata.query.throttling.tokenRefilledPerSecond e testar os resultados antes de tentar ajustar metadata.query.throttling.queryCostCapacity. Como alternativa, o administrador pode desabilitar totalmente a limitação definindo metadata.query.throttling.enabled para false. No entanto, isso impediria os benefícios de proteção de desempenho do recurso.

native_api.allowed_paths

Valor padrão: ""

Observação: mas versões do Tableau Server (incluindo versões de manutenção) anteriores a outubro de 2023, essa configuração foi configurada para permitir o acesso a todos os caminhos por padrão.

Use esta configuração para especificar uma lista de permissões para acesso a arquivos armazenados no Tableau ou em compartilhamentos remotos. Esse cenário permite que usuários autorizados do Tableau Server criassem pastas de trabalho que usassem arquivos no servidor como fontes de dados baseadas em arquivos (como planilhas).

Essa configuração permite limitar o acesso apenas aos diretórios especificados. O acesso Conta de serviço Run As é, portanto, limitado aos caminhos do diretório onde você hospeda os arquivos de dados.

Importante Certifique-se de que os caminhos de arquivo especificados nesta configuração existam e sejam acessíveis pela conta do sistema.

native_api.ExplainDataEnabled

Valor padrão: true

Esta opção controla se o Explique os dados está ativado ou desativado para o servidor. Para obter mais informações sobre o Explique os dados, consulte Começar com Explique os dados(O link abre em nova janela) na Ajuda do Tableau.

Essa opção foi adicionada a partir do Tableau Server versão: 2019.3.

nlp.concepts_shards_count

Valor padrão: 1

Observação: o valor da contagem de segmentos padrão é suficiente para a maioria das instalações do Tableau Server.

Controla o número de fragmentos de dados para o índice de conceitos do Pergunte aos dados, nomes de campo, sinônimos de campo e termos analíticos armazenados em fragmentos em:

• O Index and Search Server para 2022.1 e versões posteriores.
• Elastic Server para 2019.1 - 2021. 4

A contagem de segmentos divide o índice de pesquisa para reduzir o tamanho total do índice, o que pode melhorar o desempenho do analisador semântico do Pergunte aos dados (Ask Data). O ajuste da contagem de segmentos é outra medida de melhoria de desempenho que você pode tomar, juntamente com o aumento do tamanho da pilha por meio do elasticserver.vmopts ou indexandsearchserver.vmopts, dependendo da versão do Tableau Server que você está executando.

O Tableau recomenda aumentar a contagem de segmentos em 1 para cada 50 GB. Para reduzir o número de vezes que você precisa ajustar a contagem de segmentos, calcule o tamanho total do índice adicionando 50% ao índice atual. Por exemplo, se o tamanho total do índice for inferior a 50 GB, então 1 segmento será suficiente. O desempenho real varia de acordo com o servidor, a taxa de aumento do tamanho do índice e outros fatores.

• 0 a 50 GB: 1
• 50 GB a 100 GB: 2
• 100 GB a 150 GB: 3

É possível usar o comando a seguir para aumentar a contagem de segmentos do índice de Conceitos do padrão para 2:

tsm configuration set -k nlp.concepts_shards_count -v 2

nlp.values_shards_count

Valor padrão: 1

Controla o número de fragmentos de dados para o índice de conceitos do Pergunte aos dados, nomes de campo, sinônimos de campo e termos analíticos armazenados em fragmentos em:

• O Index and Search Server para 2022.1 e versões posteriores.
• Elastic Server para 2019.1 - 2021. 4

A contagem de segmentos divide o índice de pesquisa para reduzir o tamanho total do índice, o que pode melhorar o desempenho do analisador semântico do Pergunte aos dados (Ask Data). O ajuste da contagem de segmentos é outra medida de melhoria de desempenho que você pode tomar, juntamente com o aumento do tamanho da pilha por meio do elasticserver.vmopts ou indexandsearchserver.vmopts, dependendo da versão do Tableau Server que você está executando.

O Tableau recomenda aumentar a contagem de segmentos em 1 para cada 50 GB. Para reduzir o número de vezes que você precisa ajustar a contagem de segmentos, calcule o tamanho total do índice adicionando 50% ao índice atual. Por exemplo, se o tamanho total do índice for inferior a 50 GB, então 1 segmento será suficiente. O desempenho real varia de acordo com o servidor, a taxa de aumento do tamanho do índice e outros fatores.

• 0 a 50 GB: 1
• 50 GB a 100 GB: 2
• 100 GB a 150 GB: 3

É possível usar o comando a seguir para aumentar a contagem de segmentos do índice de Valores, do padrão para 2:

tsm configuration set -k nlp.values_shards_count -v 2

nlp.defaultNewSiteAskDataMode

Valor padrão: disabled_by_default

Use esta opção para definir o valor inicial do Modo Pergunte aos dados quando um site for criado. Para obter mais informações, consulte Desabilitar ou habilitar Pergunte aos dados para um site.

As opções válidas são disabled_by_default e disabled_always.

Essa opção foi adicionada com as versões do Tableau Server: 2019.4.5, 2020.1.3.

noninteractive.vmopts

pgsql.port

Valor padrão: 8060

Porta na qual o PostgreSQL escuta.

pgsql.preferred_host

Especifica o nome do computador do nó com o repositório preferencial instalado. Esse valor será usado se a opção --preferred ou -r for especificada com o comando tsm topology failover-repository.

Exemplo:

pgsql.ssl.ciphersuite

Valor padrão: HIGH:MEDIUM:!aNULL:!MD5:!RC4

Especifica os algoritmos cifrais que são permitidos para SSL ao Repositório.

Para obter valores aceitáveis e requisitos de formatação, consulte ssl_ciphers(O link abre em nova janela) no site da Web do Postgres.

pgsql.ssl.max_protocol_version

Valor padrão: TLSv1.3

Define a versão máxima do protocolo SSL/TLS a ser usada ao conectar-se ao repositório por SSL.

Valores válidos: TLSv1, TLSv1.1, TLSv1.2, TLSv1.3

pgsql.ssl.min_protocol_version

Valor padrão: TLSv1.2

Define a versão mínima do protocolo SSL/TLS a ser usada ao conectar-se ao repositório por SSL.

Valores válidos: TLSv1, TLSv1.1, TLSv1.2, TLSv1.3

pgsql.verify_restore.port

Valor padrão: 8061

Porta usada para verificar a integridade do banco de dados PostgreSQL. Consulte tsm maintenance backup para obter mais informações.

ports.blocklist

Versão: adicionado na versão 2021.1

Valor padrão: sem portas bloqueadas no intervalo utilizado para a atribuição automática da porta.

Usado para especificar portas dentro do intervalo de atribuição da porta que não devem ser usadas pelo Tableau ao atribuir dinamicamente as portas. Isso é útil quando você sabe que outro aplicativo está usando uma porta dentro do mesmo intervalo. Separe várias portas por vírgulas, por exemplo:

tsm configuration set -k ports.blocklist -v 8000,8089, 8090

Para obter mais informações sobre o uso da chave ports.blocklist, consulte Bloqueio de portas específicas dentro do intervalo

recommendations.enabled

Valor padrão: true

Controla o recurso de recomendações que ativa as recomendações de fontes de dados e tabelas (para o Tableau Desktop) e recomendações de exibições (para o Tableau Server). As recomendações são baseadas na popularidade do conteúdo e no conteúdo usado por outros usuários determinados como similares ao usuário atual.

searchserver.connection_timeout_milliseconds

Versão: adicionado na versão 2019.1. Obsoleto na versão 2022.3. Descontinuado na versão 2023.3.

Valor padrão, em milissegundos: 100000

Especifica, em milissegundos, o tempo que os clientes de Pesquisa e navegação aguardam para estabelecer uma conexão com o servidor de Pesquisa e navegação.

Em computadores sobrecarregados do Tableau Server ou se você observar erros de registro “Falha na verificação de integridade do Zookeeper. Recusa ao iniciar SOLR.”, aumente esse valor.

Para obter mais informações, consulte Tempos limite da sessão do cliente.

searchserver.index.bulk_query_user_groups

Versão: descontinuado na versão 2022.3.

Valor padrão: true

Especifica se a consulta de usuários do site é feita em massa ao importar ou excluir usuários com um arquivo CSV. Quando definido como true(o padrão), a indexação é feita em massa.

searchserver.javamemopts

Versão: adicionado na versão 2019.1. Descontinuado em 2023.3

Valor padrão: -Xmx512m -Xms512m -XX:+ExitOnOutOfMemoryError -XX:-UsePerfData

Determina as opções JVM para SOLR.

Dentre todas as opções configuráveis, a memória máxima da pilha, configurada pelo parâmetro -Xmx, é a mais importante ao ajustar o searchserver. Na maioria dos casos, esse valor deve ser definido como o mais alto possível, até 24 GB, com base na memória física disponível no computador do Tableau Server. Para alterar apenas a memória máxima da pilha, especifique toda a cadeia de caracteres padrão, mas apenas altere o valor para -Xmx.

Valores válidos para -Xmx dependem da memória disponível no computador do Tableau Server, mas não podem ser maiores que 24 GB. Para obter mais informações, consulte Memória máxima da pilha de Pesquisa e navegação.

searchserver.startup.zookeeper_healthcheck_timeout_ms

Versão: adicionado na versão 2020.1. Descontinuado na versão 2023.3.

Valor padrão, em milissegundos: 300000

Especifica, em milissegundos, o tempo que o Tableau Server deve aguardar por uma verificação de integridade bem-sucedida do Zookeeper na inicialização.

Em computadores sobrecarregados do Tableau Server ou se você observar erros de registro “Falha na verificação de integridade do Zookeeper. Recusa ao iniciar SOLR.”, aumente esse valor.

Para obter mais informações, consulte Tempo limite da verificação de integridade da conexão do Zookeeper na inicialização.

searchserver.zookeeper_session_timeout_milliseconds

Versão: descontinuado na versão 2022.3.

Valor padrão, em milissegundos: 100000

Especifica, em milissegundos, o tempo que os clientes de Pesquisa e navegação aguardam para estabelecer uma conexão com o Serviço de coordenação (Zookeeper).

Para obter mais informações, consulte Tempos limite da sessão do cliente.

ServerExportCSVMaxRowsByCols

Versão: adicionado na versão 2020.3.

Valor padrão: 0 (sem limite)

Especifica o número máximo de células de dados que podem ser baixadas de Exibir dados em um arquivo CSV. Por padrão, não há limite. Especifique o número de células. Por exemplo, para estabelecer um limite de 3 milhões: 

tsm configuration set -k ServerExportCSVMaxRowsByCols -v 3000000 

tsm pending-changes apply

ssl.ciphersuite

Valor padrão: HIGH:MEDIUM:!EXP:!aNULL:!MD5:!RC4:!3DES:!CAMELLIA:!IDEA:!SEED

Especifica os algoritmos cifrais que são permitidos para SSL ao Gateway.

Para obter valores aceitáveis e requisitos de formatação, consulte SSLCipherSuite(O link abre em nova janela)no site Apache.

ssl.client_certificate_login.blocklisted_signature_algorithms

Valor padrão:

• Versão 2020.4.0: 

  sha1withrsaencryption,
sha1withrsa

• Versão 2020.4.1 e posterior:

  sha1withrsaencryption,
sha1withrsa,
sha1withrsaandmgf1,
sha1withdsa,
sha1withecdsa

O valor padrão bloqueia certificados com o algoritmo de assinatura SHA-1. Especifica os algoritmos de assinatura do cliente que estão bloqueados para SSL. Para desativar o bloqueio de todos os algoritmos de assinatura, execute esta chave com um conjunto vazio de aspas.

Para obter mais informações sobre esta chave, consulte o artigo da Base de dados de conhecimento, O SSL mútuo falha após a atualização se os certificados forem assinados com o SHA-1(O link abre em nova janela).

ssl.client_certificate_login.min_allowed.elliptic_curve_size

Valor padrão: 256

Especifica o tamanho mínimo da curva elíptica necessária para os certificados de cliente ECDSA que estão autenticando com o Tableau Server por SSL mútuo. Se um cliente apresentar um certificado de cliente ECDSA que não satisfaça esse tamanho mínimo de curva, a solicitação de autenticação falhará.

Essa opção foi apresentada na versão 2021.1 do Tableau Server.

ssl.client_certificate_login.min_allowed.rsa_key_size

Valor padrão: 2048

Especifica o tamanho mínimo da chave para os certificados de cliente RSA que estão autenticando com o Tableau Server por SSL mútuo. Se um cliente apresentar um certificado de cliente RSA que não satisfaça esse tamanho mínimo da chave, a solicitação de autenticação falhará.

Essa opção foi apresentada na versão 2021.1 do Tableau Server.

ssl.protocols

Valor padrão: all +TLSv1.2 -SSLv2 -SSLv3 -TLSv1.3

Especifica os protocolos SSL aos quais o Tableau Server oferece suporte para conexões TLS do Gateway. Os valores aceitáveis derivam da Diretiva Apache SSLProtocol(O link abre em nova janela). Recomendamos seguir a configuração do protocolo SSL conforme descrito na Lista de verificação do reforço de segurança.

storage.monitoring.email_enabled

Valor padrão: false

Controla se as notificações por e-mail estão habilitadas para o monitoramento de espaço em disco do servidor. Por padrão, as notificações por e-mail estão habilitadas. Para habilitar notificações para monitoramento de espaço em disco, defina isso para true.

O SMTP deve ser configurado para que as notificações sejam enviadas. Para obter mais detalhes, consulte Configurar o SMTP.

storage.monitoring.warning_percent

Valor padrão: 20

Limite de aviso do espaço em disco restante, em porcentagem do espaço total em disco. Se o espaço em disco cair abaixo deste limite, uma notificação de aviso será enviada.

storage.monitoring.critical_percent

Valor padrão: 10

Limite crítico de espaço em disco restante, em porcentagem do espaço total em disco. Se o espaço em disco cair abaixo desse limite, uma notificação crítica será enviada.

storage.monitoring.email_interval_min

Valor padrão: 60

Com que frequência, em minutos, as notificações por e-mail devem ser enviadas quando o monitoramento do espaço em disco é habilitado e um limite é ultrapassado.

storage.monitoring.record_history_enabled

Valor padrão: true

Determina se o histórico de espaço livre em disco é salvo e disponível para exibição em Exibições Administrativas. Para desabilitar o armazenamento do histórico para monitoramento, defina storage.monitoring.record_history_enabled como false.

svcmonitor.notification.smtp.enabled

Valor padrão: false

Controla se as notificações por e-mail estão habilitadas para os eventos de processo do servidor. Por padrão, as notificações são enviadas quando os processos ficam inativos, fazem failover ou reiniciam. Para habilitar notificações de processo de servidor, defina isto para true.

O SMTP deve ser configurado para que as notificações sejam enviadas. Para obter mais detalhes, consulte Configurar o SMTP.

svcmonitor.notification.smtp.mime_use_multipart_mixed

Versão: adicionado na versão: 2020.1.8, 2020.2.5, 2020.3.1

Default value: false

Controla se os anexos HTML MIME de assinatura são enviados como multiparte/relacionado (o padrão) ou multiparte/misturado.

Em casos raros, os clientes de e-mail podem não analisar corretamente os e-mails enviados pelo Tableau Server. Muitas vezes, isso pode ser corrigido definindo essa propriedade como true. Clientes conhecidos incluem iOS Mail e Microsoft Outlook (quando emparelhados com a criptografia S/MIME do Exchange).

tabadmincontroller.auth.expiration.minutes

Valor padrão: 120

Controla quanto tempo os cookies da sessão são válidos. Por padrão, ele é definido como 120 minutos. Esse valor também determina quanto tempo as credenciais inseridas em um arquivo de inicialização de nó são válidas. Para obter mais informações, consulte tsm topology nodes get-bootstrap-file.

tdsservice.log.level

Versão: adicionado na versão 2020.3.0

Valor padrão: info

O nível de registro do serviço Propriedades da fonte de dados. Pode ser configurado dinamicamente. Portanto, se você estiver apenas alterando, não será necessário reiniciar o Tableau Server. Para obter mais informações, consulte Alterar níveis de registro.

tomcat.useSystemProxies

Valor padrão: false

Especifica se os componentes do tomcat (OpenID) requerem acesso à configuração do proxy de encaminhamento no sistema operacional Windows local. Consulte Configurar o Tableau Server para OpenID Connect.

tomcatcontainer.log.level

Valor padrão: info

O nível de registro dos microsserviços no Contêiner de microsserviços interativo e no Contêiner de microsserviços não interativo. Pode ser configurado dinamicamente a partir da versão 2020.4. Portanto, se você estiver apenas alterando, não será necessário reiniciar o Tableau Server. Para obter mais informações, consulte Alterar níveis de registro.

tsm.log.level

Valor padrão: info

Nível de registro de serviços do TSM. Esses registros incluem informações que podem ser úteis se você tiver problemas com os serviços do TSM: Agente de administração, Controlador de administração, Serviço de arquivo do cliente, Controlador de cluster, Gerente de serviço e Serviço de licença. Essa chave de configuração não altera o nível de registro do Serviço de coordenação ou dos processos de manutenção. Para obter mais informações, consulte Alterar níveis de registro e Processos do Tableau Server.

tsm.controlapp.log.level

Valor padrão: info

Nível de registro de serviçoscontrol_<app>. Esses registros incluem informações que podem ser úteis se houver problemas para iniciar ou reconfigurar um processo do TSM ou do Tableau Server. Para obter mais informações, consulte Alterar níveis de registro.

usernotifications.reap_after_days

Valor padrão: 30

Número de dias após o qual uma notificação do usuário será excluída do servidor.

vizportal.adsync.update_system_user

Valor padrão: false

Especifica se os endereços de e-mail e nomes de exibição de usuários serão alterados (mesmo quando alterados no Active Directory) quando um grupo do Active Directory for sincronizado no Tableau Server. Para garantir que os endereços de e-mail e nomes de exibição sejam atualizados durante a sincronização, defina vizportal.adsync.update_system_user como true e, em seguida, reinicie o servidor.

vizportal.alwaysUseEmbeddedShareLinks

Versão: adicionado na versão 2021.3.0

Valor padrão: false

Especifica se a opção Copiar link deve incluir o parâmetro "embed=y". A partir da versão 2019.4, por padrão, não inclui este parâmetro. Definir essa chave de configuração como true altera o comportamento de forma que o parâmetro "embed=y" seja incluído. Para obter detalhes sobre como usar a opção Copiar link para compartilhar links para inserção em páginas da Web, consulte Inserir exibições em páginas da Web(O link abre em nova janela) na Ajuda do Tableau Desktop e Criação na Web.

vizportal.art_skip_list

Versão: adicionado na versão 2024.2.

Valor padrão: null

Use essa chave de configuração para especificar aspectos da funcionalidade do Tableau Server que não usam rastreamento de atividades e recursos (ART) e gerarão grandes quantidades de dados desnecessários enquanto o ART estiver ativado.

Esta chave é usada com vizportal.log_art_java e vizportal.enable_art para solucionar problemas com o Application Server (VizPortal). Quando definido como [preciso de informações aqui sobre como foi definido.] Para saber como usar essa definição de configuração, consulte Resolução de problemas com o Servidor de aplicativos.

vizportal.csv_user_mgmt.index_site_users

Versão: obsoleto na versão 2022.3. Descontinuado (totalmente removido) na versão 2023.3.

Valor padrão: true

Especifica se a indexação de usuários do site é feita de usuário em usuário, durante a importação ou exclusão de usuários com um arquivo CSV. Quando definido como true(o padrão), a indexação é feita à medida que cada usuário é adicionado ou excluído. Para atrasar a indexação de usuários do site até que todo o arquivo CSV seja processado, defina como false.

vizportal.csv_user_mgmt.bulk_index_users

Versão: obsoleto na versão 2022.3. Descontinuado (totalmente removido) na versão 2023.3.

Valor padrão: false

Especifica se a indexação de usuários do site é feita em massa ao importar ou excluir usuários com um arquivo CSV. Quando definido para false (o padrão), a indexação é feita individualmente. Para que a indexação seja feita em massa após o processamento do arquivo CSV, defina como true.

vizportal.enable_art

Versão: adicionado na versão 2024.2.

Valor padrão: false

Esta chave de configuração é usada com vizportal.log_art_java e vizportal.art_skip_list para solucionar problemas com o Application Server (VizPortal). Quando definido como verdadeiro, isso ativa o rastreamento de atividades e recursos no servidor de aplicativos. Para saber como usar essa definição de configuração, consulte Resolução de problemas com o Servidor de aplicativos.

vizportal.log_art_java

Versão: adicionado na versão 2024.2.

Valor padrão: false

Esta chave de configuração é usada com vizportal.enable_art e vizportal.art_skip_list para solucionar problemas com o Application Server (VizPortal). Quando definido como verdadeiro, isso ativa o rastreamento de atividades e recursos no servidor de aplicativos. Para saber como usar essa definição de configuração, consulte Resolução de problemas com o Servidor de aplicativos.

vizportal.oauth.connected_apps.max_expiration_period_in_minutes

Versão: adicionado na versão 2021.4.

Valor padrão: 10

O período máximo, em minutos, que o token da Web JSON (JWT) é válido. No momento em que o JWT é verificado, o Tableau Server verifica se o período especificado no JWT não excede esse valor padrão. Essa configuração é usada quando um aplicativo conectado ao Tableau foi configurado no Tableau Server usando a API REST(O link abre em nova janela) do Tableau.

Por exemplo, para alterar o período máximo para 5 minutos, execute o seguinte comando:

tsm configuration set -k vizportal.oauth.external_authorization_server.max_expiration_period_in_minutes -v 5

vizportal.oauth.external_authorization.enabled

Versão: adicionado na versão 2021.4.

Valor padrão: false

No Tableau Server 2024.2 e posterior, a opção Habilitar aplicativos conectados está habilitada para o Tableau Server. No Tableau Server 2023.2 e versões anteriores, especifica se a opção Habilitar acesso OAuth para inserção de conteúdo está habilitada para o Tableau Server.

Use esta opção para registrar um servidor de autorização externo (EAS) com o Tableau Server para que você possa habilitar a integração do aplicativo. Para obter mais informações, consulte Configurar aplicativos conectados com confiança OAuth 2.0 .

Para habilitar esta opção, execute os seguintes comandos:

tsm configuration set -k vizportal.oauth.external_authorization.enabled -v true

vizportal.oauth.external_authorization_server.blocklisted_jws_algorithms

Versão: adicionado na versão 2021.4.

Valor padrão: ES256K

Quando um servidor de autorização externo (EAS) é registrado, ou um aplicativo conectado é configurado, você pode usar este comando para especificar o algoritmo de assinatura usado no cabeçalho do token da Web JSON (JWT). Para obter mais informações, consulte Configurar aplicativos conectados com confiança OAuth 2.0 ou Uso de aplicativos conectados do Tableau para integração de aplicativos.

Por exemplo, se necessário, você pode executar o seguinte comando para remover o algoritmo:

tsm configuration set - k vizportal.oauth.external_authorization_server.blocklisted_jws_algorithms -v

Importante: o comando de exemplo acima permite algoritmos de assinatura inseguros e deve ser usado apenas para solucionar erros.

vizportal.oauth.external_authorization_server.issuer

Versão: adicionado na versão 2021.4.

Valor padrão: null

Obrigatório. Use este comando para especificar a URL do emissor. A URL do emissor é necessária para registrar o servidor de autorização externo (EAS) com o Tableau Server. Para obter mais informações, consulte Configurar aplicativos conectados com confiança OAuth 2.0.

Por exemplo, se seu EAS for Okta, você pode executar um comando semelhante ao seguinte:

tsm configuration set -k vizportal.oauth.external_authorization_server.issuer -v "https://dev-12345678.okta.com/oauth2/abcdefg9abc8eFghi76j5"

vizportal.oauth.external_authorization_server.jwks

Versão: adicionado na versão 2021.4.

Valor padrão: null

Quando um servidor de autorização externo (EAS) é registrado, você pode usar este comando para especificar a URL do conjunto de chaves da Web JSON (JWKS). A URL do JWKS é necessária se o provedor de identidade (IdP) não expõe o terminal de metadados do servidor de autorização externo.

Por exemplo, se seu IdP for Amazon Cognito, você pode executar um comando semelhante ao seguinte:

tsm configuration set -k vizportal.oauth.external_authorization_server.jwks -v "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_Ab129faBb/.well-known/jwks.json"

vizportal.oauth.external_authorization_server.max_expiration_period_in_minutes

Versão: adicionado na versão 2021.4.

Valor padrão: 10

O período máximo, em minutos, que o token da Web JSON (JWT) é válido. No momento em que o JWT é verificado, o Tableau Server verifica se o período especificado no JWT não excede esse valor padrão. Esta configuração é usada quando um EAS foi registrado no Tableau Server. Para obter mais informações, consulte Configurar aplicativos conectados com confiança OAuth 2.0.

Por exemplo, para alterar o período máximo para 5 minutos, execute o seguinte comando:

tsm configuration set -k vizportal.oauth.external_authorization_server.max_expiration_period_in_minutes -v 5

vizportal.openid.full_server_request_logging_enabled

Valor padrão: false

Especifica se deve ser feito o registro completo da atividade do OpenID.

Defina isso para true ao solucionar problemas do OpenID Connect para coletar registros mais detalhados e permitir que você solucione melhor os problemas.

Assim como em todas as configurações relacionadas ao registro, recomendamos que, após concluir a solução de problemas e coletar os registros, você redefina essa chave para o padrão (false ). Isso limita a quantidade de informações registradas e mantém os tamanhos dos arquivos de registro no mínimo.

vizportal.password_reset

Versão: Substitui features.PasswordReset na versão 2024.2.

Valor padrão: false

Aplica-se apenas aos servidores que usam autenticação local. Defina como truepara permitir que os usuários redefinam suas senhas com a opção "Esqueci a senha" na página de logon.

vizportal.rest_api.cors.enabled

Valor padrão: false

Controla se o Tableau Server permite o Cross Origin Resource Sharing (CORS). Quando definido como true, o servidor permite que os navegadores da Web acessem os endpoints da REST API do Tableau. É possível usar esta opção e a REST API para criar portais personalizados. Por padrão, essa funcionalidade não está habilitada. Para especificar quais origens (sites) têm acesso, use a opção vizportal.rest_api.cors.allow_origin. Somente as origens especificadas com essa opção podem fazer solicitações à REST API do Tableau Server. Para obter mais informações, consulte Habilitação do CORS no Tableau Server.

vizportal.site_user_group_count_enabled

Versão: adicionado na versão 2022.3.5 e posterior, 2023.1.0 e posterior.

Valor padrão: false

Controla se a página Usuários do site incluirá uma coluna mostrando a contagem de grupos para cada usuário.

vizqlserver.force_maps_to_offline

Versão: adicionado na versão 2020.4.0

Valor padrão: false

Determina se o Tableau Server é executado no modo offline para mapas. Isso é útil em ambientes desconectados onde o acesso à Internet e ao servidor de mapas é restrito. Para ativar o modo offline para mapas, defina esse valor para true. Para obter mais informações sobre a instalação e configuração do Tableau Server em um ambiente sem acesso à Internet, consulte Instalar o Tableau Server em um ambiente desconectado (fisicamente isolado).

wgserver.authentication.legacy_identity_mode.enabled

Versão: adicionado na versão 2022.1

Valor padrão: false para Tableau Server 2022.1 e posterior. Para implantações anteriores à 2022.1 do Tableau Server atualizadas para 2022.1 ou posterior, o valor padrão é true.

Definido como false para usar pools de identidades.

Para obter mais informações, consulte Solucionar problemas de pools de identidade.

wgserver.authentication.identity_pools.default_pool_description

Versão: adicionado na versão 2023.1.

Valor padrão: Null

Opcionalmente, você pode adicionar uma descrição para o pool inicial (configurado pelo TSM) à página inicial do Tableau Server e ficar visível para todos os usuários. Quando um ou mais pools de identidades são criados, essa descrição é adicionada abaixo da opção de entrada principal e pode ser usada para ajudar a orientar os usuários que pertencem ao grupo inicial (TSM configurado) para a opção de entrada correta.

Por exemplo, para adicionar uma descrição “Funcionários regulares entrem aqui”, você pode usar o seguinte comando:

tsm configuration set -k wgserver.authentication.identity_pools.default_pool_description -v “Regular employees sign in here"

Observação: a descrição inicial do conjunto (configurado pelo TSM) é diferente da observação Personalização de logon. A observação de personalização de logon é exibida na página inicial do Tableau Server abaixo de todas as opções de logon e na página em que os usuários do pool inicial (TSM configurado) inserem o nome de usuário e a senha.

wgserver.domain.accept_list

Version: foi adicionado na versão 2020.4.0 e substitui wgserver.domain.whitelist.

Valor padrão: nulo

Viabiliza a conexão do Tableau Server com os domínios secundários do Active Directory. O Tableau Server é conectado a um domínio secundário para sincronização de usuários, porém o Tableau Server não está instalado nesse domínio. O Tableau Server tenta se conectar a domínios secundários para sincronização de usuários e grupos. Em alguns casos, não é possível conectar o Tableau Server ao domínio secundário, o que resulta no erro: “O domínio não está na lista de permissões (errorCode=101015)”.

A configuração da opção wgserver.domain.accept_list é exigida por uma correção da vulnerabilidade de segurança, [Importante] ADV-2020-003: autenticação forçada do Tableau Server(O link abre em nova janela). A partir de fevereiro de 2020, a correção dessa vulnerabilidade está incluída em todas as versões mais recentes e versões de manutenção do Tableau Server.

Para definir essa opção, digite o domínio secundário entre aspas duplas. Vários domínios devem ser separados por vírgula e espaço. Por exemplo, tsm configuration set -k wgserver.domain.accept_list -v "example.org, domain.com".

A funcionalidade Curinga não é aceita. Por exemplo, se o Tableau for conectado a sub1.example.org e sub2.example.org, os dois domínios deverão ser adicionados.

A atualização da opção wgserver.domain.accept_list substitui o valor atual. Portanto, se você estiver adicionando um novo domínio a um conjunto de domínios existentes armazenados no valor, inclua todos os domínios existentes com o novo domínio ao definir a opção. É possível recuperar a lista completa de domínios existentes, executando tsm configuration get –k wgserver.domain.accept_list.

wgserver.domain.allow_insecure_connection

Valor padrão: False

Essa configuração só se aplica ao Windows. Esta opção especifica se o Tableau Server se conectará ao Active Directory por meio de um canal não criptografado. O valor padrão, False, impõe um canal criptografado. Se o canal LDAP não estiver criptografado, o Tableau Server não se conectará ao Active Directory.

A infraestrutura do Active Directory deve gerenciar certificados e confiar em computadores associados ao domínio. Dessa forma, o canal de comunicação entre os recursos do Tableau Server e do Active Directory deve ser criptografado. Não recomendamos permitir comunicações não criptografadas com o Active Directory, pois essa configuração é vulnerável a ataques man-in-the-middle.

Se você estiver atualizando para o Tableau Server 2021.2 ou posterior e seu canal LDAP não estiver criptografado, a atualização falhará. Você pode executar este comando para permitir uma conexão insegura em versões mais antigas do Tableau Server, antes de atualizar. Se você estiver executando este comando em uma versão anterior a 2021.2, deverá incluir a opção com o comando --force-keys.

wgserver.domain.fqdn

Valor padrão: valor de %USERDOMAIN%

O nome de domínio totalmente qualificado do servidor Active Directory a ser usado.

wgserver.domain.password

Valor padrão: nulo

Especifica a senha da conta de usuário usada para conexão LDAP. Consulte a Referência de configuração do armazenamento de identidades externo.

wgserver.domain.username

Valor padrão: nulo

Especifica o nome da conta de usuário usada para conexão LDAP. Consulte a Referência de configuração do armazenamento de identidades externo.

wgserver.domain.whitelist

Importante: essa chave está obsoleta desde a versão 2020.4.0. Em vez disso, use wgserver.domain.accept_list .

Valor padrão: nulo

Viabiliza a conexão do Tableau Server com os domínios secundários do Active Directory. O Tableau Server é conectado a um domínio secundário para sincronização de usuários, porém o Tableau Server não está instalado nesse domínio. O Tableau Server tenta se conectar a domínios secundários para sincronização de usuários e grupos. Em alguns casos, não é possível conectar o Tableau Server ao domínio secundário, o que resulta no erro: “O domínio não está na lista de permissões (errorCode=101015)”.

wgserver.ignore_domain_in_username_for_matching

Versão: adicionado nas versões 2021.4.21, 2022.1.17, 2022.3.9 e 2023.1.5

Valor padrão: false

Ao ativar o SAML, você pode configurar o Tableau Server para ignorar a parte do domínio do atributo de nome de usuário SAML ao combinar o nome de usuário do provedor de identidade (IdP) com uma conta de usuário no Tableau Server. Você pode ignorar a parte do domínio do atributo nome de usuário quando já tiver usuários definidos no Tableau Server que correspondam à parte do prefixo de um atributo de nome de usuário, mas não à parte do domínio do atributo de nome de usuário. Para obter mais informações, consulte a seção Ignorar domínio ao corresponder ao atributo de nome de usuário SAML no tópico Requisitos SAML.

Por exemplo, para ignorar o nome de domínio no atributo de nome de usuário SAML, execute o seguinte comando:

tsm configuration set -k wgserver.ignore_domain_in_username_for_matching -v true

Importante:

• não recomendamos nome de domínio sem tomar precauções. Especificamente, verifique se os nomes de usuário são exclusivos em todos os domínios configurados que você criou no seu IdP.
• Este comando só funciona em implantações do Tableau Server que estão em legacy-identity-mode ou implantações que não foram atualizadas por meio do migração de identidade(O link abre em nova janela) para usar o Serviço de Identidade.

wgserver.saml.blocklisted_digest_algorithms

Versão: adicionado na versão 2021.1.

Valor padrão: SHA1

Especifica os algoritmos de hash que não são permitidos para qualquer assinatura de certificado SAML ou método de compilação de asserção SAML ou métodos de assinatura relevantes. Quando definidas, os certificados ou as asserções assinadas e com hash e um algoritmo bloqueado falharão.

Existem vários locais onde o SHA-1 pode ser usado no Tableau e no IdP. Por exemplo:

• Certificados carregados com TSM que são usados pelo Tableau Server para assinar a solicitação que é enviada ao IdP.
• Certificados nos metadados IdP usados para verificar o AuthnResponse (assinatura) recebido do IdP usando a chave pública no Certificado.
• Asserções de entrada assinadas e hash com SHA-1 (DigestMethod definido como SHA-1 e SignatureMethod definido como SHA-1).

O valor padrão foi alterado para (SHA1 no Tableau Server 2021.2. Para obter mais informações sobre como atualizar para 2021.2 com SAML configurado, consulte o artigo da Base de dados de conhecimento, Tableau Server usando a autenticação SAML falha ao iniciar ou rejeita o logon após a atualização para o Tableau Server 2021.2.

wgserver.saml.forceauthn

Versão: adicionado na versão 2019.3.

Valor padrão: false

Quando definido para true, se a sessão de usuário do Tableau expirar, o Tableau Server reautenticará o usuário com o IdP. Essa opção também pode ser usada para solicitar que o IdP solicite a reautenticação do usuário, mesmo se o usuário tiver uma sessão IdP ativa.

wgserver.saml.min_allowed.elliptic_curve_size

Valor padrão: 256

Versão: adicionado na versão 2021.1, mas não incluiu um valor padrão. Em 2021.2, o valor padrão foi definido como256.

Essa opção especifica o tamanho mínimo da curva ECDSA permitido para o certificado usado para autenticação SAML. Se você carregar um certificado com um tamanho de curva ECDSA menor que 256, o TSM registrará um erro quando você aplicar as alterações.

Se você estiver atualizando para o Tableau Server 2021.2 ou posterior e seu certificado SAML usar um tamanho de curva ECDSA inferior a 256, o Tableau Server não será iniciado após a atualização. Recomendamos fazer upload de um novo certificado com tamanho de curva ECDSA 256 (ou maior) antes da atualização. Como alternativa, você pode executar este comando para definir um tamanho de curva ECDSA inferior em versões mais antigas (pré-2021.1) do Tableau Server antes de atualizar. Se você estiver executando este comando em uma versão anterior a 2021.1, você deve incluir a opção --force-keys com o comando. Para obter mais informações sobre como atualizar para 2021.2 com SAML configurado, consulte o artigo da Base de dados de conhecimento, Tableau Server usando a autenticação SAML falha ao iniciar ou rejeita o logon após a atualização para o Tableau Server 2021.2.

wgserver.saml.min_allowed.rsa_key_size

Valor padrão: 2048

Versão: adicionado na versão 2021.1, mas não incluiu um valor padrão. Em 2021.2, o valor padrão foi definido como2048.

Esta opção especifica o comprimento mínimo permitido da chave RSA para o certificado usado para autenticação SAML. Se você carregar um certificado com um comprimento de chave RSA inferior a 2048, o TSM registrará um erro quando você aplicar as alterações.

Para executar a autenticação SAML com um comprimento de chave 1024 RSA (não recomendado), defina este valor como 1024.

Se você estiver atualizando para o Tableau Server 2021.2 ou posterior e seu certificado SAML usar um comprimento de chave inferior a 2048, o Tableau Server não será iniciado após a atualização. Recomendamos fazer upload de um novo certificado com 2048 (ou maior) de comprimento de chave antes de fazer o upgrade. Como alternativa, você pode executar este comando para definir uma intensidade de chave inferior em versões mais antigas (pré-2021.1) do Tableau Server antes de atualizar. Se você estiver executando este comando em uma versão anterior a 2021.1, você deve incluir a opção --force-keys com o comando. Para obter mais informações sobre como atualizar para 2021.2 com SAML configurado, consulte o artigo da Base de dados de conhecimento, Tableau Server usando a autenticação SAML falha ao iniciar ou rejeita o logon após a atualização para o Tableau Server 2021.2.