Home

MDG Integration for Visual Studio User Guide

1. Edit Diagrams Import and Synchronize TFS Work Items Version Control Version Control Overview Controlled Packages XML Technologies XML Schema XSD Web Services WSDL Working with Code Import Binary Import Directory Model Driven Transformation Import Database Schema from ODBC 1998 2009 Sparx Systems Pty Ltd Contents Il Baselines Differencing and Merges 50 Generate RTF Documentation 51 Generate HTML Documentation 52 Index 53 1998 2009 Sparx Systems Pty Ltd 1 Foreword Foreword MDG Integration for Visual Studio takes the high level modeling power of Enterprise Architect and the Unified Modeling Language and directly integrates it with Visual Studio 2005 and 2008 1998 2009 Sparx Systems Pty Ltd 1 Introduction Visual Studio MDG Integration Welcome to the Enterprise Architect MDG Integration for Visual Studio version 4 0 0 This set of tools takes the high level modeling power of Enterprise Architect 7 5 and the Unified Modeling Language 2 1 and directly integrates it with Visual Studio 2005 and 2008 With MDG Integration you can Provide the UML Analyst Designer and Architect with the tools to build detailed and precise UML 2 1 models Give the Visual Studio developer focused access to UML model content Offer the development team strong traceability features from requirements to model code tests and finally t
2. A Visual Studio Y MDG Integration MDG Integration for Visual Studio User Guide Welcome to the MDG Integration for Visual Studio The MDG Integration for Visual Studio takes the high level modeling power of Enterprise Architect and the Unified Modeling Language and directly integrates it with Visual Studio 2005 and 2008 SIARA SYSTEMS Copyright 1998 2009 Sparx Systems Pty Ltd MDG Integration for Visual Studio User Guide Introduction by Alistair Leslie Hughes MDG integration for Visual Studio takes the high level modeling power of Enterprise Architect and the Unified Modeling Language and directly integrates it with Visual Studio 2005 and 2008 MDG Integration for Visual Studio User Guide 1998 2009 Sparx Systems Pty Ltd All rights reserved No parts of this work may be reproduced in any form or by any means graphic electronic or mechanical including photocopying recording taping or information storage and retrieval systems without the written permission of the publisher Products that are referred to in this document may be either trademarks and or registered trademarks of the respective owners The publisher and the author make no claim to these trademarks While every precaution has been taken in the preparation of this document the publisher and the author assume no responsibility for errors or omissions or for damages resulting from the use of information contained in this document
3. _ Include Child Packages Generate Code on result C Perform Transformations on result Intermediary File optional for debugging only o Transform Close Write Now Write Always Help When the dialog displays all elements are selected and all transformations previously performed from any of the Classes are checked Em Sees eerie eden evene m sons ot nens rom es be mate nto armati er pememsomesmemomnmewh Transformations Enables you to select which transformations to perform and the package each of them should be transformed to Select Package Use the button to select the package in which the transformed elements are created Generate Code on result Specifies whether or not to automatically generate code from the target classes Perform Transformations on Specifies whether transformations previously done on target classes should result be automatically executed Intermediary File Path Specifies the filename of the intermediary file if any Write Always Specifies whether an intermediary file should be written to disk 1998 2009 Sparx Systems Pty Ltd 47 MDG Integration for Visual Studio User Guide Generates the intermediary file but doesn t perform the transform Do Transform Executes the transform command For instance to transform the basic package into a C application in the Transformations panel select the checkbox for C Once you select the transform
4. Once the document has been created you can view it immediately by clicking on the View button on the dialog More Information For further information on the Generate HTML Report dialog and HTML report generation review the Enterprise Architect User Guide To access this information either Click on the Help button on the Generate HTML Report dialog or Click on this Sparx Systems web page link 1998 2009 Sparx Systems Pty Ltd 53 MDG Integration for Visual Studio User Guide Index EAP 9 A Add EAP file 9 EA Model 9 Model Using Wizard 18 New Elements 18 New Packages 18 B Baseline Introduction 50 C Category Forum Add 26 Code Forward Engineer 42 Generate 42 Synchronize With Model 42 Working With 42 Compare Utility 50 Compiled 29 April 2008 2 Connect TOTFS 31 Connection Properties 31 To TFS Configure 31 Controlled Packages 38 Create Category In Forum 26 Post In Forum 26 Topic In Forum 26 De Diagram Edit 28 Properties 16 Diff Utility 50 Disconnect From TFS 31 Discussion Forum 26 Add Category 26 Add Post 26 Add Topic 26 Edit Post 26 Message Dialog 27 Reply to Post 26 Documentation HTML 52 RTF 51 See EA Project Explorer 14 Introduction 15 Edit Diagrams 28 Post In Forum 26 Element Add 18 EULA 4 Forum 26 Generate HTML Documentation 52 RTF Documentation 51 H HTML Documentation Generate 52 Hyperlinks Navigating 20 Im
5. Link one or more work items to the selected element Remove unlink selected work items from the selected element Properties Define the current Team Foundation Server connection properties displays the Link Properties 31 dialog Connect Connect to the Team Foundation Server Disconnect Disconnect from the Team Foundation Server Connection Properties The Link Properties dialog enables you to configure the connection to the Team Foundation Server 1998 2009 Sparx Systems Pty Ltd Maintain Work ltems 32 Link Properties E Please select a project for storing work items Team Foundation Server Team System Project Make Selected Project the Default Cancel In the Team Foundation Server field type the name of the server to connect to In the Team System Project field type or select the name of the project to connect to Select the Make Selected Project the Default checkbox to make the specified project the default Click on the OK button Bog Nor 1998 2009 Sparx Systems Pty Ltd 33 MDG Integration for Visual Studio User Guide 4 2 Manage Mapped Fields To manage the mapped fields for a work item linked against a UML element right click on the required package in the EA Project Explorer and select the Team Foundation Server Manage Mapped Fields context menu option Configure Field Mappings x Work tem Type 7 Dont create Elements for this work item t
6. select to never delete any Classes found in the model but not found in the code Prompt for action select to prompt you if Classes found that are not in the code are to be removed first Always delete select to delete Classes without prompting you New Diagram Options This button displays the New Diagram Options dialog through which you define what features are to be visible in any diagrams generated by the import 1998 2009 Sparx Systems Pty Ltd Model Driven Transformation 46 7 3 Model Driven Transformation MDG Integration for Visual Studio supports the Model Driven Architecture and the use of Platform Independent Models PIMs and Platform Specific Models PSMs You can create a PIM and define rules for transforming a PIM into a PSM For instance a single independent model might generate specific models that account for particular features of a system or language such as C or Java To perform an MDA transform you must have a master model the PIM Once you have created or imported a model right click on the containing package and select the Current Package Apply MDA Transformation context menu option The Model Transformation dialog displays Elements Transformations EE m 1 Element Name Element Type Name Target Package Account Lich Lineltem DDL Order EJB Entity OrderStatus EJB Session ShoppingBasket Java Stockltem JUnit Transaction NUnit WSDL XSD
7. Enterprise Architect generating the RTF file The Progress bar displays the progress of the RTF generation Once the document has been created you can view it immediately by clicking on the View button You can also view the document at any time later by opening the file from the directory in which it was created More Information For further information on the Generate RTF Documentation dialog and RTF report generation review the Enterprise Architect User Guide To access this information either Click on the Help button on the Generate RTF Documentation dialog or Click on this Sparx Systems web page link Note MDG Integration for Visual Studio does not apply Word Masters Bookmarks or Virtual Documents It uses the Enhanced RTF Document Generator and has no access to the Enterprise Architect Legacy RTF Generator 1998 2009 Sparx Systems Pty Ltd 52 11 Generate HTML Documentation MDG integration for Visual Studio can automate generation of documentation based on your project models To generate documentation for a model package ils 2 3 4 Right click on the package name in the EA Project Explorer Select the Current Package Documentation HTML Report context menu option The Generate HTML Report dialog displays Enter a title and the output directory for the web site to be generated Click Generate to generate the HTML files The Progress field shows the progress of the HTML Generation
8. Project Explorer and select the Code Services Import Directory context menu option The Import Source Directory dialog displays Root Directory XX ERES E sd De pa n res UB ESSO f DEO UB E S CY Ld Source Type CH a File Extensions cs Defined Component Extensions None Recursively Process Subdirectories Create Logical Diagram for Each Package mport defined components C Do not import private members Package Structure New Diagram Options Create Package per Directory Create Package per Namespace F7 Create Package per File Synchronization Synchronize existing classes Overwrite existing classes Remove Classes not found in code 9 Never delete O Prompt for action Always delete The above screen shows the default settings for CH 3 Select the root directory for the package to import 4 Set the source code type such as C or C and the expected file extension c cs You can select from a number of further options to control the import process as below 5 Once you have set your options click on the OK button to invoke Enterprise Architect to process the directory When Enterprise Architect is finished the newly created models appear in the EA Project Explorer and in the Model tab Options Main Body of Dialog These options define what data is imported Recursively Process Subdirectories select to make Enterprise Architect search the directory being imported for
9. Project Explorer window either double click on an element name or right click on an element name and select the View UML Documentation context menu 15 option 1998 2009 Sparx Systems Pty Ltd 15 MDG Integration for Visual Studio User Guide 3 1 EA Project Explorer The EA Project Explorer contains an MS Explorer style representation of the UML model as shown below It lists the UML packages diagrams elements attributes and methods EA Project Explorer a a ClassLibrary1 Ca VS Test template B Use Case 1 6 a table Account m Account E Basket 7 BillingAddress 7 DeliveryAddress E order column Order q column Billing amp ddr q column Basket q column Delivery c LA Functional REQUS OD Action1 The EA Project Explorer helps you navigate your UML project from within Visual Studio Right click on an item in the tree to open a context sensitive menu that enables you to investigate the item or to perform operations on it The following examples show the context menus for a package and an element Enter Licence Key SS Open in Enterprise Architect Add Current Package Version Control XML Services Code Services Team Foundation Server Refresh Current Item Properties MDG Options Help About Enter Licence Key View LIML Documentation Open in Enterprise Architect Add gt Team Foundation Server b Attributes Operations Refresh Curr
10. context menu option a suitable diagram in the selected package right click on the opened diagram and select the Import DB Schema from ODBC context menu option The Import DB Schema from ODBC Source dialog displays Database Name Post Testing C Filter Schema 0wner l C Include System Objects Include User Views C Include User Packages Oracle Include User Stored Procedures O Import as individual classes 3 Import as class operations C Include User Functions Import as individual classes Import as class operations C Include User Sequences Import as individual classes 9 Import as class operations Synchronization O Synchronize existing classes Synchronize T able Column Comments Synchronize Column Default Values Synchronize Check Constraints Import as New objects Import To Diagram amp Package Package Only 1998 2009 Sparx Systems Pty Ltd 49 MDG Integration for Visual Studio User Guide 3 Seethe mport Database Schema from ODBC topic in the Enterprise Architect User Guide 1998 2009 Sparx Systems Pty Ltd 50 9 Baselines Differencing and Merges MDG integration for Visual Studio includes tools to help you manage and review changes to your models over time These tools apply the concepts of Baselines Differencing and Merges To access these facilities right click on the required package in the EA Projec
11. subdirectories and to also process them Create Logical Diagram for Each Package select to make Enterprise Architect create a logical diagram for each package being imported Import defined components select to import only those packages with defined components Do not import private members select to prevent private members from being imported Package Structure This selection offers different methods for controlling packaging of the imported objects Create Package Per Directory select to create a new package for each directory including the selected root and all subdirectories if recursion is checked 1998 2009 Sparx Systems Pty Ltd 45 MDG Integration for Visual Studio User Guide Create Package Per Namespace select to create a new model package for each namespace encountered in the code being imported Create Package Per File select to create a new package for each source file that is being imported Synchronization This section controls the way Enterprise Architect s import process deals with pre existing models Synchronize existing classes select to synchronize models existing models are altered to comply with the results of reverse engineering but are not completely overwritten or deleted Overwrite existing classes select to overwrite any model with the same name already existing in the package you are importing to with the newly generated model Remove Classes not found in code Never delete
12. the model resides in a central database Specific coding tasks are assigned to the software engineers The engineers can view the model from within Visual Studio Once assigned a task an engineer can locate all the model elements within their task domain along with any notes made by the Architect Allthe team members involved on the project can use the inbuilt Forum function to swap notes and files Not only does this facilitate communication amongst team members but helps to keep track of progress and changes to a project To begin using the MDG Integration for Visual Studio see Getting Started 8 1998 2009 Sparx Systems Pty Ltd 2 Getting Started After installation you are ready to integrate your Visual Studio project with Sparx Systems Enterprise Architect An Enterprise Architect model a file with a eap extension can be added to a project using standard Visual Studio features In addition a wizard is supplied to automate creation and addition in one step The following subsections describe this process in detail Add an Enterprise Architect Model 9 Link to a Model Package 11 Multiple Linkings 12 See Also MDG Integrate Options 13 1998 2009 Sparx Systems Pty Ltd 9 MDG Integration for Visual Studio User Guide 2 1 Add an Enterprise Architect Model Add Existing Enterprise Architect Models If you have an existing EAP file to incorporate into your Visual Studio sol
13. the original Form element 3 3 2 View UML diagrams By clicking on the Diagrams hyperlink on the UML Documentation Model tab you can also display the UML models themselves In the following example the hyperlink Windows Application5 is clicked on UML Documentation e Model Search Forum Help Form1 public Class E Created 2007 05 18 08 55 46 Modified 2007 05 18 08 55 46 Diagrams WindowsApplications Project i Advanced Associations From Tagged Values Element Type Source Role Program Class This displays the UML diagram on the UML Documentation view not the UML Diagram tab UML Documentation WindowsApplication5 ClassDiagram amp Created 2007 05 23 09 19 30 Modified 2007 06 04 14 14 42 Project Advanced resourceCulture global System Globalization Culturelnfo Program resourceMan global System Resources ResourceManager Properties Resources Windows Application5 Main void Resources test scripts property Unit Not Run sdfsdf Culture global System Globalization Culturelnf ResourceManagen q sa j ResetirceManager Notice that you can view the details of the Class including its attributes and methods all taken from Enterprise Architect You should not change data in this view Alternatively double click on a diagram in the EA Project Explorer window and click on the UML Diagram 28 tab This has no effec
14. to communicate Elements 4 RE Elements Diagram edits Diagrams Elements Author Frederick Walter Date 18 05 2007 3 03 40 PM Last Modified 9 07 2007 9 38 11 AM A CS HH gj New Category New 7 bay Z Add Reply Ef Edit Select Forum Connection See Also Categories Topics and Posts 26 Forum Message Dialog 275 3 5 1 Categories Topics and Posts The Project Discussion Forum enables you to create Categories which contain Topics which contain Posts You can also edit and reply to posts Add Category To create a new Category click on the New Category icon at the bottom of the Forum tab The Create New Category 27 dialog displays Enter the name and any relevant details into the Text field Enter the name of the author Click on the OK button You can now add new topics to the category Add Topic To create a new Topic click on the New Topic button at the bottom of the Forum tab The Create New Topic 275 dialog displays Enter the name and any relevant details into the Text field and enter the name of the author Click on the OK button You can now add new posts to the topic Add Post To create a new Post click on the New Post button at the bottom of the Forum tab The Create New Post 27 dialog displays Enter the name and any relevant details into the Text field and enter the name of the author Click on the OK button Other users can now reply to the post O 1998 2009 Sparx Systems Pty Ltd 2
15. 7 MDG Integration for Visual Studio User Guide Reply to Post To reply to a Post click on the Post in the Forum tab and click on the Add Reply button at the bottom of the Forum tab The Reply to Post 27 dialog displays Enter the name and any relevant details into the Text field and enter the name of the author Click on the OK button Edit Post To edit a Post click on the Post in the Forum tab and click on the Edit button at the bottom of the Forum tab Alternatively press Ctrl E The Edit Post 27 dialog displays Enter the name and any relevant details into the Text field You cannot change the name of the author Click on the OK button Other users can now reply to the post 3 5 2 Forum Message Dialog The Project Discussion Forum message dialogs Create New Category Create New Topic Create New Post Edit Post and Reply to Post all share the same functionality Mame Author Suzanne Pearson Ei w Ic ii Tit e The table below describes the operation of each option available for the dialogs Type in the name of the message category topic or post Click on the drop down arrow and select the message author name or type in a new name if the author name is not present in the list The names in the drop down list are defined in the model Authors list If you type a name into the Author field it is used for this post but it is not added to the Authors list Formatting Tools Standard for
16. CENSE In accordance with the terms of this EULA YOU are granted the following rights a To install and use one copy of the SOFTWARE PRODUCT or in its place any prior version for the same operating system on a single computer As the primary user of the computer on which the SOFTWARE PRODUCT is installed YOU may make a second copy for your exclusive use on either a home or portable computer b To store or install a copy of the SOFTWARE PRODUCT on a storage device such as a network server used only to install or run the SOFTWARE PRODUCT over an internal network If YOU wish to increase the number of users entitled to concurrently access the SOFTWARE PRODUCT YOU must notify SPARX and agree to pay an additional fee C To make copies of the SOFTWARE PRODUCT for backup and archival purposes EVALUATION LICENSE The Trial version of MDG Integration for Visual Studio is not free software Subject to the terms of this agreement YOU are hereby licensed to use this software for evaluation purposes without charge for a period of 30 days Upon expiration of the 30 days the Software Product must be removed from the computer Unregistered use of MDG Integration for Visual Studio after the 30 day evaluation period is in violation of Australian U S and international copyright laws SPARX may extend the evaluation period on request and at their discretion If YOU choose to use this software after the 30 day evaluation period a license must be p
17. acilities see the Enterprise Architect User Guide 1998 2009 Sparx Systems Pty Ltd 51 MDG Integration for Visual Studio User Guide 10 Generate RTF Documentation MDG integration for Visual Studio can automate the generation of RTF documentation based on your project models Rich text reports are documents produced by Enterprise Architect in Rich Text Format RTF a format common to many word processors The RTF Generator Enterprise Architect has an enhanced RTF Document Generator that features Powerful WYSIWYG RTF style template editor support enabling Headers and Footers Images Indexes Tabular Sections Nested Sections All model elements connectors diagrams and their properties Template import and export using XML Basic templates supplied for customization A document generator that Provides simplified options Generates complex documents based on RTF templates An embedded RTF viewer that you use to view RTF documents generated in Enterprise Architect directly within Enterprise Architect To generate RTF Documentation Briefly to generate the documentation for a model package 1 Right click on the package name in the EA Project Explorer 2 Select the Current Package Documentation Rich Text Format RTF Report menu option The Generate RTF Documentation dialog displays 3 Enter a filename for the document to be created and select a style template 4 Click on the Generate button to start
18. ackage Enables you to gain access from packages in the version control repository that is not currently available in the users model Version Control Displays the Version Control Options dialog Options Toggles version control between offline and online More Information For further information on version control see the Enterprise Architect User Guide To access the Enterprise Architect User Guide either Click on the Help button on the Version Control Settings dialog or Click on this Sparx Systems web page link See Also Version Control Overview 36 Controlled Packages 38 1998 2009 Sparx Systems Pty Ltd Version Control Overview 36 5 1 Version Control Overview Features The version control feature provides two key facilities Coordinating the sharing of packages between users Saving a history of changes to Enterprise Architect packages including the ability to retrieve previous versions System Requirements To use version control in MDG Integration for Visual Studio a third party source code control application is required MDG Integration for Visual Studio supports the following version control applications Subversion which is available from http subversion tigris org CVS which is available from http www tortoisecvs org Any version control product that complies with the Microsoft Common Source Code Control standard version 1 1 or higher Set Up Before using MDG Integrati
19. and CVS Support import and export of model elements between different models for example a Class library can be re used in many models and kept up to date in target models using controlled packages reloading packages as required when new versions of the Class model become available Package XML is standard XMI compliant output that can be loaded into any XML viewer or used by any XML based tool to perform manipulations and extracts such as document or code generators For more information on Controlled Packages see the Enterprise Architect User Guide topic via this Sparx Systems web Help link 1998 2009 Sparx Systems Pty Ltd 39 MDG Integration for Visual Studio User Guide 6 XML Technologies MDG Integration for Visual Studio enables rapid modeling and forward and reverse engineering of two key W3C XML technologies XML Schema XSD and Web Service Definition Language WSDL XSD and WSDL support is critical for the development of a complete Service Oriented Architecture SOA and the coupling of UML 2 1 and XML provides the natural mechanism for specifying constructing and deploying XML based SOA artifacts within an organization The following topics explain how to work with these technologies using MDG Integration for Visual Studio XML Schema XSD 40 Web Services WSDL 41 1998 2009 Sparx Systems Pty Ltd XML Schema XSD 40 6 1 XML Schema XSD MDG Integration for Vis
20. asket BIGINT OD Actioni DeliveryAddress BIGINT OD Activityl O ActivityInitial m n 9 Actorl Attributes used to generate objects FA eT You can add new elements and give them their own attributes operations and types and customize or arrange them You can also drag existing elements from the EA Project Explorer window To add elements and connectors to the diagram either use the Enterprise Architect Quick Linker arrow or right click on the diagram background and select the New Element or Connector context menu option to display the UML Toolbox shortcut menu To add attributes and operations right click on the element in the diagram or EA Project Explorer and select the Attributes or Operations context menu option For further information open the Enterprise Architect User Guide topic by Clicking on the Help button on the Attributes or Operations dialog or Selecting these Sparx Systems website links for attributes and operations 1998 2009 Sparx Systems Pty Ltd 29 MDG Integration for Visual Studio User Guide 4 Import and Synchronize TFS Work Items MDG Integration for Visual Studio enables you to import and synchronize work items from Team Foundation Server It also enables you to add view edit and unlink work items 31 that have been linked against a UML element and to map work item fields 39 against Enterprise Architect elements and element properties Import Work Items To import work items f
21. ation type Enterprise Architect prompts you to select the destination folder In the example below the mplementation Model PSM folder is selected gg Project Models m Start here i Business Domain Model E S Requirements Model B System Model d System Model 23 Analysis 23 Design Model C Implementation Model PSM CJ Component Model 3 Deployment Model a Environment Model E QA Model Project Model E Example diagrams GE amp amp amp Click on the Do Transform button to perform the transformation These Classes are also generated as code and imported into the Visual Studio Project 1998 2009 Sparx Systems Pty Ltd 48 8 Import Database Schema from ODBC MDG integration for Visual Studio supports importing database tables from an ODBC data source Tables are imported as stereotyped Classes with suitable data definitions for the source DBMS Note Import of stored procedures and views is supported for DB2 SQL Server Firebird Interbase Informix Ingres Oracle 9i 10g and 11g MySQL PostgreSQL Sybase Adaptive Server Enterprise ASE and Sybase Adaptive Server Anywhere ASA Import Database Tables and Stored Procedures To import database tables and stored procedures follow the steps below 1 Select a package in the EA Project Explorer 2 To import into the package only right click on the package and select the Code Services Import DDL from ODBC
22. can only be linked to one version control configuration at a time although it is possible to connect multiple control configurations for each model The Version Control Configurations dialog can be used to connect to an SCC provider CVS configuration MS Team Foundation Server or Subversion configuration In MDG Integration for Visual Studio right click on the required package in the EA Project Explorer and select the Version Control menu option To set the version control configuration then select the Version Control Options menu item The options on the Version Control menu are described in the following table Configure Package Displays the Package Control dialog which enables you to specify whether this package and its children is controlled and which file it is controlled through Check In Branch For the selected branch of the model i e the selected package and all of its child packages displays a list of all version controlled packages within that branch that are checked out to the current user You can then select packages in the displayed 1998 2009 Sparx Systems Pty Ltd 35 MDG Integration for Visual Studio User Guide EO list to be submitted for check in Check In Submits the currently selected package and all sub packages to the central repository Enterprise Architect prompts you to enter optional comments describing changes to the packages Check Out Retrieves the latest revision of the cu
23. ce Code Control 34 Synchronize TFS Work Items 29 cT Team Foundation Server Configure Connection 31 Connect To 31 Disconnect From 31 1998 2009 Sparx Systems Pty Ltd 55 MDG Integration for Visual Studio User Guide Team Foundation Server Import Work Items 29 Maintain Work Items 31 Synchronize Work Items 29 TFS Configure Connection 31 Connect To 31 Disconnect From 31 Import Work Items 29 Maintain Work Items 31 Synchronize Work Items 29 Topic Forum Add 26 UML 2 0 Using 14 UML Documentation View 14 Display Diagrams 21 UML Model 9 Using UML 2 0 14 Ve Version Control Assign 34 CheckIn 34 Check Out 34 Configure 34 Controlled Packages 38 CVS 34 Features 36 Get Latest 34 Get Package 34 Options 34 Overview 36 Put Latest 34 SCV 34 Setup 36 Subversion 34 System Requirements 36 TFS 34 Usage 36 View Model 20 UML Diagrams 21 Views Documentation 14 W Web Services WSDL 41 Work Item Manage Mapped Fields 33 Map Fields To Enterprise Architect Properties 33 Work Items Add New 31 Import 29 Link To Element 31 Remove From Element 31 Synchronize 29 TFS 29 TFS Maintain 31 WSDL 41 X XML Schema XSD 40 XML Technologies Introduction 39 Web Services WSDL 41 XML Schema XSD 40 XSD XML Schema 40 1998 2009 Sparx Systems Pty Ltd 56 1998 2009 Sparx Systems Pty Ltd MDG Integration for Visual Studio User Guide www sparx
24. ch relates to services in relation to the SOFTWARE PRODUCT the supplying of the services again or the payment of the cost of having the services supplied again TRADEMARKS All names of products and companies used in this EULA the SOFTWARE PRODUCT or the enclosed documentation may be trademarks of their corresponding owners Their use in this EULA is intended to be in compliance with the respective guidelines and licenses Windows Windows NT Windows ME Windows XP and Windows 2000 are trademarks of Microsoft GOVERNING LAW This agreement shall be construed in accordance with the laws of the Commonwealth of AUSTRALIA 1998 2009 Sparx Systems Pty Ltd 7 MDG Integration for Visual Studio User Guide 1 3 Using MDG Integration for Visual Studio The MDG Integration for Visual Studio brings together the model and design aspects of Enterprise Architect and UML with all the power of Visual Studio Architects and Engineers can communicate directly and efficiently within the Visual Studio environment and Engineers can see exactly which project elements they are working on and how they relate to the rest of a system Model elements appear in a special Enterprise Architect window within Visual Studio Navigation from code to model only takes a mouse click and does not require leaving the Visual Studio interface For example a workflow might go like this Architect and designers prepare the model In this case assume that
25. efreshed Synchronize Model with Click on the appropriate radio button cede Manual You manually synchronize the code with the model Automatically When code is added or saved the model is automatically updated to reflect the change In the MDG Integrate Options dialog the Automatically Sync model with EA option enables synchronization of the EA Project Explorer when you switch to the full Enterprise Architect user interface and back using the Open in Enterprise Architect menu option The Synchronize Model with Code Automatically radio button however makes MDG automatically reverse synchronize your source into your model when you save changes to your source files To automatically synchronize changes made in your model to your code open Enterprise Architect using the Open in Enterprise Architect command right click on the MDG linked package select the Build and Run Package Build Scripts menu option and select the Use Live Code Generation checkbox With this enabled any changes you make in your model should be immediately synchronized in your source code 1998 2009 Sparx Systems Pty Ltd 14 3 Start Using UML 2 1 UML elements can be viewed and to some extent manipulated through Enterprise Architect s Project Browser and Documentation View without linking For easy cross referencing of UML and code models however you must link a Visual Studio project to an Enterprise Architect package See Link To a Mode
26. element details This link to attribute details This link to operation method details Changes to any information in the Properties dialogs are automatically reflected on the Model tab In this example the Notes of Class Form1 have been modified 1998 2009 Sparx Systems Pty Ltd 17 MDG Integration for Visual Studio User Guide General Detail Require Constraints Link Scenario Files Name Stereotype v J Abstract Fi Author P Status Proposed Scope Public 4 Complexity Easy Alias Language C Persistence Keywords Phase Version Advanced Notes This is a modified form1 note This change will be reflected in the class properties The change is reflected in the UML Documentation tab below Form1 public Class amp Created 2007 05 18 08 55 46 Modified 2007 05 18 09 09 02 Project Advanced This is a modifed form1 note This change will reflect in the class properties Attributes Y Operations Taaaed Values Method All Public Protected Private Parameters Dispose bool void in bool disposing true if mar protected disposed otherwise false 1998 2009 Sparx Systems Pty Ltd Add New Elements Packages 18 3 2 Add New Elements Packages Add New Package MDG Integration for Visual Studio enables you to add new elements and packages to the model To start in the EA Project Explorer select the package under which to create your
27. ent Item Properties MDG Options Help About From these menus you can also perform other actions such as Browse UML 14 View Properties 16 Edit UML Diagrams 28 1998 2009 Sparx Systems Pty Ltd EA Project Explorer 16 XML Services 32 Import Team Foundation Server Work Items 22 Code Generation 424 Model Driven Transformation 467 Alternatively you can use the EA Project Explorer toolbar icons Ba D mE ITI O From left to right these icons enable you to Open the selected project in Enterprise Architect View the UML documentation Add a package Add a diagram Add an element Display the properties of the selected object Perform a search via the Search 2 tab 3 1 1 Object Properties Right click on an element diagram attribute or method in the EA Project Explorer and select the Properties context menu option Alternatively click on the object and on the Properties icon in the EA Project Explorer toolbar The appropriate Properties dialog displays See the Enterprise Architect User Guide for information on object properties and their settings responsibilities constraints links scenarios associated files object files and classifiers and boundary element settings To display Help on properties from the Enterprise Architect User Guide click on either The Help button on the displayed Properties dialog or This link to diagram details This link to
28. for this work item type 1998 2009 Sparx Systems Pty Ltd 31 MDG Integration for Visual Studio User Guide 4 1 Maintain Work Items The EA Work ltems tab enables you to add and update work items against a selected element configure the connection to the Team Foundation Server and connect to or disconnect from the server To display the EA Work ltems tab right click on the required element in the EA Project View and select the Team Foundation Server Maintain Work Items context menu option _ EA Work Items X t a xc235 Work Item Assigned To Created By Priority Title Requirement Alistair Lesli Alistair Lesli 2 Web Site 4 b Title web Site Type operational x Classification Area path uMReqiemets o mw Iteration path famapproved a wl Status Assignedto Alistar Lesie Hughes mBodedifes gt Priority f v state Proposed A Triage Triaged REST investigation Complete Committed No bd Description analysis Subject Matter Experts History Links Attachments Details Description The web site Needs to look pretty 2 The EA Work Items tab has a toolbar The functions provided by the toolbar icons are from left to right Add New Work Item create a new work item linked to the currently selected element Save Save all changes to the current work item selected from the panel underneath the toolbar Link
29. ghts SPARX may terminate this EULA if YOU fail to comply with the terms and conditions Upon termination YOU or YOUR representative shall destroy all copies of the SOFTWARE PRODUCT and all of its component parts or otherwise return or dispose of such material in the manner directed by SPARX WARRANTIES AND LIABILITY WARRANTIES SPARX warrants that the SOFTWARE PRODUCT will perform substantially in accordance with the accompanying written materials for a period of ninety 90 days from the date of receipt and any Support Services provided by SPARX shall be substantially as described in applicable written materials provided to YOU by SPARX and SPARX support engineers will make commercially reasonable efforts to solve any problems associated with the SOFTWARE PRODUCT EXCLUSIONS To the maximum extent permitted by law SPARX excludes for itself and for any supplier of software incorporated in the SOFTWARE PRODUCT all liability for all claims expenses losses damages and costs made against or incurred or suffered by YOU directly or indirectly including without limitation lost costs profits and data arising out of YOUR use or misuse of the SOFTWARE PRODUCT YOUR inability to use or obtain access to the SOFTWARE PRODUCT Negligence of SPARX or its employees contractors or agents or of any supplier of software incorporated in the SOFTWARE PRODUCT in connection with the performance of SPARX S obligations under this EULA or Termination
30. individual package element the Generate Package Source Code dialog displays The Code Services Generate Package option to generate code for the entire selected package the Synchronize Package Contents dialog displays with the options to either forward engineer the code from model to source or reverse engineer source to model Synchronization keeps your models and your code in line so that you can always be sure that what is represented in code is represented in the model For instance if you have made changes to a Class definition by hand coding your model is out of date Synchronization ensures that the Class you have altered is updated in the model to reflect the changes you have made Reverse Engineering The MDG Integration for Visual Studio is also able to reverse engineer both source code and Visual Studio binary portables into UML Class diagrams 1998 2009 Sparx Systems Pty Ltd 43 MDG Integration for Visual Studio User Guide 7 1 Import Binary Enterprise Architect is capable of reverse engineering Visual Studio portable binaries exe dll and generating Class models 1 Right click on the target package in which to store the resulting models in the EA Project Explorer and select the Code Services Import Binary Module context menu option The Import dialog displays File s CJ Source Type No file s selected Generation Import Method Synchronise existing classes ief Overwrite ex
31. ir component sub packages in a central repository This repository is maintained by third party version control applications that control access and record revisions Version controlled packages are packages that have been configured for use with version control software The supported Version Control products are CVS SCC TFS and Subversion EA Project Explorer i x UML Documentation UML Diagram Class Model Sse m o L8 O Model Search Y Forum Y Help 3 Class Model ria Account public Class table E asslibes tma 2006 02 20 144826 a Frameworks Open in Enterprise Architect Dites RES ACCA mi o E Package my Basket Order DeliveryAddress BilingAd s System Basket BillingAddress Delivery Address C vs Test Current Package C1 template E Use Case Configure Package table Acc XML Services Check In Branch vw Aetiorid Code Services Check In C3 Activity1 O activity Initi Team Foundation Server 2 Actori Find in Class Vi dE ind in Class View business a Browse Definition Q Choice Classi Refresh Current Item amp PublicOf Build amp sampled PRESAS Ej entity Cla Debug ent ZA El Classii Run File History El Classi2 es El Classi3 Properties Get Package El Classi4 Version Control Options li Classis innui Work Offline El Class16 Help El Class17 About El Classis Version control can be assigned to individual packages Each package
32. isting Classes g Create Logical Diagram for et EA le each package C Do not import private members Please be aware that creating diagrams for each package may significantly increase the time required to import 2 Select the file to import Once you have selected the file you must set certain options as outlined below 3 Once all your settings are set click on the Import button Enterprise Architect imports the binary module the UML representation is then constructed as a diagram and laid out Generation Select whether Pre existing classes are to be synchronized or overwritten To automatically create a Logical Diagram for each package To import private members New Diagram Options This button displays the New Diagram Options dialog through which you define what features are to be visible in any diagrams generated by the import Import Method Enables you to select the method Enterprise Architect uses to analyse the binary file Select from Reflection Disassembly or Let EA decide which triggers Enterprise Architect to select the most appropriate method for the selected file 1998 2009 Sparx Systems Pty Ltd Import Directory 44 7 2 Import Directory Reverse engineering your project code into UML Class models is a simple process as follows 1 Create and link a new package or use a linked package associated with the project to reverse engineer 2 Right click on the package name in the EA
33. l Package 11 for instructions Equally you can double click on any EAP file visible in the Solution Explorer This activates the MDG Integration for Visual Studio main interface components The EA Project Explorer 154 window which shows the UML packages diagrams and elements in a hierarchical view The UML Documentation tab which is the main work area of MDG Integration for Visual Studio see below The lt elementname gt lt language gt tab which displays the code for an element selected from the EA Project Explorer The UML Diagram tab 284 which displays a diagram selected from the EA Project Explorer or UML Documentation tab The UML Documentation tab itself has four tabs The Model 20 tab displays the diagrams and UML properties of the model elements most of the report information from the MDG Integration for Visual Studio is displayed on this tab The Search 24 tab is used to find UML elements search returns are shown as a report view with clickable items The Forum 26 tab enables you to discuss projects using a BBS style forum interface within Visual Studio The Help tab displays the HTML based help for quick reference UML Documentation Form1 public Class E Created 2007 05 18 08 55 46 Modified 2007 05 18 08 55 46 Diagrams WindowsApplications E Project E Advanced Associations From Y Taaaed Values Element Type Source Role Program Class To display the UML Documentation tab in the EA
34. l Studio screen EA Project Explorer 5 H Class Model TS Class Model q Ti Class Model 4 Class Model 3 ClassLibrary1 J Experiment GD Frameworks J Package2 J System Ca vs Test S L template Embed Multiple Models While it is possible to embed multiple Enterprise Architect models into a single Visual Studio solution and embedded projects it is not possible for the MDG to identify which of multiple linked projects contain an element you are trying to view eg through View in UML It is therefore important that you ensure that any linked model is in the Solution Items folder and is the first model listed in that folder See Also Link to a Model Package 11 1998 2009 Sparx Systems Pty Ltd 11 MDG Integration for Visual Studio User Guide 2 2 Link to a Model Package To link a Visual Studio project with an Enterprise Architect model package follow these steps Select an existing package or create a new model package in the EA Project Explorer right click on the parent node and select the Add New Package menu option give the package a meaningful name Link the package to a Visual Studio project by right clicking on the package and selecting Current Package Link Existing UML Package to Visual Studio Project The Connect Project dialog displays listing the currently active projects Select the project to link with the Enterprise Architect file and click the OK butt
35. lect all projects in the list Click on the OK button to reverse engineer the project s A new package is generated for each project under the selected parent package Once the Integration Environment has successfully imported and linked the projects you can view them in the EA Project Explorer 15 window 1998 2009 Sparx Systems Pty Ltd 13 MDG Integration for Visual Studio User Guide 2 4 MDG Integrate Options Before you start using the MDG Integration for Visual Studio you should set the options for synchronizing your work in Visual Studio and Enterprise Architect In the EA Project Explorer window right click on the linked package and select the MDG Options context menu option The MDG Integrate Options dialog displays OCT EP EPL Automatically Sync model with EA recommended Synchronize Model with Code O Manual Automatically Automatically Synch model MDG automatically refreshes the EA Project Explorer when elements within with EA recommended Enterprise Architect change Switch to Visual Studio on Click on the appropriate radio button closing Enterprise Architect Refresh Entire Model The entire model is refreshed Refresh Current Model The currently selected package in MDG is refreshed when Enterprise Architect is closed Note If a non package is selected MDG iterates up the tree and refreshes from the first package that is found Do not Refresh Anything Nothing is r
36. matting options for text lO Click on this button to confirm the message 1998 2009 Sparx Systems Pty Ltd Edit Diagrams 28 3 6 Edit Diagrams You can easily edit the UML diagrams from the EA Project Explorer in two ways by Double clicking on a diagram name or Right clicking on a diagram name and selecting the Edit Diagram menu option The selected diagram displays on the UML Diagram tab as shown below EA Project Explorer Class Model EB Class Model EL n Clas o oo 2 Experiment S Frameworks J Package2 amp System responsibilities Requirement 1 test scripts Unit Pass Test 1 Unit Not Run Test 2 CA vs Test amp amp C template nokis This is a Notes element you can a This is some Notes text It is formatted FRA Use Case 1 x format the text of this element i ab lon Accor On the Notes field of the Properties fon B dialog A Account Inthe Notes compartment of the You can display the Notes text of Responsibilities Tests and Constraints here using Tagged Values to show the descriptions E Basket E Bilingaddress DeliveryAddress E order Q column Order Q column BillingAddr q column Basket q column DeliveryAc LA Functional REQOS element and In the Motes window Order BilingAddress BIGINT B
37. n Server Manage Mapped Fields context menu option 1998 2009 Sparx Systems Pty Ltd 30 Configure Field Mappings l x Work Item Type x Dont create Elements for this work item type UML Element Action Element Stereotype Y Work Item Field E Property Title State Rev Changed By Issue State Change Date Activated Date Activated By Resolved Date Reason Resolved By Assigned To Work Item Type Closed Date Closed By Priority Test Name gure Clear Defaults OK Cancel CA Work Item Type Click on the drop down arrow and select the type of work item to configure Don t create Elements for this work Select this checkbox to prevent MDG Integration For Visual Studio item type from creating an Enterprise Architect element if the query returns a work item of the specified type UML Element If MDG Integration For Visual Studio is to create an element click on the drop down arrow and select the type of element to create Element Stereotype If required click on the drop down arrow and select the stereotype to apply to the element Work Item Field If required click on a work item field against which to configure an Enterprise Architect property Configure Click on this button to select an Enterprise Architect property to configure against the selected work item field Clear the currently selected mapping Default Apply the default mapping
38. new package and either Right click and select the Add New Package context menu option or Click on the New Package icon in the EA Project Explorer toolbar Give the package a relevant name If you do not want a diagram for this package deselect the Automatically add new diagram checkbox Click on the OK button If you are also adding a diagram provide the diagram name and type on the New Diagram dialog Add New Element Either Right click on the newly created package and select the Add New Element context menu option or Click on the New Element icon in the EA Project Explorer toolbar The New Element dialog displays In this example the selected Type is UseCase with the name Use Case 1 Type UseCase v Mame Use Case 1 Stereotype Ivi Open Properties Dialog on Creation Close dialog on OK Checkboxes Open Properties Dialog on Creation Select this checkbox to display the Properties dialog for the element to tailor its information for more information on this window see Object Properties 16 Close Dialog on OK Closes the New Element dialog when you click on the OK button deselect the checkbox to add multiple elements in one go Add to Current Diagram Add the newly imported Class to the open diagram Add Model using Wizard You can also add one or more basic model structures to your project using a template wizard Right click on the appropriate root package and select the Add Add Model using Wizard con
39. o deployed artifacts Increase productivity by linking UML models to Domain Specific Language DSL tools and artifacts Import and synchronize work items from Team Foundation Server Before working with MDG Integration for Visual Studio please review the following Copyright Notice s Software Product License Agreement 4 Using MDG Integration For Visual Studio 7 1998 2009 Sparx Systems Pty Ltd 3 MDG Integration for Visual Studio User Guide 1 1 Copyright Notice Copyright 1998 2009 Sparx Systems Pty Ltd All rights reserved The software contains proprietary information of Sparx Systems Pty Ltd It is provided under a license agreement containing restrictions on use and disclosure and is also protected by copyright law Reverse engineering of the software is prohibited Please read the license agreement 4 for full details Due to continued product development this information may change without notice The information and intellectual property contained herein is confidential between Sparx Systems and the client and remains the exclusive property of Sparx Systems If you find any problems in the documentation please report them to us in writing Sparx Systems does not warrant that this document is error free No part of this publication may be reproduced stored in a retrieval system or transmitted in any form or by any means electronic mechanical photocopying recording or otherwise without the prior w
40. of this EULA by either party for any reason LIMITATION The SOFTWARE PRODUCT and any documentation are provided AS IS and all warranties whether express implied statutory or otherwise relating in any way to the subject matter of this EULA or to this EULA generally including without limitation warranties as to quality fitness merchantability correctness accuracy reliability correspondence with any description or sample meeting your or any other requirements uninterrupted use compliance with any relevant legislation and being error or virus free are excluded Where any legislation implies in this EULA any term and that legislation avoids or prohibits provisions in a contract excluding or modifying such a term such term shall be deemed to be included in this EULA However the liability of SPARX for any breach of such term shall if permitted by legislation be limited at SPARX S option to any one or more of the following upon return of the SOFTWARE PRODUCT and a copy of the receipt If the breach relates to the SOFTWARE PRODUCT the replacement of the SOFTWARE PRODUCT or the supply of an equivalent SOFTWARE PRODUCT the repair of such SOFTWARE PRODUCT or the payment of the cost of replacing the SOFTWARE PRODUCT or of acquiring an equivalent SOFTWARE PRODUCT or the payment of the cost of having the SOFTWARE PRODUCT repaired 1998 2009 Sparx Systems Pty Ltd Software Product License Agreement 6 If the brea
41. ollow the steps below 1 Inthe EA Project Explorer right click on the required package and select the Team Foundation Server Import Work Items context menu option The Select Queries dialog displays Select Queries Custom Requirements x Active Bugs O Issues L All My Team Project work Items C Mitigation Action Status C All Tasks D My work Items DO All Work Items C Product Requirements CO Blocked work Items O Resolved Bugs C Change Requests O Reviews O Corrective Actions O Risks O Customer Requirements CO Custom Requirements O Development Tasks Select All Select None Link Selected Queries to Package DK Cancel 2 Click on the checkbox against each query for which to import work items from Team Foundation Server 3 Click on the Link Selected Queries to Package checkbox 4 Click on the OK button The work items in the selected queries are imported and if the Link Selected Queries to Package checkbox is selected the queries are stored against the package You can return to this dialog to add and remove queries for a package Synchronize With TFS When a package has stored queries against it new elements are automatically added and existing elements updated based on each query Note Elements are never deleted To manage the mapped fields for a work item linked against a UML element right click on the required package in the EA Project Explorer and select the Team Foundatio
42. on OS Cosjgaci Projecti Select an unassigned Visual Studio project to link to Class Model Solution Explorer va x c ClassLibrary1 od Solution ClassLibrary1 1 project E ClassLibrary1 2 jg Properties AssemblyInfo cs B Ly References 43 System 43 System Data C3 System xml c Classt cs on Project eap When a package has been linked this status is indicated by a Visual Studio icon next to the package name 64 Class Model The UML package and the Visual Studio project are now integrated enabling you to work using the UML model and the powerful toolset of Enterprise Architect all from within Visual Studio See Also Multiple Linkings 12 1998 2009 Sparx Systems Pty Ltd Multiple Linking 12 2 3 Multiple Linking It is possible to link many different Visual Studio projects with multiple UML packages simultaneously Right click on the required parent package in the EA Project Explorer window and select the Current Package Import and Link Visual Studio Projects menu option Select one or more unassigned Visual Studio projects to import under EA Package Documenter e bytecode t LA Xm c LinearHtml c NativeHtmlHelp2 F qi UsersGuide The Connect Project dialog lists the Solution Projects which are yet to be linked to a UML model Select the check box for each project to import or click on the Select All button to se
43. on for Visual Studio s version control facility your version control software must be installed on each machine where it is intended to be used Typically there are A server component that manages a version control repository Client components on the workstations that MDG Integration for Visual Studio uses to communicate with the server A version control client must be installed on every machine where you run MDG Integration for Visual Studio and want to access your version control system Once the version control software has been installed and configured you must define a Version Control Configuration within MDG Integration for Visual Studio to use your installed version control product Usage There are four basic ways in which you might apply the version control facility Use Jon S Single Shared model Multiple Private models Shared packages Standard packages Users share an MDG Integration for Visual Studio model stored in a central EAP file or DBMS repository This configuration enables users to see other users packages without explicitly having to retrieve them Version control regulates access to packages and maintains package revision history An MDG Integration for Visual Studio model is created by a single user who configures it for version control The model file is then distributed to other users with each user storing their own private copy of the model Users update their model s packages through ve
44. or from the use of programs and source code that may accompany it In no event shall the publisher and the author be liable for any loss of profit or any other commercial damage caused or alleged to have been caused directly or indirectly by this document Printed January 2009 Special thanks to Publisher Sparx Systems All the people who have contributed suggestions examples bug reports and assistance in the development of MDG Integration for Visual Studio The task of developing and maintaining this tool has been greatly enhanced by their Geoffrey Sparks contribution Managing Editor Technical Editors Alistair Leslie Hughes I MDG Integration for Visual Studio User Guide Table of Contents Foreword Introduction Copyright Notice Software Product License Agreement Using MDG Integration for Visual Studio Getting Started Add an Enterprise Architect Model Link to a Model Package Multiple Linking MDG Integrate Options Start Using UML 2 1 EA Project Explorer Object Properties 10er eerie eee trie euo en Renee nenne einen ten ae Ya ge Duce vegas obe peu een eine sue ste re Add New Elements Packages Model Tab Navigating Bs yonin c MX View UML diagrams M Search Tab Project Discussion Forum Categories Topics arid Posts rere eor eorr noinen Cano neo nU s Ce NEP aeo aea uo Sr NER PN SEN ESO ressentent Forum Message Dialog m
45. ox next to the column title 1998 2009 Sparx Systems Pty Ltd 25 MDG Integration for Visual Studio User Guide Object Icon v Object Type Stereotype Scope Status Phase Created Modified 0 RequirementT ype Filename Alias C Author version F Language Notes w 1998 2009 Sparx Systems Pty Ltd Project Discussion Forum 26 3 5 Project Discussion Forum The Project Discussion Forum can be used to discuss the development of your project from within the Visual Studio environment It operates much like any other web based forum you might have used applying the concept of Categories Threads and Posts You can access the Project Discussion Forum via the UML Documentation tab selecting the Forum tab The Forum tab consists of two main areas the message thread area and the message contents area The message thread area is located on the left hand side and appears as a tree The message thread area is used to create new categories and threads and to select posts for viewing editing or deleting When a post is selected for viewing it appears in the message contents area on the right hand side UML Documentation ClassDiagram1 cd Pot UML Diagram Planning Classi cs xX Elements i Diagram edits This is the message content In this space you can type whatever message or Diagrams explanation you want
46. port Binary 43 Database Schema from ODBC 48 DDL Schema from ODBC 48 Directory 44 TFS Work ltems 29 1998 2009 Sparx Systems Pty Ltd Index 54 L License Agreement 4 Link Multiple Projects 12 To Model Package 11 Visual Studio Project To Model Package 11 Visual Studio Solution To Model Package 11 Manage Mapped Work Item Fields 33 Mapped Fields Manage 33 MDA Transformation 46 MDG Integration for Visual Studio Components 14 Copyright Notice 3 Getting Started 8 Introduction 2 Model Tab 20 Options 13 Overview 7 Software Product License Agreement 4 Using 14 Workflow 7 Message Dialog Create New Category 27 Create New Post 27 Create New Topic 27 Edit Post 27 Reply to Post 27 Model Driven Transformation 46 Model Package Link Project To 11 Model Tab 20 Hyperlinks 20 View UML Diagrams 21 Model Wizard 18 Multiple Linking 12 0 ODBC Import From 48 Options Refresh Model 13 Synchronize Code 13 P Package Add 18 Assign Version Control 34 Check In 34 Check Out 34 Configure 34 Controlled 38 Get Latest 34 Get Package 34 Put Latest 34 WSDL Namespace 41 PIM 46 Platform Independent Model 46 Platform Specific Model 46 Post Forum Add 26 Edit 26 Reply To 26 Properties Diagram 16 PSM 46 R Reply To Post In Forum 26 Reverse Engineer Import Binary 43 Import Directory 44 ODBC Data Sources 48 RTF Documentation Generate 51 Run Search 24 S Search Project 24 Sour
47. ritten permission of Sparx Systems Licensed users are granted the right to print a single hardcopy of the user manual per licensed copy of the software but may not sell distribute or otherwise dispose of the hardcopy without written consent of Sparx Systems Sparx Systems Pty Ltd 7 Curtis St Creswick Victoria 3363 AUSTRALIA Phone 61 3 5345 1140 Fax 61 3 5345 1104 Support Email support sparxsystems com Sales Email sales sparxsystems com Website www sparxsystems com Visual Studio is copyright C 2009 Microsoft website msdn microsoft com vstudio 1998 2009 Sparx Systems Pty Ltd Software Product License Agreement 4 1 2 Software Product License Agreement MDG Integration Version 4 0 for Visual Studio Copyright 1998 2009 Sparx Systems Pty Ltd All Rights Reserved IMPORTANT READ CAREFULLY This End User License Agreement EULA is a legal agreement between YOU as Licensee and SPARX for the SOFTWARE PRODUCT identified above By installing copying or otherwise using the SOFTWARE PRODUCT YOU agree to be bound by the terms of this EULA If YOU do not agree to the terms of this EULA promptly return the unused SOFTWARE PRODUCT to the place of purchase for a full refund The copyright in the SOFTWARE PRODUCT and its documentation is owned by Sparx Systems Pty Ltd A C N 085 034 546 Subject to the terms of this EULA YOU are granted a non exclusive right for the duration of the EULA to use
48. rrently selected package and sub packages from the central repository overwriting the current packages After check out the packages are available for editing Undo Check Out Cancels all changes you have made to the currently selected package and sub packages Restores the model to the state it was in before package was checked out leaving the selected package and sub packages locked Get Latest Available only on Private Models for packages that are checked in Retrieves the latest revision of the package from the repository Get All Latest Available only on Private Models Retrieves the latest revision of all version controlled packages in the project Only retrieves packages that are checked in Put Latest Updates the central repository with the currently selected package which you have checked out while retaining checkout status on the package This is equivalent to checking a package in and immediately checking it back out again File Properties Asks the version control provider to show the version control properties associated with the XML export file pertaining to the currently selected package File History Where the controlling package has been configured by an SCC provider this provider shows a change history for the package Refer to your provider s documentation for details on how to use the control Otherwise if the version control is CVS the history is shown via Enterprise Architect s internal CVS history menu Get P
49. rsion control Version control regulates access to packages and maintains package revision history Other users new packages are retrieved using the Get Package menu option Individual users create separate MDG Integration for Visual Studio models but share one or more packages Users share packages through version control A company might have a standard set of packages that are broadly shared as read only files Individual users retrieve packages with the Get Package menu option 1998 2009 Sparx Systems Pty Ltd 37 MDG Integration for Visual Studio User Guide See Also Version Control 34 Controlled Packages 38 O 1998 2009 Sparx Systems Pty Ltd Controlled Packages 38 5 2 Controlled Packages Controlled packages are a powerful means of externalizing parts of an MDG Integration for Visual Studio model Using controlled packages you can Support widely distributed development by having team members submit packages in the form of XML for import into a central Enterprise Architect repository Support version control by writing model elements in XML text files suitable for version control using standard version control software Using XMI this way enables you to manually connect to third party version control software outside the MDG Integration for Visual Studio environment MDG Integration for Visual Studio internally supports the configuration of version control through SCC
50. s associate business processes mm Note Note Public Proposed 1 0 20 11 2005 The Stakeholders package contains model elements representing the various people organizations and information sys some way connected into the current business context m Note Note Public Proposed 1 0 20 11 2005 The Business Objects package contains representations of information reports data stores and other artifacts which and used within the business workflows E report1 Object information Public Proposed 1 0 11 01 2006 e Note Note Public Proposed 1 0 20 11 2005 The Workflow package contains diagrams modeling the processing of information flows throughout the business domai Fs Note Public Proposed 1 0 5 01 2006 In the Search Term input box enter the text string to search for then click on the drop down arrow in the Search List field and select the type of search to perform Simple Extended Created _ Attribute Details ire are no items Find Orphans Failed Internal Tests Method Details Responsibility Resources Requirements Sams Search Run Search J Columns Modifie To execute the search click on the Run Search button You can click anywhere on the entry for a returned result to navigate to the Model tab for the item You can also specify which columns are returned Click on the Columns button to display a list of the information that is returned To turn a column on or off simple select or deselect the checkb
51. systems com
52. t Explorer and select the Current Package Manage Baselines menu option Baselines MDG integration for Visual Studio provides a facility to create a Baseline snapshot of the contents of a selected package and its child packages at a particular point in time enabling you to later compare that branch of the model at that time with the current state of the branch Baselines are stored in the same XML format as is used for version control but are stored within the project in compressed format You can also have parallel copies of parts of your model for team development and create Baselines within each copy to merge changes into the project master Differencing Differencing Diff or Compare enables you to explore the differences between the current state of a specific part of your project and previous or parallel versions captured in a Baseline or an XML file on disk Merges Once Differencing is complete you can merge information from the Baseline into the current project it is not possible to go the other way You can merge information manually change by change or automatically by electing to merge in all changes in one batch procedure You can also revert completely to the original Baseline by importing the stored XMI directly and merge in information and elements from a Baseline in a different project making it possible to keep multiple versions of a single model in synch For further information on the Baseline and Differencing f
53. t icon to open Enterprise Architect in the current model If Enterprise Architect is already open this icon opens another instance of the application Click on the code page icon to display the lt elementname gt lt language gt tab which displays the code for the selected element including its attributes operations and associations The element s attributes operations Tagged Values parameters and associations both to and from the element are also shown in the main body of the Model tab Additional information on the element can be seen by clicking on the Project and Advanced expansion boxes 3 3 1 Navigating Hyperlinks Within the UML Documentation tab you can navigate between diagrams and sections using hyperlinks UML Documentation Model Search Forum feio Form1 public Class E Created 2007 05 18 08 55 46 Modified 2007 05 18 08 55 46 Diagrams WindowsApplications Project E Advanced Associations From Y Taqqed Values lement Type Source Role Program Class 1998 2009 Sparx Systems Pty Ltd 21 MDG Integration for Visual Studio User Guide For example you might click on the diagram name and display the diagram 21 Or perhaps under the Associations From tab click on an element hyperlink such as Program above and display the element details for the source element On that screen you could check under the Associations To tab and follow the link back to
54. t menu displays 2 Select the XML Services Generate XML Schema menu option The Generate XML Schema dialog displays showing the name of the selected package in the Source Package field 3 Seethe Generate XSD topic in the Enterprise Architect User Guide Import XSD The mport XML Schema facility reverse engineers a W3C XML Schema XSD file as a UML Class model XSD files are imported into MDG Integration for Visual Studio as a UML package To import an XSD file follow the steps below 1 In the EA Project Explorer right click on the package to contain the imported XSD package The context menu displays 2 Select the XML Services Import XML Schema menu option 3 See the Import XSD Schema topic in the Enterprise Architect User Guide 1998 2009 Sparx Systems Pty Ltd 41 MDG Integration for Visual Studio User Guide 6 2 Web Services WSDL MDG Integration for Visual Studio supports forward engineering and reverse engineering of the W3C Web Service Definition Language WSDL WSDL documents are represented as components marked with the stereotype WSDL WSDL documents are contained in a package hierarchy representing the target WSDL namespace and its constituent XSD Types Messages PortTypes Bindings and Services The top level package is stereotyped as a WSDLnamespace The figure below shows a skeletal WSDL namespace package structure EA Project Explorer A TA Overview S5 xSDschema T
55. t on the UML Documentation tab This is the view in which you can edit the diagram 1998 2009 Sparx Systems Pty Ltd Model Tab 22 ML Diagram Planning You can also add your elements into a new Visual Studio Class diagram To do this right click on an element inside a linked folder and select the View Class Diagram context menu option The Class Details tab displays at the bottom of the screen and a Diagram tab opens in the body of the screen Hide Modifier Summary Type Methods iQ add method gt Properties if lt add property gt Fields EQ lt add field gt amp Events L4 lt add event gt O 1998 2009 Sparx Systems Pty Ltd 23 MDG Integration for Visual Studio User Guide ClassDiagram1 cd UML Document Classi 1 Class 1998 2009 Sparx Systems Pty Ltd Search Tab 24 3 4 Search Tab The Search tab is a convenient way of locating the elements of a model You can search on a range of criteria from element name type and scope to element connections or status within a project work in progress completed To begin a search click on the Search tab UML Documentation The Business Process Model describes both the behavior and the information flows within an organization or system As a model of business activity it captures the significant events inputs resources processing and output
56. text menu option The Model Wizard dialog displays 1998 2009 Sparx Systems Pty Ltd 19 MDG Integration for Visual Studio User Guide T Select model s to add to your project Select from Common Technology Name CE User Interface Project Management Maintenance Testing Deployment Component Database Class Dom Th BE S PL ICI ES Click on the checkbox for each model to add to your project Select the model template group from which to select the template on which to base the model E Select all of the models Dee omnes or CE eger Des ET TT m 1998 2009 Sparx Systems Pty Ltd Model Tab 20 3 3 Model Tab The Model tab shows the currently selected model element The element name is displayed In the top left corner of the tab UML Documentation Classi cs Model Search Forum Help Class7 public Class table E Created 2007 04 18 14 56 10 Modified 2007 12 18 09 40 02 Diagrams Class Model Project Attributes Operations Tagged Values Method Al Public Protected Private Parameters Details FK Class Table2 VARCHAR in VARCHAR Something Tags public FK property Delete Cascade 0 Update Cascade 0 PK Class VARCHAR public PK in VARCHAR Sempervit Just after the element name are two icons an Enterprise Architect icon and a code page icon Click on the Enterprise Architec
57. the SOFTWARE PRODUCT YOU do not acquire ownership of copyright or other intellectual property rights in any part of the SOFTWARE PRODUCT by virtue of this EULA Your use of this software indicates your acceptance of this EULA and warranty DEFINITIONS In this End User License Agreement unless the contrary intention appears EULA means this End User License Agreement SPARX means Sparx Systems Pty Ltd A C N 085 034 546 Licensee means YOU or the organization if any on whose behalf YOU are taking the EULA Registered Edition of MDG Integration for Visual Studio means the edition of the SOFTWARE PRODUCT which is available for purchase from the web site http www sparxsystems com ea purchase htm following the thirty day free evaluation period SOFTWARE PRODUCT or SOFTWARE means MDG Integration for Visual Studio which includes computer software and associated media and printed materials and may include online or electronic documentation Support Services means email based support provided by SPARX including advice on usage of Enterprise Architect investigation of bugs fixes repairs of models if and when appropriate and general product support SPARX support engineers means employees of SPARX who provide on line support services Trial edition of MDG Integration for Visual Studio means the edition of the SOFTWARE PRODUCT which is available free of charge for evaluation purposes for a period of 30 days GRANT OF LI
58. ual Studio enables forward and reverse engineering of W3C XML schemas XSD Model XSD Schema XML schemas are modeled using UML Class diagrams within MDG Integration for Visual Studio as in Enterprise Architect See the Model XSD Schema help topic in the Enterprise Architect User Guide The UML Profile for XSD specifies a set of stereotypes Tagged Values and constraints that can be applied to the UML model in order to change particular aspects of the resulting schema Note You cannot edit Tagged Values in MDG Integration for Visual Studio To work on Tagged Values switch to Enterprise Architect When modeling XSD constructs it is often useful to have the XSD primitive types represented as UML elements In this way user defined types for example can reference the datatype elements as part of inheritance or association relationships Sparx Systems provides the set of primitive XSD data types as a UML package in the form of an XMI file Each XSD primitive type is represented by a UML Class in a package named XSDDatatypes Generate XSD The Generate XML Schema feature forward engineers a UML Class model to a W3C XML Schema XSD file An XML schema corresponds to a UML package in MDG Integration for Visual Studio therefore XML schema generation is a package level operation To generate an XML schema from a package follow the steps below 1 In the EA Project Explorer right click on the package to be converted to XSD The contex
59. urchased as described at http www sparxsystems com ea purchase htm Upon payment of the license fee YOU will be sent details on where to download the registered edition of MDG Integration for Visual Studio and will be 1998 2009 Sparx Systems Pty Ltd 5 MDG Integration for Visual Studio User Guide provided with a suitable software key by email ADDITIONAL RIGHTS AND LIMITATIONS YOU hereby undertake not to sell rent lease translate adapt vary modify decompile disassemble reverse engineer create derivative works of modify sub license loan or distribute the SOFTWARE PRODUCT other than as expressly authorized by this EULA YOU further undertake not to reproduce or distribute license key codes except under the express and written permission of SPARX If the Software Product purchased is an Academic Edition YOU ACKNOWLEDGE THAT the license is limited to use in an educational context either for self education or use in a registered teaching institution The Academic Edition may not be used to produce commercial software products or be used in a commercial environment without the express written permission of SPARX ASSIGNMENT YOU may only assign all your rights and obligations under this EULA to another party if YOU supply to the transferee a copy of this EULA and all other documentation including proof of ownership Your license is then terminated TERMINATION Without prejudice to any other ri
60. ution or project you can add it using the standard Visual Studio facilities Project Add Existing Item Shift Alt A Solution Explorer s context menu Add Existing Item The following illustration shows the Solution Explorer option Add Reference Add Web Reference New Folder iy Windows Form amp View Class Diagram 1 E User Control Set as StartUp Project td Component Debug wg Class Cut T3 X Remove Rename Unload Project Properties ClassLibrary E When an Enterprise Architect model has been added in this way it might appear in the Solution Explorer unopened To open it double click on it Create New Enterprise Architect Models New Enterprise Architect models are created using a wizard available through either the Project Menu Attach UML Model menu option or through the solution s context menu as indicated below Models added in this way are always placed inside the Solution Items folder O 1998 2009 Sparx Systems Pty Ltd Add an Enterprise Architect Model 10 Solution Explorer H Build Solution Rebuild Solution Clean Solution Batch Build Configuration Manager Add gt Set StartUp Projects Rename Properties After a new or existing model has been added through the ensuing wizard the model hierarchy displays in an Enterprise Architect EA Project Explorer 15 window on the Visua
61. ype UML Element Action Element Stereotype M Work Item Field E Property Title State Rev Changed By Issue State Change Date Activated Date Activated By Resolved Date Reason Resolved By Assigned To Work Item Type Closed Date Closed By Priority Test Name xl om Clear Defaults OK Cancel 7 Work Item Type Click on the drop down arrow and select the type of work item to configure Don t create Elements for this work Select this checkbox to prevent MDG Integration For Visual Studio item type from creating an Enterprise Architect element if the query returns a work item of the specified type UML Element If MDG Integration For Visual Studio is to create an element click on the drop down arrow and select the type of element to create Element Stereotype If required click on the drop down arrow and select the stereotype to apply to the element Work Item Field If required click on a work item field against which to configure an Enterprise Architect property Configure Click on this button to select an Enterprise Architect property to configure against the selected work item field Clear the currently selected mapping Default Apply the default mapping for this work item type 1998 2009 Sparx Systems Pty Ltd 34 5 Version Control MDG Integration for Visual Studio supports Enterprise Architect s version control of packages and the
62. ypes TA Types xSDcomplexTypes InputParameters XSDcomplexTypes OutputParameters 5 Messages TA Messages amp Ej WSDLmessage SampleInput 4 WSDLmessage SampleOutput SI PortTypes TE PortTypes WSDLportType SamplePortTypeHTTP H WSDLportType SamplePortTypeSOAP SI Bindings TE Bindings Ej WSDLbinding SampleBindingHTTP WSDLbinding SampleBindingSOAP i Services TA SampleService 9 WSDLservices SampleService SJ WSDL Sample WSDLFile amp WSDL WSDLComponent1 E E E E A WSDLnamespace package can contain one or more WSDL components Each WSDL component can be automatically generated to a WSDL file using Enterprise Architect s built in WSDL generator For information on the Enterprise Architect WSDL generator and importing WSDL see the Enterprise Architect User Guide via this Sparx Systems web Help link 1998 2009 Sparx Systems Pty Ltd 42 7 Working with Code MDG integration for Visual Studio enables you to generate code directly from model packages and elements and to automatically synchronize model and code To generate code for a UML model element such as a Class right click on it in the EA Project Explorer and select the Code Services Generate Code context menu option To generate the code for a model package right click on the package and select either of the following The Code Services Generate Code context menu option to simply generate code for an

MDG Integration for Visual Studio User Guide

Contents

Download Pdf Manuals

Related Search

Related Contents