Document Status : draft, awaiting review


This section presents a step-by-step execution of the process of extracting, compiling, and executing VIVO with UQAM-DEV.

Prerequisite

Variables definition

The table below shows the list of variables used in this procedure

Variable nameValue
UQAM_DEVHome directory of eclipse installation (ex.: c:\UQAM_DEV on Windows or /home/user_name/uqam_dev on linux)
ECLIPSE_HOME$UQAM_DEV/eclipse
TOMCAT_HOME$ECLISPE_HOME/apache-tomcat-8.5.11
TOMCAT_WEBAPP$TOMCAT_HOME/webapp
SOLR_HOME$ECLISPE_HOME/solr-7.7.2
VIVO_HOME$ECLISPE_HOME/vivo/home
GIT_HOME$UQAM_DEV/GIT (Proposal)

1. Configuration of VIVO servers

This step consists of editing the files needed to configure VIVO.

ref: https://wiki.lyrasis.org/display/VIVODOC111x/Installing+VIVO#InstallingVIVO-ConfiguretheHomeDirectory

StepsDescription

a) Setup "applicationSetup.n3" for the use of TDB for data persistence.

For this step, just rename the file example.tdb.applicationSetup.n3 by applicationSetup.n3


b) Setup runtime.propeties for configuring the VIVO runtimes attributes

  1. For this step, just rename the file uqam-dev.runtime.properties by runtime.properties
  2. Adjusting the value of each property to your needs



RDFService.languageFilter = true
languages.selectableLocales = fr_CA, en_CA, en_US

rootUser.emailAddress = vivo@uqam.ca
rootUser.passwordChangeRequired = false
rootUser.password = Vivo2435....



2. Cloning VIVO and VIVO installer repositories


2.1 Select the Git perspective

2.2 Click on Clone Git repository

2.3 Provide the repository URI :

https://github.com/UQAM-SB/Vivo-installer-i18n

and click Next

2.4 Make sure the proper path to the Git directory is provided (Ex.: if your UQAM_DEV variable equal C:\UQAM_DEV

Click Finish to add the repository to UQAM-DEV.

2.5 Repeat steps 2.1 through 2.4 using the following repositories URI:

https://github.com/vivo-project/Vitro.git

https://github.com/vivo-project/VIVO.git

https://github.com/vivo-project/Vitro-languages.git

https://github.com/vivo-project/VIVO-languages


Note: for developement purposes, you would have to clone VIVO repositories in your own GitHub account and clone those URI instead.


Make sure to select the appropriate branch !

For the current i18n initiative, the working branch is sprint-i18n.


2.6 When all the repositories are cloned, your Git perspective should look like this:

3. Importing VIVO code into the UQAM-DEV workspace

3.1 In the menu File, select Import

3.2 Select Maven > Existing Maven Projects, and click next

3.3 Provide the path to the Git repository, and click Finish

3.4 Selecting the Java perspective, this is how your Project Explorer should look after the importation

4. Setupping, Compiling and Running VIVO

4.1 Setupping

StepsDescription

1) Editing appropriate setup xml files:

  • Choosing the Resource Perspective
  • Select the 'setting???xml' file specific to your environment
  • Assign the right value to the attributes: vivo-dir and tomcat-dir

2) Configuring the runner

In A) In the Java perspective, scroll down the 'Run' menu and select 'Run Configurations...'.

In B), select the 'Maven Build' vivo-project-i18n-INSTALL. In the 'Goals' field, replace the file name 'settings???xml' by the name you have used in 1)

A)

B)



4.2 Compiling and Running VIVO

StepsDescription


Temporary steps pending merge of feature/i18n_en_CA in the master branch.

1-a) In the Git perspective, right-click on the repository Vivo-installer-i18n

1-b) In the contextual menu, select Switch to

1-c) Then select the feature/i18n_en_CA branch.


Temporary steps pending merge of feature/i18n_en_CA in the master branch.


2-a) In the Java perspective, right-click on vivo-installer-home-i18n

2-b) Select Maven

2-c) Select Update Project...


Temporary steps pending merge of feature/i18n_en_CA in the master branch.

3  Make sure vivo-installer-home-i18n is checked, then click OK.


Steps 1) through 3) must be performed prior to compiling whenever a Git repository was switched to a different branch.


4) In the Java perspective, select vivo-project-i18n INSTALL

5) The Console tab will display the Maven stack trace.

6) Once Maven has compiled the build with success, start Solr.

7) When first starting Solr, you might have to authorize its execution through the Firewall. Choose the parameters you deem adequate, and click Authorize.


Appears under Windows


8) Solr is running.

9) Then, start Tomcat.

10) Tomcat will launch from another window.

Upon success, the server will display the following message:

INFOS [main] org.apache.catalina.startup.Catalina.start Server startup in xxxxx ms

This new window has to stay open for Tomcat to run.

Closing the window is actually the method used to shut down the server.


4.8 VIVO will be available at http://localhost:8080/vivo/

It may take some time for the initial page to load, as VIVO will be building its database.


When first loading, VIVO will issue a FreemarkerEmailFactory$Setup warning. Ignore it and click on Continue.


11)  Enter the following credentials to access VIVO in administrator mode:

  • UserName: vivo@uqam.ca
  • Password: rootPassword


Corresponds to the values entered in the runtime.properties file.



5. Loading a fr_CA sample dataset


5.1 Follow this link to download the dataset on your computer : sample-data-fr_localhost-vivo.ttl


5.2 In VIVO, log in as administrator (see point 3.9 above) and click on Site Admin.

5,3 Click on Add / Remove RDF data

5.4 Upload the dataset downloaded on step 4.1

5.5 Select Add mixed RDF

5.6 Select Turtle format

5.7 Check create classgroups automatically

5.8 Submit

5.9 VIVO might take some time to populate the triplestore.


Appendix

List of useful link

NameURL
UQAM-DEV updateSitehttp://vivo-i18n.dev.uqam.ca:8080/uqam-dev/release/