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 cal 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.3, there are multiple different views for the editor pages. For the purposes of this guide, we may sometimes call the 6.2 editor application the “old editor”. The “new editor” view for 6.3 contains customizable layouts and panels all within one single page. This view will be the default for EDG unless an administrator sets the configuration to default to the previous editors. See Server Administration – EDG Configuration for more details.
Regardless of the default editor, the header menu at the top of the editor page will allow the user to switch between the new 6.3 editor and the old 6.2 editor, unless administrator disables 6.2 editors.
You will see up to 3 icons for switching between editors. The rightmost icon switches the display to the new 6.3 editor. Icon(s) to the left of it switch to the 6.2 editor(s). The 6.2 editor choices depend on the type of collection:
- For taxonomies and ontologies, there are two 6.2 editors: a hierarchical tree of either concepts or classes and the tabular view.
- For other asset collections, only one 6.2 editor is available.
If you do not see these icons it means that your EDG administrator disabled 6.2 editors.
The documentation provided here focuses on the new editor for 6.3. Please see the previous documentation (doc.topquadrant.com/editor) for details on the 6.2 editors.
Editor Layout View
With the new 6.3 editor, the default view (layout) for collections will vary. For example, the default layout for the editor application for business glossaries will look as follows:
And for an ontology that defines schema for other asset collections, the default editor layout will look as follows:
Editor applications are composed of panels. In the ontology editor above there are five panels numbered from 1 to 5.
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:
Asset Information Panels
• Source Code
Search and Query Panels
• Search (not available in Ontology Editor)
• Search Library (not available in Ontology Editor)
• 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)
• Taxonomy Concepts
• Problems and Suggestions
• Change History
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 a panel is added to or removed from a page, this choice is remembered in the 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 report as an alternative to clicking on the Reports tab > Problems and Suggestions. Unlike the option on the Reports tab, it is fully integrated with the editor.
The Layouts menu also lets you manage existing layouts by selecting “Available Layouts”.
Other Configuration Settings
“More” icon 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” turn 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. 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”, will place in the header an icon for each panel – as shown in the screenshot below.
“Clear locally stored Settings” 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.
The remainder of the menu is navigation/search options.
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
In the new 6.3 editor, 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.
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.
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.
Searching for Assets
You can search among the assets of selected type by using:
- Free text (any property). This searches all properties in the result set for your string. It’s not limited to the amount of results rows shown in the panel, i.e 1000 results as the default. This query is wildcard. For example, searching “rock” will be *rock* and return results for “rocket”. Multiple word free text searches will be OR not AND.
- Filter on specific property values. The filter icon will open a drop down listing available properties and letting you select one or more. 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.
Actions in the Search Panel
The Search panel also has actions that can be performed on the search query or search results. Explanations of each menu/button is provided below.
1. Save Searches. 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 the column to the results table each time you add a filter to 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 the 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 selected assets – will launch a batch edit wizard tool
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.
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. When you select to edit an included (or referenced) resource:
- 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. Note that a language tag for a string can be selected from the dropdown to the right of the field.
For relationship values, you can:
- Start typing the name of the existing resource and pick it from the auto-complete
- Use search to find the resource you want to connect to using 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.
The dropdown icon to the left of the delete icon lets you switch to a different edit widget. For example, to use plain text instead of HTML. Options shown are defined in the schema used for the asset.
If any of the properties are not editable, it means that their values 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.
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).
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 report 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 report 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
If an asset is from another collection and is included by reference you will see an option to Open it in the defining collection.
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.
If an asset shown on a form has multiple types or views, it can be viewed and edited using either of these perspectives. In this case, you will see a dropdown box at the top right of the form next to the settings menu.
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 even more options with GraphQL schema information.
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.
- 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 through each collection’s Export tab.
Batch Edit is available from the Asset List Panel and Search Panel. Where you see this menu item:
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 watch you through modifying data similarly to the features 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.
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 familar with editting Turtle serialization.
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.
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.
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.
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 colleciton. 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.
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.
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.
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 is similar to theProblems and Suggestions report in the Report tab, but it is conveniently integrated with the editor.
Change History Panel
Change History panel is similar to the View Change History report in the Report tab, but it is conveniently located with the editor.
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.