Host

The automatic variable $Host is of type PSHost and represents the current host application for PowerShell.
Within the context of powerEvents this can either be the Vault WebServiceExtension running an extended Host version or your PowerShell IDE.

Syntax

$Host.Name

Remarks

In contrast to your PowerShell IDE the powerEvents Host redirects the written output into the logfile.
The format of the output provided by the Write-Host cmdlet can be customised within the according Logging sections.

Error Notifications

By default the powerEvents host is configured to write to the logfile and display a modal Vault restrictions dialog to notify users about erroneous scripts, modules and exceptions that were thrown by registered Vault events.
The way how users are notified about terminating errors can be changed using the PrivateData and its OnTerminatingError property that provides all the relevant error details:

$global:Host.PrivateData.OnTerminatingError = [Action[System.Management.Automation.RuntimeException]] {
	param($exception)
	        $errorType = $exception.GetType().FullName
	        $errorMessage = $exception.Message
	        $errorStackTrace = $exception.ErrorRecord.ScriptStackTrace

	        if($exception.Data['RegisteredEvent'])
	        {
	                $script = $exception.Data['RegisteredEvent'].Script.FullName
	                $vaultEventName = $exception.Data['RegisteredEvent'].Name
	                Write-Host "An unexpected error has occurred in the script '$script' for Vault event '$vaultEventName'.`r`n$errorType : $errorMessage`r`n$errorStackTrace"
	        }
	        else
	        {
	                Write-Host "An unexpected error has occurred in the script or module '$($exception.ErrorRecord.InvocationInfo.ScriptName)'`r`n$errorType : $errorMessage`r`n$errorStackTrace"
	        }
}

Automatic Script reloading

Changes made in the PowerShell files located in the Events or Modules folder are loaded by the powerEvents Host at every start.
Also when the files are modified while they are loaded, powerEvents automatically executes them again. Restarting your application is not required.
Adding or removing Scripts or Modules also causes powerEvents to automatically reload the whole configuration.

Please be aware that long running operations or modal dialog boxes can block this script execution (e.g. error dialogs).
Changes that are saved in the meantime may then not take effect for the current script execution, and the original script execution will continue after such dialogs are closed. However, the changes will take effect immediately on the next run.
Cmdlets such as Show-Inspector or Show-BOMWindow are an exception. They block the current script execution with the windows they show, but they still allow nested reloading of scripts (but again, PowerShell operations are only executed sequentially).

Note

Similarly, also simple Form.ShowDialog or System.Windows.Forms.MessageBox.Show usages, as well as Window.ShowDialog or System.Windows.MessageBox.Show calls may not block the main window thread from processing automatic reloads.
If these functions are used - by mistake without owner window assignment - changes at runtime might not be supported and can lead to misbehavior.
So, as long as these dialogs are open, no automatic reload should be triggered, or a restart of the application may be necessary for all changes to take effect correctly.

We’re still working on the feature and the documentation to detail what edits are supported.

Keep this functionality in mind when developing new client customizations or when saving changes in your PowerShell IDE.
In order to disable the automatic realoding mechanism you can use the global flag $powerEvents_ReloadPsScripts in the Common.psm1 Module:

$global:powerEvents_ReloadPsScripts = $false

After enabling the functionality again, you need to restart the application.

Type	Name	Description	Access type
String	Name	An identifier for the PowerShell hosting application. Within Client Customizations this should be ‘powerEvents Webservice Extension’.	read-only
PSObject	PrivateData	Each Host can provide private data that is editable. For example the property ErrorBackgroundColor that is available in several PowerShell IDEs for changing the background color of error messages. The powerEvents Host allows manipulating the way how Vault users are notified about Terminating Errors using the `OnTerminatingError` property.	read-write