Deploying an Event Notification Plug-In

To deploy an event notification plug-in, complete the following steps:

  1. Package the plug-in into a .jar file.

  2. Copy this .jar file into the %PROGRAMDATA%\HID Global\Credential Management System\custom.war\WEB-INF\lib directory on the ActivID CMS server. Declare each plug-in in the eventnotificationplugin.properties file (as shown in the following example eventnotificationplugins.properties file):

    Example 1: eventnotificationplugins.properties File

    Copy
    plugins = MyFirstPlugin,MySecondPlugin
    MyFirstPlugin.class=com.activcard.aims.PlugIn1
    MySecondPlugin.class=com.activcard.aims.PlugIn2

    This example contains two plug-ins; one named MyFirstPlugin and the other MySecondPlugin, both of which are declared. The classes containing the implementation of these two plug-ins are:

    • com.activcard.aims.PlugIn1

    • com.activcard.aims.PlugIn2
  3. If any Java extensions are required, they need to be added to the Java Runtime Environment (JRE), which is used by ActivID CMS and runs the plug-ins. The JRE is located in the directory parent_of_cms_dir\_jvm\lib where parent_of_cms_dir is the parent directory of the ActivID CMS installation directory (the directory in which the ActivID CMS directory is located).

The plug-in must be installed on the system that acts as the host for the ActivID CMS server. The external system that is called when the event occurs can be hosted on a separate system. If the external system is hosted on a separate system, it is the responsibility of the Event Notification plug-in to transfer the events to that remote system.