Upgrade script of Tableau Server with TSM shows garbled text when upgrading from pre-TSM version

Issue

In Windows Operating system with a non-English language pack installed, it is possible the admin may see garbled text when trying to run the upgrade-tsm.cmd script. This happens when the upgrading from pre-TSM version (2018.1 or earlier) to Tableau Server with TSM version (2018.2 or above).

Example below is for the language pack "Simplified Chinese"
upgrade-tsm.cmd shows garbled texts

Environment

Windows Server 2008 or 2012 OS with non-English language pack installed
Tableau Server
- Pre-upgrade version 2018.1 or earlier > Upgrading-to version 2018.2 or newer

Resolution

Change the system locale of Windows to match the applied language setting, in this case Simplified Chinese.
The change will prompt the user to complete a system reboot.
Once system has rebooted, login to the system and run the upgrade-tsm.cmd manually under the software installation path. By default, the path is C:\Program Files\Tableau\Tableau Server\packages\scripts.<version>\

Cause

This issue is caused by the underlying OS setting.

When applying a language pack, for example Simplified Chinese, the system will try to display Chinese characters. However, if the system locale remains as the default (i.e. English), the command prompt may not display the text properly, hence the garbled text appearing in the command prompt.

Additional Information

It is possible to cancel the upgrade-tsm.cmd script when user is seeing the garbled text:

Enter Ctrl-C
Enter "y" to Terminate batch job (Y/N)?

This will prevent upgrade-tsm.cmd from running, and the user can then follow the resolution steps above to proceed with upgrade. A re-installation of the software is not required at this point.

Discuss this article... Feedback Forum