Exemple de schéma NIEM

Cette page fournit un aperçu de la définition d'un nouveau schéma compatible NIEM, du début à la fin.

Les Paquetages de framework requis pour modélisation NIEM ont été décrits dans les rubriques précédentes. Constructeur de Modèle fournit également un Paquetage qui sert de point de départ pratique pour définir votre IEPD. Une fois celui-ci importé dans votre modèle, vous trouverez diagrammes contenant des instances des types IEPD, avec l'état d'exécution défini pour afficher les propriétés de base que vous aurez probablement besoin de définir.

Cette section décrit le processus de prise de l'exemple IEPD du Motif et de création d'un message de type « Hello World », où une demande est faite pour un message personnalisé basé sur une image faciale. La réponse sera l'identité de la personne représentée et un message personnalisé pour elle.

Importer Paquetages de framework NIEM

Modélisation avec NIEM dans Enterprise Architect commence avec les types standards définis par le Comité Architecture technique NIEM et la spécification NIEM-UML de Object Management Group, comme décrit ici. Ceux-ci sont disponibles à partir de notre serveur d'actifs réutilisables et du Constructeur de Modèle .

Pour les importer dans votre modèle :

Ouvrez le Constructeur de Modèle (Ctrl+Shift+M)
Dans la dialogue Constructeur de Modèle , cliquez sur le bouton <nom de la perspective>, puis sélectionnez la perspective ' Échange d'Informations > NIEM'
Développer l'élément « NIEM 3, 4 et 5 »
Sélectionnez les Paquetages requis pour votre modèle
Cliquez sur le bouton Créer Modèle pour importer les motifs sélectionnés dans votre modèle

Note :

Tous les modèles NIEM 5 nécessitent le Paquetage de types IEPD NIEM ainsi que l'un des Paquetages de Modèle de référence NIEM
Tous les modèles NIEM 3 et 4 nécessitent le Paquetage de types NIEM MPD ainsi que l'un des Paquetages de Modèle de référence NIEM
Tous les modèles NIEM 2.1 nécessitent le Paquetage Modèle de référence NIEM 2.1 mais pas de Paquetage de types MPD, car les éléments MPD NIEM 2.1 sont disponibles dans la boîte à outils Diagramme MPD NIEM 2.1

Composant	Détails
Cadre NIEM	La puissance de NIEM vient principalement de la vaste bibliothèque de types que vous pouvez utiliser pour créer vos propres schémas. Enterprise Architect fournit des frameworks NIEM complets pour NIEM 5, ainsi que toutes les versions de NIEM 3 et NIEM 4. Ces frameworks sont tous disponibles à partir du Constructeur de Modèle . Ce tutoriel utilise le framework NIEM 5.0, sélectionnez donc ce motif pour l'importation.
Types d'IEPD du NIEM-UML	Un schéma NIEM défini par l'utilisateur est construit autour d'un IEPD qui définit, pour les consommateurs du schéma, comment utiliser les différents fichiers XSD inclus et quels types de messages sont définis. Lors de modélisation en UML , un IEPD est créé à l'aide d'instances d'un certain nombre de classes définies dans le profil UML . Enterprise Architect fournit ces classes dans un Paquetage disponible à partir du Constructeur de Modèle . Tous les modèles NIEM 5 nécessiteront ces types IEPD, sélectionnez donc le motif « Types IEPD NIEM 5 » pour l'importation.

Composant

Détails

Cadre NIEM

La puissance de NIEM vient principalement de la vaste bibliothèque de types que vous pouvez utiliser pour créer vos propres schémas. Enterprise Architect fournit des frameworks NIEM complets pour NIEM 5, ainsi que toutes les versions de NIEM 3 et NIEM 4. Ces frameworks sont tous disponibles à partir du Constructeur de Modèle .

Ce tutoriel utilise le framework NIEM 5.0, sélectionnez donc ce motif pour l'importation.

Types d'IEPD du NIEM-UML

Un schéma NIEM défini par l'utilisateur est construit autour d'un IEPD qui définit, pour les consommateurs du schéma, comment utiliser les différents fichiers XSD inclus et quels types de messages sont définis.

Lors de modélisation en UML , un IEPD est créé à l'aide d'instances d'un certain nombre de classes définies dans le profil UML . Enterprise Architect fournit ces classes dans un Paquetage disponible à partir du Constructeur de Modèle .

Tous les modèles NIEM 5 nécessiteront ces types IEPD, sélectionnez donc le motif « Types IEPD NIEM 5 » pour l'importation.

Sous-ensemble Namespaces NIEM

Le motif Starter Modèle inclut un artefact Compositeur de Schéma à utiliser pour spécifier un sous-ensemble. Double-cliquez dessus pour ouvrir le Compositeur de Schéma et commencer le processus de sous-ensemble.

Nous voulons que notre message de requête envoie une image faciale à utiliser pour la reconnaissance faciale. Pour ce faire, nous devons sous-ensembleer les types appropriés du Paquetage Biométrique. Démarrer par localiser le type FaceImageType dans le Paquetage Domains\Biom du Modèle de Référence NIEM 5.0. Faites glisser ce type dans le Compositeur de Schéma . Les super-types dont ce type hérite sont automatiquement ajoutés au Compositeur de Schéma .

Notre message de réponse nécessite un PersonType du Paquetage 'niem-core'. Faites également glisser ce type sur le Compositeur de Schéma .

Cette image montre la sélection d'un sous-ensemble de types et de propriétés dans un certain nombre d'espaces de noms dans le Modèle de référence NIEM 5.0 :

Enterprise Architect Schema Composer - Defining a NIEM 5 subset model<br />

Une fois les types requis sélectionnés, vous pouvez générer le sous-ensemble. Lorsque vous y êtes invité, sélectionnez le Paquetage parent dans lequel l'espace de noms du sous-ensemble Paquetages sera généré. Après la génération, les classes du sous-ensemble Paquetages devraient ressembler à ceci :

Enterprise Architect Browser window - NIEM 5 subset model.<br />

Nous pouvons maintenant créer un diagramme NIEM PIM et placer toutes nos classes de sous-ensemble sur ce diagramme , pour produire quelque chose qui ressemble à ceci :

Créer des types d'extensions

Nous allons définir deux messages, une requête et une réponse. Pour chacun de ces messages, nous devons définir les éléments racines du document. Ceux-ci seront modélisés comme des extensions du schéma NIEM. Maintenant que nous avons défini notre sous-ensemble Paquetages , nous pouvons définir ces racines de document. Comme nous ne créons que deux types de documents simples, tout ce dont nous avons besoin est un PropertyHolder et ObjectType pour chaque message. Les ObjectTypes sont liés aux types que nous avons sélectionnés dans le framework NIEM, pour décrire le contenu de chaque message comme indiqué :

Personnaliser l'IEPD

L'instance de la classe IEPD contient des informations qui identifient l'IEPD, et les liens entre elle et les divers autres artefacts du modèle déterminent ce qui est généré (et où cela est généré) lors de la génération des fichiers de schéma et des fichiers de catalogue. Les points principaux sont décrits ici.

Composant	Description
Métadonnées IEPD	L' object de niveau supérieur dans Motif est une instance de la classe IEPD. Le nom de l'IEPD est le nom de l' Object lui-même. Toutes les autres propriétés sont dans l'état d'exécution de l' object . Cette figure montre à quoi pourrait ressembler l'IEPD après avoir fourni des informations réelles. NIEM-UML recommande que la dernière section de iepdBaseURI corresponde au nom de l'IEPD et spécifie que l'id de version iepd sera ajouté à iepdBaseURI pour produire l'iepdURI généré. Cet exemple suit cette convention. Le Motif définit par défaut la valeur de iepdClassCode sur 'iepd'. Cela signifie que l'IEPD est destiné à représenter un document Paquetage Échange d'Informations (IEPD). Il s'agit du type d'IEPD le plus courant et c'est celui que nous souhaitons créer, c'est pourquoi il a été laissé avec la valeur par défaut .
Types de documents définis	Un IEPD doit définir un ou plusieurs types de documents. Chacun d'entre eux sera une instance de IEPConformanceTargetType nommée « IEPConformanceTarget ». Le modèle Motif fourni inclut déjà l'un d'entre eux, mais nous en avons besoin d'un deuxième comme indiqué ici : Note les instances de QualifiedNamesType, avec la relation skilledName avec un PropertyHolder. Cela spécifie que le niveau supérieur du document décrit sera un élément de l'un des attributs contenus. La section Créer Paquetages d'extension dans la rubrique Créer un Modèle de données NIEM décrit comment cela est défini.
Utilisation Paquetage	Les relations reliant l'instance IEPD aux modèles d'information spécifient les fichiers de schéma à générer avec cet IEPD. Dans cet exemple, nous utilisons des types de deux espaces de noms NIEM différents. Le processus de sous-paramétrage a créé un InformationModel Paquetage pour chacun, où les Namespace Valeur Étiquetés correspondent à l'original et l'objectif est défini sur sous-ensemble. Nous créons également un Paquetage d'extension dans lequel nous définissons nos propres types et la manière dont les types NIEM seront utilisés. Cette figure montre à quoi cela ressemble : Les relations utilisées spécifient également comment le Paquetage est utilisé et le chemin relatif vers le schéma défini par ce Paquetage .
Fichiers supplémentaires	Tous Paquetages IEPD doivent contenir, selon NIEM, au minimum un log des modifications et un fichier readme, mais plusieurs autres types d'artefacts sont également pris en charge. Dans Enterprise Architect , chacun est défini à l'aide d'une relation stéréotypée avec un artefact. Comme pour l'utilisation Paquetage , la relation spécifie où le fichier sera situé. Dans cette image, un fichier ReadMe, un journal des modifications et un exemple de document sont décrits pour chacun des types de documents. Cela ajoutera des informations sur ces fichiers au fichier catalogue cible. Les fichiers ne seront pas créés par Enterprise Architect et leur contenu dépasse le cadre de ce didacticiel.

Générer IEPD

Pour générer votre IEPD :

Sélectionnez la spécification d'instance IEPD, soit sur le diagramme , soit dans la fenêtre Navigateur .
Depuis le ruban « Spécialiser », sélectionnez l'option « Technologies > NIEM > Générer le schéma NIEM »

Enterprise Architect - Generating schema files from NIEM 5 model.<br />

La dialogue affiche les artefacts NIEM standard et la liste des espaces de noms liés qui peuvent être générés sous forme de schémas. Définissez le répertoire cible et cliquez sur le bouton Générer pour créer l'IEPD modélisé.