README: section on cdm datasource configuration
[cdm-vaadin.git] / README.md
1
2 ## Developer
3
4 ### Configure vaadin UIs for a specific cdm data source
5
6 On the fist application startup on a cdm data source the `eu.etaxonomy.cdm.addon.config.CdmVaadinConfiguration` will create a `vaadin-apps.properties` file in the cdm source specific configuration folder: `~/.cdmLibrary/remote-webapp/${cdm-source-bean-id}/`
7
8 The default content of this file defined in `eu.etaxonomy.cdm.addon.config.CdmVaadinConfiguration.APP_FILE_CONTENT` at the time of writing this documentation is :
9
10 ~~~
11 ################################################################
12 #
13 # Vaadin application specific configurations
14 #
15 ################################################################
16
17 # Enablement of vaadin uis.
18 #
19 # Multiple uis can be defined as comma separated list.
20 # Whitespace before and after the comma will be ignored.
21 # Valid values are the path properties of the @SpringUI
22 # annotation which is used for UI classes.
23 cdm-vaadin.ui.activated=account,concept,distribution,editstatus
24 ~~~
25
26 There are more UIs that can be activated by adding them to the `cdm-vaadin.ui.activated` property.
27 For example to enable the `RegistrationUI` you will need to add the name defined in `eu.etaxonomy.cdm.vaadin.ui.RegistrationUI.NAME`:
28
29 ~~~
30 cdm-vaadin.ui.activated=account,concept,distribution,editstatus,registration
31 ~~~
32
33
34 #### Setup Selenium based UI tests
35
36 * Run a `clean install` goal to download the Selenium drivers
37