Report Script Editor

Applies to ReadyAPI 3.9, last modified on July 30, 2021

About

Report scripts are executed when you generate a report and after the run of an entity. Report script editors exist on the test case and test suite levels.

The editor supports all the standard features of ReadyAPI scripting editors such as property expansions, code validation, and code templates.

Test case-level report editors

Click the image to enlarge it.

Test suite-level report editors

Click the image to enlarge it.

Tip: To learn about reporting in ReadyAPI, see Configuring Report Templates.

Script objects

Below is a list of the default objects that are available in the report script editors:

Object Description
log

Includes methods and properties for posting messages to the Script log (to view this log, click Logs in the bottom left corner of the ReadyAPI window and switch to the Script log tab).

You use this for debugging and logging purposes: to post and view data in the log.

report Holds all the data used to populate the report. Its members allow you to add or adjust data and subreport data that the report engine uses to fill the report template.
params Contains all defined report parameters and their values.
testSuite Provides a scripting interface to the test suite run.
Note: This object is only available in test suite-level report scripts.
testCase Provides a scripting interface to the test case run.
Note: This object is only available in test case-level report scripts.

You can see methods and properties of these objects on the Code Completion list. To invoke it, type the object name and press Ctrl+Space.

Examples

You can find examples of report scripts in the Script Extensions (Reporting) topic.

See Also

Script Editors
Script Extensions (Reporting)

Highlight search results