Event Handler Database File
Overview
Event handlers are stored in the database file uemh.db.
This page describes the parameters that comprise a record in the event handler file.
Event Handler Record
For Universal Event Monitor, an event handler represents the action that should be taken in response to a monitored event.
An event handler record consists of parameters that:
- Describe the action to take.
- Establish an execution environment for the action.
- Define success or failure criteria for the action's outcome.
UEM Server executes the specified action on behalf of the event handler. Accordingly, the action also can be referred to as the event handler process.
Event Handler Parameters
The following table describes the event handler parameters.
The parameters that make up the record's key are underlined.
Parameter |
Description |
Remarks |
---|---|---|
Handler ID |
Unique identifier for the event handler. |
Length of the handler ID cannot be greater than 32 characters. |
Handler Type |
Type of action that will be executed. |
If the Handler Actions field contains a system command or other command line application, this field has a value of cmd. |
Script Type |
Script interpreter to invoke to execute script statements contained in the Handler Actions parameter. |
On Windows-based systems, this value will be used as a file extension for the temporary script constructed by UEM Server in order to execute the script statements specified in the Handler Actions parameter. To insure proper execution of the script, a file association should exist on the target system that specifies the application with which the script should be executed.
|
Maximum Acceptable Return Code |
Highest value that the handler process can return to still be considered as having executed successfully. |
If the value returned by the action is less than or equal to the value specified by this parameter, UEM will report a successful completion of the handler process. |
User ID |
ID of the user account in whose security context the handler actions will be run. |
If the UEM Server processing this record is configured to run without security, the value in this parameter is ignored. |
Password |
Password of the user account specified in the User ID parameter. |
If the UEM Server processing this record is configured to run without security, this parameter is ignored. |
Encrypted File |
Complete path to a file encrypted with Universal Encrypt. |
A password may not be necessary on UNIX, depending on the existing EVENT_HANDLER_ACL entries. |
Encrypted Key |
Optional encryption key used to decrypt the encrypted file. |
This must be the same key that was used to encrypt the file. |
Handler Actions |
Command or script executed by UEM Server for this handler. |
For records with a Handler Type of cmd, this parameter contains the syntax required to execute a system command or other command line application. |
Last Update Date/Time |
Date and time that the event handler was created or last modified. |
|
Last Update User |
ID of the user account that created or most recently updated the event handler. |
|
Options |
String with one or more parameters that UEM adds to the command line that it constructs in order to execute a specified command or script. |
This parameter serves the same purpose as the event definition's Handler Options parameter, but differs in scope. |