Settings - DokuSnapper

The following settings can be found under Settings->TBox->DokuSnapper:

Setting

Description

Enable Snapper

Set to True to enable DokuSnapper.

When the DokuSnapper function is enabled, Tosca generates a Microsoft Word document for every TestCase upon each execution. The document name consists of the TestCase name and the timestamp of the execution time.

Make all properties available

Set to True if you want to use TestCase properties in your DokuSnapper templates.

Path

The folder for generated Microsoft Word documents. For example: @{Environment.AppData}\dokusnapper.

Report format

Specify the file format for the report that you want DokuSnapper to generate:

  • PDF document (.pdf)

  • Word document (.xlsx)

  • Excel document (.xlsx) - doesn't support templates.

For example: PDF document (.pdf).

Screen Flow

Set to True to generate screenshots of all TestStepValues that use the ActionMode Input (check out "Take screenshots of TestStepValues").

Screen Flow Path

Define a directory where you want Tricentis Tosca to save the screenshots.

If you have enabled Tricentis File Service, you don't have to specify a path. Tricentis Tosca saves the screenshots to the Tricentis File Service.

For example: C:\Temp.

Storage Location Type

Define where Tosca saves the DokuSnapper document.

The default value is Local, which means Tosca saves the document to the folder you specified in the Path setting. This is true even if you have Tricentis File Service turned on.

If you don't want to save the document locally, set the value to Tosca:

  • If you use Tricentis File Service, Tosca adds the document to the execution results in the workspace and saves it to Tricentis File Service.

  • If you don't use Tricentis File Service, Tosca just adds the document to the execution results in the workspace.

To save your Dokusnapper document to both of the above locations, select Tosca and Local.

For the integrated version of pre-execution approval, you must change the setting to Tosca, or VERA doesn't get a record of your results.

To learn how to access your DokuSnapper documents after you've run your tests, check out "Access your DokuSnapper document".

For example: FileService.

Template

The generated document is based on a Microsoft Word template.

The central element of this template is a table with two columns. The left column of a row saves a screenshot of the TestStep and the right column contains the data used by the TestStep.

This template can be customized. For more information, check out "Work with templates".

Note the following preconditions:

  • The template must contain exactly one table with two columns.

  • You can insert different placeholders throughout the right column of this document.

For example: @{Environment.ProjectDir}\templates\TemplateDokuSnapper.doc.