Skip to end of metadata
Go to start of metadata

Page Contents

TopBraid Enterprise Vocabulary Net (EVN)

The TopBraid Enterprise Vocabulary Net (EVN) application environment lets users flexibly manage vocabularies (aka asset collections), leveraging standards-based semantic technologies.

The EVN User Guide

The following pages cover the concepts and functions that users access via the web-based interface.

Users create and manage various  Asset Collections , each of which has separate views for utilities (operations) and viewing/editing. EVN also supports user-teams' development and maintenance work through role-based workflows. Additionally, TopBraid Explorer and TopBraid Tagger and AutoClassifier are optional add-on modules.

The EVN User Interface (UI)

Many EVN views are oriented toward a particular type of asset collection (aka, vocabulary), such as taxonomy, ontology, etc. Every view has a header that provides breadcrumb navigation, global lookup, and special application links. Often there is also a collapsible left-navigation menu that provides direct links to all of the asset collection types and to other top-level functions and views. Left-navigation menu sections can be expanded/collapsed by selecting the +/- in the top right hand corner of the section.

The EVN Home View

The EVN Home view has the standard header and left-navigation menu along with some user-specific listings.

1, 4–6: EVN Dashboard, Searches, & User lists2: Asset Collections by type3: Governance Model contexts


EVN searches and user-specific items

The left-nav DASHBOARD section (#1 above) and the header (#4) provide links to top-level searches:

Both the DASHBOARD section and the Home page have listings that pertain to the current user:

  • #1 My Workflows: lists any workflows for which the current user has a potential action pending, and
  • #5 Recently Viewed Collections (#5): lists the five asset collections most recently edited by the user, and
  • #6 My Tasks: lists the current user's open tasks.

For the details of the top-level searches and other management functions, see the sections below.

Asset Collections

These graphs contain the details of—and relationships among—various business vocabularies, content, and schema in the enterprise. For details of each asset collection type, see its documentation pages via links either in the left-hand documentation tree or in the either of the EVN User Guide or EVN Asset Collections listings.

Governance Model

This is the special asset collection that defines enterprise contexts for grouping asset collections and users. Asset collections grouped into governance areas can be associated with selected governance roles. Users can be grouped into organizations according to associated job titles. See Governance Model Overview for more information.

Additional UI Controls

1. "Hamburger menu" Home: The header's three-bar "hamburger" Home icon drops down a quick-navigation menu for direct access to any asset collection.

2. Toggle left-nav labels: The left/right arrow atop the left-navigation menu toggles the text labels off/on, trading them for screen real estate.

3. Special links: The right-header has links for logging out, help documentation, and if authorized, the EVN Server Administration functions. It also shows the EVN webapp version.

 

EVN Top-Level Searches

Global Lookup

In the page header of non-editor screens, a Global Lookup text box searches for classes, properties, or instances across all asset collections in EDG. Any such resource whose label is prefixed by the search text will appear in a popup list. Selecting a listed resource opens its corresponding editor in a new browser tab, with the resource pre-selected.

Find Asset Collection

To search the EVN application for a particular asset collection based on its metadata, use EVN Home > Find Asset Collection. This feature becomes more useful as the number of managed asset collections grows.

 click image to enlarge

The left Filter pane of the search form lets you specify search criteria, with the Search Results showing in the right pane. EVN top-level asset collection form-searches work similarly to form searches in editors, but properties are not shown as columns in the results. Click the Reset button at the bottom of the search form to remove all search criteria entered on the form. Enter a value in the Search any Text property at the top to indicate that you want to search all the metadata properties for that particular text. This includes a checkbox to control whether the search is case-sensitive. Clicking the white triangle on the right of any property gives you greater control over how the value entered there is used in the search. The following options may appear on this menu, depending on the nature of the data stored in the property:

  • text contains Search for asset collections that have the entered string anywhere in the value for this property. It will match full or partial words containing the search string. This is the default behavior of each field on the search form.

  • text equals Search for asset collections that have this exact string in this property.

  • text matches regular expression Search using the regular expression entered here. Users will need to be familiar with the regular expression syntax. For example, while setting this field to "text contains" and entering "Virginia" would start a search that finds both "Virginia" and "West Virginia", a regular expression search for "^Virginia" would search only for values that begin with "Virginia", because ^ is used in regular expression syntax to indicate the beginning of an expression.

  • nested form When the field is a relationship, open up a nested form to describe the search criteria using the properties of the related entity.

  • any value Search for asset collections that have any value at all in this property.

  • min/max number of values Search for any asset collection whose number of values for this property fall in the range specified by the two numbers you enter. For example, entering the values 2 and 4 for the subject area property would search for asset collections that had more than 1 but less than 5 subject areas assigned to them.

  • no value Search for any asset collection that has no value set for this property.

The gear menu  below the search form gives you several options for what you can do with search results:

  • Export results to SPARQL CSV spreadsheet creates a comma-separated value version of the search results that includes the URI of the resource represented by each result row in the first column. See the W3C SPARQL 1.1 Query Results CSV and TSV Formats standard for more details (although there aren't many more details—it's a very simple format).

  • Export results to SPARQL JSON file creates a text page of results in SPARQL Query Results JSON format.

  • Export results to SPARQL TSV spreadsheet creates a tab-separated value version of the search results that includes the URI of the resource represented by each result row in the first column. URIs are delimited by angle brackets.

  • Export results to SPARQL XML file creates an XML version of the search results that conform to the W3C SPARQL Query Results XML Format.

  • Export results to simple TSV spreadsheet creates a tab-separated value version of the search results, showing the preferred label of each resource instead of URIs. This creates a more human-readable version of the data than the SPARQL TSV spreadsheet.

  • Show SPARQL query... displays a pop-up window with the query that is being generated on the server when the search form is executed. Advanced users with knowledge of the SPARQL query language can copy and paste the resulting query string into a SPARQL execution window (for example, using TopBraid Composer) or send the query to the EVN SPARQL Endpoint.

Exported search results will be displayed in your browser. Select Save As from your browser's File menu to save the results as a text file.

Spreadsheet programs such as Excel can easily read tab-separated value files, so saving search results in a tab-separated format is a simple way to create custom reports for people with no  access to this system.

Find Tasks

This lists the tasks defined for all asset collections in EVN.

Tasks do not appear until enabled by an administrator (see EVN Administration: EVN Configuration Parameters).

Filter the list by status and/or assignee. See also the (Utilities) > Task View documentation for any collection type.

 

User's Work Items

The Home page shows user-specific listings for workflows with pending actions, open tasks, and recently viewed collections.

Metrics Dashboard (EDG only)

This presents a high-level, user-oriented view of the status of the user's subject areas, collections, and workflows. The available subviews and their content is customizable, providing the capability of showing data quality indicators, workflow status, and metrics pertaining to collections and data governance. To customize please see Governance Model Overview > Metrics Dashboards.

My Workflows.

This lists the workflows for which the current user has potential status-transition actions pending. (For an overview of workflows, see Governance Model > Workflow Overview.)

The workflows are shown using a table and include the following information about each workflow:

  • Workflow: displays the type and name of the workflow.
  • Priority: shows the priority assigned to the workflow, if defined.
  • Next Actions: next stage in the workflow.
  • Asset Collection: name of the asset the workflow belongs to.
  • State: current state of the workflow.
  • Date Started: date in which the workflow was started.
  • Working Copy: name of the working copy associated with the workflow.
  • Asset: displays the asset over which the workflow was started.

The following operations can be performed, some require a that a workflow is selected (users can select a workflow from the list by clicking on it):

  • Go to Workflow: navigates to the overview page of the selected workflow.
  • Go to Working Copy: navigates to the editor application of the selected workflow.
  • Go to Asset: navigates to the asset page the workflow is associated with.
  • Excel: Exports the table contents to a Microsoft Excel document.
  • CSV: Exports the table contents to a CSV document.
  • Print: Prints the list of workflows.

My Tasks

This section provides links to the user's own open tasks.

Recently Viewed Collections

This provides links to the five collections that were most recently viewed (edited) by the current user.

  • No labels