ReportData¶

class ReportData¶

Adds a report format to your configuration.

Parameters:

reportFormat¶: Report format to be added

Clone()¶

Call this method if you want to use API-objects in multiple contexts, e.g. if you want to insert a specific test step in multiple blocks.

Returns:: A copy of this object
Return type:: ReportData

CreateReportFormat(formatName)¶

Create a new Output format.

Parameters:

formatName : str¶: Format handler (e.g. “HTML”, “EXCEL”, …)

Returns:

New report format

Return type:

ReportFormat

GetAvailableOutputFormats()¶

Returns a list of available output formats.

Returns:: List of report format names
Return type:: list[str]

GetConfiguredOutputFormats(showActiveOnly=False)¶

Returns a list of display names from configured output formats.

Parameters:

showActiveOnly : bool¶: If True only formats that will be automatically generated are shown.

Returns:

List of report format names

Return type:

list[str]

GetCopyLogFilesToReportFolder()¶

Gets the state of the option to copy log files to report folder.

Returns:: State of the option.
Return type:: bool

GetDirectory()¶

Returns the report directory.

Returns:: Report directory
Return type:: str

GetReportFormat(displayName)¶

Return the report format with the given displayname.

Parameters:

displayName : string¶: Name of the report format

Returns:

Report format object

Return type:

ReportFormat

GetReportFormats(autoGenerateOnly)¶

Returns a list of configured report formats.

Parameters:

autoGenerateOnly : bool¶: If True only formats that will be automatically generated are shown.

Returns:

List of report format display names

Return type:

list[ReportFormat]

GetUserDefinedInfoScripts()¶

Returns the script files for generating user defined report information.

Returns:: List of paths to the *.py files. Absolute or relative to workspace.
Return type:: list[str]

GetUserReportData()¶

Returns user defined report information.

Returns:: User defined report information
Return type:: UserReportData

RemoveReportFormat(reportFormat)¶

Removes the report format.

Parameters:

reportFormat¶: Report format to be removed

RemoveReportFormatByName(displayedName)¶

Removes an report format by name.

Parameters:

displayedName : str¶: Format name (e.g. “New HTML report”)

SetCopyLogFilesToReportFolder(state)¶

Enable or disable the option to copy log files to report folder.

Parameters:

state : bool¶: Enable or disable copy

SetDirectory(reportDir)¶

Sets the report directory.

Parameters:

reportDir : str¶: Report directory to be set

SetUserDefinedInfoScripts(filepaths)¶

Sets the script files for generating user defined report information.

Parameters:

filepaths : list[str]¶: List of paths to the *.py files. Absolute or relative to the workspace. If an empty list is passed, the script paths will be reset.

GetUserDefinedInfoScript()¶

Returns the script file for generating user defined report information.

Returns:: Path to the *.py file. Absolute or relative to workspace.
Return type:: str

Deprecated since version 2026.2: Use GetUserDefinedInfoScripts() instead

SetUserDefinedInfoScript(filepath)¶

Sets the script file for generating user defined report information.

Parameters:

filepath : str¶: Path to the *.py file. Absolute or relative to the workspace. If an empty string is passed, the script path will be reset.

Deprecated since version 2026.2: Use SetUserDefinedInfoScripts() instead