TestimoX

API Reference

Class

ExecutionConfiguration

Namespace TestimoX.Execution
Assembly TestimoX
Implements
IEquatable<ExecutionConfiguration>

Configuration for running TestimoX executions in any host (CLI, PowerShell, samples). Lives in the core library so hosts reuse the same options and semantics.

Inheritance

  • Object
  • ExecutionConfiguration

Constructors

public ExecutionConfiguration() #

Methods

public virtual ExecutionConfiguration <Clone>$() #
Returns: ExecutionConfiguration
public virtual Boolean Equals(ExecutionConfiguration other) #
Returns: Boolean

Parameters

obj Object requiredposition: 0
public override Int32 GetHashCode() #
Returns: Int32
public override String ToString() #
Returns: String

Properties

public Int32 Concurrency { get; set; } #

Maximum number of rule tasks to run concurrently.

public Boolean GenerateHtml { get; set; } #

Generate HTML report output.

public Boolean OpenReport { get; set; } #

Open HTML report automatically when finished.

public String HtmlReportPath { get; set; } #

Path to HTML report (overrides default when set).

public Boolean GenerateWord { get; set; } #

Generate Word (.docx) report output.

public Boolean GenerateJson { get; set; } #

Generate JSON summary report output.

public String WordReportPath { get; set; } #

Path to Word report (overrides default when set).

public String JsonPath { get; set; } #

Path to JSON report (overrides default when set).

public String ExportDir { get; set; } #

Directory for exports (attachments, CSV, etc.).

public Boolean AutoConfirm { get; set; } #

Auto‑confirm prompts in interactive hosts.

public VerbosityLevel Verbosity { get; set; } #

Verbosity level for console output.

public ConsoleView ConsoleView { get; set; } #

Console rendering mode (auto/plain/fullscreen).

public Boolean KeepOpen { get; set; } #

Keep console UI open after run completes (for manual review).

public PreflightMode Preflight { get; set; } #

Preflight mode: Soft (most rules), Strict, or Off.

public StorageConfig Storage { get; set; } #

Optional durable store configuration for this run. When provided and enabled, the engine may reuse cached results and write outputs as rules complete.

public String LicenseEdition { get; set; } #

Optional license edition label for this run (for example Community, Test, Trial, Premium, Enterprise). Used for report attribution only; behavior is governed by the licensing engine.

public String LicenseSubject { get; set; } #

Optional licensed-to subject (person or team) used for attribution in reports.

public String LicenseOrganization { get; set; } #

Optional licensed-to organization used for attribution in reports.

public Nullable<DateTimeOffset> LicenseExpiresUtc { get; set; } #

Optional license expiry timestamp in UTC used for display in HTML and Word reports.

public Nullable<DateTimeOffset> BuildSupportExpiryUtc { get; set; } #

Optional build support window end timestamp in UTC used for display in HTML and Word reports.

public Nullable<Int32> LicenseConcurrencyCap { get; set; } #

Optional concurrency cap derived from licensing. When set, the engine clamps the requested Concurrency to this value before executing rules.

public Nullable<Boolean> LicenseAllowHtml { get; set; } #

Optional flag indicating whether HTML report generation is permitted by the current license. When false, hosts should ignore GenerateHtml and not offer HTML toggles.

public Nullable<Boolean> LicenseAllowWord { get; set; } #

Optional flag indicating whether Word report generation is permitted by the current license. When false, hosts should ignore GenerateWord and not offer Word toggles.

public Nullable<Boolean> LicenseAllowJson { get; set; } #

Optional flag indicating whether JSON report generation is permitted by the current license. When false, hosts should ignore JSON paths/toggles.

public PowerShellRuntimeConfig PowerShellRuntime { get; set; } #

Optional PowerShell catalog settings (override default compiled/legacy behavior for the run).

public Boolean IncludeSupersededRules { get; set; } #

When true, do not suppress rules that are marked as superseded; run legacy/alternate implementations as well.

public String PowerShellRulesDirectory { get; set; } #

Optional path to a folder containing user PowerShell rules (.ps1). When set, discovery loads from this path instead of relying on the TESTIMOX_PS_RULES_DIR environment variable.