Semantic entities

The semantic entities package offers a new feature that automatically identifies place, organization and person entities from the document and complete link the document to these entities. This feature aims at automatically propose complementary information to users and easily have access to documents related to the same entities.

Note
On Nuxeo DM 5.4.0.1, this package requires the prior installation of hotfix package "DM-5.4.0.1-HF01". Should this package not be installed, entities won't be available on PDF documents.

Consult the entities linked to a document

An entity is a document available in Nuxeo DM in an "Entities" root folder, just like "Workspaces" or "Sections" root folders. There are three types of entities: person entities, place entities and organization entities. When a document is created or edited, the system identifies the entities in the document. For each entity identified, it checks if the entity exists in a remote database (DBPedia) and, if it does, creates it with the DBPedia informations about the entity. If the entity doesn't exist in DBPedia, the entity is created empty in the application. Finally, the system automatically links the document with the entities it found in the document.

When you consult a document, the entities linked are displayed on the Summary tab of the document. Users can then click on an entity's name to read more about this entity and see if other documents are linked to this entity.

Info
The creation of entities by the system and linking them to the document is done by the system after the document is actually created or edited. As a consequence, entities are not immediately available on the summary tab of the document.

Edit the entities available on the documents

Links between the document and the entities are automatically added by the system. However, users can add or remove entities links.

Link a document to an entity

You need to have "Write" right on documents to be able to link them to entities.

You can link documents and entities from the document and from the entities.

Panel

bgColor	#FFFFFF
1	borderStyle:dashed
title	To link a document to an entity:

From the document

Click on the document to consult it.
The document's Summary tab is displayed.
Type the name of the entity in the Link to a new entity box.
Click on the correct suggested entity.
The entity is now displayed on the Summary tab of the document.
You can click on it to read more about it, and see if other documents are also linked to it.

From the entity

Go on an entity.
- by clicking it from a document
- by clicking it from the Entities' Content tab.
  The entity's Summary tab is displayed.
Type the title of the document you want to link the entity to in the field Add a new occurrence.
Click on the document in the suggestions.
The document is added to the lists of documents in which the entity occurs.

Remove an entity link

You need to have at least Write right to be able to remove a link between an entity and a document.

To remove a link between a document and an entity, from the Summary tab of the document, click on the icon to remove the link between the entity and the document.
The entity is not displayed on the Summary tab of the document. The entity is still available in the Entities space and can be linked to other documents.

Manage entities

You can browse entities in the Entities space, at the root of your application. Users with write access rights in this Entities space can create, edit and delete entities. Users with Manage everything access rights on the Entities space will be able to manage the Entities space like any other space.
Below is described the steps to create a new entity, which are specific. You can refer to the Nuxeo DM user guide for edition, deletion and space management steps.

Panel

bgColor	#FFFFFF
borderStyle	dashed
title	To create a new entity:

In the Entities space, click on the New entity button.
Click on the type of entity you want to create: person, place or organization.
Fill in the creation form (see below for the parameters details).
Click on the Create button.
The entity is created and its Summary tab is displayed.
You can now link it to documents where it occurs.
Possibly, synchronize the newly created entity with the remote knowledge base to automatically get the information available online:
- Click on Add link to remote entity.
- Search the entity using the textarea displayed.
- Click on the entity in the suggestions.
  The link is added and the information are imported in Nuxeo.
  
  Tip
  If the entity doesn't have the same name on the remote knowledge base and in Nuxeo DM, it automatically takes the remote KB name.

Organization entity parameters

Field	Description
Name	Name of the organization.
Summary	Optional text about the organization, for instance its responsibilities or its expertise area
Depiction	Picture describing the organization (logo for instance)
Also known as	Possible other spellings of the organization's name.
Inception date	Date at which it was created.
Dissolution date	Date at which the organization was closed.

Person entity parameters

Field	Description
Name	Name of the person.
Summary	Optional text about the person, for instance a brief biography.
Depiction	Picture of the person.
Also known as	Possible other spellings of the person's name.
Birth date	Select a date using the calendar.
Death date	Select a date using the calendar.

Place entity parameters

Field	Description
Name	Name of the place.
Summary	Optional text about the place, for instance a brief history.
Depiction	Picture describing the place.
Also known as	Possible other spellings of the place's name.
Latitude	Type the coordinates of the entity, for information.
Longitude	Type the coordinates of the entity, for information.

All Nuxeo DM documentation versions

Nuxeo DM 5.4

Semantic entities

Versions Compared

Old Version 8

New Version 9

Key

Consult the entities linked to a document

Edit the entities available on the documents

Link a document to an entity

Remove an entity link

Manage entities