Skip to main content

Property types

Overview

A property type sets the kind of value a property holds on a template.

Common properties

Every template has three reserved properties. You can't delete them, and they stay at the top of the property list.

PropertyTypeBehaviour
TitleTextRequired on every entity; supports priority sorting
Date addedDateSet once when the entity is created
Date modifiedDateUpdated on every save

The Title property offers a Generated ID option. When it's on, Uwazi fills the title with an auto-generated identifier instead of free text.

Property types

The table lists every property type, the value stored in the template configuration, what it holds, and whether it accepts more than one value.

TypeConfig valueStoresMultiple values
TexttextOne line of plain textNo
Rich textmarkdownOne formatted text valueNo
NumericnumericOne numberNo
DatedateOne dateNo
Multiple datesmultidateA list of datesYes
Date rangedaterangeOne start-and-end date pairNo
Multiple date rangesmultidaterangeA list of date pairsYes
SelectselectOne value from a thesaurusNo
Multiple selectmultiselectMany values from a thesaurusYes
RelationshiprelationshipLinks to other entitiesYes
LinklinkOne URL with an optional labelNo
ImageimageOne image, uploaded or by URLNo
MediamediaOne media file, uploaded or by URLNo
GeolocationgeolocationOne latitude and longitude pointNo
Generated IDgeneratedidOne auto-generated identifierNo
PreviewpreviewNo value; shows a document thumbnailNo

Configuration options

Each option below appears in the property side panel for the listed types.

OptionDescriptionAvailable for
LabelThe name shown for the propertyAll types
Hide labelHides the label when an entity is displayedAll types
RequiredMakes a value mandatory on every entityAll types except Preview
Show in cardsShows the property on library cardsAll types
Use as filterAdds the property to the library filtersText, Rich text, Numeric, Date, Multiple dates, Date range, Multiple date ranges, Select, Multiple select, Relationship, Generated ID
Default filterShows the filter without expanding the filter listSame types as Use as filter
Priority sortingSets the property as the default library sortText, Numeric, Select, Date, Relationship
StyleSets image fit to Fill or ContainImage, Media, Preview
Full widthDisplays the image across the full widthImage, Media, Preview
ThesaurusThe thesaurus that supplies values (required)Select, Multiple select
Relationship typeThe connection type used for the link (required)Relationship
EntitiesRestricts related entities to one templateRelationship
Inherit propertyShows a property from the related entity inlineRelationship

Type-specific options

Select and multiple select

Both types need a Thesaurus. Values come from that thesaurus, and Uwazi checks each value against it. Labels resolve to the reader's language from the thesaurus translations.

Relationship

A Relationship property needs a Relationship type. The optional Entities option limits related entities to a single template. Once you set Entities, the Inherit property option shows a chosen property of the related entity inline on the source entity.

Relationship properties in one template that share the same relationship type and target template always hold the same values.

Image, media, and preview

These types share the Style and Full width options. Style sets the image fit to Fill or Contain. Media also supports video time segments.

Filtering, search, and sorting

The table shows which types appear as filters and how Uwazi matches their values.

TypeFilterableSearch behaviourPriority sorting
TextYesExact term matchYes
Rich textYesExact term matchNo
NumericYesNumber rangeYes
DateYesDate rangeYes
Multiple datesYesDate rangeNo
Date rangeYesStart and end rangeNo
Multiple date rangesYesStart and end rangeNo
SelectYesValue match with facet countsYes
Multiple selectYesValue match with facet countsNo
RelationshipYesValue match with facet countsYes
Generated IDYesExact term matchNo
LinkNoNo
ImageNoNo
MediaNoNo
GeolocationNoPlotted on the library mapNo
PreviewNoNo

Select, Multiple select, and Relationship filters also show faceted value counts in the library sidebar.

Language behaviour

Translatable types store a separate value for each language. Synced types copy one value across all languages on save. Label-only types share one value, but their displayed label translates on its own.

TypeTranslatableSynced across languages
TextYesNo
Rich textYesNo
NumericNoYes
DateNoYes
Multiple datesNoYes
Date rangeNoYes
Multiple date rangesNoYes
SelectLabel onlyYes
Multiple selectLabel onlyYes
RelationshipLabel onlyYes
LinkYesNo
ImageYesNo
MediaYesNo
GeolocationNoYes
Generated IDNoNo
Preview

For Select and Multiple select, the label comes from the thesaurus translation for the active language. For Relationship, the label comes from the related entity's title in that language. You translate a thesaurus under Settings > Translations, not on each entity.

For Link, both parts are translatable. Each language stores its own URL and label, and the two can differ per language.

Constraints by type

The table lists the main validation rules and limits for each type.

TypeConstraints
TextHolds one value. Empty values are removed.
Rich textHolds one value. Interchangeable with Text on an existing property.
NumericAccepts integers or decimals. Empty input removes the value; zero stays.
DateHolds one date, stored as a timestamp.
Multiple datesHolds many dates. Empty entries are removed.
Date rangeNeeds a start or an end. The end can't come before the start.
Multiple date rangesEach range needs a start or an end. The end can't come before the start.
SelectNeeds a thesaurus. The value must exist in that thesaurus.
Multiple selectNeeds a thesaurus. Duplicate values are removed.
RelationshipNeeds a relationship type. Related entities must already exist.
LinkThe URL must include a scheme. A label needs a URL.
ImageAccepts an uploaded file or a valid URL.
MediaAccepts an uploaded file or a valid URL. Supports video time segments.
GeolocationLatitude ranges from -90 to 90; longitude from -180 to 180.
Generated IDAuto-filled in the format XXX-XXXX-XXXX. Existing entities are backfilled.
PreviewStores no value. Shows the entity's main document thumbnail.
warning

A property's type can't change after you create it. To switch type, delete the property and add a new one, which removes its stored data.

Property names and uniqueness

Uwazi generates a property name from its label. The name uses lowercase letters, numbers, and underscores. Geolocation names end in _geolocation.

A property name is unique within its template. You can't delete a property that another template inherits.

Shared properties across templates

When two templates give a property the same label, Uwazi treats them as one shared property and keeps their configuration in sync. The type must match. Select and Multiple select must also use the same thesaurus. Relationship must also use the same relationship type, target template, and inherited property. The Save button stays disabled until the settings match.

The examples below show which shared labels Uwazi allows or blocks:

  • Allowed: a Country Select property points to the same Countries thesaurus in both the Case and Event templates.
  • Blocked: the Case template defines Country as Select, and the Event template defines Country as Text, because the types differ.
  • Blocked: both templates define a Country Select property, but each points to a different thesaurus.

To configure two properties on their own, give them different labels.

Export behaviour

CSV export includes every property type except Preview.