
*GraphDB-Workbench*
Semantic Repository for RDF(S) and OWL
*Version 6.0*
*{_}User Guide{_}*
*Table of Contents*
\\
{toc}
h1. Overview
The GraphDB Workbench is a our recommended web-based administration tool. The user interface is similar to the Sesame Workbench webapp, but with more functionality. Here are some of the additional features:
* Query monitoring with the possibility to kill a long running query
* Better SPARQL editor based on [http://laurensrietveld.nl/yasgui/]
* Connectors administration(only present in the enterprise edition)
Of course GraphDB Workbench can be used to create GraphDB repositories, load and export data, execute SPARQL queries and updates. The user interface is built using the Forest framework ready to use, bug free components.
The GraphDB Workbench can be found in the distribution as a separate war file. The war file can be deployed with the startup script in the distribution or deployed in a dedicated application server.
h1. Requirements
Java: JRE 1.7 or higher (JDK 1.7 or higher if using custom rule sets)
Tomcat: Version 7 or higher if deployed as a 'war' file
h1. Installation, start-up and shutdown
To run the GraphDB Workbench as a standalone server, unzip the distribution zip file and execute the startup.sh/.bat script.
For Mac the command line is:
{code:language=bash}
sh startup.sh
{code}
You can also start the workbench by running the line:
{code:language=bash}
java -jar graphdb-tomcat.jar
{code}
These methods of deployment use an embedded tomcat server which will deploy the war files in sesame_graphdb directory. The GraphDB 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 {{graphdb-workbench-x.y.z.war}} file must be copied to the servlet container's {{webapps}} directory. In order to access the GraphDB Workbench use a browser with a URL similar to the following:
{noformat}
http://localhost:8080/graphdb-workbench-webapp-x.y
{noformat}
Shutting down the workbench if you are using the embedded tomcat method can be done with Ctrl-c in the console. 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 if security is enabled
If you start the workbench with *\-Dsecurity.enabled=true*, the first page presented will be the login page. The default administrator account information is:
{info}
username: *admin*
password: *root*
{info}
You are recommended to change the root password as soon as you login for the first time. Go to Admin->Users and choose Edit next to your username. Then change your password. See section [User administration|#GraphDB-Workbench-Useradministration] in the current document.
h1. Index page
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. Invalid GraphDB License
In order to run the GraphDB Workbench application, you need a valid GraphDB license. By default there is an evaluation license included in the distribution but in case you found out that your license had expired, you have to write to Ontotext for a new one. Once obtained, the recommended way of specifying it is with a java system parameter. Just add the following parameter
{code}
-Dowlim-license=<path-to-graphdb-license>
{code}
to the java process that is responsible for the workbench deployment(tomcat's setenv.sh file or our startup.sh script). Look at [How to setup graphdb license|https://confluence.ontotext.com/display/GraphDB6/GraphDB+FAQ#GraphDBFAQ-HowdoIsetuplicensefilesforGraphDBSEandGraphDBEnterprise] for other methods.
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.
h2. Adding a location
If we were unable to detect the sesame server(i.e. it is not deployed in the same application server) you will have to connect to the sesame server manually. To do this:
# From admin-repositories click on "Add Location"
# Enter the URL to a sesame location
# Optionally specify credentials for the sesame location(user and password)
# Optionally add JMX Connection parameters(url and credentials) - this allows you to monitor the resources on the external location and do query monitoring
{info}
For now there is no possibility to manage the graphdb cluster setup through the workbench even if you add jmx connection parameters
{info}
{note}
The JMX connection url is of the form
{code}