litvinovg/vivo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated file with release announcement from the wiki. Also changed the explanation text for deploy.properties settings for: vitro.core.dir, upload.directory, luceneSetup.indexDir, selfEditing.idMatchingProperty, visualization.topLevelOrg.

Browse source
This commit is contained in:
ejc12 2011-02-01 22:13:04 +00:00
parent a5b4d8d0a6
commit d70fd96e95
1 changed files with 557 additions and 437 deletions
Download patch file Download diff file Expand all files Collapse all files

338
doc/upgrade-1.2.html
View file

@ -13,7 +13,8 @@
<div id="wrapper-content" role="main">
<h1>VIVO Release 1 v1.2 Upgrade Guide</h1>
<small>
January 28, 2011 - Upgrading from Release 1 v1.1 to Release 1 v1.2
January 28, 2011 - Upgrading from Release 1 v1.1 to Release 1
v1.2
</small>
<blockquote>
<b>Missing pieces and fixes</b>
@ -22,9 +23,7 @@
Link to install pdf online at SF
</li>
<li>
Add config table from install d/t so many new vars.
</li>
<li>
<br>
</li>
</ul>
</blockquote>
@ -39,22 +38,109 @@
</ul>
</toc>
<p>
This document provides a short description of the steps involved in upgrading your
installation of VIVO from Release 1, Version 1.1 to Version 1.2. This and other
documentation can be found on the <a href="http://vivoweb.org/support">support page</a>
This document provides a short description of the steps involved in
upgrading your installation of VIVO from Release 1, Version 1.1 to
Version 1.2. This and other documentation can be found on the <a href="http://vivoweb.org/support">support page</a>
at <a href="http://vivoweb.org">VIVOweb.org</a>
</p>
<p>
If you need to do a fresh install, please consult <a href="VIVO_Release-1-v1.2_Installation_Guide.pdf">VIVO Release 1 v1.2 Installation Guide</a>
If you need to do a fresh install, please consult <a href="VIVO_Release-1-v1.2_Installation_Guide.pdf">VIVO Release 1 v1.2
Installation Guide</a>
or the install.html file located in the <code>doc</code>
directoy of the VIVO source code distribution.
directoy of the VIVO source code distribution. The installation
document also has a list of the required software and versions.
</p>
<!-- Release Announcement --><h2 id="announcement">Release anouncement for V1.2</h2>
<p>
Text from the wiki page
The VIVO 1.2 release incorporates major changes to the entire
application - theming and navigation changes that will be immediately
evident to any user, and underlying changes to the system architecture
that are less visible but address important questions of scalability
and extensibility.
</p>
<h3>Theming and Navigation</h3>
<p>
A new installation of VIVO 1.2 will look strikingly different - the
User Interface team has designed a new visual theme that incorporates a
new navigation and browse structure as well as a much more modular
approach to page design. This theme is not only cosmetically different
but leverages entirely new page templates developed with the Freemarker
system, an open-source library for Java development that enables much
cleaner separation of application logic from the actual page design.
These changes extend the available configuration options controlling
VIVO's appearance and navigation options while also simplifying the
process of local customization and branding.
</p>
<p>
For existing installations of VIVO, the upgrade will not immediately
transition to the new theme, navigation, or page templates. The current
default theme and "tabs" (top-level and secondary navigation controls)
will be left intact on upgrade and will still function as they do in
version 1.1.1, with the caveat that local modifications to the default
theme may conflict with internal application changes. We highly
recommend that current VIVO installations use the time between release
1.2 and the upcoming release of version 1.3 (targeted for June or July
2011) to migrate local theme branding and navigation to the new VIVO
template. Many legacy features such as the "tab" infrastructure have
been deprecated with version 1.2 and will no longer be supported as of
version 1.3.
</p>
<h3>Browsing</h3>
<p>
In addition to changes in the top-level navigation, VIVO 1.2
introduces a number of new browsing controls that will be made more
configurable and extensible in version 1.3 but which already offer
extensive functionality.
</p>
<p>
A fresh installation of VIVO 1.2 will feature the new theme and
additional browsing options on other top-level navigation pages (Home,
People, Research, Organizations, and Events). Primary among the new
browsing options will be browsing by <b>type</b>, organized
hierarchically with the same upper-level <b>class groups</b>
currently
visible in search results - people, courses, activities, topics,
events, organizations, and publications. Class groups combine the
similar types such as people or organizations into groups for browsing
and searching, and are locally configurable using the VIVO ontology
editor.
</p>
<p>
Once a group has been selected, browsing can continue to the very
specific, at the level of individual people, organizations, events, or
publications via A ... Z listing featuring thumbnail pictures where
available. Sites will be able to configure which groups and which types
within a group are exposed in search results and for browsing.
</p>
<h3>Data Storage</h3>
<p>
Before this release, VIVO has used the Jena
(<a href="http://jena.sourceforge.net/" rel="nofollow">http://jena.sourceforge.net</a>)
relational database (RDB)
subsystem for the storage of RDF data. The performance of this persistence layer
has never been fast enough for an interactivity at any significant scale, so
VIVO has also maintained a complete copy of data in memory. While server memory capacity
has increased significantly in recent years, this requirement has put
limits on the ultimate scalability of VIVO instances and also increased
the cost of servers required to support VIVO.
</p>
<p>
With version 1.2 VIVO uses the SPARQL database (SDB) subsystem of
Jena, specifically designed to support scalable storage and query of
RDF datasets while still using standard relational database technology.
This transition will significantly reduce the initial memory footprint
of a VIVO application, and while the application will still require
adequate processor and memory resources to generate pages from so many
individual RDF statements, the scalability of VIVO installations is
greatly improved.
</p>
<p>
The transition to retrieving all data via SPARQL queries also
enables additional features important for tracking data provenance and
access to data outside the immediate local VIVO instance. These
features will be more fully explored and developed for version 1.3.
</p>
<!-- Upgrade process for V1.2 --><h2 id="upgrade">Upgrade process for V1.2</h2>
</p>
<toc>
<ol class="roman1">
<li>
@ -67,10 +153,12 @@
<a href="#ontology">Ontology Upgrade</a>
<ol class="roman2">
<li>
<a href="#verify_ontology_upgrade">Verify Ontology upgrade process</a>
<a href="#verify_ontology_upgrade">Verify Ontology upgrade
process</a>
</li>
<li>
<a href="#ontology_knowledge_base">Ontology knowledge base manual review</a>
<a href="#ontology_knowledge_base">Ontology knowledge base
manual review</a>
</li>
</ol>
</li>
@ -78,10 +166,12 @@
<a href="#fileSystem">File Storage System Upgrade</a>
<ol class="roman2">
<li>
<a href="#verify_ontology_upgrade">Changes to the File Storage System</a>
<a href="#verify_ontology_upgrade">Changes to the File
Storage System</a>
</li>
<li>
<a href="#verify_ontology_upgrade">Verify File Storage System upgrade process</a>
<a href="#verify_ontology_upgrade">Verify File Storage
System upgrade process</a>
</li>
</ol>
</li>
@ -106,13 +196,13 @@
</li>
</ul>
<p>
The upgrade process is similar to the original install process with the following
EXCEPTIONS:
The upgrade process is similar to the original install process with
the following EXCEPTIONS:
</p>
<ul>
<li>
DO NOT reinstall MySQL or recreate the MySQL database. Please ensure that
you back-up the MySQL database.
DO NOT reinstall MySQL or recreate the MySQL database. Please
ensure that you back-up the MySQL database.
</li>
<li>
It is not necessary to add RDF data.
@ -120,27 +210,29 @@
<li>
First-time login of the administrator account after the upgrade
process is complete will use the password previously set, NOT the
default password used on the first login after the initial installation.
default password used on the first login after the initial
installation.
</li>
<li>
The first time Apache Tomcat starts up after the upgrade, it will
initiate a process that modifies the knowledge base to align the data
with the revised ontology. See the section on the <a href="ontology">Ontology Upgrade</a>
The first time Apache Tomcat starts up after the upgrade, it
will initiate a process that modifies the knowledge base to align the
data with the revised ontology. See the section on the <a href="ontology">Ontology Upgrade</a>
below for more information.
</li>
</ul>
<h3 id="upgrade_process">The Upgrade Process</h3>
<p>
1. Download the new distribution file and unpack it into a new source
directory.
1. Download the new distribution file and unpack it into a new
source directory.
</p>
<p>
2. Create deploy.properties, using the same values as in your previous
installation and set values for the new variables. The following table
shows the default properties for deploy.properties with new V1.2 properties in
<span class="blue">blue</span>.
<!-- deploy.properties table from install.html -->
2. Create deploy.properties, using the same values as in your
previous installation and set values for the new variables. The
following table shows the default properties for deploy.properties with
new V1.2 properties in <span class="blue">blue</span>.<!-- deploy.properties table from install.html -->
</p>
<table>
<tbody>
<tr>
<th>
Property Name
@ -151,16 +243,18 @@
</tr>
<tr>
<td colspan="2">
Default namespace: VIVO installations make their RDF resources available
for harvest using linked data. Requests for RDF resource URIs redirect to HTML
or RDF representations as specified by the client. To make this possible,
VIVO's default namespace must have certain structure and begin with the public
web address of the VIVO installation. For example, if the web address of a VIVO
installation is "http://vivo.example.edu/" the default namespace must be set to
"http://vivo.example.edu/individual/" in order to support linked data. Similarly,
if VIVO is installed at "http://www.example.edu/vivo" the default namespace must be
set to "http://www.example.edu/vivo/individual/"
<h4>* The namespace must end with "individual/" (including the trailing slash).</h4>
Default namespace: VIVO installations make their
RDF resources available for harvest using linked data. Requests for RDF
resource URIs redirect to HTML or RDF representations as specified by
the client. To make this possible, VIVO's default namespace must have
certain structure and begin with the public web address of the VIVO
installation. For example, if the web address of a VIVO installation is
"http://vivo.example.edu/" the default namespace must be set to
"http://vivo.example.edu/individual/" in order to support linked data.
Similarly, if VIVO is installed at "http://www.example.edu/vivo" the
default namespace must be set to
"http://www.example.edu/vivo/individual/"<h4>* The namespace must end with "individual/" (including the
trailing slash).</h4>
</td>
</tr>
<tr class="odd_row">
@ -173,8 +267,9 @@
</tr>
<tr>
<td colspan="2">
Directory where Vitro code is located. In most deployments, this is set to
./vitro-core, but it commonly points elsewhere during development.
Directory where Vitro code is located. In most
deployments, this is set to ./vitro-core (It is not uncommon for this
setting to point elsewhere in development environments).
</td>
</tr>
<tr class="odd_row">
@ -213,7 +308,9 @@
</tr>
<tr>
<td colspan="2">
Directory where uploaded files will be stored. You must create this directory ahead of time.
Directory where uploaded files will be stored.
Be sure this directory exists and is writable by the user that
the Tomcat service is running as.
</td>
</tr>
<tr class="odd_row">
@ -223,11 +320,12 @@
<td>
/usr/local/vivo/data/uploads
</td>
</tr>
<tr>
<td colspan="2">
Directory where the Lucene search index will be built. Depending on your
permissions and who Tomcat is running as, you may need to create this directory
ahead of time.
Directory where the Lucene search index will be
built. Be sure this directory exists and is writable by the user that
the Tomcat service is running as.
</td>
</tr>
<tr class="odd_row">
@ -240,8 +338,9 @@
</tr>
<tr>
<td colspan="2">
Specify an SMTP host that the form will use for sending e-mail (Optional). If
this is left blank, the contact form will be hidden and disabled.
Specify an SMTP host that the form will use for
sending e-mail (Optional). If this is left blank, the contact form will
be hidden and disabled.
</td>
</tr>
<tr class="odd_row">
@ -254,8 +353,8 @@
</tr>
<tr>
<td colspan="2">
Specify the JDBC URL of your database. Change the end of theURL to reflect
your database name (if it is not "vivo").
Specify the JDBC URL of your database. Change
the end of theURL to reflect your database name (if it is not "vivo").
</td>
</tr>
<tr class="odd_row">
@ -268,7 +367,8 @@
</tr>
<tr>
<td colspan="2">
Change the username to match the authorized user you created in MySQL.
Change the username to match the authorized user
you created in MySQL.
</td>
</tr>
<tr class="odd_row">
@ -281,7 +381,8 @@
</tr>
<tr>
<td colspan="2">
Change the password to match the password you created in MySQL.
Change the password to match the password you
created in MySQL.
</td>
</tr>
<tr class="odd_row">
@ -294,9 +395,9 @@
</tr>
<tr>
<td colspan="2">
Specify the Jena triple store technology to use. SDB is Jena's
SPARQL database; this setting allows RDF data to scale beyond the
limits of the JVM heap. Set to RDB to use the older Jena RDB
Specify the Jena triple store technology to use.
SDB is Jena's SPARQL database; this setting allows RDF data to scale
beyond the limits of the JVM heap. Set to RDB to use the older Jena RDB
store with in-memory caching.
</td>
</tr>
@ -310,9 +411,9 @@
</tr>
<tr>
<td colspan="2">
Specify the maximum number of active connections in the database
connection pool to support the anticipated number of concurrent
page requests. It is not necessary to adjust this value when
Specify the maximum number of active connections
in the database connection pool to support the anticipated number of
concurrent page requests. It is not necessary to adjust this value when
using the RDB configuration.
</td>
</tr>
@ -326,9 +427,9 @@
</tr>
<tr>
<td colspan="2">
Specify the maximum number of database connections that will be
allowed to remain idle in the connection pool. Default is
25% of the maximum number of active connections.
Specify the maximum number of database
connections that will be allowed to remain idle in the connection pool.
Default is 25% of the maximum number of active connections.
</td>
</tr>
<tr class="odd_row blue">
@ -341,11 +442,10 @@
</tr>
<tr>
<td colspan="2">
Change the dbtype setting to use a database other than MySQL.
Otherwise, leave this value unchanged.
Possible values are DB2, derby, HSQLDB, H2, MySQL, Oracle,
PostgreSQL, and SQLServer.
Refer to http://openjena.org/wiki/SDB/Databases_Supported
Change the dbtype setting to use a database
other than MySQL. Otherwise, leave this value unchanged. Possible
values are DB2, derby, HSQLDB, H2, MySQL, Oracle, PostgreSQL, and
SQLServer. Refer to http://openjena.org/wiki/SDB/Databases_Supported
for additional information.
</td>
</tr>
@ -359,9 +459,9 @@
</tr>
<tr>
<td colspan="2">
Specify a driver class name to use a database other than MySQL.
Otherwise, leave this value unchanged.
This JAR file for this driver must be added to the the <code>webapp/lib</code>
Specify a driver class name to use a database
other than MySQL. Otherwise, leave this value unchanged. This JAR file
for this driver must be added to the the <code>webapp/lib</code>
directory within the vitro.core.dir specified above.
</td>
</tr>
@ -375,9 +475,9 @@
</tr>
<tr>
<td colspan="2">
Change the validation query used to test database connections
only if necessary to use a database other than MySQL.
Otherwise, leave this value unchanged.
Change the validation query used to test
database connections only if necessary to use a database other than
MySQL. Otherwise, leave this value unchanged.
</td>
</tr>
<tr class="odd_row blue">
@ -390,9 +490,10 @@
</tr>
<tr>
<td colspan="2">
Specify the name of your first admin user for the VIVO application.
This user will have an initial temporary password of 'defaultAdmin'.
You will be prompted to create a new password on first login.
Specify the name of your first admin user for
the VIVO application. This user will have an initial temporary password
of 'defaultAdmin'. You will be prompted to create a new password on
first login.
</td>
</tr>
<tr class="odd_row">
@ -405,9 +506,15 @@
</tr>
<tr>
<td colspan="2">
The name of a property that can be used to associate an Individual
with a user account. When a user logs in with a name that matches
the value of this property, the user will be authorized to editthat Individual.
The URI of a property that can be used to
associate an Individual with a user account. When a user logs in with a
name that matches the value of this property, the user will be
authorized to edit that Individual.&nbsp; For example, to use the netID
at Cornell University as the property:
<br>
<span style="font-style: italic;">seflEditing.idMatchingProperty
=
http://vivo.cornell.edu/ns/hr/0.9/hr.owl#netId</span>
</td>
</tr>
<tr class="odd_row blue">
@ -420,16 +527,20 @@
</tr>
<tr>
<td colspan="2">
Temporal Graph Visualization is used to compare different
organizations/people within an organization on different parameters like
number of publications, grants. This parameter will be used as a default
in case a URI is not provided. It will be also used whenever this
visualization is to be rendered for top level organization.
In absence of this parameter a SPARQL query will be fired which will
attempt to provide a top level organization. The name of a property that
can be used to associate an Individual with a user account. When a user
logs in with a name that matches the value of this property, the user
will be authorized to edit that Individual.
The temporal graph visualization is used to
compare different
organizations/people within an organization on parameters like number
of publications or grants. By default, the app will attempt to make its
best guess at the top level organization in your instance. If you're
unhappy with this selection, uncomment out the property below and set
it to the URI of the organization individual you want to identify as
the top level organization. It will be used as the default whenever the
temporal graph visualization is rendered without being passed an
explicit org. For example, to use "Ponce School of Medicine" as the top
organization:
<br>
<span style="font-style: italic;">visualization.topLevelOrg =
http://vivo.psm.edu/individual/n2862</span>
</td>
</tr>
<tr class="odd_row blue">
@ -440,41 +551,50 @@
http://vivo-trunk.indiana.edu/individual/topLevelOrgURI
</td>
</tr>
</tbody>
</table>
</p>
<p>
3. Apply any previous changes you have made to the new source directory.
3. Apply any previous changes you have made to the new source
directory.
</p>
<blockquote>
<strong>Special notes regarding source files</strong>
<ul>
<li>
This process assumes any changes made to the application were made in
the source directory and deployed, and were not made directly within
the Tomcat webapps directory.
This process assumes any changes made to the application were
made in the source directory and deployed, and were not made directly
within the Tomcat webapps directory.
</li>
<li>
In many cases, simply copying the modified files from your original
source directory will not work since the files on which they are based
have changed. It will be necessary to inspect the new source files and
add any changes to them at that time.
In many cases, simply copying the modified files from your
original source directory will not work since the files on which they
are based have changed. It will be necessary to inspect the new source
files and add any changes to them at that time.
</li>
<li>
NIH-funded VIVO Implmentations will need to apply the Google Analytics Tracking
Code (GATC) to <code>googleAnalytics.ftl</code>
in the theme:<pre>[new_source_directory]/themes/[theme_dir]/templates/googleAnalytics.ftl</pre>
NIH-funded VIVO Implmentations will need to apply the Google
Analytics Tracking Code (GATC) to <code>googleAnalytics.ftl</code>
in
the theme:<pre>[new_source_directory]/themes/[theme_dir]/templates/googleAnalytics.ftl</pre>
A sample <code>googleAnalytics.ftl</code>
is included in the built-in theme. This file
serves only as an example, and you must replace the tracking code shown
with your institution's own tracking code.
For additional information about the GATC for the NIH-funded VIVO
implementation sites and a copy your institution's tracking code, see the <a href="https://confluence.cornell.edu/display/ennsrd/Google+Analytics+for+UI">VIVO Google Analytics wiki page</a>.
is included in the built-in
theme. This file serves only as an example, and you must replace the
tracking code shown with your institution's own tracking code. For
additional information about the GATC for the NIH-funded VIVO
implementation sites and a copy your institution's tracking code, see
the <a href="https://confluence.cornell.edu/display/ennsrd/Google+Analytics+for+UI">VIVO
Google
Analytics
wiki
page</a>.
</li>
<li>
If you had used the <code>vivo/contrib/FLShibboleth</code>
code in your previous release,
you should stop using it. Consult <code>install.html</code>
or <a href="VIVO_Release-1-v1.2_Installation_Guide.pdf">VIVO Release 1 v1.2 Installation Guide</a>
on "Using an External Authentication System with VIVO".
code in your previous release, you should stop using it. Consult <code>install.html</code>
or <a href="VIVO_Release-1-v1.2_Installation_Guide.pdf">VIVO Release 1
v1.2 Installation Guide</a>
on "Using an External Authentication System
with VIVO".
</li>
</ul>
</blockquote>