Skip to main content

Component Plug-In SDK 2026 R1

Interface IHarnessRunnerHost

Last update: 19.06.2026

Namespace: Phoenix.ComponentAPI
Assembly: Phoenix.ComponentAPI.dll

The host object passed to harnesses to give them context for their run.

public interface IHarnessRunnerHost : ILicenseProvider, IDisposable

Implements

ILicenseProvider, IDisposable

Properties

ComponentDirectory

This property contains the directory where the pacz is extracted to.

ExtractedPacz

This property contains the IPacz object for the current harness. The plug-in is not responsible for disposing the returned object.

Logger

Get a logger to use when writing messages.

Metadata

Arbitrary metadata about the context can be stored here. Some well known keys will be put here include:

  • TODO: Lookup what MCD and MCRE provide by default to consider what we want going forward.

RunDirectory

This property contains the directory used for running for the component. The behavior of this field is controlled by Phoenix.PaczAPI.IComponentConfig.RunFolderPreference. If set to PerRun this will be a new temporary folder on each call to run the harness. If set to PerProcess, it will be a new temporary folder for each instance.

Methods

UpdateDebugData(Dictionary<string, string>)

Plug-in implementations may supply custom debugging data for the debugging UI by calling this method.

To add debug information to display to the user, supply a string-to-string map where keys are a display label for the value. The keys supplied become "permanent." You may remove a key from the debug display by passing the key in question with a null value.

Note that the host application may not display debugging data until a run is requested.

Connect with Ansys