Workbench User Interface

The Workbench is the web-based administration interface to GraphDB. It lets you administer GraphDB, as well as load, transform, explore, manage, query, and export data.

The Workbench layout consists of two main areas. The navigation area is on the left-hand side of the screen and it contains dropdown menus to all functionalities - Import, Explore, SPARQL, Monitor, Setup, and Help. The work area shows the tasks associated with the selected functionality. On the home page, it provides easy access to some of the actions in the Workbench such as setting a license, attaching a location, creating a repository, finding a resource, querying your data, etc. On the bottom of the page, you can see the license details, and in the footer - the versions of the various GraphDB components.

_images/workbench-landing-page-free.png

Workbench functionalities descriptions

Navigation Tab

Functionality Description

Import

  • RDF => Import data from local files, from files on the server where the Workbench is located, from a remote URL (with a format extension or by specifying the data format), or by pasting the RDF data in the Text area tab. Each import method supports different serialization formats.

  • Tabular (OntoRefine) => Convert tabular data into RDF and import it into a GraphDB repository using simple SPARQL queries and a virtual endpoint. The supported formats are TSV, CSV, *SV, Excel (.xls and. xlsx), JSON, XML, RDF as XML, and Google sheet.

Explore

  • Graphs overview => See a list of the default graph and all named graphs in GraphDB. Use it to inspect the statements in each graph, export the graph, or clear its data.

  • Class hierarchy => Explore the hierarchy of RDF classes by number of instances. The biggest circles are the parent classes and the nested ones are their children. Hover over a given class to see its subclasses or zoom in a nested circle (RDF class) for further exploration.

  • Class relationships => Explore the relationships between RDF classes, where a relationship is represented by links between the individual instances of two classes. Each link is an RDF statement where the subject is an instance of one class, the object is an instance of another class, and the link is the predicate. Depending on the number of links between the instances of two classes, the bundle can be thicker or thinner and it gets the color of the class with more incoming links. The links can be in both directions.

  • Visual graph => Explore your data graph in a visual way. Start from a single resource and the resources connected to it, or from a graph query result. Click on a resource to expand its connections as well.

  • Similarity => Look up semantically similar entities and text.

SPARQL

  • SPARQL => Query and update your data. Use any type of SPARQL query and click Run to execute it.

Monitor

  • Queries and Updates => Monitor all running queries or updates in GraphDB. Any query or update can be killed by pressing the Abort button.

  • Resources => Monitor the usage of various system resources, such as memory and CPU, for the currently active location.

Setup

  • Repositories => Manage repositories and connect to remote locations. A location represents a local or remote instance of GraphDB. Only a single location can be active at a given time.

  • Users and Access => Manage users and their access to the GraphDB repositories. You can also enable or disable the security of the entire Workbench. When disabled, everyone has full access to the repositories and the admin functionality.

  • My Settings => Configure the default behavior of the Workbench.

  • Connectors => Create and manage GraphDB Connector instances.

  • Cluster => Manage a GraphDB cluster - create or modify a cluster by dragging and dropping the nodes, or use it to monitor the state of a running cluster in near real time. The view shows repositories from the active location and all remote locations.

  • Namespaces => View and manipulate the RDF namespaces for the active repository. You need a write permission to add or delete namespaces.

  • Autocomplete => Enable/disable the autocomplete index and check its status. It is used for automatic completion of URIs in the SPARQL editor and the View Resource page.

  • RDF Rank => Identify the more important or popular entities in your repository by examining their interconnectedness determined by the RDF Rank algorithm. Their popularity can then be used to order query results.

Help

  • REST API => REST API documentation of all available public RESTful endpoints together with an interactive interface for executing requests.

  • Documentation => Link to the GraphDB public documentation.

  • Developer Hub => Link to the GraphDB dev hub - a hands-on compendium to the GraphDB documentation that gives practical advice and tips on accomplishing real-world tasks.

  • Support => Link to the GraphDB support page.

  • System information => See the configuration values of the JVM running the GraphDB Workbench: Application Info, JVM Arguments, and Workbench Configuration properties. You can also generate a detailed server report file that you can use to hunt down issues.

Workbench configuration properties

In addition to the standard GraphDB command line parameters, the GraphDB Workbench can be controlled with the following parameters (they should be of the form -Dparam=value):

Parameter

Description

graphdb.workbench.cors.enable

Enables cross-origin resource sharing.

Default: false

graphdb.workbench.cors.origin

Sets the allowed Origin value for cross-origin resource sharing.

This can be a comma-delimited list or a single value. The value “*” means “allow all origins” and it works with authentication too.

Default: *

graphdb.workbench.cors.expose-headers

As per GraphDB’s compliance with the Access-Control-Expose-Headers, when the two parameters above are enabled, this parameter exposes headers other than the CORS-safelisted request headers. They are exposed in a comma-delimited list.

Example:

graphdb.workbench.cors.enable=true

graphdb.workbench.cors.origin=*

graphdb.workbench.cors.expose-headers="content,location"

Default: If no value is set, only the CORS-safelisted request headers will be exposed.

graphdb.workbench.maxConnections

Sets the maximum number of concurrent connections to a remote GraphDB instance.

Default: 200

graphdb.workbench.datadir

Sets the directory where the workbench persistence data will be stored.

Default: ${user.home}/.graphdb-workbench/

graphdb.workbench.importDirectory

Changes the location of the file import folder.

Default: ${user.home}/graphdb-import/

graphdb.workbench.maxUploadSize

Sets the maximum upload size for importing local files. The value must be in bytes.

Default: 200 MB