Defines.js - Revision history

Lan@dote.ru: +loginMessage

2014-03-05T11:23:10Z

+loginMessage

Lan@dote.ru: {{BioUML current version}} used /* Example */

2013-07-30T04:32:24Z

{{BioUML current version}} used - ‎Example

Lan@dote.ru at 05:31, 3 July 2013

2013-07-03T05:31:50Z

Lan@dote.ru at 04:22, 17 April 2013

2013-04-17T04:22:38Z

Lan@dote.ru: Sorting

2013-04-17T04:20:13Z

Sorting

Lan@dote.ru: +serverAddress

2013-04-17T04:18:47Z

+serverAddress

Lan@dote.ru: grammar

2013-04-17T04:13:32Z

grammar

Lan@dote.ru: Created page with "defines.js is the JavaScript file located on BioUML server in $CATALINA_HOME/webapps/bioumlweb/ directory (see BioUML server installation). It contains some configuration ..."

2013-04-17T04:13:03Z

Created page with "defines.js is the JavaScript file located on BioUML server in $CATALINA_HOME/webapps/bioumlweb/ directory (see BioUML server installation). It contains some configuration ..."

New page

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

;name (String)
:Application name (usually "BioUML" or "geneXplain"). It's displayed in user interface in various places like page title.
;edition (String)
:Edition name (usually "web edition"). It's displayed in user interface in various places like page title.
;version (String)
:Current software version (for example, {{BioUML current version}}). It's displayed in user interface in various places like login box.
;adminMail (String)
:Server administrator e-mail address. It's displayed in user interface in various places like some error messages.
;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.
;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).
;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.
;help (String)
:URL to manual pages. Used for "Help" button on the main toolbar.
;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.
;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.
;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 <code>ant</code> target in $CATALINA_HOME/webapps/bioumlweb/ directory which increments this value, so you can just launch <code>ant</code> in this directory after every update.

=== 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: "localhost",

end: ""
};

[[Category:Installation]]

← Older revision		Revision as of 05:31, 3 July 2013
Line 1:		Line 1:
−	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 <code>appInfo</code> object, some of which should be modified by server administrator. All meaningful constants are listed here.	+	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 <code>appInfo</code> object, some of which should be modified by server administrator. All meaningful constants are listed here.

	;adminMail (String)		;adminMail (String)

← Older revision		Revision as of 04:13, 17 April 2013
Line 1:		Line 1:
−	defines.js is the JavaScript file located on BioUML server in $CATALINA_HOME/webapps/bioumlweb/ directory (see [[BioUML server installation]]). It contains ~~some~~ configuration constants in the <code>appInfo</code> object, some of which should be modified by server administrator. All meaningful constants are listed here.	+	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 <code>appInfo</code> object, some of which should be modified by server administrator. All meaningful constants are listed here.

	;name (String)		;name (String)

@@ Line 15: / Line 15: @@
 ;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.

@@ Line 35: / Line 35: @@
     name: "BioUML",
     edition: "web edition",
-    version: "0.9.4",
+    version: "{{BioUML current version}}",
     disableAnonymous: false,
     build: "11",

@@ Line 20: / Line 20: @@
 :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 the only use of this field is to display it in the login box, thus this parameter is optional.
+: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.
@@ Line 44: / Line 44: @@
     help: "http://www.biouml.org/help/user/html/index.html",
     manual: "Manual geneXplain platform.pdf",
-    serverAddress: "localhost",
+    serverAddress: "http://localhost",
     end: ""

@@ Line 1: / Line 1: @@
 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 <code>appInfo</code> 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).
-;serverPath (String)
+;build (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.
+: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 <code>ant</code> target in $CATALINA_HOME/webapps/bioumlweb/ directory which increments this value, so you can just launch <code>ant</code> in this directory after every update.
-;userProjectsPath (String)
+;disableAnonymous (Boolean)
-: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.
+: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.
-;serverAddress (String)
+;edition (String)
-:Absolute URL of this web-server. Currently the only use of this field is to display it in the login box, thus this parameter is optional.
+: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.
-;build (String)
+;manual (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 <code>ant</code> target in $CATALINA_HOME/webapps/bioumlweb/ directory which increments this value, so you can just launch <code>ant</code> in this directory after every update.
+:URL to manual PDF document. If specified, can be used to link manual from the start page. Currently used in [[geneXplain]] project only.
 === Example ===