Version 1 (modified by Gregory Vincic, 13 years ago) (diff)

Refs #665. Copied Manual page from extensions site, links are probably broken.

Extension Manual

Writing extensions for proteios enables you to expand the application with your own actions and plugins. I'll start of by explaining the terms action, plugin and extension. At the end of each term there is a list of examples for you to use and learn from.


Actions are executed each time you click on something in the gui. It may be a link, column or button. Every link in proteios links to an action. Read more about how to ImplementAction.


This action displays a form where the user can enter a string value.

This action creates a job using the ImportXFile plugin.


A plugin is often a block of code that you want to execute at a later time using the job queue within proteios. Use plugins when your code takes long time to execute and you want traceability. Read more about how to ImplementPlugin.



An extension is basically a jarfile named ANAME.ext.jar which is put in servlet directory /path/to/webapps/proteios/WEB-INF/lib. This jar should contain action and/or plugin classes. The plugins available in extensions are available for installation from the gui(if you have administrator privileges). Read more about how to ImplementExtension?.



This example shows how to write an import plugin with actions that create a job for each file to import.