ScenarioRun.ExecutionName Property

Definition

Gets the name of the execution that this ScenarioRun represents.

public:
 property System::String ^ ExecutionName { System::String ^ get(); };
public string ExecutionName { get; }
member this.ExecutionName : string
Public ReadOnly Property ExecutionName As String

Property Value

Remarks

ExecutionName can be set to any string that uniquely identifies a particular execution of a set scenarios and iterations that are part of an evaluation run. For example, ExecutionName could be set to the build number of the GitHub Actions workflow that runs the evaluation. Or it could be set to the version number of the product being evaluated. It could also be set to a timestamp (so long as all ScenarioRuns in a particular evaluation run share the same timestamp for their ExecutionNames).

As new builds / workflows are kicked off over time, this would produce a series of executions each with a unique ExecutionName. The results for individual scenarios and iterations can then be compared across these different executions to track how the EvaluationMetrics for each scenario and iteration are trending over time.

If the supplied ExecutionName is not unique, then the results for the scenarios and iterations from the previous execution with the same ExecutionName will be overwritten with the results from the new execution.

Applies to