tsm configuration set 選項

以下是您可以使用 tsm configuration set 命令進行設定之組態選項或金鑰的清單。在許多情況下,您可以使用 tsm configuration get 命令找出組態金鑰目前的值。

此清單並非 Tableau Server 組態設定的完整清單。其中僅顯示伺服器管理員可設定的部分組態金鑰。最終,Tableau Server 內部使用的某些金鑰並未顯示在此清單中。

附註:組態金鑰區分大小寫。

使用 tsm CLI

您可在初始節點(安裝 TSM 的所在節點),或是叢集中的任何其他節點上執行 tsm 命令。

若要執行 tsm 命令,您必須開啟 Windows 命令提示字元。請勿使用 PowerShell 執行 tsm 命令。使用 PowerShell 可能會出現非預期的行為。

  1. 使用屬於叢集中節點上的「管理員」群組成員的帳戶開啟 Windows 命令提示字元。

  2. 執行您要的命令。如果您透過非初始節點執行命令,請加入 -s 選項以按照名稱(而非 IP 位址)指定初始節點的 URL,以及加入 TSM 連接埠 8850。

    若要從初始節點查看 TSM 和 Tableau Server 的版本:

    tsm version

    若要從其他節點查看 TSM 和 Tableau Server 的版本:

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

    例如:

    tsm version -s https://myTableauHost:8850

tsm 組態金鑰的基本用途

設定組態金鑰

tsm configuration set -k <config.key> -v <config_value>

在某些情況下,必須加入 --force-keys 選項才能針對先前尚未設定之金鑰的組態值進行設定。有關詳情,請參閱「不明金鑰」回應

設定組態金鑰值之後,您必須使用 tsm pending-changes apply 套用待定組態變更。在您執行該操作之前,新值將不會由 Tableau 使用或顯示在 tsm configuration get 命令的結果中。您可以使用 tsm pending-changes list 檢視待定變更。有關詳情,請參閱 tsm pending-changes

將組態金鑰重設為預設值

若要將設定鍵重設回其預設值,請使用 -d 選項:

tsm configuration set -k <config.key> -d

檢視組態金鑰目前的值

若要檢視組態機碼目前的設定,請使用 configuration get 命令:

tsm configuration get -k <config.key>

在以下兩種特殊情況下,不會為金鑰傳回有用的目前值:

  • 在某些情況下,無法取得未明確設定之金鑰的組態值。系統會改以 tsm configuration get 命令傳回「不明金鑰」反應。有關詳情,請參閱「不明金鑰」回應

  • 對於具有預定義預設值的某些金鑰, tsm configuration get 命令會傳回「Null」回應。有關更多資訊,請參閱「Null」值回應

組態金鑰

adminviews.disabled

預設值:false

停用 Tableau 管理檢視存取。預設情況下,檢視存取為啟用狀態(此選項設定為「false」)。

api.server.enabled

版本:在版本 2023.1 中已被取代。無法在版本 2023.1 及更高版本中停用 REST API。

預設值:true

允許存取 Tableau Server REST API(連結在新視窗開啟)

預設情況下,此功能已啟用。我們強烈建議您保持此設定。停用 REST API 會破壞 Tableau 的大量功能,不會提高效能或增強安全性。若選擇在安裝 Tableau Server 時停用 REST API,請仔細測試需要的功能。

停用 REST API 影響的功能包括:

  • 搜尋
  • 我的最愛
  • 集合
  • 內容管理工具 (CMT)
  • Resource Monitoring Tool (RMT)
  • 個人空間

auditing.enabled

預設值:true

允許存取 PostgreSQL(Tableau Server 自己的資料庫)歷史審計表。

backgrounder.default_run_now_priority

預設值(整數):0

此設定控制指派哪個工作優先順序來執行目前的工作,其中 0 為最高工作優先順序。應指定的值應在 0 到 100 之間。

backgrounder.enable_parallel_adsync

版本: 2018.3.6 版本中新增

預設值:false

控制在有多個背景程式時是否允許並行處理外部目錄群組同步作業。預設情況下,是由單一背景程式串列處理外部目錄群組排程同步作業。將此設定為 true 在多個背景程式執行個體上啟用並行處理。

backgrounder.externalquerycachewarmup.enabled

版本:在版本 2023.1 中已被取代。要縮短工作簿的檢視載入時間,請改為在站台上允許檢視加速

預設值:false

在排程的擷取重新整理任務之後控制工作簿查詢結果緩存。

backgrounder.externalquerycachewarmup.view_threshold

版本:在版本 2023.1 中已被取代。要縮短工作簿的檢視載入時間,請改為在站台上允許檢視加速

預設值:2.0

用於在排程擷取重新整理任務之後緩存工作簿查詢結果的閾值。此閾值等於工作簿在過去七天內收到的檢視數除以未來七天內排程的重新整理次數。

下列兩個 backgrounder 命令選項決定流程工作在取消流程背景工作之前可以執行的時間。這兩個命令共同決定流程工作的總逾時值。

backgrounder.extra_timeout_in_seconds

預設值:1800

取消幕後工作之前超出 backgrounder.querylimit 中的設定的秒數。此設定可確保停止的工作不會阻止後續工作。此設定適用於 backgrounder.timeout_tasks 中列出的處理序。1800 秒是 30 分鐘。

backgrounder.default_timeout.run_flow

預設值:14400

取消流程執行任務前的秒數。14,400 秒是 4 小時。

backgrounder.failure_threshold_for_run_prevention

預設值:5

工作掛起前訂閱、擷取或流程執行工作連續失敗的次數。掛起連續失敗的作業有助於為其他作業保留幕後程式資源。若要停用掛起失敗的幕後工作,請將其設定為 -1

backgrounder.log.level

版本:在版本 2020.3.0 中新增。

預設值:info

背景程式流程的記錄層級。這是可動態設定的,因此,如果您只是加以變更,不必重新啟動 Tableau Server。有關詳情,請參閱變更記錄層級

backgrounder.querylimit

預設值:7200

完成一次擷取重新整理工作允許的最長時間,以秒為單位。7200 秒 = 2小時。

附註: 如果幕後工作達到此時間限制,則在被取消的同時,它可以繼續額外執行幾分鐘。

backgrounder.restrict_serial_collections_to_site_level

預設值:false

在 Tableau Server 中,可以將擷取重新整理、訂閱或流程排程為定期執行。這些排程項目稱為「工作」。背景程式處理序會在排定的時間啟動這些工作的唯一執行個體以執行它們。因此,所啟動工作的唯一執行個體稱為「作業」。

此設定會影響設定為串列執行的排程。預設情況下,當排程設定為串列執行時,使用該排程的所有工作都將串列執行。當此設定設為true,在不同站台上執行的工作可以並行執行。同一站台上排程任務的工作將繼續串列執行。

下面的範例說明了這種情況:

Tableau Server 包含一個名為「每日」的排程,用於每天早上七點執行工作。「每日」排程設定為串列執行。站台「人資」和站台「工資單」各有多個使用排程「每日」的排程任務。當此設定設為true,站台「人資」上這些排程任務的工作可以與站台「工資單」上的工作並列執行,而同一站台上的工作依然只能串列執行。

backgrounder.notifications_enabled

預設值:true

控制是否為伺服器上的所有網站啟用擷取重新整理和流程執行警示。預設情況下啟用了通知。若要為伺服器上的所有網站禁用警示,請將此項設定為 false

網站管理員可以在網站設定中按網站或在使用者設定中的使用者層級啟用或禁用擷取通知。

backgrounder.sort_jobs_by_type_schedule_boundary_heuristics_milliSeconds

預設值:60000

控制時間視窗,此時間視窗標識被確定為具有相同排程開始時間的幕後程式作業。

幕後程式處理序會對按作業類型排程在同一時間執行的工作進行排序,首先執行最快類別的作業:訂閱,然後是增量擷取,最後是完整擷取。

系統會對作業進行批次處理以確定「同時」安排的作業。值 60,000 毫秒(預設值)表示在 1 分鐘時間視窗內啟動的排程作業應歸類為同一批,因此應在該批內按類型進行排序。

backgrounder.subscription_failure_threshold_for_run_prevention

預設值:5

決定在警示條件擱置前必須發生的連續訂閱失敗次數。設定為預設值 5 時,會在 5 次連續訂閱失敗後擱置警示。值 -1 將允許通知電子郵件無限期繼續。此閾值為全伺服器設定,因此適用於伺服器上定義的所有訂閱。

backgrounder.subscription_image_caching

預設值:true

控制幕後程式是否緩存為訂閱產生的影像。不必每次重新產生緩存的影像,因此緩存可提高訂閱性能。預設情況下已啟用影像緩存。若要為伺服器上的所有網站禁用影像緩存,請將此項設定為 false

backgrounder.timeout_tasks

預設值:預設值可能會有所不同,具體取決於您的Tableau Server 版本。要查看 Tableau 版本預設值列表,請執行tsm configuration get命令:

tsm configuration get -k backgrounder.timeout_tasks

執行時間比 backgrounder.querylimitbackgrounder.extra_timeout_in_seconds 中的組合值長時可取消的任務的清單。此任務清單用逗號分隔。預設清單表示此設定的所有可能的值。

backgrounder.timeout.single_subscription_notify

版本:在版本 2021.2 中新增。

預設值:1800 秒(30 分鐘)

這是完成單個訂閱工作的最長允許時間(以秒為單位)。

backgrounder.timeout.sync_ad_group

版本: 在版本 2021.1.23、2021.2.21、2021.3.20、2021.4.15、2022.1.11、2022.3.3、2023.1 中新增。

預設值:14400 秒(4 小時)

這是完成 Active Directory 群組同步的最長允許時間(以秒為單位)。這適用於由後台程序服務完成對排程群組同步,防止長期執行的同步無限期執行。這不會影響使用 Tableau Server UI 或 REST API 完成的群組同步。

backgrounder.vInstances_max_overflow_queue_size

版本:在版本 20221.2 中新增。

預設值:1000

可以在從屬隊列中的最大作業數。執行的作業數量達到設定的並發限制後,將建立從屬隊列。預設最大值為 1000 個作業 - 這意味著如果在達到並發限制時有超過 1000 個作業,則任何超過 1000 個作業都不會排隊。使用 backgrounder.vInstance_max_overflow_queue_size tsm 命令變更溢出最大隊列大小。

這些值應以整數指定。

backup.zstd.thread_count

版本:在版本 2021.1.0 中新增。此金鑰可動態設定。有關詳情,請參閱 Tableau Server 動態拓撲變更

預設值: 2

建立備份時應使用的執行緒數。

增加此數字可以提高備份效能,但建議執行緒數不超過 Tableau Server 電腦上的邏輯處理器數字(最多四個)。

basefilepath.backuprestore

預設值:C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\backups\

tsm maintenance backup 命令建立備份的位置。這也是使用 tsm maintenance restore 命令或 tsm maintenance send-logs 命令還原時,備份檔案必須存在的位置。設定後,應該執行tsm maintenance validate-backup-basefilepath命令(在 2022.1 及更高版本中可用),驗證是否為該位置正確設定了權限。有關詳情,請參閱tsm File Paths

basefilepath.log_archive

預設值:C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\log-archives\

tsm maintenance ziplogs 命令建立壓縮封存的位置。有關詳情,請參閱tsm File Paths

basefilepath.site_export.exports

預設值:C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\siteexports\

tsm sites export 命令建立匯出檔案的位置。有關詳情,請參閱tsm File Paths

basefilepath.site_import.exports

預設值:C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\siteimports\

tsm sites import 命令希望匯入檔案所在的位置。有關詳情,請參閱tsm File Paths

clustercontroller.log.level

版本:在版本 2020.3.0 中新增。

預設值:info

「叢集控制器」的記錄層級。這是可動態設定的,因此,如果您只是加以變更,不必重新啟動 Tableau Server。有關詳情,請參閱變更記錄層級

clustercontroller.zk_session_timeout_ms

預設值:300000

叢集控制器在確定需要容錯移轉之前將等待協調服務的時間長度(以毫秒為單位)。

dataAlerts.checkIntervalInMinutes

預設值:60

Tableau Server 進行檢查以判定資料警示條件是否為 True 的頻率,單位:分鐘。

(每當重新整理與資料警示相關的擷取時,伺服器也會進行檢查。)

dataAlerts.retryFailedAlertsAfterCheckInterval

預設值:true

決定 Tableau Server 重新檢查失敗資料警示的頻率。如果設定為 true,伺服器將按 dataAlerts.checkIntervalInMinutes 定義的頻率重新檢查失敗通知。如果設定為 false,伺服器將每隔五分鐘重新檢查失敗通知,從而能在資料狀況發生變更時更快地向通知收件人發出通知,但會降低伺服器性能。

(每當重新整理與資料警示相關的擷取時,伺服器也會進行檢查。)

dataAlerts.SuspendFailureThreshold

預設值:350

判斷在條件擱置而發出警示前必須發生的連續資料警示失敗次數。預設值設為 350 時,警示大約會在為期 2 週的警示後擱置。此閾值為全伺服器設定,因此適用於伺服器上定義的所有資料警示。

databaseservice.max_database_deletes_per_run

版本:在版本 2021.2 中新增。

預設值:Null

使用此選項可調整每次後台過程執行時可刪除的內嵌外部資產(資料庫和表格)的最大數量,由features.DeleteOrphanedEmbeddedDatabaseAsset控制。如果此選項空白,則可刪除的內嵌外部資產的預設最大數量為 100。

有關詳情,請參閱 features.DeleteOrphanedEmbeddedDatabaseAsset

dataserver.log.level

版本:在版本 2020.3.0 中新增。

預設值:info

「資料伺服器」的記錄層級。這是可動態設定的,因此,如果您只是加以變更,不必重新啟動 Tableau Server。有關詳情,請參閱變更記錄層級

dataserver_<n>.port

執行資料伺服器執行個體(由「<n>」指定)的連接埠。

elasticserver.vmopts

版本:在版本 2019.1 中新增。已移除:2022.1

此配置選項對 Tableau Server 版本 2022.1 及更高版本無效。對於 Tableau Server 版本 2022.1 及更高版本,請使用 indexandsearchserver.vmopts 組態選項

預設值:「-Xmx<default_value> -Xms<default_value>

預設值會因系統記憶體數量而有所不同。JVM 的最大堆積大小已調整為系統總 RAM 的 3.125%。

控制彈性伺服器堆積大小。由於預設值會自動調整,因此僅在絕對必要時使用此選項覆寫預設值。將字母「k」附加到值表示 KB、附加「m」表示 MB,附加「g」表示 GB。一半情況下,將初始堆積大小 (-Xms) 設定為等於最大堆積大小 (-Xmx) 以最大程度地減小記憶體回收。

excel.shadow_copy_all_remote.enabled

版本:在 2019.1.5、2019.2.1 版本中增加。

預設值:false

控制 Tableau Server是否會對用來做為即時資料來源的共用 Excel 試算表(.xlxs.xlxm),建立「陰影複製」。啟用時,這個選項會防止 Excel 使用者看到「共用違規錯誤」,以及檔案「目前正在使用中」的訊息。這個選項對於大型的 Excel 檔案可能會有效能上的影響。如果 Excel 使用者不需要編輯共用檔案,則不需要啟用這個選項。

附註:Tableau Server 一律會嘗試建立 .xls 檔案的陰影複製。此選項不會變更該行為。

extractservice.command.execution.timeout

版本:在版本 2021.4 中新增。

預設值:7200

設定 VConn 資料擷取重新整理執行時間的逾時值。

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

請注意: 您必須使用 --force-keys 選項變更此值。

功能。ActiveMQ

版本:在版本 2021.4 中新增。

預設值:true

控制 Tableau Server 是否使用 Apache ActiveMQ 服務(Tableau Server 傳訊服務)作為內部傳訊機制。

features.DeleteOrphanedEmbeddedDatabaseAsset

版本版本 2021.2 中新增。

預設值:true

控制 Tableau Catalog(或 Tableau 中繼資料 API)的後台過程,該拓程刪除不再與下游 Tableau 內容關聯的內嵌外部資產(資料庫和表格)。此過程每天在 22:00:00 UTC(國際標準時間)執行,並且每天最多可以刪除 100 個外部資產,直到沒有與下游 Tableau 內容沒有連線的剩餘外部資產。可以將此選項設定為false以阻止此過程執行。databaseservice.max_database_deletes_per_run 調整可刪除的外部內嵌資產的最大數量。

有關詳情,請參閱缺少內容疑難排解

features.DesktopReporting

預設值:false

控制是否在伺服器上啟用桌面授權報告。設定為 false(預設值)時,則沒有與桌面授權相關的管理檢視可用。將此選項設定為 true 可啟用授權報告,並讓授權使用情況及過期管理檢視在「伺服器狀態」頁面上可見。附註:必須在用戶端 (Tableau Desktop) 上啟用桌面授權報告,才能將資訊報告給 Tableau Server。

features.IdentityMigrationBackgroundJob

版本:新增至版本 2022.1。在版本 2021.4.22、2022.1.18、2022.3.10、2023.1.6 和 2023.3 中,預設值變更為 false

預設值:false

控制執行身分移轉的處理序。設定為 true 後,將 Tableau Server 升級至版本 2022.1(或更高版本)並還原 Tableau Server 版本 2021.4(或更早版本)的備份後,立即在現有部署中執行身分移轉。設定為 false (預設)停用身分移轉。

例如,要開始身分移轉,請執行以下命令:

tsm configuration set -k features.IdentityMigrationBackgroundJob -v true

有關詳情,請參閱關於身份識別遷移

附註: 如果停用身分移轉,Tableau Server 將無法使用身分服務儲存與管理使用者身分資訊。使用身分服務是某些功能的先決條件,例如 身分集區

features.IdentityPools

版本:版本 2023.1 中新增

預設值:false

如果執行全新 Tableau Server 安裝,則需要啟用身分集區功能的元件。需要將 feature.NewIdentityModewgserver.authentication.legacy_identity_mode.enabled 設定為 true 以啟用身份集區。設定為 false (預設)停用身分集區。

例如,要啟用身分集區,請執行以下命令:

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

有關詳情,請參閱身分集區疑難排解

功能。MessageBusEnabled

版本:在版本 2019.4 中新增。

預設值:true

控制 Tableau Server 是否使用新的內部傳訊機制。

features.NewIdentityMode

版本:版本 2022.1 中的新增功能

預設值:false。在 2023.1.6 中,預設值已從 true 變更為 false

身份集區功能的附加條件。需要將 wgserver.authentication.legacy_identity_mode.enabled 設定為 false 以啟用身份集區。設定為 true (預設)停用身分集區。

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

有關詳情,請參閱身分集區疑難排解

features.PasswordlessBootstrapInit

預設值:true

控制 Tableau Server 是否允許在啟動程序檔案包含內嵌認證。啟用(預設值)時,除非您指定不應包含內嵌認證,否則內嵌認證包含在啟動程序檔案中。如果認證不應包含在您產生的任何啟動程序檔案中,請將此設定為 false。有關產生啟動程序檔案的詳情,請參閱 tsm topology nodes get-bootstrap-file

從 Tableau Server 2019.3 版本起已加入此選項。

features.PasswordReset

預設值:false

僅適用於使用本地驗證的伺服器。設定為 true 可讓使用者在登入頁面上使用「忘記密碼」選項重設密碼。

filestore.empty_folders_reaper.enabled

版本在 2020.x(2020.1.14、2020.2.11、2020.3.6、2020.4.2)和 2021.1.x 中新增。在 2021.2 中,預設值已變更為 true

預設值:true

啟用「收穫」(移除)清空檔案存儲資料夾的工作。

filestore_empty_folders_reap.frequency_s

版本:在 2020.x(2020.1.14、2020.2.11、2020.3.6、2020.4.2)中新增。

預設值: 86400(24 小時)

以分鐘為單位,指定執行刪除空檔案存儲資料工作的頻率。

features.Hyper_DisallowTDEPublishing

版本:從版本 2023.1.0 開始預設為 true

預設值:true

指定使用者是否可以上傳 .tde 格式檔案。從 Tableau Server 10.5 版本開始,此格式已被 .hyper 格式取代,但未阻止上傳。若執行了多個動作之一,檔案會自動轉換為 .hyper 格式。有關詳情,請參閱擷取升級為 .hyper 格式

filestore.log.level

features.Hyper_DisallowTDEPublishing

版本:在版本 2020.3.0 中新增。

預設值:info

「檔案存放區」的記錄層級。這是可動態設定的,因此,如果您只是加以變更,不必重新啟動 Tableau Server。有關詳情,請參閱變更記錄層級

filestore.reapemptyfoldersholdoffms

版本:在 2020.x(2020.1.14、2020.2.11、2020.3.6、2020.4.2)中新增。這在 2021.1 中尚不可用。

預設值:300000 (5分鐘)

以毫秒為單位,指定刪除空檔案存儲資料夾之前等待的時間。

floweditor.max_datafile_upload_size_in_kb

版本:在版本 2020.4 中新增

預設值:1048576

對於 Tableau Prep 流程 Web 製作,可以上傳到 Tableau Server 的分隔文字檔(例如 CSV 或 TXT)的最大大小。

gateway.external_url

版本:版本 2023.1 中新增

預設值:Null

在 Tableau Server 設定期間在 TSM 中設定或使用身分識別集區設定 OpenID Connect (OIDC) 驗證時需要。指定身分識別提供者 (IdP) 使用的 Tableau Server URL,以將經過驗證的使用者重新導向到 Tableau。閘道外部 URL 與您指定為 IdP 的重新導向 URL 相同,用於比對目的。

例如,要將與 OIDC 驗證設定關聯的 IdP 重新導向到您的 Tableau Server http://myco,請執行以下命令:

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

gateway.http.cachecontrol.updated

預設值:false

快取控制 HTTP 標頭指定用戶端瀏覽器是否應該快取從 Tableau Server 傳送的內容。若要停用用戶端上的 Tableau Server 資料快取,請將此選項設定為 true

gateway.http.hsts

預設值:false

HTTP 嚴格傳輸安全性 (HSTS) 頭強制瀏覽器在啟用它的域上使用 HTTPS。

gateway.http.hsts_options

預設值:"max-age=31536000"

預設情況下,會為一年(31536000 秒)期間設定 HSTS 原則。此時間段指定瀏覽器將透過 HTTPS 存取伺服器的時間量。

gateway.httpd.loglevel

版本:在 2021.3.0 中新增。

預設值:notice

指定「閘道」(Apache HTTPD 伺服器)的記錄層級。預設情況下其設定為 notice。其他選項包括 debuginfowarningerror。如果變更記錄層級,請注意對磁碟空間使用和效能的潛在影響。最佳做法是,在收集到所需資訊後,將記錄層級恢復為預設值。有關 Apache 記錄的詳細資訊,請參閱Apache HTTP 文件(連結在新視窗開啟)

gateway.httpd.shmcb.size

版本: 在 2021.4 中新增

預設值:2048000

指定使用時循環緩衝區的內存量(以位元為單位)shmcb存儲類型。此組態金輪在使用時dbm存儲類型時不可套用。

gateway.httpd.socache

版本: 在 2021.4 中新增

預設值:shmcb

指定全域/處理程序內部 SSL 工作階段快取的存儲類型。預設情況下,將其設定為shmcb,附帶另一個可設定選項dbm.有關 shmcbdbm儲存類型的詳細資訊,請參閱 Apache 網站中的SSLSessionCache 指令(連結在新視窗開啟)

gateway.http.request_size_limit

預設值:16380

允許根據 HTTP 請求透過 Apache 閘道傳遞的標頭內容的大小上限(位元組)。標頭超過此選項上設定的值將導致瀏覽器錯誤,如 HTTP 錯誤 413(請求實體太大)或驗證失敗。

gateway.http.request_size_limit 的值較低可能會導致驗證錯誤。與 Active Directory(SAML 和 Kerberos)整合的單一登入解決方案在 HTTP 標頭中經常需要大型驗證權杖。一定要在部署到生產環境之前測試 HTTP 驗證方案。

我們建議將 tomcat.http.maxrequestsize 選項設定為您為此選項設定的相同值。

gateway.http.x_content_type_nosniff

預設值:true

X-Content-Type-Options 回應 HTTP 頭指定 Content-Type 頭中的 MIME 類型不應由瀏覽器變更。在某些情況下,如果未指定 MIME 類型,則瀏覽器可能會透過評估有效負載的特徵來嘗試確定 MIME 類型。然後瀏覽器將相應地顯示內容。這個過程被稱為「嗅探」。誤解 MIME 類型可能會導致安全性漏洞。預設情況下,系統使用此選項將 X-Content-Type-Options HTTP 頭設定為「nosniff」。

gateway.http.x_xss_protection

預設值:true

HTTP X-XSS-Protection 回應頭會傳送到瀏覽器以啟用跨網站指令碼 (XSS) 保護。在使用者在瀏覽器中停用XSS 保護的情況下,X-XSS-Protection 回應頭會覆蓋設定。預設情況下,系統使用此選項啟用了 X-XSS-Protection 回應頭。

gateway.log.level

版本:在版本 2020.3.0 中新增。

預設值:info

閘道的記錄層級。這是可動態設定的,因此,如果您只是加以變更,不必重新啟動 Tableau Server。有關詳情,請參閱變更記錄層級

gateway.public.host

預設值:<hostname>

伺服器的名稱 (URL),用於對 Tableau Server 進行外部存取。如果將 Tableau Server 設定為使用 Proxy 伺服器或外部負載平衡器,則它是在瀏覽器位址欄中輸入的用於存取 Tableau Server 的名稱。例如,如果透過輸入 tableau.example.com 來存取 Tableau Server,則 gateway.public.host 的名稱是 tableau.example.com

gateway.public.port

預設值:80 (如果採用 SSL,則為 443

僅適用於 Proxy 伺服器環境。 Proxy 伺服器所偵聽的外部埠。

gateway.slow_post_protection.enabled

預設值:true

啟用後,可以使極慢速率傳輸資料的 POST 請求逾時來防止慢速 POST(拒絕服務)攻擊。

附註: 此選項無法消除此類攻擊的威脅,並且可能會有終止慢速連線的意外影響。

gateway.slow_post_protection.request_read_timeout

預設值:header=10-30,MinRate=500 body=30,MinRate=500

透過前面的選項 gateway.slow_post_protection.enabled 啟用後,此選項會設定 Apache httpd ReadRequestTimeout。httpd 指示詞會記錄在 Apache 模組 mod_reqtimeout(連結在新視窗開啟)。此選項的主要用途做為防禦 Slowloris 攻擊。請參閱 Wikipedia 條目 Slowloris (computer security)(連結在新視窗開啟)

附註:舊版本使用預設值:header=15-20,MinRate=500 body=10,MinRate=500

gateway.timeout

預設值:7200

閘道在請求失敗前等待某些事件的最長時間,以秒為單位(7200 秒= 2 小時)。

gateway.trusted

預設值:Proxy 伺服器機器的 IP 位址

僅適用於 Proxy 伺服器環境。 Proxy 伺服器的 IP 位址或主機名稱。

gateway.trusted_hosts

預設值: Proxy 伺服器的備用名稱

僅適用於 Proxy 伺服器環境。 Proxy 伺服器的任何備用主機名稱。

hyper.file_partition_size_limit

預設值:0

設為 0 時,大小會設為不限制並將使用所有可用的磁碟空間。

此選項用於設定多工緩衝處理至磁碟之查詢的磁碟空間限制。如果 spool.<id>.tmp 檔案的磁碟空間使用量大於環境所需使用量,則意味著查詢正在進行多工緩衝處理並佔用磁碟空間。使用此選項可限制任一查詢可使用的磁碟空間量。spool.<id>.tmp 檔案可在執行 Tableau Server 的使用者帳戶的 temp 資料夾中找到。您可以以 K(KB)、M(MB)、G(GB) 或 T(TB) 為單位指定此值。例如,當您要將磁碟空間使用量限制為 100 GB 時,可將大小限制指定為 100G。

有關多工緩衝處理的詳情,請參閱 Tableau Server 資料引擎中的〈記憶體與 CPU 使用量〉一節。

hyper.global_file_partition_size_limit

預設值:0

設為 0 時,大小會設為不限制並將使用所有可用的磁碟空間。

此選項用於設定多工緩衝處理至磁碟之所有查詢的磁碟空間限制。如果 spool.<id>.tmp 檔案的磁碟空間使用量大於環境所需使用量,則意味著查詢正在進行多工緩衝處理並佔用磁碟空間。spool.<id>.tmp 檔案可在執行 Tableau Server 的使用者帳戶的 temp 資料夾中找到。使用此選項可限制多工緩衝處理至磁碟時所使用的所有查詢總量。您可以以 K(KB)、M(MB)、G(GB) 或 T(TB) 為單位指定此值。例如,當您要將磁碟空間使用量限制為 100 GB 時,可將大小限制指定為 100G。Tableau 建議您在微調多工緩衝處理限制時啟動此設定。

有關多工緩衝處理的詳情,請參閱 Tableau Server 資料引擎中的〈記憶體與 CPU 使用量〉一節。

hyper.enable_accesspaths_symbolic_canonicalization

預設值:false

在 Windows 作業系統中,為了解析符號連結,Hyper 需要能夠存取存儲擷取的目錄及其所有上層目錄。如果不是這種情況,則可能會在 Hyper 記錄中看到一條錯誤消息,內容為: Unable to get canonical path for//dirA/subdir/myextract.hyper ... Access is denied .

在這種情況下,可以將其設定為 true,以便 Data Engine(Hyper)在使用規範路徑時不會嘗試解析符號連結。

附註將該值設定為 true 還意味著 Hyper 不再保證可以防止潛在的攻擊者,他們會設法放置符號連結以逸出 Hyper 設定為可以存取的允許目錄集。

hyper.log_queries

預設值:true

設定為 true 時,會記錄查詢資訊。

預設情況下會記錄查詢資訊。但如果您發現記錄檔對於磁碟空間可用容量而言太大,可以將其設定為 false 以停用記錄查詢資訊。Tableau 建議將此組態集保留為 true

hyper.log_query_cpu

預設值:false

使用此設定可記錄每個查詢所需的時間及 CPU 使用量。

hyper.log_timing

預設值:false

此設定有助於深入了解查詢的詳細資訊,例如編譯和剖析時間。預設情況下,此設定為停用狀態。您可以透過將該值設定為 true 開啟此選項以收集更多有關查詢的詳細資料。但這樣會增加資料引擎記錄檔 (\logs\hyper) 的大小。

hyper.log_troublesome_query_plans

預設值:true

設為 true 時,會記錄標識為有問題的查詢之查詢計劃。已取消、執行速度慢於 10 秒的查詢或如果查詢多工緩衝處理至磁碟的查詢屬於此類別。記錄檔中的資訊可能有助於疑難排解問題查詢。如果您擔心記錄檔大小,可將該設定變更為 false

hyper.memory_limit

預設值:80%

控制 Hyper 使用的記憶體數量上限。指定位元組數量。將字母「k」附加到值表示 KB、附加「m」表示 MB、附加「g」表示 GB、附加「t」則表示 TB。例如,hyper.memory_limit="7g"。或者,也可以將記憶體限額指定為整體可用系統記憶體的百分比。例如,hyper.memory_limit="90%"

hyper.memtracker_hard_reclaim_threshold

預設值:80%

此設定僅適用於 Windows。Hyper 會將擷取中解壓縮和解密的部分保留在記憶體中,以便更快速進行後續存取。此設定會控制工作執行緒何時開始將此資料寫入磁片快取,以減少記憶體壓力。如果以百分比提供,該值將解讀為整體 hyper.memory_limit 設定的百分比。例如,hyper.memtracker_hard_reclaim_threshold="60%"。您可以將絕對值指定為「k」(KB)、「m」(MB)、「g」(GB) 或「t」(TB)。例如,hyper.memtracker_hard_reclaim_threshold="10g"。該值應大於 hyper.memtracker_soft_reclaim 閾值。

hyper.memtracker_soft_reclaim_threshold

預設值:50%

此設定僅適用於 Windows。與 Hyper 檔案互動時,Hyper 會寫出一些資料,以便快取或保存資料。Windows 具有將新寫入之資料鎖定到記憶體中的特殊行為。為了避免交換,我們會在 Hyper 達到為回收閾值設定的限額時強制剔除資料。達到柔性回收閾值時,Hyper 會嘗試在背景回收快取的資料,以嘗試維持在回收閾值之下。在其他會發生交換的情況下,在 Hyper 中觸發回收可能會產生更好的結果。因此,如果您的 Tableau Server 安裝發生大量交換,就可以使用此設定來嘗試減少記憶體壓力。

指定位元組數量。將字母「k」附加到值表示 KB、附加「m」表示 MB、附加「g」表示 GB、附加「t」則表示 TB。或者,也可將該值指定為針對 Hyper 整體設定之記憶體的百分比。例如,hyper.memtracker_soft_reclaim_threshold="20%"

hyper.network_threads

預設值:150%

控制 Hyper 使用的網路執行緒數量。指定網路執行緒數量(例如 hyper.network_threads=4)或指定與邏輯核心計數相關的執行緒百分比(例如 hyper.network_threads="300%")。

網路執行緒是用來接受新的連線,以及傳送或接收資料與查詢。Hyper 會使用非同步網路,因此可由單一執行緒提供多個連線。一般來說,在網路執行緒上完成的工作量非常低。有一個例外是在較慢的檔案系統上開啟資料庫;這可能會需要很長時間,而且會阻擋網路執行緒。您嘗試檢視或編輯使用擷取且有一段時間未使用的儀表板時,如果連線時間很慢,而且您在 Hyper 記錄中經常看到「asio-continuation-slow」訊息,且 Tableau 記錄中對 Hyper 的「construct-protocol」時間很長,請嘗試增加此值。

hyper.objectstore_validate_checksums

預設值:false

在 Hyper 中控制檔案完整性檢查的布林值設定。設定為 true 時,Hyper 會在首次存取時在擷取檔案中檢查資料。此設定可以偵測到無訊息損毀以及可能會讓 Hyper 當機的損毀。通常會建議開啟此設定,但磁碟速度很慢的安裝作業除外,因為這樣可能會導致效能退化。

hyper.query_total_time_limit

預設值:0(表示無限制)

設定可讓 Hyper 中個別查詢使用的總執行緒時間上限。將「s」附加到值表示秒,「min」表示分鐘,「h」則表示小時。

例如,若要將所有查詢的總時間限制為 1,500 秒,請執行以下命令:

tsm configuration set -k hyper.query_total_time_limit -v 1500s

如果查詢執行時間超過指定限制,則查詢將失敗並傳回錯誤。此設定可讓您自動控制失控的查詢,否則會使用過多的資源。

Hyper 會並行執行查詢。例如,如果查詢執行了 100 秒鐘,而且此期間是在 30 個執行緒上執行,則總執行緒時間會是 3,000 秒。每個查詢的執行緒時間會報告在 Hyper 記錄中「total-time」欄位的「query-end」記錄項目中。

hyper.session_memory_limit

預設值:0(表示無限制)

控制個別查詢可以擁有的記憶體消耗量上限。指定位元組數量。將字母「k」附加到值表示 KB、附加「m」表示 MB、附加「g」表示 GB、附加「t」則表示 TB。

例如,將內存限制上限設定為 900 MB,請執行以下命令:

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

或者,將工作階段記憶體上限指定為總可用系統記憶體的百分比,請執行以下命令:

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

某個查詢使用過多的記憶體且使其他查詢長時間失敗時,降低此值能夠有所幫助。透過降低限額,單一大型查詢可能會失敗(如果多工緩衝處理並未關閉,則會採用多工緩衝處理),而且對其他查詢不會有負面影響。

hyper.srm_cpu_limit_percentage

預設值(百分比):75

指定 Hyper 允許的最大每小時平均 CPU 使用率。若超出,資料引擎將自行重新啟動,以盡量減少對電腦上其他流程的影響。

預設情況下,若在一小時內的平均 CPU 使用率超過 75%,資料引擎將自行重新啟動。除非與 Tableau 支援合作,或者若在專用伺服器節點上執行資料引擎,否則不應變更此值。若資料引擎在專用節點上執行,可以安全地將此值增加到 95%,以充分利用可用的電腦硬體。有關在專用節點上執行資料引擎的詳細資訊,請參閱對擷取查詢密集型環境進行最佳化

要將其增加到 95%:

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

tsm pending-changes apply

要將其重設為預設值 75%:

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

tsm pending-changes apply

hyper_standalone.consistent_hashing.enabled

預設值:true

提高已快取查詢的擷取機會。如果已快取擷取的節點無法支援額外負載,會將您路由至新節點,而且擷取將載入新節點上的快取。這會提升系統使用率,因為只有在真正需要負載時,才會將擷取載入記憶體。

hyper_standalone.health.enabled

預設值:true

將負載平衡指標從隨機選擇切換至根據目前 Hyper 活動和系統資源使用情況組成的健康情況分數選擇「資料引擎 (Hyper)」節點。根據這些值,負載平衡器將選擇最能處理擷取查詢的節點。

hyper.temp_disk_space_limit

預設值:100%

設定磁碟空間上限;Hyper 會在此上限停止為暫存檔案分配空間。此設定有助於防止硬碟填滿來自 Hyper 的暫存檔案且用盡磁碟空間的情形。如果磁碟空間達到此閾值,Hyper 會嘗試在沒有管理員介入的情況下自動復原。

請將其指定為要使用之整體可用磁碟空間的百分比。例如,hyper.temp_disk_space_limit="96%"。設定為 100% 時,可以使用所有可用的磁碟空間。

若要啟動資料引擎,已設定的磁碟空間必須可用。如果沒有足夠的磁碟空間,您就會看到一個資料引擎記錄項目顯示「已達到暫存檔案的磁碟空間限制。請釋出裝置上的磁碟空間。請參閱 Hyper 記錄以瞭解詳情:裝置上已無剩餘空間。」

hyper.hard_concurrent_query_thread_limit

預設值:150%

使用此選項可設定 Hyper 應用於執行查詢的執行緒數量上限。您要對 CPU 使用量設定硬性限制時,請使用此選項。請指定執行緒數量或指定與邏輯核心計數相關的執行緒百分比。Hyper 使用的資源不太可能會超過此設定所配置的數量,但 Hyper 背景和網路執行緒不會受到此設定的影響(雖然它們通常不會佔用 CPU 資源)。

請務必考慮到此設定會控制可以執行的並行查詢數量。因此,如果您減少此設定,則查詢需要等待目前執行之查詢完成的機率就會提高,因此會影響工作簿載入時間。

hyper.soft_concurrent_query_thread_limit

預設值:100%

使用此選項可以指定單一查詢可跨執行緒平行執行的執行緒數量(假設 hard_concurrent_query_thread_limit 設定有足夠的執行緒可使用)。請指定執行緒數量或指定與邏輯核心計數相關的執行緒百分比。

為了說明這一點,下面是一個簡化的例子:

假設您將此值設定為 10 個執行緒,這意味著查詢最多可在 10 個執行緒上平行執行。如果只有 2 個查詢正在執行,則其餘 8 個執行緒會用於平行執行 2 個查詢。

hyper. hard_concurrent_query_thread_limithyper.soft_concurrent_query_thread_limit 選項共同協作,為您提供一些管理 CPU 使用量的選項,可在最大程度增加可用 CPU 資源的同時更快完成查詢。如果您不希望資料引擎使用機器上的所有可用 CPU,請將其變更為最適合您的環境的小於 100% 的百分比。該柔性限制是您限制 CPU 使用量的一種方式,但同時又允許您在必要時超出柔性限制,達到硬性限制。

附註:hyper.hard_concurrent_query_thread_limithyper.soft_concurrent_query_thread_limit 選項取代 Tableau Server 版本 2018.3 及更早版本的中提供的 hyper.num_job_worker_threads 與 hyper.num_task_worker_thread 選項,並已在目前版本中棄用。有關 hyper.num_job_worker_threads 和hyper.num_task_worker_threads 的詳情,請參閱tsm configuration set 選項(連結在新視窗開啟)

hyper.use_spooling_fallback

預設值:true

設定為 true 時,其允許在查詢擷取超出設定 RAM 使用量(已安裝 RAM 的 80%)時多工緩衝處理至磁碟。換句話說,它會允許 Hyper 在超過 RAM 使用量時使用磁碟執行查詢。

Tableau 建議您使用預設設定。如果您擔心磁碟使用量,您可以透過將該值設定為 false 來關閉此設定。如果關閉此設定,將會取消使用超過已安裝 RAM 的 80% 的查詢。多工緩衝處理查詢通常需要相當長的時間才能完成。

有關多工緩衝處理的詳情,請參閱 Tableau Server 資料引擎中的〈記憶體與 CPU 使用量〉一節。

indexandsearchserver.vmopts

版本:在版本 2022.1 中新增。

預設值:「-Xmx<default_value> -Xms<default_value>

預設值基於系統記憶體量,為系統總 RAM 的 3.125%。

控制索引和搜尋伺服器堆積大小。由於預設值會自動調整,因此僅在絕對必要時使用此選項覆寫預設值。將字母「k」附加到值表示 KB、附加「m」表示 MB,附加「g」表示 GB。一半情況下,將初始堆積大小 (-Xms) 設定為等於最大堆積大小 (-Xmx) 以最大程度地減小記憶體回收。

jmx.security.enabled

版本在版本 2022.1 中新增。

預設值:false

預設情況下停用 JMX,因此也停用了安全 JMX。如果要啟用 JMX,我們強烈建議啟用安全 JMX。

將其設定為true,並在執行tsm maintenance jmx enable命令時使用 SSL 和基本使用者名稱/密碼驗證唯讀存取時開啟安全 JMX,並在提示是否為 JMX 啟用安全功能時回答y

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

版本在版本 2022.1 中新增。

預設值:true

為 JMX 強制執行 SSL。此選項預設為 true 但除非 jmx.security.enabled 也設定為 true,否則沒有效果。要啟用 JMX 安全性,請執行 tsm maintenance jmx enable 命令。系統提示啟用 SSL 時回答 y,或回答 n 停用 SSL:

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

jmx.ssl.require_client_auth

版本在版本 2022.1 中新增。

預設值:false

執行tsm maintenance jmx enable命令時將其設定為 true,並在提示要求客戶端身份驗證 (mTLS) 時回答y

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

要完成設定,必須具有用戶端憑證,並將其放置在用戶端電腦上的正確位置。

jmx.ssl.user.name

版本在版本 2022.1 中新增。

預設值:tsmjmxuser

在安裝或升級Tableau Server時設置。

jmx.ssl.user.password

版本在版本 2022.1 中新增。

預設值:<generated>

在安裝或升級Tableau Server時設置。

jmx.user.access

版本在版本 2022.1 中新增。

預設值:readonly

執行tsm maintenance jmx enable命令時將其變更為 readwrite,並在提示新增readwrite 存取時回答y

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

預設值:0

設定在系統提示使用者重新啟動前,其登入型授權可為離線且不連線至 Tableau Server 應持續的時間(以秒為單位)。Tableau Desktop 正在使用中並且可以連線到 Tableau Server 時,此持續時間始終會重新整理。

licensing.login_based_license_management.enabled

預設值:true

設定為 true 以啟用 以登入為基礎的授權管理。設定為 false 以停用 以登入為基礎的授權管理

附註:若要使用 以登入為基礎的授權管理,必須啟用已為 以登入為基礎的授權管理 啟用的產品金鑰。可以使用 tsm licenses list 查看 以登入為基礎的授權管理 已啟用的產品金鑰。

licensing.login_based_license_management.max_requested_duration_seconds

預設值:7776000

設定在系統提示使用者重新啟動 Tableau 前,其登入型授權可為離線且不連線至 Tableau Server 應持續的最長時間(以秒為單位)。最大值是 7776000 秒(90天)。Tableau Desktop 正在使用中並且可以連線到 Tableau Server 時,此持續時間始終會重新整理。

maestro.app_settings.sampling_max_row_limit

預設值:1000000

設定使用 Web 版 Tableau Prep 從大型資料集中取樣資料的最大列數。

maestro.input.allowed_paths

預設值:""

預設情況下,任意目錄的存取都將被拒絕,並且只允許發佈至具有 tflx 檔案中包含之內容的 Tableau Server。

流程輸入連線允許的網路目錄清單。必須啟用 Tableau Prep Conductor 才能在 Tableau Server 上對流程進行排程。如需詳細資訊,請參閱 Tableau Prep Conductor

設定此項設定時,套用且必須考慮下列規則:

  • Tableau Server 應該能夠存取路徑。這些路徑在伺服器啟動和流程執行期間進行驗證。

  • 網路目錄路徑必須為絕對,並且不能包含萬用字元或其他路徑遍歷符號。例如,\\myhost\myShare\*\\myhost\myShare* 為無效路徑並且將會導致所有路徑不受允許。安全列出 myShare 下的任何資料夾的正確方式是 \\myhost\myShare or \\myhost\\myShare\

    附註\\myhost\myShare 組態將不允許 \\myhost\myShare1。為了安全列出這些資料夾,應將其安全列為 \\myhost\myShare; \\myhost\myShare1。

  • 此值可以是 *,以便允許任何網路目錄或網路目錄路徑清單由「;」分隔。

  • 即使值設定為 *,將不允許任何本機目錄路徑。

重要資訊:
此命令會覆寫現有的資訊,並以您提供的新資訊將其取代。如果您要新增新位置至現有的清單,則必須提供您要新增的所有位置、現有及新位置的清單。請使用下列命令查看目前的輸入及輸出位置清單:

tsm configuration get -k maestro.input.allowed_paths
tsm configuration get -k maestro.output.allowed_paths

有關為流程輸入和輸出連線設定允許目錄的詳情,請參閱步驟 4:安全清單輸入和輸出位置(連結在新視窗開啟)

maestro.output.allowed_paths

預設值:""

預設情況下,任何目錄存取都將被拒絕。

流程輸出連線允許的網路目錄清單。必須啟用 Tableau Prep Conductor 才能在 Tableau Server 上對流程進行排程。如需詳細資訊,請參閱 Tableau Prep Conductor

設定此項設定時,套用且必須考慮下列規則:

  • Tableau Server 應該能夠存取路徑。這些路徑在伺服器啟動和流程執行期間進行驗證。

  • 網路目錄路徑必須為絕對,並且不能包含萬用字元或其他路徑遍歷符號。例如,\\myhost\myShare\*\\myhost\myShare* 為無效路徑並且將會導致所有路徑不受允許。安全列出 myShare 下的任何資料夾的正確方式是 \\myhost\myShare or \\myhost\\myShare\

    附註\\myhost\myShare 組態將不允許 \\myhost\myShare1。為了安全列出這些資料夾,應將其安全列為 \\myhost\myShare; \\myhost\myShare1。

  • 此值可以是 *,以便允許任何網路目錄或網路目錄路徑清單由「;」分隔。

  • 即使值設定為 *,將不允許任何本機目錄路徑。

  • 附註:如果路徑在流程允許的清單和 internal_disasslowed 清單上,internal_disallowed 會採取優先權。

有關為流程輸入和輸出連線設定允許目錄的詳情,請參閱步驟 4:安全清單輸入和輸出位置(連結在新視窗開啟)

maestro.output.write_to_mssql_using_runas

版本:在版本 :2022.3.1 中新增

預設值:false

啟用後,允許發佈到 Tableau Server 的流程輸出使用執行身分憑證對 Microsoft SQL Server 資料庫進行寫入存取。執行身份服務帳戶使用的憑證必須具有對資料庫的寫入權限。在啟用 maestro.output.write_to_mssql_using_runas 設定之前評估安全性和部署要求。有關詳情,請參閱執行身分服務帳戶

請注意:此命令需要 --force-keys 選項。例如: tsm configuration set -k maestro.output.write_to_mssql_using_runas -v true --force-keys

maestro.sessionmanagement.maxConcurrentSessionPerUser

預設值:4

設定使用者一次可以開啟的流程 Web 編輯工作階段的最大數量。

metadata.ingestor.blocklist

預設值:Null

設定後,Tableau Catalog 會封鎖擷取指定的內容。若要指定要封鎖的內容,必須識別伺服器「noninteractive」記錄檔中的封鎖清單值,這些值是網站 ID、內容類型和要封鎖內容的內容 ID 的組合。封鎖清單值必須用逗號分隔。

重要提示:僅當 Tableau 支援人員指示使用此選項時,才應使用此選項。

例如,可以使用 tsm configuration set --force-keys -k metadata.ingestor.blocklist 封鎖擷取使用以下命令的資料來源、工作簿和流程組合:

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”

若要驗證被封鎖的內容,請檢閱伺服器「noninteractive」記錄檔中的以下事件:

  • Skipping ingestion for
  • Successfully updated blocklist to

例如:

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]

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

metadata.ingestor.pipeline.throttleEventsEnable

預設值:false

控制新內容和更新內容(也稱為事件)的索引編製是否在伺服器上跨所有網站進行監管。預設情況下,事件節流處於關閉狀態。若要開啟事件節流,請使用以下命令將此設定變更為 true: 

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

有關事件節流的詳情,請參閱啟用 Tableau Catalog

metadata.ingestor.pipeline.throttleLimit

預設值:20

啟用事件節流後,這是可在指定時段內編製索引的新內容和更新內容項目的最大數量。特定項目達到指定的限制後,會延遲 編製索引。

預設情況下,限制會設定為 20 且設定不得低於 2。可以使用以下指令變更上限: 

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

在伺服器「noninteractive」記錄檔中,已節流事件可識別為 ingestor event flagged for removal by throttle filter

metadata.ingestor.pipeline.throttlePeriodLength

預設值:20

啟用事件節流後,這是可以為指定的最大數量的新內容和更新內容項目編製索引的時段(以分鐘為單位)。達到指定時間後,將延遲任何其他新內容和更新內容的索引編製。

預設情況下,限制設定為 30 分鐘。您可以使用以下指令變更時間:

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

metadata.query.limits.time

預設值:20

這是 Catalog 或中繼資料 API 查詢在逾時發生和取消查詢之前可執行的最長時間(以秒為單位)。Tableau 建議使用以下命令逐步將逾時限制增加到不超過 60 秒:

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

重要提示: 僅當您看到此處(已超過逾時限制和節點限制的訊息)描述的錯誤時,才應變更此選項。 增加逾時限制可以更長時間地利用更多 CPU,這可能會影響整個 Tableau Server 的工作的效能。增加逾時限制還會導致更高的記憶體使用率,這可能導致在並行執行查詢時交互式微服務容器出現問題。

metadata.query.limits.count

預設值:20000

這是 Catalog 在超出節點限制和取消查詢之前可以返回的物件數(可以大概對應到查詢結果數)。Tableau 建議使用以下命令逐步將逾時限制增加到不超過 100000:

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

重要提示: 僅當您看到此處(已超過逾時限制和節點限制的訊息)描述的錯誤時,才應變更此選項。增加節點限制會導致更高的記憶體使用率,這可能導致在並行執行查詢時交互式微服務容器出現問題。

metadata.query.throttling.enabled

版本:新增至版本 2023.3

預設值:true

控制是否已啟用 中繼資料 API(連結在新視窗開啟) 查詢限制。中繼資料 API 查詢限制是一項旨在防止伺服器的 API 回應對整體效能產生負面影響的功能。設定為 true (預設)後,如果對中繼資料 API 的請求超過定義的閾值,將返回 RATE_EXCEEDED 錯誤。

如果中繼資料 API 使用者經常看到 RATE_EXCEEDED 錯誤,管理員可以嘗試使用 metadata.query.throttling.tokenRefilledPerSecondmetadata.query.throttling.queryCostCapacity 設定調整限制。管理員也可以透過將 metadata.query.throttling.enabled 值設定為 false 完全停用限制。但這樣做會妨礙該功能的效能保護優勢。

metadata.query.throttling.queryCostCapacity

版本:新增至版本 2023.3

預設值:20000000

代表中繼資料 API(連結在新視窗開啟) 可以回答查詢的容量數字。每個中繼資料 API 請求都有計算成本,在執行時會從該數字中減去該成本。(使用權杖貯體模型,這是貯體中可以容納的最大權杖數量。)

如果中繼資料 API 使用者經常看到 RATE_EXCEEDED 錯誤,管理員可以調整該限制設定。他們應該調整 metadata.query.throttling.tokenRefilledPerSecond,並在嘗試調整 metadata.query.throttling.queryCostCapacity 之前測試結果。管理員也可以透過將 metadata.query.throttling.enabled 設定為 false 完全停用限制。但這樣做會妨礙該功能的效能保護優勢。

metadata.query.throttling.tokenRefilledPerSecond

版本:新增至版本 2023.3

預設值:5555

代表中繼資料 API(連結在新視窗開啟) 每秒重新產生的查詢容量數。(使用權杖貯體模型,這是每秒放入貯體中的權杖數。)

如果中繼資料 API 使用者經常看到 RATE_EXCEEDED 錯誤,管理員可以調整該限制設定。他們應該調整 metadata.query.throttling.tokenRefilledPerSecond,並在嘗試調整 metadata.query.throttling.queryCostCapacity 之前測試結果。管理員也可以透過將 metadata.query.throttling.enabled 設定為 false 完全停用限制。但這樣做會妨礙該功能的效能保護優勢。

metricsservices.checkIntervalInMinutes

版本:在版本 2024.2 中淘汰。

預設值:60

控制仰賴即時資料源之指標其重新整理之間的間隔(以分鐘為單位)。當伺服器通過指標的連接檢視檢查新資料時,指標隨即重新整理。

metricsservices.enabled

版本:在版本 2022.3 中新增。在版本 2024.2 中淘汰。

預設值:true

設定為 false 時,會對伺服器上的所有站台停用度量內容類型。有關詳細資訊,請參閱為伺服器停用指標

淘汰舊版指標功能

Tableau 的舊版指標功能於 2024 年 2 月在 Tableau Cloud 和 Tableau Server 版本 2024.2 中淘汰。2023 年 10 月,Tableau 已淘汰在 Tableau Cloud 和 Tableau Server 版本 2023.3 中內嵌舊版指標的功能。借助 Tableau Pulse,我們開發了一種改進的體驗來追蹤指標和對資料提出問題。有關詳細資訊,請參閱使用 Tableau Pulse 建立指標以瞭解新的體驗,以及建立指標並進行疑難排解(已淘汰)以瞭解此淘汰的功能。

metricsservices.failureCountToWarnUser

版本:在版本 2024.2 中淘汰。

預設值:10

控制在警告指標擁有者之前,必須發生的連續重新整理的失敗次數。當設定為預設值 10 時,指標重新整理必須連續失敗 10 次,然後系統才會向擁有者傳送有關故障的通知。

metricsservices.maxFailedRefreshAttempts

版本:在版本 2024.2 中淘汰。

預設值:175

控制在指標重新整理暫停之前,必須發生的連續重新整理的失敗次數。

mobile.deep_linking.on_prem.enabled

預設值:true

使用 Tableau Mobile 應用控制連結到 Tableau Server 時是否設為深層連結。設定為 true 時,則會連結到在應用程式中開啟的支援內容類型。設定為 false 時,則會在行動瀏覽器中開啟連結。有關更多詳情,請見控制 Tableau Mobile 的深層連結

monitoring.dataengine.connection_timeout

預設值:30000

叢集控制器在確定發生連線逾時之前將等待資料引擎的時間長度(以毫秒為單位)。預設值為 30,000 毫秒(30 秒)。

native_api.allowed_paths

預設值:""

附註:在 2023 年 10 月之前的 Tableau Server 版本(包括維護版本)中,此設定配置為預設允許存取所有路徑。

使用此設定可以指定存取儲存在 Tableau 或遠端共用上的檔案的允許清單。此情境允許獲授權的 Tableau Server 使用者建立使用伺服器上的檔案作為基於檔案資料來源的工作簿(如試算表)。

此設定可讓您將存取權限制為僅可存取您指定的目錄。因此,執行身分服務帳戶存取權僅限於託管資料檔案的目錄路徑。

tsm configuration set -k native_api.allowed_paths -v "path",其中 path 是要新增到允許清單中的目錄。指定路徑的所有子目錄將都新增到允許清單中。如果想要指定多個路徑,請用分號將它們分開,如此範例中所示:

tsm configuration set -k native_api.allowed_paths -v "c:\datasources;\\HR\data"

重要事項:確保您在此設定中指定的檔案路徑存在並且可由系統帳戶存取。

native_api.connection.limit.<連線類>

設定指定資料來源(連線類)的並行查詢限制。此選項優先於資料來源的全域限制。

native_api.connection.globallimit

預設值:16

並行查詢的全域限制。除了 Amazon Redshift 的預設值為 8 之外,其他的預設值均為 16。

native_api.ExplainDataEnabled

預設值:true

此選項控制伺服器啟用還是停用「資料詮釋」。有關「資料詮釋」的詳細資訊,請參見 Tableau 說明中的開始使用「資料詮釋」(連結在新視窗開啟)

從 Tableau Server:2019.3 版本起已加入此選項。

native_api.force_alternative_federation_engine

預設值:false

聯結單一檔案連線與單一 SQL 資料庫連線的資料時,覆寫操作限制。將這個選項設定為 True,強制 Tableau 使用即時資料庫連線處理聯結。

native_api.ProtocolTransitionLegacyFormat

預設值:false

為約束委派使用舊名稱格式。

版本 10.1 中的名稱格式已變更,以允許跨域協議轉換 (S4U)。如果這樣導致現有組態發生問題,而且您不需要跨網域通訊協定轉換,請將此參數設定為 true,以便將 Tableau Server 設定為使用舊行為。

native_api.InitializeQueryCacheSizeBasedOnWeights

預設值:True

控制是否根據可用的系統記憶體數量自動初始化查詢快取大小。查詢快取由邏輯查詢快取、中繼資料快取和原生查詢快取組成。預設情況下,此功能已啟用。

native_api.QueryCacheMaxAllowedMB

查詢快取的最大大小(以 MB 為單位)。此值會因系統記憶體數量而有所不同。查詢快取由邏輯查詢快取、中繼資料快取和原生查詢快取組成。使用下表確定預設值:

系統記憶體Tableau Server 的預設值Tableau Desktop 的預設值
64 GB 及以上3200 MB1600 MB
從 32 GB 到 64 GB2400 MB1200 MB
從 16 GB 到 32 GB1600 MB800 MB
16 GB 及以下800 MB400 MB

native_api.LogicalQueryCacheMaxAllowedWeight

預設值:70

邏輯查詢快取大小限制在總查詢快取大小中的權數。

native_api.MetadataQueryCachMaxAllowedWeight

預設值:4

中繼資料查詢快取大小限制在總查詢快取大小中的權數。

native_api.NativeQueryCacheMaxAllowedWeight

預設值:26

原生查詢快取大小限制在總查詢快取大小中的權數。

native_api.QueryCacheEntryMaxAllowedInPercent

預設值:60

指定可以放入查詢快取的查詢結果的最大大小。其可設定為總查詢快取大小的百分比。例如,若邏輯查詢快取大小為 100 MB,並且 native_api.QueryCacheEntryMaxAllowedInPercent 設定為 60%,則只能將小於 60 MB 的查詢結果放入邏輯查詢快取中。

nlp.concepts_shards_count

預設值:1

附註:對於大多數 Tableau Server 安裝而言,預設的分區計數值就足夠了。

控制為資料問答、欄位名稱、欄位同義字和分析詞彙的「概念」索引之資料碎片數:

  • 2022.1 及更高版本的索引和搜尋伺服器。
  • 2019.1 - 2021 的索引和搜尋伺服器。4

分區計數對搜尋索引進行分割以縮減總索引大小,這可能會提升資料問答 (Ask Data) 的語意剖析器的效能。調整分區計數是您可以透過 elasticserver.vmoptsindexandsearchserver.vmopts 增加堆積大小而採取的另一種效能增強措施,取決於執行的 Tableau Server 版本。

Tableau 建議每 50 GB 即將分區計數增加 1。要減少調整分區計數的次數,您可以將目前的索引大小增加 50%,並據此計算總索引大小。例如,如果總索引大小低於 50 GB,則 1 分區就足夠了。實際效能會因伺服器、索引大小增加的速率及其他因素而有所不同。

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

可以使用以下命令將「概念」索引分區計數從預設值增提高至 2:

tsm configuration set -k nlp.concepts_shards_count -v 2

nlp.values_shards_count

預設值:1

控制為資料問答、欄位名稱、欄位同義字和分析詞彙的「概念」索引之資料碎片數:

  • 2022.1 及更高版本的索引和搜尋伺服器。
  • 2019.1 - 2021 的索引和搜尋伺服器。4

分區計數對搜尋索引進行分割以縮減總索引大小,這可能會提升資料問答 (Ask Data) 的語意剖析器的效能。調整分區計數是您可以透過 elasticserver.vmoptsindexandsearchserver.vmopts 增加堆積大小而採取的另一種效能增強措施,取決於執行的 Tableau Server 版本。

Tableau 建議每 50 GB 即將分區計數增加 1。要減少調整分區計數的次數,您可以將目前的索引大小增加 50%,並據此計算總索引大小。例如,如果總索引大小低於 50 GB,則 1 分區就足夠了。實際效能會因伺服器、索引大小增加的速率及其他因素而有所不同。

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

可以使用以下命令將「值」索引分區計數從預設值增提高至 2:

tsm configuration set -k nlp.values_shards_count -v 2

nlp.defaultNewSiteAskDataMode

預設值:disabled_by_default

建立站點後,使用本選項設定「資料問答模式」(Ask Data Mode) 的初始值。有關更多詳情,請參閱為網站停用或啟用「資料問答」(Ask Data)

有效選項是 disabled_by_defaultdisabled_always

這個選項已從下列 Tableau Server 版本開始加入:2019.4.5、2020.1.3。

noninteractive.vmopts

預設值:"-XX:+UseConcMarkSweepGC -Xmx<default_value>g -XX:+ExitOnOutOfMemoryError"

預設值會因系統記憶體數量而有所不同。JVM 的最大堆積大小已調整為系統總 RAM 的 6.25%。

此選項可控制 Tableau Catalog 擷取的 JVM 堆積大小。由於預設值會自動調整,僅在絕對必要時使用此選項透過修改 -Xmx<default_value>g 引數覆寫預設值。例如,可以使用以下命令將最大堆積大小增加到 2 GB:

tsm configuration set -k noninteractive.vmopts -v "-XX:+UseConcMarkSweepGC -Xmx2g -XX:+ExitOnOutOfMemoryError"

有關詳情,請參閱非互動式微服務容器記憶體

pgsql.port

預設值:8060

PostgreSQL 所偵聽的埠。

pgsql.preferred_host

指定安裝了慣用存放庫的節點的電腦名稱。如果隨 tsm topology failover-repository 命令一起指定了 --preferred-r 選項,則使用此值。

範例:

tsm configuration set -k pgsql.preferred_host -v "<host_name>"

附註:host_name 區分大小寫,而且必須符合 tsm status -v 輸出中顯示的節點名稱。

pgsql.ssl.ciphersuite

預設值:HIGH:MEDIUM:!aNULL:!MD5:!RC4

為存放庫指定 SSL 允許的密碼演算法。

有關可接受的值和格式要求,請參閱 Postgres 網站上的 ssl 加密(連結在新視窗開啟)

pgsql.ssl.max_protocol_version

預設值:TLSv1.3

設定透過 SSL 連線到存放庫時要使用的最高 SSL/TLS 通訊協定版本。

有效值:TLSv1TLSv1.1TLSv1.2TLSv1.3

pgsql.ssl.min_protocol_version

預設值:TLSv1.2

設定透過 SSL 連線到存放庫時要使用的最低 SSL/TLS 通訊協定版本。

有效值:TLSv1TLSv1.1TLSv1.2TLSv1.3

pgsql.verify_restore.port

預設值:8061

用於驗證 PostgreSQL 資料庫完整性的埠。有關詳情,請參閱tsm maintenance backup

ports.blocklist

版本:在版本 2021.1 中新增

預設值:在用於自動指派連接埠的範圍內沒有連接埠被封鎖。

用於指定連接埠指派範圍內 Tableau 在動態指派連接埠時不應使用的連接埠。當您知道另一個應用程式正在使用該範圍內的連接埠時,此選項很有用。請以逗號分隔多個連接埠,例如:

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

有關使用 ports.blocklist 金鑰的詳情,請參閱封鎖範圍內的特定連接埠

recommendations.enabled

預設值:true

控制建議功能,該功能為資料來源和資料表(針對 Tableau Desktop)的建議以及檢視的建議(針對 Tableau Server)提供支援。建議的提供以內容受歡迎的程度為準,或以經確認與目前使用者相似的其他使用者所使用的內容為準。

recommendations.vizrecs.enabled

預設值:true

控制針對 Tableau Server 使用者的檢視的建議。此選項是 recommendations.enabled 的子選項,如果父選項設定為 false,則該選項將不起作用。當父選項設定為 true 而此選項設定為 false 時,將仍向 Tableau Desktop 使用者推薦資料來源和資料表,但將停用 Tableau Server 上檢視的建議。

redis.max_memory_in_mb

預設值:1024

指定快取伺服器外部查詢快取的大小(單位:MB)。

refresh_token.absolute_expiry_in_seconds

預設值:31536000

指定重新整理權杖和個人存取權杖 (PAT) 的絕對過期秒數。

連線的用戶端(Tableau Desktop、Tableau Prep Builder、Tableau Mobile 等)使用重新整理權杖在初始登入後對 Tableau Server 進行驗證。

若要刪除限制,將值設為 -1。若要停用重新整理權杖和 PAT,請參閱停用自動用戶端驗證

refresh_token.idle_expiry_in_seconds

預設值:1209600

指定閒置 重新整理權杖過期時的秒數。連線的用戶端(Tableau Desktop、Tableau Prep Builder、Tableau Mobile 等)使用重新整理權杖在初始登入後對 Tableau Server 進行驗證。要移除限制,請將值設定為 -1

refresh_token.max_count_per_user

預設值:24

指定可以為每個使用者頒發的重新整理權杖的最大數量。如果使用者工作階段比預期更早過期,則可以增加此值或將其設定為 -1 以完全移除權杖限制。

rsync.timeout

預設值:600

完成檔同步所允許的最長時間(以秒為單位)(600 秒 = 10 分鐘)。檔同步在設定高可用性或移動資料引擎和存放庫的過程中發生。

schedules.display_schedule_description_as_name

預設值:false

控制在建立訂閱或擷取重新整理時是顯示排程名稱(預設值),還是顯示描述排程的時間和頻率的「排程頻率說明」名稱。若要將 Tableau Server 設定為顯示排程的時區敏感名稱,請將該值設定為 true

設定為 true 時,也會在排程清單頁面上的排程名稱之後顯示「排程頻率說明」。

schedules.display_schedules_in_client_timezone

預設值:true

設定為 true 時,在使用者的時區中顯示「排程頻率說明」(使用使用者端瀏覽器時區計算「排程頻率說明」)。

schedules.ignore_extract_task_priority

預設值 (布林):False

此設定控制是否將工作優先順序納入考量,來確定何時將工作從佇列拉出的工作排名。設定為true 將停用編輯工作的工作優先順序,並且將僅考慮排程優先順序來確定工作排名。

searchserver.connection_timeout_milliseconds

版本:在版本 2019.1 中新增。在版本 2022.3 中已棄用。於版本 2023.3 中停用。

預設值(單位:毫秒):100000

指定搜尋和流覽用戶端等待建立與搜尋和流覽伺服器之連線所需的時間(單位:毫秒)。

在特別繁忙的 Tableau Server 電腦上,或者如果您看到記錄檔錯誤訊息:「zookeeper 健康情況檢查失敗」。拒絕啟動 SOLR 會增加這個值。

有關詳情,請參閱用戶端工作階段逾時

searchserver.index.bulk_query_user_groups

版本:在版本 2022.3 中已過時。

預設值:true

指定在使用 CSV 檔匯入或刪除使用者時是否大量查詢站點使用者。如果設定為 true(預設值),索引是大量完成的。

searchserver.javamemopts

版本:在版本 2019.1 中新增。於版本 2023.3 中停用

預設值:-Xmx512m -Xms512m -XX:+ExitOnOutOfMemoryError -XX:-UsePerfData

判別 SOLR 的 JVM 選項。

在所有可配置選項中,藉由 -Xmx 參數所設定的堆積記憶體上限,是調整搜尋伺服器時最重要的項目。在大多數情況下,應根據 Tableau Server 電腦上的可用實體記憶體,盡可能在設定中提高此值,最高為 24 GB。若僅僅要變更堆積記憶體上限,請指定整個預設字串,但僅變更 -Xmx 值。

-Xmx 的有效值取決於 Tableau Server 電腦上的可用記憶體,但不可大於 24 GB。有關詳細資訊,請參閱搜尋和瀏覽最大堆積記憶體

searchserver.startup.zookeeper_healthcheck_timeout_ms

版本:在版本 2020.1 中新增。於版本 2023.3 中停用。

預設值(單位:毫秒):300000

以毫秒為單位指定 Tableau Server 在啟動時,系統等待順利完成 Zookeeper 健康情況檢查的時間。

在特別繁忙的 Tableau Server 電腦上,或者如果您看到記錄檔錯誤訊息:「zookeeper 健康情況檢查失敗」。拒絕啟動 SOLR 會增加這個值。

有關詳情,請參閱 啟動時,Zookeeper 連線健康情況檢查逾時

searchserver.zookeeper_session_timeout_milliseconds

版本:在版本 2022.3 中已過時。

預設值(單位:毫秒):100000

指定搜尋和流覽用戶端等待建立與協調服務 (Zookeeper) 之連線所需的時間(單位:毫秒)。

有關詳情,請參閱用戶端工作階段逾時

ServerExportCSVMaxRowsByCols

版本:在版本 2020.3 中新增。

預設值:0(無限制)

指定可以從檢視資料下載到 CSV 檔中的資料儲存格數量上限。預設情況下,沒有上限。指定儲存格數目。例如:將上限設定為 300 萬: 

tsm configuration set -k ServerExportCSVMaxRowsByCols -v 3000000 
tsm pending-changes apply

service.jmx_enabled

預設值:false

設定為 true 則可將 JMX 埠用於可選的監視和故障排除。

service.max_procs

預設值:<number>

最大伺服器處理序數。

service.port_remapping.enabled

預設值:true

確定在預設的或設定的埠不可用時 Tableau Server 是否嘗試動態地重新對應埠。設定為 false 會停用動態埠重新對應。

session.ipsticky

預設值:false

使使用者端會話僅對用於登入的 IP 位址有效。如果發出請求的 IP 位址和與會話權杖關聯的 IP 位址不同,則將會話權杖視為無效。

在某些情況下(例如,當具有已知靜態 IP 位址的電腦存取 Tableau Server 時),此設定可提高安全性。

附註:請仔細考慮此設定是否能為您的伺服器安全帶來幫助。此設定要求使用者端具有唯一 IP 位址以及在會話持續時間內保持相同的 IP 地址。例如,處於 Proxy 後面的不同使用者看起來可能具有相同的 IP 位址(即 Proxy 的 IP 位址);在這種情況下,一個使用者可能能夠存取另一個使用者的會話。在另一種情況下,使用者可能具有動態 IP 位址,並且其位址可能會在會話過程中發生變化。如果是這樣,使用者必須要再次登入。

sheet_image.enabled

預設值:true

控制是否可以使用 REST API 獲取檢視的影像。有關詳情,請參閱 REST API 參考

ssl.ciphersuite

預設值:HIGH:MEDIUM:!EXP:!aNULL:!MD5:!RC4:!3DES:!CAMELLIA:!IDEA:!SEED

為閘道指定 SSL 允許的密碼演算法。

有關可接受的值和格式要求,請參閱 Apache 網站上的 SSLCipherSuite(連結在新視窗開啟)

ssl.client_certificate_login.blocklisted_signature_algorithms

預設值:

  • 版本 2020.4.0: 

    sha1withrsaencryption,
    sha1withrsa

  • 版本 2020.4.1 和更高版本:

    sha1withrsaencryption,
    sha1withrsa,
    sha1withrsaandmgf1,
    sha1withdsa,
    sha1withecdsa

預設值會封鎖使用 SHA-1 簽名演算法的憑證。指定 SSL 封鎖的用戶端簽名演算法。若要停用所有簽名演算法的封鎖設定,請使用空引號集執行此金鑰。

有關此金鑰的資訊,請參閱知識庫文章若憑證使用 SHA-1 簽署,升級後相互 SSL 失敗(連結在新視窗開啟)

ssl.client_certificate_login.min_allowed.elliptic_curve_size

預設值:256

指定透過相互 SSL 向 Tableau Server 進行驗證的 ECDSA 用戶端憑證所需的最小橢圓曲線大小。若用戶端提供的 ECDSA 用戶端憑證不符合此最小曲線大小,則驗證請求將失敗。

此選項已在 Tableau Server 版本 2021.1 中引入。

ssl.client_certificate_login.min_allowed.rsa_key_size

預設值:2048

指定透過相互 SSL 向 Tableau Server 進行驗證的 RSA 用戶端憑證的最小金鑰大小。若用戶端提供的 RSA 用戶端憑證不符合此最小金鑰大小,則驗證請求將失敗。

此選項已在 Tableau Server 版本 2021.1 中引入。

ssl.protocols

預設值:all +TLSv1.2 -SSLv2 -SSLv3 -TLSv1.3

為閘道的 TLS 連線指定 Tableau Server 支援的 SSL。可接受的值來自Apache SSLProtocol Directive(連結在新視窗開啟) 。我們建議遵循安全強化檢查清單中所述的 SSL 協定設定。

storage.monitoring.email_enabled

預設值:false

控制是否啟用伺服器磁碟空間監控的電子郵件通知。預設情況下,系統會啟用電子郵件通知。若要啟用磁碟空間監控的通知,請將此設為 true

必須設定 SMTP,才能傳送通知。有關詳情,請參閱設定 SMTP 設定

storage.monitoring.warning_percent

預設值:20

剩餘磁碟空間的警告閾值,以總磁碟空間百分比表示。如果磁碟空間低於此閾值,則系統會傳送警告通知。

storage.monitoring.critical_percent

預設值:10

剩餘磁碟空間的嚴重閾值,以總磁碟空間百分比表示。如果磁碟空間低於此閾值,則系統會傳送嚴重通知。

storage.monitoring.email_interval_min

預設值:60

當磁碟空間監視功能啟用,且已超過閾值時,應該傳送電子郵件通知的頻率(以分鐘表示)。

storage.monitoring.record_history_enabled

預設值:true

判斷可用磁碟空間歷史記錄是否儲存,並可在管理檢視中查看。若要停用監控的歷史記錄儲存,請將 storage.monitoring.record_history_enabled 設定為 false

subscriptions.enabled

預設值:false

控制是否可在系統範圍內設定訂閱。請參閱 設定訂閱站點

subscriptions.timeout

預設值:1800

在工作簿訂閱工作逾時前,該工作的檢視呈現的時間長度,以秒為單位。如果在呈現檢視時達到此時間限制,則會繼續呈現,但不會呈現工作簿中任何後續檢視,而且作業會在錯誤中結束。在單一檢視工作簿的情況下,此值永遠不會造成因逾時而停止呈現。

svcmonitor.notification.smtp.enabled

預設值:false

控制是否啟用伺服器程序事件的電子郵件通知。預設情況下,當程序停止運作、容錯移轉或重新啟動時,系統會傳送通知。若要啟用伺服器程序通知,請將此設定為 true

必須設定 SMTP,才能傳送通知。有關詳情,請參閱設定 SMTP 設定

svcmonitor.notification.smtp.mime_use_multipart_mixed

版本:在版本 2020.1.8、2020.2.5 、2020.3.1 中新增

預設值:false

控制訂閱 HTML MIME 附件以 multipart/related(預設)方式傳送,還是以 multipart/mixed 方式傳送。

在極少數情況下,電子郵件用戶端可能無法正確解析 Tableau Server 傳送的電子郵件。很多時候,可以將此屬性設定為 true 來解決此問題。已知的用戶端包括 iOS Mail 和 Microsoft Outlook(與 Exchange S/MIME 加密配對時)。

tabadmincontroller.auth.expiration.minutes

預設值:120

控制工作階段 Cookie 的有效時間長度。預設情況下,其設定為 120 分鐘。這個值也會決定內嵌認證在節點啟動程序檔案中的有效時間長度。有關詳情,請參閱 tsm topology nodes get-bootstrap-file

tdsservice.log.level

版本:在版本 2020.3.0 中新增。

預設值:info

資料來源屬性服務的記錄層級。這是可動態設定的,因此,如果您只是加以變更,不必重新啟動 Tableau Server。有關詳情,請參閱變更記錄層級

tomcat.http.maxrequestsize

預設值:16380

允許根據 HTTP 請求透過 Apache 閘道傳遞的標頭內容的大小上限(位元組)。標頭超過此選項上設定的值將導致瀏覽器錯誤,如 HTTP 錯誤 413(請求實體太大)或驗證失敗。

tomcat.http.maxrequestsize 的值較低可能會導致驗證錯誤。與 Active Directory(SAML 和 Kerberos)整合的單一登入解決方案在 HTTP 標頭中經常需要大型驗證權杖。一定要在部署到生產環境之前測試 HTTP 驗證方案。

我們建議將 gateway.http.request_size_limit 選項設定為您為此選項設定的相同值。

tomcat.http.proxyHost

為 IdP 所需 OpenID 指定正向 Proxy 主機名稱。參看為 OpenID Connect 設定 Tableau Server

tomcat.http.ProxyPort

為對 IdP 的 OpenID 請求指定正向 Proxy 連接埠。參看為 OpenID Connect 設定 Tableau Server

tomcat.https.proxyHost

為 IdP 所需 OpenID 指定正向 Proxy 主機名稱。參看為 OpenID Connect 設定 Tableau Server

tomcat.https.ProxyPort

為對 IdP 的 OpenID 請求指定正向 Proxy 連接埠。參看為 OpenID Connect 設定 Tableau Server

tomcat.https.port

預設值:8443

Tomcat 的 SSL 埠(未使用)。

tomcat.server.port

預設值:8085

tomcat 偵聽關機訊息的埠。

tomcat.useSystemProxies

預設值:false

指定 tomcat 組件 (OpenID) 是否需要存取本機 Windows 作業系統中的正向 Proxy。參看為 OpenID Connect 設定 Tableau Server

tomcatcontainer.log.level

預設值:info

互動式微服務容器和非互動式微服務容器中的微服務紀錄層級。從版本 2020.4 開始,這是可動態設定的,因此,若僅變更此內容,則不必重新啟動 Tableau Server。有關詳情,請參閱變更記錄層級

tsm.log.level

預設值:info

TSM 服務的記錄層級這些記錄包括在 TSM 服務出現問題時,可提供幫助的資訊:管理代理程式、管理控制器、用戶端檔案服務、叢集控制器、服務管理員,以及授權服務。這個組態金鑰不會變更 Coordination Service 或維護程序的記錄層級。有關詳情,請參閱變更記錄層級Tableau Server 處理序

tsm.controlapp.log.level

預設值:info

control_<app> 服務的記錄層級。如果您在啟動或重新設定 TSM 或 Tableau Server 處理序時遇到問題,這些記錄包括的資訊可能有所幫助。有關詳情,請參閱變更記錄層級

usernotifications.reap_after_days

預設值:30

多少天後將使用者通知從伺服器中刪除。

vizportal.adsync.update_system_user

預設值:false

指定在 Tableau Server 中同步 Active Directory 組時使用者的電子郵寄地址和顯示名稱是否變更(即使在 Active Directory 中變更)。為了確保使用者電子郵寄地址和顯示名稱在同步過程中更新,請將 vizportal.adsync.update_system_user 設定為 true,然後重新啟動伺服器。

版本:在版本 2021.3.0 中新增

預設值:false

指定「複製連結」選項是否應包含「embed=y」參數。從 2019.4 版本開始,預設情況下不包含此參數。將此組態金鑰設定為 true 會變更行為,以便包含「embed=y」參數。有關使用「複製連結」選項共用連結以內嵌網頁的詳細資訊,請參見 Tableau Desktop 和 Web 製作說明中的將檢視內嵌網頁。(連結在新視窗開啟)

vizportal.commenting.delete_enabled

預設值:true

設定為 true 時,允許使用者刪除檢視上的注釋。如果您是注釋的建立者、內容所有人或具有相應網站角色的項目主管,或者是管理員,則可以刪除注釋。若要瞭解需要哪些網站角色才能獲得完全項目主管存取權限,請參閱專案級管理

vizportal.csv_user_mgmt.index_site_users

版本:在版本 2022.3 中已過時。在版本 2023.3 中已停用(完全移除)。

預設值:true

指定在使用 CSV 檔匯入或刪除使用者時是否逐個使用者地完成網站使用者索引。如果設定為 true(預設值),則會在新增或刪除每個使用者時完成索引編製。若要將網站使用者的索引延遲到處理完整個 CSV 檔之後,請將此項設定為 false

vizportal.csv_user_mgmt.bulk_index_users

版本:在版本 2022.3 中已過時。在版本 2023.3 中已停用(完全移除)。

預設值:false

指定在使用 CSV 檔匯入或刪除使用者時是否大量索引站點使用者。當設定為 false(預設值),索引是單獨完成的。若要將站點使用者的索引延遲到處理完整個 CSV 檔之後,請將此項設定為 true

vizportal.log.level

預設值:info

vizportal Java 元件的記錄層級。記錄寫入 C:\ProgramData\Tableau\Tableau Server\data\tabsvc\logs\vizportal\*.log

如需詳細資料,請設定為 debug。使用調試設定可能會顯著影響性能,因此您應該僅當 Tableau 支援部門指示時才使用此設定。

從 2020.4.0 版本起就是可動態設定,因此如果只是變更,則無需新啟動 Tableau Server。有關詳情,請參閱變更記錄層級

vizportal.oauth.connected_apps.max_expiration_period_in_minutes

版本:在版本 2021.4 中新增。

預設值:10

JSON Web 權杖 (JWT) 有效的最長時間段(以分鐘為單位)。在驗證 JWT 時,Tableau Server 會檢查 JWT 中指定的時間段是否不超過此預設值。使用 Tableau REST API(連結在新視窗開啟) 在 Tableau Server 上設定 Tableau 已連線應用程式時,會使用此設定。

例如,要將最長時間段變更為 5 分鐘,請執行以下命令:

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

vizportal.oauth.external_authorization.enabled

版本:在版本 2021.4 中新增。

預設值:false

指定是否為 Tableau Server 啟用為內嵌內容啟用 OAuth 存取選項。使用此選項向 Tableau Server 註冊外部授權伺服器 (EAS),以便您可以為自訂應用程式中的內嵌內容啟用單一登入 (SSO)。有關詳細資訊,請參閱註冊 EAS 以為內嵌內容啟用 SSO

要啟用此選項,請執行以下命令:

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

vizportal.oauth.external_authorization_server.blocklisted_jws_algorithms

版本:在版本 2021.4 中新增。

預設值:ES256K

註冊外部授權伺服器 (EAS) 或設定已連線應用程式後,可以使用此命令指定 JSON Web 權杖 (JWT) 標頭中使用的簽署演算法。有關詳細資訊,請參看註冊 EAS 以為內嵌內容啟用 SSO設定 Tableau 已連線應用程式,以為內嵌內容啟用 SSO

例如,若需要,可以執行以下命令來移除演算法:

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

重要提示:上面的範例命令允許使用不安全的簽署演算法,並且只能用於對錯誤進行疑難排解。

vizportal.oauth.external_authorization_server.issuer

版本:在版本 2021.4 中新增。

預設值:null

必需。使用此命令可指定簽發者 URL。需要簽發者 URL 才能向 Tableau Server 註冊外部授權伺服器 (EAS)。有關詳細資訊,請參閱註冊 EAS 以為內嵌內容啟用 SSO

例如,若 EAS 為 Okta,可能會執行類似於以下內容的命令:

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

vizportal.oauth.external_authorization_server.jwks

版本:在版本 2021.4 中新增。

預設值:null

註冊外部授權伺服器 (EAS) 後,可以使用此命令指定 JSON Web 金鑰集 (JWKS) URL。若身分識別提供者 (IdP) 不公開外部授權伺服器中繼資料端點,則需要 JWKS URL。

例如,若 IdP 為 Amazon Cognito,可能會執行類似於以下內容的命令:

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

版本:在版本 2021.4 中新增。

預設值:10

JSON Web 權杖 (JWT) 有效的最長時間段(以分鐘為單位)。在驗證 JWT 時,Tableau Server 會檢查 JWT 中指定的時間段是否不超過此預設值。EAS 已註冊到 Tableau Server 時,會使用此設定。有關詳細資訊,請參閱註冊 EAS 以為內嵌內容啟用 SSO

例如,要將最長時間段變更為 5 分鐘,請執行以下命令:

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

vizportal.openid.client_authentication

指定 OpenID Connect 的自訂用戶端驗證方法。

若要設定 Tableau Server 以使用需要 client_secret_post 的 IdP,請將此值設定為 client_secret_post

例如,連線至需要此設定的 Salesforce IDP。

vizportal.openid.essential_acr_values

版本:在版本 2020.4 中新增。

指定驗證內容類別引用 (ACR) 值的清單,以提供 OpenID Connect IdP 作為基本宣告請求。IdP 負責確保驗證符合預期的準則。若已填入 vizportal.openid.essential_acr_values 設定金鑰,則 Tableau Server 會充當信賴憑證者,並將檢查權杖回應中的 ACR 宣告。僅當 ACR 宣告與預期的設定金鑰值不相符時,Tableau Server 才會發出警告。

要設定此選項,請按慣用順序輸入 ACR 值,並用雙引號括起來。必須用逗號和空格分隔多個值,如以下範例所示:

tsm configuration set -k vizportal.openid.essential_acr_values -v "value1, value2"

vizportal.openid.full_server_request_logging_enabled

預設值:false

指定是否對 OpenID 活動進行完整記錄。

在對 OpenID Connect 問題進行故疑難排解時,將此設定為true ,收集更詳細的記錄並讓您更好地進行疑難排解。

與所有與記錄相關的設定一樣,我們建議在完成疑難排解並收集記錄後,將此鍵重設為預設值 (false)。這會限制記錄的資訊量,並將記錄檔案的大小保持在最低限度。

vizportal.openid.voluntary_acr_values

版本:在版本 2020.4 中新增。

指定驗證內容類別引用 (ACR) 值的清單,以提供 OpenID Connect IdP 作為自發宣告請求。IdP 負責確保驗證符合預期的準則。若已填入 vizportal.openid.voluntary_acr_values 設定金鑰,則 Tableau Server 會充當信賴憑證者,並將檢查權杖回應中的 ACR 宣告。若缺少 ACR 宣告或提供的宣告值與預期的設定金鑰值不相符,則驗證請求將失敗。

要設定此選項,請按慣用順序輸入 ACR 值,並用雙引號括起來。必須用逗號和空格分隔多個值,如以下範例所示:

tsm configuration set -k vizportal.openid.voluntary_acr_values -v "value1, value2"

vizportal.rest_api.cors.allow_origin

vizportal.rest_api.cors.enabled 設定為 true 時,指定允許存取 Tableau Server 上 REST API 端點的原點(網站)。可以透過用逗號 (,) 分隔每個項目來指定多個原點。

tsm configuration set -k vizportal.rest_api.cors.allow_origin -v https://mysite, https://yoursite

如果 vizportal.rest_api.cors.enabledfalse,則此選項列出的源會被忽略。有關詳情,請參閱在 Tableau Server 上啟用 CORS

附註: 您可以使用星號 (*) 作為萬用字元來相符所有網站。不建議這樣做,因為它允許從具有伺服器存取權限的任何源進行存取,並且可能存在安全風險。不要使用星號 (*),除非您完全瞭解您的網站的影響和風險。

vizportal.rest_api.cors.enabled

預設值:false

控制 Tableau Server 是否允許進行跨源資源分享 (CORS)。設定為 true 時,伺服器允許 Web 瀏覽器存取 Tableau REST API 端點。您可以使用此選項和 REST API 建立自訂門戶。預設情況下,此功能未啟用。若要指定具有存取權限的源(網站),請使用 vizportal.rest_api.cors.allow_origin 選項。只允許使用此選項指定的源向 Tableau Server REST API 發出請求。有關詳情,請參閱在 Tableau Server 上啟用 CORS

vizportal.site_user_group_count_enabled

版本: 在 2022.3.5 及更高版本、2023.1.0 及更高版本中新增。

預設值:false

控制「站台使用者」頁面是否包含顯示每個使用者分組計數的欄。

vizqlserver.allow_insecure_scripts

預設值:false

允許透過 Tableau Desktop 將工作簿發佈到伺服器,以及從伺服器中開啟工作簿,即使該工作簿包含可能不安全的 SQL 或 R 運算式(例如,可能允許 SQL 注入的 SQL 運算式)。如果此設定為 false(預設值),則發佈工作簿或從伺服器中開啟工作簿會導致出現錯誤訊息,並且工作將被阻止。在您將此值設定為 true 之前,請先檢閱知識庫文章:封鎖或允許 Tableau Server 中的 Insecure 指令碼(連結在新視窗開啟)

vizqlserver.browser.render

預設值:true

低於由 vizqlserver.browser.render_thresholdvizqlserver.browser.render_threshold_mobile 設定的閾值的檢視由使用者端 Web 瀏覽器(而非伺服器)呈現。有關詳情,請參閱 設定用戶端轉譯

vizqlserver.browser.render_threshold

預設值:100

預設值表示 PC 上顯示的檢視的高複雜度。複雜度因素包括標記數、標題數、參考線數和註解數。高於此複雜度的檢視由伺服器呈現,而不是在 PC 的 Web 瀏覽器中呈現。

vizqlserver.browser.render_threshold_mobile

預設值:60

預設值表示平板電腦上顯示的檢視的高複雜度。複雜度因素包括標記數、標題數、參考線數和註解數。高於此複雜度的檢視由伺服器呈現,而不是在平板電腦的 Web 瀏覽器中呈現。

vizqlserver.clear_session_on_unload

預設值:false

確定當使用者離開檢視或關閉其瀏覽器時是否將 VizQL 會話保留在記憶體中。預設值 (false) 會將會話保留在記憶體中。若在要離開檢視或關閉瀏覽器時關閉 VizQL 會話,請將此項設定為 true

vizqlserver.force_maps_to_offline

版本:在版本 2020.4.0 中新增。

預設值:false

確定 Tableau Server 是否以離線模式執行地圖。這在網路和地圖伺服器存取受限的斷開連線環境中很實用。若要啟用地圖離線模式,請將此值設定為 true。有關在無法存取網路的環境中安裝與設定 Tableau Server 的詳細資訊,請參閱在斷開連線(無網路連線)的環境中安裝 Tableau Server

vizqlserver.geosearch_cache_size

預設值:5

設定可同時載入到伺服器記憶體中的不同地理搜尋地區設定/語言資料集的最大數量。如果伺服器收到針對不在記憶體中的地區設定/語言資料集的地理搜尋請求,則會將該集載入到記憶體中。如果載入資料集會超出指定限額,則會從記憶體中清除最近使用的地區設定/語言資料集,以便可載入請求的地區設定/語言資料集。最小值為 1。每個緩存在記憶體中佔用大約 60 MB,因此,如果您將此項設定為 10,記憶體使用量將為 600 MB (60 * 10)。

vizqlserver.initialsql.disabled

預設值:false

指定是否忽略所有資料來源的初始 SQL 陳述式。將此設定為 true 以忽略初始 SQL:

tsm configuration set -k vizqlserver.initialsql.disabled -v true

vizqlserver.log.level

預設值:info

vizportal Java 元件的記錄層級。記錄寫入 C:\ProgramData\Tableau\Tableau Server\data\tabsvc\logs\vizqlserver\*.log

如需詳細資料,請設定為 debug。使用調試設定可能會顯著影響效能,因此您應該僅當 Tableau 支援部門指示時才使用它。

從 2020.3.0 版本起就是可動態設定,因此如果只是變更,則無需新啟動 Tableau Server。有關詳情,請參閱變更記錄層級

vizqlserver.NumberOfWorkbookChangesBetweenAutoSaves

預設值:5

Web 製作自動復原設定。指定使用者必須執行變更以觸發自動儲存的次數。變更此值時請小心。自動復原功能可能會影響到 Tableau Server 上的 Web 製作和其他視覺效果相關操作的效能。我們建議隨時間進行增量調整來微調此值。

vizqlserver_<n>.port

正在執行 VizQL 伺服器執行個體(由「<n>」指定)的連接埠。

vizqlserver.protect_sessions

預設值:true

當設定為 true 時,可防止 VizQL 會話在原始使用者結束後被重用。

vizqlserver.querylimit

預設值:1800

更新檢視允許的最長時間,以秒為單位。1800 秒 = 30 分鐘。此設定選項會影響 VizQL Server 和 Data Server。

vizqlserver.RecoveryAttemptLimitPerSession

預設值:3

Web 製作自動復原設定。復原相同工作階段的最大嘗試次數。變更此值時請小心。自動復原功能可能會影響到 Tableau Server 上的 Web 製作和其他視覺效果相關操作的效能。我們建議隨時間進行增量調整來微調此值。

vizqlserver.session.expiry.minimum

預設值:5

當 VizQL 處理序開始出現記憶體不足的情況時,允許丟棄 VizQL 會話前的閒置時間分鐘數。

vizqlserver.session.expiry.timeout

預設值:30

丟棄 VizQL 會話前的閒置時間分鐘數。

vizqlserver.sheet_image_api.max_age_floor

預設值:1

用於緩存由 REST API 的「查詢檢視影像」方法產生的影像的時間(以分鐘為單位)。有關詳情,請參閱 REST API 說明中的 REST API 參考(連結在新視窗開啟)

vizqlserver.showdownload

預設值:true

控制檢視中「下載」功能表的「Tableau 工作簿」選項的顯示。設定為 false 時,Tableau 工作簿選項不可用。

附註此設定不會移除 Web 編輯模式下使用者的選項。

vizqlserver.showshare

預設值:true

控制檢視中「共用」選項的顯示。若要隱藏這些選項,請設定為「False」。

附註: 使用者可以覆蓋伺服器預設值,方法是設定「showShareOptions」JavaScript 或 URL 參數。

vizqlserver.url_scheme_whitelist

指定在檢視和儀表板上使用 URL 動作(連結在新視窗開啟)時要列入允許清單的一個或多個 URL 方案。預設情況下,httphttpsgophermailtonewssmsteltsctsl 方案會被列入安全名單。此命令可以包含多個逗號和空格分隔的值,如本範例中所示:

tsm configuration set -k vizqlserver.url_scheme_whitelist -v scheme1, scheme2

您指定的值將覆寫以前的設定。因此,您必須在 set 命令中包括完整的方案清單。(您無法透過重複執行 set 命令來修改方案清單。)

vizqlserver.web_page_objects_enabled

預設值:true

控制儀表板中的網頁物件是否可以顯示目標 URL。為防止出現網頁,請設定為 false。

vizqlserver.WorkbookTooLargeToCheckpointSizeKiB

預設值:5120

Web 製作自動復原設定。自動儲存之工作簿的大小限制 (KB)。大於此值的工作簿將不會被自動儲存。變更此值時請小心。自動復原功能可能會影響到 Tableau Server 上的 Web 製作和其他視覺效果相關操作的效能。我們建議隨時間進行增量調整來微調此值。

附註:舊版本的伺服器使用預設值:1024

vizqlserver.workflow_objects_enabled

預設值:true

決定是否可以將 Tableau 外部動作工作流程物件新增到儀表板。

webdataconnector.refresh.enabled

已棄用。請改用 tsm data-access web-data-connectors allow

確定是否在 Tableau Server 中為 Web 資料連接器 (WDC) 啟用擷取重新整理。要對所有 WDC 停用重新整理,請將此鍵的值設定為 false,如下所示:

tsm configuration set --key webdataconnector.refresh.enabled --value false

若要瞭解詳情,請參閱 Tableau Server 中的 Web 資料連接器

webdataconnector.whitelist.fixed

已棄用。請改用 tsm data-access web-data-connectors add

指定一個或多個可用於存取可透過 HTTP 或 HTTPS 存取的資料連線的 Web 資料連接器 (WDC)。該命令在單行上格式化為 JSON 資料,所有雙引號 (") 都使用反斜線 (\) 轉義。

例如,將三藩市影業地點 WDC 新增到允許清單中:

tsm configuration set --key webdataconnector.whitelist.fixed --value "'{\"https://tableau.data.world:443\": {\"properties\": { \"secondary_whitelist\": [\"(https://data.world/)(.*)\"] } } }'"

若要瞭解詳情,請參閱 Tableau Server 中的 Web 資料連接器

webdataconnector.enabled

已棄用。請改用 tsm data-access web-data-connectors allow

預設值:true

設定為 true 後,可以使用 tsm 命令來管理伺服器上的 Web 資料連接器。

webdataconnector.whitelist.mode

預設值:mixed

確定 Tableau Server 如何執行 Web 資料連接器。支援的模式為:

  • mixed。使用者可以執行在 URL 的允許清單上的連接器。此模式最初也允許使用者運行已匯入的 WDC。不再支援匯入WDC。
  • fixed。使用者可以執行在 URL 的允許清單上的連接器。
  • insecure。使用者可以執行任何連接器。

重要資訊:insecure 選項用於開發和測試。因為連接器會執行自訂代碼,因此執行尚未審核的連接器可以會對安全構成威脅。

wgserver.audit_history_expiration_days

預設值:183

指定歷史事件記錄從 PostgreSQL 資料庫(Tableau Server 資料庫)刪除後的天數。

wgserver.authentication.legacy_identity_mode.enabled

版本:版本 2022.1 中的新增功能

預設值:在 Tableau Server 2022.1 及更高版本中設定為 false。如果升級到 2022.1 或更高版本的 2022.1 之前的 Tableau Server 部署,預設值為 true

設定 false 使用身份集區。

有關詳情,請參閱身分集區疑難排解

wgserver.authentication.identity_pools.default_pool_description

版本:版本 2023.1 中新增

預設值:Null

或者,可以將初始集區(已設定 TSM)的描述新增到 Tableau Server 登陸頁面,並且對所有使用者可見。建立一個或多個身分識別集區時,此描述會新增到主要登入選項下方,可用於幫助引導屬於初始集區(已設定 TSM)的使用者使用正確的登入選項。

例如,要新增「正式員工在此處登入」描述,可以使用以下命令:

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

附註:初始集區(已設定 TSM)描述不同於自訂登入說明。登入自訂說明顯示在 Tableau Server 登陸頁面上所有登入選項下方,以及初始集區(已設定 TSM)使用者輸入使用者名稱和密碼的頁面上。

wgserver.change_owner.enabled

預設值:true

控制工作簿、資料來源或專案的所有權能否變更。其他選項包括 falseadminonly

wgserver.clickjack_defense.enabled

預設值:true

設定為 true 時,可幫助阻止惡意人員「Clickjacking」Tableau Server 使用者。在 Clickjack 攻擊中,目標頁面以透明方式顯示在另一個頁面之上,攻擊者將誘使使用者在目標頁面中按一下或輸入資訊,而使用者會認為自己在與另一個頁面交互。

有關詳情,請參閱Clickjack 保護

wgserver.domain.accept_list

版本:從版本 2020.4.0 開始新增此金鑰,並取代 wgserver.domain.whitelist

預設值:Null

允許從 Tableau Server 連線至從屬 Active Directory 網域。從屬網域是 Tableau Server 連線的目的地,藉此進行使用者同步作業,不過卻是尚未安裝 Tableau Server 的網域。Tableau Server 將嘗試連線至從屬網域以進行使用者和群組同步作業。在某些情況下,Tableau Server 可能無法連線至從屬網域,因而導致出現錯誤訊息:「網域不在接受清單中(錯誤代碼 = 101015)」。

設定 wgserver.domain.accept_list 選項是安全性漏洞修正程式的必要項目,[重要] ADV-2020-003:Tableau Server 強制執行身份驗證(連結在新視窗開啟)。自 2020 年 2 月起,此漏洞的修正程式包含在 Tableau Server 的所有最新版本和維護版本中。

要設定此選項,請輸入用雙引號括起來的從屬網域。多個網域必須用逗號和空格分隔。例如,tsm configuration set -k wgserver.domain.accept_list -v "example.org, domain.com"

不支援萬用字元功能。例如,如果 Tableau 連線至 sub1.example.orgsub2.example.org,則必須新增這兩個網域。

更新 wgserver.domain.accept_list 選項將覆寫現有值。因此,如果要將新網域加入至存儲在值中的一組現有網域,請在設定選項時,將新網域連同所有現有網域一併加入。可以藉由執行 tsm configuration get –k wgserver.domain.accept_list 擷取現有網域的完整清單。

wgserver.domain.allow_insecure_connection

預設值:False

此設定僅適用於 Windows。此選項指定 Tableau Server 是否將使用未加密的通道連線到 Active Directory。預設值False將強制執行加密通道。如果 LDAP 通道未加密,則 Tableau Server 將不會連線到 Active Directory。

Active Directory 基礎架構應管理憑證,並信任加入網域的電腦。因此,Tableau Server 和 Active Directory 資源之間的通道通訊應進行加密。建議不要允許與 Active Directory 進行未加密的通訊,因為此組態容易受到中間人攻擊。

如果要升級到 Tableau Server 2021.2 或更高版本,而您的 LDAP 通道未加密,則升級將失敗。升級前,可以執行此命令以允許較舊版本的 Tableau Server 的不安全連線。如果在 2021.2 之前的版本上執行此命令,則必須在命令中包含--force-keys選項。

wgserver.domain.fqdn

預設值:%USERDOMAIN% 的值

要使用的 Active Directory 伺服器的完全限定功能變數名稱。

wgserver.domain.password

預設值:Null

指定用於 LDAP 連線的使用者帳戶密碼。請參閱外部識別身分存放區設定參考資料

wgserver.domain.username

預設值:Null

指定用於 LDAP 連線的使用者帳戶名稱。請參閱外部識別身分存放區設定參考資料

wgserver.domain.whitelist

重要資訊:自版本 2020.4.0 起,此金鑰已過時。請改用 wgserver.domain.accept_list

預設值:Null

允許從 Tableau Server 連線至從屬 Active Directory 網域。從屬網域是 Tableau Server 連線的目的地,藉此進行使用者同步作業,不過卻是尚未安裝 Tableau Server 的網域。Tableau Server 將嘗試連線至從屬網域以進行使用者和群組同步作業。在某些情況下,Tableau Server 可能無法連線至從屬網域,因而導致出現錯誤訊息:「網域不在允許清單中(錯誤代碼 = 101015)」。

wgserver.extended_trusted_ip_checking

預設值:false

為受信任的票證請求強制實施 IP 使用者端相符。

wgserver.ignore_domain_in_username_for_matching

版本:在版本 2021.4.21、2022.1.17、2022.3.9 和 2023.1.5 中新增

預設值:false

啟用 SAML 後,可以將 Tableau Server 設定為在將識別提供者 (IdP) 使用者名稱與 Tableau Server 上的使用者帳戶配對時忽略 SAML 使用者名稱屬性的網域部分。當您已在 Tableau Server 中定義與使用者名稱屬性的前置部分配對,但不與使用者名稱屬性的網域部分配對的使用者時,可能會忽略使用者名稱屬性的網域部分。有關詳情,請參閱 SAML 要求主題中的配對 SAML 使用者名稱屬性時忽略網域區段。

例如,要忽略 SAML 使用者名稱屬性中的網域名稱,請執行以下命令:

tsm configuration set -k wgserver.ignore_domain_in_username_for_matching -v true

重要資訊:

  • 在未採取預防措施的情況下,我們不建議忽略網域名稱。具體來說,請驗證使用者名在您在 IdP 中建立的已設定域中是否唯一。
  • 此命令僅適用於 legacy-identity-mode 中的 Tableau Server 部署,或尚未透過身分移轉(連結在新視窗開啟)更新為使用身分服務的部署。

wgserver.restrict_options_method

預設值:true

控制 Tableau Server 是否接受 HTTP OPTIONS 請求。如果此選項設定為 true,則伺服器將為 HTTP OPTIONS 請求返回 HTTP 405(不允許的方法)。

wgserver.saml.blocklisted_digest_algorithms

版本:在版本 2021.1 中新增。

預設值:SHA1

指定任何相關 SAML 憑證簽章、SAML 判斷提示摘要方法,或簽章方法不允許的雜湊演算法。設定後,使用已列入封鎖清單演算法來簽章和雜湊的憑證或判斷提示將遭到拒絕,並且失敗。

在 Tableau 和 IdP 端都可以在多處使用SHA-1。例如:

  • Tableau Server 使用 TSM 上傳的憑證對傳送到 IdP 的請求進行簽章。
  • IdP 中繼資料中用於驗證從 IdP 接收的 AuthNResponse (簽章)的憑證,會使用憑證中的公開金鑰。
  • 使用 SHA-1 對傳入的判斷提示進行簽彰和雜湊處理(DigestMethod 設定為 SHA-1,SignatureMethod 設定為 SHA-1)。

在 Tableau Server 2021.2 中,預設值已變更為(SHA1。有關升級到 2021.2 並設定 SAML 的更多資訊,請參閱知識庫文章使用 SAML 身份驗證的 Tableau Server 在升級到 Tableau Server 2021.2 後無法啟動或拒絕登入

wgserver.saml.forceauthn

版本:在版本 2019.3 中新增。

預設值:false

當設定為true,如果 Tableau 使用者工作階段過期,Tableau Server 將使用 IdP 重新對使用者進行身份驗證。此選項還可用於要求 IdP 提示使用者重新進行身份驗證,即使使用者具有使用中的 IdP 工作階段。

wgserver.saml.idpattribute.username

指定 SAML IdP 儲存使用者名稱的屬性名稱。預設情況下,其設定為 username。如果 IdP 使用的屬性名稱包含空格,請用引號將其括起。有關詳情,請參閱設定全伺服器的 SAML設定特定於網站的 SAML

wgserver.saml.iframed_idp.enabled

預設值:false

預設值為 false,這意味著當使用者選取嵌入檢視上的登入按鈕時,IdP 的登入表單將在快顯視窗中打開。

當您將其設定為 true 時,已經登入的伺服器 SAML 使用者將導航到具有嵌入檢視的網頁,使用者將無需登入即可查看該檢視。

如果 IdP 支援在 iframe 內登入,則可以將其設定為 true。iframe 選項沒有使用快顯視窗安全,所以並不是所有 IdP 都支援它。如果 IdP 登入頁面實現點擊劫持保護,大多數情況下,登入頁面無法顯示在 iframe 中,並且使用者無法登入。

如果您的 IdP 確實支援透過 iframe 登入,您可能需要顯式啟用它。但是,即使您可以使用此選項,它也會針對 SAML 停用 Tableau Server 點擊劫持保護,因此它仍然有安全風險。

wgserver.saml.maxassertiontime

預設值:3000

指定自建立後 SAML 判斷提示可用的最大秒數。

wgserver.saml.min_allowed.elliptic_curve_size

預設值:256

版本:在版本 2021.1 中添加,但不包含預設值。在 2021.2 中,預設值設定為256

此選項指定用於 SAML 身份驗證憑證的最小允許 ECDSA 曲線大小。如果上傳憑證的 ECDSA 曲線小於 256,則在套用變更時,TSM 將記錄錯誤。

如果升級到 Tableau Server 2021.2 或更高版本,但 SAML 憑證使用的 ECDSA 曲線小於 256,則升級後 Tableau Server 將不會啟動。我們建議在升級之前上傳具有 256(或更大)ECDSA 曲線大小的新憑證。或者,您可以執行此命令,以在升級之前在 Tableau Server 的舊版本(2021.1 之前)上設定較小的 ECDSA 曲線大小。如果您在 2021.1 之前的版本上執行此命令,則必須在命令中包含--force-keys選項。有關升級到 2021.2 並設定 SAML 的更多資訊,請參閱知識庫文章使用 SAML 身份驗證的 Tableau Server 在升級到 Tableau Server 2021.2 後無法啟動或拒絕登入

wgserver.saml.min_allowed.rsa_key_size

預設值:2048

版本:在版本 2021.1 中添加,但不包含預設值。在 2021.2 中,預設值設定為2048

此選項指定用於 SAML 身份驗證的憑證允許的最小 RSA 金鑰長度。如果上傳的憑證 RSA 金鑰長度小於 2048,則在套用變更時,TSM 將記錄錯誤。

要使用長度為 1024 的 RSA 金鑰執行 SAML 身分驗證(不建議),請將此值設定為 1024

如果要升級到 Tableau Server 2021.2 或更高版本,並且 SAML 憑證使用的金鑰長度小於 2048,則升級後 Tableau Server 將不會啟動。我們建議您在升級之前上傳金鑰長度為 2048(或更長)的新憑證。或者,您可以在升級之前執行此命令,以在 Tableau Server 的舊版本(2021.1之前)上設定較低的金鑰強度。如果您在 2021.1 之前的版本上執行此命令,則必須在命令中包含--force-keys選項。有關升級到 2021.2 並設定 SAML 的更多資訊,請參閱知識庫文章使用 SAML 身份驗證的 Tableau Server 在升級到 Tableau Server 2021.2 後無法啟動或拒絕登入

wgserver.saml.responseskew

預設值:180

設定仍允許處理訊息的 Tableau Server 時間與判斷提示建立時間(基於 IdP 伺服器時間)之間的最大秒數差。

wgserver.saml.sha256

預設值:true

設定為 true 時,Tableau Server 會對 IdP 的 SAML 判斷提示中的訊息簽章和 SHA-256 摘要進行雜湊處理。僅當 IdP 拒絕包含 SHA-256 雜湊內容的判斷提示時,才可將此選項設定為 false

wgserver.session.apply_lifetime_limit

預設值:false

控制伺服器會話是否存在會話生命週期。將此值設定為 true可以設定伺服器工作階段生命週期。

wgserver.session.idle_limit

預設值:240

登入 Web 應用程式發生超時前的閒置時間分鐘數。

wgserver.session.lifetime_limit

預設值:1440

伺服器會話持續的分鐘數(如果設定了會話生命週期)。預設值為 1440 分鐘(24 小時)。若 wgserver.session.apply_lifetime_limitfalse(預設值),則會忽略此項。

wgserver.unrestricted_ticket

預設值:false

指定是否為透過受信任票證進行驗證的使用者將存取權限擴展到伺服器資源。預設行為僅允許使用者存取檢視。將此項設定為 true 可允許具有有效受信任票證的使用者存取伺服器資源(專案、工作簿等),就好像他們已使用自己的認證登入一樣。

workerX.gateway.port

預設值:80 (如果採用 SSL,則為 443

Apache 偵聽 workerX 所在的外部埠(其中「worker」是用於叢集中後續伺服器節點的術語)。worker0.gateway.port 是 Tableau Server 的外部埠。在分散式環境中,worker0 是初始 Tableau Server 節點。

workerX.vizqlserver.procs

預設值:<number>

VizQL 伺服器數。

zookeeper.config.snapCount

指定導致協調服務建立記錄快照集所必需的事務數。預設情況下,此值為 100,000 個事務。如果協調服務未寫入足夠的事務來產生快照集,則不會自動清理超過 5 天的快照集,並且您可能需要額外的磁碟空間來存儲事務記錄。預設情況下,會在 Tableau 資料目錄中建立事務記錄和快照集。

感謝您的意見反應!已成功提交您的意見回饋。謝謝!