Extended Traceability Report for Enterprise Architect

Transcription

1 Extended Traceability Reprt User Guide Extended Traceability Reprt fr Enterprise Architect Extended Traceability Reprt fr Enterprise Architect... 1 Disclaimer... 2 Dependencies... 2 Overview... 2 Limitatins f the free versin f the extensin... 3 Installatin... 4 Verifying the installatin... 4 Launching the Traceability Reprt... 8 Observing the Traceability Reprt prgress The Traceability Exprt interface Leaf nde naming cnventins The Traceability Filter interface Sample Excel utput Sample RTF utput with autmatic template selectin Sample PDF utput using the Mdel Reprt template Trubleshting Supprt and cntact infrmatin Versin 1.2.x r later 1 f 24 January 2, 2018

2 Disclaimer Extended Traceability Reprt User Guide Versin 1.2.x f the Extended Traceability Reprt extensin has been successfully tested fr deplyment against Enterprise Architect versins 11.1 up t This extensin, as well as the guidelines, may r may nt be applicable t any later versin f the tl as released by the vendr, Sparx Systems. If required, updates t this sftware will be made available t supprt future versins f Enterprise Architect. There is n guarantee that versins prir t EA 11.1 will wrk prperly. N effrt will be made t supprt earlier releases f Enterprise Architect. Great care has been taken during develpment t use SQL statements that are supprted acrss the cmmn backend database platfrms. Nnetheless, shuld a statement fail t execute crrectly, please refer t the Trubleshting part f this User Guide fr assistance. If any prblems are encuntered with the installatin r peratin f this sftware please cntact us thrugh any f the channels listed at the bttm f this dcument. Dependencies The add-in depends n the fllwing cmpnents being installed n the system: Interp.EA.dll (part f the standard Sparx installatin files). Micrsft.Net Framewrk 4.0 Client Prfile (if missing, the installer will detect this and ffer t autmatically dwnlad and install the Framewrk). Overview The 1.2.x versin f the Extended Traceability Reprt sftware extends the default functinality prvided in Enterprise Architect by the Traceability Windw with the fllwing features: Tracing additinal nn-cnnectr based relatinships such as: Element level tagged value references. Attribute data type relatinships. Attribute level tagged value references. Operatin return type and argument type relatinships. Operatin level tagged value references. Allwing cntrl ver the depth/level that the traceability reprt shuld include. Inclusin f additinal cnnectr types, such as Sequence diagram Message flws. Quick expansin r cllapse f the tree view ndes cntaining the traceability results. Mdeless User Interface, permitting the full usage f all the Enterprise Architect windws withut changing the cntext (and cntent) f the Traceability Reprt windw. Allwing multiple Traceability Reprt windws t be pen at the same time. Fr every (enabled) relatinship type fund, prviding a filter capability: By target type and steretype. Versin 1.2.x r later 2 f 24 January 2, 2018

3 Extended Traceability Reprt User Guide Additinally, fr cnnectr based relatinships, by cnnectr type and steretype. Filter settings are remembered acrss invcatins, as lng as the Enterprise Architect instance remains active. Lcating the related element r feature (Attribute/Operatin) in the Prject Brwser via a single muse-click. Exprting the Traceability Reprt t Excel, with the fllwing ptins: Adding the path (in Enterprise Architect) f every element r feature as a cell level cmment. Adding hyperlinks between all related elements included in the spreadsheet. Autmatically pening the Excel file after creatin. Exprting t a dcument the element being traced, as well as any related elements that are als expanded in the Reprt (i.e. leaf level traceability elements that are nt themselves expanded are nt explicitly included in the generated dcument, but references t them are likely t be present in the cntent depending n the dcumentatin generatin template selected). Als nte that the dcumentatin template may have element and/r cnnectr filters defined WHICH WILL LIMIT ITS CONTENTS regardless f the traceability results fund. The fllwing exprt ptins are available: Exprt in RTF, PDF, DOCX r HTML utput frmat. Insertin f Linked Dcuments if present. Autmatically pening the dcument after creatin. Selectin f the template t be used fr dcumentatin generatin frm: The templates predefined in Enterprise Architect. User-defined templates. Autmatic selectin: the extensin will prduce a single dcument with Requirements generated using the standard Requirements template, Use Cases using the standard Use Case template, and all ther elements using the standard Mdel Reprt template. Limitatins f the free versin f the extensin Versin 1.2.x f the add-in has the fllwing limitatins: The maximum depth f a Traceability Reprt is 5 levels. Custm References, which are rarely used, are nt reprted. The RTF/PDF/DOCX/HTML dcumentatin generatin is using the Enterprise Architect Dcument Generatr Interface API and is thus subject t the limitatins f that interface (e.g. its limited frmatting ptins). Dcumentatin generatin templates laded int Enterprise Architect frm MDG Technlgies are nt included in the selectin list. Versin 1.2.x r later 3 f 24 January 2, 2018

4 Installatin Extended Traceability Reprt User Guide Exit any running instances f Enterprise Architect, then launch the setup.exe prgram prvided as part f the installatin sftware and fllw the n-screen instructins. The installatin will attempt t update the Windws registry, s the User needs t ensure that s/he has sufficient privileges t run the setup prgram. The recmmended install path is t place the DLL and any supprting files in an Addins flder in the Sparx Systems installatin directry, e.g. C:\Prgram Files (x86)\sparx Systems\Addins. Nte that lder versins f the sftware are autmatically remved and replaced. Shuld the installatin fail fr any reasn ther than insufficient User privileges, please take apprpriate screenshts and the data t the supprt address listed at the bttm f this dcument. Verifying the installatin Bring up Enterprise Architect and verify that: Fr releases prir t versin 13, there is a Traceability Reprt menu item under the EXTENSIONS menu: Versin 1.2.x r later 4 f 24 January 2, 2018

5 Extended Traceability Reprt User Guide Fr versin 13 r later, there is a Traceability Reprt item in the EXTEND ribbn: Nte that the ther extensins shwn in the abve screenshts may r may nt be present, depending n yur Enterprise Architect versin and cnfiguratin. Shuld the menu entry nt be present, select the Manage Add-Ins ptin: Fr versins prir 13, frm the EXTENSIONS menu: Fr versin 13 r later, in the EXTEND ribbn: Versin 1.2.x r later 5 f 24 January 2, 2018

6 Extended Traceability Reprt User Guide And cnfirm that the TraceabilityReprtAddin extensin is laded and enabled: If an errr status is shwn, this typically means that either: The DLL installatin prcess failed and EA cannt lcate its reference, either in the Windws registry r in the file system. The installatin did succeed but the DLL file was later mved r deleted. If the TraceabilityReprtAddin entry itself is nt fund, then the add-in installatin did nt cmplete successfully. Versin 1.2.x r later 6 f 24 January 2, 2018

7 Extended Traceability Reprt User Guide T fix an incrrect installatin: Exit ut f all instances f Enterprise Architect. Launch the setup prcess again. The installer will autmatically prvide a repair ptin: If, after the repair prcedure, the extensin is still nt laded crrectly in Enterprise Architect, remve the prgram thrugh the Windws cntrl panel and start the installatin prcess ver. At a minimum the fllwing files shuld have been installed in the selected installatin directry: Cephas_Sftware_EULA.pdf TraceabilityReprt.pdf (this file) Interp.EA.dll TraceabilityReprtAddin.dll Versin 1.2.x r later 7 f 24 January 2, 2018

8 Launching the Traceability Reprt Extended Traceability Reprt User Guide 1. In the Prject Brwser, right click any element t be traced and select Generate Reprt frm the cntext menu: Versin 1.2.x r later 8 f 24 January 2, 2018

9 Extended Traceability Reprt User Guide The same actin can be perfrmed in a diagram cntext: Versin 1.2.x r later 9 f 24 January 2, 2018

10 The fllwing dialg is then presented: Extended Traceability Reprt User Guide Field descriptins and User actins: Field Descriptin 1. Enable r disable the desired relatinship types. See next table fr a definitin f each type. 2. Optinally use these buttns t quickly select r deselect all types. 3. Set the maximum depth f the reprt (between 1 and 5). Be aware that in large mdels selecting a higher depth level will significantly impact the time required t generate the reprt! Click Start Trace t begin the prcess. T exit the interface withut further actin, simply click the Cancel buttn. Versin 1.2.x r later 10 f 24 January 2, 2018

11 Extended Traceability Reprt User Guide The fllwing table describes each f the relatinship types frm the perspective f the element selected fr traceability (referred t as this element ). Nte that each type is represented by tw directins: Relatinship Type Directins Reprts Ownership Owns Any child elements wned by this element (i.e. fr which it is the parent). Element Classificatin Element Tagged Value references Attribute references Attribute Tagged Value references Operatin references Operatin Tagged Value references Realizatins (Realizatin Owned by Classifies Classified by Owns tag referencing Is referenced by tag Owns Attribute with data type Is the data type f Attribute Owns Attribute tag referencing Has Attribute referenced by tag Owns Operatin referencing Is referenced by Operatin Owns Operatin tag referencing Has Operatin referenced by tag Realizes The parent element (if any) f this element. All the bjects (instances) that are classified by this element. The element/type (if any) that classifies this bject/instance. The elements r features (Attributes/Operatins) that are referenced by Tagged Values f this element. Any elements r features in the repsitry which have Tagged Values that reference this element. The Attributes f this element fr which the data type references anther element. The Attributes f ther elements in the repsitry fr which the data type is this element. The elements r features that are referenced by Attribute level Tagged Values f this element. Any elements r features which have Tagged Values that reference an Attribute f this element. The Operatins f this element fr which a return type r an argument type references anther element in the repsitry. The Operatins f ther elements in the repsitry fr which a return type r argument type references this element. The elements r features that are referenced by Operatin level Tagged Values f this element. Any elements r features which have Tagged Values that reference an Operatin f this element. The elements realized by this element (i.e. the Realizatin assciatin surces fr which Versin 1.2.x r later 11 f 24 January 2, 2018

12 cnnectrs) Dependencies (Dependency and Usage cnnectrs) Realized by Depends n Needed by Extended Traceability Reprt User Guide this element is the assciatin surce). The elements that realize this element (i.e. the Realizatin assciatin ends fr which this element is the assciatin end). The elements that this element depends n. The elements that depend n this element. Generalizatins Subtype f The elements that are generalizatins f this element. Aggregatins (includes Cmpsitins) Transitins (Cntrl Flw, Object Flw and State Flw) Assciatins (all ther cnnectr types) Supertype f Part f Cmpsed f Transitins t Transitins frm Links t Links frm The elements specialized by this element. The elements that aggregate (cntain) this element. The elements that are aggregated int (are part f) this element. The elements that this element transitins (i.e. passes cntrl) t. The elements that transitin (i.e. pass cntrl t) this element. The relatinship target f every cnnectr where this element is the surce. The relatinship surce f every cnnectr where this element is the target. Transfrmatins Transfrms t The elements fr which this element is a transfrmatin surce. Transfrms frm The elements fr which this element is a transfrmatin target. Versin 1.2.x r later 12 f 24 January 2, 2018

13 Extended Traceability Reprt User Guide Observing the Traceability Reprt prgress The reprt s prgress can be viewed in the Traceability Reprt Lg tab f the System Output windw in Enterprise Architect. This windw is autmatically made visible by the extensin. A typical reprt generatin will yield a result similar t the fllwing: Once the sftware has cmpleted building the traceability map, the User interface shwn in the next sectin is presented. Versin 1.2.x r later 13 f 24 January 2, 2018

14 The Traceability Exprt interface Extended Traceability Reprt User Guide Field descriptins and User actins: Field Descriptin 1. Expand the tree view ndes as required (similar t the Enterprise Architect Traceability windw interface). Each relatinship type is represented by a header nde. Single click n any leaf nde t lcate the crrespnding element r feature in the Prject Brwser. See the Naming Cnventins sectin belw fr a descriptin f hw elements and features are represented in the tree view (and in Excel). 2. Optinally use these buttns t expand r cllapse the entire tree view. Nte that fr a cmplex tree with many ndes this can take a few secnds Versin 1.2.x r later 14 f 24 January 2, 2018

15 Extended Traceability Reprt User Guide 3. Optinally use these buttns t expand r cllapse a single nde, including all f its child ndes. 4. Optinally use these buttns t expand r cllapse a single nde withut including its child ndes. 5. Refer t the Traceability Filter interface. Excel generatin panel. 6. When enabled: fr each cell in the spreadsheet representing an element r feature in Enterprise Architect, add its (Prject Brwser) path as a cmment. 7. When enabled: fr each cell referencing an element that is present in the spreadsheet, add a hyperlink t its lcatin in the sheet. 8. When enabled: autmatically pen the spreadsheet after creatin r update. 9. Click t generate the spreadsheet. Prvide the path t the file name when prmpted. If the Excel file already exists, please ensure that it is nt currently pen since this will prevent the cmpletin f the update. Dcumentatin generatin panel. Please nte that the generated dcument reprts the element being traced as well as all the related elements fund as part f the traceability drilldwn. Its actual cntent is ttally dependent n the selected template which may, r may nt, include all f the relatinships fund! 10. Enter the path t the dcument file t be created (r updated) either manually, by paste, r by clicking the ellipsis ( ). The default path is set t the temp directry f yur system. 11. When enabled: includes the Linked Dcument cntent (if any) f the elements being reprted. Mst RTF templates have this ptin set by default, s fr thse templates it shuld nt be enabled here; therwise the Linked Dcument cntent will appear twice. 12. Open the generated dcument (RTF, PDF, DOCX r HTML) after creatin r update. 13. Select ne f the RTF templates t generate the reprt with. The default <autmatic> ptin will prduce a single dcument with Requirements (if any) generated using the Requirements Reprt Summary template, Use Cases (if any) using the Use Case Summary template, and all ther elements using the standard Mdel Reprt template. 14. Select the utput frmat f the dcument (RTF, PDF r HTML). Changing the ptin autmatically updates the extensin f the specified file path (if any). 15. Click t generate the dcument. Fr bth generatin ptins: Versin 1.2.x r later 15 f 24 January 2, 2018

16 Extended Traceability Reprt User Guide 16. Watch the message and prgress bar fr status updates! T exit this User interface, simply click the X (clse) buttn in the tp right hand crner f the windw. Leaf nde naming cnventins Fr elements: <<Optinal element steretype>> Element-name Fr Objects (instances), Prts and Parts: Name-f-bject :: Name-f-classifier Example: Fr element Tagged Value references: {Name-f-tag} [Optinal-name-f-feature] <<Optinal element steretype>> Elementname Example: Fr Attribute (data type) references: [Name-f-attribute] <<Optinal element steretype>> Element-name Example: Fr Attribute Tagged Value references: /Name-f-wned-attribute/ {Name-f-tag} [Optinal-name-f-referenced-feature] <<Optinal element steretype>> Element-name Examples: Fr Operatin (return type r parameter type) references: [Optinal-name-f-parameter :: Name-f-peratin] <<Optinal element steretype>> Element-name Versin 1.2.x r later 16 f 24 January 2, 2018

17 Examples: Extended Traceability Reprt User Guide Fr Operatin Tagged Value references: /Name-f-wned-peratin/ {Name-f-tag} [Optinal-name-f-referenced-feature] <<Optinal element steretype>> Element-name Example: Versin 1.2.x r later 17 f 24 January 2, 2018

18 The Traceability Filter interface Extended Traceability Reprt User Guide Field descriptins and User actins: Field Descriptin 1. Expand the tree view ndes as required. Each enabled relatinship type fr which traceable elements were fund is represented by a separate nde. The nde then lists every related element type/steretype cmbinatin fund acrss the relatinship tree. Nte that a related element can be n the surce r the destinatin side f a cnnectr. Disable (i.e. filter ut) the entire relatinship, r ne r mre f its related types and/r related steretypes. Fr relatinship types that are cnnectr based (e.g. Dependencies), the filter can als be applied at the specific cnnectr type and steretype level. Fr example: Versin 1.2.x r later 18 f 24 January 2, 2018

19 Extended Traceability Reprt User Guide 2. Optinally use these buttns t expand r cllapse the entire tree view. 3. Optinally use these buttns t expand r cllapse a single nde. 4. Optinally use these buttns t quickly select r deselect all target types. 5. Click Apply t filter the current result set based n yur selectins (the cntent f the Traceability Exprt windw is autmatically refreshed), r Cancel t leave the current filter settings unchanged. Versin 1.2.x r later 19 f 24 January 2, 2018

20 Extended Traceability Reprt User Guide Sample Excel utput Versin 1.2.x r later 20 f 24 January 2, 2018

21 Extended Traceability Reprt User Guide Sample RTF utput with autmatic template selectin Requirement Reprt - Summary Use Case Summary Versin 1.2.x r later 21 f 24 January 2, 2018

22 Extended Traceability Reprt User Guide Mdel Reprt Versin 1.2.x r later 22 f 24 January 2, 2018

23 Extended Traceability Reprt User Guide Sample PDF utput using the Mdel Reprt template Versin 1.2.x r later 23 f 24 January 2, 2018

24 Trubleshting Extended Traceability Reprt User Guide Shuld a SQL statement fail t execute prperly, Enterprise Architect will display an errr message dialg similar t this: As f versin 13.x f Enterprise Architect this type f errr is nt relayed back t the API functin call which is unaware that a prblem ccurred. Please fllw this prcedure: Take a screensht f the errr message. Lcate the DBErrr.txt file in %APPDATA%\Sparx Systems\EA and include it in yur message. Befre dismissing the dialg bx, lk at the System Output windw t help determine the executin cntext at the time f the failure. Als prvide yur database type (Micrsft Access, SQL Server, Oracle, etc.) and versin number. Supprt and cntact infrmatin Use the cntact infrmatin belw fr any installatin r runtime issues with the add-in. Feature requests r suggestins fr imprvement are als welcme! Cntact: Frank Truyen supprt@enterprisemdelingslutins.cm Phne: Web: enterprisemdelingslutins.cm Versin 1.2.x r later 24 f 24 January 2, 2018