Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

The vivo.xml (called vivo.model.xml in harvester 1.2 and above) file outlines your vivo configuration. There are several values needing to be set in this file in order for the harvester to harvest into your vivo instance. Most of the is the same parameters that must be passed to the JDBC connector which is utilized to create the connection. The file itself is located in config/models/vivo.xml relative to your harvester base directory.

Parameters

Type

You have the choice of four options, and should set according to your VIVO database layout:
TDB, SDB, FILE, and RDB. Since version 1.2 VIVO is using SDB by default.

TDB is a non-transactional, faster database solution for use by a single system. It scales well beyond SDB and is simpler to setup. The harvester uses TDB for local temp models.

SDB is a system that uses relational databases for storage of RDF and OWL. It supports many open source and commercial databases including MySQL, PostgreSQL, Oracle 11g, Microsoft SQL server and IBM DB2. It scales to graphs of 100 million triples.

FILE is an xml file that contains data about triples in RDF format.

RDB is a legacy database which supports persistent storage of RDF data in relational databases. It is deprecated.

For more information feel free to check out Jena's website on sources. SDB Store

dbLayout

This parameter is only required for SDB databases. Is should not be entered for RDB. This specifies the layout type of the SDB database. VIVO uses layout2 by default. These layouts are from the JENA library.

dbDir

This parameter is only required for TDB databases.It indicates the directory location to store the TDB model.

file

This parameter is only required for FILE databases. It indicates the directory location of the rdf data.

dbClass

This is where the db driver is specified, should be a jdbc driver like: com.mysql.jdbc.Driver

dbType

Specify database type, for example MySQL, H2

dbUrl

The JDBC connection string including port and database name

dbUser

The username to use for the JDBC connection

dbPass

The password to use for the JDBC connection

Namespace

This needs to be the same as defined in your deploy.properties file for your vivo. Should be similar to something like this: http://institution.vivo.edu/individual/

modelName

This should be the main vivo model. Since versoin 0.9, vivo is using the http://vitro.mannlib.cornell.edu/default/vitro-kb-2 as the default model name

Example file

No Format
<?xml version="1.0" encoding="UTF-8"?>
<Model>
  <Param name="type">rdb</Param>
  <Param name="dbClass">com.mysql.jdbc.Driver</Param>
  <Param name="dbType">MySQL</Param>
  <Param name="dbUrl">jdbc:mysql://123.1.1.1:1234/data</Param>
  <Param name="modelName">http://server.name.edu/default/vitro-kb-2</Param>
  <Param name="dbUser">USERNAME</Param>
  <Param name="dbPass">PASSWORD</Param>
  <Param name="namespace">http://server.name.edu/individual/</Param>
  <!-- The default name space for UF "http://vivo.ufl.edu/individual/", Make sure it matches the deploy.properties -->
</Model>

Note: The example does not need a dbLayout parameter due to the fact that it is rdb and not sdb.