IBM Software Group ® Overview of SA and RSA Integration John Jessup June 1, 2012 Slides from Kevin Cornell December 2008 Have been reused in this presentation.

IBM Software Group | Rational software 2 Integrations Between the Two Tools UML Demo:  UML Modeling Transform Utility – Circa 2009  BPMN 2.0 Exchange, 2012 Discuss:  Java Emitter Template Agenda:

IBM Software Group | Rational software 3 Integrations Between the Two Tools UML Demo:  UML Modeling Transform Utility – Circa 2009  BPMN 2.0 Exchange, 2012 Discuss:  Java Emitter Template Agenda:

IBM Software Group | Rational software 4 What are the Business Use Cases?  Existing System Architect Models => Rational RSx  Business / UML Models exist in System Architect  User wishes to re-use models from System Architect in Rational RSx  Detailed technical Modeling in Rational RSx  Existing Rational RSx Models => System Architect  Technical UML Models exist in Rational RSx  User wishes to re-use models in System Architect  Use the technical UML model as basis for generalization into an Enterprise model  Co-operative Modeling - System Architect  Rational RSx  Business / UML Models from System Architect refined in RSx  Brought back into System Architect to update the Enterprise view from the updated detailed model Slide from Kevin Cornell December 2008

IBM Software Group | Rational software 5 System Architect integration overview  Integration is currently limited to a subset of the UML that is supported by System Architect (SA)  Does not support DoDAF, MODAF, IDEF or other frameworks that are available in SA  Integration is really a proof of concept that data can be exchanged between SA and the Rational Software modeling products (RSx)  Integration is accomplished by export and import wizards  An intermediate XML data file is exported from SA and then imported into RSx  Also, limited support for exporting an XML data file from RSx and importing into a System Architect encyclopedia  Installation product feature called “System Architect Integration”  Available in the versions of RSA-WS, RSA-SE, RSA-RTE and RSM  Available only in the Windows versions of the products (not Solaris or Linux) Slide from Kevin Cornell December 2008

IBM Software Group | Rational software 6 SA integration workflows  Multiple workflows are supported between SA and RSx  A) Initial populating of an RSx UML model from an SA encyclopedia  B) Updating the RSx UML model with changes made in the SA encyclopedia, using the fuse technology  C) Reconciling the RSx UML model back to the SA encyclopedia  Workflows are affected by the following  The import and export wizards use model-to-model transformations  Merge technologies are more flexible in RSx than in SA  The RSx fuse technology does not support diagram merges. Slide from Kevin Cornell December 2008

IBM Software Group | Rational software 7 SA integration workflows (continued)  A) Initial populating of an RSx UML model  In SA, the user defines a high level architecture (stored in an encyclopedia)  In SA, the desired elements and diagrams are exported to an XML data file  In RSx, a model project with a blank UML model is created as the target model  In RSx, the exported XML data file is copied into workspace project  In RSx, the SA import wizard is used to transform the XML data into UML where the source is the XML data file and the target is the UML model  At the end of the import, a fuse is performed between the transformed UML data and the target (UML) model; for an initial import, the user can simply accept all fuse changes and update the blank UML model  This initial UML model is the baseline SA model that may be used in other workflows; the user may want to keep a separate copy of this model SA encyclopedia XML data SA export RSx import (accept all fuse changes) working UML model baseline UML model RSx (manually copy the UML model) Slide from Kevin Cornell December 2008

IBM Software Group | Rational software 8 SA integration workflows (continued)  B) Updating the RSx UML model with SA changes using fuse  In SA, changes are made to the architecture design based on new requirements or information; user wants to update the RSx UML model with these changes  In RSx, the UML model created in workflow A is modified as implementation of the architecture proceeds  In SA, the desired elements and diagrams are exported to an XML data file which is copied into an RSx workspace project  In RSx, the SA import wizard is used to transform the XML data into UML  At the end of the import, a fuse is performed between the transformed UML data and the target (UML) model. The user must carefully examine all deltas detected by the fuse to determine which elements should be added to or deleted from the target UML model. Since the fuse does not handle diagram changes very well, all new diagrams can be accepted but changes to existing diagrams in the target model should not. SA encyclopedia XML data SA export RSx import (carefully accept fuse changes) working UML model Slide from Kevin Cornell December 2008

IBM Software Group | Rational software 9 SA integration workflows (continued)  C) Reconciling the RSx UML model back to the SA encyclopedia  The RSx working UML model is first updated using workflow B  In RSx, a new XML data file can be created or the previous one reused  In RSx, the SA export wizard is used to transform the UML from the working UML model into XML and then overwrite the target XML data file  In SA, the XML import command is used to import the generated XML data file (must use the option to only update definitions/fields if new data is available; never replace or delete existing definitions or fields). SA encyclopedia XML data 1. SA export 2. RSx import working UML model XML data 4. SA import 3. RSx export Slide from Kevin Cornell December 2008

IBM Software Group | Rational software 10 Exporting XML data from System Architect  In the SA Explorer view, UML tab, select a package and in the context menu select Export XML...  In the Export XML dialog, check the option for subordinate definitions and diagrams and specify the output file with the extension “.xml” Slide from Kevin Cornell December 2008

IBM Software Group | Rational software 11 Importing XML data into a UML model  Copy the XML data file exported from SA into an RSx workspace project  Create a blank UML model (ensure root element is Model and not Package)  Using File > Import, select the System Architect import wizard on page 1  On page 2, select the transformation to import XML data into UML Slide from Kevin Cornell December 2008

IBM Software Group | Rational software 12 Importing XML data into a UML model (con’t)  On page 3 of the import wizard, select the XML file as the source  On page 4, select the UML model as the target  When Finish is pressed, the transformation is run. At the end of the transformation a visual merge is performed into the target using the fuse technology

IBM Software Group | Rational software 13 Demo Using SA Sample Encyclopedia System Architect Software Architect

IBM Software Group | Rational software 14 SA to RSx UML import limitations  Only a subset of the UML definitions in an SA encyclopedia are imported  Some SA diagrams are supported: activity, class, sequence, use case  For class and use case diagrams only positional attributes of symbols are used  SA activity and sequence diagrams are used to create the semantic elements of a UML activity and interaction but blank diagrams are created  The blank activity, sequence and communication diagrams are populated from the semantic elements when opened for the first time (may need to fix layout)  Ports are created on classes but are not shown by default on class diagrams; use the Filters context menu to show the structure compartment  Port links in SA are converted into UML connectors which cannot be shown on class diagrams as they are in SA; a UML Collaboration called “Port Links” is created in package if at least one class in that package is a client of a port link (e.g., port on class has a required interface) collaboration element contains a composite structure diagram to show these connectors (may need to fix layout) Slide from Kevin Cornell December 2008

IBM Software Group | Rational software 15 SA to RSx UML import limitations (con’t)  Supported SA UML definitions that are imported:  Activity model, action state, action transition, complex transition, decision node, final node, initial node, organizational unit (activity swimlane)  Actor, use case association, use case extends, use case generalization, use case includes, use case  Attribute, class, interface, method, formal parameter, package, port  Aggregation, association, composition, dependency, generalization (inherits from), port link, realization  Message (with/without method call), object (lifeline)  Diagrams (activity, class, collaboration, sequence, use case), notes on diagrams (class & use case only) Slide from Kevin Cornell December 2008

IBM Software Group | Rational software 16 Exporting a UML model into SA XML data  In a project, create a new file (e.g., RSx_export_data.xml)  Using File > Export, select the System Architect export wizard on page 1); export wizard is similar to the import wizard (4 pages)  On page 2, select the transformation to export XML data from UML  On page 3, select the UML model as the source  On page 4, select the new XML file as the target  When Finish is pressed, the transformation is run. At the end of the transformation the XML file is overwritten (no merging of XML data) Slide from Kevin Cornell December 2008

IBM Software Group | Rational software 17 Importing XML data into System Architect  In the SA Explorer view, display the context menu select Import XML...  In the Import XML dialog, browse to the RSx exported XML file  In the Import XML dialog, for definition collisions, choose the option to update fields if new data is supplied (do not replace entire definitions) Slide from Kevin Cornell December 2008

IBM Software Group | Rational software 18 RSx UML to SA export limitations  Only the SA UML definitions that can be imported are exported  No UML diagrams are exported (in SA a lot of semantic definition information is only stored in symbols on a diagram)  No dependencies (client/supplier data only in diagrams)  No activity models or definitions (e.g., no states, transitions, activity nodes)  No sequence messages or objects (lifelines)  Supported SA UML definitions that are exported:  Actor, use case association, use case extends, use case generalization, use case includes, use case  Attribute, class, interface, method, formal parameter, package, port  Aggregation, association, composition, generalization (inherits from), port link, realization Slide from Kevin Cornell December 2008

IBM Software Group | Rational software 19

IBM Software Group | Rational software 20 BPMN 2.0 Interchange Software Architect System Architect Software Architect System Architect Slide from Kevin Cornell December 2008

IBM Software Group | Rational software 21

IBM Software Group | Rational software 22 Java Emitter Template – Custom Exchange

IBM Software Group | Rational software 23 SA to RSA – Custom Transform Software Architect System Architect

IBM Software Group | Rational software 24 Collaboration Site

IBM Software Group | Rational software 25