Personal tools
  • We're Hiring!

You are here: Home Documentation Previous versions OME Server Developer New Users APIs Perl API

Perl API

Example code for using the Perl API to build a web application around OME can be found in the ./src/perl2/OME/Web directory and its subdirectories. Login.pm is the login screen; Home.pm is the main page that is displayed upon login, etc. Home.pm loads a Joust configuration file (./src/JavaScript/UseWithJoust.js) to build a joust menu. This menu contains links to modules in the ./src/perl2/OME/Web hierarchy that perform the requested tasks. For example, DatasetSwitch.pm is used to switch datasets, and Viewer.pm brings up an image viewer.

The ./ome/OME/src/perl2/OME directory contains Perl classes for most of the Core OME data types. Generally, these objects are derived from the OME::DBObject class. As with other modules, these files are self-documenting with perldoc.

Document Actions