Getting Started: Auditor

Version 3

    What is the Auditor?

    The Auditor is a tool that leverages Scout (Getting Started: Scout ) in order to gather content metadata on a server. It excels at providing information about the various relationships between data sources, workbooks, and worksheets on a server. The auditor will help you:

    • Identify workbooks that might need improvement
    • Find workbooks with specific blended data sources
    • View the attributes of your most popular workbooks
    • Understand the impact of changing data sources
    The Auditor is made available AS-IS with no support. This is intended to be a self service tool and includes several training videos and an installation guide. 
    Please review those fully to get the most out of this toolset.

    Getting Started

     

    To get started, you will need a Windows machine (The Auditor currently runs on Windows only) and must be testing against a supported version of Tableau Server. Because Scout interacts natively with Tableau, in order to exercise against a version of Tableau, you will need the corresponding matching version of Scout.

    You are not expected to write any code to get started with this tool. The Auditor is usable "out of the box" with only light configuration needed.

     

    1. Install and configure Postgresql

         Download and install postgresql from https://www.postgresql.org/download/windows/

         Remember the port, username and password you set it up with!
         Once you have completed installation, open pgadmin and create a database called ‘AuditResults’.
        
    If you want others to connect to your Postgres database from Tableau, you may need to adjust your configurations. Add the following line to your pg_hba.conf file.  If you plan on only opening your results from a local machine, ignore this.
             
    host    all             all             0.0.0.0/0               md5
        
    This will allow the auditor to save its results to a local database.

    2. Download the Scout Tool

         Download the Scout tool. If you don’t have Google Chrome, install that too.
         This is still work in progress, we're going to add more information on where and how to download Scout closer to TC and after TC

    3. Run the Auditor

         Locate RunAuditor.bat and run it.
         Enter the URL of the server you want to audit.
         Navigate to the config tab and change the Tableau server credentials (username/user password) to an admin account on your server.
         Also replace the db server, name, username, and password with your postgres information. (The database name should be “AuditResults” and the database server should be something like “localhost:5432”, assuming default installation settings.)

     

    4. Wait

         The auditor takes quite a bit of time. Let it run for as long as you can.

     

    5. See Results

         Open the attached viz in Tableau Desktop. Edit the data source connection to correctly connect to your Postgres db.

    Limitations

    The Auditor cannot audit workbooks that have authenticated data sources. These workbooks have to be omitted, since we can’t gather enough information about them.
    The Auditor cannot audit workbooks that take more than 15 seconds to load; we have a timeout period of 15 seconds.

    Because of the above limitations, it is not safe to make major decisions solely based on the Auditor’s results. The Auditor is intended to be a starting point for gathering data about your server; be careful not to make permanent deletions without double-checking your results.

     

    Troubleshooting

         The Auditor doesn’t do anything

      • Make sure you have Chrome installed.
      • Make sure you have postgres installed and your credentials  match.
      • Make sure you have a valid login and password to your Tableau server.

         The Auditor loads web pages that say “Resource not found”.

      • Make sure you have an admin account on the Tableau server.

         The Auditor doesn’t audit all my workbooks!

      • There have been some instances of auditing failures over extended periods of time. Re-running the auditor without re-auditing old workbooks should cover the missed ones.

         Where are those snazzy vizzes from TC?

      • We will be updating the vizzes shortly!

     

    Other questions? Feedback?

    You may ask Scout or Auditor related questions on our Tableau Administrator Community at: (http://community.tableau.com/community/forums/server-administration)

    If you want to stay informed and get updates, please watch the github project page for updates or follow us on twitter @tableau or @thedavesmolin