Skip to main content

Glossary

Overview

This glossary defines the terms and concepts a user meets across Uwazi.

Terms group by product area. Within each area, entries run in alphabetical order for fast lookup. Bold text marks the term. A label in a definition such as Library points to a feature you see in the interface.

Content and structure

These terms describe how Uwazi stores and organizes content.

TermDefinition
Common propertiesThe three reserved fields on every template: Title, Date added, and Date modified.
EntityThe main unit of content in Uwazi: a record with a title, metadata, files, and relationships.
Generated IDAn auto-generated identifier in the format XXX-XXXX-XXXX, available as a Title option.
MetadataThe set of property values on an entity, such as its dates, locations, and linked records.
PropertyA single typed field on a template, such as a date, a number, or a link. Also called a metadata field.
Property typeThe kind of value a property holds, such as Text, Date, or Select.
TemplateThe structure that defines the fields for one type of entity. Also called an entity type.
ThesaurusA reusable list of values that Select and Multiple select properties draw from.
TitleThe required name of an entity, shown across the library and search results.
ValueA single option in a thesaurus, such as one country in a list of countries. Also called an item.

Property types

A property type sets the kind of value a property holds. The table lists the types a user meets when building a template.

TypeStores
DateOne date.
Date rangeOne start-and-end date pair.
Generated IDOne auto-generated identifier.
GeolocationOne latitude and longitude point for the map.
ImageOne image, uploaded or by URL.
LinkOne web address with an optional label.
MediaOne video or audio file, with optional time segments.
Multiple date rangesA list of date pairs.
Multiple datesA list of dates.
Multiple selectMany values from a thesaurus.
NumericOne number.
PreviewNo value; it shows a related document's thumbnail.
RelationshipLinks to one or more other entities.
Rich textOne formatted text value written in Markdown.
SelectOne value from a thesaurus.
TextOne line of plain text.

For each type's options, filtering, and constraints, see the property types reference.

Documents and files

These terms cover the files a user attaches to an entity.

TermDefinition
AttachmentAny extra file on an entity that is not its main document. Also called a supporting file.
DocumentThe main PDF attached to an entity, searchable by its full text.
Full textThe text Uwazi extracts from a PDF, which makes the document searchable.
OCROptical character recognition, a service that reads text from scanned PDFs.
ReferenceA link between a highlighted passage in a PDF and another entity. Also called a text reference.
Table of contentsA list of sections built from a PDF, shown beside the document.
ThumbnailA small preview image generated from a document's first page.
Time segmentA start-and-end marker on a media file that points to part of a video or audio clip.
warning

A document can hold up to 300 text references.

Relationships

These terms describe how Uwazi connects entities to each other.

TermDefinition
ConnectionA single link between two entities, created through a relationship.
Inherited propertyA field from a related entity, shown inline on the source entity.
RelationshipA link between two entities, or between a passage of text and an entity.
Relationship typeA label that describes a relationship, such as "represents" or "authored by".

These terms cover how a user browses and finds entities.

TermDefinition
Cards viewThe default library layout, which shows each entity as a card.
Default filterA filter that the library shows open without expanding the filter list.
FilterA sidebar control that narrows the library by a property value.
Full-text searchA search across the text of documents and the titles of entities.
LibraryThe main page for browsing, searching, and filtering entities.
Map viewA library layout that plots entities with a geolocation on a map.
Priority sortingA property set as the library's default sort order.
RelevanceA sort order that ranks results by how well they match the search.
Table viewA library layout that shows entities as rows in a table.

Users and permissions

These terms describe who can see and change content.

TermDefinition
Activity logA record of important actions in the collection, available to admins.
AdminA role with full access to all content and to every setting, including users.
CollaboratorA role that creates and edits its own or shared entities but can't publish them.
EditorA role with full access to all entities and publishing, but not to system settings.
GroupA named set of users that share the same entity permissions.
PermissionAn entry that grants a user or group read or write access to an entity.
PublishedAn entity that everyone can see, including signed-out visitors on a public instance.
ReadA permission level that lets a user view an entity but not change it.
RestrictedAn unpublished entity that the current user can't open or find.
RoleA collection-wide access level: Admin, Editor, or Collaborator.
ShareThe action of granting a user or group access to an entity.
Two-factor authenticationA second sign-in step using a one-time code from an authenticator app. Also called 2FA.
UserA person with an account on the instance.
VisitorA signed-out person who sees only published content on a public instance.
WriteA permission level that lets a user view and edit an entity.

Languages and translation

These terms cover how Uwazi handles many languages.

TermDefinition
Automatic translationA service that translates chosen template fields into the collection's languages.
Content translationA translation of entity and thesaurus content, such as titles and values.
Default languageThe main language of the collection, used when no other applies.
Inline translationA mode that translates text directly on the page as a user edits it.
LanguageOne of the languages a collection publishes content in.
RTLA right-to-left language, such as Arabic or Hebrew, that the interface adapts to.
System translationA translation of the Uwazi interface labels and messages.

Pages and navigation

These terms cover custom pages and the navigation menu.

TermDefinition
Basic pageA page that uses HTML and can embed maps, charts, and entity lists.
Entity view pageA page set as the display layout for entities of one template.
Landing pageThe first page a visitor sees, which defaults to the library.
MenuThe links in the top navigation bar, set under Settings.
PageA custom web page in the collection, with its own content and address.
ReleaseA published version of a page that a user can restore later.
Rich pageA page that uses Markdown for simpler, text-based content.

Collection and settings

These terms cover instance-wide configuration and branding.

TermDefinition
AnalyticsSettings that connect the collection to Google Analytics or Matomo.
Character supportA setting that improves field names for non-Latin scripts.
CollectionA single Uwazi deployment, with its own templates, entities, and settings. Also called an instance.
Cookie policyA setting that shows a cookie consent banner to visitors.
Custom CSSA setting that adds custom styles to the collection's appearance.
Custom JSA setting that adds custom JavaScript to the collection.
Date formatThe setting that controls how dates appear across the interface.
FaviconThe small icon shown in a browser tab for the collection.
FavoriteA personal bookmark that marks an entity for quick return.
Map providerThe map service used for geolocation display: Mapbox or Google.
Public instanceA collection where anyone can view published content without signing in.
SettingsThe area where admins configure the collection.
Site logoThe logo shown in the top navigation bar.
SyncA feature that pulls content from another Uwazi instance.
Synced templateA template that comes from a sync and that the receiving instance can't delete.
Theme and brandingThe settings that control the collection's colours, logo, and favicon.
warning

A public instance exposes every published entity to anyone on the internet.

Information extraction

These terms cover the tools that suggest metadata from documents.

TermDefinition
AccuracyA measure of how often a suggestion matches the value a person confirms.
Auto-acceptAn option that applies suggestions to entities without a manual review.
ExtractorA configuration that pairs templates and a property with an extraction model.
Information extractionA feature that suggests metadata values by reading an entity's documents.
Paragraph extractionA feature that pulls paragraphs from documents and saves each as an entity.
SegmentationA service that splits a PDF into paragraphs for extraction.
SuggestionA candidate value that an extractor proposes for an entity's property.
TrainingThe process of teaching an extraction model from confirmed examples.

Importing and exporting

These terms cover moving content in and out of Uwazi.

TermDefinition
Custom uploadsFiles uploaded for branding, such as logos and favicons.
CSV exportA download of the current library results as a CSV file.
CSV importA bulk creation of entities from a CSV file mapped to one template.
Translations CSVA CSV file for importing or exporting the collection's translations.
ZIP importA CSV import packaged with the attachment files it refers to.

Public access

These terms cover how signed-out people interact with a collection.

TermDefinition
CAPTCHAA check on a public form that blocks automated spam submissions.
Public formA form that lets signed-out people submit a new entity using an approved template.
Whitelisted templateA template approved to accept public form submissions.