Configuring the web.properties file

The web.properties has these properties:

  • begin.intro
    • the introductory text on the webapp front page
  • begin.query.classes
    • classes that will appear in the QueryBuilder section of the home page.
  • begin.browse.template
    • the template used by the QuickSearch
  • portal.welcome.flybase
    • the message to show when a user arrives at the webapp via the portal action (eg . <something>/portal.do)
  • sitemap.urls
    • URLs that are placed in the sitemap generated for search engines.
  • feedback.title
    • Text for the link to the feedback form located at the bottom of every page.
  • funding
    • Text located in the footer of every page.
  • bag.example.identifiers
    • Text present in the list upload form.
  • header.links
    • These will populate the top right navigation and will link to <link>.shtml
  • submenu.extraLink
    • An external link that will appear in the submenu navigation on each page.
  • attributeLink
    • to configure hyperlinks, generally to external dbs.

Settings for the attributeLink property

The format for this property is

'attributelink' + unique_name + taxonId + attributeName + (url|imageName|text)

or

'attributelink' + unique_name + taxonId + attributeName + 'list' + (url|imageName|text)

if the link is with list of objects (ids).

  • the unique_name is used to distinguish between multiple configurations for the same attribute/organism/class combination
  • the taxonId is either a proper id or '*' when no assumptions is made regarding the organism.
  • the 'list' element is either present (for link with list of identifiers) or not
  • the value of the attribute (for the current object) is substituted anywhere the string "<<attributeValue>>" occurs in the text or the url

example:

 attributelink.flybase.Gene.7227.organismDbId.url=http://www.flybase.org/.bin/fbidq.html?<<attributeValue>>
 attributelink.flybase.Gene.7227.organismDbId.text=FlyBase: <<attributeValue>>

In this case Gene pages for Drosophila melanogaster will have a link that uses the organismDbId field.

A list example:

 attributelink.flymine.Gene.*.identifier.list.url=http://www.flymine.org/query/portal.do?externalid=<<attributeValue>>&class=Gene
 attributelink.flymine.Gene.*.primaryIdentifier.list.text=FlyMine
 attributelink.flymine.Gene.*.primaryIdentifier.list.imageName=flymine_logo_link.gif

Note that for lists the attribute value (the list of ids) is not displayed. Only if a taxId is specified the code will check if the link to the external db is relevant.

An example web.properties file configured for list (modmine).