Re3gistry v1.1 - Quick install guide

This is a guide to quickly install and run the precompiled webapp (compiled using Java 1.7) of the Re3gistry software. The complete documentation can be found here.

Prerequisite:

  • Apache HTTPD;
  • Java 7 or Java 8;
  • Tomcat 7 or Tomcat 8;
  • Postgres >= 9.2;
  • ECAS for Tomcat (Refer to this guide to install ECAS for Tomcat)

 

Note:

The examples contained in the "example" folder, provide some example data to produce a copy of the INSPIRE registry service. If you want to create your own registers, follow the "quick customisation guide".

 

Step 1 - Copy the project folders

Before moving the project’s folder, make sure that the Tomcat server is not running. Take the “Re3gistry” folder from the “compiled” folder in the project package and move it in the tomcat’s “webapp” folder.

 

Step 2 - Database installation

The database initialization creates the structure of the DB and fills the registry and registers details and informations.

The database initialization example included in the Re3gistry software package, will create the registers included in the INSPIRE registry service. If you want to create your own registers, follow the "quick customisation guide".

Execute the database initialisation using the example SQL scripts available in the project’s package “example\database” folder.

The database script could be executed either from the command line or using a Graphic User Interface (GUI) such as pgAdmin.

Open the create-tables.sql into an SQL editor and run the queries. Do the same for the database-initialization.sql and database-localization.sql. It is important to run the create-tables.sql before the other scripts. The database-initialization.sql and database-localization.sql files contain some sample data. If you need to cleanup all the database and recreate it, in the example package, there is also a drop-tables.sql script.

Note: for each new register to be added, the register table, the itemcalss table and the localisation table should all be filled in; for more information related to the creation of new register, please refer to paragraph 6.4.

 

Step 2 - Setting up the configurations

Open the configuration files and edit it as explained below. The properties to be changed are marked with the code "_[name]_" (e.g _DBADDRESS_ or _USERNAME_).

It is important that you complete all the configuration by replacing the placeholder "_[name]_", otherwise, the system will not work properly.

  • Re3gistry/WEB-INF/classes/META-INF
    •  persistence.xml: this file provides the configuration for the database. The parameters to be configured are: “javax.persistence.jdbc.url", "javax.persistence.jdbc.password", "javax.persistence.jdbc.user;
  • Re3gistry/WEB-INF/classes/configurations
    • Application.properties: this file contains all the main configurations for the system. To run the system the properties to be updated are:
      • “application.language.available” which represents the available language on the interface and the related language label;
      • “application.contact”, “mail.sender”, “mail.recipient” which are the e-mail address of the contact, sender and respectively recipient;
      • “mail.smtp.host” which is the server host smpt email;
    • logcfg.xml: this file contains all the configurations related to the logger system.  In this file, the logger file path for each “log appender” has to be configured.
  • Re3gistry/WEB-INF/classes/configurations/modules/[modulename.properties]: each module has its own properties file. To run the system, the configuration to be updated are:
    • Re3gistry/WEB-INF/classes/configurations/modules/RegistryData.properties: each property is detailed with comment directly in the property file. The important properties to be updated are:
      • - “data.customtempfolder” (folder to save the temporary data files): if this property is left blank, a default folder is taken (inside the webapp folder);
      • - “data.operatinglanguage”: this property represents the main language of the system;
      • - data.supportedlanguage: this property represents the list of the language supported by the data management system.
    •  Re3gistry/WEB-INF/classes/configurations/modules/RegistryStaticizer.properties:
      • “xml.formats.list=xml,json,html,atom...”: the formats to be used by the xslt transformations (separated by comma)
      • “staticizer.SOLR.format=solr”: the SOLR folder name.
      • “staticizer.cutom.folder.path”: in this folder all the staticized files will be saved .
      • “staticizer.formats.path”: this property specifies the folder containing the xslt files for the transformations. Some example xslt files are available in the project package (example folder).
    • Re3gistry/WEB-INF/classes/configurations/modules/RegistryDeployer.properties:
      • "deploy.script.folder": the folder containing the deploy scripts.
      • "deploy.rss.file": the base RSS for the deployment system.
      • "deploy.rss.targetfolder": target folder for theproduced RSS.
      • "deploy.rss.baseuri": the base uri of the links inside the RSS.

 

Step 3 - Start the system

Start the server: once all the previous steps are completed, start the Tomcat server and test the installation.

Try to access the webapp using its address. An example of url to be called is provided below (this url may be differ depending on the system’s configuration):

http://localhost:[tomcat_port]/Re3gistry (e.g. http://localhost:8080/Re3gistry)