Create custom reports in PDF, Word, and Excel

Tosca Cloud offers different solutions for reporting, such as the dashboard or the Reports page. This topic explains yet another option: custom reports on test case level. The so-called "DokuSnapper" offers some key advantages:

• Detailed data for all test steps.

• Screenshots, if the application under test has a graphical user interface (GUI).

• Microsoft Word, Microsoft Excel, or PDF formats.

• Customizable templates for PDF and Microsoft Word reports.

• Reports on the Attachments tab of your test run or offline on your local machine.

Enable DokuSnapper for your test cases

DokuSnapper creates reports on the test case level. To enable it, add the following test case parameters to each test case you want a report for:

• DokuSnapperEnabled

• DokuSnapperStorageLocationType

• DokuSnapperReportFormat

• DokuSnapperPath

• DokuSnapperTemplate

Work with templates

When DokuSnapper creates a PDF or Microsoft Word report, it uses a template that defines which information appears where in your report. You can customize the template to meet your needs.

Note that you can't customize Microsoft Excel reports.

Find your templates

After a default installation of Launcher, you can find the templates at %localappdata%\TRICENTIS\Launcher\TBox\<version>\Resources.

Customize with placeholders

Your template uses placeholders to tell Tosca Cloud what information to put where in your reports. We provide a couple templates to help you get started. They already have some placeholders, but you can add, remove, and replace these as needed.

The first pages of every template have a cover and overview where you can use the following placeholders:

Placeholder	Equivalent information
<Duration>	The length of your test case run.
<ErrorTestSteps>	The number of test steps that encountered an error.
<FailedTestSteps>	The number of failed test steps.
<NoResultsTestSteps>	The number of test steps without results.
<PassedTestSteps>	The number of successful test steps.
<TestCaseName>	The name of your test case.
<TestCaseResult>	The result of your test case: passed or failed, for instance.
<TestCaseStartTime>	The time your test case started. Displays date time according to special task parameters ToscaDateFormat and ToscaTimeFormat.
<TestCaseEndTime>	The time your test case finished. Displays date time according to special task parameters ToscaDateFormat and ToscaTimeFormat.
<[ToscaObjectProperty]>	The value of any property in your test case. Replace [ToscaObjectProperty] with the property you want to report on. Note that to use this placeholder, you must add the parameter DokuSnapperAllPropertiesAvailable with the value True.

After the cover and overview, you'll see a page with placeholders in the upper-right corner. It's a table with two columns but the borders and gridlines are invisible.

The left side of the table is exclusively for the screenshots that Tosca Cloud captures during the test runs of applications with a GUI. You can't add any placeholders in this column.

You can, however, use the following placeholders on the right side of the table:

Placeholder	Equivalent information
<Log>	A predefined set of basic test information and values used. Try this option if you don't want to be too granular about which details go into your report.
<TestStepName>	The name of the test step that was run.
<TestStepResult>	The result of the test step that was run.
<TestStepStartTime>	The exact time your test step started.
<TestStepEndTime>	The exact time your test step finished.
<UsedValue>	The actual value used in your test step during its run.

Note that you mustn't add columns to the table or add tables to the templates.

Access your report

Once you've run your tests, you can find your report at the location you defined in the DokuSnapperPath parameter.