OMERO.webadmin User Guide

3. Technical background and configuration.

Web Admin is the basic application which allows managing users and groups in Omero server. WebAdmin was build by the JavaServer Faces (JSF), which is a Java technology-based Web application framework that simplifies the development of user interfaces for Java EE applications. Unlike to other traditional request-driven Model-View-Controller web frameworks, JSF uses a component-based approach. The state of UI components are saved when the client requests a new page and then they are restored when the request is returned. Out of the box, JSF uses JavaServer Pages for its display technology, but JSF can also accommodate other display technologies. JSF includes:

  • A set of APIs for representing user interface components and managing their state, handling events and input validation, converting values, defining page navigation, and supporting internationalization and accessibility.
  • A default set of user interface components.
  • A server-side event model.
  • State management.
  • Managed Beans (JavaBeans created with dependency injection).

The list below presents the files that can be configured.

  • web.xml is the main web-application configuration file. You can set the following parameters
    1. defaultServerHost : the value sets in the Hostname field of the login page (see Section 4.1). The default value is localhost.
    2. defaultServerPort : the value sets in the Port field of the login page (see Section 4.1). The default value is 1099.
    3. topTenValue : the number of users using most of the drive space (see Section 4.18). The default value is 5.
    4. usersListsDir : path where the intermediary files will be stored with users' details (see Section 4.5). The default value is /OMERO/WebAdmin. (WARNING: if you change this directory name please, remember to change uploadRepositoryPath . The default value is /OMERO/WebAdmin).
    5. ldapAttributes : list of Ldap search attributes (see Section 4.20). The defult values are: sn,givenName,cn,mail,employeeNumber,uidNumber,gidNumber
  • log4j.properties - Log4j is used to collect logs statement. You can edit log4j.properties to specify the location of the log file.
  • faces-config.xml - sets the parameter ome.admin.bundle.messages to specify the language used, which supporting internationalization and accessibility (default language: en, supported: de, nl, fr, sp, it, pl, ect.). (WARNING: For adding new language needs to be duplicated the tag: <supported-locale>lang</supported-locale> and creates the new file under WebAdmin/src/omero/admin/boundle/ with specified name: messages_LANG.properties and context with translated sentences)
  • message.properties - defines the internationalization context.

To build the application from your IDE you need to run build.xml. Every changes needs to rebuild the application.

To start the tool, use your favorite web browser and enter the following link: http://localhost:1099/WebAdmin/