The Scout results files

Version 2

    Scout results file structure

    The Scout results data is located at the output folder location specified for the run

    There, Scout saves the actual results of each interaction, a screenshot for each interaction (if the save screenshot flag was passed in as true), product log, the Scout logs of the run and some more miscellaneous files

    The structure of the folder is:

    • <output log path root>\
      • LocalRun\
        • <Tableau version>\
          • <Tableau full version>\
            • <Platform>\
              • <Name of the server, for server, or machine executing for desktop>\
                • <Metrics1-Metricsn>
                  • Folders with metrics information for each iteration.
                  • These files are used by Scout to calculate the timings of each interaction
                • <S1-Sn>\
                  • Here you can find the screenshots for each of the interaction
                  • Each screenshot has a name like: 1_00000000-10c9-c1e4-ffff-ffffc007cab4_1_LoadViz.jpg
                    • The format is like this: n_UUID_m_inter.jpg
                    • n = the counter of the interaction executed
                    • UUID = a unique identifier used to compare 2 runs. For the same interaction, workbook and worksheet Scout guarantees the same UUID
                    • m = The index of the interaction. If there are multiple of the same interaction on the same worksheet this number will distinguish between the different instances
                    • inter = The name of the interaction
                  • There is going to be a different folder for each iteration, S1 for iteration 1... Sn for iteration n
                • Results.csv
                  • This is the most important file, Scout records here all the interactions executed, the duration, if they were successful or not and the path to the screenshot
                • ScoutMetrics.csv
                  • Optional file containing the merged version of the individual metrics files
                • ScoutLog.log
                  • Scout run logging file
                • Test.log
                  • Scout run logging file

    The format of the results file

    Each line in the results file is the outcome of Scout executing an interaction UUID|Index|Iteration|Platform|InteractionMode|Location|Site|Project|Workbook|Worksheet|Interaction|InteractionStartTime|InteractionEndTime|Error|Command|Build|InteractionTotalTime|ScreenshotPath|ExtendedErrorInfoThe different fields are:

    • UUID = unique identified for a workbook, worksheet and interaction. This field is what should be used when doing A\B comparison. Scout guarantees that for the same workbook, worksheet and interaction the UUID is unique and can be used as a key to join the 2 data sets
    • Index = If there are multiple of the same interaction executed on the same worksheet, this index can help distinguish between them
    • Iteration = The iteration
    • Platform = Server or Desktop
    • InteractionMode = NA for Desktop, Viewing or Authoring for Server
    • Location  = the full path to the workbook\worksheet where the interaction was executed
    • Site = NA for Desktop, for Server it is the site on which Scout ran, if a site was specified for the run
    • Project = NA for Desktop, for Server the project is the project for the workbook the interaction was executed on
    • Workbook = The name of the workbook Scout executed on
    • Worksheet = The name of the worksheet Scout executed on
    • Interaction = The name of the interaction executed by Scout
    • InteractionStartTime = The time at the interaction execution start (format: YYYY-MM-DD hh:mm:ss:538)
    • InteractionEndTime = The time at the interaction execution end (format: YYYY-MM-DD hh:mm:ss:538)
    • Error = The error (if any error occurred during the interaction execution)
    • Command = The command executed by Scout to initiate the interaction
    • Build = The version of Tableau
    • InteractionTotalTime = The total time between the start and the end of the interaction execution (in ms)
    • ScreenshotPath = The path to the screenshot for this interaction
    • ExtendedErrorInfo = Optional, could contain extra information about the error, if an error occurred during the execution of the interaction

    When doing A\B comparison the following values should be used as the key to be able to join information from the 2 runs:

    • UUID, Iteration, Index

    This will allow to uniquely identify the same Interaction executed across 2 different runs, as long as the data (workbooks, worksheets) is the same