Edit or View a Collection
When you click on an asset collection name in any of EDG pages, its content will be presented to you using so-called Editor application. You can also open up the Editor for an asset collection by clicking on the very first tab in the horizontal panel at the top of the asset collection page.
The Editor may open in the edit mode or view only mode. This depends on the user’s permissions:
- A user that creates an asset collection will always get manager permissions for it and, thus, can edit its content.
- If an asset collection is associated with a governance area, then every user with a governance role for the area will be able to view the collection (at least). If a governance role is set up to have edit or manage privileges, then people with this role will be able to edit collection’s content.
- Governance roles and direct permissions can also be specified at the asset collection level by users with the manager permissions via the Users tab (see documentation).
Instead of making changes directly to an asset collection, you can start a Workflow. If you start a workflow, you are its manager and will always be able to edit content of the asset collection in a context of a workflow.
Edits made directly in an asset collection are visible to all other collections that include it and to any workflows. In contrast, edits made as part of a workflow are only visible within the working copy managed by the workflow until and unless workflow changes are committed.
In EDG 6.4, there is only one editor option. The other options have been removed or consolidated.
Editor Layout View
Editor applications are composed of panels that are combined to form layouts. Multiple layouts are available. Each collection type has its own default layout. Users can change these defaults.
For example, the default layout for business glossaries will have two panels – Search and Form, looking as follows:
While for an ontology (asset collection that defines schema for other collections), the default editor layout will have panels looking as follows:
Configuring Editor UI
Selecting and Arranging Panels
Each panel can be displayed in the entire with of the screen by closing all other panels. This is useful when you need more screen real estate for working. To reset the layout, just select a layout from the menu and your panels will come back. Or you can drag them back into view from the panels menu. The next image shows how the Glossary Editor Application would look if the Form panel was stand-alone.
Panels can also be rearranged by dragging and dropping. Panels can be stacked behind each other in the same screen area. In the image below, the Change History panel is stacked behind the Form panel.
Panels can be closed by clicking on the ‘x’ button in the panel’s header. This action removes a panel from a page.
Clicking on the Panels button displays additional selection of panels to add to a page.
All available panels are described below, organized into categories:
Asset Information Panels
- Attachments (available when S3 is configured)
- Source Code
- Hierarchy of Selected Asset
Search and Query Panels
- Search Library
- SPARQL Query
- SPARQL Results Table
- SPARQL Library
- Asset List
- Available Crosswalks
- Class Hierarchy
- Class Diagram
- Node Shapes (only Ontology Editor)
- Property Groups (only Ontology Editor)
- RDF/OWL Property List (only Ontology Editor)
- Shape Scripts (only Ontology Editor if scripts are enabled)
Scripts Panels (available if scripts are enabled)
Some panels can be placed on a page more than once. They remain in the menu even if they already exist on a page. Other panels make sense only once per page. When already shown on a page, they no longer appear in the menu.
Some panels may have a pin icon – for example, if you open two forms. Pining a panel down will ensure that its content will not change when you click in another panel
Once you add or remove a panel from a page, this choice is remembered in your next session.
Layouts button lets you save arrangements of panels as a layout. You can also switch to one of the already available layouts.
A saved layout can be made available to other users or kept private. It could also be declared as a new default only for the user who created it or for others as well.
Pre-built layouts are:
- Default layout for the selected collection type
- Single Form Layout – displays only the form for the selected resource
- SPARQL Layout – provides a way to run SPARQL queries as an alternative to clicking on the Export tab > SPARQL Endpoint. Unlike the option on the Export tab, it is fully integrated with the editor.
- Classes and Instance Layout – useful for Enumerated values.
- Search Layout – a convenient page layout for Search operations, combines Search, Search Library and Form panels
- Problems and Suggestions Layout – provides a way to execute Problems and Suggestions checking
The Layouts menu also lets you manage existing layouts by selecting “Available Layouts”.
Using Editor-wide Configuration Settings
More icon in the header provides access to application settings and additional navigation options for user UX personalization. These settings are locally stored per user and won’t effect other users.
Display Edit Actions as Icons button turns various menu options into icons and vice versa. By default, Display Actions as icons is checked. Unchecking it will impact all panels that have Create New actions and there is more than one action. in a panel. Currently, these are Property Groups and Taxonomy Concepts panels. Instead of the icons, we will see Add menu with dropdowns. For example:
Checking the option to Display Settings as icons will impact every panel that has a Settings menu (gear icorn). Instead of the menu, we will see icons for each option.
Checking Display Panels palette option, will place in the header an icon for each panel – as shown in the screenshot below.
Clear locally stored Settings button will clear out any personalization of the UI with the exception of the Layouts as those are stored in the system, not the browser. Any check box, Asset List, or other personalization you have made will be reset.
Checking Hide values in non-preferred languages option will hide property values tagged with languages that are not set in your browser as one of your preferred language.
Manage default settings for all users … button will appear only if you have Manager profile for a collection. It will display a page where you can pre-set panel Settings for all users of a collection. For example, you can use it to ensure that for all users, when they look at the content of the current asset collection, the Form will show properties even if they don’t have any values.
The remainder of the menu is navigation/search options.
Cross Panel Operations
Some features and options work the same across different panels. These are described below.
Undo button in the header lets you reverse the most recent Save operation.
You can also reverse one or more changes made in the past by using Change History panel.
Resource (right click) Menus
Right click menu’s are available in most panels. You can right click to access a menu anywhere a link to an EDG resource is present or in a tree. In the descriptions of the panels below, you will find details for the resource (right click) menus.
Drag and Drop Operations
Several panels support drag and drop:
- You can drag and drop items displayed in the hierarchical panels e.g., Taxonomy Concepts, Class Hierarchy and Property Groups
- You can also drag and drop from other panels into fields on the Form panel
- In an ordered list (indexed property) on a Form, list values can be re-arranged by dragging and dropping
Note that, by default, drag and drop in the hierarchical panels in order to re-arrange a tree structure performs “delete and add” as a resource gets moved. This, for example, means that if a taxonomy concept had two different parents – A and B, moving it from its position under parent A to a position under parent C will give it a brand new parent and remove the previous two parents. In other words, it will no longer be under both, A and B. It will only be under C.
If you want to simply add a new parent instead of replacing previously existing parents, press CTRL key when dragging. This will add a new parent without removing existing parents. Alternatively, you can select a resource for which you want to add a new parent and edit its information in a form by adding a new value to already existing values for the hierarchical property.
When you drag and drop into a form, TopBraid EDG will check that a resource you are dragging has a suitable type for the field (property) you are dragging it into. Otherwise, you will not be able to drop it.
The Search panel lists assets of the selected type in a sortable table. From here, users can further filter displayed assets, export information, save searches and perform other operations. Note that this panel is not available for ontologies, please see ontology specific documentation here.
By default, this panel will display up to 1,000 result rows. This default can be changed by your EDG Administrator.
Selecting Asset Type in the Search Panel
The Type Selector shown at the top of the Search panel lets you to select the type of assets to show in the table. You can select an asset type either from the Type drop-down list (it supports autocomplete so to select you can start typing the name of an asset type you are interested in) or you could click on the button next to the drop-down list to open a browsable hierarchical navigator listing available asset types.
Table in the Search panel shows only assets of the selected type including any of its sub types.
Selecting Search Results Columns
The Columns icon to the right of the Filter icon lets you add columns to the search results table. Properties available for selection depend on the type of the asset. For example, Database Column is selected as the asset type in the image below. You will be able to select any properties defined for the Database Column asset type.
You can scroll through the list of properties available for selection or quickly find a property by typing in the Search field at the top of the dropdown. Clicking on a property will select it as column. Currently selected columns will be shown at the top of the drop down list. To remove a selected column, click on the “x” icon next to it.
For properties that are relationships, you will see “>” to the right of the property name – as shown in the screenshot above. If you click on it, EDG will present a list of properties for the related asset. This way, you can add as columns not only properties of assets you are looking at, but also properties of related resources – these are called nested columns.
The screenshot below shows a results table that we will get after selecting as columns 1) “record count” property that belongs to related assets – namely, Database Tables that assets of the selected type, Database Columns, are associated with via “column of” property – this is an example of a nested column and 2) “physical datatype” property that belongs directly to the Database Columns.
If a column is a nested column, the header row will display the connecting relationship name in the square brackets. Cell values for such columns will display the related assets before displaying the value of the selected property. You can select more than one level of nesting.
Searching for Assets
You can search among the assets of selected type by using:
- Free text (any property). This matches your string against any property with textual values e.g., label, description, note, etc. This query is wildcard. For example, searching for “rock” will be interpreted as *rock* and return results for “rocket”. Multiple word free text searches will be AND not OR.
- A B means an implicit AND
- “A B” matches the full term (in exactly that order)
- A OR B means an ‘or’ – infinite chains are supported such as A OR B OR C OR D
- Filter on specific property values. The filter icon will open a drop down listing available properties and letting you select one or more. This works similar to Columns drop down, including ability to select properties of related assets. For each property selected using Filters drop down, you will be able to enter a search criteria and specify the type of match. Type of match determines how EDG will use the value you enter in that field to search for matching data. Different properties can use different match types. Search criteria specified for each property are combined together to produce an overall search result.
|Type of Match||How a search value matches instance property-values|
|contains||DEFAULT for text properties: Finds resources that contain the entered search string (case-insensitive) in the property value. Example: Search text “lis” on a city-name property would match instances having city-name values such as “Lisbon”, “Lisboa”, and “Minneapolis”.|
|equals||DEFAULT for relationships: For attributes, this will match the entered string exactly to the property value (case-sensitive). For relationships, this becomes an auto-complete field for selecting a related asset. As you start typing a value in a relationship field, you will get a list of autocomplete options that match the text you’ve typed so far—a list of the names (labels) of any resources that begin with the typed letters.|
|regular expression||For text properties, searches text using a regular expression that matches a property-value (case-insensitive). Example: Search text “^lis” as a regular expression matches city-name values that begin with “lis”, e.g., “Lisbon” and “Lisboa” but not “Minneapolis”. Conversely, “lis$” would match only at the name’s end. For relationships, does similar matching, but on the labels of related resources.|
|any value||At least one value exists for the selected property (count >= 1). Example: See how extensively a property is used.|
|min/max number of values||Finds resources whose number of values for selected property fall in the range specified by the one or two numbers you enter. Example: If most resources in a Data Assets Collection have labels in three languages, entering a label search with values-range 0 to 2 would return those instances with fewer. Leaving min range empty and just using 2 in the max field will return the same results.|
|no value||No values exist for the search property (count = 0). Example: Use to clean up a Data Assets Collection and check for remaining work.|
|boolean||DEFAULT for Boolean properties: Search values restricted to true/false instead of free-text|
|nested form||Available only for relationships: Adds an embedded search form for properties whose type is another class|
|min/max (inclusive)||DEFAULT for numeric properties: Finds resources that are within the range of entered search criteria, inclusively.|
|min/max (exclusive)||Finds resources that are within the range of entered search criteria, exclusively.|
- Refine field is displayed at the top of each column under the column name. Entering a value in this field refines the results displayed in the table. The Refine is similar to Filter except that it only affects the visibility of assets that are already in the results table, without affecting which assets are loaded into results table, i.e., the underlying search scope is unchanged and refine only narrows data already in the table.
If you have incomplete search results, over 1000 if you have the default settings, you can still search the entire collection as well as export all the search results:
Actions in the Search Panel
The Search panel has New button. Clicking on it, will let you create a new asset of the currently selected type.
The Search panel also offers several other actions that can be performed on the search query or on the search results. These actions and the corresponding menus and buttons are shown in the next screenshot and explained in the text below it.
1. Save Search button. Will bring up the dialog to save searches. Saved searches are public and can be seen and used by any other users of this collection. To run or delete previously saved searches use the Search Library panel.
2. Settings menu for Search Panel. Lets you personalize the behavior of this panel.
- Hide Quick Asset Type Selector – will hide the type selector menu but leave the type selector menu in place.
- Disable auto-searching – this will change the behavior of the free text search box. You will need to hit enter when ready to submit instead of the results auto populating as you type.
- Add a column for each filter – checking this box will add a column to the results table each time you add a property as a filter for the search.
- Return local results only – this will filter out included collections.
3. Export. Provides access to the various export options for search results. The entire search results are exported unless you check certain results rows, then export will be limited to those rows.
4. More. Provides access to several actions that can be performed on selected results. Check the row boxes for the items you want to perform these actions on.
- Add to Asset List – which is another panel in the editor used for bulk functions or bookmarks
- Add to Basket – which is the basket for all of EDG located in the left navigation menu
- Edit assets – will launch a batch edit wizard tool
- Show on Map Results Panel – this option will be available only if Map Explorer panel is enabled. Clicking on it will display selected items on the map – provided that they have geo coordinates.
Changing to Lucene WhitespaceAnalyzer
Form Panel – Updating Asset Information
You can modify asset information directly by editing it in an asset collection or you can start a workflow and edit information in the working copy of the collection that is managed by the workflow. Irrespective of the choice, editing options are the same.
Asset information is modified primarily using the form panel. Clicking on the Edit button on top of the form opens all fields for editing. Alternatively, to clicking on the Edit button, users can do inline editing. Mouse over the area between the field name (e.g., definition) and the field itself. You will see a pencil icon. Click on it to start editing one property at the time.
TopBraid EDG supports modular management of information. You can create resources in one asset collection, then include this collection into another one and add more information about these resources. See Settings guide on how to combine asset collections through includes.
The hue of the icon at the top of the form will indicate if that resource is from the selected collection or is included from another collection. If included from another collection, the icon will be a lighter color. Further, you will see at the top of the form information about a collection where this resource is defined in.
You will be able to click through to that “defining” collection and modify the resource there.
If you do not go to the defining asset collection and decide to edit an included (or referenced) resource in your current collection:
- You will only be able to add information and will not be able to remove or modify any of the information from the included collection
- The changes you make are added to the collection you are currently in, not the collection this resource has come from.
Similarly if you choose to delete an included resource, only the changes you made in that collection will be deleted, not the original resource. If you want to make changes to the statements that are included, use Explore -> Open in Defining Asset Collection. This will open the asset in the collection where it was originally created.
Click on the + (plus) sign to the left of the editable field to get a slot for a new value. Plus sign will appear only if the property could have more than one value. Click on the – (minus) sign to the right of the editable field to remove a value.
For attribute values, you can just type the value. A convenient picker may appear depending on the datatype e.g., a date. EDG will protect you from making mistakes. For example, if a value is supposed to be an integer, you will not be able to enter letters.
Note that a language tag for a string can be selected from the dropdown to the right of the field – if a value is defined as a language tagged string.
The dropdown icon to the left of the delete icon lets you switch to a different edit widget – If multiple types are defined for an attribute e.g., a string or a language string or HTML. For string values, you will be able to switch between a “text field” (a single line entry field) and a “text area” (a larger text box). Options shown are determined by the schema (ontology) that defines the asset type.
For relationship values, you can:
- Start typing the name of the existing resource and pick it from the auto-complete.
- Enter the URI of the related asset. The dropdown menu available by clicking on the “v” sign to the right of the field will let you switch between using autocomplete (default) and entering a URI.
- Use search to find the resource you want to connect to by clicking on the button directly to the right of the field – as shown below.
- Create a new resource by clicking on the button directly to the right of the field – as shown below.
- Drag and drop assets from other panels directly into a form
After at least one change is made, Save Changes button becomes clickable. If any of the edits presents an issue, the page will display them. You will have a choice to correct issues prior to saving, cancel edits or save them as-is.
Preview button will display added and deleted statements as well as any issues.
Sometimes, to the left of a field open for editing you will see a + icon surrounded by a square shape. Clicking on it will open a subform that lets you make statements about property’s value. For example, you may want to say that a value of a country code or a status has an effective start and an effective end date.
When information shown on the form is a relationship, you can:
- Right click to see and use menu options for the related resource
- Click on the dropdown to switch the display to show URI of the related asset instead of its label (in view not in edit mode). You can also click on Show Details to see the embedded form for the related asset.
Further, if you mouse over the related asset, you will see an info box with its description (ala Wikipedia) if a description is available.
Sometimes, a form may display information in tables and/or display generated diagrams. What to display as a table is defined in the associated ontology models and can be configured. For example, in the form below for a database table from Northwind you see two tables: one containing data sample (not editable) and one containing records of data quality runs (editable).
Values that can’t be Edited
If a value of a property is displayed, but not editable, it means that one of the following is true:
- Values for this property are automatically calculated (inferred) by EDG. Rules for inferring values are defined in the underlying ontologies. Some values may also be inferred by default, but still editable. In this case, any user edit overrides system inferences.
- Value has been entered in an asset collection that is included in the currently selected collection. In this case, you will not be able to remove or change the value. To edit it, you must navigate to the defining asset collection. If, however, the property can have multiple values, you will able to create additional values for such properties.
- Property has been set as “read only” in the underlying ontology. This may happen if your organization wants to control addition and edits of values for certain properties in the UI e.g., to make such edits possible only through import or APIs or to make them possible only in certain asset collections or to protect users in certain roles from incidentally modifying these values.
Cloning and Replacing Assets
Clone and Replace operations are available under Modify menu.
Clone creates a copy of the selected Asset. The label of the clone (preferred label in case of SKOS Concepts) will be set as the label of original asset with “ Copy” post-pended to it.
Replace, creates a clone of the selected asset using URI that you will provide and then deletes selected asset. One difference with the clone operation above is that the label will be the same as the label of the original asset, “ Copy” will not be post-pended. You can use this operation if you decide that you need to modify URI identity of a resource. EDG will automatically adjust all incoming and outgoing references. However, it will do so only for the currently selected asset collection. Other asset collections will not be updated. If they contain references to the asset you are replacing, you will see broken links. To understand possible impacts of delete operations see Deleting Assets section.
You can delete assets directly in an asset collection or you can start a workflow and delete in the working copy of the collection that is managed by the workflow. Irrespective of the choice, delete options are the same.
With asset information displayed on a form, click on Modify button and select Delete.
Since asset collections in EDG can include each other by reference, some care needs to be taken when deleting assets. Delete operation only deletes references to the deleted asset that exist in your current asset collection. Consider the following scenario:
- Taxonomy 1 defines Concept A
- Taxonomy 1 also defines Concept B making it a child of Concept A
- Taxonomy 2 includes Taxonomy 1
- Taxonomy 2 defines Concept C making it a child of Concept A
- You go to Taxonomy 1 and delete Concept A. Concept B’s reference to A will be removed, but Concept C’s reference to A will stay. Now concept C has a broader relationship to an undefined concept
Running Problems and Suggestions check on Taxonomy 2 will report the issue and assist you in removing such references.
Similarly, deleting a class (asset type) from an ontology will not remove class instances (assets of a given type) that may be stored in another asset collection. It will make them members of undefined class. Deleting a property does not delete property values that are held in another asset collection.
Running Problems and Suggestion check will help you identify and fix these issues. Further, by going to the Settings>Included By you will see all asset collections that include your selected collection. You can then go to them and use References panel to identify what may be referring to a resource you are planning to delete.
With asset information displayed on a form click on Explore button to select one of the available menu options.The explore menu may differ based on collection type. See ontologies or taxonomies for additional features available in these collections.
For all assets, you will be able to:
- Find similar assets
- Show any workflows that contain changes to the selected asset
- See and enter comments about the asset
- See and create tasks for the asset
- Select a number of diagrams and visualizations – available options depend on the type of the asset
- Add and view endorsements. Endorsements will be recorded as activity in the what’s happening section of EDG home page, viewable in the form panel and in Search the EDG.
If an asset is from another collection and is included by reference you will see an option to Open it in the defining collection.
Alternate Form Views
An asset may have more than one type. It may also be of a single type, but have multiple views defined. For information on defining alternative views, see ontologies view shapes.
The view you will see by default will depend on your role and selections made in the relevant ontology.
If an asset shown on a form has multiple types or different role-based views, it can be viewed and edited using any of these perspectives. In such cases, you will see a dropdown box at the top right of the form next to the settings menu.
You will also be able to select a Merged view that, for assets that have multiple types, will combine properties of all types. To do this, select Settings>Merge properties from all suitable view shapes.
Updating Asset Collection Information
To update information about the collection itself, for example, its metadata, use the form for the collection. Clicking on the home button in the header bar or the title of the collection in the header bar will display on the form information about the collection itself. You can then modify metadata such as subject area or version.
Ontologies will have a drop down to switch to the GraphQL view where you can see and modify information used by EDG to auto-generate GraphQL schema for the ontology.
Additional Options for Viewing and Modifying Data
Additional options for modifying data in other editors panels are as follows:
- Source Code panel. This is a low-level technical operation and should be only used by users who are well versed in RDF, the underlying data model behind EDG. Your EDG Administrator can disable access to this panel for some of the users.
- SPARQL query panel. Update access must be enabled on the server to modify through SPARQL queries.
You can also modify data through GraphQL in EDG accessible from each collection’s Export tab.
The Forms for classes, SKOS concepts and concept schemes have a section called “Display” where you will find the “hidden” property. Setting it to “true” will hide these resources from the panels that display tree views – Class Hierarchy panel (in case of classes) and Taxonomy Concepts panel (in case of concepts and concept schemes). When a parent is hidden in the tree, all its children also disappear from the tree – unless they have another parent. The Class and Taxonomy Concepts panels have a “ghost” setting to show hidden items. To do this, select Settings> Also show assets marked as hidden.
Batch Edit is available from the Asset List Panel, Instances Panel and Search Panel. Where you see the following menu item once you select multiple assets:
The batch edit wizard tool will then be launched. Note, you can only modify resources of the same type. If you have selected resources with multiple types, you will be asked to choose one.
The wizard will then let you select properties you want to change and walk you through modifying data using features similar to those of the Form Panel.
If the Jira feature has been configured by an administrator, then for each asset collection, a manager can set an associated project-key string via Manage > Jira Project Key (see documentation). Then, when the collection’s editors are logged into Jira, they can launch from editor resources into related Jira searches and create new issues in the collection’s corresponding Jira project.
On a selected resource in the form panel, use the modify menu select any of the following: Create Jira Issue, Search Jira issues by label, or Search Jira issues by URI. The two searches will open (as new browser tabs) JIRA pages that search on the indicated resource string (URI or label). The create option will open the start of a new Jira item.
Note that if the browser is not logged into Jira (or if the administered JIRA settings fail), then the launches can result in a Server Interaction Error message dialog. Please check the server logs for details in that case.
After configuring the S3 Attachments bucket and selecting the appropriate bucket from the Manage tab, the attachments panel will be accessible. Files can be added as an attachment to individual assets or the entire collection. Attachments will stored in the configured S3 bucket. These can be downloaded from the attachments panel as well. Removing them only removes them from the panel, not from S3.
References panel displays all assets that refer to the currently selected asset (in the form or one of the other panels). For each referring asset, you will see its label and the referring relationship.
If you click on one of the referring assets, it gets selected on the form, in the hierarchical panels, etc. Then, in turn, what is shown in the References panel will change. If you want to avoid this from happening, select the “pin” option under the Settings (gear) menu. This will prevent the contents of the Reference panel from changing as you click around.
Source Code Panel
Source Code panel displays information about selected asset in Turtle serialization https://www.w3.org/TR/turtle/. This is a low level operation and care should be taken here. You can cause damage to your EDG workspace making it unavailable. An administrator can block all edits to source code with an option in EDG Configuration. This is recommended if you aren’t familiar with editing Turtle serialization.
Source Code panel can also be hidden from users in certain roles.
Depending on the situation, you may see two windows: upper window will show content of the current graph (asset collection) and lower window may show content from included graphs, if any. The latter is not editable. The upper window lets you edit. You can make changes and click on the Save Changes button.
If there are any syntax errors, Save Changes will not be available.
Prefix declarations can be expanded and collapsed. Do not make changes to prefixes here. Change them in the Settings tab > Namespaces and Prefixes.
Settings menu option will let you hide statements from the included graph (if any). With it on, the window with statements from the included graph will be hidden.
Search Library Panel
This panel will show the list of searches saved using the Search panel. What it shows is determined by the asset collection you are currently in.
You will be able to select and execute a search. You will also be able to delete saved searches.
The settings menu lets you configure how much information about a search should be displayed.
Your saved searches can be used as APIs by other systems using the Service URL.
SPARQL Query Panel
This panel lets you compose, run and save SPARQL queries. For example, a query shown below will identify assets that do not have a preferred label in Russian, effectively providing a translation list.
You can use either URIs or Qnames. The panel will automatically resolve prefixes and put out PREFIX statements. The panel will detect and report query syntax errors. Query parts can be collapsed and expanded for readability.
To see results of query execution, use SPARQL Results Table. You can use SPARQL Layout which already integrates SPARQL Query and SPARQL Results panels as well as SPARQL Library panel.
To save a query for re-use, use Save icon. You will be able to name the query and decide the scope of its sharing. Your query can be parametrized. This will let users enter a parameter when they run saved query. To indicate that a variable is a parameter, replace “J” with “$” e.g., use $label instead of ?label.
Use the algebra button to see the SPARQL algebra associated with the query for advanced debugging. This will show how the SPARQL engine is executing the query allowing optimizations to be discovered.
TopBraid EDG supports SPARQL 1.1, including SPARQL Update. GeoSPARQL is also supported. To enable your asset collection for Geospatial queries, use the Manage tab to enable GeoSPARQL. This will create and maintain the geo spatial index.
If SPARQL updates have been enabled by an administrator, editors (and managers) can run them, but viewers cannot. Note that the Pivot Table and Geo functions can be slow on some platforms and are not supported for Internet Explorer.
SPARQL Results Panel
This panel shows results of SPARQL query execution from the SPARQL Query Panel in a tabular format and lets you export them. Table columns are sortable and rows are clickable so that you could see more information about returned resource on, let’s say, a form.
By default, returned resources are displayed using their labels. Settings menu lets you request that IDs (QNames) are displayed instead of labels. Export menu lets you export query results in a variety of formats. Results of SPARQL SELECT queries can be exported in any of the standard export formats as defined by the W3C specifications: TSV and CSV, JSON and XML. Results of SPARQL CONSTRUCT and DESCRIBE queries can be exported in one of the standard RDF serializations: Turtle, JSON-LD, RDF/XML.
SPARQL Library Panel
This panel will show the list of queries saved using the SPARQL query panel. What it shows is determined by the scope of the saved queries and the asset collection you are currently in.
You will be able to select and run a query. You will also be able to delete saved queries.
The settings menu lets you configure how much information about a query should be displayed.
The following buttons can be used to show the query and to copy the URL for the query results.
The following is an example of json results:
Asset List Panel
You can add any asset or group of assets to an asset list through the Search Panel.
The asset list is a way of bulk editing or sharing groups of assets. The “batch actions menu” is in the top right.
Pencil icon lets you name an asset list. The above asset list has been named “customer”. To create another asset list, drag the asset list panel from the panel selection to your window. Now when you choose to add to an asset list, you will choose which of your two asset lists.
Asset lists are private until shared. Cloud icon opens a menu that lets you open an existing asset list and share an asset list you create with colleagues who have permissions to this collection. They will be able to go to “Open an existing Asset List” and find all of the shared asset lists along with their own.
The settings menu lets you configure how information about assets in a list is displayed e.g., whether a person who added it to a list is displayed as a column.
This panel will show a table of instances of a selected class i.e., resources with the type corresponding to the selected class. The free text search field at the top of the panel lets you filter the list. The panel also has New button for creation of new assets of selected type. Settings menu has further options governing what and how is shown. The first column of the table is a check box. If you select multiple assets, you will be able to use the “batch actions menu” at the top right to perform the same bulk operations as those available in the Assets List panel.
Available Crosswalks Panel
This panel will list any crosswalks that map the current asset collection to another collection. You will be able to access crosswalk mappings from this panel. You will also be able to create new crosswalks. For more information see Crosswalks guide.
Class Hierarchy Panel
In EDG, every asset is a member of at least one class. This panel displays hierarchy of classes starting with a selected root. Hierarchical relationship between classes is rdfs:subClassOf. Class information is only editable if you are in an Ontology. In other collection types you will only be able to view class information. For more information about this panel see Working with Ontologies guide.
Node Shapes Panel
While EDG will declare all new classes also as Node Shapes, it also supports creation of Node Shapes that are not classes. This may be useful when creating an alternative view of class members or when creating a shape that will be used in other shapes, for example, as part of logical expressions.
Node Shapes panel displays ONLY node shapes that are not classes. It also supports creation of such shapes. For more information about this panel see Working with Ontologies guide.
Class Diagram Panel
This panel displays UML-like diagram for the selected class or node shape. The drop down menu at the upper right of the panel offers different diagram options e.g., with and without attributes.
Property Groups Panel
This panel will display properties associated with a selected class or a node shape. Properties are displayed organized into groups, reflecting how they would be shown on a form. For more information about this panel see Working with Ontologies guide.
RDF/OWL Properties List Panel
This panel is a table showing instances of rdf:Property class and its subclasses. New button lets you create new properties. For more information about this panel see Working with Ontologies guide.
Taxonomy Concepts Panel
This panel displays taxonomy concepts organized into concept schemes. It also lets you create new concepts and schemes. For more information, see description of this panel in Working with Taxonomies guide.
Problem and Suggestions Panel
This panel checks the content of the asset collection against all of applicable quality rules (i.e., applicable shapes and validity constraints they define). It also runs enrichment rules to suggest mappings.
Problems and Suggestions panel will raise validation results if values of properties do not comply with the constraints defined in the ontology your data is based on.
Note that RDF, as a flexible graph data model, lets you make statements that were not anticipated e.g., to say something about Person’s eye color even if no property “eye color” is defined for a Person. Creating such values is not supported by the form-based editing in TopBraid EDG – the forms are entirely driven by what is defined in ontology models. Yet, it is possible to add values for undefined properties e.g., if you have appropriate permissions, you could use the Source Code panel to add any triple directly in Turtle or you could import RDF containing any kind of triples. The fact that these triples may be using properties not explicitly defined in the ontology is not a violation of the model. It will not be flagged by the Problems and Suggestions unless you explicitly say that no values except for the defined properties are allowed.
Change History Panel
Change History panel will show all captured changes – additions and deletions.
Each change can be expanded to show details. Added statements are shown in green. Removed statements are shown in pink.
You can filter displayed changes by selecting a user who made a change, the time period when changes were made, and/or the property (predicate) which values were changed.
To see only changes made to the currently selected asset, click on the “on selected” button.
Changes can also be reverted from the change history panel. Click to select changes you want to revert and then click on the Undo icon – the first icon in the panel. Note that this will create an audit trail entry for the revert operation.
Workflows will have a button “from workflow only” to narrow down to only changes made specifically in the current workflow.
Inferences panel lets you run rules. It will display all triples generated by the rules using a table with 3 columns: subject, predicate and object.
In addition to the button that runs rules, the panel provides:
- A button to assert all inferred triples. It will be displayed only once you execute rules and they generate some statements that will be shown in the panel. Clicking on this button will write the inferred statements into the asset collection. Until you take this action, generated statements are not stored permanently.
- A button that will display all available rules and let you activate and deactivate them for the run. Note that rules defined using sh:values are evaluated dynamically and will NOT be shown or executed by the panel. The screenshot below shows the dialog that will appear when you click on this button
- Settings button. It lets you switch between the display of labels and URIs and between the tabular display of the inferred statements and display in the Turtle format (source code). It also lets you control the number of iterations.
If you expect your rules to produce a large number of triple statements, we recommend that you run them by using the option available in the Transform tab. The role of Inferences panel is primarily to help you with testing rules as you develop them.
Assets Hierarchy Panel
These panels show tree views of resources based on any relationships. Select the root resource type to start the tree. Use the gold circle icon to the right of the setting icon to make the selection. This can also be pre-set in the Manage tab.
Hierarchy of Selected Asset Panel
This panel shows a tree view starting with the currently selected resource, letting you to expand its relationship values as children in the hierarchy. These children can then be similarly expanded and so on.
Map Explorer Panel
This panel works with EDG’s GeoSPARQL support. In order to use the Google Maps panels, your EDG Administrator needs to set a Google Maps API Key in the configuration parameters page. Geo location information must use W3C vocabulary for representing latitude, longitude and altitude information in the WGS84 geodetic reference datum (namespace http://www.w3.org/2003/01/geo/wgs84_pos). The W3C vocabulary has properties for specifying geo coordinates.
TopBraid EDG provides the W3C vocabulary within its own Geo vocabulary that adds additional features for controlling map display. You will find it as an option in the Settings>Includes dialog by using Other as the collection type. If you do not see it in the dialog, click on the Home button in your asset collection and in the Source Code panel add:
To make geo coordinate properties directly available to your resources, you will typically declare their types as subclasses of geo:SpatialThing class. As an example, you can look at the TopBraid Example Geo Ontology in the Asset Collections Samples project where this is already done.
The Map Explorer panel will display selected resources on the map using their geo coordinates – values of geo:lat and geo:long properties.
The panel can display items using markers of different types, sizes and color. This is controlled using properties such astbgeo:fillColor. It can also display shapes (e.g., polygons) as shown below. These features require inclusion of TopBraid GeoSPARQL Vocabulary (tbgeo: namespace).
Follow the below example to get started with the polygon display.
Create an Ontology, include TopBraid GeoSPARQL Vocabulary. In the class that will contain data to display on the map (e.g. Country), use Create or Add Property> Add an existing property definition (property shape): geosparql:Feature-hasGeometry. This defines the property hasGeometry that can hold instances of geosparql:Geometry and those can carry either a GML or WKT rendering of the polygon or multi-polygon. Mark geosparql:Geometry as a public class of your ontology (click the Home button and switch to GraphQL Schema View in the Form to do this) so you will be able to readily create its instances.
Create an asset collection based on your new ontology e.g., a Data Graph. Enable GeoSPARQL support on the Manage tab, Create an instance of geosparql:Geometry class. Using the Form or the Source Code panel, enter the information in the below example. Most data of this type will probably be imported.
ex:SwissGeometry a geosparql:Geometry ; geosparql:asWKT "MULTIPOLYGON(((7.697223 47.543327, 8.57642 47.59137, 8.566111 47.806938, 9.566724 47.540451, 9.533569 47.274544, 9.474637 47.057457, 9.598635 47.063835, 10.471235 46.871353, 10.465277 46.546387, 10.050278 46.539993, 10.129999 46.227219, 9.28194400000012 46.495827, 9.036665 45.837776, 8.43638800000014 46.463333, 7.855742 45.919052, 7.038054 45.931938, 6.79138900000015 46.434166, 5.966666 46.209442, 6.99055500000014 47.497215, 7.588268 47.58448, 7.697223 47.543327)))"^^geosparql:wktLiteral ; . ex:Switzerland geosparql:hasGeometry ex:SwissGeometry ; tbgeo:fillColor "green" ; tbgeo:fillOpacity 0.8 ; tbgeo:strokeColor "blue" ; .
An example value in GML:
geosparql:asGML """<?xml version=\"1.0\" encoding=\"utf-8\" ?> <gml:Polygon xmlns:gml=\"http://www.opengis.net/ont/gml\"> <gml:exterior> <gml:LinearRing> <gml:posList>13.833611 48.773605 14.70028 48.581379 15.025833 49.018883 16.946182 48.619064 17.166386 48.012497 17.053886 47.709442 16.450554 47.698051 16.713886 47.543884 16.510555 47.00666 16.111805 46.86972 14.544998 46.407494 13.718655 46.526611 12.440554 46.690826 12.127777 47.001663 10.471235 46.871353 9.598635 47.063835 9.533569 47.274544 9.566724 47.540451 10.173332 47.274719 10.478054 47.591942 11.095554 47.396111 12.735554 47.684166 13.016666 47.470276 12.758333 48.123886 13.833611 48.773605</gml:posList> </gml:LinearRing> </gml:exterior> </gml:Polygon>"""^^geosparql:gmlLiteral ;
The values of tbgeo:fillColor, etc., can be dynamically computed using sh:values rules. The map will automatically update when (asserted) values for tbgeo:fillColor etc., change after edits, but this will not work for dynamically computed values.
Local Assets Panel
This panel will display only assets that are defined in the current asset collection. Assets from included collections will not be shown. There is a Search field to filter results and check boxes for selection. You can then use the “More” button in the upper left of the panel to execute operations on selected assets.
This panel shows a diagram of assets that are connected to the selected asset. The diagram is interactive, you can expand any node to show its incoming and outgoing links. When you click on a node shown in the diagram, you will see a few icons displayed below it. These icons let you filter the type of relationships shown and they also let you change the focus node.
Script Editor Panel
focusNode lets you work with the APIs for the selected resource. Use the Execute (“Play”) button to run the script, which may in the beginning only consist of the word
focusNode. When you run that “script”, the Script Results panel will show the currently selected asset.
Another common starting place for a script is to use
graph object and its associated APIs as shown below.
Stop button to the right of the Execute lets you stop currently running script.
There is also a button that lets you Upload a file for use by the script. And a button to Refresh the generated API. This button is used after ontology changes are made, including changes in the ontology structure and changes made in the Shapes Scripts panel.
Settings menu has an option to let the script modify data.
Script Results Panel
This panel shows results of script execution. In the header, it will display the time it took to execute a script.
Shape Scripts Panel
This panel lets you create source code that will be injected into the generated API. It is available only in ontologies.
To use it, navigate to a class you want to add code to. Enter the source code as shown below. Don’t forget to press Save Changes button.
Script API Viewer Panel
This panel lists all APIs available in the current asset collection. It has a button to Refresh the generated API. This button is used after ontology changes are made, including changes in the ontology structure and changes made in the Shapes Scripts panel.