What are Terms?
Terms are relational descriptors that can be used to annotate Items in the Exchange.ai Portal. Terms infer relationship (from other terms) and can also expose metadata fields to that item through Term Properties. Term Properties can be added to a Term so that all items with that Term inherit those Term Property fields. The relations between Terms and the Term Properties are defined by users with the Curator role. Once a collection of items is annotated with a Term that Term can be used to find all relevant items via a search.
For example, the Article Term may have a URL Property. Any item added to the Exchange.ai Portal can then be annotated with the Article Term which will expose the URL Property field for that item.
What is Term Scope?
Terms within the Portal are grouped into Public and Private Scopes. Publicly scoped terms can be used by all curators on the Portal to annotate their content. Privately scoped terms can only be used by curators of the organization that created them. In this way an organization can have a set of terms that are specific to their organization allowing for custom properties and searches using these private terms.
After selecting Terms from the toolbar, the user is presented with the Terms Panel:
+ Request New Term (Not visible to users with Curator or Master Curator roles)
||Request a new Term for your Organization or for the Core (Public) Term Graph.
||Filter the table of terms by different scopes. Public terms (visible and searchable by all Portal users) are administered by Ruths.ai and select users with the Master Curator role. Private terms (visible and searchable only by your org only) are administered by your org curators.|
||Each available Term is displayed here. The exposed fields can be sorted. Clicking on a Term name will bring the user to the Term View page (discussed below). There are various actions the user can take within the Term Table.
By clicking on a term name from the Term Table users are taken to the Term View page. The Term View page is used to graphically explore how Terms are related and discover what relationships exist. For curation of Terms, see below for Curator roles.
Curating Terms (Curator and Master Curator Roles Only)
Users in the Curator or Master Curator roles are able to curate Terms. Curating terms includes adding, editing, and removing terms as well as defining relationships in the term graph, adding properties to terms, and annotating terms to items.
Add, Edit, and Remove Term
From the Terms Panel, users in the Curator or Master Curator roles are able to Add, Edit, and Remove Terms with the +New Term button and the Edit, Remove Actions:
Clicking on +New Term button will open the New Term Form:
|Name||Name of the new Term.|
|Definition||Description of the Term.|
|Synonyms||Add Synonyms to the Term (e.g. Texas, TX). These synonyms will help to populate term suggestions while searching.|
|Scope||Selects the scope to which the Term will be added.|
Define Relationships between Terms
From the Term View Page, users in the Curator or Master Curator roles are able to curate Term relationships with the +Add or Edit buttons. Clicking the +Add or Edit buttons will open the Relationship Modal:
|Child Term (first drop-down)||The Child Term (first drop-down) is the term that will be edited with the current action. This should be populated with the Term the Curator has already clicked on.|
|is a OR is part of (second drop-down)||Use the "is a" relationship when the Active Term is a Target Term (Data Science is a Field of Study).
Use the "is part of" relationship when the Active Term is part of Target Term (Statistics is part of Data Science).
|Parent Term (last drop-down)||The Parent Term (last drop-down) is the term that the Child Term has a relationship with.|
|Create + Add Another||Clicking this button will confirm the relationship and allow the Curator to add another relationship.
Cancel will exit the modal.
Adding Properties to Terms
From the Term View Page, users in the Curator or Master Curator roles are able to curate Term Properties with the +Add or Edit buttons.
|Type||Data Type of the Property. (Text, Boolean, Time, URL, Script, etc.)|
|Name||Name of the Property. (This field is used to uniquely identify this property for the Exchange.ai API. It should be descriptive and unique across Properties)|
|Display Title||The property name that will be shown to the user.|
|Description||Description of the Property.|
Create + Add Another
||Clicking this button will confirm the relationship and allow the Curator to add another relationship.
Cancel will exit the modal.
Annotating Items with Terms
From the Item View Page, users in the Curator or Master Curator roles are able to annotate Items with Terms with the Annotate icon. NOTE: This icon will only be visible Curator or Master Curator roles.
After clicking this icon, the Curator is shown the Annotation Modal:
|Current Terms||A list of Current Terms. Clicking the "X" on a Term here will remove the Term from annotation.|
|Recent Terms||A list of recently used Terms. Clicking the "+" on a Term here will add the Term to the list of annotated Terms for this Item.|
|Terms Table||Each available Term is displayed here. The exposed fields can be sorted. Clicking on Add next to Term name will add the Term to the Item. Terms can be filtered by Public and Private terms by using the filter toggles:
|Create New Term||Clicking Create New Term will extend the modal to expose the form for adding a new Term (as discussed above).|
|Close||Close will close the modal.|