Child pages
  • Getting Started with TopBraid Explorer
Skip to end of metadata
Go to start of metadata

Introduction

TopBraid Explorer lets a broader community of data stakeholders work with the enterprise knowledge graph curated by TopBraid EDG.  TopBraid Explorer lets all stakeholders search, query and view all published information. It offers an easy to use Google-like search as well as visual exploration of graph connections, data lineage and impact. For access by applications, Explorer offers rich semantic services delivered through flexible and scalable APIs. For cost effective read access to the EDG knowledge graph by people and APIs TopBraid Explorer can be added to any of TopBraid EDG's packages.

TopBraid Explorer is installed on a server separate from EDG for scalable, high performance access. This setup separates the information curation environment, and associated workloads, from the information use environment. Individual asset collections are published from EDG to Explorer as they become ready to be used through a choice of mechanisms.  These mechanisms are: on demand publishing; scheduled, workflow-controlled publishing;  just-in-time replication of changes to some or all asset collections.

TopBraid Explorer users can search across all published information, view it and can create comments for the information curation team.

Installation and Setup

To install and configure Explorer, administrators will use the same process they follow to install EDG. 

Step 1:

Obtain a license for Explorer from TopQuadrant. Contact sales@topquadrant.com if you have not already done this. 

Step 2: 

Set up a separate server or instance for your Explorer application. Follow the same guidelines used for your EDG environment. You can scale this down if you will have far less data, but if not, follow the same guidelines. See Administrator Guide for complete instructions to install and configure Explorer as you would EDG. You will use the same edg.war file for this installation. 

Step 3:

Configure permissions on the Explorer server. You will need an administrator role and an explorer group role. Configure EDG and the Explorer server with Explorer Parameters. See Explorer configuration for complete instructions. 

The User Interface

For a basic orientation to the user interface, see EDG User Guide - UI Overview 

Adding Content to Explorer

Once a collection has been published from EDG, a user (member of "explorer group" ) logged into the Explorer server will be able to see it.  Explorer provides the same navigation and search features as TopBraid EDG.

On Demand Publishing

Managers of specific asset collections, or EDG Administrators, can publish collections to the Explorer server once it's configured. To do this, navigate to the collection in EDG → Export → Publish for Explorer Users  (as shown below for a Reference Dataset).


Note: If you immediately get a 'bad request' message back, then please double check the Explorer parameters on the EDG server and compare this to the examples in the documentation. 

To remove the collection from Explorer, go to this same link and set its status to "Unpublished".

In order to update the collection on Explorer to the most recent version in EDG, use the "update published copy" option. 

Workflow-controlled Publishing

Users can configure publishing as a step in a workflow template, and publishing can also be accomplished via an API.  For more information see TopBraid EDG Developer Guide.

Users can also create a publishing job and schedule it to run using the Job Scheduler in EDG.

Just-in-Time Replication of Changes

User organizations that have TopBraid Data Platform can set up the Explorer server as one of the replicated nodes. This setup will result in the continuous publishing of changes to selected asset collections in EDG. For more information, see TopBraid Data Platform.

Configuring Search the EDG

An Administrator of Explorer can configure which of the published collections should be included in the Search the EDG feature for the Explorer server. In order to set this, navigate to each collection → Manage tab, then select the checkbox as shown below.


Features of Explorer

Explorer users will have read-only access to any collection that is published; no other permission configuration is required. When accessing a collection they will see its content and be able to perform a number of functions. Navigation to a collection works in the same way it does in EDG: by clicking on the collection type (e.g., Taxonomies) in the left hand side Navigator bar, or by using a hamburger menu in the header.

Users can also go directly to the asset of interest, by searching in the Search the EDG window, or using Global Lookup in the header bar. For details on using Search the EDG and Global Lookup, please see User Interface - Overview

Clicking on a collection type, will bring you to the list of published collections.

Clicking on a collection's name (e.g., Geography Taxonomy), will display its contents in the same view application as the one available in EDG. The screenshot below shows a tabular view for a taxonomy. Users can click on the "Hierarchical application view" icon to switch to a tree view display – just as they do in EDG.  

Once inside the collection, users can customize their views, for example, by adding columns to a table and saving searches. They can use the many filtering and sorting options. Additional features that EDG users are familiar with, such as Export, Print, and Save to Basket, are also available. To see more details about each asset displayed in the table, select a row, and click the details button or double click on the row. You will be taken to a standalone form page. 

Explorer users have all the visualization features of EDG as well, such as Impact, Lineage and NeighborGram (see below):


In order to provide feedback to the editorial team working in EDG, Explorer users can make comments as shown below:

Send Comment is also available in the asset's form as shown below:


This comment will then be sent to the EDG server and appear in EDG as a comment from the Explorer user










  • No labels