Traits de base

Les traits sont des blocs de construction utilisables pour ajouter des caractéristiques à l'entité de base.

On regroupe dans cette page des traits simples couramment utilisés pour étendre les caractéristiques des entités accessibles à l'utilisateur pour * leur identification * leur documentation * leur annotation

D'autres implémentation plus complexes sont documentées dans des pages dédiées.

Identification fournie par l'utilisateur

Ce trait permet d'attribuer un identifiant fourni par l'utilisateur à une entité. Ce mécanisme permet à l'utilisateur de constituer un référentiel contrôlé dont les entités peuvent être identifiées sans ambiguïté au sein et en dehors du système pour leur utilisation dans les processus.

Diagramme de classe des objets identifiés par l'utilisateur

Propriétés des entités à identifiant fourni par l'utilisateur

`identifier` : Identifiant fourni par l'utilisateur

L'identifiant fourni par l'utilisateur contient l'identification de l'entité du point de vue des métiers. Cet identifiant doit être unique dans le référentiel d'entité. Il est attribué par l'utilisateur et reste modifiable tant que l'entité est en copie de travail, puis immuable après sa publication.

Documentation des entités

Ce trait permet de gérer de la documentation associée à une entité.

Il s'agit par exemple de fournir un intitulé pour les entités ou pour leurs attributs, des descriptions, de l'aide contextuelle ou encore de exemples.

Diagramme de classe des objets comportant de la documentation

Propriétés des entités documentées

`displayName` : Nom affiché

C'est le nom affiché à l'utilisateur pour faciliter l'identification et la compréhension de l'information contenue. Parfois mentionné comme "nom d'affichage", "libellé", "intitulé".

`description` : Description

C'est une description de l'information, destinée à faciliter la compréhension de l'information contenue. Elle peut faire office d'aide contextuelle.

`tags` : Mots-clés

Les mots-clés sont des termes qui permettent de décrire et de catégoriser le contenu. Ils sont utilisés pour faciliter la recherche et l'organisation de l'information.

Commentaires

Ce trait permet à l'utilisateur d'ajouter des commentaires et de discuter avec d'autres utilisateurs à propos d'un contenu d'information.

Une entité du métier peut comporter plusieurs commentaires, qui sont des entités faibles, c'est-à-dire dont l'identification dépend directement de leur entité forte d'appartenance. Chaque commentaire peut faire l'objet d'une ou plusieurs réponses par un système de relation récursive, les réponses possédant les mêmes propriétés que les commentaires les ayant initié.

Propriétés des entités à commentaire

Les entités possédant un mécanisme d'annotation et commentaires possède une propriété qui contient les fils de discussion

`comments` : Liste des commentaires

Cette propriété contient la liste des commentaires de premier niveau, c'est-à-dire qui ne sont pas des réponses à un autre commentaire existant. Chaque commentaire est composé d'une structure de données décrite ci-après.

Propriétés des commentaires

identifier : Chaque commentaire est identifié parmi les autres commentaires d'un même objet. L'identifiant est fourni par le système et non accessible à l'utilisateur.
text : Le contenu du commentaire est un texte qui peut être assez long et contenir tout caractère imprimable, des espaces et tabulations, retours à la ligne, etc.
createdAt : La date de création du commentaire contient l'horodatage associé à l'entrée de l'information dans le système. Elle est définie par le système lors de la création et non modifiable après enregistrement.
author : L'auteur du commentaire est l'identifiant de l'agent qui a rédigé et enregistré le contenu initial du commentaire dans le système. Il est défini par le système lors de la création et non modifiable après enregistrement. L'auteur possède un droit d'accès total à son commentaire, pour le modifier et en supprimer le contenu.
modifiedAt : La date de la dernière modification contient l'horodatage associé à la dernière mise à jour du commentaire dans le système. Elle est définie par le système lors des accès en mise à jour par l'auteur ou un utilisateur habilité.
modifiedBy : L'auteur de la dernière modification contient l'identification de l'agent qui a réalisé la dernière opération de mise à jour du contenu du commentaire. Il est défini par le système lors des accès en mise à jour.
access : Cet indicateur définit quelle population d'utilisateurs peut accéder au commentaire et à ses réponses dans un fil de discussion. L'habilitation à visualiser un commentaire noté privé est un attribut de base des agents utilisateurs et groupes d'utilisateurs.