Professional Documents
Culture Documents
C PDF
C PDF
C PDF
PowerDesigner®
Requirements Model
User's Guide
Version 11.0
DC00121-01-1100-01
Last modified: November 2004
Copyright © 1991-2004 Sybase, Inc. All rights reserved.
Information in this manual may change without notice and does not represent a commitment on the part of Sybase, Inc. and its
subsidiaries.
Sybase, Inc. provides the software described in this manual under a Sybase License Agreement. The software may be used only in
accordance with the terms of the agreement.
No part of this publication may be reproduced, transmitted, or translated in any form or by any means, electronic, mechanical, manual,
optical, or otherwise, without the prior written permission of Sybase, Inc.
Use, duplication, or disclosure by the government is subject to the restrictions set forth in subparagraph (c)(1)(ii) of DFARS 52.227-
7013 for the DOD and as set forth in FAR 52.227-19(a)-(d) for civilian agencies.
Sybase, SYBASE (logo), ADA Workbench, Adaptable Windowing Environment, Adaptive Component Architecture, Adaptive Server,
Adaptive Server Anywhere, Adaptive Server Enterprise, Adaptive Server Enterprise Monitor, Adaptive Server Enterprise Replication,
Adaptive Server Everywhere, Afaria, AppModeler, APT Workbench, APTBuild, APT-Edit, APT-Execute, APT-Translator, APT-
Library, ASEP, AvantGo, AvantGo Application Alerts, AvantGo Mobile Document Viewer, AvantGo Mobile Delivery, AvantGo
Mobile Inspection, AvantGo Mobile Marketing Channel, AvantGo Mobile Pharma, AvantGo Mobile Sales, AvantGo Pylon, AvantGo
Pylon Application Server, AvantGo Pylon Conduit, AvantGo Pylon PIM Server, AvantGo Pylon Pro, Backup Server, BayCam, Bit-
Wise, BizTracker, Certified PowerBuilder Developer, Certified SYBASE Professional, Certified SYBASE Professional Logo,
ClearConnect, Client-Library, Client Services, CodeBank, Column Design, ComponentPack, Connection Manager, Convoy/DM,
Copernicus, CSP, Data Pipeline, Data Workbench, DataArchitect, Database Analyzer, DataExpress, DataServer, DataWindow, DB-
Library, dbQueue, Developers Workbench, Direct Connect Anywhere, DirectConnect, Distribution Director, Dynamic Mobility Model,
e-ADK, E-Anywhere, e-Biz Integrator, E-Whatever, EC Gateway, ECMAP, ECRTP, eFulfillment Accelerator, Electronic Case
Management, Embedded SQL, EMS, Enterprise Application Studio, Enterprise Client/Server, Enterprise Connect, Enterprise Data
Studio, Enterprise Manager, Enterprise Portal (logo), Enterprise SQL Server Manager, Enterprise Work Architecture, Enterprise Work
Designer, Enterprise Work Modeler, eProcurement Accelerator, eremote, Everything Works Better When Everything Works Together,
EWA, Financial Fusion, Financial Fusion (and design), Financial Fusion Server, Formula One, Fusion Powered e-Finance, Fusion
Powered Financial Destinations, Fusion Powered STP, Gateway Manager, GeoPoint, GlobalFIX, iAnywhere, iAnywhere Solutions,
ImpactNow, Industry Warehouse Studio, InfoMaker, Information Anywhere, Information Everywhere, InformationConnect, InstaHelp,
Intelligent Self-Care, InternetBuilder, iremote, iScript, Jaguar CTS, jConnect for JDBC, KnowledgeBase, Logical Memory Manager,
M-Business Channel, MBusiness Network, M-Business Server, Mail Anywhere Studio, MainframeConnect, Maintenance Express,
Manage Anywhere Studio, MAP, MDI Access Server, MDI Database Gateway, media.splash, Message Anywhere Server, MetaWorks,
MethodSet, ML Query, MobiCATS, My AvantGo, My AvantGo Media Channel, My AvantGo Mobile Marketing, MySupport, Net-
Gateway, Net-Library, New Era of Networks, Next Generation Learning, Next Generation Learning Studio, O DEVICE, OASiS,
OASiS logo, ObjectConnect, ObjectCycle, OmniConnect, OmniSQL Access Module, OmniSQL Toolkit, Open Biz, Open Business
Interchange, Open Client, Open ClientConnect, Open Client/Server, Open Client/Server Interfaces, Open Gateway, Open Server, Open
ServerConnect, Open Solutions, Optima++, Orchestration Studio, Partnerships that Work, PB-Gen, PC APT Execute, PC DB-Net, PC
Net Library, PhysicalArchitect, Pocket PowerBuilder, PocketBuilder, Power++, Power Through Knowledge, power.stop, PowerAMC,
PowerBuilder, PowerBuilder Foundation Class Library, PowerDesigner, PowerDimensions, PowerDynamo, Powering the New
Economy, PowerScript, PowerSite, PowerSocket, Powersoft, PowerStage, PowerStudio, PowerTips, Powersoft Portfolio, Powersoft
Professional, PowerWare Desktop, PowerWare Enterprise, ProcessAnalyst, QAnywhere, Rapport, Relational Beans, RemoteWare,
RepConnector, Report Workbench, Report-Execute, Replication Agent, Replication Driver, Replication Server, Replication Server
Manager, Replication Toolkit, Resource Manager, RW-DisplayLib, RW-Library, SAFE, SAFE/PRO, SDF, Secure SQL Server, Secure
SQL Toolset, Security Guardian, SKILS, smart.partners, smart.parts, smart.script, SQL Advantage, SQL Anywhere, SQL Anywhere
Studio, SQL Code Checker, SQL Debug, SQL Edit, SQL Edit/TPU, SQL Everywhere, SQL Modeler, SQL Remote, SQL Server, SQL
Server Manager, SQL SMART, SQL Toolset, SQL Server/CFT, SQL Server/DBM, SQL Server SNMP SubAgent, SQL Station, SQLJ,
Stage III Engineering, Startup.Com, STEP, SupportNow, S.W.I.F.T. Message Format Libraries, Sybase Central, Sybase Client/Server
Interfaces, Sybase Development Framework, Sybase Financial Server, Sybase Gateways, Sybase IQ, Sybase Learning Connection,
Sybase MPP, Sybase SQL Desktop, Sybase SQL Lifecycle, Sybase SQL Workgroup, Sybase Synergy Program, Sybase Virtual Server
Architecture, Sybase User Workbench, SybaseWare, Syber Financial, SyberAssist, SybFlex, SybMD, SyBooks, System 10, System 11,
System XI (logo), SystemTools, Tabular Data Stream, The Enterprise Client/Server Company, The Extensible Software Platform, The
Future Is Wide Open, The Learning Connection, The Model For Client/Server Solutions, The Online Information Center, The Power of
One, TotalFix, TradeForce, Transact-SQL, Translation Toolkit, Turning Imagination Into Reality, UltraLite, UltraLite.NET, UNIBOM,
Unilib, Uninull, Unisep, Unistring, URK Runtime Kit for UniCode, Viewer, VisualWriter, VQL, WarehouseArchitect, Warehouse
Control Center, Warehouse Studio, Warehouse WORKS, Watcom, Watcom SQL, Watcom SQL Server, Web Deployment Kit,
Web.PB, Web.SQL, WebSights, WebViewer, WorkGroup SQL Server, XA-Library, XA-Server, XcelleNet, and XP Server are
trademarks of Sybase, Inc. or its subsidiaries.
All other trademarks are property of their respective owners.
Contents
iv PowerDesigner
Creating an MS Word document from a requirements
model .................................................................................... 121
Inserting a requirements model into an existing MS Word
document .............................................................................. 124
Updating an MS Word document from a requirements
model .................................................................................... 127
Updating a requirements model from an MS Word
document .............................................................................. 129
Detaching an MS Word document from a requirements
model .................................................................................... 133
Detaching a requirements model from an MS Word
document .............................................................................. 135
Index .........................................................................................139
Audience This book is for anyone who wants to build a requirements model with
PowerDesigner. It does not require any particular knowledge. For more
information, see the Bibliography section at the end of this chapter.
This book only explains how to use the Requirements Model. For
information on other models or aspects of PowerDesigner, consult the
following books:
Physical Data Model Getting Started To learn the basics of the PDM.
viii PowerDesigner
About This Book
Special thanks to Dr Gregory Abowd and his team, Jeffrey Corn (Manager),
Travis Works (Architect), John Garrard (Programmer), Kesniel Acton
(Technical Writer), and Dinesh Krishna (Quality Assurance), who designed
the CyberFridge project – Copyright 2004, Georgia Tech Research
Corporation, Atlanta, Georgia 30332-0415, All Rights Reserved
x PowerDesigner
C H A P T E R 1
About this chapter This chapter presents the PowerDesigner Requirements Model. It provides
you with an introduction to the basic notions of the Requirements Model.
Contents
Topic Page
Functional overview 2
What is a requirements model? 4
Defining the requirements model environment 6
Defining a requirements model 11
Defining packages in a requirements model 20
Functional overview
The Requirements Model (RQM) is a documentary model. It describes a
project by listing and explaining precisely what actions must be implemented
during a development process.
You can use the Requirements Model for any kind of structured technical
document (e.g. functional or technical specification, test plan) that must be
taken into account during a development process.
The Requirements Model displays no diagram but two different kinds of
views:
♦ Requirements document views: numbered lists of requirements with a
common set of properties
♦ Traceability matrix views: grids indicating the links between current
requirements and design objects (objects from other types of models),
external files or other requirements
For more information on requirements views, see section Defining
requirements views, in chapter Building a requirements model.
The Requirements Model allows you to:
♦ Build a requirements model from a structured technical document
♦ Check an existing or imported model
♦ Create links between requirements and design objects (objects from
other types of models)
♦ Create requirements from design objects, and vice versa
Some design objects (e.g. business rules, packages, use cases) may
correspond to requirements, and vice versa
♦ Create and update an MS Word document from a requirements model
To provide users with an MS Word document corresponding to the
requirements model
♦ Create and update a requirements model from an MS Word document
To start from an existing MS Word document
2 PowerDesigner
Chapter 1 Requirements model basics
Demo models
Demo requirements models are available in the Examples directory.
4 PowerDesigner
Chapter 1 Requirements model basics
Object Description
Requirement The name and description of an action. It can be
part of a hierarchy with parent and child
requirements. It must be defined precisely before
being assigned to users and groups
Glossary term A word used in a requirements model. It must be
defined precisely to avoid misunderstandings and
set a common vocabulary
User A person that is concerned by at least one
requirement
Group A group of users that have a common interest in
satisfying at least one requirement
None of these objects has a graphic symbol, since there are no diagrams in a
requirements model. Requirements are listed in document views. Traceability
matrix views display the links between requirements and design objects
(objects from other types of models), external files or other requirements.
All objects appear in the Browser tree view.
6 PowerDesigner
Chapter 1 Requirements model basics
Option Description
Share Current extended model definition constantly refers to the extended
model definition stored in the Resource Files\Extended Model
Definitions directory. Any changes made to the extended model
definition are shared by all linked XEM
Copy Current extended model definition is a unique copy of the extended
model definition stored in the Resource Files\Extended Model
Definitions directory. The current extended model definition is
independent of the original one, so modifications made to the
extended model definition in the Resource Files\Extended Model
Definitions directory are not available to the copied XEM. This one
is saved with the requirements model and cannot be used without it
2 Select a category in the left pane and define its properties in the right
part of the dialog box.
3 Click OK.
8 PowerDesigner
Chapter 1 Requirements model basics
Title fonts
You can define title fonts for requirements document views.
Naming conventions
You can also set naming conventions for each type of objects in your model.
For information on naming conventions, see section Defining naming
conventions, from chapter Managing Models, in the General Features Guide.
10 PowerDesigner
Chapter 1 Requirements model basics
3 Click OK.
Property Description
Name Name of the model
Code Code of the model
Comment Descriptive label of the model
File name Location of the model file. This box is empty if the model has
never been saved
Author Author of the model. You can insert a name, a space or
nothing. If you insert a space, the Author field in the title box
remains empty. If you intentionally leave the box empty, the
Author field in the title box displays the user name from the
Version Info page of the model property sheet
Version Version of the model. You can use this box to display the
repository version or a user-defined version of the model.
This parameter is defined in the display preferences of the
Title node
Default view View displayed by default when opening the model
Property Description
Workload 1 Sum of all the workloads assigned to a first person or team
Workload 2 Sum of all the workloads assigned to a second person or team
Workload 3 Sum of all the workloads assigned to a third person or team
Workload 4 Sum of all the workloads assigned to a fourth person or team
12 PowerDesigner
Chapter 1 Requirements model basics
Property Description
Linked Object Design objects or external files linked to the requirements
model or package
Bookmark Bookmark for the MS Word file linked with the requirements
model or package. Click a cell, then the Ellipsis button (…)
to create or modify a bookmark.
See Defining a bookmark for an MS Word file, in Defining
requirements properties, in chapter Building a requirements
model
You can modify the properties displayed in the Traceability Links page by
clicking the Customize Columns and Filter tool.
Option Description
Share To use the shared extended model definitions stored in the Extended
Model Definitions directory of your installation. Any changes made
to the extended model definitions are available to the linked
requirements model
Copy To create a copy of the extended model definition in the model. The
current extended model definition is independent from the original
extended model definition, so any changes made in the extended
model definition are not available to other models. The extended
model definition is saved with the model and cannot be used by
other models
14 PowerDesigner
Chapter 1 Requirements model basics
3 Select the New model radio button in the upper right part of the dialog
box.
4 <optional> If you want to attach one or more extended model definitions
to the model, select the extended model definitions of your choice in the
Extended Model Definitions page.
For more information on attaching extended model definitions to a
model, see section Selecting extended model definitions at model
creation.
5 <optional> Select either Share or Copy the extended model definitions.
6 Click OK.
A new requirements model is created in the Workspace (Browser and
document view).
16 PowerDesigner
Chapter 1 Requirements model basics
Creating a requirements model using the New model from template option
List of templates
You can select user-defined model templates (use the Change user-
defined model templates folder tool to specify the user templates
folder) and copy some existing models as model templates using the
Copy model to user-defined model templates folder tool.
18 PowerDesigner
Chapter 1 Requirements model basics
Package hierarchy You can create several packages at the same hierarchical level within a
model, or decompose a package into other packages, and continue this
process without limitation in decomposition depth. Each package appears
with a default requirements view (document or matrix view). At each level of
decomposition, you can create several requirements views.
To display a package view, you must double-click its name or icon in the
Browser tree view.
For more information on packages, see the section Defining a package
in the General Features Guide.
Package In a requirements model, packages only appear in the Browser tree view. To
requirements add requirements to a package, you can:
♦ Create requirements directly from the package document view(s)
♦ In the Browser, select requirements from the model Requirements folder,
and drag and drop them either in the package document view(s) or
beneath the package Requirements folder (for root requirements), or
beneath other requirements (for child requirements)
20 PowerDesigner
Chapter 1 Requirements model basics
You can link requirements from different packages of the same model. Use
the Add Links to Other Requirements tool, in the Traceability Links page
of the requirements property sheet.
Property Description
Name Name that clearly identifies the package
Code Codes are references for packages
Comment Optional label that describes a package and provides additional
information
Stereotype Sub-classification used to extend the semantics of an object without
changing its structure. It can be predefined or user-defined
Use parent Defines the package as being the area in which the name of an
namespace object must be unique in order to be used. The package is the
default namespace
Default view View displayed by default when you open the package
Property Description
Workload 1 Sum of all the workloads assigned to a first person or team to
satisfy all the requirements of the current package
Workload 2 Sum of all the workloads assigned to a second person or team
to satisfy all the requirements of the current package
Workload 3 Sum of all the workloads assigned to a third person or team to
satisfy all the requirements of the current package
Workload 4 Sum of all the workloads assigned to a fourth person or team to
satisfy all the requirements of the current package
22 PowerDesigner
Chapter 1 Requirements model basics
Property Description
Linked Object Design objects or external files linked to the requirements
package or model
Bookmark Bookmark for the MS Word file linked with the requirements
package or model. Click a cell, then the Ellipsis button (…)
to create or modify a bookmark.
See Defining a bookmark for an MS Word file, in Defining
requirements properties, in chapter Building a requirements
model
You can modify the properties displayed in the Traceability Links page by
clicking the Customize Columns and Filter tool.
24 PowerDesigner
C H A P T E R 2
About this chapter This chapter describes how to build a requirements model (RQM). It explains
the role of each object in a requirements model and how to create them.
Contents
Topic Page
26 PowerDesigner
Chapter 2 Building a requirements model
Property Description
Name Name of the requirements view
Code Code of the requirements view
Comment Any comment on the requirements view
Traceability Only for traceability matrix views. Use the dropdown listbox
matrix type to select the type of linked objects (Design Object, File or
Requirement) displayed in the traceability matrix view
Parent Name of the model or package to which the requirements
view belongs
Default view If checked, the current requirements view (document or
matrix view) appears by default when opening the model
Caution
You cannot insert graphics in a requirements document view.
Note: The arrow beside the first title ID indicates that the first requirement is
selected.
A requirements model can have as many requirements document views as
necessary. You can differentiate the views by customizing columns and
filtering rows.
For more information, see section Customizing columns and filtering
rows.
28 PowerDesigner
Chapter 2 Building a requirements model
3 Select a title level in the Title level pane and define its characteristics in
the other panes.
4 Repeat step 3 for each title level you want to modify.
5 Click OK.
The title fonts are modified as defined in the Model Options dialog box.
30 PowerDesigner
Chapter 2 Building a requirements model
2 < Selecting columns > Select or clear check boxes in the Displayed (D)
column, for columns you want to appear or not in the requirements
document view.
3 < Ordering columns > Use the arrowed buttons at the bottom-left corner
of the list to rearrange columns in the requirements document view.
4 < Filtering rows > Define an expression beside a column heading to
filter rows. For example, type “1.*” beside “Title ID Text”. Only the first
chapter requirements will appear in the requirements document view.
For more information on filtering rows, click the Help button or
see section Defining a filter on a list, in chapter Using the
PowerDesigner Interface, in the General Features Guide.
5 Click OK.
The requirements document view appears with customized columns and
filtered rows.
32 PowerDesigner
Chapter 2 Building a requirements model
The Current cell properties group box displays the properties of a selected
link:
Property Description
Link type Additional information about the object linked to the
current requirement
Bookmark Only with MS Word files.
Bookmark for the MS Word file linked with the current
requirement. (See Defining a bookmark in an MS Word
document)
You can also create or delete traceability links with the tool in the upper left
corner of the Current cell properties group box. (See Creating a traceability
link and Deleting a traceability link)
You can create as many traceability matrix views as you want, by changing
the linked objects type or selecting the linked objects.
2 In the Traceability Matrix Type dialog box, select the type of objects
linked with requirements.
3 Click OK.
The traceability matrix view appears with the selected type of objects in
the columns.
34 PowerDesigner
Chapter 2 Building a requirements model
Adding columns
You can add columns to a traceability matrix view.
To add a column:
1 In the menu bar, select Requirements→Select Rows/Columns.
or
In the matrix view toolbar (on the upper left corner of the grid), click the
Select Rows/Columns tool.
36 PowerDesigner
Chapter 2 Building a requirements model
2 Click the Column Object Selection tab to display the list of objects
selected for columns.
3 In the Column Object Selection page, click the Add New Column
Object tool.
♦ The Select Design Objects dialog box appears for a matrix view
with design objects links.
You can select objects from any design model open in the
workspace
♦ The standard Open dialog box appears for a matrix view with
external files links
Note: The Add New Column Object tool is not available for a matrix
view with requirement objects links, because requirements from different
models cannot be linked
4 Select the design object or external file you want to add in a new column
of the matrix view.
5 Click OK in the Select Design Objects dialog box, or Open in the Open
dialog box.
6 Click OK in the Select Row/Column Objects dialog box.
The new column appears in the traceability matrix view.
38 PowerDesigner
Chapter 2 Building a requirements model
The traceability link is created. A check mark appears in the selected cell
and the current cell properties are modified.
The traceability link is deleted. The check mark disappears from the
selected cell and the current cell properties are grayed.
40 PowerDesigner
Chapter 2 Building a requirements model
Caution
As the new requirements view is identical to the original
requirements view, you might have the impression that nothing has
changed in the GUI.
To make sure that a new requirements view has been created,
check its name in the general title bar or in the Browser tree view.
Caution
As the new requirements view is identical to the original requirements
view, you might have the impression that nothing has changed in the GUI.
To make sure that a new requirements view has been created, check its
name in the PowerDesigner general title bar or in the Browser tree view.
42 PowerDesigner
Chapter 2 Building a requirements model
or
A new traceability matrix view appears in the workspace, along with its
property sheet.
44 PowerDesigner
Chapter 2 Building a requirements model
Defining requirements
A requirement is a clear and precise description of an action that must be
implemented during a development process.
Example of a requirement in a requirements document view:
General properties
The General page of a requirement property sheet displays the following
properties:
Property Description
Parent Name of the parent requirement. For root requirements (directly
linked to the Requirements folder), it is the requirements model
name
Title ID Read-only number expressing the place of the requirement in
the requirements hierarchy. For example: 1.3.2
Title Name of the requirement
Code Code of the requirement
Description Full description of the requirement. You can use the RTF editor
toolbar. The text appears simultaneously in the Description tab
of the Notes page
Detail properties
The Detail page of a requirement property sheet displays the following
properties:
Property Description
Comment Any comment on the requirement
Stereotype Sub-classification used to extend the semantics of an object
without changing its structure. It can be predefined or user-
defined
Type Type of requirement from the process point of view (See
Customizing a list of values)
Status Validation level for a requirement (See Customizing a list of
values)
Priority Priority level attached to a requirement. The value cannot be
null or negative, and is limited to one decimal. For example:
1.5
Selected If checked, the requirement is retained for the project. If
cleared, the requirement is excluded from the project and the
sum of workloads
Risk Level of risk, would a requirement not be satisfied (See
Customizing a list of values)
Verification Test level for a requirement (See Customizing a list of values)
Workload 1 Time assigned to a first person or team to satisfy the current
requirement (See note below)
Workload 2 Time assigned to a second person or team to satisfy the current
requirement (See note below)
Workload 3 Time assigned to a third person or team to satisfy the current
requirement (See note below)
Workload 4 Time assigned to a fourth person or team to satisfy the current
requirement (See note below)
46 PowerDesigner
Chapter 2 Building a requirements model
Workloads
You should respect a unit for all workloads (hour or day). A workload is
divided by as many persons in a team. Values must be greater or equal to
zero, limited to one decimal (e.g. 3.5).
A parent requirement workload is the sum of its child requirements
workloads. Parent workloads are automatically calculated once you enter
their child workloads. Parent workloads are in read-only mode (grayed).
You can only modify child workloads.
Customizing a list Some requirement properties come with a predefined list of values. You can
of values define your own list of values by creating an extended model definition (See
following procedure). The new list will replace the predefined one. In the
case of several extended model definitions, all the lists are merged.
You can customize the list of values for the following requirement properties:
♦ Type
♦ Status
♦ Risk
♦ Verification
You can also customize the list of values for the Link type property in
traceability matrix views, and for the Type property in the User Allocations
page of requirements property sheets. (See note in step 8)
3 Type a name and a code for the new extended model definition.
4 Click Apply.
5 Double-click the arrow at the beginning of the line.
The extended model definition property sheet appears.
48 PowerDesigner
Chapter 2 Building a requirements model
The right panel displays the name and comment (definition, default
values) for the selected property.
50 PowerDesigner
Chapter 2 Building a requirements model
11 Referring to the default values in the Comment box, type a value in the
Value column (this value will appear in the property dropdown listbox)
and a code in the Name column (this code is stored in the system).
Traceability links
To increase the scope of a requirement, you can create links with design
objects (objects from other types of models), external files (MS Word, MS
Excel, PowerDesigner…) and other requirements that bring additional
information about the requirement.
The Traceability Links page of a requirement property sheet allows you to
attach design objects, external files and other requirements to the current
requirement:
52 PowerDesigner
Chapter 2 Building a requirements model
When the parsing is over, the Select a bookmark dialog box appears.
Expand the Entry points node, to reveal the paragraph titles hierarchy, and
select one title as bookmark.
Click OK.
The bookmark reference appears in the Traceability Links page of the
requirement property sheet, as well as in the traceability matrix view (See
Current cell properties groupbox).
User allocations
The User Allocations page of a requirement property sheet allows you to
assign users and groups, defined in the model, to the accomplishment of the
current requirement.
Click the Add Objects tool to select the users and groups you want to attach
to the requirement:
For more information on users and groups, see section Defining users
and groups.
54 PowerDesigner
Chapter 2 Building a requirements model
Creating a requirement
You can create a requirement:
♦ From the contextual menu of the model item in the Browser tree view
♦ From a requirements document view
56 PowerDesigner
Chapter 2 Building a requirements model
Property Description
Name Name of the user
Code Code of the user
Comment Any comment on the user
Stereotype Sub-classification used to extend the semantics of an object
without changing its structure. It can be predefined or user-
defined
Email address E-mail address of the user
Property Description
Name Name of the group
Code Code of the group
Comment Any comment on the group
Stereotype Sub-classification used to extend the semantics of an object
without changing its structure. It can be predefined or user-
defined
Email address E-mail address of the group
58 PowerDesigner
Chapter 2 Building a requirements model
Groups hierarchy
You must not select child groups that are, at the same time, parent groups
of the current group. (See Group check in chapter Working with a
requirements model)
Property Description
Name Name of the glossary term
Code Code of the glossary term
Comment Any comment on the glossary term
Stereotype Sub-classification used to extend the semantics of an object
without changing its structure. It can be predefined or user-
defined
60 PowerDesigner
Chapter 2 Building a requirements model
Action Description
Attach design objects to requirements In the Traceability Links page of a
requirement property sheet, click the
Add Links to Design Objects tool to
select design objects in a model open in
the workspace, and attach them to the
current requirement. Design objects are
listed as external shortcuts in the List of
Shortcuts.
At the other end of the links, the
requirement appears in the
Requirements page of the design objects
property sheet.
See section Linking requirements with
design objects, in chapter Working with
a requirements model
Export requirements as design objects In the menu bar, select
Requirements→Export Requirements
as Design Objects, to open the
Requirement Export Wizard which
allows you to create design objects from
requirements.
See chapter Working with a
requirements model
Import design objects as requirements In the menu bar, select
Requirements→Import Design
Objects as Requirements, to open the
Requirement Import Wizard which
allows you to create requirements from
design objects.
See chapter Working with a
requirements model
62 PowerDesigner
Chapter 2 Building a requirements model
5 In the right pane, type a name and a code for the extended model
definition.
6 In the left pane, right-click the Profile category and select Add
Metaclasses in the contextual menu.
The Metaclass Selection dialog box appears.
7 In the PdCommon page, select BusinessRule.
64 PowerDesigner
Chapter 2 Building a requirements model
8 Click OK.
The BusinessRule entry appears within the Profile category.
9 Click OK.
The new extended model definition appears in the List of Extended
Model Definitions.
10 Click OK.
The new extended model definition appears in the Browser tree view,
and you can now create business rules (See Creating a business rule) and
attach them to requirements (See Applying a business rule to a
requirement).
Property Description
Name Name of the rule
Code Code of the rule
Comment Descriptive label of the rule
Stereotype Sub-classification used to extend the semantics of an object
without changing its structure. It can be predefined or user-
defined
Type Constraint, definition, fact, formula, requirement or validation
66 PowerDesigner
Chapter 2 Building a requirements model
4 Click Apply.
5 Double click the arrow at the beginning of the line.
The business rule property sheet appears.
6 Click the Notes tab, to display the Notes page, then type a description of
the business rule in the Description sub-page.
68 PowerDesigner
Chapter 2 Building a requirements model
4 Click OK.
The selected business rule appears in the Rules page of the requirement
property sheet.
5 Click OK.
70 PowerDesigner
C H A P T E R 3
About this chapter This chapter describes how you can work with a requirements model.
When building a requirements model, you can check its validity at any time,
with the Check Model feature.
Linking requirements with design objects is the best way to verify that the
design process meets the requirements.
The Import and Export Wizards allow you to convert design objects into
requirements, and vice versa.
Contents
Topic Page
72 PowerDesigner
Chapter 3 Working with a requirements model
These messages represent two different levels of problem severity. You can
modify the level of problem severity for each object parameter verified by the
Check model. This severity level can depend on the degree of normalization
you want to achieve in your model.
Automatic correction
You can specify if you want PowerDesigner to automatically correct an error
using the Automatic Correction feature.
However, before using automatic correction, make sure you understand how
it will affect your model.
Automatic correction is not available for all object parameters. Problems that
cannot be corrected automatically must be corrected manually.
For more information on objects available for automatic correction, see
section Requirements model objects verified by Check Model.
The Check Model Parameters dialog box displays the Options page.
Requirements Model User's Guide 73
Checking a requirements model
74 PowerDesigner
Chapter 3 Working with a requirements model
8 Select or clear check boxes for objects you want to be checked or not.
9 Click OK.
The Check Model Result List displays errors and warnings based on the
check options you have defined.
76 PowerDesigner
Chapter 3 Working with a requirements model
Navigating in the The Check toolbar contains navigation tools to move to the first, previous,
error list next, or last error listed. You can also navigate in the Result list by right-
clicking an object parameter and selecting Go To→First / Previous / Next /
Last Error, from the contextual menu.
Contextual menu
When you right-click an object parameter, a menu appears listing the
correction options: Correct, Help, Check Again, and Automatic
Correction. You can also select options to clear, dock and hide the result
window.
78 PowerDesigner
Chapter 3 Working with a requirements model
User check
During a user check, the following object controls are made.
80 PowerDesigner
Chapter 3 Working with a requirements model
Group check
During a group check, the following object controls are made.
Existence of user
A group must contain at least one user or another group of users.
Requirement check
During a requirement check, the following object controls are made.
82 PowerDesigner
Chapter 3 Working with a requirements model
File check
During a file check, the following object controls are made
Replication check
During a replication check, the following object control is made.
84 PowerDesigner
Chapter 3 Working with a requirements model
86 PowerDesigner
Chapter 3 Working with a requirements model
4 Select the design model in the Model dropdown listbox, and select the
design objects you want to attach to the requirement.
5 Click OK.
The design objects appear in the Traceability Links page.
6 Click OK.
or
Click Apply.
8 Click the Properties tool beside the Name box to display the design
object property sheet.
88 PowerDesigner
Chapter 3 Working with a requirements model
The requirement, to which the design object has been attached, appears
in the Requirements page of the design object property sheet.
10 Click OK in each property sheet (design object, shortcut and
requirement).
90 PowerDesigner
Chapter 3 Working with a requirements model
The Add Objects dialog box appears with the requirements model
selected and its root requirements displayed in a check list.
5 Click OK.
The attached requirements appear in the Requirements page of the
design object property sheet.
6 Click OK.
or
Click Apply.
92 PowerDesigner
Chapter 3 Working with a requirements model
7 < If you clicked Apply > Double-click the row number corresponding to
a requirement in the list.
The requirement shortcut property sheet appears.
8 Click the Properties tool beside the Name box to display the
requirement property sheet.
The design object, to which the requirement has been attached, appears
as a linked object in the Traceability Links page of the requirement
property sheet.
10 Click OK in each property sheet (requirement, shortcut and design
object).
94 PowerDesigner
Chapter 3 Working with a requirements model
Caution
The design models to which you want to export requirements must be
open in the workspace.
Note: The dialog box only displays design models that are open in the
workspace.
96 PowerDesigner
Chapter 3 Working with a requirements model
Note: The objects displayed in the dropdown listbox are specific to the
design model previously selected.
In the dropdown listbox, you can select the current requirements model or a
requirements hierarchy. Click the Include Sub-Objects tool to display all the
requirements of the model or a hierarchy.
Click Finish, and the requirements appear as design objects in the design
model.
98 PowerDesigner
Chapter 3 Working with a requirements model
Caution
You must have a design model and a requirements model open in the
workspace.
Note: The dialog box only displays design models that are open in the
workspace.
100 PowerDesigner
Chapter 3 Working with a requirements model
In the dropdown listbox, you can select the current design model or an
objects hierarchy. Click the Include Sub-Objects tool to display all objects
belonging to a model or a hierarchy.
Click Finish, and the design objects (Language, Hot Line) appear as
requirements in the requirements model (Browser and document view).
102 PowerDesigner
C H A P T E R 4
About this chapter This chapter explains how you can work jointly with an MS Word document
and a requirements model.
104 PowerDesigner
Chapter 4 Using MS Word with a requirements model
Check-list Before starting to work on the Requirements Model and MS Word, you must
check the following list:
♦ MS Word 2000 or higher is installed on your machine
♦ The Microsoft Word Import Export add-in is selected in
PowerDesigner. (See Tools→General options)
The add-in only works if the system code page is consistent with the
model language. For example, the add-in will work properly on a
Chinese model if your system code page is Chinese
♦ The WordToRqm.dot template is selected in MS Word. (See
Tools→Templates and Add-Ins)
♦ Titles in the MS Word document are formatted with MS Word-based
heading styles.
Use only MS Word numbering
♦ Heading styles must not increase by more than one level.
For example, a title with Heading 1 must not be followed by a subtitle
with Heading 3
Contents
Topic Page
Heading styles
To be properly converted into a requirements model, an MS Word
document must use MS Word-based heading styles.
106 PowerDesigner
Chapter 4 Using MS Word with a requirements model
3 Click Open.
The following message appears in the PowerDesigner window.
The Files folder in the Browser tree view contains the file of the linked
MS Word document.
108 PowerDesigner
Chapter 4 Using MS Word with a requirements model
110 PowerDesigner
Chapter 4 Using MS Word with a requirements model
4 Click OK.
The selected titles appear as requirements, with their description, in a
new requirements model.
The Files folder in the Browser tree view contains the file of the linked
MS Word document.
112 PowerDesigner
Chapter 4 Using MS Word with a requirements model
Requirement tags An MS Word document is linked to a requirements model (or package) when
its sections (titles followed by a text) are bounded by a requirement start tag
[PDRQM] and a requirement end tag [/PDRQM].
114 PowerDesigner
Chapter 4 Using MS Word with a requirements model
Packages When a requirements model contains packages, each package can be linked
to a specific MS Word document. A package cannot be linked to more than
one document.
If the model is itself linked to a document, only the requirements which do
not belong to a package are linked to the document.
For example:
Note: The Files folder of the model item contains the model file and a
shortcut for each package file.
Traceability links A requirements model (or package) is linked to an MS Word document when
the Traceability Links page of the model (or package) and each requirement
property sheet displays the document file with Main document as Link Type
and a bookmark for each requirement.
Example of a requirement property sheet:
116 PowerDesigner
Chapter 4 Using MS Word with a requirements model
118 PowerDesigner
Chapter 4 Using MS Word with a requirements model
6 Expand the model root node to reveal the requirements hierarchy, and
select the location where you want to create the requirement.
Note: Only packages that are not linked to a document appear in the
dialog box.
7 Click OK.
The new requirement (“User list”), corresponding to the selected text,
appears in the existing requirements model.
120 PowerDesigner
Chapter 4 Using MS Word with a requirements model
122 PowerDesigner
Chapter 4 Using MS Word with a requirements model
Note: If you export a package, the MS Word file is attached to the package in
the Browser.
124 PowerDesigner
Chapter 4 Using MS Word with a requirements model
4 Expand the Entry points node and all its sub-nodes, and select a title
beneath which the requirements will be added.
5 Click OK.
The MS Word file appears in the Browser, in a Files folder within the
model item. The requirements model is now linked to the MS Word
document.
The Merge feature is no more available in the contextual menu of the model
item.
If you insert a package into an existing document, the MS Word file is
attached to the package.
126 PowerDesigner
Chapter 4 Using MS Word with a requirements model
Graphics
If you add graphics to a linked MS Word document, do not try to update
the document from the requirements model, you will lose the graphics.
Modify the document and then update the model from the document.
The following procedure assumes you have a requirements model open in the
workspace and linked to an MS Word document.
2 In the Browser tree view, right-click the model name, and select Update
Word Document in the contextual menu.
MS Word is launched and the document is parsed and updated.
128 PowerDesigner
Chapter 4 Using MS Word with a requirements model
The titles already linked to a requirement have their check box selected
and grayed. You cannot deselect them.
The added title (“Scenario options”) is selected but not grayed.
4 Click OK.
The Merge Models dialog box appears.
130 PowerDesigner
Chapter 4 Using MS Word with a requirements model
The title with an added text line (“Scenario Descriptions”) and the
additional title (“Scenario options”) are selected by default in the model
to update.
6 Click OK.
The existing requirements model is updated with the recent changes.
132 PowerDesigner
Chapter 4 Using MS Word with a requirements model
134 PowerDesigner
Chapter 4 Using MS Word with a requirements model
… and when the Traceability Links page of the requirements property sheet
displays the MS Word file as a linked object of Main document type:
To detach the model from the document, delete the document file in the
Browser…
… and the file will disappear from the Traceability Links page of the
requirements property sheet:
136 PowerDesigner
Requirements Model Glossary
138 PowerDesigner
Index
R
related glossary term 54
L replication check 84
level of problem severity requirement 45
error 72 check 82
warning 72 create requirement 55
link customize list of values 47
requirements model (or package) to MS Word description 45
document 112 detail properties 46
requirements with design objects 86 general properties 45
parent 45
priority 46
related glossary terms 54
risk 46
selected 46
140 PowerDesigner
requirement (continued)
status 46
T
title (RQM) 45
tags 113
title ID 45
title 45
traceability link
title ID 45
define bookmark 53
traceability links 52
design object 52
type 46
external file 52
user allocations 54
main document 116
verification 46
other requirement 52
views 26
traceability matrix type 27
workload 46
traceability matrix view
requirements document view
add new columns 36
customize columns and filter rows 31
create traceability links 38
definition 28
definition 32
demote 29
delete traceability links 39
promote 29
filter empty rows and columns 38
requirements hierarchy 29
select rows and columns 35
title fonts 30
select traceability links type 34
requirements model
type (RQM) 46
check requirements model 73
typographic conventions ix
compare and merge requirements models 85
create model 14
default view 12
define properties 11 U
definition 4 update
detach model from workspace 18 MS Word document from requirements model
environment 6 127
extended definitions 6 requirements model from MS Word document
extended dependencies 10 129
functional overview 2 use MS Word to create requirements model 109
general properties 12 user (RQM)
linking requirements with design objects 86 check 80
name and code case sensitivity 9 create user 57
naming conventions 10 definition 57
objects 5 dependencies 57
open existing model 18 general properties 58
options 8 user allocation 54
save and close 19
title fonts 9
traceability links 13
workloads 12 V
risk (RQM) 46 verification (RQM) 46
view (RQM) 26
create requirements view 40
properties 27
S requirements document view 28
selected (RQM) 46 traceability matrix type 27
status (RQM) 46 traceability matrix view 32
sub-package hierarchy (RQM) 20
142 PowerDesigner