Child pages
  • Glossary View or Edit
Skip to end of metadata
Go to start of metadata


Page Contents

 

View or Edit

If a Glossary is associated with a governance area, then every user with a governance role in that same area will be able to view it (at least). For any other user to view or edit assets contained in a Glossary, a manager must grant them permissions via the Glossary's utilities > Users settings (see documentation).

Instead of making changes directly to an asset collection, you can start a Workflow

Note that different workflows that process changes to a Glossary can have their own permission-profile settings (for background, see Workflows: Rights Entailed by Permission Profiles).


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.


Creating New Assets

Using Create New

Use New button on top of the Search Results table to create a new asset. The Create dialog will let you pick asset type and enter its label.

Depending on the configuration options selected for EDG and/or the asset collection you are working in, you may be able to see and, possibly, change URI EDG generates for the newly created resource.

After clicking Confirm, new resource will be created and you will be presented with its form view where you can specify additional information.

There is also Create new ... option in the context of editing relationship values for already existing resource. This option is explained in the Editing Information about an Asset section below.

Importing New Assets

As an alternative to creating assets by using the Create dialog, you can import data into EDG.

Go to Glossaries >Glossary Utilities>Import View to learn about available import options.

#IF-NOT ONTO

Searching and Browsing in Glossaries

#ENDIF

The Search panel lists assets of the selected type in a sortable table. From here, users can further filter displayed assets, export information and perform other operations. The main features available in this panel are:

  • Searching for assets and displaying them in different ways.
  • Viewing and editing asset information.
  • Performing various actions on assets, either individually or in selected groups.


#IF-NOT ONTO

Controlling Asset Type

You can control what is displayed in the table by using Type Selector described below. This option is not available for ontologies where the type is selected by clicking on one of the classes in the Class Hierarchy.

Element NameDisplayed AsDescription
Type Selector

Lets you to select type(s) of assets to show in the table. You can select an asset type either from the Type drop-down list (it supports autocomplete so you a 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, which opens a browsable hierarchical navigator listing available asset types.

#ENDIF



Searching for Assets

You can search among the assets of selected type by using the various options available in the light gray upper box. These include:

  • finding assets using free text (any property),
  • finding assets by filtering on specific property values, and
  • using advanced search queries.

These options are explained in the table below:

Element NameDisplayed AsDescription
Free Text Search Box

Lets you type in a search criteria that will be matched against values in any properties of selected type of asset that contain text.
Advanced search LinkAdvancedThe Advanced link opens a GraphQL query box. For a tutorial on GraphQL in EDG please go to the Export tab of a collection > GraphQL Queries > GraphQL in TopBraid Tutorial. For more information please go to https://graphql.org/.
Filters Button

Clicking on Filters displays a drop-down lists of properties defined for the currently selected asset type and lets you select and deselect them. When a property is selected, a search widget will appear where you can enter a search criteria that is applied to deliver a subset of results. Each property filter supports various kinds of matching types described in a table below. Users can select multiple properties and specify search criteria for each. Clicking the search button will load only assets whose properties match the specified filters (along with any other selection settings).

Columns Button

Clicking on Columns displays a drop-down lists of properties defined for the currently selected asset type and lets you select and deselect them. When a property is selected, it will be added as a table column.
Search Button

Runs a query based on the specified search criteria and presents results in the table.
Reset Active Filters

Removes all currently specified search criteria, including any defaults (which remain saved).
More Search Options Menu

This menu lets you perform operations on the results of the current search. You can select to batch edit all resource returned by your current search or export them in a choice of formats. It also provides an option to view GraphQL generated fo the current search query, open a dialog that will let you name and save the current search criteria (query) for later use and open a list of any previously saved queries for this collections. User with manager privileges will also have an options to save the current query (including any search criteria and selected columns) as the default one for all users. The default will automatically be displayed to everyone who navigates to the collection and selects the asset type for which there is a default search.
Return Local Results Only Checkbox

When checked will ensure that the search query is ran only against assets directly defined in the current asset collection. In other words, will exclude from results any assets defined in the included collections.

By default, you will see only 1000 rows of search results. (To change this maximum number of asset results: see Administration > Server Configuration: SWP Parameters > maximum number of table rows.)

Matching type

For each property selected using Filters drop down, you can enter a search criteria and specify the type of match. This determines how EDG uses the value you enter in that field to search for matching data. Different properties can use different match types, all combining 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".

equalsDEFAULT 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 expressionFor 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 valueAt least one value exists for the selected property (count >= 1). Example: See how extensively a property is used.
min/max number of valuesFinds 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 Glossary 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 valueNo values exist for the search property (count = 0). Example: Use to clean up a Glossary and check for remaining work.
booleanDEFAULT for Boolean properties: Search values restricted to true/false instead of free-text
nested formAvailable 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.

#IF-NOT ONTO

Switching between Tabular and Hierarchical Displays

You can also switch between the tabular and hierarchical views. This option is explained below. It is not available for ontologies.

Element NameDisplayed AsDescription
Switch to Properties Hierarchy View Button

This button replaces the table with a two-column view that displays assets hierarchically in the left column and the details of a selected asset in the right column. The hierarchy will be structured according to a user selected property relationship (e.g., "has broader") or its inverse. This option is available in the light grey upper box.


Switch to Table View Button

This button is displayed after you switch to the hierarchy view. It will let you revert back to the tabular view.

#ENDIF

Actions on Search Results

These options are selectable either from the rows of page elements just above the table of search results or within the table itself and, finally, in the footer below the table.

Note: Not all options are available for all types of Collections. For example, edit features such as New and Delete, are not available when the Search View is in display-only mode such as in Ontology asset collections.

Element NameDisplayed AsDescription
Refine Text Box

The Refine text field is similar to the free text search (above) except that it only affects the visibility of the loaded assets, without affecting which assets are loaded into results table, i.e., the underlying search scope is unchanged, refines operates on the data in the table. Refine matches the string will against data in any of the table's columns.

New

Button

New

Clicking on this button lets you create a new asset of a chosen type. The Create Dialog will let you select a sub-type, if any are available.

Details

Button

Details

This button is clickable only when a single asset is selected. It displays information about the selected asset in a form in a new browser tab .

Delete

Button

DeleteThis will let you delete all of the currently selected assets.

Clone

Button

CloneThis button is clickable only when a single asset is selected. It creates a copy of the currently selected asset.

Export

Menu

ExportThis menu lets you export the selected rows in a choice of spreadsheet formats and, if a single asset is selected, lets you print out its detailed information.
Resource Actions Menu

This menu is clickable only when a single asset is selected. It lets you add it to the basket and runs and displays a report that identifies any active workflows that may impact the selected resource.
Visualizations Actions Menu

This menu is clickable only when a single asset is selected. It lets you select amongst the various graphical diagrams for assets (e.g., NeighborGram, etc.). Availability of some diagrams depends upon the type of asset to be viewed.

More Actions Menu

This menu is clickable only when a single asset is selected. It lets you add tasks or comments to a selected resource, add it to the basket or start a workflow for it.
Show Number of Entries Drop-down

By default, table displays 25 rows, but you can select a different number of rows
Table Header Row
This is the first row of the table. It displays names of currently selected properties. You can sort the table in the descending or ascending order by clicking on one of the columns. You can also re-arrange the order of the columns in the table by dragging and dropping columns in the first row.
Checkbox Column
The first column in the table contains checkboxes. These get checked when you click on a row to select it. You can select multiple rows. In addition to the checked checkbox, another indication that a row is selected is that its background color changes from white to blue. To deselect, click again.
Pencil Icon

This icon shows up when you mouse over any cell in the table except for cells in the first, header row or the first two columns. When clicked it opens the values in the cell for editing.
Save Icon

Lets you save edits made in a cell of the table. You must click on either Save or Cancel icon to exit the cell editing mode.
Cancel Icon

Exits the cell editing mode without saving any changes.
Counter

Counter is shown at the bottom of the table. It shows the total number of assets displayed in the table and the number and sequential order of assets displayed on the current page. The maximum number of assets to display in the table is set in the Server Administration console. When search results exceed the maximum, TopBraid EDG will display a message at the bottom of the table.
Previous ButtonPreviousThis button is shown at the bottom of the table. It lets you page through results.
Next ButtonNextThis button is shown at the bottom of the table. It lets you page through results.

Viewing Asset Details and Making Changes

Displaying Relationships with NeighborGram and UML-like Diagrams

One can visually browse a resource's relationships to other resources (classes and instances) in an interactive graphical view called a NeighborGramTM. To launch this view from a resource's details pane, select the visualization button  and select the Display NeighborGramTM... item. The views opens in a new browser tab.

 When a resource node has over 10 different relationships, they will be shown in groups that are "pageable" via a selector with arrows and a counter. Selecting a node shows popup controls for making it the central resource, configuring links, or expanding links.

The form in the right pane shows details of the central resource. When that resource is a class or a node shape, the form shows a Class Diagram section which contains several subsection links with the diagram options. Selecting a subsection link opens a nested form showing the resources associations in a UML-like diagram.

Viewing and Editing Information about an Asset

Information about selected asset is shown in a form, with fields organized into groups. To get to the details form, double click a row or select a row and click the details button. 

Form View Options

Create and View Tasks

If enabled, Tasks button shows a number of tasks already associated with a resource. It lets you view these tasks and create new tasks.

Create and View Comments

If enabled, Comments button shows a number of comments already associated with a resource. It lets you view these comments and create new comments.

Switching Resource View

The drop-down button to the left of Show/Hide Properties will let you switch to a different view on the selected resource, if a different view is available. For example, EDG users may create an abridged view for subject matter experts that only shows some properties while the full view will show all properties. The form will present a default view for your role, but let you switch to other views.

Show/Hide Properties

When selecting Hide Properties button above, the details form below will only show properties that have data values. The button will then flip to Show Properties to put it back to seeing all available properties and sections in the form. This option will be remembered next time you enter the form. 

Property Descriptions

Selecting the "Display descriptions of the properties" button will show a description underneath each property on the form. 

Display Form Sections as Tabs

Selecting "Display form sections as tabs" button above will convert the form view to separate each section into it's own tab.

Checking data quality via Problems and Suggestions

When the Show Problems and Suggestions button  at the top of the form is selected, form will display any issues that are found with the selected resource together with suggestions on how to fix them. It will also display some additional facts TopBraid EDG finds with some degree of certainty - for example it may suggest a connection between a data element and a business term. You can then accept the suggestion or ignore it. When the Show Problems and Suggestions button  is de-selected, checking of values and making suggestions will happen only when information is modified and saved or when a user decides to run Problems and Suggestions report for the entire collection. This setting acts across all of the user's collections.

Show History

The Show History checkbox at the top of the form toggles the display of all saved changes made to the asset since it was first created. It lets you to undo or "revert" the changes back to what they were previously.

 

Find similar...

The Find similar... (plus) button at the top of the form page.

It takes the current instance as a "template" allows users to select which properties they want to match against. For example, "find every other city that is in Germany" when you have Berlin selected.

The results page shows applied filters and entities matching the filtering.

Editing Information about an Asset

This section describes how you can change information about an asset. If you have Editor privileges for a collection, you can perform edits directly in it. All changes will be immediately visible to all users. Alternatively, you can start a workflow and take changes through the review and approval process. These changes are only available in the context of your workflow.

Start Workflow button is available from the form as well as from other EDG pages. 

#IF-NOT ONTO

Editing in the Table

You can edit directly in the table by clicking on the pencil icon displayed when mousing over cell values. After making changes, click on the green checkbox  icon.  This option is not available for ontologies.

Another option for making changes directly from the table is available under More > Batch Edit. It requires selecting multiple rows to modify.

#ENDIF

Editing using the Form

The most convenient and comprehensive way to edit is by using asset's form. The default viewing mode for the form shows only the properties of an Asset that currently have values. You can use Show/Hide Properties toggle button to also show properties that have no values - as shown below.

 

Users with sufficient permissions can edit information in two ways: (1) per individual property via the pencil icon  that pops up as the cursor moves over a property; (2) all information on the form by pressing the Edit button  at the top of the page. 

Clicking a property's popup pencil icon  lets you edit "inline" values of that property. Note that inline editing is only for direct properties, not for nested ones.

The Edit-button  opens all properties for editing. It will respect Show/Hide Properties option and depending on selection can open for edit only populated fields or all fields. 

The Edit-button mode also lets you log a message with the saved changes. The log message is saved with the history of the change and can be seen from the change history report as a comment and also at the inline change when selecting show history in the form.

NOTE: When finished with Edit mode, be sure to click either the Save Changes or the Cancel button.

When entering a value for a relationship, you have the following options:

  1. Start typing the name of the related resource and pick it from the auto-complete list
  2. Use Select using search dialog ... This is useful if you are not sure what laters the related resource's name starts with. As shown below, clicking on this option opens the search panel where you can use all the search functionality to find a resource you want to connect to.
  3. Use Create new ... This will open the Create dialog. It will create a new resource and connect to it.




If a property value is inferred, it will not be editable, unless the inference is only set to calculate default values which can be overwritten by edits. If property values can't be edited, you will not see the pencil icon and it will not be opened for editing after you click Edit button.

If a property value comes from an included asset collection, you will not be able to delete or modify it. You will, however, be able to add new values. The exception to this is when a property can have only one value. Then, since you can't modify existing value, you will not be able to perform any edit operations.

Editing using the Source Code panel

You may see a button to display the Source Code panel. This button is positioned on the right of a form when a form is displayed full width - without the tree component on the left.

If you do not see the source code, it means that your EDG administrator disabled it server-wide or it is disabled for your governance role.

Source Code shows RDF serialization of asset's information. 


You can edit the source code directly and press Save Changes after making changes. This is a low level operation that should only be performed if, for some reasons, you can't make changes in the form. And only by technical users comfortable with modifying RDF. Doing this is rarely necessary.

Deleting Assets

To complete remove a resource, you can select a Delete button from the results table or from the form.

You will be given a confirmation message before proceeding with the delete.

JIRA Launch-in-Context

If the JIRA LiC 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 simultaneously logged into JIRA, they can launch from editor resources into related JIRA searches and new items in the collection's corresponding JIRA project. On a selected resource, use the gear button  in the details pane to select any of the following: Create JIRA Issue, Search URI on JIRA, or Search label on JIRA. The two searches will open (as browser popups) 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.

  • No labels