Skip to end of metadata
Go to start of metadata

Page Contents

View or Edit

If a Content Tag Set is associated with some governance area, every user with any governance role in this are will be able to view it, at least. For any other user to view or edit assets contained in a Content Tag Set, a manager must use the Content Tag Set's utilities > Users settings (see documentation) to grant them permissions.

Note that different workflows that process changes to a Content Tag Set can have their own permission-profile settings (for background, see Workflow Overview: Permissions for Production Collections ...).

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.

Content Tag Set Editor

From a content tag set's main screen, click Edit Production Copy to edit it. (You can also work with a temporary copy of the production tag set known as a Working Copy; see User Roles and Workflow for more on the use of working copies.)

Whether you are editing a working copy or a production tag set, the interface is the same. The following screen shot shows EDG Tagger with a Tag Set named "December article subjects":

The following steps are a typical workflow to tag content:

  1. Choose a class where the content instances are located. Choosing a class contextualizes the search. If you do not know the class of the content resource, choose the root class and search from there.
  2. Set the search criteria and select the "Search" button. In this example, no search criteria was selected, so all instances of the selected class are displayed. Adding search criteria will narrow the search to the specified property values.
  3. Select an instance in the Matching Instances window. The data for the selected instance will appear in the middle pane, which is named after the label of the chosen instance.
  4. Navigate to a term in the Concept Hierarchy. Any term in any level of the hierarchy can be chosen. When chosen, the term's data will appear in the named pane beneath Concept Hierarchy.
  5. Choose the tag property from the drop-down list.
  6. Click the green '+' button to add the tag. This adds the tag triple and displays the tag in the movable Current Tags widget. To remove a tag, click the red 'x' next to it.

In this example the content, whose label is "Three Musicians", has just been tagged with the vocabulary term 'arts, culture and entertainment' on the property "Subject". The screen shot also shows two previous tags stating that the content item is related to the vocabulary term "musical performance" and 'food and drink' by the property "Subject". Informally, the tags are saying that the article "Three Musicians" has three subjects, 'arts, culture and entertainment', 'food and drink', and 'musical performance'.

The Tagger screen

The Tagger main screen has six panes. Note the color-coding of the pane tabs, with the content on the left and vocabulary on the right. The color coding is displayed in a key in the EDG Tagger header.

  • Content Types The upper-left of the Tagger screen shows the hierarchy of content being tagged, because content resources are often grouped according to their class of content. Selecting a node on the hierarchy lets you limit the content resources displayed on the Matching Instances list.

  • Search Instances of Content The search form under the Content Types pane lets you narrow down the content resources you want displayed in the Matching Instances pane based on search criteria that you enter on this form. If you don't enter any criteria and just click the Search button, all of the content resources associated with the selected node in the Content Types hierarchy will be displayed in the Matching Instances pane.

  • Matching Instances Use this list in the lower-left to identify the content resource to tag; selecting one displays metadata about it in the Content Properties pane where you can then tag it.

  • Instance Form The pane down the middle of the screen displays data from the item selected from Matching Instances in a property-value form.

  • Current Tags Widget Displays tags currently assigned to the content resource. The subject of a tag triple is the instance in the form behind the Current Tags. The property is selected from the drop-down list inside the Current Tags widget and in the top line of an assigned tag. The object of a tag triple is the vocabulary instance shown in the Concept Instance pane or the hyperlink in an assigned tag.

  • Concept Hierarchy The pane in the upper-right shows the concepts available for tagging content. These are typically arranged in a hierarchical taxonomy and maintained by TopBraid Enterprise Vocabulary Net (EDG). The hierarchy shows up to 1000 nodes.

  • Concept Instance This pane in the lower-right displays the instance data from the Concept Hierarchy pane in a property-value form.

Tagger panes can be resized by dragging the separators between them. Double-click the dark strip in the middle of a separator to minimize the pane next to it. (After doing so, the separator will appear at the edge of the screen; click the dark strip to restore that pane.)

Recommended concepts for a single document

If the AutoClassifier feature has been installed and trained, then users can request automatically recommended tags for specific content items. When editing a content instance, users can click the light bulb-shaped button Recommend Concepts, located in the top-right title bar of the Concept Hierarchy pane:

This retrieves a list of candidate concept tags that AutoClassifier recommends for the instance, along with each candidate's confidence value:

 click image to enlarge

Clicking one of the recommended concepts will jump to it in the concept hierarchy and show its details in the bottom-right pane. To assign a recommended concept as a tag, use the “plus” button in the Current Tags panel.

The listed recommended tags will not include tags with a confidence value below the minimum threshold that was set in the AutoClassifier configuration panel.

Manually tagging documents

When a particular content resource is selected, the Current Tags list on the Content Properties pane shows any tags currently assigned to it and each tag's relationship to that content resource. To add a new tag,

  1. Select the content resource that you want to tag in the Matching Instances pane and the concept to tag it with in the Concept Hierarchy pane.

  2. At the bottom of the Current Tags list, a drop-down list lets you select the tag property that describes the relationship you want to define between the content resource and the concept that you have selected. If the currently displayed property is what you need, you can skip to the next step.

  3. Click the "Add selected concept as tag" button  to add a new tag associating the concept with the content resource using the selected tag property.

In the screen shot above, we can see that the content resource with a title beginning "One year on" has just been tagged with a Subject value of "demonstration."

To remove a tag, click the "Delete this tag" button  on the tag.

Should you need recommendations for selecting appropriate tags, e.g. if you are unfamiliar with the available concepts, you may use the Recommended Concepts feature to select concepts from a subset.

Basic Search Form

The basic search form provides many options in how you search and what you can do with your search results. For the selected class, the search form has a field for each property that you can add to it using the Filters dropdown in the upper right of the form. One can use a combination of fields to match instances only on those properties. Properties with two hyphenated fields allow one to search on a range of values. The Search any Text field matches on any property of an instance (See the Configuring Search Text Properties section in the Developer Guide for how to add this field to the search form for a given class and configuring which properties it should search). Each resulting instance must match all of the form's user-entered values (AND operator). Selecting Return local results only will deliver only resources whose rdf:type triple is in the base graph, thus excluding resources from included graphs. This search option will be presented if the vocabulary/asset manager has not pre-selected a choice.


Property matching

For each property, one can specify the type of match. Different properties can use different match types, all combining together to produce an overall search result.

Type of MatchHow a search value matches instance property-values
text contains

Text DEFAULT: Search text is a substring of a property- value (case-insensitive). Example: Search text "lis" on a city-name property would match instances having city-name values such as "Lisbon", "Lisboa", and "Minneapolis".

text equalsSearch text is exactly the same as a property- value (case-sensitive)
text matches regular expressionSearch text is 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.
any valueAt least one value exists for the search property (count >= 1). Example: See how extensively a property is used.
min/max number of valuesThe number (count) of property-values (occurrences) is within the search range, inclusive. Example: If most instances in a Content Tag Set have labels in three languages, entering a label search with values-range 0 to 2 would return those instances with fewer.
no valueNo values exist for the search property (count = 0). Example: Use to clean up a Content Tag Set and check for remaining work.
booleanBoolean DEFAULT: Search values restricted to true/false instead of free-text
equalsClass DEFAULT: Quick-search field for finding an instance of the property (object)
nested formAdds an embedded search form for properties whose type is another class
label matches regular expressionSearch text is a regular expression that matches the label of a property-instance (object)

Searching by relationship values

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 entities that begin with the typed letters.

The triangle next to each relationship field displays a menu that gives you several options for how EDG uses the value you enter in that field to search your reference data. The options are similar to the ones described above with a couple of exceptions: regular expression search is not available, but there is a nested form search option:

  • nested form displays a form denoted in dark gray where you can describe specific details about the items with the specified relationship to the data you're searching for.

  • label contains indicates that you want to search for codes that have the entered string anywhere in the label value for this resource. For example, if you search market identifier codes whose mic Country property has "land" in it, EDG will return resources with values such as Thailand, The Netherlands, and Switzerland.

  • any value indicates that you want to search for codes that have any value at all for this property.

  • min/max number of values search for any code whose number of values for this property fall in the range specified by the one or two numbers you enter.

  • no value indicates that you want to search for resources that do not have a value set for this property.

Displaying Columns in Results Tables

Columns in the results table are configured by properties

The columns displayed in the central results table are determined by a setting on each property in the search form. The display selector is located between each property's label and search field(s), and the display setting is independent of whether the property is used in a search.

This property will appear as a column in the results table
... (ellipsis)This property will not appear as a column in the results table
# (hash/number)

This property will appear as a count column in the results table (showing the number of property-values)

To change the table's columns, select or unselect fields in the search form (also see:  gear-button > Unselect all columns, below) and then press the Search button. The order of properties in the form determines the column-order of the table.

Setting the default columns

In subsequent editing sessions, the column settings will revert to their defaults. However, a manager can reconfigure the default for all users by selecting the columns and then clicking on the star button  at the bottom of the Search form. This preserves the current settings as the new default for all users.

A recommended practice is to set default columns (properties) on an ontology class, which is subsequently included by other vocabularies or assets, such as reference datasets. The resulting instance tables will have the ontology class's column settings as their initial default, which can then be overridden if desired.

Search Results Operations

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

  • Batch edit search results... lets you edit property values for all the search results together. See Editing multiple codes together for further information.

  • Display chart of search results... generates a chart of your search results from your choice of formats.

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

  • Export results to SPARQL JSON file creates a text page of results in SPARQL Query Results JSON format.
  • Export results to SPARQL TSV spreadsheet creates a tab-separated value version of the search results that includes the URI of the resource represented by each result row in the first column. URIs are delimited by angle brackets.
  • Export results to SPARQL XML file creates an XML version of the search results that conform to the W3C SPARQL Query Results XML Format.

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

  • Open faceted search dialog... displays a dialog box that lets you do a faceted search over the reference data for the selected entity.

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

  • Unselect all columns clears all selected columns (check-marked or hash-counted) in the form, which removes all non-default columns from associated search-result tables.

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

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

Editing multiple results together

After executing a search with the search form, the Batch edit search results choice on the search form's gear menu  lets you edit all the search results at once with a single form.

For example, when selected after searching for all country codes that became valid in 1991, this menu choice displays the following form in a dialog box:

The form displays only values that all of the results have in common - in this case only the value for the "valid since" property. If you change this value, the change will apply to all resources in the search results. Any new values you will add will also apply to all search results.

Common values can be deleted all at once by clicking the X to the right of the value on the batch edit form, and new values can be added by entering them the displayed fields before clicking the Save Changes button.


Saving Searches

In the lower-right of the search pane, two buttons let you save and retrieve searches for later execution. In addition to executing these searches from within EDG, the saved search servlet lets other applications execute saved searches by using the appropriate URL. The "Save current search" button  displays a dialog box where you enter a name for the search that you'd like to re-use later. The "Show saved searches" button  displays a list of saved searches.

This dialog box has three buttons at the bottom:

  • The Select button closes the dialog box and fills out the search pane with the parameters set by the selected search so that you can execute it.

  • The Delete button deletes the selected search from the list of searches.

  • The Close button closes the dialog box.

Selecting a saved search on this dialog box also displays a URL in the Service URL (for copy and paste) field that can be used to retrieve the search results from another application that has HTTP access to EDG. This can be a browser, Excel (after picking Open from the File menu), or any application that can make a RESTful API call. (The default format of the returned data is comma-separated values, but this can be modified in the URL.)

Saved searches will also be available on the Export Saved Search list available via the Export tab.

  • No labels