C PDF

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 152

Sybase®

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

About This Book ...........................................................................................vii

1 Requirements model basics..............................................1


Functional overview .................................................................. 2
What is a requirements model?................................................ 4
Objects in a requirements model ....................................... 5
Defining the requirements model environment ......................... 6
Selecting extended model definitions at model creation .... 6
Defining model options....................................................... 8
Requirements model extended dependencies................. 10
Defining a requirements model............................................... 11
Defining model properties ................................................ 11
Creating a requirements model........................................ 14
Opening an existing requirements model......................... 18
Detaching a requirements model from the workspace..... 18
Saving and closing a requirements model ....................... 19
Defining packages in a requirements model .......................... 20
Requirements package properties ................................... 21
Creating a requirements package .................................... 24

2 Building a requirements model.......................................25


Defining requirements views................................................... 26
Why views instead of diagrams?...................................... 26
Requirements views properties ........................................ 27
Defining requirements document views ........................... 28
Defining traceability matrix views ..................................... 32
Creating a requirements view........................................... 40
Defining requirements............................................................. 45
Defining requirements properties ..................................... 45
Creating a requirement..................................................... 55
Defining users and groups ...................................................... 57
Creating a user or a group ............................................... 57
User general properties.................................................... 58
Group general properties ................................................. 58
Attaching users and groups to a group ............................ 59
Defining glossary terms .......................................................... 60

Requirements Model User's Guide iii


Glossary term general properties ..................................... 60
Creating a glossary term .................................................. 61
Using design objects............................................................... 62
Defining business rules........................................................... 63
What is a business rule? .................................................. 63
Activating business rules in a requirements model .......... 63
Defining business rules properties ................................... 66
Creating a business rule................................................... 67
Applying a business rule to a requirement ....................... 69

3 Working with a requirements model .............................. 71


Checking a requirements model............................................. 72
Defining options in Check Model...................................... 72
Selecting objects in Check Model .................................... 73
Checking a requirements model ...................................... 73
Displaying previously applied check options in a
requirements model ......................................................... 76
Making corrections based on requirements model check
results............................................................................... 76
Requirements model objects verified by Check Model........... 79
Business rule check ......................................................... 79
Glossary term check ........................................................ 80
User check ....................................................................... 80
Group check ..................................................................... 81
Requirement check .......................................................... 82
File check ......................................................................... 83
Extended object check ..................................................... 84
Extended link check ......................................................... 84
Replication check ............................................................. 84
Comparing and merging requirements models ...................... 85
Linking requirements with design objects ............................... 86
Attaching design objects to requirements ........................ 86
Attaching requirements to design objects ........................ 89
Exporting requirements as design objects.............................. 95
Importing design objects as requirements.............................. 99

4 Using MS Word with a requirements model ................ 103


Creating a requirements model from an MS Word
document .............................................................................. 106
Importing an MS Word document as a requirements
model.............................................................................. 106
Using MS Word to create a requirements model ........... 109
How are a model and a document linked?..................... 112
Creating a requirement from a selected text ........................ 117

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

Requirements Model Glossary ........................................................................137

Index .........................................................................................139

Requirements Model User's Guide v


vi PowerDesigner
About This Book

Subject This book describes the PowerDesigner Requirements Model environment. It


shows you how to do the following:
♦ Create requirements document views
♦ Create traceability matrix views
♦ Define specific objects in a requirements model
♦ Check a requirements model
♦ Compare and merge requirements models
♦ Link requirements with design objects (objects from other types of
models)
♦ Export requirements as design objects
♦ Import design objects as requirements
♦ Create and update an MS Word document from a requirements model
♦ Insert a requirements model into an existing MS Word document
♦ Create and update a requirements model from an MS Word document

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.

Requirements Model User's Guide vii


About This Book

Documentation The PowerDesigner modeling environment supports several types of models:


primer
♦ Conceptual Data Model (CDM) to model the overall logical structure
of a data application, independent from any software or data storage
structure considerations
♦ Physical Data Model (PDM) to model the overall physical structure of
a database, taking into account DBMS software or data storage structure
considerations
♦ Object Oriented Model (OOM) to model a software system using an
object-oriented approach for Java or other object languages
♦ Business Process Model (BPM) to model the means by which one or
more processes are accomplished in operating business practices
♦ XML Model (XSM) to model the structure of an XML file using a DTD
or an XML schema
♦ Requirements Model (RQM) to list and document the customer needs
that must be satisfied during a development process
♦ Information Liquidity Model (ILM) to model the replication of
information from a source database to one or several remote databases
using replication engines
♦ Free Model (FEM) to create any kind of chart diagram, in a context-
free environment

This book only explains how to use the Requirements Model. For
information on other models or aspects of PowerDesigner, consult the
following books:

General Features Guide To get familiar with the PowerDesigner


interface before learning how to use any of the models.

Conceptual Data Model Getting Started To learn the basics of the


CDM.

Conceptual Data Model User’s Guide To work with the CDM.

Physical Data Model Getting Started To learn the basics of the PDM.

Physical Data Model User’s Guide To work with the PDM.

Object Oriented Model Getting Started To learn the basics of the


OOM.

Object Oriented Model User's Guide To work with the OOM.

viii PowerDesigner
About This Book

Business Process Model Getting Started To learn the basics of the


BPM.

Business Process Model User’s Guide To work with the BPM.


XML Model User’s Guide To work with the XSM.
Information Liquidity Model User’s Guide To work with the ILM.

Reports User’s Guide To create reports for any or all models.

Repository Getting Started To learn the basics of the Repository.

Repository User’s Guide To work in a multi-user environment using a


central repository.

Typographic PowerDesigner documentation uses specific typefaces to help you readily


conventions identify specific items:
♦ monospace text (normal and bold)
Used for: Code samples, commands, compiled functions and files,
references to variables.
Example: declare user_defined…, the
BeforeInsertTrigger template.
♦ UPPER CASE
Object codes, reversed objects, file names + extension.
Example: The AUTHOR table appears in the Browser. Open the file
OOMAFTER.OOM.
♦ bold text
Any new term.
Example: A shortcut has a target object.
♦ SMALL CAPS
Any key name.
Example: Press the ENTER key.

Bibliography INCOSE (International Council on Systems Engineering) –


http://www.incose.org/practice/techactivities/semanagement/rwg.aspx

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

Requirements Model User's Guide ix


About This Book

x PowerDesigner
C H A P T E R 1

Requirements model basics

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

Requirements Model User's Guide 1


Functional overview

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

From a requirements model, you can create design objects from


requirements, or create and update an MS Word document.
You can also create requirements from design objects, or create and update a
requirements model from an MS Word document.

Requirements Model User's Guide 3


What is a requirements model?

What is a requirements model?


A requirements model is a documentary model that helps you list and define
precisely what actions must be implemented during a development process.
Requirements are listed in document views, and their links with design
objects (objects from other types of models), external files or other
requirements are managed in traceability matrix views.
A requirements model sets and reminds what is at stake and what must be
done during a development process.
A requirements model is the reference model which defines the tasks and
orientates the work of all users and groups involved in a development
process.
Example of a requirements model (Browser and requirements document
view):

Demo models
Demo requirements models are available in the Examples directory.

4 PowerDesigner
Chapter 1 Requirements model basics

Objects in a requirements model


A requirements model has some specific objects:

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.

Requirements Model User's Guide 5


Defining the requirements model environment

Defining the requirements model environment


The requirements model environment includes a set of parameters and
configuration options that define various aspects of the model content and
behavior. You can set these parameters:
♦ At model creation
♦ After creating a model with default options and parameters
♦ When creating a model template

Selecting extended model definitions at model creation


Extended model definitions (.XEM files) provide means for customizing and
extending PowerDesigner metaclasses, parameters and generation. Extended
model definitions are typed like models in PowerDesigner. You create an
extended model definition for a specific type of model and you cannot share
these files between heterogeneous models.
In the case of requirements models, you can use extended model definitions
as methodological supports for requirements management:
♦ Custom checks verify that methodological statements are satisfied. For
example, each requirement of scenario type must be associated with a
use case in an OOM
♦ You can customize the list of values for some properties. See Detail
properties, in Defining requirements properties, in chapter Building a
requirements model
♦ You can initialize the default values of a requirement, just after its
creation, by using the Initialize event handler
When you create a new requirements model, you can select one or several
extended model definitions and attach them to the model from the New
dialog box.

6 PowerDesigner
Chapter 1 Requirements model basics

You can choose one of the following options:

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

 For more information on extended model definitions, see chapter


Extended Model Definitions Reference Guide, in the Advanced User
Documentation.

Requirements Model User's Guide 7


Defining the requirements model environment

Defining model options


You can define the following options for a requirements model:
♦ Name/Code case sensitivity
♦ Title fonts
♦ Naming conventions

™ To define requirements model options:


1 In the menu bar, select Tools→Model Options.
The Model Options dialog box appears.

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

Name/Code case sensitivity


You can define the case sensitivity of names and codes for all objects in the
current model. When this check box is selected, it implies that you can have
two objects with identical name or code but different case in the same
namespace. You can modify the name and code case sensitivity during the
design process. However, if you do so, make sure you run the check model
feature to verify if the model does not contain any duplicate object.

Title fonts
You can define title fonts for requirements document views.

™ To define title fonts in Model Options:


1 Select a title level in the Title level pane.
2 Define the characteristics of the title level in the other panes.
3 Repeat steps 1 and 2 for each title level you want to modify.
4 Click OK.
The title fonts appear in the current document view as defined in the
Model Options dialog box.

Requirements Model User's Guide 9


Defining the requirements model environment

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.

Requirements model extended dependencies


Extended dependencies are links between objects of a requirements model.
These links help to make object relationships clearer but are not interpreted
and checked by PowerDesigner, as they are meant to be used for
documentation purposes only.
You can complement these links by applying stereotypes. Stereotypes can be
used to define extended dependencies between objects in a requirements
model.
You can type stereotypes directly in the Stereotype column of the object
property sheet or select a value from the dropdown listbox, if you have
previously defined stereotypes in an embedded or imported extended model
definition (.XEM).
 For more information on extended model definitions, see chapter
Extended Model Definitions Reference Guide in the Advanced User
Documentation.

10 PowerDesigner
Chapter 1 Requirements model basics

Defining a requirements model


This section presents the main operations you have to perform before starting
to build or work on a requirements model.

Defining model properties


The model property sheet displays the definition of the current model.
This section only explains the specific pages of a requirements model
property sheet.
 For more information on the generic pages of a model property sheet,
see section Using property sheets in chapter Using the PowerDesigner
Interface, in the General Features Guide.

™ To define the properties of a requirements model:


1 Select Model→Model Properties.
or
Right-click the model name or icon in the Browser, and select Properties
in the contextual menu.
The model property sheet appears.

2 Define model properties in the different pages.

Requirements Model User's Guide 11


Defining a requirements model

3 Click OK.

Model General page


The General page of a requirements model property sheet displays the
following properties:

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

Model Detail page


The Detail page of a requirements model property sheet displays the
following properties:

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

A workload is the time assigned to a person or a team to satisfy a


requirement. This time is divided by as many persons in the team. You
should respect a unit for all workloads (hour or day). Values must be greater
or equal to zero, and limited to one decimal (For example: 3.5).

12 PowerDesigner
Chapter 1 Requirements model basics

A parent requirement workload is the sum of its child requirements


workloads. Parent workloads are automatically calculated once you enter
their child workloads. Model workloads are the sum of all child workloads.
Model and parent workloads are in read-only mode (grayed). You can only
modify child workloads.

Traceability Links page


To help understanding a requirements model or package, you can create links
with design objects (objects from other types of models) and external files
(MS Word, MS Excel, PowerDesigner...).
Use the following tools to create links with the current model or package:

Tool Tooltip Description


Add Links to Design Objects Creates shortcuts to attach design
objects to the current model or
package. Design objects are selected
from design models open in the
workspace
Add Link to External File Creates a link between an external file
(whatever the format) and the current
model or package. The external file is
stored in a Files folder within the
model

The standard Traceability Links page displays the following properties:

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.

Requirements Model User's Guide 13


Defining a requirements model

Creating a requirements model


There are several ways to create a requirements model:
♦ Create a new requirements model
♦ Create a new requirements model using a template
♦ Create a new requirements model importing an MS Word document. See
Importing an MS Word document as a requirements model, in chapter
Using MS Word with a requirements model

Creating a requirements model using the New model option


When you create a requirements model using the New model option, an
Extended Model Definitions page appears.
The following options concern extended model definitions that you would
have selected:

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

™ To create a new requirements model using the New model option:


1 In the menu bar, select File→New.
The New dialog box appears.
2 Select Requirements Model in the list of model types.

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.

Requirements Model User's Guide 15


Defining a requirements model

6 Click OK.
A new requirements model is created in the Workspace (Browser and
document view).

7 Select Model→Model Properties.


The model property sheet appears.

8 Type a name and a code for the model.


9 Click OK.

16 PowerDesigner
Chapter 1 Requirements model basics

Creating a requirements model using the New model from template option

™ To create a new requirements model using the New model from


template option:
1 Select File→New to display the New dialog box.
2 Select Requirements Model in the list of model types.
3 Select the New model from template radio button, in the upper right
part of the dialog box, to display the Template page.

4 Select a model template from the list.

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.

 For more information on model templates, see section Creating a


model, in chapter Managing Models, in the General Features Guide.
5 Click OK.
A new requirements model is created in the Workspace.
6 Select Model→Model Properties.
The model property sheet appears.

Requirements Model User's Guide 17


Defining a requirements model

7 Type a name and a code for the model.


8 Click OK.

Opening an existing requirements model


A requirements model has the file extension .RQM.

™ To open an existing requirements model:


1 Select File→Open.
or
Click the Open tool.
A standard Windows Open file dialog box appears.
2 Select a file with a .RQM extension.
3 Click Open.
The existing model appears in the workspace.

Detaching a requirements model from the workspace


When you detach a requirements model from a workspace, its node is
removed from the Browser, and it is no longer defined in the workspace. Yet
the file is not deleted from your operating environment.

™ To detach a requirements model from a workspace:


1 Right-click the requirements model node in the Browser and select
Detach from Workspace in the contextual menu.
A confirmation box asks if you want to save the requirements model.
2 Click Yes, if you want to save modifications to the requirements model.
Select or browse to a directory.
Type a name for the file and click the Save button.
or
Click No, if you do not want to save modifications to the file.
The requirements model is removed from the workspace.

18 PowerDesigner
Chapter 1 Requirements model basics

Saving and closing a requirements model


Saving a To save a requirements model, choose one of the following options:
requirements
model ♦ Select File→Save
♦ Click the Save tool in the standard toolbar
♦ Right-click the requirements model in the Browser, and select Save in
the contextual menu
If it is the first time you save a requirements model, a standard Windows
Save As dialog box appears: Type a file name, choose a folder in your
directory and click Save.
Closing a To close a requirements model, choose one of the following options:
requirements
model ♦ Select File→Close
♦ Right-click the requirements model in the Browser, and select Close in
the contextual menu
When a requirements model is closed, a red mark appears on its icon in the
Browser:

Requirements Model User's Guide 19


Defining packages in a requirements model

Defining packages in a requirements model


A package is a piece of a model.
When working with a large model, you can split the model into smaller
subdivisions to avoid manipulating the entire set of model objects. Packages
can be useful to assign portions of a model, representing different tasks and
subject areas, to different development teams.
In the following example, a package contains functional requirements and
another package contains non-functional requirements.

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.

Requirements package properties


This section explains the specific pages of a requirements package property
sheet.
 For more information on the generic pages of a property sheet, see
section Using property sheets in chapter Using the PowerDesigner Interface,
in the General Features Guide.
To display a package property sheet:
♦ Double-click its name or icon in the Browser
♦ Right-click its name or icon in the Browser, and select Properties in the
contextual menu

Package General page


The General page of a package property sheet displays the following
properties:

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

Requirements Model User's Guide 21


Defining packages in a requirements model

Package Detail page


The Detail page of a package property sheet displays the following
properties:

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

A workload is the time assigned to a person or a team to satisfy a


requirement. This time is divided by as many persons in the team. You
should respect a unit for all workloads (hour or day). Values must be greater
or equal to zero, and limited to one decimal (For example: 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. Package workloads are the sum of all their child
workloads. Package, sub-package and parent workloads are in read-only
mode (grayed). You can only modify child workloads.

22 PowerDesigner
Chapter 1 Requirements model basics

Traceability links page


To help understanding a requirements package or model, you can create links
with design objects (objects from other types of models) and external files
(MS Word, MS Excel, PowerDesigner...).
Use the following tools to create links with the current package or model:

Tool Tooltip Description


Add Links to Design Objects Creates shortcuts to attach design
objects to the requirements package or
model. Design objects are selected
from design models open in the
workspace
Add Link to External File Creates a link between an external file
(whatever the format) and the
requirements package or model. The
external file is stored in a Files folder
within the model

The standard Traceability Links page displays the following properties:

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.

Requirements Model User's Guide 23


Defining packages in a requirements model

Creating a requirements package


You can create a requirements package using the following methods:
♦ Right-click the model item in the Browser, and select New→Package in
the contextual menu. A root package (directly linked to the model item)
is created
♦ Right-click a package item in the Browser, and select New→Package in
the contextual menu. A sub-package is created under the selected
package
♦ Use the List of Packages in the Model menu

™ To create a requirements package using the List of Packages:


1 In the menu bar, select Model→Packages.
The List of Packages appears.
If the model document view is open in the workspace, the List of
Packages displays the root packages of the model.
If a package document view is open in the workspace, the List of
Packages displays the sub-packages of the current package.
2 Click a blank line in the list.
A package appears in the list, with generic name and code.
3 <optional> Type a name and a code for the package.
4 Click OK.
The new package appears in the Browser tree view as a root package or
a sub-package.
To display a package view, double-click its name or icon in the Browser.

24 PowerDesigner
C H A P T E R 2

Building a requirements model

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

Defining requirements views 26


Defining requirements 45
Defining users and groups 57
Defining glossary terms 60
Using design objects 62
Defining business rules 63

Requirements Model User's Guide 25


Defining requirements views

Defining requirements views


Unlike other models in PowerDesigner, the Requirements Model displays
views instead of diagrams.
There are two kinds of views in a requirements model:
♦ Requirements document views
♦ Traceability matrix views

Why views instead of diagrams?


A requirements model represents a detailed and structured list of actions that
must be implemented during a development process. A diagram, showing a
structure of interconnected symbols, is not the best way to represent a
numbered list of requirements. Document and matrix views are grids that
enumerate a list of requirements with respectively a set of attributes or
traceability links.
A requirements model can have as many views as necessary. You can
differentiate views by selecting requirements, customizing columns, changing
the traceability matrix type.

26 PowerDesigner
Chapter 2 Building a requirements model

Requirements views properties


You can display a requirements view property sheet using one of the
following methods:
♦ From the menu bar, select View→Requirements View→Properties
♦ From the Browser tree view, right-click the requirements view name or
icon, and select Properties in the contextual menu
The General page of a requirements view property sheet displays the
following properties:

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

Requirements Model User's Guide 27


Defining requirements views

Defining requirements document views


Requirements document views are grids in which you create hierarchies of
requirements in rich edit text:
♦ Rows, corresponding to requirements, can be resized and moved
♦ Columns, corresponding to requirements attributes, are editable

Caution
You cannot insert graphics in a requirements document view.

Example of a requirements document view with a two level hierarchy:

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

Creating a requirements hierarchy


To create a requirements hierarchy in a requirements document view, use the
specific tools of the requirements document view toolbar:

Tool Tooltip Description


Insert a Row Creates a new requirement at the same level
as a selected requirement
Insert Sub-Object Creates a requirement inferior by one level
to a selected requirement
Promote Upgrades a selected requirement by one
level
Demote Downgrades a selected requirement by one
level
Show Titles and Texts Shows the title and description of the
requirements.
This feature is also available in the
Requirements menu
Show Titles Only Shows only the title of the requirements.
This feature is also available in the
Requirements menu
Show Current Title and When pushed-in, shows the title and
Text description of a selected requirement. When
released, shows only the title of the selected
requirement.
This feature is also available in the
Requirements menu

Requirements Model User's Guide 29


Defining requirements views

Redefining title fonts


You can modify the title fonts of a requirements document view through
model options.

™ To redefine title fonts in a requirements document view:


1 In the menu bar, select Tools→Model Options.
The Model Options dialog box appears.
2 In the left pane, select the Title Fonts category.

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

Customizing columns and filtering rows


You can customize columns and filter rows in a requirements document view.

™ To customize columns and filter rows in a requirements document


view:
1 In the requirements document view toolbar, click the Customize
Columns and Filter tool.

The Customize Columns and Filter dialog box appears.

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.

Requirements Model User's Guide 31


Defining requirements views

Defining traceability matrix views


You can link objects to a requirement to confirm that the requirement has
been integrated during the analysis and design processes. (See the
Traceability Links page of a requirement property sheet)
Traceability matrix views are grids which display the links between
requirements (in rows) and their linked objects (in columns).
There are three types of matrix views corresponding to three types of links:
♦ Between requirements and design objects (objects from other types of
models).
These links confirm that the requirements have been integrated in the
analysis and design processes
♦ Between requirements and external files (MS Word, MS Excel,
PowerDesigner…).
The links with MS Word are managed automatically. You can also link
requirements with pieces of various documents (e.g. a planning)
♦ Between requirements from different hierarchies.
These links allow you to manage interconnected requirements from
different hierarchies. For example, you can start from a customer
requirements list, then move to a designer requirements list, and end with
specifications. The requirement to requirement matrix view allows you
to check that no requirement has been forgotten between the customer
list and the specifications

32 PowerDesigner
Chapter 2 Building a requirements model

Example of a traceability matrix view with requirements links:

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.

Requirements Model User's Guide 33


Defining requirements views

Selecting the type of traceability links


You can select the type of traceability links displayed in a traceability matrix
view.

™ To select the type of traceability links:


1 In the menu bar, select Requirements→Change Traceability Matrix
Type.
or
In the matrix view toolbar (on the upper left corner of the grid), click the
Change Traceability Matrix Type tool.

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

Selecting rows and columns


You can select the objects displayed in the rows and columns of a traceability
matrix view.

™ To select rows and columns:


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.

The Select Row/Column Objects dialog box appears.

The Row Object Selection page displays a list of requirements.


The Column Object Selection page displays a list of linked objects,
depending on the type of traceability links you have selected. (See
Selecting the type of traceability links)
2 In each list, click the Deselect All tool, and select the objects you want
to appear in rows and columns of the traceability matrix view.
3 Click OK.
The traceability matrix view appears with the selected objects in rows
and columns.

Requirements Model User's Guide 35


Defining requirements views

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.

The Select Row/Column Objects dialog box appears.

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.

Requirements Model User's Guide 37


Defining requirements views

Filtering with empty rows and columns


You can filter a traceability matrix view by hiding or displaying its full or
empty rows and columns:
♦ In the menu bar, select Requirements→Display Only Full
Rows/Columns or Display Only Empty Rows/Columns
♦ In the matrix view toolbar, use the following tools:

Tool Tooltip Description


Display Only Full When pushed-in, it displays only full rows and
Rows/Columns columns, so that you focus only on
requirements with links
Display Only Empty When pushed-in, it displays only empty rows
Rows/Columns and columns that need to be linked

Creating a traceability link


To create a traceability link in a traceability matrix view:
♦ Click an empty cell in the traceability matrix view, and type “V” or press
the space bar
♦ Use the Current cell properties group box

™ To create a traceability link using the Current cell properties group


box:
1 In the traceability matrix view, click an empty cell where you want to
create a link between a requirement and a design object, an external file,
or another requirement.
The current cell properties appear at the bottom of the traceability matrix
view.

38 PowerDesigner
Chapter 2 Building a requirements model

2 Click the Create Traceability Link tool.

The traceability link is created. A check mark appears in the selected cell
and the current cell properties are modified.

3 <optional> Select a value in the Link type dropdown listbox to specify


the kind of linked object involved in the traceability link.
Note: The Link type values are customizable through an extended model
definition. (See Customizing a list of values in section Detail properties,
in Defining requirements properties)
The traceability link is automatically created in the Traceability Links page
of the concerned requirement property sheet.
A bookmark can be defined when you create a link with an MS Word file, in
the Traceability Links page of a requirement property sheet. (See Defining a
bookmark in an MS Word document)

Deleting a traceability link


To delete a traceability link in a traceability matrix view:
♦ Click a full cell in the traceability matrix view, and press the Delete key
or the space bar
♦ Use the Current cell properties group box

™ To delete a traceability link using the Current cell properties group


box:
1 In the traceability matrix view, click the cell corresponding to the
traceability link you want to delete.
The current cell properties appear at the bottom of the traceability matrix
view.

Requirements Model User's Guide 39


Defining requirements views

2 Click the Delete Traceability Link tool.

The traceability link is deleted. The check mark disappears from the
selected cell and the current cell properties are grayed.

The traceability link is automatically deleted from the Traceability Links


page of the concerned requirement property sheet.

Creating a requirements view


You can create a requirements view (document or traceability matrix view):
♦ Using the View menu
♦ Using the Requirements menu
♦ Using the requirements view toolbar
♦ Using the Browser tree view
When you create a new requirements view of the same type as an existing
requirements view, the new view is the perfect copy of the original view
(same hierarchy of requirements or same traceability links). You can modify
the new view without altering the original view.

40 PowerDesigner
Chapter 2 Building a requirements model

Using the View menu

™ To create a requirements view using the View menu:


1 In the menu bar, select View→Requirements View→New
View→Requirements Document View or Traceability Matrix View.
The New View dialog box appears.

2 Type a name and a code for the new view.


3 Click OK.
You can now work on this new requirements view.

Using the Requirements menu

™ To create a requirements view using the Requirements menu:


♦ In the menu bar, select Requirements→Create a Requirements Document
View or Create a Traceability Matrix View.
A new requirements document view or traceability matrix view appears
in the workspace.

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.

Requirements Model User's Guide 41


Defining requirements views

Using the requirements view toolbar


You can create a new view using the toolbar located on top of a requirements
view.
In the requirements view toolbar, select one of the following tools:

Tool Tooltip Description


Create a Requirements A new requirements document view is
Document View created with the same hierarchy of
requirements as the original view. You
can modify the new view without altering
the original view.
This feature is also available from the
Requirements menu
Create a Traceability A new traceability matrix view is created
Matrix View with the same traceability links as the
original view. You can modify the new
view without altering the original view.
This feature is also available from the
Requirements menu

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.

Using the Browser tree view

™ To create a requirements view using the Browser:


1 In the Browser, right-click a model or a package name or icon, to display
its contextual menu.
2 In the contextual menu, select New→Requirements Document View or
Traceability Matrix View.

42 PowerDesigner
Chapter 2 Building a requirements model

A new requirements document view appears in the workspace, along


with its property sheet.

or
A new traceability matrix view appears in the workspace, along with its
property sheet.

Note the Traceability matrix type property, specific to the traceability


matrix view property sheet.

Requirements Model User's Guide 43


Defining requirements views

3 Type a name and a code for the new requirements view.


4 < Only for traceability matrix views > Select the type of linked objects in
the Traceability matrix type dropdown listbox.
5 Click OK.
You can now work on this new requirements view.

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:

Note: All columns (except Title ID) are editable.

Defining requirements properties


To display a requirement property sheet:
♦ Double-click the arrow beside the requirement in the requirements
document view
♦ Double-click its name or icon in the Browser tree 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

Requirements Model User's Guide 45


Defining requirements

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)

™ To customize a list of values:


1 In the menu bar, select Model→Extended Model Definitions.
The List of Extended Model Definitions appears.
2 Click the Add a Row tool.
or
Click a blank line in the list.

Requirements Model User's Guide 47


Defining requirements

An extended model definition appears with generic name and code.

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.

6 In the left pane, expand the Settings category.


7 In the Settings category, expand the Custom Values category.

48 PowerDesigner
Chapter 2 Building a requirements model

8 In the Custom Values category, expand the Requirement category.

Note: Expand the TraceabilityLink category to define Link type values


in traceability matrix views, and the UserAllocation category to define
Type values in the User Allocations page of requirements property
sheets.
9 In the Requirement category, select one property. For example,
TypeMap.

Requirements Model User's Guide 49


Defining requirements

The right panel displays the name and comment (definition, default
values) for the selected property.

10 In the Value table, click the Add a Row tool.


or
Click a blank line in the list.
A value is created with a generic name.

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).

12 Repeat step 11 for each value you want to create.


13 Click OK in the extended model definition property sheet.
The new extended model definition appears in the List of Extended
Model Definitions.
14 Click OK in the List of Extended Model Definitions.
The requirement property dropdown listbox displays the customized
values.

Requirements Model User's Guide 51


Defining requirements

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:

Tool Tooltip Description


Add Links to Design Objects Creates shortcuts to attach design
objects to the current requirement.
Design objects are selected from
design models open in the
workspace
Add Link to External File Creates a link between an external
file (whatever the format) and the
current requirement. The external
file is stored in a Files folder
within the model.
See Defining a bookmark in an
MS Word document
Add Links to Other Requirements Creates a link between the current
requirement and other
requirements from the same
model, but from different
hierarchies (different root
requirements) and not yet selected

52 PowerDesigner
Chapter 2 Building a requirements model

Defining a bookmark in an MS Word document


In the Traceability Links page of a requirement property sheet, click the Add
Link to External File tool, then select an MS Word file in your directory. A
message appears indicating that the system is parsing the MS Word document
to extract its paragraph titles.

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).

Requirements Model User's Guide 53


Defining requirements

Modifying a To modify a bookmark in an MS Word document, click the bookmark cell in


bookmark the Traceability Links page of the requirement property sheet, then click the
Ellipsis button (…) to redefine a bookmark.
Displaying a To display a bookmark in an MS Word document, select the linked file in the
bookmark Traceability Links page of the requirement property sheet, then click the
Properties tool in the page toolbar. The MS Word document appears starting
with the title defined as bookmark.

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.

Related glossary terms


The Related Glossary Terms page of a requirement property sheet allows you
to attach specific terms, defined in the model, to the current requirement. It
lists the vocabulary that is used for the current requirement, or that should be
used for matters concerning the current requirement.
 For more information on glossary terms, see section Defining glossary
terms.

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

™ To create a requirement from a requirements document view:


1 Click any empty cell in the requirements document view.
or
Click the Insert a Row tool in the requirements document view toolbar.
A requirement appears in the requirements document view, with
predefined properties.

Note: All columns (except Title ID) are editable.


2 Double-click the arrow beside the requirement Title ID.
or
Click the Properties tool in the requirements document view toolbar.
The requirement property sheet appears.

Requirements Model User's Guide 55


Defining requirements

3 Type a title and a code for the requirement.

4 Define other properties in the different pages of the requirement property


sheet.
5 Click OK.

56 PowerDesigner
Chapter 2 Building a requirements model

Defining users and groups


Users are all the people concerned by at least one requirement defined in a
requirements model.
Groups are categories of users specialized in one or more aspects of a
development process (e.g. a QA team). A group is concerned by at least one
requirement defined in a requirements model.
Users and groups are attached to requirements via the User Allocations page
of the requirements property sheet.
The Dependencies page of a user or group property sheet displays:
♦ The list of requirements assigned to that user or group
♦ The groups or child groups linked to that user or group

Creating a user or a group


You can create a user or a group:
♦ From the List of Users or Groups in the Model menu
♦ From the Browser tree view

™ To create a user or a group from the Browser tree view:


1 In the Browser tree view, right-click the model name or icon.
2 In the model contextual menu, select New→User.
or
Select New→Group.
The user or group property sheet appears.
3 Type a name and a code for the new user or group.
4 Click OK.
The new user or group appears in the Browser, in its corresponding
folder (Users or Groups).

Requirements Model User's Guide 57


Defining users and groups

User general properties


The General page of a user property sheet displays the following properties:

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

Group general properties


The General page of a group property sheet displays the following properties:

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

Attaching users and groups to a group


The Group Users page of a group property sheet allows you to attach users
and child groups to the current group.

™ To attach users and groups to a group:


1 In the Group Users page of a group property sheet, click the Add
Objects tool.
The Add Objects dialog box appears.
2 In the User page, select the users you want to attach to the current group.
3 In the Group page, select the child groups you want to attach to the
current group.
4 Click OK.
The selected users and child groups appear in the Group Users page of
the current group property sheet.

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)

Requirements Model User's Guide 59


Defining glossary terms

Defining glossary terms


Glossary terms are clearly defined words used to avoid misinterpretations in
a requirements model. Use the Description tab, in the Notes page of a
glossary term property sheet, to give a full and precise description of a
glossary term.
Glossary terms are attached to requirements via the Related Glossary Terms
page of the requirements property sheet.
The Dependencies page of a glossary term property sheet displays the
requirements associated with the glossary term.

Glossary term general properties


The General page of a glossary term property sheet displays the following
properties:

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

Creating a glossary term


You can create a glossary term:
♦ From the Browser tree view
♦ From the List of Glossary Terms in the Model menu

™ To create a glossary term from the List of Glossary Terms:


1 In the menu bar, select Model→Glossary Terms.
The List of Glossary Terms appears.
2 Click the Add a Row tool.
or
Click a blank line in the list.
A new glossary term appears in the list, with generic name and code.
3 Click Apply.
4 Double-click the arrow at the beginning of the line.
The glossary term property sheet appears.
5 Type a name and a code for the new glossary term.
6 Click OK.
The new glossary term appears in the List of Glossary Terms.
7 Click OK.

Requirements Model User's Guide 61


Using design objects

Using design objects


Design objects are objects defined in design models (CDM, PDM, OOM,
BPM, FEM, XSM, ILM). These objects can be an additional source of
information about requirements, either in the making of a requirements
model, or as a result of a requirement satisfaction.
You can perform several actions concerning design objects in 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

Defining business rules


Business rules are not available by default in a requirements model. You
must activate them. (See Activating business rules in a requirements model)

What is a business rule?


A business rule is a written statement specifying what a model must contain
or how it must be structured to support business needs.
A business rule is a rule that your business follows. It could be a government-
imposed law, a customer requirement, or an internal guideline.
In the case of the Requirements Model, a business rule should be used as a
super requirement, i.e. a requirement defined for requirements. For
instance, a business rule could be a methodological rule for writing
requirements.

Activating business rules in a requirements model


Business rules are activated through the creation of an extended model
definition.

™ To activate business rules in a requirements model:


1 Select Model→Extended Model Definitions, to display the List of
Extended Model Definitions.
2 Click the Add a Row tool to create a new extended model definition.
3 Click Apply.

Requirements Model User's Guide 63


Defining business rules

4 Double-click the arrow at the beginning of the line, to display the


extended model definition property sheet.

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).

Requirements Model User's Guide 65


Defining business rules

Defining business rules properties


To display a business rule property sheet, double-click its name or icon in the
Browser tree view.

Business rule general properties


The General page of a business rule property sheet displays the following
properties:

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

You can define several types of business rules in a requirements model:

Type Description Example


Constraint Additional check constraint The start date should be inferior
on a value to the end date of a project
Definition Properties of an object in the A customer is a person
requirements model identified by a name and an
address
Fact Certainty, existence in the A client may place one or more
requirements model orders
Formula Calculation used in the The total order is the sum of all
requirements model the order line costs
Requirement Functional specification for The model is designed so that
the requirements model total losses do not exceed 10%
of total sales
Validation Constraint on a value in the The sum of all orders for a
requirements model client must not be greater than
the client's allowance

66 PowerDesigner
Chapter 2 Building a requirements model

Business rule expression property


The Expression page of a business property sheet allows you to complete a
rule by adding a technical expression.
There are two types of expression for a business rule:
♦ Server, for database generation
♦ Client, for documentation purposes
Expressions are mainly used in CDMs or PDMs.

Creating a business rule


You can create a business rule in different ways:
♦ From the Browser tree view
♦ From the List of Business Rules

™ To create a business rule from the List of Business Rules:


1 Select Model→Business Rules, to display the List of Business Rules.
2 Click the Add a Row tool.
or
Click a blank line in the list.
A rule appears with generic name, code and rule type.
3 Type a name, a code, and select a type in the Rule Type dropdown
listbox.

Requirements Model User's Guide 67


Defining business rules

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.

7 Click OK in the business rule property sheet.


The business rule appears in the List of Business Rules.
8 Click OK in the List of Business Rules.
Expand the Business Rules folder in the Browser tree view to reveal the
business rule.

68 PowerDesigner
Chapter 2 Building a requirements model

Applying a business rule to a requirement


Once you have defined a business rule in the List of Business Rules, you can
apply this business rule to a requirement.

™ To apply a business rule to a requirement:


1 In the Browser tree view, double-click the name or icon of a
requirement.
or
In the requirements document view, double-click the line number of a
requirement.
The requirement property sheet appears.
2 In the Rules page, click the Add Objects tool to display the Selection
dialog box.
3 Select a business rule.

Requirements Model User's Guide 69


Defining business rules

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

Working with a requirements model

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

Checking a requirements model 72


Requirements model objects verified by Check Model 79
Comparing and merging requirements models 85
Linking requirements with design objects 86
Exporting requirements as design objects 95
Importing design objects as requirements 99

Requirements Model User's Guide 71


Checking a requirements model

Checking a requirements model


The Requirements Model is a very flexible tool. It allows you to build your
model without any controls or constraints on data exchange and consistency
of the system.
However, you can use the Check Model feature at any time to control the
consistency and correctness of the model you are building.
With the Check Model feature, you can:
♦ Define check options, such as level of problem severity and automatic
correction
♦ Select objects to be verified
♦ Check a requirements model
♦ Reuse check options previously defined
♦ Make corrections based on requirements model check results

Defining options in Check Model


When you check a requirements model, if a parameter is invalid, it is
displayed as an error or a warning in the Check Model window.
You can define levels of severity for problems that Check Model finds and
some problems are automatically corrected.

Levels of problem severity


You can identify the level of problem severity with the following tools:

Tool Tooltip Description


Error Major problem that produces an invalid requirements model

Warning Minor problem or recommendation

To display the severity level options, select Tools→Check Model, then


expand the nodes of the tree view in the options tab.

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.

Tool Tooltip Description


Automatic PowerDesigner will correct the problem automatically
correction

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.

Selecting objects in Check Model


You select objects to be checked from the Selection page of the Check Model
Parameters dialog box (Tools→Check Model).
You can list all objects, including composite objects created in the current
model, by selecting the Include Sub-Objects tool.

Checking a requirements model


You can check the validity of a requirements model at any time.

™ To check a requirements model:


1 In the menu bar, select Tools→Check Model.
or
Click the Check Model tool in the toolbar.

The Check Model Parameters dialog box displays the Options page.
Requirements Model User's Guide 73
Checking a requirements model

2 Expand an object parameter node.


The object parameters verified by the Check Model are displayed with
the symbols indicating a degree of problem severity.

3 If you want to change a degree of problem severity, select the object


parameter and then click either the Error or Warning tool.
The symbol changes to the appropriate severity level.
4 If you want PowerDesigner to automatically correct a problem, select the
object parameter and then click the Automatic Correction tool.
The Automatic Correction symbol appears superimposed on the Error or
Warning symbol for that object parameter.
5 Click the Selection tab to display the Selection page.
6 Select a model from the dropdown listbox at the top of the dialog box.

74 PowerDesigner
Chapter 3 Working with a requirements model

7 Click an object tab at the bottom of the Selection page.


The corresponding object page displays all the objects in the current
requirements model.

8 Select or clear check boxes for objects you want to be checked or not.

Select all / Deselect all check boxes


Click the Select All tool to select all object check boxes.
Click the Deselect All tool to clear all object check boxes.

9 Click OK.
The Check Model Result List displays errors and warnings based on the
check options you have defined.

Dockable result window


When you right-click an object parameter in the Result List, a
contextual menu appears listing correction options. Among these, you
can also select options to clear, dock or hide the result window.

Requirements Model User's Guide 75


Checking a requirements model

Displaying previously applied check options in a requirements


model
If you click the Apply button in the Check Model Parameters dialog box, all
error and warning selections are stored in memory.

™ To display errors and warnings selected in the last check:

♦ In the menu bar, select Tools→Check Model.


The Check Model Parameters dialog box displays the Options page. The
object parameters are displayed with the Error or Warning icons selected
in the last check.

Making corrections based on requirements model check results


You use the Check Model feature to locate and correct problems in a
requirements model.
Using the Check toolbar generally located in the upper part of the
PowerDesigner main window, you have access to the following correction
options when you select an error in the Result List:

Tool Tooltip Description


Correct Error Displays the property sheet of the erroneous object

Check Again Checks the selected object parameter after correction


Model
Automatic PowerDesigner automatically corrects non-unique
Correction names and codes
First Error Goes to the first error

Previous Error Goes to the previous error

Next Error Goes to the next error

Last Error Goes to the last error

76 PowerDesigner
Chapter 3 Working with a requirements model

Display the Check toolbar


If the Check toolbar is not displayed, select Tools→Customize Toolbars
and select the Check check box.

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.

Making manual corrections to a requirements model


Some errors cannot be corrected automatically, they must be corrected
manually.

™ To make manual corrections to a requirements model:


1 Select an object parameter from the Result List.
2 Right-click the object parameter and select Correct from the contextual
menu to display the object property sheet.
3 Select the appropriate tab and make the necessary correction.
4 Close the property sheet.
5 Right-click the object parameter and select Check Again from the
contextual menu.
Verify that the problem has been corrected by running Check Model
again.

Requirements Model User's Guide 77


Checking a requirements model

Making automatic corrections to a requirements model


PowerDesigner can perform automatic corrections on non-unique names and
codes.

™ To make automatic corrections to a requirements model:


1 Select an object parameter from the Result List.
2 Right-click the object parameter and select Automatic Correction from
the contextual menu.
3 Right-click the object parameter and select Check Again from the
contextual menu.
Verify that the problem has been corrected by running Check Model
again.

78 PowerDesigner
Chapter 3 Working with a requirements model

Requirements model objects verified by Check


Model
The Check Model verifies the validity of requirements model objects.
When errors are found during a check model, corrections can be made
manually or automatically. Manual corrections depend on how you are using
your model.
Some checks are not available if the object is not supported by the model.

Use the Help command to select object control options


When you right-click a requirements model object control in the Check
Model Parameters page, a menu appears listing several options. The Help
command opens a contextual help page explaining the checks performed
for the selected object type.

Business rule check


During a business rule check, the following object controls are made.

Business rule name and code uniqueness


A model cannot contain two business rules with identical names and/or
codes.

Manual correction Automatic correction


Modify the duplicated business rule Modifies the business rule name/code
name/code of a selected object by appending a
number to its current name

Unused business rule


The business rule you have created should be used in the model.

Manual correction Automatic correction


Apply the business rule to an object in —
the model

Requirements Model User's Guide 79


Requirements model objects verified by Check Model

Glossary term check


During a glossary term check, the following object controls are made.

Glossary term name and code uniqueness


A model cannot contain two glossary terms with same names and/or codes.

Manual correction Automatic correction


Modify the duplicated glossary term Modifies the glossary term name
name and/or code and/or code by appending a number
to its current name and/or code

Unused glossary term


A glossary term should be attached to at least one requirement.

Manual correction Automatic correction


Attach the glossary term to a requirement, —
by using the Related Glossary Terms
page of the requirement property sheet, or
delete the glossary term

User check
During a user check, the following object controls are made.

User name and code uniqueness


A model cannot contain two users with same names and/or codes.

Manual correction Automatic correction


Modify the duplicated user name and/or Modifies the user name and/or code
code by appending a number to its current
name and/or code

80 PowerDesigner
Chapter 3 Working with a requirements model

Existence of user allocation


A user should be allocated to at least one requirement.

Manual correction Automatic correction


Attach the user to a requirement, by using —
the User Allocations page of the
requirement property sheet, or delete the
user

Group check
During a group check, the following object controls are made.

Group name and code uniqueness


A model cannot contain two groups with same names and/or codes.

Manual correction Automatic correction


Modify the duplicated group name and/or Modifies the group name and/or code
code by appending a number to its current
name and/or code

Existence of user
A group must contain at least one user or another group of users.

Manual correction Automatic correction


Attach a user or another group to the —
group, by using the Group Users page of
the group property sheet, or delete the
empty group

Requirements Model User's Guide 81


Requirements model objects verified by Check Model

Circular group definition


One group cannot be at the same time parent and child of another group.

Manual correction Automatic correction


Remove a group (parent group) from the —
Group Users page of another group
(child group) property sheet.
The parent group appears in the
Dependencies page of the child group
property sheet

Requirement check
During a requirement check, the following object controls are made.

Requirement title uniqueness


A model cannot contain two requirements with same titles.

Manual correction Automatic correction


Modify the duplicated title —

Requirement code uniqueness


A model cannot contain two requirements with same codes.

Manual correction Automatic correction


Modify the duplicated code —

82 PowerDesigner
Chapter 3 Working with a requirements model

Empty description on atomic requirement


An atomic requirement (as opposed to a composite requirement) should have
a description.

Manual correction Automatic correction


In the requirement property sheet, type a —
description in the Description box of the
General page or in the Description tab of
the Notes page

File check
During a file check, the following object controls are made

Embedded file name uniqueness


A model cannot contain two embedded files with identical names.

Manual correction Automatic correction


Rename one of the embedded files Renames the file by appending a
number to its name

Existence of external file location


An external file should have a valid path location.

Manual correction Automatic correction


Define a valid path location —

Requirements Model User's Guide 83


Requirements model objects verified by Check Model

Extended object check


During an extended object check, the following object control is made.

Extended object name and code uniqueness


Extended object names and codes must be unique in the namespace.

Manual correction Automatic correction


Modify the duplicated extended object Modifies the extended object name or
name/code code of a selected object by appending a
number to its current name or code

Extended link check


During an extended link check, the following object control is made.

Extended link name and code uniqueness


Extended link names and codes must be unique in the namespace.

Manual correction Automatic correction


Modify the duplicated extended link Modifies the extended link name or
name/code code of a selected object by appending a
number to its current name or code

Replication check
During a replication check, the following object control is made.

Partial object replication


A replica object is partially synchronized with its replicated object.

Manual correction Automatic correction


Modify the list of replicated attributes Enforces the replication of
from the replication property sheet desynchronized attributes of the
replica object in the replication
property sheet

84 PowerDesigner
Chapter 3 Working with a requirements model

Comparing and merging requirements models


You can compare and merge two requirements models.
The comparison process allows you to highlight the differences between two
requirements models.
The merge process allows you to form a single model that combines design
efforts performed independently by several team members.
Merge is performed from left to right. The model in the right pane is
compared to the model in the left pane. Differences are highlighted and
merge actions are proposed in the model to be merged.
 For more information on comparing and merging models, see chapter
Comparing and Merging Models in the General Features Guide.

Requirements Model User's Guide 85


Linking requirements with design objects

Linking requirements with design objects


You should always try to link requirements with design objects (objects from
other types of models), to verify that the design process meets the
requirements.
Requirements can be linked with design objects, either from a requirements
model or from a design model.

Attaching design objects to requirements


When a design object meets a requirement, you should attach it to the
requirement.
The following procedure assumes you have a requirements model and a
design model (CDM, PDM, OOM, BPM, XSM or ILM) open in the
workspace.

™ To attach design objects to a requirement:


1 In the requirements document view, double-click the row number of a
requirement.
The requirement property sheet appears.
2 Click the Traceability Links tab.
3 In the toolbar of the Traceability Links page, click the Add Links to
Design Objects tool.
A Select Design Objects dialog box appears.

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.

Requirements Model User's Guide 87


Linking requirements with design objects

7 < If you clicked Apply > Double-click a row number corresponding to a


design object in the list.
The design object shortcut property sheet appears.

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

9 In the design object property sheet, click the Requirements tab to


display the list of requirements attached to the design object.

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).

Attaching requirements to design objects


To verify that the design process meets the requirements, you should attach
requirements to objects in design models (CDM, PDM, OOM, BPM, XSM,
ILM).
If no requirement has yet been attached to a design object, then you must
activate the Requirements page in the design objects property sheet.

Requirements Model User's Guide 89


Linking requirements with design objects

Activating the Requirements page in a design model


The following procedure assumes you have a design model open in the
workspace.

™ To activate the Requirements page in a design model:


1 In the menu bar, select Tools→Model Options.
The Model Options dialog box appears.
2 In the Model Settings page, select Enable links to requirements in the
All Objects group box.
3 Click OK.
Double-click any symbol in the diagram to verify that a new Requirements
page appears in the design object property sheet.

Add requirements in a Requirements page


The following procedure assumes you have a design model and a
requirements model open in the workspace.

™ To add requirements in a Requirements page:


1 Double-click the object symbol in the diagram. (e.g. a use case from an
OOM)
The object property sheet appears.
2 Click the Requirements tab to display the Requirements page.
3 In the Requirements page toolbar, click the Add Objects tool.

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.

4 In the Add Objects toolbar, click the Include Sub-Objects tool to


display all the requirements, and select the requirements you want to
attach to the design object.

Requirements Model User's Guide 91


Linking requirements with design objects

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.

Requirements Model User's Guide 93


Linking requirements with design objects

9 In the requirement property sheet, click the Traceability Links tab to


display the list of linked objects.

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

Exporting requirements as design objects


As requirements must be satisfied during a design process, you might want to
visualize or integrate them into design models.
The Requirement Export Wizard allows you to export requirements as
design objects in design models (CDM, PDM, OOM, BPM, FEM, XSM,
ILM). The resulting design objects bear the same name and code as their
corresponding requirement. A traceability link is created between each design
object and its corresponding requirement.

Caution
The design models to which you want to export requirements must be
open in the workspace.

™ To export requirements as design objects:


1 In the menu bar, select Requirements→Export Requirements as Design
Objects.
The Requirement Export Wizard appears.
2 Select the design model to which you want to export requirements, and
click Next.
3 Select the type of design objects to which you want to export
requirements, and click Next.
4 Select the requirements you want to export, and click Finish.
The requirements appear in the design model as design objects.

Requirements Model User's Guide 95


Exporting requirements as design objects

Selecting the design model


In the first page of the Requirement Export Wizard, select the design model
to which you want to export requirements.

Note: The dialog box only displays design models that are open in the
workspace.

Selecting the type of design objects


In the second page of the Requirement Export Wizard, select the type of
design objects into which you want to transform the requirements.

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.

Selecting the requirements


In the third and last page of the Requirement Export Wizard, you select the
requirements you want to export as design objects.

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.

Requirements Model User's Guide 97


Exporting requirements as design objects

Design objects symbols


By default, the symbols of the new design objects do not appear in the
diagram.
To display them, you can either drag and drop the design objects from the
Browser to the diagram, or select Symbol→Show Symbols, in the menu
bar, and select the symbols in the Show Symbols dialog box.

98 PowerDesigner
Chapter 3 Working with a requirements model

Importing design objects as requirements


Some objects in design models (CDM, PDM, OOM, BPM, FEM, XSM,
ILM) might correspond to requirements that users must satisfy during a
design process.
The Requirement Import Wizard allows you to import design objects as
requirements. The resulting requirements bear the same name and code as
their corresponding design object. A traceability link is created between each
requirement and its corresponding design object.

Caution
You must have a design model and a requirements model open in the
workspace.

™ To import design objects as requirements:


1 In the menu bar, select Requirements→Import Design Objects as
Requirements.
The Requirement Import Wizard appears.
2 Select the design model from which you want to import objects as
requirements, and click Next.
3 Select the design objects you want to import as requirements, and click
Next.
4 In the requirements model, select at what level of the requirements
hierarchy you want to add the new requirements, and click Finish.
The design objects appear in the requirements model as requirements.

Requirements Model User's Guide 99


Importing design objects as requirements

Selecting the design model


In the first page of the Requirement Import Wizard, select the design model
from which you want to import design objects as requirements.

Note: The dialog box only displays design models that are open in the
workspace.

Selecting the design objects


In the second page of the Requirement Import Wizard, select the design
objects you want to import as requirements.

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.

Selecting the requirements hierarchy


In the third and last page of the Requirement Import Wizard, select at what
level of a requirements hierarchy you want to add the new requirements.

Click Finish, and the design objects (Language, Hot Line) appear as
requirements in the requirements model (Browser and document view).

Requirements Model User's Guide 101


Importing design objects as requirements

102 PowerDesigner
C H A P T E R 4

Using MS Word with a requirements model

About this chapter This chapter explains how you can work jointly with an MS Word document
and a requirements model.

Case 1 You can start from an MS Word document…

… and create a requirements model.

The MS Word document and the requirements model can be linked.

Requirements Model User's Guide 103


Creating a requirements model from an MS Word document

Case 2 You can start from a requirements model…

… and create an MS Word document.

The requirements model and the MS Word document are linked.

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

Creating a requirements model from an MS Word document 106


Creating a requirement from a selected text 117
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

Requirements Model User's Guide 105


Creating a requirements model from an MS Word document

Creating a requirements model from an MS


Word document
You can create a requirements model from an MS Word document using
PowerDesigner (See Import feature) or MS Word (See Requirements menu
and toolbar). The MS Word option is more direct.

Heading styles
To be properly converted into a requirements model, an MS Word
document must use MS Word-based heading styles.

Graphics are not imported in a requirements model.

Importing an MS Word document as a requirements model


In PowerDesigner, you can call the Import feature in different ways:
♦ Use the File menu
♦ Right-click an empty requirements model and select Import from Word
Document in the contextual menu
♦ Right-click an empty requirements package and select Import from
Word Document in the contextual menu
The following procedure assumes you have an MS Word document available,
with MS Word-based headings.

™ To import an MS Word document using the File menu:


1 In the PowerDesigner menu bar, select File→Import→Word Document.
The Open dialog box appears.
2 Select a directory in the Look in dropdown listbox, and an MS Word file
(.doc) in the list.

106 PowerDesigner
Chapter 4 Using MS Word with a requirements model

3 Click Open.
The following message appears in the PowerDesigner window.

4 Click Yes, if you want the MS Word document to be linked to the


requirements model, so as you can synchronize them later on. The Save
As dialog box appears. Select a directory in the Save in box, type a name
in the File name box, and click Save.
or
Click No, if you do not want the MS Word document to be linked to the
requirements model.
A message appears indicating that the MS Word document is being
parsed to extract its paragraph titles. You can cancel the parsing at any
time, only the parsed sections are converted into requirements.
When the parsing is over, the Select Titles to Import dialog box
appears.

Requirements Model User's Guide 107


Creating a requirements model from an MS Word document

5 Click the Expand All tool to display all titles.

All titles are selected by default.


You can click the Deselect All tool, and then select the titles you want to
convert as requirements.
6 Click OK.
The MS Word document appears in the workspace as a requirements
model.

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

Using MS Word to create a requirements model


An MS Word document can contain one or several titles, with their
associated text, that you would like to use as requirements.
Check that MS Word has a Requirements menu…

… and a Requirements toolbar.

If not, select Tools→Templates and Add-Ins, and check the


WordToRqm.dot item.
The following procedure assumes you have an MS Word document open,
with MS Word-based headings.

™ To use MS Word to create a requirements model:


1 In the MS Word menu bar, select Requirements→Create/Update a
Requirements Model from the Document.
or
In the Requirements toolbar, click the Create/Update a Requirements
Model from the Document tool.

The following message appears.

2 Click Yes, if you want the MS Word document to be linked to the


requirements model, so as you can synchronize them later on. The Save
As dialog box appears. Select a directory in the Save in box, type a name
in the File name box, and click Save.
or
Click No, if you do not want the MS Word document to be linked to the
requirements model.

Requirements Model User's Guide 109


Creating a requirements model from an MS Word document

A message appears indicating that the MS Word document is being


parsed to extract its paragraph titles. You can cancel the parsing at any
time, only the parsed sections are converted into requirements.
When the parsing is over, the Select Titles to Import dialog box
appears.

3 Click the Expand All tool to display all titles.

All titles are selected by default.


You can click the Deselect All tool, and then select the titles you want to
convert as requirements.

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.

Requirements Model User's Guide 111


Creating a requirements model from an MS Word document

How are a model and a document linked?


An MS Word document and a requirements model (or package) are linked
when you need to synchronize them when they change.
The following sections explain how a document and a model (or package) are
linked.

How is an MS Word document linked?


An MS Word document is linked to a requirements model (or package)
through custom properties and requirement tags.
Custom properties An MS Word document is linked to a requirements model (or package)
through the Custom page of its property sheet.
To display the document property sheet, select File→Properties.

112 PowerDesigner
Chapter 4 Using MS Word with a requirements model

The Custom page displays information concerning the linked requirements


model (or package):
♦ Model ID
♦ Model name
♦ File path
♦ Last update
♦ (Package ID)
♦ (Package name)

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].

To display the requirement tags, click the Show/Hide ¶ tool.

Requirements Model User's Guide 113


Creating a requirements model from an MS Word document

How is a requirements model linked?


A requirements model (or package) is linked to an MS Word document
through an attached file and traceability links.
Attached file A requirements model (or package) is linked to an MS Word document when
the MS Word file appears in the Browser, in a Files folder attached to the
model (or package).

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.

Requirements Model User's Guide 115


Creating a requirements model from an MS Word document

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

Creating a requirement from a selected text


In MS Word, the Create a Requirement from the Selected Text feature is
useful in the following cases:
♦ When you have already created a linked requirements model, and you
want to add a new section (title and text) from the document to the
model. You type the section in the document (between a requirement end
tag [/PDRQM] and a requirement start tag [PDRQM]), then you select it
and export it to the model
♦ When you want to add a new requirement from an MS Word document
to an existing requirements model, and you do not want the document to
be linked to the model
The following procedure assumes you have an MS Word document open,
with MS Word-based headings.
PowerDesigner can be open, with an existing requirements model linked or
not.

™ To create a requirement from a selected text:


1 In the MS Word document, select the section (title and text) you want to
convert into a requirement.

2 In the MS Word menu bar, select Requirements→Create a Requirement


from the Selected Text.
or
In the Requirements toolbar, click the Create a Requirement from the
Selected Text tool.

If the document is linked to a model, the section is directly exported as a


requirement in the model. The location of the section, between a
requirement end tag and a requirement start tag, determines the location
of the requirement in the model. If the section has no title, then it is
exported as a sub-requirement of the previous requirement.

Requirements Model User's Guide 117


Creating a requirement from a selected text

If the document is not linked to a model, the following message appears.

3 Click Yes, if you want the section to be linked to the requirements


model.
or
Click No, if you do not want the section to be linked to the requirements
model.
A Select the requirements model dialog box appears.
4 Select <New model>.
or
Select an existing requirements model. (It must be open in the
workspace)

Note: Only models open and not linked to a document, or containing at


least one package not linked, appear in this dialog box.
5 Click OK.
If you selected <New model>, the Save As dialog box appears to let you
save the new model. Select a directory in the Save in dropdown listbox,
type a name in the File name box, select Word Document (*.doc) in the
Save as type dropdown listbox, and click Save. A new requirements
model appears with an atomic requirement corresponding to the selected
text.

118 PowerDesigner
Chapter 4 Using MS Word with a requirements model

If you selected an existing requirements model, the Select a Place in


Document dialog box appears with the model root node.

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.

Requirements Model User's Guide 119


Creating a requirement from a selected text

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

Creating an MS Word document from a


requirements model
In a requirements document view, you can write the title and description of
requirements using the rich edit text features. To improve the layout and
readability of a requirements model, you can transform it into an MS Word
document.
You can also create an MS Word document from a package containing at
least one requirement.
The following procedure assumes you have a requirements model open in the
workspace. MS Word can be open or closed.

™ To create an MS Word document from a requirements model:


1 In the Browser tree view, right-click the model name and select Export
as Word Document in the contextual menu.
or
In the menu bar, select Tools→Export as Word Document.
If the requirements model has not been saved yet, the Save As dialog
box appears. Select a directory in the Save in dropdown listbox, type a
name in the File name box, select Requirements Model (xml) (*.rqm) in
the Save as type dropdown listbox, and click Save.
The New dialog box appears.

Requirements Model User's Guide 121


Creating an MS Word document from a requirements model

2 In the General page, select Blank Document and Document in the


Create New box.
or
Select a template icon (.dot) and Document in the Create New box. You
might want to use a template for predefined heading styles based on MS
Word heading styles.
3 Click OK.
MS Word opens with a blank document, and the Save As dialog box
appears.
4 Select a directory in the Save in dropdown listbox, type a name in the
File name box, and select Word Document (*.doc) in the Save as type
dropdown listbox.
5 Click Save.
The requirements appear progressively in the MS Word document. Only
full descriptions (titles and descriptions) are exported.
Extract of an MS Word document created from a requirements model:

122 PowerDesigner
Chapter 4 Using MS Word with a requirements model

The requirements model and the MS Word document are automatically


linked. The document sections (titles and texts) appear between
requirement tags ([PDRQM]…[/PDRQM]), and the MS Word file is
attached to the model in the Browser:

Note: If you export a package, the MS Word file is attached to the package in
the Browser.

Requirements Model User's Guide 123


Inserting a requirements model into an existing MS Word document

Inserting a requirements model into an existing


MS Word document
A requirements model being a descriptive list of requirements, you might
want to insert it into an existing MS Word document, e.g. a functional or
technical specification.
A package containing at least one requirement can also be inserted into a
document.
The following procedure assumes you have a requirements model open in the
workspace and not linked to an existing document. MS Word can be open or
closed.

™ To insert a requirements model into an existing MS Word document:


1 In the Browser tree view, right-click the model name and select Merge
with an Existing Word Document in the contextual menu.
or
In the menu bar, select Tools→Merge with an Existing Word Document.
If MS Word is already open, you might need to click its button which
blinks in the taskbar.
The Open dialog box appears.
2 Select a directory in the Look in dropdown listbox, and an MS Word file
(.doc) in the list.
3 Click Open.
The MS Word document is parsed.
When the parsing is over, the Select a Place in Document dialog box
appears in the PowerDesigner window.

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.

6 Double-click the MS Word file in the Browser tree view.


The MS Word document appears with the added requirements.

Requirements Model User's Guide 125


Inserting a requirements model into an existing 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

Updating an MS Word document from a


requirements model
Once you have linked an MS Word document to a requirements model, you
can change the requirements model and update the linked MS Word
document.
The Update feature is available from the Browser:
♦ Right-click the model name and select Update Word Document in the
contextual menu
♦ Right-click a package name and select Update Word Document in the
contextual menu

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.

™ To update an MS Word document from a requirements model:


1 Change the requirements model.
For example, add a requirement (“Provisional Budget”).

Requirements Model User's Guide 127


Updating an MS Word document from a requirements model

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

Updating a requirements model from an MS


Word document
Once you have linked a requirements model to an MS Word document, you
can change the MS Word document and update the requirements model.
If you add graphics to a linked document, they will be preserved during an
update of the model from the document.
The following procedure assumes you have an MS Word document open and
linked to a requirements model.

™ To update a requirements model from an MS Word document:


1 Make changes in the linked MS Word document.
For example:
♦ Delete a title and its text
♦ Modify the text under a title
♦ Add a title and its text
2 In the MS Word menu bar, select Requirements→Create/Update a
Requirements Model from the Document.
or
In the Requirements toolbar, click the Create/Update a Requirements
Model from the Document tool.

The Select Titles to Import dialog box appears.

Requirements Model User's Guide 129


Updating a requirements model from an MS Word document

3 Click the Expand All tool to display all titles.

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 new model, corresponding to the modified MS Word document,


appears in the left panel. The existing model to update appears in the
right panel.
5 Expand the Requirements folder, and select the deleted title (“User list”)
in the model to update.
Deleted titles are not selected by default in the models to update.

The title with an added text line (“Scenario Descriptions”) and the
additional title (“Scenario options”) are selected by default in the model
to update.

Requirements Model User's Guide 131


Updating a requirements model from an MS Word document

6 Click OK.
The existing requirements model is updated with the recent changes.

132 PowerDesigner
Chapter 4 Using MS Word with a requirements model

Detaching an MS Word document from a


requirements model
You can always detach an MS Word document that is linked to a
requirements model.
An MS Word document is linked to a requirements model when its sections
(titles followed by a text) are bounded by a requirement start tag [PDRQM]
and a requirement end tag [/PDRQM].
Extract of a linked document:

In the MS Word menu bar, select Requirements→Detach the Document


from the Requirements Model.
or
In the Requirements toolbar, select the Detach the Document from the
Requirements Model tool.

Requirements Model User's Guide 133


Detaching an MS Word document from a requirements model

The requirement tags disappear from the MS Word document.

134 PowerDesigner
Chapter 4 Using MS Word with a requirements model

Detaching a requirements model from an MS


Word document
You can always detach a requirements model that is linked to an MS Word
document.
A requirements model is linked to an MS Word document when the MS
Word file appears in a Files folder beneath the model item in the Browser…

… and when the Traceability Links page of the requirements property sheet
displays the MS Word file as a linked object of Main document type:

Requirements Model User's Guide 135


Detaching a requirements model from an MS Word document

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

atomic requirement The last requirement of a hierarchy of requirements, or a root requirement


without child requirements
See also requirement, composite requirement, root requirement
business rule A written statement specifying what a model must contain or how it must be
structured to support business needs. In the case of a requirements model, a
business rule acts as a super requirement (a requirement on requirements). It
sets a methodology for requirements
Note: Business rules are not active by default, you activate them from an
extended model definition attached to the model
composite A requirement made of other requirements
requirement
See also requirement, atomic requirement, root requirement
design object An object from a design model in PowerDesigner (CDM, PDM, OOM, BPM,
XSM, FEM, ILM). The Requirements Model (RQM) allows you to attach
design objects to requirements, to import design objects as requirements, or
to export requirements as design objects
export wizard The Requirement Export Wizard guides you through the creation of design
objects from requirements
glossary term A term used in a requirements model. You can attach it to requirements via
the Related Glossary Terms page of their property sheet. By doing this, you
define a common vocabulary for requirements
group A group of users to which requirements are allocated. A group can contain
other groups
import wizard The Requirement Import Wizard guides you through the creation of
requirements from design objects selected in a design model open in the
workspace
priority Level of priority attached to a requirement. Values are limited to one
decimal, cannot be null or negative

Requirements Model User's Guide 137


Requirements Model Glossary

requirement A requirement is a precise description of an action that must be implemented


during a development process. Requirements are listed and organized in
requirements models, and can be associated with objects in design models
(CDM, PDM, OOM, BPM, FEM, XSM, ILM).
See also atomic requirement, composite requirement, root requirement
requirements The requirements document view is a grid in which you create a hierarchy of
document view requirements in rich edit text. Rows, corresponding to requirements, can be
moved and resized. Columns, corresponding to requirements attributes, are
editable.
Note: The requirements document view is the equivalent of a diagram in
design models
risk Level of risk should a requirement not be satisfied (The list of values is
customizable)
root requirement The first or only requirement in a hierarchy of requirements. In the Browser
tree view, it is directly linked to the model item. In a requirements document
view, it has a first level title ID
See also requirement, atomic requirement, composite requirement
status Validation level for a requirement (The list of values is customizable)
stereotype Sub-classification used to extend the semantics of an object without changing
its structure. It can be predefined or user-defined
traceability link A link between a requirement and a design object, an external file or another
requirement from a different hierarchy
traceability matrix A traceability matrix view is a grid which displays the links between
view requirements and design objects, external files or other requirements from
different hierarchies
type The type of requirement from the process point of view (The list of values is
customizable)
user A user is a person concerned by one or several requirements. You can assign
users to requirements (See User Allocations page in requirements property
sheet) and check all the requirements assigned to users (See Dependencies
page in users property sheet)
verification Test level for a requirement (The list of values is customizable)

138 PowerDesigner
Index

check model (RQM) (continued)


replication 84
requirement 82
A user 80
activate Requirements page in design model 90 check-list MS Word / RQM 105
add requirements in Requirements page 90 compare requirements models 85
attach correct error 76
design object to requirement 86 create
requirement to design object 89 MS Word document from requirements model
automatic correction 73, 76 121
requirement from selected text 117
requirements model from MS Word document
106
B customize list of values (RQM) 47
bibliography ix
bookmark (RQM) 53
business rule
activate business rule (RQM) 63 D
apply to requirement 69 demote 29
check 79 description (RQM) 45
create business rule 67 design object (RQM) 62
definition (RQM) 63 detach
expression 67 MS Word document from requirements model
type 66 133
requirements model from MS Word document
135
document view 28
C
check again model (RQM) 76
check model (RQM) 72
automatic correction 73, 76, 78 E
business rule 79 error 72
check again 76 error list 76
correct error 76 export requirements as design objects 95
error list 76 extended
extended link 84 dependencies 10
extended object 84 link check 84
file 83 model definition 6
glossary term 80 object check 84
group 81
levels of problem severity 72
manual correction 77
objects 79
objects selection 73

Requirements Model User's Guide 139


F M
file check 83 matrix view 32
functional overview (RQM) 2 merge requirements models 85
MS Word document
bookmark 53
create from requirements model 121
G create requirement from selected text 117
glossary term create requirements model 106, 109
check 80 custom properties 112
create glossary term 61 detach from requirements model 133
definition 60 import as requirements model 106
general properties 60 insert requirements model into existing MS
group (RQM) Word document 124
create group 57 requirement tags 113
definition 57 update from requirements model 127
dependencies 57 update requirements model 129
general properties 58
group users 59
group check 81
P
package (RQM)
add requirements 20
H create 24
hierarchy package (RQM) 20 define 20
general properties 21
hierarchy 20
sub-package 20
I traceability links 23
import workloads 22
design objects as requirements 99 parent (RQM) 45
MS Word document as requirements model priority (RQM) 46
106 promote 29
insert requirements model into existing MS Word
document 124

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

Requirements Model User's Guide 141


W
warning 72
wizard (RQM)
export 95
import 99
workload (for model) 12
workload (for package) 22
workload (for requirement) 46
workspace 18

142 PowerDesigner

You might also like