Tableau server configuration and support
Tableau Support
analytics@broadinstitute.org (first line support, all content support)
tableau-admins@broadinstitute.org (group of BITS staff to ask or alert regarding downtime)
help@broadinstitute.org (standard BITS help if the Windows VM is malfunctioning)
support@tableausoftware.com (if Tableau Server still won't work)
tableau-users@broadinstitute.org (send alerts to this user list about downtime or upgrades)
Server Summary
Broad has three Tableau servers running concurrently on separate local VMs (two other machines run Tableau Desktop), which can be accessed via Remote Desktop (note that you'll often receive a warning that the certificates have the wrong names – this is okay). Reports published to the primary server are replicated onto the dev server every night. If the primary server is unavailable, users can access all their same reports with live data using tableau-dev. Icinga monitoring means BITS will be paged if the server goes down, so let tableau-admins know in advance if there is planned maintenance.
Server | Tableau Server version | Purpose | IP address | Hardware config | Windows version | Icinga | |
---|---|---|---|---|---|---|---|
(CNAME tableau) | 2023.3.5 (July 15, 2024) 2021.4.10 (Nov 25, 2022) 2021.4.2 (July 13, 2022) 2019.4.4 (June 12, 2020) 2018.1.15 (July 26, 2019) 2018.1.6 (December 11, 2018) 10.4.11 (October 6, 2018) 10.4.10 (August 26, 2018) 10.4.7 (June 25, 2018) 10.3.11 (June 3, 2018) | primary production | 192.168.196.109 According to whatsmyip My Public IPv4 is: 69.173.127.109 | 64GB RAM, 8 cores, 590 GB storage | Windows Server 2016 Datacenter |
| |
(CNAME tableau-dev) | 2023.3.5 (June 13, 2024) 2021.4.10 (Sept 21, 2022) 2021.4.2 (April 29, 2022) 2019.4.4 (May 8, 2020) 2018.1.18 (November 4, 2019) 2018.1.16 (August 23, 2019) 2018.1.10 (April 4, 2019) 2018.1.8 (January 2, 2019) 2018.1.6 (December 11, 2018) 10.4.12 (October 17, 2018) | emergency backup | 69.173.127.108 | 64GB RAM, 8 total processors (2 sockets x 4 cores each), 500GB storage | Windows Server 2016 | ||
tableau-beta | 2021.4.10 (Sept 6, 2022) 2021.4.2 (Jan 13, 2022) 2019.4.4 (March 9, 2020) 2019.4.2 (January 24, 2020) 2019.4.1 (January 7, 2020) 2019.3.0 (December 12, 2019) 2018.1.18 (October 25, 2019) 2018.1.17 (September 25, 2019) 2018.1.15 (July 25, 2019) 2018.1.14 (June 26, 2019) 2018.1.13 (June 18, 2019) 2018.1.12 (April 24, 2019) 2018.1.11 (April 4, 2019) 2018.1.10 (February 26, 2019) 2018.1.9 (February 2, 2019) 2018.1.8 (January 2, 2019) | testing | 192.168.196.21 | 32GB RAM, 8 cores, 120GB storage (temporarily increased to 150GB for latest upgrade) | Windows Server 2022 | ||
tableau-ts | Desktop 2023.3 (July 16, 2023) Desktop 2019.4 | Desktop terminal server | 10.200.96.32 | 12GB RAM, 2 cores | Windows Server 2016 Datacenter |
Server Access
Microsoft Remote Desktop Connection (RDC) is used from the Macs to gain access to the servers. A similar program is used from Windows. You must be a member of the tableau-admins group to access the servers. Once logged in, open a Command Prompt to run the tabadmin command line program. NOTE 2018-12-11: TABADMIN WILL CHANGE IN 2018.2 ONWARD
https://help.tableau.com/current/server-linux/en-us/tsm.htm#commands
command | command (2018.2+) | purpose |
---|---|---|
tsm status tsm status -v | check whether server is running list status of each service | |
tsm stop | stop server | |
tsm start | start server | |
tsm restart | restart server (stop then start) |
Screenshot Scripts
Several Windows batch file scripts run on the primary Tableau server to capture images that are sent via e-mail and to monitors around 320C.
Task Scheduler is used to run these automatically. More batch scripts are on the individual monitor computers to copy the images from krypton(gp-reports) to their local directories.
Information about managing the monitors that display these screenshots (and their individual batch scripts) can be found here: Tableau screenshot display monitors
Script | Path | Schedule | Purpose |
---|---|---|---|
mailTableauReports | C:\Local\Tableau Reports\Daily\ | M-F 700a once per day | E-mail daily reports to users |
mailTableauReports | C:\Local\Tableau Reports\Weekly\ | Monday 745a | E-mail weekly reports to users |
getTableauReports | C:\Local\Tableau Reports\Screenshots\ | M-F 730a once per day | Generate images for Common folder |
getTableauScreenshots | C:\Local\Tableau Reports\Screenshots\ | M-F 715a-715p hourly | Generate images for Sequencing, Samples, & CLF folders |
Editing batch files:
To alter a batch file, EDIT it (don't open it, as that runs it). They're written in DOS.
Adding more screenshots to the getTableauScreenshots script is as simple as adding a new line, altering the URL to find the right view for a screenshot, designating the right destination folder, and designating the name of the destination image file. Putting two different output files for a single Tableau view doubles the time that image will display on a monitor.
Backup Scripts
All of the servers are shut down every night to run backup and restore scripts from their C:\Local\Scripts\ directories via Windows Task Scheduler.
Script | Purpose | tableau | tableau-dev | tableau-beta |
---|---|---|---|---|
tableau-backup tableau-cleanup | copy logs and data to \\krypton\TABLEAU_Backups remove old logs and data (>30 days) | 130a | 100a (logs only) | n/a |
tableau-restore-from-prod | restore production data onto server | n/a | 230a | n/a |
Time | Events |
---|---|
100a | tableau-dev and tableau-beta stop, backup their logs, and restart |
130a | tableau stops, backs up its production logs and data, and restarts |
230a | tableau-dev and tableau-beta stop, restore production data, and restart |
Logs
Log files are described here: http://onlinehelp.tableau.com/current/server/en-us/logs_loc.htm
Background tasks
If you need to stop a background task (e.g. an extract refresh that is taking a long time, neither succeeding nor failing), the instructions here work well: https://community.tableau.com/docs/DOC-8920 (note: this problem can occur when a manual refresh is begun right before an automatic refresh starts)
Upgrading Server (admins) https://help.tableau.com/current/server/en-us/upgrade.htm
Consult with lab and BITS to plan upgrade schedule.
Earlier in the day:
- Create a JIRA ticket for the upgrade (e.g. RPT-3311)
- Email tableau-admins@broadinstitute.org to have them turn off Icinga on the target server for the day.
- On any computer, download the latest server version into the tableau-backups directory on Krypton (DL from products download page: http://www.tableau.com/esdalt)
- Email tableau-users to let them know about downtime.
For the upgrade:
- On the target server you're going to upgrade, confirm that there are no current users: (e.g. https://tableau-dev.broadinstitute.org/#/server/analysis/ActionsbyRecentUsers)
- Log in to VM of target server (e.g. tableau-dev).
- On target VM, navigate to the newly downloaded file, open it, accept all defaults during setup/installation.
- Paste in the User (e.g CHARLES\tableau_auth) & password (initialization takes quite a while)
- Once it's done (it'll try to launch IE), trash any *.tsbak from C:\ProgramData\Tableau\Tableau Server\ & any tabsvc.bak* from C:\ProgramData\Tableau\Tableau Server\data\ and empty the recycle bin.
- Ensure that the server is back online by logging in on web (e.g. https://tableau01-dev.broadinstitute.org )
- (Major upgrade only) Start > Environmental Variables / System variables (Edit and change TABLEAU_BIN to C:\Program Files\Tableau\Tableau Server\#.#\bin) Save & Close.
- (Major upgrade only) Restart Windows to force PATH variable to re-source %TABLEAU_BIN%. Confirm updated path using "where tabadmin" command
- Test & validate reports on server
- Test backups & restores from prod to upgraded dev/beta by enabling and running Task Scheduler scripts on VM. .tsbak files are written to \\kr\Tableau_backups\Database\TABLEAU01-DEV, for example. Disable backups on non-production VMs. Disable all schedules on tableau-beta server.
- Update the version in the Server Summary table at the top of this page.
Update SSL certificate on Tableau Server (admins)
Plan for update:
- Tableau Servers need to be restarted to apply the change. To update production Tableau Server's SSL certs, plan down time with GP lab managers and warn tableau-users
- Remote Desktop to VM (any admin user login)
- Make a copy of the .crt and .key files from BITS (C:\Local) in kr\Tableau_backups\Certificates\ (BITS usually provides a .cer file which just needs to be renamed to .crt)
- Generate chain file using https://whatsmychaincert.com/ and copy to kr\Tableau_backups\Certificates\
- Move .cer, .key, and .chained.crt files to wherever TSM expects files to be ( C:\Program Files\Tableau\Tableau Server\SSL )
For the update:
- Remote Desktop to VM (any admin user login)
- Open and login to the TSM portal https://localhost:8850/#/configuration/security/external-ssl (ignore security warning) (any admin user login or CHARLES\tableau_auth password in Teams)
- Click on Configuration tab
- Go to Security and choose External SSL
- Click Reset
- Check the box for Enable SSL for server communication
- Click Select File and browse to the new SSL files for each of the three (do not enter a passphrase)
- Apply pending changes
- Restart Tableau Server to apply changes (may take 20 minutes)
- Test web access
Tableau Server version changes
version | key features | extract format | admin tool |
---|---|---|---|
2018.1 (tableau, tableau-dev, tableau-beta) | Hyper extracts Viz in Tooltip Hierarchy filtering Step and jump lines | hyper | tabadmin |
2018.2 | Tableau Services Manager (tsm) (Upgrade steps: external link) Nested sorting Dashboard extensions | tsm | |
2018.3 | Set actions Dashboard navigation buttons | ||
2019.1 | Tableau Prep Conductor Ask Data (natural language processing) no new legacy text or excel connections | ||
2019.2 | no support for existing legacy text or excel connections | ||
2019.3 | includes integrated audit tool (post-interworks) |
For reference, see
Operating System requirements
Broad's Tableau Servers run on Windows Server 2016 Datacenter