Difference between revisions of "Defines.js"

Revision as of 12:31, 3 July 2013

defines.js is the JavaScript file located on BioUML server in $CATALINA_HOME/webapps/bioumlweb/ directory (see BioUML server installation). It contains the configuration constants in the appInfo object, some of which should be modified by server administrator. All meaningful constants are listed here.

adminMail (String)

Server administrator e-mail address. It's displayed in user interface in various places like some error messages.

biostoreRegisterLink (String)

Relative URL to account registration page. In order to use standard BioStore registration, the value must be "../biouml/map?registration=1". If this parameter is absent, then no "Registration" button will appear in login box (of course this doesn't prevent the registration).

build (String)

number of web-scripts build. Used to work-around caching of scripts in some browsers. If you update the JavaScript code, you should change (increment) this value so users will get the new version of the code next time. There's default ant target in $CATALINA_HOME/webapps/bioumlweb/ directory which increments this value, so you can just launch ant in this directory after every update.

disableAnonymous (Boolean)

If true, then anonymous login will be disabled ("Demo" button will be removed from login box and empty login name will not be accepted). Please note that this option is not enough to secure your server from unwanted access: corresponding setup in BioStore must be performed as well.

edition (String)

Edition name (usually "web edition"). It's displayed in user interface in various places like page title.

help (String)

URL to manual pages. Used for "Help" button on the main toolbar.

jabberServer (String)

URL of Jabber server. If specified, custom Jabber server will be used for chat module. If absent or empty, default BioStore Jabber server will be used.

manual (String)

URL to manual PDF document. If specified, can be used to link manual from the start page. Currently used in geneXplain project only.

name (String)

Application name (usually "BioUML" or "geneXplain"). It's displayed in user interface in various places like page title.

serverAddress (String)

Absolute URL of this web-server. Currently this parameter is optional, though it's desired to specify it.

serverPath (String)

Relative URL to BioUML server location. Must be "../biouml/". Currently this value is still hardwritten in some code, thus don't try to install BioUML server to different location: even if you change this setting, you will experience some problems and malfunction.

userProjectsPath (String)

Path in BioUML repository to user projects folder. Usually "data/Collaboration" (for BioUML) or "data/Projects" (for geneXplain). Used for some functionality like list of projects in account manager, default location for open element dialog and so on. Please use correct value here.

version (String)

Current software version (for example, 2023.3). It's displayed in user interface in various places like login box.

Example

Here's an example of defines.js file:

var appInfo = 
{
  name: "BioUML",
  edition: "web edition",
  version: "0.9.4",
  disableAnonymous: false,
  build: "11",
  adminMail: "contact_info@biosoft.ru",
  biostoreRegisterLink: "../biouml/map?registration=1",
  serverPath: "../biouml/",
  userProjectsPath: "data/Collaboration",
  help: "http://www.biouml.org/help/user/html/index.html",
  manual: "Manual geneXplain platform.pdf",
  serverAddress: "http://localhost",

  end: ""
};