Versions Compared

Old Version 2

changes.mady.by.user Armando Stellato

Saved on

compared with

New Version Current

changes.mady.by.user Armando Stellato

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Introduction

Please refer to the Full Installation Guide, sections “Requirements” and “Installation Steps”, up to step 3: “Import the Administrator Database SQL Dump File”. For step 4, just drop the VB war in Tomcat, and then follow this guide for configuring the Config.properties file, then restart tomcat.

  1. Install Tomcat
  2. Install MySQL
  3. Install OWLIM
  4. Install ST and SemanticTurkeyData folder
  5. Install VB

Introduction

These instructions propose a quick installation method for having an AGROVOC installation of the VocBench Thesauri Management Web Application. Note that, by replacing “Agrovoc” with your specific dataset, and “Agrontology” with your own domain vocabulary, they should still be valid.

VB offers a User Interface for many of the options that you will see represented through config files here but, as the package that comes with this guide is already pre-configured, you will find it easier to go through these specific configuration steps instead of using the UI.

For the same reason above, you just have to follow this guide up straightly, and all parameters have been already set for the AGROVOC installation. Whenever a parameter needs a value which is specific to your installation, we have put a placeholder for it. The list of placeholders is reported in the Legenda here below.

Legenda

{youradminemail.xxx} : these are placeholders for the configuration of a real email address which will be used to deliver email messages to the vocbench administrator

  • {youradminemail.address} : address of your {youradminemail} account
  • {youradminemail.user} : username of your {youradminemail} account
  • {youradminemail.pwd}: password of your {youradminemail} account
  • {youradminemail.host} : smtp server of URL of the service for sending emails through your {youradminemail} account
  • {youradminemail.port} : port for the outgoing mail service of your {youradminemail} account

{yourAdministratorDB.name}: this is a placeholder for admin DB of VB.
{yourDB.user} : this is a placeholder for the account you are using for storing the admin DB of VB
{yourDB.pwd}: a placeholder for the password of your {yourDB.user} account

{admin.emails}: a comma separated list of email addresses of administrators, which will be notified of any email, together with the main administrator

{owlim.license.path}: put here your full path to where you stored the OWLIM license file in your path, such as /path/fao1core.license, or C:/temp/fao1core.license

Configuration

  1. Import Administrator database.
  2. Copy your war file of VB inside tomcat.
  3. VB allows updating your configuration file at the time of first load after installation.
  • CFG.VERSION= 2.0
  • CFG.DISPLAYVERSION= 2.0
  • CFG.MODE= DEV
  • CFG.DB.CONNECTIONURL = jdbc:mysql://localhost:3306/{yourAdministratorDB.name}?requireSSL=false&useUnicode=true&characterEncoding=UTF-8
  • CFG.DB.USERNAME= {yourDB.user}
  • CFG.DB.PASSWORD= {yourDB.pwd}
  • CFG.MAIL.HOST={youradminemail.host}
  • CFG.MAIL.PORT={youradminemail.port}
  • CFG.MAIL.USER={youradminemail.user}
  • CFG.MAIL.PASSWORD={youradminemail.pwd}
  • CFG.MAIL.FROM={youradminemail.address}  
  • CFG.MAIL.FROM_ALIAS=VocBench Admin
  • CFG.MAIL.ADMIN={admin.emails}
  • CFG.MODELCLASS: Set org.fao.aoscs.model.semanticturkey.STManager to use Semantic Turkey
  • CFG.MANDATORY.DEFINITION.NAMESPACES = Add namespaces which requires mandatory definition's source and link (For multiple namespaces use semicolon ";" as a separator)
  • CFG.CODETYPE = set CODETYPE to “http://aims.fao.org/aos/agrovoc/AgrovocCode” if you want to set Agrovoc Code. Set it to empty if you are not installing VocBench for managing Agrovoc
  • CFG.CUSTOMDATATYPE= Add custom data types can be added via this parameter. To add multiple data types use semicolon ";" as a separator. For Agrovoc, add http://aims.fao.org/aos/agrovoc/AgrovocCode
  1. Optionally you can pre configure your war file with updated VB Configuration file. To preconfigure, after dropping the war file of VB inside tomcat, have it unzipped by tomcat, then and replace your specific installation information (see entries here below) on the Config.properties file located in vocbench2/WEB-INF/classes. Then, restart tomcat to have it re-loaded.
  2. From the Sesame Workbench for configuring OWLIM, create a new repository (and do not add any data!)
    1. Create new repository.
  • Type: OWLIM-SE
  • ID: AGROVOC_SKOS_VB_2013-07-12
  • Title: AGROVOC_SKOS_VB dated 2013-07-12
  • License file (leave blank for evaluation and use '/'): {owlim.license.path}
  • Repository type: file-repository
  • Ruleset: Empty
  • Base URL: http://aims.fao.org/aos/agrovoc/
  • Total cache memory (min 20m): 120m
  • Main index memory (min 20m): 80m
  • Use predicate indices: true
  • Predicate index memory (min 20m): 20m  
  • Full-text search memory (min 20m): 20m
  • Full-text search indexing policy: On commit
  1. Set custom OWLIM rule set to the path to the file builtin_owl2-rl-fixed.pie in this distribution (see instructions in “Appendix B: OWLIM specific notes” of the full instruction manual).
  2. Add RDF data

...

This is a simple test drive for you to try VocBench by using the embedded sesame component for creating a very simple project. We will use a small thesaurus developed in FAO as a test data sample.

The sample thesaurus, the "Land and Water" FAO vocabulary, is available for download (see later section on loading pre-existing data)

So follow strictly the "e.g." suggestions if you want to get this working with the provided example.

Create a new project    

  • Login with the administrator privilege (Only administrator are allowed to delete the project)
  • Once logged in, the list of currently available project will be displayed.
  • On the top right corner, click [+] button to add the project.
  • A window will be prompted to input the following parameters:
    • Project name (e.g. LandAndWater)
    • Project description (A project describing concepts about Land and Water Management)
    • Project type (Type of the project (OWL, SKOS, SKOS-XL). Only SKOS-XL is available at the moment)
    • Base URI: (e.g. http://www.fao.org/landandwater/  it is important to keep the ending "/" )
    • Semantic Turkey Server URL (Connection URL to Semantic Turkey Server (ST Server) )
  • Click [Connect] button to test the connection to ST Server.
    • If failed, will prompt service failed message. Check if ST Server is running and connection URL is correct.
    • In case of successful connection, it will prompt a list of available triple Stores: OntologyManagerFactorySesame2Impl
  • After triple store selection, it will prompt for available triple storage mode as follows
    • In memory/persistent
    • In memory/no persist
    • Native store/persistent
    • Remote access

    now, to create a plain Sesame2 project (as a starting point, we will use sesame internal triple stores)
    1. select “in memory/persistent” or "native store/persistent"
    2. You can leave the other parameter values (1000, true, true) as they are

Manage the SKOS Concept Scheme

  • After login, you will be directed to concept module.
  • If no concept scheme is selected by default, you will be prompted to go to Scheme module to select concept scheme.
  • Click on the [Schemes] link on the main menu bar, to go to Schemes module.
  • List of available concept schemes will be displayed.
  • If none of them is available, click [+] button on top right corner of list box to add new scheme.
  • The "Add scheme" dialog will prompt you to add the following parameters:
    • Scheme URI (e.g. http://www.fao.org/landandwater - no ending slash "/" here )
    • Scheme label (e.g. "core scheme for the land and water thesaurus")
    • Scheme language (e.g. "en")
  • After clicking [Add] button, the newly added scheme will be displayed in the list.
  • To select the scheme, click on the check box.

    Now that a scheme has been created, you can start editing concepts. Anyway, let's start from a pre-built thesaurus, by loading its data (next section)

Loading pre-existing data

Start playing around

Project is ready, some sample data has been loaded...time to play around now! things like editing new concepts, lexicalizations etc..

We will be adding more docs soon. In the meanwhile, you can follow those videos reported here: http://aims.fao.org/

...

tools/

...

Running the System

  1. Run Semantic Turkey by launching the batch file appropriate for your system (server_run.bat for Windows or server_run.sh for UNIX systems) which is located in the ST-Server directory.
  2. Login to VB as administrator user (user/pass:administrator/111111)
  3. You will see the “ontology panel” on the right empty. Create a new project by clicking on the + button.

...

vocbench-2/support-material

Ok, test drive done...time now for seriously managing a big thesaurus!

As a first thing, we recommend to work with a separate data server1, with the proper triple store and its setup balanced for your needs.

You can use a sesame2 remote connection to a sesame2 server (see related section of the sesame2 manual for how to setup a server). Remember to enable RDFS Reasoning and a Hierarchical Reasoner if you want to exploit the reasoning capabilities of VB (though this will affect performances).

Also, we recommend use of other triple stores if you have the necessity to manage large quantities of data and/or if you want to exploit OWL reasoning capabilities. Currently in fact, VB is best adopted with a triple store supporting at least hierarchical inferencing and RDFS/OWL reasoning, however, Sesame has usually poor performances on even average size repositories when its reasoning sails are being activated.

For using the remote connection, just follow these instructions:

  • create an empty repository on your sesame server, and remember the Repository ID you chose
  • Now, on VocBench, create a new project, then...
  • Select the remote access option
  • VB will prompt to input the following parameters:
    • repositoryId
      • ID of the sesame2 repository to be accessed 
      • This should match the ID value used in repository (Repository ID value while creating new repository in OWLIM)
    • serverURL
    • Username
    : test
  • Password: test
  1. Beware: after you click ok, you will return to the previous form, but the ontology may have not been refreshed in the “Ontology” list. Wait a few seconds, or if nothing appears, in case, close it, log out and try to log in again
  2. Manage SKOS Concept Scheme
    1. Select the Schemes tab.
    2. Add Scheme (right upper corner): (If using AGROVOC, a scheme should be already present, so you can skip this step:)
  1. Import the following ontology: agrontology.owl (AdministrationàOntology, then “Import” bottom panel à select from the combobox “Add Import From Ontology Mirror”)
  • Add import from ontology mirror
  • Namespace: http://aims.fao.org/aos/agrontology
    Note that In general, when using VocBench with your own dataset, you need the ontology vocabulary which is being used to model your data, as in each tab of the concept details panel, VocBench looks for subproperties of given standard properties, and so it needs to know where the properties being used are hooked up.
  1. Manage namespace (AdministrationàOntology) if needed (it should be automatically assigned when importing agrontology).
  1. Enable indexing

Creating a new blank project by using Sesame2

 

...

      • Identifier for the user connecting to the rdf repository
      • If not applicable, add “test” as this is mandatory field
    • Password
      • Password for the user connecting to the rdf repository
      • If not applicable, add “test” as this is mandatory field
    • Click on the [?] icon to view each field information.
    • It is assumed that the Data Server is already running and the specified repository has been created.
    • Click [Add] button to create the project.
    • The newly created project will be added to the list.

 

In this page on the Semantic Turkey wiki there are some information for using VB/ST with other triple stores.

Appendix: Creating a new User

We suppose here that you are both the user and administrator of vocbench

To add a new user in VocBench follow these steps:

  • Go to http://localhost:8080/vocbench-2.0/index.html and click on "Create an account" under the login form on the right of the page
  • Input all the required information. It is better, even if it is not mandatory, to specify the "Languages you wish to manage" and the "Ontology you wish to manage"
  • At this point the account is not yet allowed to log on.
    • As a user, you can wait for the confirmation email that a request has been sent to the administrator
    • As administrator, you can wait for the email and follow its instructions

If you do not receive any email (maybe a misplaced configuration) you need to manually enable the account by modifying the admin DB (see FAQ 1)


[1] in VB2.1, which is still based on Semantic Turkey 0.9.1, there is still a nasty bug about projects being deleted (or corrupted) when access to their data fails (actually a portion of code collapsing both the case of a wrongly set remote-connection project, which is rolled back by removing its folder, and the case of a project failing to access its data for any reason, which should obviously not end up in deleting it!). Accessing a separate data server with a remote connection also prevents from any accidental data loss of this kind.