OWLIM-Workbench

{toc}

h1. Overview

The OWLIM Workbench is a stand-alone OWLIM server with a built-in web-based administration tool. The user interface is similar to the Sesame Workbench webapp, but with more functionality, most importantly in the area of security and user access roles. Unlike Sesame, where separate server and workbench webapps are deployed, the OWLIM Workbench is a fully functional OWLIM server with a SPARQL endpoint.

The OWLIM workbench can be used to create OWLIM repositories, load and export data, execute SPARQL queries and updates, manage user accounts and control user access roles. The user interface is built using the Forest framework which provides syntax highlighting for SPARQL and other benefits.

The OWLIM Workbench is distributed in several forms, firstly as an executable 'jar' file so that it can be run without any dependency on Tomcat or any other servlet container/application server. It is also packaged as a 'war' file so that it can be deployed alongside other webapps in a servlet container.


h1. Requirements

Java: JRE 1.6 or higher (JDK 1.6 or higher if using custom rule sets)
Tomcat: Version 7 or higher if deployed as a 'war' file

h1. Contents of the distribution

The OWLIM-Workbench is packaged as a separate zip file from the 'standard' OWLIM-SE plus Sesame zip file. The existing means of deploying OWLIM-SE as described in the [installation section for that distribution|OWLIM-SE Installation] remains unchanged.

In the OWLIM-Workbench zip file are:
* README.txt - helpful hints on how to run the OWLIM-Workbench
* startup.sh (.bat) - start up script
* shutdown.sh (.bat) - shutdown script
* owlim-workbench.jar - standalone 'runnable' jar file containing the workbench

h1. Installation, start-up and shutdown

To run the OWLIM Workbench as a standalone server, unzip the distribution zip file and execute the startup.sh/.bat script. This method of deployment uses the internal [Jetty|http://jetty.codehaus.org/jetty/] server. The OWLIM-Workbench is accessed and administered using a Web browser. If located on the same machine, use a URL such as the following (assuming the default port number):

{noformat}
http://localhost:8080
{noformat}

When deployed as a 'war' file, the procedure is the same as deploying any other Web application, i.e. the {{owlim-workbench-x.y.z.war}} file must be copied to the servlet container's {{webapps}} directory. In order to access the OWLIM-Workbench use a browser with a URL similar to the following:

{noformat}
http://localhost:8080/owlim-workbench-webapp-x.y
{noformat}

To gracefully shutdown the OWLIM-Workbench run the shutdown.bat/.sh script if started as a standalone application. If started in a servlet container use the appropriate tools, e.g. with Tomcat then the Tomcat server can be stopped or an individual Web application unloaded using the HTML manager tool.

h1. Login and status

After starting, the first page presented will be the login page. The default administrator account information is:

{info}
username: *admin*
password: *root*
{info}

and you are recommended to change the root password as soon as possible, see below. After logging in, the summary page is displayed that shows: version number, license details, currently selected repository (if any) and user name. If no repository is currently selected then the message 'Please select a repository' is displayed. Click this to get to the repository management page.

h1. Managing repositories

The repository management page is accessed using the menu bar ADMIN->Repositories. This will display a list of available repositories and their locations as well as the permissions that the logged on user has for each repository.

An OWLIM-Workbench instance always has at least two repositories: the {{SYSTEM}} repository that holds the Sesame repository configurations and the {{security}} repository that holds user accounts and access rights. A repository can be selected, i.e. made 'current'. by clicking the 'connect' button next to a repository. Subsequent import, export and query evaluation functions will operate against this repository.


!add-repo.png|align=center,width=781,height=125!


To create a new repository, click 'add repository'. This will display the configuration page for the new repository where a new, unique ID must be entered. The rest of the parameters are described in the [OWLIM-SE configuration section|OWLIM-SE Configuration] of the user guide.

It is also possible to use the current interface for creating and accessing a repository on another OWLIM-Workbench instance (on another machine) or at a different location on the same machine. To do this, a new location must be entered for identifying the other OWLIM-Workbench instance (or directory on the current machine):

# From admin-repositories click on "Add Location"
# Enter the URL, user and password for a Sesame location
# After you change the current location you can create and browse repositories in the same way as when using a local location


!add-location.png|align=center,width=780,,height=367!


h1. Loading data into a repository

After creating and connecting to a repository the following steps can be used to load data. Note that loading data is a two stage process: the data files are first loaded to the server and from there loaded in to OWLIM:

# Pick a repository to work with from "Repositories in selected location" list and click "Connect"
# Some text on the top of the screen will say "Current repository is REPOSITORY_NAME, located in LOCATION_PATH"
# To load data use the menu bar DATA->Import and choose a file (.rdf, .n3, .nt, .trig, and .trix) - as each file is selected it is added to the list in this page
# After the files have been selected, click "Start Upload" for individual files or "Upload All" to load all of them
# When the upload is finished a "Load Data" button will appear for each successfully uploaded file. Press this to load files individually or use the "Load All" button for multiple files. After loading a message is displayed with a link to the query page.


!Import-upload.png|align=center,border=1,width=779,,height=201!



!Import-load-data.png|align=center,border=1,width=780,,height=197!



h1. Executing queries

Access the SPARQL pages using the menu bar SPARQL->Query. Above the query editing text area query templates can be accessed and selected. Clicking on one will populate the text-area with a SPARQL query that can be edited in place. The query can be freely edited (with syntax highlighting) and namespaces can be added very easily by accessing the list of known namespaces next to the query templates.

A check-box is provided that allows the execution of the query over all RDF statements or just explicit statements. Another check-box controls whether equivalent URIs are expanded. This relates to the use of {{owl:sameAs}} and causes the automatic addition of the pseudo-graph {{FROM <}}{{[http://www.ontotext.com/disable-sameAs]}}{{>}} to the query. This is described in the [special query behaviour section of the OWLIM user guide|OWLIMv53:OWLIM-SE Query Behaviour].

The query is executed by clicking the 'Submit' button, where the results are presented in the results page.

h1. Results page

The results page will show the response for your query:


!results_page.png|align=center,border=1,width=779,height=565!


From the results page it is possible to download results as JSON or XML. It is also possible to provide an alternative view of query results by 'viewing as exhibit'. This allows the results to be sorted on each column and provides a summary of values found in each column.

h1. Executing updates

SPARQL updates can be executed from the update page by accessing the menu bar SPARQL->Update. This behaves in a similar way to the query page, except that different templates are available for inserting and deleting statements, as well as loading and dropping named graphs. After executing an update the page is updated with a message about the success of the update, but no results page is shown.

Also similar to the query page, namespaces can easily be added to the query by accessing the list of known namespaces from the list about the text-area.

Example: deleting all triples from the default graph. Copy the following statement and run it from the update page:

{noformat}
DELETE { ?s ?p ?o }
WHERE { ?s ?p ?o }
{noformat}

You can see the result of this update below the text-area.

h1. Export data

Data can be exported in several ways and formats.

h3. Export repository or graphs

From the menu bar select DATA->Export and the data export page will provide options for exporting the whole repository (in several different formats) or specific named graphs (in the same variety of formats). Just click the appropriate format and the download will begin:

!Export.png|align=center,border=1!

h3. Export query results

SPRQL query results can be exported to JSON or XML from the query results page:

!Export-query.png|align=center,border=1,width=776,height=207!

h3. Export resources

From the resource description page, it is possible to export the RDF triples that make up the resource description to JSON, RDF, N3/Turtle and N-Triples:

!Export-resource.png|align=center,border=1,width=780,height=361!


h1. User administration

User management is accessed from the menu bar ADMIN->Users. This page displays a list of users and the number of repositories they have access to. It is also possible to disable security for the entire OWLIM-Workbench instance by clicking the 'disable/enable' button, i.e. all users (even anonymous ones) have read/write access to all repositories.

!adminitration-users.png|border=1,width=778,height=238!


Clicking 'remove' next to a user name will remove that user and its permissions from the system. Clicking 'create new user' or 'edit' next to an existing user allows a user's properties to be edited. This includes setting their role (administrator or user) and the read/write permission to each repository. The password can also be changed here.

User Roles are:

* user - user that can read and write according to his permissions for each repository
* admin - user with full access including creating, editing, deleting users.

!new-users.png|border=1!


h1. Configuration

In addition to the standard OWLIM command line parameters, the OWLIM Workbench can be controlled with additional parameters as follows. These should be of this form {{\-Dparam=value}}

|| Parameter || Default || Description ||
| app.cors.enable | false | enable cross-origin resource sharing |
| app.info | true | control the display of build date and revision |
| app.maxConnections | 15 | set the maximum number of concurrent connections to an owlim instance |
| impex.dir | $\{user.home\}/owlim-impex/ | change the location of the file import folder |
| jetty.port | 8080 | set the jetty port |
| repo.data | <none> | connect to the specified location for repositories |
| resource.language | 'en' (English) | set the default language with which to filter results displayed in resource exploration |
| resource.limit | 100 | set the limit for the number of statements displayed in the resource view page |
| security.enabled | true | enable/disable security\* |
| sparql.limit | 100 | set the limit for the number of rows of SPARQL query results displayed in the query results page |
| sparql.equivalence | false | enable result expansion over equivalent URIs for SPARQL queries when using the query page |

* will be available in the next release of OWB