Event Handler Configuration
Event handlers provide a way to notify your application that the status of an action has changed, so that the application can avoid repeatedly calling the QueueInfo action to obtain status information.
Event handlers can be configured to run when asynchronous actions begin processing (OnStart), finish (OnFinish), or fail (OnError).
This section describes the event handlers that are available, and their configuration parameters.
HTTP Event Handler
The HTTP Event Handler sends event data to a URL.
| Parameter | Description |
|---|---|
| LibraryName | To use the HTTP Event Handler, set LibraryName=HttpHandler. |
| BasicPassword | The password to use to access the URL (basic authentication). |
| BasicUser | The user name to use to access the URL (basic authentication). |
| NTLMPassword | The password to use to access the URL (NTLM authentication). |
| NTLMUser | The user name to use to access the URL (NTLM authentication). |
| ProxyHost | The host name or IP address of a proxy server to use to send event data. |
| ProxyPassword | A password for the proxy server. |
| ProxyPort | The port of a proxy server to use to send event data. |
| ProxyUsername | A user name for the proxy server. |
| Retries | The number of times to attempt to connect to the URL, if the initial connection fails. |
| RetryInterval | The amount of time (in seconds) between attempts to connect to the URL. |
| SSLConfig | The name of a section in the configuration file that contains SSL settings for communication with the URL. |
| URL | The URL to send event data to. |
| UseNTLMAuthentication | Whether to use NTLM authentication to connect to the URL. |
| UseNTLMv2 | Whether to use NTLMv2 authentication. |
Lua Event Handler
The Lua Event Handler passes event data into a Lua script.
| Parameter | Description |
|---|---|
| LibraryName | To use the Lua Event Handler, set LibraryName=LuaHandler. |
| LuaScript | A Lua script to run when an event occurs. |
Text File Event Handler
The Text File Event Handler writes event data to a text file.
| Parameter | Description |
|---|---|
| LibraryName | To use the Text File Event Handler, set LibraryName=TextFileHandler. |
| FilePath | The path of the file to receive event data. |