Dimensions RM 12.8 Integration Guide for Enterprise Architect

Copyright 2001–2020 Micro Focus or one of its affiliates.The only warranties for products and services of Micro Focus and its affiliates and licensors (“MicroFocus”) are set forth in the express warranty statements accompanying such products and services.Nothing herein should be construed as constituting an additional warranty. Micro Focus shall not beliable for technical or editorial errors or omissions contained herein. The information contained herein issubject to change without notice.Contains Confidential Information. Except as specifically indicated otherwise, a valid license is requiredfor possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial ComputerSoftware, Computer Software Documentation, and Technical Data for Commercial Items are licensed tothe U.S. Government under vendor's standard commercial license.Product version: 12.8Publication date: August 2020

Table of ContentsPreface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Objective . . . . . . . . . . . . . .Audience. . . . . . . . . . . . . . .Related Documents . . . . . . .Contacting Technical Support.5.Integrating Dimensions RM and Enterprise Architect . . . . .Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Configuring Dimensions RM. . . . . . . . . . . . . . . . . . . . . . . . . .Configuring the Dimensions RM Add-In for Enterprise Architect .Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Editing the Settings File . . . . . . . . . . . . . . . . . . . . . . . . .Marking a Package for Requirements . . . . . . . . . . . . . . . .7.Using the Integration . . . . . . . . . . . . . . . . . . . . . . . . .Linking Requirements and Artifacts . . . . . . . . . . . . .Linking to an Existing Requirement . . . . . . . . . .Creating and Linking a Requirement . . . . . . . . .Unlinking Requirements . . . . . . . . . . . . . . . . . .Refreshing Artifacts and Requirements . . . . . . . . . . .Importing Requirements . . . . . . . . . . . . . . . . . . . . .Publishing Models . . . . . . . . . . . . . . . . . . . . . . . . .Opening Requirements or Artifacts in Dimensions RM.Opening Artifacts in Enterprise Architect . . . . . . . . . .Integration Guide for Enterprise Architect.55668899101113.1414151516171718183

Table of Contents4Dimensions RM 12.8

PrefaceThis document describes the Dimensions RM integration with SparxSystems EnterpriseArchitect.The instructions in this document outline how to link Dimensions RM requirements toEnterprise Architect artifacts. These instructions assume that you are familiar withEnterprise Architect. If not, consult the documentation provided by SparxSystems. Theseinstructions also assume that you know how to manipulate Dimensions RM instanceinformation. If not, consult the Dimensions RM User’s Guide and the Dimensions RMAdministrator’s Guide.These instructions assume that both Enterprise Architect is already installed on yoursystem and Dimensions RM is available in your network environment. See theDimensions RM Installation Guide for information on installing Dimensions RM.The instructions in this document are provided by Micro Focus for illustrative purposesonly. The instructions have been verified only for the versions of Enterprise Architectspecified in the platform matrix, which is available at Download.aspx?FilePath /serena/platformmatrix/dimensionsrm/rtm 12.8.xlsx. Other versions ofEnterprise Architect may integrate with Dimensions RM in a similar manner, or a differentmanner, or not at all.Micro Focus makes no representations or warranties regarding Enterprise Architect, thatthe instructions are valid, or that the instructions are applicable to any other version ofEnterprise Architect.The instructions do not replace the documentation provided by SparxSystems forEnterprise Architect. The documentation for Enterprise Architect should be your primarysource of information regarding Enterprise Architect.ObjectiveThe purpose of this book is to describe how to integrate Dimensions RM withSparxSystems Enterprise Architect.AudienceThis document is intended for members of project teams who use Dimensions RM tocreate, manage, and track requirements and Enterprise Architect for modelling.Integration Guide for Enterprise Architect5

PrefaceRelated DocumentsTitleDescriptionDimensions RM Browser User’sGuideGuide to creating, managing, and trackingrequirements during the lifecycle of a project.Dimensions RM Administrator’sGuideGuide to configuring, managing, andadministering instances and users.Dimensions RM Installation GuideGuide to installing Dimensions RM.Contacting Technical SupportMicro Focus provides technical support for all registered users of this product, includinglimited installation support for the first 30 days. If you need support after that time,contact Micro Focus Support at the following URL and follow the uage-specific technical support is available during local business hours. For all otherhours, technical support is provided in English.You can use the Micro Focus Support Web page to: Report problems and ask questions.Obtain up-to-date technical support information, including that shared by ourcustomers via the Web, automatic e-mail notification, newsgroups, and regional usergroups.Access a knowledge base, which contains how-to information and allows you to searchon keywords for technical bulletins.Download updates and fix releases for your Micro Focus products.License and Copyright Information for Third-PartySoftwareFor license and copyright information of third-party software included in this release,check the file Third Party Licenses.txt, which can be found in the Dimensions RMinstallation directory, e.g. C:\Program Files\Micro Focus\Dimensions 12.8\RM.6Dimensions RM 12.8

Integrating Dimensions RM andEnterprise ArchitectPrerequisites8Configuring Dimensions RM8Configuring the Dimensions RM Add-In for Enterprise Architect9Integration Guide for Enterprise Architect7

Integrating Dimensions RM and Enterprise ArchitectPrerequisitesIn order to integrate Dimensions RM and Enterprise Architect, the following conditionshave to be met: Dimensions RM is installed, running and available in the network environment. You have the support tools (e.g. RM Manage) installed. Enterprise Architect is installed. On the machine running Enterprise Architect, .NET framework 4.0 is installed. The Dimensions RM add-in for Enterprise Architect is installed.Configuring Dimensions RMIn order to integrate Dimensions RM and Enterprise Architect, you need a class whichrepresents the Enterprise Architect model. In this guide, the class to be linked is namedModel, but you can use any name you like.To create the Model class in Dimensions RM, follow these steps:1Start the Class Definition tool.2Right-click the background.3From the shortcut menu, select Add Class Model.4Enter a name (e.g. Model) and press Enter.5Double-click the Model class.6Double-click the Model attribute.7Select the Text tab.8Ensure that the HTML Formatting box is selected and click OK.9Create these Alpha-Numeric attributes: EA GUID EA Project EA Type Model Version810Click OK.11Save the class definition.12Create links between the Model class and the requirement classes you want to link to.Dimensions RM 12.8

Configuring the Dimensions RM Add-In for Enterprise ArchitectFigure 1-1. Linked Classes in Dimensions RM Class DefinitionFor further information about creating classes and links, refer to Dimensions RMAdministrator’s Guide.Configuring the Dimensions RM Add-In forEnterprise ArchitectThe current version supports creation and linking of requirements with elements fromEnterprise Architect.CAUTION! All linking and unlinking of requirements and artifacts must be done throughthe add-in. If you create a link directly in Dimensions RM, Enterprise Architect will notrecognize this link and vice-versa. This also applies when unlinking.SettingsIn order to integrate Dimensions RM and Enterprise Architect, the add-in needs to beconfigured.To configure the add-in, follow these steps:Integration Guide for Enterprise Architect9

Integrating Dimensions RM and Enterprise Architect1Open Enterprise Architect.2Expand the EXTENSIONS menu in Enterprise Architect and select Specialize Dimensions RM Settings. This opens the Settings dialog.3Configure the Dimensions RM Connection settings by filling out these fields: Server: The URL to the web server. The URL is in this format:http:// SERVER NAME : PORT Example: http://rmserver:8080 User Name: The user name for connecting to Dimensions RM. Password: The password associated to the user name. Database: The database in which the instance resides. Instance: The instance you want to use, e.g. RMDEMO. Class: The name of class which references Enterprise Architect, e.g. Model. This isthe class you created in chapter "Configuring Dimensions RM" on page 8.4Check if the data you entered are correct, by clicking the Validate button at thebottom of the window.5Configure the Enterprise Architect settings, by filling out these fields: Temp Image Folder: Specifies the location where the exported diagram filesfrom Enterprise Architect are stored before they are uploaded to Dimensions RM. Interconnection Port: Specifies the port under which Enterprise Architectelements can be opened directly from the Dimensions RM web page.CAUTION! The port needs to be identical for all Enterprise Architect installations as theport is used for the web link from Dimensions RM’s Model class to Enterprise Architect’smodel. Changing the port makes the web links unusable. System Output: If selected, provides logging to the System Output view ofEnterprise Architect. Dimensions RM Requirement Read-Only: If selected, Dimensions RMrequirements are read-only in Enterprise Architect. This prevents thatrequirements can be changed from the Enterprise Architect project.6Click OK.TIP In order to check if your Connection and Enterprise Architect settings arecorrect, click Validate.Editing the Settings FileOpening the Settings File for Editing110Enter the following into the location box of Windows Explorer:%APPDATA%\Dimensions RM\Enterprise ArchitectIf your Windows user name is Administrator, this translates s RM\Enterprise Architect.Dimensions RM 12.8

Configuring the Dimensions RM Add-In for Enterprise Architect2Open the file user.config with a text editor (e.g. Notepad).Excluding Classes From the Class Selection BoxesThe user.config file contains two settings that can be used to exclude classes from classselection: excludedClassNames and excludedClassTypeIDs.With the excludedClassNames setting, you can specify the classes to exclude by theirnames (e.g. Marketing Requirements). To specify several classes, use a comma asseparator.Please note that both settings, excludedClassNames and excludedClassTypeIDs, willexclude the specified classes from any Dimensions RM instance connecting to.Example: add key "excludedClassNames" value "Tests,Defects" / The setting excludedTypeIDs uses IDs that are constants in any version ofDimensions RM. These type IDs will exclude any class that was created from that type, nomatter what their names are.Default type IDs: 7: Comment (class for creating comments) 500: Poll (class for creating polls) 501: Chapter (class for creating documents)Example: add key "excludedTypeIDs" value "7,500,501" / Marking a Package for RequirementsIn order to link to Dimensions RM requirements, Enterprise Architect needs a packagewhich contains the requirements from Dimensions RM.To mark a package, follow these steps:1Open Enterprise Architect.Integration Guide for Enterprise Architect11

Integrating Dimensions RM and Enterprise Architect2In Project Browser, create or select a package, e.g. Dimensions RM Requirements.Figure 1-2. Project Browser with selected package.3Expand the EXTENSIONS menu in Enterprise Architect and select Specialize Dimensions RM Mark Requirement Package.NOTE The package for requirements needs to be marked for each Enterprise Architectproject.12Dimensions RM 12.8

Using the IntegrationLinking Requirements and Artifacts14Refreshing Artifacts and Requirements16Importing Requirements17Publishing Models17Opening Requirements or Artifacts in Dimensions RM18Opening Artifacts in Enterprise Architect18Integration Guide for Enterprise Architect13

Using the IntegrationLinking Requirements and ArtifactsIn the following chapters, artifact refers to an Enterprise Architect artifact andrequirement refers to a Dimensions RM requirement.A link is a connection between an artifact and a requirement. When creating a link, a copyof the artifact is created in Dimensions RM and a copy of the requirement is created in thepackage for requirements in Enterprise Architect.CAUTION! Do not link requirements in the package for requirements with anyEnterprise Architect artifact as these links will be removed when refreshing therequirement or artifact.Linking to an Existing RequirementLinking of Requirements is done in the Project Browser. To link an Enterprise Architectartifact and a requirement, follow these steps:1Open Enterprise Architect.2In Project Browser, right-click the Enterprise Architect artifact you want to link to aDimensions RM requirement.Figure 2-1. Project Browser with selected artifact314From the shortcut menu, select Specialize Dimensions RM LinkRequirement. This opens the Link Requirement dialog.Dimensions RM 12.8

Linking Requirements and Artifacts4Select the requirement you want to create the link to.TIP To quickly find a requirement, you can choose any or all of these options: Enter the name or part of it or a complete requirement ID into the search box. You can choose a class. You can choose a collection.After making your choice, click Search.5Click Add Link. This starts the linking process. This creates a copy of the artifact inDimensions RM and links it with the requirement. When the link process is completedthe Link Requirement the requirement is marked withand the Dimensions RMrequirement appears in the Serena Requirements package you configured in chapter"Marking a Package for Requirements" on page 11.Creating and Linking a RequirementTo simplify the process of creating a requirement and linking it to an artifact, you canperform these actions in one step within Enterprise Architect.To create and link the requirement, follow these steps:1Open Enterprise Architect.2In Project Browser, right-click the artifact you want to link the new requirement to.3In the shortcut menu, select Specialize Dimensions RM Create & Link.This opens the Create Requirement dialog.4In the Class box, select the class of the requirement you wish to create.5Fill out the form as required.6Click Create & Link. This starts the process and closes the dialog.Unlinking RequirementsIf a link between a requirement and an artifact is no longer required, it can be removedfrom within Enterprise Architect. Note that this does not remove the artifact nor therequirement.To unlink an artifact and a requirement, follow these steps:1Open Enterprise Architect.2In Project Browser, right-click the artifact you want to unlink.3In the shortcut menu, select Specialize Dimensions RM UnlinkRequirement. This opens the Unlink Requirement dialog.4From the list of requirements, select the requirement you want to unlink.Integration Guide for Enterprise Architect15

Using the Integration5Click Delete Link.Refreshing Artifacts and RequirementsWhen working with Dimensions RM and Enterprise Architect it is common that datachange in the requirement or in the artifact. When modifying an artifact, the copy inDimensions RM needs to be updated. A modification of a requirement requires an updateof the copy in Enterprise Architect.Refreshing a model artifact updates all attributes in the model class in Dimensions RMwith the attribute values of the artifact.Refreshing a requirement updates all attribute values in the requirement inEnterprise Architect with the attribute values of the linked Dimensions RM requirement.Any Dimensions RM requirement which has been linked to an artifact in Dimensions RMwill be copied to the package for requirements if it does not already exist.In both cases, the links between the artifact and the requirement are updated by copyingthe links from Dimensions RM to Enterprise Architect. If links were deleted inDimensions RM, they will also be deleted in Enterprise Architect.CAUTION! Any link between a requirement in the package for requirements and anartifact which was not created through the Dimensions RM add-in for Enterprise Architectwill be removed when refreshing the requirement or artifact.To refresh data of an artifact or requirement, follow these steps:1Open Enterprise Architect.2In Project Browser, right-click the package, artifact, or requirement you want torefresh.3Select Specialize Dimensions RM Refresh from the shortcut menu.The refresh is executed as a background task, which allows you to continue working withEnterprise Architect. Note that changes are not incorporated immediately. Progressinformation is written to the System Output tab Dimensions RM. Refresh is completedwhen a status message starting with Finished Synchronisation is shown.Figure 2-2. System Output tab Dimensions RM with status messagesTIP To open the artifact, double-click the corresponding report line (see Figure 2-2).16Dimensions RM 12.8

Importing RequirementsImporting RequirementsFor reference, requirements from Dimensions RM can be imported into the package forrequirements of Enterprise Architect. For further information about the package, seechapter "Marking a Package for Requirements" on page 11.To import requirements, follow these steps:1Open Enterprise Architect.2In Project Browser, right-click the package for the requirements.3From the shortcut menu, select Specialize Dimensions RM Import Requirements. This opens the Import Requirementsdialog.4Select class and/or collection from the Class and Collection boxes.5Select the status from the Current Status box to filter requirements by.6Click Search. This lists all requirements to be imported.7If you want to overwrite previously imported requirements, select the Overwriteexisting requirements check box.8Click Import.9Confirm the Import Requirements dialog to start importing the requirements.NOTES Import imports all requirements in the list. To limit the number of requirements tobe imported, add them into a collection. For further information about collections,see chapter "Managing Requirements in a Collection" in RM Browser User’s Guide.Import does not overwrite (update) an existing requirement. To update arequirement see chapter "Refreshing Artifacts and Requirements" on page 16.Publishing ModelsPublishing Models is suggested if you want to work with artifacts in Dimensions RM.Publishing a model copies the artifacts from Enterprise Architect to Dimensions RM.Publishing a Single ModelTo publish a single model, follow these steps:1Open Enterprise Architect.Integration Guide for Enterprise Architect17

Using the Integration2In Project Browser, right-click an artifact.3From the shortcut menu, select Specialize Dimensions RM Publish Model.This starts the publishing process. To check the status, open the System Outputwindow.Publishing all Models of a PackageTo publish all models of a package, follow these steps:1Open Enterprise Architect.2In Project Browser, right-click