From 14ab5d559df91b40c21a5f7296cb4655fa2253ae Mon Sep 17 00:00:00 2001 From: j2blake Date: Fri, 29 Jun 2012 22:09:55 +0000 Subject: [PATCH] NIHVIVO-3845 update the Upgrade document for 1.5 --- doc/install.html | 2 +- doc/upgrade-1.4.html | 5 +- doc/upgrade-1.5.html | 191 ++++++++++++++++++++++++++++++++++++++++--- 3 files changed, 180 insertions(+), 18 deletions(-) diff --git a/doc/install.html b/doc/install.html index e13a7552..cb0893b2 100644 --- a/doc/install.html +++ b/doc/install.html @@ -149,7 +149,7 @@ Apache Tomcat 6.x or 7.x http://tomcat.apache.org
  • - Apache Ant 1.7 or higher, http://ant.apache.org + Apache Ant 1.8 or higher, http://ant.apache.org
  • MySQL 5.1 or higher, http://www.mysql.com diff --git a/doc/upgrade-1.4.html b/doc/upgrade-1.4.html index 43adef64..9e370ddc 100644 --- a/doc/upgrade-1.4.html +++ b/doc/upgrade-1.4.html @@ -684,10 +684,7 @@ you will need to rerun the knowledge base migration. -

    - -

    -

    +

    IV. Knowledge Base Migration

    i.Knowledge Base Migration Process

    diff --git a/doc/upgrade-1.5.html b/doc/upgrade-1.5.html index 8b429d11..b83478fb 100644 --- a/doc/upgrade-1.5.html +++ b/doc/upgrade-1.5.html @@ -37,7 +37,15 @@

    1. Before Performing the Upgrade
      2. -
    2. Noteworthy Changes
      +
    3. + Noteworthy Changes +
        +
      1. Ant version 1.8 is required
        2. +
      2. Custom short views
        3. +
      3. Support for OpenSocial gadgets
        4. +
      4. Supported Browsers
        5. +
      +
    4. Upgrade Instructions
    5. Knowledge Base Migration
    6. Review the VIVO Terms of Use
      7. @@ -86,32 +94,41 @@ -

      BOGUS -- INSERT REAL STUFF HERE, EVENTUALLY

      II. Noteworthy Changes

      • -

        Ant version 1.8 required

        +

        Ant version 1.8 is required

        - See J.Blake for details. + The VIVO build script has been revised, and now requires features from + version 1.8 of Apache Ant. Version 1.8 has been available since February, 2010. + The current version of Apache Ant is 1.8.4. +

        +

        + You can find recent versions of Apache Ant at + http://ant.apache.org

      • -

        Custom search views

        +

        Custom short views

        "Custom search views" have been re-implemented as part of the more flexible "Custom short views" mechanism. - If you have custom search views, you will need to re-configure them. - See J.Blake for details. + If you have implemented custom search views, you will need to re-configure them to fit the new framework. + For an explanation of how to use custom search views, consult the + + SourceForge Wiki page on custom search views +

      • Support for OpenSocial gadgets

        - You can now add OpenSocial support to your VIVO instance. Look at setting_up_orng.html for details. - See J.Blake for details. + VIVO can now be configured to support Open Research Networking Gadgets, + an extension of OpenSocial gadgets. For a description of this, and instructions + for configuring VIVO, look at setting_up_orng.html, in this directory.

      • -

        Supported Browsers

        +

        Supported Browsers

        For this release, the following browsers are supported.

        @@ -137,12 +154,159 @@
      -

      BOGUS -- INSERT REAL STUFF HERE, EVENTUALLY

      III. Upgrade Instructions

      -

      BOGUS -- INSERT REAL STUFF HERE, EVENTUALLY

      -

      IV .Knowledge Base Migration

      + 1. Download the new distribution file and unpack it into a new + source directory. +

      +

      + 2. Create a new deploy.properties using the same settings as in + your previous installation and set values for the new variables as described + below: +
      +

      +

      + +

      + + + + + + + + + + + + + + + + + + + + + + + +
      + Property Name + + Example Value +
      + Show only the most appropriate data values based on the Accept-Language + header supplied by the browser. Default is true if not set. +
      + RDFService.languageFilter + + true +
      + These values are used when deploying VIVO as an OpenSocial container + and integrating with OpenSocial gadgets. + For instructions, look at setting_up_orng.html, in this directory. + If you are creating + a VIVO installation that does not use OpenSocial gadgets, these values are omitted. +
      + OpenSocial.shindigURL
      + OpenSocial.tokenService
      + OpenSocial.tokenKeyFile
      + OpenSocial.sandbox +       		+   +
      + + +

      + 3. Apply any previous changes you have made to the new source + directory. +

      +
      + Special notes regarding source files +
        +
      • + 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. +
        • +
      • + 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. +
        • +
      • + NIH-funded VIVO implementations will need to apply the + Google + Analytics Tracking Code (GATC) to googleAnalytics.ftl + in + the theme:
        [new_source_directory]/themes/[theme_dir]/templates/googleAnalytics.ftl
        + A sample googleAnalytics.ftl + 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 of your institution's tracking code, + see the VIVO + Google + Analytics + wiki + page. +
        • +
      +
      +

      + 5. Stop Apache Tomcat and from your VIVO source directory, run + ant + by typing: ant all +

      +

      + 6. Start Apache Tomcat and log into VIVO as the root user when the upgrade is + completed. Depending on the size of your database, the migration process may + take up to several hours. When it is complete, you will + see a message in the catalina.log file that the server has started.

      INFO: Server startup in XXXXX ms
      +

      +

      + 7. As root or an administrator, request a rebuild of the Solr search index: + Go to the "Site Admin" page and click on "Rebuild Search Index" under the + heading "Refresh Content". +

      +

      + 8. Review and save aside the knowledge base migration logs. + The knowledge base migration process described in the next section will generate logs. + These logs will be overwritten if you redeploy the VIVO application (but not if you restart tomcat), and since + they may be a useful reference if questions come up about your 1.5 VIVO data after deployment, + you should save them aside. + The logs are created in the Tomcat webapps/vivo/WEB-INF directory: +

      +
      +
      + ontologies/update/logs/knowledgeBaseUpdate.(timestamp).log +
      +
      + A log of a summary of updates that were made to the knowledge + base. This file should end with "Finished knowledge base migration". + If this file contains any warnings they should be reviewed with your + implementation team representative to see whether any corrective action needs to be taken. +
      +
      +
      +
      + ontologies/update/logs/knowledgeBaseUpdate.(timestamp).error.log +
      +
      + A log of errors that were encountered during the upgrade + process. This file should be empty if the upgrade was successful. If any errors are encountered + you will need to rerun the knowledge base migration. +
      +
      + +

      IV. Knowledge Base Migration

      + +

      Changes to the VIVO core ontology may require corresponding modifications to the knowledge base instance data and ontology annotations. When VIVO first starts up following the upgrade, it will @@ -191,6 +355,7 @@ An N3 file containing all the statements that were added to the knowledge base. +

      V. Review the VIVO Terms of Use

      VIVO comes with a "Terms of Use" statement linked from the footer. The "Site Name"