Create and connect your first entity
What you'll learn
An entity is one record in Uwazi, such as a person, a case, or an event. We'll create a new entity, fill in its details, and link it to another entity. By the end of this tutorial, we'll have added our own content to the library and connected it to a related record.
Prerequisites
- A link to a live Uwazi instance that already holds some content
- A username and password for that instance
Creating entities needs an admin, editor, or collaborator account. If you don't see the Create entity button, ask your instance manager for access.
Part 1: Create the entity
The Library is your home base. It lists every entity you can see. We'll start a new one and give it a type.
-
Go to the Library and select Create entity in the footer.
A side panel slides in from the right. It shows a Title field at the top and a Type drop-down below it.
-
Type a name in the Title field, such as
Ahmad Al-Rashid.The title shows a red asterisk because Uwazi always needs it.
-
Open the Type drop-down and select an entity type, such as Person.
The form grows to show the fields that this type carries. Each type brings its own set of fields.
Part 2: Fill in the metadata
The fields on an entity are its metadata, and the type decides which fields appear. We'll fill a few and save.
-
Type a value in a text field, such as a Role of
Witness.The text appears in the field as you type.
-
Open a list field, such as Country, and select a value.
The drop-down closes and shows your choice. A red asterisk marks a field you must fill, so give it a value before you save.
-
Select a Date field and pick a date from the calendar.
The field fills with the date you picked.
-
Select the green Save button at the bottom of the panel.
A Entity created message appears, and your new entity shows up in the library.
Part 3: Open the entity and its relationships
Now let's open the record we made and find its connections.
-
Select View on your entity's card.
The entity page opens. The title sits at the top left, and a badge showing its type sits at the top right. The metadata fills the main area as label and value pairs.
-
Select the Relationships tab, marked with an exchange icon.
A small number badge shows how many links the entity has. A new entity starts with none, so the panel reads No Relationships.
Part 4: Add a connection
A relationship links two entities, such as a person to an event. We'll add one and save it.
-
Select Edit, marked with a pencil icon, in the footer.
The page enters edit mode. New controls appear for adding connections.
-
Select New relationships group, marked with a plus icon.
A new row appears with a drop-down that reads New relationship type.
-
Open the drop-down and select a relationship type, such as Witnessed.
The Add entities / documents panel opens on the right.
-
Type in the search box to find the entity you want to link, such as
Cairo Demonstration.A list of matching entities appears as you type.
-
Select the entity you want in the results.
A short message confirms: "added to hub. Save your work to make change permanent." The entity now sits in your relationship group.
-
Select Save in the footer.
A Relationships saved message appears. Your two entities are now linked.
What you've done
- Created a new entity from the library
- Gave it a type and filled in its metadata
- Saved it and opened its entity page
- Added a relationship to another entity
- Saved the connection so it stays
Open the entity you linked to and check its Relationships tab. The connection shows on both entities, so you can travel between them either way.
Next steps
- How to create and edit an entity — create entities in bulk, edit them, and copy values between them
- How to create relationships between entities — every way to link entities, including through a metadata field
- Understanding Uwazi's building blocks — the model behind entities and relationships