ReportFormat¶

class ReportFormat¶

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:: ReportFormat

GetDisplayName()¶

Returns the display name.

Returns:: display name
Return type:: string

GetFormat()¶

Returns the format name.

Returns:: format name
Return type:: string

GetPrePostScript()¶

Returns the pre/post script if set.

Returns:: Pre/post script or empty string if not set
Return type:: string

GetProjectFilter()¶

Returns the project report filter configuration.

Returns:: The project report filter
Return type:: FilterGroupDisjunction

GetSettings()¶

Returns the configuration for this report format.

Returns:: Report format configuration
Return type:: dict[str, str]

GetSettingsValue(name)¶

Returns a specific configuration value.

Parameters:

name : string¶: Name of the settings entry

Returns:

Value of the settings entry

Return type:

string

GetTestCaseFilter()¶

Returns the test case report filter configuration.

Returns:: The test case report filter
Return type:: FilterGroupDisjunction

GetTraceAnalysesFilter()¶

Returns the trace analyses report filter configuration.

Returns:: The trace analyses report filter
Return type:: FilterGroupDisjunction

IsAutoGenerate()¶

Returns if the report format will be automatically generated.

Returns:: True for automatic generation.
Return type:: bool

IsSaveReportFormat()¶

Return if the configuration will be saved for later use.

Returns:: True if activated
Return type:: bool

SetAutoGenerate(autoGenerate)¶

Enable or Disable automatic generation of the report format.

Parameters:

autoGenerate : bool¶: If True, report will be generated automatically after package execution

SetDisplayName(displayName)¶

Sets the display name.

Parameters:

displayName : string¶: New display name to be set

SetPrePostScript(prePostScript)¶

Sets a pre/post script.

Parameters:

prePostScript : string¶: pre/post script as “user.<package>.<module>.<class>” or empty string to unset.

SetProjectFilter(filterGroup)¶

Sets the project report filter configuration.

Parameters:

filterGroup¶: The project report filter

SetSaveReportFormat(saveEnabled)¶

Enable or Disable saving of the configuration for later use.

Parameters:

saveEnabled : bool¶: True for activating

SetSettings(settings)¶

Sets the configuration for this report format

Parameters:

settings : dict[str, str]¶: Report format configuration

SetSettingsValue(name, value)¶

Sets a specific configuration value.

Parameters:

name : string¶: Name of the settings entry
value : string¶: Value of the settings entry

SetTestCaseFilter(filterGroup)¶

Sets the test case report filter configuration.

Parameters:

filterGroup¶: The test case report filter

SetTraceAnalysesFilter(filterGroup)¶

Sets the trace analyses report filter configuration.

Parameters:

filterGroup¶: The trace analyses report filter