Customize MOLGENIS
Last updated
Last updated
MOLGENIS allows extensive customization of look & feel to suit your work
The menu manager is a module that gives you the ability to arrange your menu to contain the items that you want it to contain. If you only want to show the data explorer and importer, you can do that. If you want to throw away news and background modules because you do not have any need for them, then you can do that as well. Every item is configurable.
Just remember that throwing away the menu manager module might not be the best idea! And it's good to always keep the blue Home item at the top, else your homepage will no longer be accessible to anonymous visitors.
When you enter the menu manager screen, it can be a bit overwhelming. But do not be alarmed, we will take you through it one step at a time.
First, pay attention to the large list on the left. As you can see, this block represents the current menu structure. You can change the structure by moving items around, you can change the name of a menu item by pressing the pencil, and you can remove items by pressing the trash can. Remember to save your changes before leaving this screen by pressing the 'Save the new menu layout' button. If you do not, then your changes will not be applied to the menu.
The block to the right gives you the options to add new menu items, or to add an entirely new menu. Try it by creating a new menu with 'test_plugin' as ID and 'Test' as the Name, then press 'Create'. You will see that a new item, called Test, is added to your list of items on the left. Now that you have created a new menu, let's add an item to that menu.
Fill in the Create Menu Item form with the following data:
Plugin: contact
Name: Contact information
Query string:
Now press 'Create'. The Contact information item will appear in the list on the right. Move it under the Test menu, and save the layout. You should now have a Test drop down in your menu, and when you open it, it should show you the Contact information item. The contact plugin is similar to the Home plugin as it lets you fill in information via an online editor
Using Query string to add additional parameters Some modules, like the data explorer, can be opened with starting parameters. These can be used via the Query string field when creating a new menu item. To test this, we will add a Query string to the existing Data Explorer menu item so that the data set we created in the Import guidewill be selected at the start.
Edit the existing data explorer item by pressing the pencil, and add the following Query string:
Query string: entity=example_data_table
Save and when you now press the Data explorer in your menu then you will be taken to the data explorer with the example_data_table data set selected.
A complete list of all the Query strings available at the Data Explorer:
Query string
Options
Use
Example
entity
All existing entities
Using this query string you can open the data explorer with the specified entity selected.
entity=test_data
hideselect
true, false
Hide the drop down for selecting data sets. Use this if you want users to focus on only one data set. Combined with the entity query string, you can create a Data Explorer that only shows one data set to users.
entity=test_data&hideselect=true
mod
data, aggregates
Select a Data Explorer tab to show
entity=test_data&hideselect=true&mod=data
Creating redirects to URLs outside MOLGENIS Using the redirect plugin as a menu item, you are able to create a link to an outside source. To show how this works, we will create a menu item that links to Wikipedia.
First, create a new Menu item that has the following traits:
Plugin: redirect
Name: Wikipedia Link
Query string: url=https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FBioinformatics
Second, move the new link below the Home item. Then press the 'Save the new menu layout' button.
A new menu item will appear which will take you to the bioinformatics Wikipedia page.
Creating your own research database often comes with the desire to add a unique styling to it. We wanted to give users a way to change the standard Bootstrap style that is shipped with MOLGENIS.
Using the Theme manager, you can select between multiple bootstrap styles.
To get the feel of how certain styles look, you can select it in the dropdown menu. The style will not be applied to the application unless you press the 'Save' button.
You can create new themes using the https://github.com/molgenis/molgenis-theme/ repository. If they get published there, they'll appear in the pulldown.
Or, if you are hosting a custom theme somewhere, you can open the Application Settings in the Settings Manager and fill in the themeURL and legacyThemeURL there.
The home page is one of the most important part of your MOLGENIS application. It is a doorway to the rest of your application, and as it is such, it should look nice! When you are logged in as administrator, the home page contains an edit button. Clicking this button will open up an editor.
Here you can do simple stuff like adding text, images, and table.
If you want more control, you can go to tools -> Source code. This opens up an HTML editor, which is nice if you know how to write HTML. For even more fancy functionality, the Source code editor also allows you to write JavaScript code.
If you need some aspiration for a nice home page, you visit either the ASE website or the COL7A1 website.
By default, the entity report will be generated using the generic Freemarker template view-entityreport-generic-default.ftl. You can customize this entity report for specific entities by adding Freemarker Templates for those entity. You'll need write permission for the entity FreemarkerTemplate to do this.
In the top menu, select the Data Explorer.
In the pulldown, select the entity FreemarkerTemplate
Push the plus icon.
The Name is view-entityreport-specific-<the entity name>.ftl. So for an entity named ASE, the Freemarker Template containing the entity report should be named view-entityreport-specific-ASE.ftl
The Value is a Freemarker Template specifying the contents of the report.
The HTML you specify in the template will be shown in a modal dialog, so you'll usually want to add a header, a body, and a footer:
If you use the dataexplorer, you might have noticed the tabs showing data or aggregates. MOLGENIS allows you to create tabs with your own content. This content support both HTML and JavaScript.
To Create your own data explorer tab, do the following: 1. In the top menu, select the Data Explorer. 2. In the pulldown, select the entity FreemarkerTemplate 3. Push the plus icon. 4. The name is view-<report name>-entitiesreport.ftl. So for a report called example, the template would be called view-example-entitiesreport.ftl 5. The value is a Freemarker Template specifying the contents of the report.
Now that you created a freemarker template, you want to associate this template with your data set: 1. Go to the dataexplorer and select the cogwheel in the top right corner 2. Scroll down to the reports section 3. In the text area, type the following: <my data set name>:<report name>. For our report, we have a data set called MyData. To link our previously created template, fill in MyData:example. 4. Save, wait for the page to reload, and select MyData from the dropdown in the top right corner. 5. You will now see a new tab called example, which contains the HTML you filled in in the freemarker template.
Download the example dataset here Download the freemarker template example here
The model will contain
a variable named entity of type org.molgenis.data.Entity
a variable named entityTypeMetadata of type org.molgenis.data.meta.model.EntityTypeMetaData
which you can use to specify the contents of your template.
To display the value of one of the entity's attributes value, use ${entity.getString("<the attribute name>")}.
To make a conditional check on the actual value of an attribute, use <#if entity.get("P_Value") == 0>...</#if>.
You can follow references to other entities: <#list entity.getEntities("Genes") as gene>...</#list> will iterate over all Genes. In between the list tags, the gene gets added as a variable gene which you can access the same way as you access the variable entity.
To open a page at a button click, use the data-href attribute to specify the href: <button type="button" class="btn" data-href='<the link>'>Button label</button>.
By default, number values will be shown in 'computer' format (e.g. 1234). If you want to show a human readable form of the number (with a thousand separator: 1,234), you can use the notation ${x?string.number}.
These are just examples, many powerful constructs are possible.
You can show the genome browser, zoomed in on this specific entity.
In the body, add a placeholder div for the genome browser: <div id="modalGenomeBrowser"></div>
At the bottom of the template, add script tags to instantiate the genome browser:
In the top menu, select the Data Explorer.
In the pulldown, select the entity 'languages'.
Push the plus icon.
The code must be a lowercase ISO 639 alpha-2 or alpha-3 code.
The name is the name of the language as shown to the user.
If the is more then one language available a dropdown appears next to the 'Sign out' button on the right of the menu bar (Maybe you have to refresh the browser page first). You can switch langage by selecting a language from the dropdown.
In the top menu, select the Data Explorer.
In the pulldown, select the entity 'i18nstrings'.
Click on the 'Edit row' icon before the row you want to edit.
Provide a translation for each available language.
Missing translations will show up in English in the user interface.
In the top menu, select the Data Explorer.
In the pulldown, select the entity 'Localization'.
Push the plus icon.
Fill in the form according to which plugin you would like to add a description to.
Example for the importwizard plugin, the pluginId is 'importwizard'. The plugin ID can be found in the URL, the sys_Plugin table, or in the menu manager.
After saving, the importwizard plugin will now have a description at the top when the english language is selected. This is an admin only feature and allows the admin to use HTML.
If you want to brand your MOLGENIS instance, you could add a banner. We recommend high resolution image. It will be automatically resize to fit the browser window. Do realize that taking a banner with a very big height might make your application unusable.
There is an application setting that allows you to set the max height of your image. This will force an image to have a height according to the set amount of pixel.
In some cases it would be nice to be able to share a row in your data with someone else. Therefore MOLGENIS contains the “standalone report” functionality. This can be set in the dataexplorer settings. To go there, go to the dataexplorer and click on the gear below the logout button.
In section “Modules”, subsection “Data” the setting “Standalone Reports” can be found. By default the “Standalone Reports” are turned off.
When turning them on, keep in mind that when customizing your entity report in the FreeMarkerTemplate table (see above), you also need to add a customized “view-standalone-report-specific-Your entity name here.ftl”. This file should contain what you want to show in your standalone report.
With the configuration being completed, clicking on the magnifying glass button in front of a row in your dataset will result in your specific freemarker template with the addition of a share link in the upper right corner.
When clicking the copy button, the URL is copied to your clipboard. You can paste it in your address bar in the browser to go to the specific entity report of that row. This way you can bookmark it and share it with others. Opening the link shows the content of your entity report on a new page. Clicking the blue button with: “View full dataset” leads back to the specific table in the dataexplorer.
An example of a banner:
