Traits
Les traits sont des collections de propriétés et de comportements qui peuvent être utilisés pour modifier les classes de base afin de leur ajouter des données et des fonctions.
Identification fournie par l'utilisateur
Lorsqu'une entité peut être identifiée, définie et utilisée indépendamment de toute autre, on dit qu'elle est indépendante ou forte.
Les entités fortes possèdent un identifiant constitué uniquement d'attributs intrinsèques,
c'est-à-dire ne faisant référence à aucune autre entité; cet identifiant est dit absolu.
Il s'agit donc d'une entité racine qui possède son propre référentiel.
Le système fournit un identifiant système pour toutes les entités qu'il gère (dérivés de SystemObjectAbstract).
Il permet aussi à l'utilisateur d'attribuer un identifiant personnalisé, qui doit être unique dans le référentiel. Ce mécanisme permet à l'utilisateur de constituer un référentiel contrôlé dont les entités peuvent être identifiées de manière univoque en dehors du système pour leur utilisation dans les processus.
| Diagramme de classe des objets identifiés par l'utilisateur |
|---|
 |
Trait IdentifiableObject : Identifier une entité
Le trait IdentifiableObject permet d'ajouter aux objets un identifiant définit par l'utilisateur,
ainsi que les méthodes pour y accéder.
| Nom | Type | Description |
|---|---|---|
identifier |
normalizedString |
Identifiant unique de l'entité, fourni par l'utilisateur lors de la phase de création et de copie de travail, et immuable après publication. |
Opération setIdentifier
boolean - Définit l'identifiant métier, fourni en entrée par l'utilisateur.
Opération getByIdentifier
SystemObject - Récupère un objet dont l'identifiant défini par l'utilisateur est fourni.
Documentation et annotation
Cette fonctionnalité permet de définir des propriétés destinées à présenter à l'utilisateur final de la documentation sur l'information à laquelle il accède.
Il s'agit par exemple de fournir un nom usuel pour les entités ou pour leurs attributs, des descriptions, de l'aide contextuelle ou encore de exemples.
Trait DocumentableObject : Documenter une entité
Le trait DocumentableObject ajoute les propriétés de documentation et d'annotation aux entités et types.
| Nom | Type | Description |
|---|---|---|
displayName |
normalizedString |
Un nom affiché à l'utilisateur pour faciliter l'identification et la compréhension de l'information contenue. Parfois mentionné comme "title" ou "summary" dans les systèmes de documentation. |
description |
string |
Une description de l'information destinée à faciliter la compréhension de l'information contenue. Elle peut faire office d'aide contextuelle. |
tags |
[token] |
Un tableau d'étiquettes portées par l'objet. Les étiquettes permettent la découverte et la catégorisation. |
Opération setDisplayName
boolean - Définit la valeur du nom d'affichage.
Opération setDescription
boolean - Définit la valeur de la description.
Opération addTag
boolean - Ajoute une étiquette.
Opération removeTag
boolean - Enlève une étiquette par sa valeur.
Attributs personnalisés
La fonctionnalité permet d'ajouter des attributs personnalisés aux entités du métier, en plus des propriétés gérées de base par le système.
La structure des attributs ainsi ajoutés peut être liée à un modèle d'attributs afin d'ajouter des contraintes en lien avec les règles du métier.
Trait CustomAttributes : Gestion des attributs personnalisés
Le trait CustomAttributes ajoute aux entités le conteneur pour les attributs personnalisés.
| Nom | Type | Description |
|---|---|---|
attributes |
ObjectAttributes |
Conteneur pour la gestion des attributs personnalisés. |
Classe ObjectAttributes : Attributs
La classe ObjectAttributes est le conteneur des attributs personnalisés.
Elle rassemble les attributs et permet le lien avec un modèle de données associé
pour leur description et leur validation.
| Nom | Type | Description |
|---|---|---|
data |
object |
Conteneur pour les différents attributs personnalisés de l'objet porteur, structurés en fonction du modèle de description. |
modelId |
token |
Identifiant, sous la forme d'une URI ou d'un identifiant interne, du modèle d'attributs personnalisés utilisé pour les données. |
Opération updateAttributes
Le système permet à l'utilisateur de gérer les données complémentaires sur les entités qui l'autorisent, c'est-à-dire dont le type système ouvre la capacité et dont le sous-type fournit un modèle par des opérations d'ajout, de modification et de suppression des attributs.
Opération validateAttributes
Le système contrôle la conformité d'un objet par rapport au modèle d'information défini par la personnalisation. Cette fonction est utilisée lorsque l'utilisateur soumet l'information à créer ou à modifier dans le système. Le processus reçoit les données à valider et l'identification d'une définition présente dans le référentiel (ou dictionnaire des données). La validation porte sur le respect des contraintes définies dans le schéma. Elle retourne une liste des erreurs liées à des contraintes non respectées. Le comportement du système lorsqu'une ou plusieurs contraintes sont violées dépend du cycle de vie de l'objet. Par exemple, il peut être acceptable que des données obligatoires soient manquantes tant que l'objet est dans un état de copie de travail; le système peut simplement avertir ou informer des non-conformités sans pour autant empêcher la mise à jour des données. En revanche, les données doivent être valides lorsque l'objet est publié et qu'il devient utilisable dans les processus métier.