Working with Workbench

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 contains drop-down menus that lead to all tools and features: Import, Explore, SPARQL, Monitor, Setup, Lab, and Help. The work area shows the tasks associated with the selected functionality. The home page provides easy access to some of the actions in the Workbench such as creating a repository, attaching a location, finding a resource, querying your data, etc. At the bottom of the page, you can see the license details, and in the footer — the versions of the various GraphDB components.

GraphDB Workbench is a separate project available at https://github.com/Ontotext-AD/graphdb-workbench. It is also part of the GraphDB distribution and can be configured with the graphdb.workbench.home property. As a user, this makes it easy for you to extend and reuse parts of the Workbench. See Extend GraphDB Workbench.

_images/workbench-landing-page.png

Navigation Tab

Functionality Description

Import

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.

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.

  • Backup and Restore — Monitor all running backups and restores in GraphDB.

  • Resources — Monitor

    • The usage of various system resources: system CPU load, file descriptors, heap memory usage, off-heap memory usage, and disk storage.

    • The performance of: queries, global page cache, entity pool, and transactions and connections.

    • Cluster health (in case a cluster exists).

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.

    Note

    This feature requires a GraphDB Enterprise license.

  • 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.

  • JDBC — Configure the JDBC driver to allow SQL access to repository data.

  • SPARQL Templates — Create and store predefined SPARQL templates for futures updates of repository data.

  • License — View the details of your current GraphDB license and set or revert to a different one.

Help

  • Interactive guides — A set of interactive guides that will lead you through various GraphDB functionalities using the Workbench user interface.

  • 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

    • Workbench Configuration properties

      Note

      You can also generate a detailed server report file that you can use to hunt down issues.