Child pages
  • CE 15-EDITOR-10.A ["EDG"] Table
Skip to end of metadata
Go to start of metadata

#IF-NOT ONTO

Searching and Browsing in $ModelTypes

#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 for 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 $ModelType 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 $ModelType 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.
  • No labels