bat.pl - Main executable for BAT

Back to top ^

NAME

bat.pl - Main executable for BAT

Back to top ^

DESCRIPTION

All user interaction with the BAT system takes place through this CGI script. Different functionality/pages are available by specifying different modes in the mode CGI parameter. The available modes are outlined below.

Back to top ^

MODES

define_analysis

Accepts no arguments. Displays a page for defining a new analysis. The select elements are populated using the select-tree.js JavaScript module in combination with the jsrs-client.js and JavaScript::RPC::SelectTree modules. Submits to analyse mode.

example_analysis

Like define_analysis, except that there are no dynamic select elements. Submits to analyse mode.

analyse

Runs an analysis as defined by the user in define_analysis mode or as specified in example_analysis mode. Accepts the following CGI parameters:

  data_source_id
  grid_size
  class
  order
  family
  analysis_type

If an analysis is run successfully, the user is redirected to the interactive map URL. If there are too many analyse processes running concurrently, the mode will be switched to define_analysis and the user will be informed of the high server load.

imap_include_top

Provides session-related information within the interactive map. This mode is not called directly by the user, but is called by server side include (SSI) within the interactive map templates. It accepts the following CGI prameters:

  sessionID
  analysisType

analysis_unit_detail

Displays the score and bounding box of a given analysis unit. It also displays a list of distinct species located within the analysis unit. The following CGI parameters are accepted:

  session_id
  analysis_type
  analysis_unit_id

Calls to this mode are activated by clicking on the interactive map with the query tool.

analysis_unit_detail_full

Like analysis_unit_detail mode, except that it displays all records that were analysed against the current analysis unit. It is available via the analysis_unit_detail mode and accepts the same parameters.

Back to top ^

SEE ALSO

BAT::Config, BAT::Database, BAT::Session, BAT::Analysis, BAT::Map

CGI, Template, JavaScript::RPC::SelectTree, JavaScript::RPC::Server::CGI

Back to top ^

AUTHOR

  Bryn Honeyman 2005

Back to top ^

 bat.pl - Main executable for BAT