Running Scout from the command line or scheduled

Version 2

    Scout can be executed from the command line, this allowing it to be scheduled as a task.

     

    Since Scout is written in Java the execution means to execute Java, point to the right classpath, set all the required Java arguments and pass in the right Scout arguments.

     

    Here's an example of a Scout execution:

        

    java -Djna.nosys=true -Djava.library.path=.;.\dependencies -cp bin\*;libs\* com.tableausoftware.test.tools.scout.ScoutRunner <Scout arguments>
    

     

    The composition of this command is:

    1. Start java (java)
    2. Make sure the JNA shipped with Scout is used, and not the default system JNA (-Djna.nosys=true)
    3. Set the java native library path to the Scout\dependencies: (-Djava.library.path=.;.\dependencies)
    4. Set the java class path to the bin and libs folders (-cp bin\*;libs\*)
    5. The name of the class to be executed by java that contains the program entry point for Scout (com.tableausoftware.test.tools.scout.ScoutRunner)
    6. The arguments to be passed in to Scout for execution (<Scout arguments>)

     

    Here are the arguments supported by Scout when executing from the command line:

     

    Argument categoryArgument nameRequiredValuesDefaultDescription
    Generalplatformy[Server, Desktop]The platform Scout will be running against (Tableau Server or Tableau Desktop)
    outputDirn<path>The path where the Scout results, logs and screenshots are going to be saved
    iterationsn<integer>1The number of iterations to execute
    saveScreenshotsn[true, false]trueFlag to indicate Scout to save or not screenshots
    flown[AllInteractions, PageLoad, RandomInteractions]AllInteractionsThe flow Scout will execute. For more information about flows see the main Scout help page
    forceAuditn[true, false]falseA flag indicating the Auditor to overwrite any data already audited
    Server hosty<URL to server>The address to the Tableau Server to execute Scout on
    moden[view, authoring]viewThe interaction mode Scout should be run in (view or authoring)
    serverTypen[onprem, online, public]onpremThe Tableau Server type (on premise, Tableau online or Tableau public)
    urlsFilen<path>A path to a file containing a list of the URLs Scout should be running on (one URL per line)
    saveServerLogsn[true, false]falseA flag indicating to Scout to try to pull the logs from the server after the run execution
    limitViewCountn<integer>If specified this will restrict Scout to only execute on the number of views limited to
    overrideWorkbookDiscoveryOrderOnServern[true, false]A flag indicating to Scout to not go in the order of popularity, but rather go in alphabetical order when discovering content on the server
    isJsDebugEnabledn[true, false]A flag indicating to Scout that the server is rendering the content with jsDebugEnabled query string set to true
    allowServerExecutionWithoutPerfInstrumentationn[true, false]false

    A flag indicating to Scout that it could ignore missing performance instrumentation data due to the fact that WCM were not enabled.

    Useful for user acceptance testing

    siten

    If specified, Scout will only discover content on the given site.

    This is the SiteID, as in the URL and it is case-sensitive

    projectn

    If specified, Scout will only discover content on the given project.

    Case-sensitive

    DesktopworkbookNamen<path>Path to workbook Scout will execute on
    workbookDirn<path>Path to a folder with workbooks Scout will execute on
    tableauExecutabley<path>Path to the location of Tableau Desktop instance to be used by Scout
    suppressDialogsn[true, false]trueFlag to indicate to Scout that it should suppress any dialogs that could be suppressed
    collectPerfmonCountersn[true, false]falseFlag to indicate Scout to try to start and stop performance counter collection
    processIsolationn[true, false]falseFlag to indicate to Scout that each workbook should start a new Tableau Desktop instance