Executing Scout runs from the UI

Version 1

    Here are the options you can change when executing Scout from the UI tool


    The Scout UI
    Scout UI parameters explanation

    First you need to select the platform to run on (Server or Desktop)

    Server Parameters

    • Server host
      • The address to the Tableau server you want to run Scout on (ex.: http://myserver)
    • Server Type: [On Premise, Online, Public]
      • The type of server deployment (OnPrem, Online, ...)
    • Workbook discovery mode: [Automatic, Url list]
      • The discovery mode. For automatic Scout will query the server and get the workbooks\views to execute on.
      • If set to URLList, you'll need to supply a list of URLs Scout will execute on
    • Site ID
      • The Site to execute Scout on. If this is not supplied Scout will execute on the Default site
      • Note: the siteID is case sensitive
    • Project Name
      • The project you want to execute Scout on
      • Note: the project name is case sensitive
    • Workbook discovery order: [Alphabetical, Most used]
      • The order in which Scout will execute on the workbooks\views on the server
    • Limit view count
      • Use this value to limit the number of views Scout will execute on
      • Depending on the discovery order these could be the nth most used views, or the nth views in alphabetical order
    • URLList file
      • A list of full URLs on the server that you want Scout to execute on
      • Use this option when you have a login that is non-standard or if you want to limit the views Scout will execute on
      • Each entry in the URL file is the full URL to the view (including the workbook, worksheet, site, ...)
    • Interaction mode [Authoring, View]
      • An option to execute Scout in authoring mode or in viewing mode
      • View is almost always the right choice here, most interactions are not requiring authoring mode
    • Is JS Debug enabled
      • Check this option If the server has JsDebug enabled or if the URLList have &:jsDebug appended to the query parameters
      • Having jsDebug enabled makes the presentation model not be minified anymore
    • Allow server execution without perf instrumentation
      • Checking this will allow Scout to run without collecting server client metrics. This is useful when the run is more for validation (User Acceptance Testing purpose)
      • You can find instructions on how to enabled web client metrics here: Getting Started: Scout
    • Save server logs
      • If you check this, at the end of the run Scout will try to connect to the server, save the logs and copy them in the output directory

    Desktop Parameters

    • Workbook directory
      • The location where the workbooks you want Scout to execute on
    • Desktop Exe
      • The location of the Tableau desktop executable
    • Suppress dialogs
      • Turning this on will instruct Scout to dismiss any dialog it can automatically dismiss
      • We strongly suggest having this setting turned on
    • Process isolation
      • Turning this setting "on" will instruct Scout to start a new instance of Tableau desktop for each workbook found in the folder

    Common Parameters

    These are parameters for Scout that are common between server and desktop runs

    • Iterations
      • The number of times you want to execute Scout (in order to collect multiple sets of data to eliminate noise, outliers, average data, ...)
    • Save screenshots
      • Turning this flag on will instruct Scout to take a screenshot for each interaction
    • Output directory
      • The location where you want the output of the run to be saved
      • This includes: logs, results, screenshots, metrics, ...

    Config Parameters

    These settings are read from the config file (config\ScoutConfig.yaml), but you can change them in the UI too

    • Tableau server credentials
      • user name
      • user password
    • DB settings (this only matters for auditor when the data is persisted into a DB)
      • DB Server
      • DB Name
      • DB User
      • DB Password