The generic openBIS Web application comes with a start page which shows the openBIS logo, a login form and a footer with a link to a help page:
After login the application shows a welcome page together with a history of recently viewed entities. The standard welcome page is just the text "Welcome to openBIS":
Since version 13.04.11 these two pages can be customized by creating a core plugin Web app named
How to customize Login Page and Welcome Page
First you have to create a new core plugin module with an arbitrary name, say
my-start-page. It should contain a Web app named
start-page. Here is the file structure in the folder
<openBIS installation path>/servers/core-plugins(for more details see Core Plugins):
The module name
my-start-pageis arbitrary but the core plugin name
plugin.propertieshas just the line
Next you copy the existing
index.html(to be found in folder
<openBIS installation path>/servers/openBIS-server/jetty/webapps/openbis) into the folder
html. In addition copy also all files in folder
<openBIS installation path>/servers/openBIS-server/jetty/webapps/openbis/custom) into the folder
my-start-page(the name of the new module) to the comma-separated list of property
<openBIS installation path>/servers/core-plugins/core-plugins.properties.
After starting up openBIS you will find that the original file
index.html and folder
<openBIS installation path>/servers/openBIS-server/jetty/webapps/openbis have been replaced by symbolic links into the Web app.
Before starting to customize the login page or the welcome page it is a good idea to make a backup of the existing content of the folder
html of the Web app.
Developing customized Login Page
After the preparation step you can start to modify
index.html and observe the result after reloading it in the Web browser. Note, that the
<div> elements defined in
index.html. All these elements have to be inside the invisible
<div> element with id
openbis_login_div. The following
<div> elements are recognized and used if present.
openbis_login_form is mandatory.
The name of the openBIS instance. It will be placed near the openBIS logo.
|HTML which just appears above the openBIS logo. If not present the file |
|HTML which appears after the login form. By default it shows the text "Click here for help." where "here" is a link to the file |
|This form should have two fields with the ids |
Here is an example which illustrates the layout of the various elements:
Developing customized Welcome Pages
There are three HTML files for welcome pages:
welcomePageSimpleScreening.html. The first will be used in normal view mode. That is, when openBIS application is a normal GUI application with menu bars. The two others will be used in simple view mode. That is, when openBIS application looks like a normal HTML page without any menu bar (see also Simple View Mode of openBIS).
welcomePageSimpleScreening.html is used when technology screening is enabled otherwise
welcomePageSimpleGeneric.html is used.
Here is an example:
The content of
welcomePage.html of the example reads: