Plug-in components Notification

Notification plug-in components must meet a few requirements in order to be usable by the application.
----------------------------------------------------------------------------
The following sections will outline these requirements.

COM Requirements--------------------
The notification plug-in must be implemented as an apartment threaded COM server.

Registration Requirements-----------------------------
The notification plug-in must register itself with COM (via RegSvr32 or a custom method).

The plug-in must also register itself with the WhatsUp Gold application. This registration consists of a series of registry entries under the HKEY_LOCAL_MACHINESoftwareIpswitchWhatsupNotification key. The following entries are required:

ComponentName – A key under the Notification key that specifies the component name (i.e. Pager)
o CLSID – A string value of the CLSID used to create the COM plug-in. This clsid must be listed in the COM registry format. (i.e. {E7B57F67-8B0D-11D4-803D-0001025EB176})
o Description – A one line text description about the plug-in
o DisplayName – The name of the component to be displayed in the WhatsUpGold application
o Manufacturer – The manufacturer of the notification plug-in

Data Storage and Retrieval Requirements===============================================
The notification plug-in is required to implement it’s own file based serialization mechanism for instances of the notification. The plug-in system will provide the component with the path to store and read notification instance data, but the component must do the physical reads and writes. The WhatsUp Gold application has no knowledge of the data types, versions, etc.

User Interface---------------------
The notification plug-in is also required to provide the user interface mechanism for adding and editing instances of the notification. The WhatsUp Gold application will call methods on the interface implemented by the component to display these user interface components.

Web Interface=================
The web interface (IWUGWebNotificationInstanceEditor) is optional for the notification plug-in. If the plug-in implements this interface, there are a few data requirements for integration with the WhatsUp Gold web interface.

The WhatsUp Gold application will be looking for the following hidden form values in the submit operation from a notification related web page:

The form action field must be: “_maincfgret.cgi”
There must be a hidden field named “page” and the value must be “notify”
There must be a hidden field named “action” and the value must be “return”
There must be a hidden field named “type” and the value must be the displayname of the notification plug-in
After the last form field, a hidden field named “end” and the value “end” must exist

Installation Requirements================================
The installation requirements for a plug-in are:
---------------------------------------------------
Must register itself with COM and WhatsUp Gold
Must install help files (for user interface objects) in the WhatsUp Gold directory (if applicable). This path can be found in the registry in HKEY_LOCAL_MACHINESoftwareIpswitchWhatsUpInstallDir
Must install HTML help files (for the web interface) in the directory specified by WhatsUp Gold for HTML Help. This path can be found in the registry in HKEY_LOCAL_MACHINE SoftwareIpswitchWhatsUpSettingsWebDir

Plurk This Post Ping This Post Reddit Stumble This Post

 Link to this page

 Link to this page

No related posts.