Event Handler Properties Files

Configure the default behavior for event handlers with settings available from the Event Handler Settings dialog box.

Design Tool Properties

Create a script.properties file in the <VHI_install_dir>\HostIntegrator\etc folder. It can contain settings for the properties described below. This file has the form of a Java properties file. Entries have the form name=value, one per line. Backslashes ( \ ) must be doubled ( \\ ) to be interpreted literally. Open <VHI_install_dir>/HostIntegrator/etc/script.properties.sample for details.

Classpath: vhi.script.classpath=<semicolon-separated list of JAR file names>

Design Tool uses the vhi.script.classpath setting to locate Java classes that do not contain event handlers, but which must be available for use with the event handlers used by all models executing on the Server. This file is read at script manager startup. The script manager must be reset (by stopping and restarting it or by closing the Design Tool) before changes made to this file will take effect.

If this file is not present, or if the file does not contain a classpath definition, the classpath is assumed to be empty. No external Java libraries will be available to event handlers unless they are defined here.

Any other Java properties contained in this file are made available to event handlers via the Event.getHandlerProperty() API.

Server Properties

The script.properties file defines properties used by the session server to control the script manager. It must be located in the <VHI>\etc folder, and is in the form of a Java properties file. Entries have the form name=value, one per line. Backslashes ( \ ) must be doubled ( \\ ) to be interpreted literally. Open <VHI_install_dir>\HostIntegrator\etc\script.properties.sample for more details.

Classpath:vhi.script.classpath=<list of JAR file names>

The value is a string. On UNIX, it consists of a colon-separated list of JAR file names to be searched. On Windows, it is a semicolon-separated list of JAR file names.

You can define the Java classpath that the session server uses for locating Java classes that do not contain event handlers, but that must be available for use with event handlers. This file is read-only when the server starts. The script manager must be reset (using the Reload Event Handlers option on the Events menu in the Design Tool, or by restarting the session server) before changes made to this file take effect.

If this property is not present, the default classpath is assumed to be empty (no external libraries used).

Other Properties

Any other Java properties contained in this file are made available to event handlers via the getHandlerProperty API.

 

Related Topics
Bullet Event handler settings
Bullet Event handler guidelines