VizAlerts 2.1.1 Released

Version 1

    I'm happy to report that the next version of VizAlerts, v2.1.1 is now available. There are two main changes:

     

    • 2019.1 compatibility: A change was made to the Custom SQL in the VizAlertsConfig workbook which is required for 2019.1 compatibility,and incorporates another fix. If you plan to upgrade to 2019.1, and don't wish to upgrade fully upgrade to 2.1.1, you can simply replace your existing Custom SQL with the attached file. If you do not do this, VizAlerts will break if you upgrade to 2019.1.
    • Performance Improvements: A bug was fixed where duplicate content references were being processed unnecessarily. For duplicate reports being bursted to many recipients, performance should improve.

     

    A few other documentation updates were added as well.

     

     

    To upgrade from v2.1.0, see the install guide , or read the following:

     

    Upgrading from VizAlerts 2.1.0

    1. Backup your current VizAlerts directory to a separate location.
    2. Download version 2.1.1 fromhttps://github.com/tableau/VizAlerts/releases, and unzip to anewfolder alongside your existing VizAlerts folder. You should have three folders at this point: The live, current installation, the backup of the current installation, and a new folder you unzipped v2.1.1 into.
    3. Merge VizAlertsConfig changes into new workbook
      • There is a new version of \config\VizAlertsConfig.twb that contains a new Custom SQL query. It's easiest to simply drop this into your existing VizAlertsConfig workbook. To do so, here are the steps:
        • Download your existing VizAlertsConfig workbook from Tableau Server and open it in Tableau Desktop
        • Locate thenewVizAlertsConfig workbook from the new VizAlerts folder, in the config subfolder, and open it in Tableau Desktop (you'll need to edit the connection to point to your Tableau Server postgreSQL database)
        • Edit the connection in the new VizAlertsConfig workbook, then edit the one table in the connection pane. This will open the Custom SQL dialog.
        • Copy the Custom SQL Query.
        • Carefully update yourcurrentVizAlertsConfig workbook with the new Custom SQL query.
        • Now re-publish the current VizAlertsConfig workbook to Tableau Server,making sure that you are embedding the password in the connection. This will not break v2.1.0 of VizAlerts.
    4. Copy config files
      • Copy the \config\vizalerts.yaml file from yourcurrentVizAlerts folderoverthe same file in thenewVizAlerts folder
        • No changes were made to this file, so it will work just fine the way it is
      • If you're using SSL to connect to Tableau Server, and have a certificate file you're storing in the VizAlerts folder, make sure it's copied to the new location
      • If you've referenced any other files for passwords or anything else, make sure they're copied as well.
    5. In Task Scheduler, disable the existing VizAlerts scheduled task.
    6. VizAlerts outage begins
    7. If you didn't already publish the updated version of VizAlertsConfig, publish it now, ensuring that you embed the password when you publish it!
    8. Rename folders
      • Rename the existing VizAlerts folder with something like "-old" at the end of it
      • Rename the new VizAlerts folder whatever the old one was called
    9. Testing
      • Open a command prompt, navigate to the VizAlerts folder, and execute VizAlerts one time. Ensure it runs properly, and review the logs if there are any errors.
      • Test a single alert by adding a test_alert comment to a viz, and then run it again in the command prompt, again ensuring that no errors are logged.
    10. Optional: If you want to ensure that no alerts were skipped during the upgrade, copy the \ops\vizalerts.state file from the -old VizAlerts folder to the current one.
    11. In Task Scheduler, enable the VizAlerts task
    12. VizAlerts outage ends
    13. Remove the -old VizAlerts folder and any backups you made, whenever you feel comfortable