Réserver une Démo
Pré. Proc.

Documents liés

Lorsque vous développez des éléments dans votre modèle, vous souhaiterez peut-être fournir une documentation complète sur un élément, afin de fournir un texte plus structuré que celui que vous pouvez créer dans le champ « Notes » de l'élément. Dans ce cas, vous pouvez créer un document formaté lié à l'élément. Vous pouvez créer un document lié à partir de zéro ou à partir d'une gamme de Gabarits liés que vous définissez avec l'éditeur de documents Gabarit . Les documents liés sont conservés dans le modèle.

Travailler avec des documents liés

Tâche

Détail

Voir aussi

Créer des documents liés

Vous pouvez créer un document lié soit :

  • Dans un élément d'artefact de document attaché à votre élément de modèle, ou
  • Directement sur l'élément modèle
Les avantages de l'utilisation d'un artefact de document pour héberger le document lié incluent :
  • Visibilité de l'artefact de document et donc du document lié dans la fenêtre Navigateur
  • Comme vous ne pouvez avoir qu'un seul document lié dans un élément, héberger chacun des nombreux documents dans son propre artefact de document et connecter les différents artefacts de document à un élément de modèle signifie que vous disposez d'une plus grande marge de manœuvre pour fournir des informations.
  • De même, associer plusieurs éléments à un document en les connectant à l'élément d'artefact de document hôte signifie que vous pouvez partager des informations plutôt que de les dupliquer.
Les avantages de l'utilisation d'un document lié directement sur un élément incluent :
  • Lier plus étroitement le contenu du document à l'élément, de sorte qu'il y ait moins d'ambiguïté quant à ce à quoi l'information fait référence
  • Lier plus étroitement le document lui-même à l'élément, de sorte qu'il y a moins de risque que le document soit modifié, déplacé ou supprimé sans référence à l'élément auquel il appartient
Créer un artefact de document Créer un document lié sur un élément

Créer gabarits de documents liés

Vous pouvez baser votre document lié sur l'un des nombreux gabarits fournis par le système, chacun représentant un type de document de projet.

Vous pouvez également créer et utiliser vos propres gabarits de documents liés dans l'onglet « Ressources » de la fenêtre Navigateur , au sein du dossier Documents liés .

Créer un document lié Gabarits

Modifier les documents liés

Vous pouvez définir le style, le format et disposition de votre document lié à la fois dans le gabarit à partir duquel vous créez le document et dans le document lui-même. Vous pouvez éditer le document lié à partir d'un élément sélectionné dans la fenêtre de document et dans l'éditeur de document lié.

Modifier le document lié Gabarits Modifier les documents liés

Créer des hyperliens dans les documents liés

Les documents liés sont étroitement associés à des éléments spécifiques, mais vous pouvez également créer des hyperliens dans le document directement vers d'autres éléments du modèle. Après avoir suivi le lien, vous pouvez effectuer n'importe quelle opération normale sur cet élément.

De même, vous pouvez créer de nouveaux éléments ou diagrammes auxquels créer des liens.

Vous pouvez également créer des hyperliens vers d’autres formes de documentation.

Lien hypertexte à partir du document lié Créer un élément à partir du document

Inclure les documents liés dans les rapports RTF

Les documents liés, quelle que soit leur manière de création, sont restitués dans les rapports de documents lorsque vous sélectionnez la case à cocher « Document lié » dans le concepteur de documents Gabarit .

Documents liés au Rapportage

Localiser les documents liés

Dans diagrammes , tout élément possédant un document lié est marqué d'un symbole « A » dans le coin inférieur droit.

Vous pouvez également utiliser le Modèle de recherche facilité pour rechercher des éléments qui ont des documents liés, soit en utilisant la recherche « Rechercher des documents liés » dans le groupe « Publier » des recherches définies par le système (renvoyant des documents liés standard), soit en créant une recherche personnalisée contenant cette Query SQL (qui renvoie toutes les variantes de document lié) :

SÉLECTIONNEZ ea_guid AS CLASSGUID, Object_Type AS CLASSTYPE, Nom AS Object , Object_Type AS [ Type ], Stéréotype, Auteur, Portée, Statut, Phase, CreatedDate , ModifiedDate

DE t_object

OÙ t_object.Style COMME '#WC#MDoc=1#WC#'

Créer des définitions de recherche Fenêtre Propriétés - Diagramme

Supprimer les documents liés

Vous pouvez supprimer complètement un document lié d'un élément, ou vous pouvez supprimer le contenu du document et le remplacer par le contenu d'un fichier externe.

Remplacer ou supprimer les documents liés

Notes

  • Vous pouvez créer un élément d'artefact de document pour contenir un document lié dans toutes les éditions d' Enterprise Architect
  • Vous pouvez créer et lier un document à n'importe quel élément UML du modèle, dans toutes les éditions d' Enterprise Architect
  • Vous pouvez travailler sur des documents liés via l'interface d'automatisation, en utilisant les méthodes GetLinkedDocument(), DeleteLinkedDocument(), SaveLinkedDocument( string Filename) et LoadLinkedDocument( string Filename)

Apprenez Plus