wiki:Extensions/GettingStarted

Getting Started

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.

First

  1. Install Proteios
  2. Download build.xml into an empty directory
  3. Run ant init to get sample code and setup source directory
  4. Build the example extension with ant

Action

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.

Examples

ImportXFileForm.java

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

CreateXFileImportJob.java

This action creates a job using the ImportXFile plugin.

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.

Examples

ImportXFile.java

Extension

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).

Last modified 6 years ago Last modified on Dec 13, 2010, 2:38:47 PM