Pré. | Proc. |
Exemple de schéma NIEM
Cette page fournit un aperçu de la définition d'un nouveau schéma conforme NIEM, du début à la fin.
Les Paquetages de framework requis pour la modélisation ont été décrits dans les rubriques précédentes. L' Assistant de Modèle ( Page Démarrage "Créer à partir de Motif ") fournit également un Paquetage qui sert de point de départ pratique pour définir votre IEPD. Lorsque cela est importé dans votre modèle, vous trouverez des 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 devrez probablement définir.
Cette section décrit le processus de prise de l'exemple d'IEPD du Motif et de création d'un message de style "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 photographiée et un message personnalisé pour elle.
Importer les packages du framework Paquetages
La Modélisation avec NIEM dans Enterprise Architect commence par les types standard définis par le comité d'architecture technique NIEM et la spécification NIEM-UML du groupe de gestion d' Object , comme décrit ici. Ceux-ci sont disponibles à partir de notre serveur d'actifs réutilisables et de l'assistant Modèle Motifs .
Pour les importer dans votre modèle :
- Ouvrez l' Page Démarrage 'Créer à partir de Motif ' de Page Démarrage (l' Assistant de Modèle )
- Retrouvez la Perspective 'NIEM 3, 4 et 5'
- Sélectionnez les Paquetages requis pour votre modèle
- Cliquez sur le bouton Créer Modèle (s) pour importer les motifs sélectionnés dans votre modèle.
- Tous les modèles NIEM 5 nécessitent le paquetage de types NIEM Paquetage ainsi que l'un des Paquetages de modèles de référence Modèle
- Tous les modèles NIEM 3 et 4 nécessitent le paquetage de types Paquetage MPD ainsi que l'un des Paquetages de modèles de référence Modèle
- Tous les modèles NIEM 2.1 nécessitent le Paquetage de modèle de référence Modèle 2.1 mais pas un paquetage de types Paquetage , car les éléments NIEM 2.1 MPD sont disponibles dans la boîte à outils du diagramme MPD Diagramme 2.1
Composant |
Détails |
---|---|
Cadre NIEM |
La puissance de NIEM provient 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 depuis l' Page Démarrage 'Créer à partir de Motif ' (l' Assistant de Modèle ). Ce didacticiel utilise le framework NIEM 5.0, sélectionnez donc ce modèle pour l'importation. |
Types IEPD du NIEM-UML |
Un schéma NIEM défini par l'utilisateur est construit autour d'un IEPD qui définit, pour les utilisateurs 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 qui est disponible depuis l'onglet Démarrage de la Page Démarrage 'Créer à partir de Motif ' (l' Assistant de Modèle ). Tous les modèles NIEM 5 nécessiteront ces types IEPD, sélectionnez donc le modèle « NIEM 5 IEPD Types » pour l'importation. |
Sous-ensemble d'espaces de Namespaces NIEM
Le pattern Starter Modèle inclut un Compositeur de Schéma Artifact à 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 demande envoie une image faciale à utiliser pour la reconnaissance faciale. Pour ce faire, nous devons créer un sous-ensemble des types appropriés à partir du Paquetage biométrique . Début par localiser le type FaceImageType dans le Paquetage Domains\ Paquetage 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 PersonType du paquetage ' Paquetage -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 Modèle 5.0 :
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 les Paquetages espace de noms de sous-ensemble seront générés. Après génération, les Classes du sous-ensemble Paquetages doivent ressembler à ceci :
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 demande et une réponse. Pour chacun de ces messages, nous devons définir les éléments racine 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. Étant donné que nous ne créons que deux types de documents simples, tout ce qui est nécessaire est un PropertyHolder et un ObjectType pour chaque message. Le lien ObjectTypes vers les 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 celui-ci et les divers autres artefacts de modèle déterminent ce qui est généré (et où il 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 le 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 iepdVersionID 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 d'échange d'informations ( Paquetage ). C'est le type d'IEPD le plus courant, et c'est ce que nous voulons créer, il a donc été laissé avec la valeur par défaut . |
Types de documents définis |
Un IEPD est censé définir un ou plusieurs types de documents. Chacun sera une instance de IEPConformanceTargetType nommée 'IEPConformanceTarget'. Le modèle Motif fourni en inclut déjà un, mais nous en avons besoin d'un second, comme illustré ici :
Note les instances de QualifiedNamesType, avec la relation qualifierName 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éation d'un modèle de données Modèle décrit comment cela est défini. |
Utilisation Paquetage |
Les relations reliant l'instance IEPD aux modèles d'information spécifient quels fichiers de schéma doivent être générés avec cet IEPD. Dans cet exemple, nous utilisons des types de deux espaces de noms NIEM différents. Le processus de sous-ensemble a créé un InformationModel Paquetage pour chacun, où l'espace de Namespace Valeur Étiquetés correspond à l'original, et l'objectif est défini sur sous-ensemble. Nous créons également une extension Paquetage où nous définissons nos propres types et comment 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 |
Le NIEM s'attend à ce que tous les paquets Paquetages contiennent - au minimum - un log modifications et un fichier Lisez-moi, mais plusieurs autres types d'artefacts sont également pris en charge. Dans Enterprise Architect , chacun est défini en utilisant 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, ChangeLog et un exemple de document sont décrits pour chacun des types de document. Cela ajoutera des informations sur ces fichiers au fichier de 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 .
- Dans le ruban 'Spécialiser', sélectionnez l'option ' Technologies > NIEM > Générer NIEM Schema'
La boîte de dialogue affiche les artefacts NIEM standard et la liste des espaces de noms liés qui peuvent être générés en tant que schémas. Définissez le répertoire cible et cliquez sur le bouton Générer pour créer l'IEPD modélisé.