Visual Modeling Guidelines

honorableclunkΛογισμικό & κατασκευή λογ/κού

30 Οκτ 2013 (πριν από 3 χρόνια και 9 μήνες)

72 εμφανίσεις

IBM Global Services & Software Group

®


Olivier Béghain

IT Specialist

olivier.beghain @ be.ibm.com

PATRIS project @ SPF
-
FOD


Visual Modeling Guidelines


Last update: 8
-
APR
-
04


Vincent Urbain

Senior Consultant

vincent.urbain @ be.ibm.com

Hervé Dubois

Analyste
-
Programmeur

herve.dubois @ minfin.fed.be

IBM Global Services & Software Group

Scope of these Guidelines


This presentation focuses on:



Describing the
UML models

(as recommended within the Rational Unified
Process) used within the project and how they are supported by IBM
Rational XDE model files



Describing the various IBM Rational
XDE model file structures

adopted
within the project



Describing how to perform some
modeling tasks

within the XDE models


IBM Global Services & Software Group

The UML Models


The Business Use
-
Case model



The Business Analysis model



The System Use
-
Case model



The Analysis model



The Data Model

IBM Global Services & Software Group

The XDE Model files


bususecase.mdx



busanalysis.mdx



sysusecase.mdx



sysanalysis.mdx



sysnewlogicaldata.mdx



(note: current name is sysdatamodel.mdx)



sysoldlogicaldata.mdx



(note: need to be created)



???.mdx



(note: N models used to document existing information systems)



sysphysicaldata.mdx



(note: need to be created)

IBM Global Services & Software Group

The Business Use
-
Case Model in XDE


Note: This model is not valuable for the project


IBM Global Services & Software Group

The Business Analysis Model in XDE


Note: this model is not valuable for the project

IBM Global Services & Software Group

The System Use
-
Case Model structure in XDE

XDE model

UML package all actors
identified for the system

UML package all use
-
cases identified for the
system

UML actor

UML use
-
case

IBM Global Services & Software Group

The ‘Global View’ use
-
case diagram

NEED TO BE DOCUMENTED ONCE THE USE
-
CASE MODEL WILL BE POPULATED WITH
ELEMENTS

1

IBM Global Services & Software Group

The ‘Local View’ use
-
case diagram

NEED TO BE DOCUMENTED ONCE THE USE
-
CASE MODEL WILL BE POPULATED WITH
ELEMENTS

2

IBM Global Services & Software Group

The System Analysis Model structure in XDE (1/2)

XDE model

UML package holding the
architectural
mechanisms

UML class representing
an architectural
mechanism

UML package holding all
‘Boundary’ analysis
classes

UML package holding all
‘Control’ analysis classes

UML package holding all
‘Entity’ analysis classes

UML class diagram
showing all identified
entities (persistent and
transient ones)

UML class diagram
showing only the peristent
entities (without their
attributes)

UML class diagram
showing all entities with
their attributes

UML class attribute

UML dependency
relationship from the
entity to the ‘Persistency’
mechanism

1

2

3

IBM Global Services & Software Group

The System Analysis Model structure in XDE (2/2)

UML package holding
the realizations of
all

use
-
cases

UML package holding
the realization of a
specific use
-
case

UML class diagram
showing the association
between the identified
analysis classes and the
architectural
mechanisms

UML class diagram
showing all analysis
classes identified as
participating in the
realization of the use
-
case

UML collaboration
instance used to
represent a use
-
case
realization

UML interaction
instance used to
document a specific
scenario

UML sequence diagram
depicting visually a
specific use
-
case
scenario

UML messages
«

exchanged

»
between the analysis
classes

4

5

6

IBM Global Services & Software Group

The ‘Overview


All Entities’ class diagram

1

IBM Global Services & Software Group

The ‘Persistent info’ class diagram

2

IBM Global Services & Software Group

The ‘Responsabilities


All Entities’ class diagram

3

IBM Global Services & Software Group

The ‘Mechanisms’

4

IBM Global Services & Software Group

The ‘Participants’ class diagram

5

IBM Global Services & Software Group

The ‘Main’ sequence diagram

6

IBM Global Services & Software Group

The Data Model structure in XDE

(for relational DBs)

XDE model

UML class diagram
showing all identified
relational elements

1

UML package holding
the relational
elements shared
accross all domains

UML package holding
the relational
elements specific to a
subject area

UML class
representing a
relational table

UML class attribute
representing a
column of the table

UML dependency to
the analysis class
used to create the
relational element

UML component
representing a
relational database

IBM Global Services & Software Group

The ‘Main’ class diagram

1

IBM Global Services & Software Group

The Data Model Structure in XDE

(for Hierarchical DBs)

XDE model

UML package holding all
logical information

UML package holding all
physical information

UML component
representing an ISAM /
VSAM file

UML dependency to the
entity stored in the ISAM
/ VSAM file

UML class representing
an information stored in
the ISAM / VSAM file

UML association
between entities

UML class diagram
showing all identified
entities manipulated
through the ISAM / VSAM
files

UML component diagram
showing all ISAm / VSAM
files

UML class diagram
showing the relationships
between the files and the
entities

1

2

3

IBM Global Services & Software Group

The ‘All entities’ class diagram

1

IBM Global Services & Software Group

The ‘All files’ component diagram

2

IBM Global Services & Software Group

The ‘All associated entities’ class diagram

3

IBM Global Services & Software Group

The XDE Workspaces

2 XDE workspaces are available:



Workspace #1 is dedicated to members of the Business Analyst
team. This workspace provides access to the various XDE models
available in the PATRIS
-
PR
-
BA UCM project.



Workspace #2 is dedicated to members of the Database Modelers
team. This workspace provides access to the various XDE models
available in the PATRIS
-
PR
-
DM UCM project.



Each workspace can be accessed via an XDE shortcut where the
root directory of the worksapce is mentionned as value of the

data
parameter.

IBM Global Services & Software Group

Modeling a VSAM/ISAM information system (1/4)


Recommended organization:


1 XDE model file per system


Model sub
-
divided into 2 packages (‘Logical’ & ‘Physical’)


<<Entity>> analysis classes to model the entities stored
within the VSAM/ISAM files


<<file>> component to model the VSAM/ISAM files


UML Component diagram

showing all the VSAM/ISAM files

UML Class diagram showing all the

entities stored within the files

UML Class diagram showing which entities

are stored within a specific file

IBM Global Services & Software Group

Modeling a VSAM/ISAM information system (2/4)


Former representation:

IBM Global Services & Software Group

Modeling a VSAM/ISAM information system (3/4)


Transformation steps:

1.
For each VSAM/ISAM file, create a <<file>> component and one or
more <<entity>> classes. Note: The component should be placed on
the ‘All ISAM files’ diagram of ’the ‘Physical’ package, the class(es)
should be placed on the ‘All Entities’ diagram of the the ‘Logical’
package.

=

=

UML Component representing an ISAM file

UML Classes representing an entities

‘All ISAM files’

UML component diagram

‘All Entities’

UML class diagram

IBM Global Services & Software Group

Modeling a VSAM/ISAM information system (4/4)


Transformation steps:


For each identified <<entity>> classes, model a <<reside>> dependency relationship
between the file containing the entity and the entity itself.









Migrate the notes/documentation to the documentation field of the model (optional)


‘Associated Entities’

UML class diagram

IBM Global Services & Software Group

Modeling a use
-
case realization


Creation steps:



Note: By default
do not

name the objects used in your interaction
diagram except when you have multiple objects of the same type (the
same analysis class) and it helps to understand the scenario.