ReportPackage¶

class ReportPackage¶

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:

ReportPackage

GetAbortCode()¶

Returns the abort code of the package or an empty string if it was not aborted.

Returns:

Abort code of the package

Return type:

str

GetAbortComment()¶

Returns the abort comment of the package or an empty string if it was not aborted.

Returns:

Abort comment of the package

Return type:

str

GetArtifacts()¶

Returns all referenced artifacts.

Returns:

A list of all referenced artifacts.

Return type:

list[Artifact]

GetAttributes()¶

Returns all package attributes

Returns:

Dictionary of package attributes

Return type:

dict[str, str]

GetComment()¶

Returns the comment of the package.

Returns:

Comment of the package

Return type:

str

GetDuration()¶

Returns the duration of the test execution.

Returns:

Execution duration in seconds

Return type:

float

GetElementName()¶

Returns the project element name.

Returns:

Name of the project element

Return type:

str

GetExecutionTime()¶

Returns the test execution date and time as string representation.

Returns:

Execution time

Return type:

str

GetFilename()¶

Returns the filename of the package which corresponds to the column ‘Activity’ in the project summary (without file extension).

Returns:

Name of the package file

Return type:

str

GetGlobalConstantsDefinedOnStart()¶

Gets the values that the global constants had at the start of the Package execution.

Returns:

list of global constants

Return type:

list[GlobalConstant]

GetName()¶

Returns the package name.

Returns:

Package name

Return type:

str

GetOriginalResult()¶

Returns the original total test result.

Returns:

Original total test result

Return type:

str

GetParameterDescription(name)¶

Returns the description of the parameter specified by the given name.

Parameters:

name : str¶

Name of the parameter

Returns:

Description of the parameter

Return type:

str

GetParameterInitialValue(name)¶

Returns the string representation of the initial value of the parameter specified by the given name.

Parameters:

name : str¶

Name of the parameter

Returns:

Initial value of the parameter

Return type:

str

GetParameterNames()¶

Returns a list of parameter names.

Returns:

List of names

Return type:

list[str]

GetParameterOrigin(name)¶

Returns the origin of the parameter specified by the given name.

Parameters:

name : str¶

Name of the parameter

Returns:

Origin of the parameter

Return type:

str

GetParameterValue(name)¶

Returns the string representation of the latest value of the parameter specified by the given name.

Parameters:

name : str¶

Name of the parameter

Returns:

Value of the parameter

Return type:

str

GetProjectElements()¶

Returns a list of all direct project child elements.

Returns:

List of direct project child elements

Return type:

list[ReportProjectElement]

GetRecordings()¶

Returns the recordings created or used by the package.

Returns:

The recording objects

Return type:

list[ReportRecording]

GetReportItemId()¶

Returns the ReportItem Id of the project element.

Returns:

ReportItem Id

Return type:

int

GetResult()¶

Returns the package result.

Returns:

Package result

Return type:

str

GetReturnDescription(name)¶

Returns the description of the return specified by the given name.

Parameters:

name : str¶

Name of the return

Returns:

Description of the return

Return type:

str

GetReturnInitialValue(name)¶

Returns the string representation of the initial value of the return specified by the given name.

Parameters:

name : str¶

Name of the return

Returns:

Initial value of the return

Return type:

str

GetReturnNames()¶

Returns a list of return names.

Returns:

List of names

Return type:

list[str]

GetReturnValue(name)¶

Returns the string representation of the latest value of the return specified by the given name.

Parameters:

name : str¶

Name of the return

Returns:

Value of the return

Return type:

str

GetRevalComments()¶

Returns all revaluation comments of the package.

Returns:

List of revaluation comments

Return type:

list[RevaluationComment]

GetStimulationPackage(returnParamSets=True)¶

This call is only valid for analysis packages and returns the stimulation package.

Note:

For older reports (before 2022.2) this method may return None if no trace analysis was executed.

Parameters:

returnParamSets : bool¶

Specifies, how to deal with stimulation parameter sets. If True, the parameter set that has been used to stimulate the execution of the analysis package is returned.

If False, the stimulation package itself is returned, which is of type ReportParameterizedPackage for parameterized stimulations.

Returns:

The stimulation package. The default return value will be of type ReportPackage. If returnParamSets is False, it is possibly also of type ReportParameterizedPackage.

Return type:

ReportProjectElement

GetSubReportPath()¶

Returns the path to the trf subreport of the package.

Returns:

Path to the trf sub report or None if there is no sub report

Return type:

str

GetTestCase()¶

Returns the test case of the package.

Returns:

Test case of the package

Return type:

ReportTestCase

GetTestManagementId()¶

Returns the corresponding test management ID.

Returns:

Test management ID or an empty string if no ID defined.

Return type:

str

GetTestScriptId()¶

Returns the corresponding testscript ID.

Returns:

Testscript ID or an empty string if no ID defined.

Return type:

str

GetTraceAnalysisJobs()¶

Returns a list of the analysis jobs of the package.

Returns:

List of analysis jobs

Return type:

list[ReportAnalysisJob]

GetType()¶

Returns the type (class name) of the project element, e.g.

• “ReportConfigurationChange”

• “ReportFolderElement”

• “ReportPackage”

• “ReportParameterizedPackage”

• “ReportParameterSet”

• “ReportProjectElement”

• “ReportProject”

Returns:

Type (class name) of the test step

Return type:

str

GetUserDefinedData()¶

Returns the user defined report information.

Returns:

Name and value of the user defined information.

Return type:

dict[str, str]

IsAnalysisPackage()¶

Returns, whether this package is an analysis package.

Returns:

True if this package is an analysis package

Return type:

bool

IsSkipped()¶

Returns True if the package was skipped.

Returns:

True if skipped

Return type:

bool

IsStimulationPackage()¶

Returns, whether this package is a stimulation package.

Returns:

True if this package is a stimulation package

Return type:

bool