®
IBM Global Services & Software Group
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
Olivier Béghain
IT Specialist
olivier.beghain @ be.ibm.com
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
UML package all actors
identified for the system
UML actor
UML package all usecases identified for the
system
UML use-case
XDE model
IBM Global Services & Software Group
The ‘Global View’ use-case diagram
1
NEED TO BE DOCUMENTED ONCE THE USECASE MODEL WILL BE POPULATED WITH
ELEMENTS
IBM Global Services & Software Group
The ‘Local View’ use-case diagram
2
NEED TO BE DOCUMENTED ONCE THE USECASE MODEL WILL BE POPULATED WITH
ELEMENTS
IBM Global Services & Software Group
The System Analysis Model structure in XDE (1/2)
UML package holding the
architectural
mechanisms
XDE model
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 attribute
UML dependency
relationship from the
entity to the ‘Persistency’
mechanism
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
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 collaboration
instance used to
represent a use-case
realization
UML interaction
instance used to
document a specific
scenario
UML messages
« exchanged »
between the analysis
classes
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 usecase
4
5
6
UML sequence diagram
depicting visually a
specific use-case
scenario
IBM Global Services & Software Group
The ‘Overview – All Entities’ class diagram
1
DemandeInfo
MissionEvaluation
Dossier
IBM Global Services & Software Group
The ‘Persistent info’ class diagram
2
DemandeInfo
MissionEvaluation
+ id
«mechanism»
Persitency
Dossier
+ info
+ statut
IBM Global Services & Software Group
The ‘Responsabilities – All Entities’ class diagram
3
MissionEvaluation
+ id
Dossier
+ info
+ statut
DemandeInfo
IBM Global Services & Software Group
The ‘Mechanisms’
4
«mechanism»
Persitency
DemandeInfo
Dossier
+ info
+ statut
MissionEvaluation
+ id
IBM Global Services & Software Group
The ‘Participants’ class diagram
5
MissionEvaluation
ValiderDemande
UI
1..*
ValiderDemande_Ctrl
1..*
Dossier
IBM Global Services & Software Group
The ‘Main’ sequence diagram
6
IBM Global Services & Software Group
The Data Model structure in XDE (for relational DBs)
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
XDE model
1
UML class diagram
showing all identified
relational elements
IBM Global Services & Software Group
The ‘Main’ class diagram
1
DemandeInfo
- «column» DemandeInfo_ID : INTEGER
+ «primary key» Dem_Constraint1 ( )
0..1
Dossier
-
«column» info : SMALLINT
«column» statut : SMALLINT
«column» Dossier_ID : INTEGER
«column» MissionEvaluation_ID : INTEGER
+ «primary key» Dos_Constraint2 ( )
+ «foreign key» Dos_Constraint5 ( )
+ «index» Dos_Constraint6 ( )
0..*
«Nonidentifying relationship»
MissionEvaluation
- «column» id : SMALLINT
- «column» MissionEvaluation_ID : INTEGER
+ «primary key» Mis_Constraint3 ( )
IBM Global Services & Software Group
The Data Model Structure in XDE (for Hierarchical DBs)
UML package holding all
logical information
UML association
between entities
UML class representing
an information stored in
the ISAM / VSAM file
UML package holding all
physical information
UML component
representing an ISAM /
VSAM file
UML dependency to the
entity stored in the ISAM
/ VSAM file
XDE model
UML class diagram
showing all identified
entities manipulated
through the ISAM / VSAM
files
1
2
UML component diagram
showing all ISAm / VSAM
files
UML class diagram
showing the relationships
between the files and the
entities
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 Class diagram showing all the
entities stored within the files
UML Component diagram
showing all the VSAM/ISAM 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:
TP 430
gestion des concessions
sur le domaine de
l'etat...
centraal bestand met alle
gegevens over de
concessiehouders en hun
concessies
calcul des droits et comptabilité
de ceux-ci
centraal bestand met de
invorderingsrekeningen van de
concessiehouders
ons
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
«File»
filename1
centraal bestand met alle
gegevens over de
concessiehouders en hun
concessies
=
filename1
‘All ISAM files’
UML component diagram
calcul des droits et comptabilité
de ceux-ci
centraal bestand met de
invorderingsrekeningen van de
concessiehouders
«Entity»
Concessie
«Entity»
ConcessieHouder
=
Concessie
ConcessieHouder
UML Classes representing an entities
‘All Entities’
UML class diagram
IBM Global Services & Software Group
Modeling a VSAM/ISAM information system (4/4)

TP 430
gestion des concessions
sur le domaine de
l'etat...
Transformation steps:
 For each identified <<entity>> classes, model a <<reside>> dependency relationship
between the file containing the entity and the entity itself.
centraal bestand met alle
gegevens over de
concessiehouders en hun
concessies
calcul des droits et comptabilité
de ceux-ci
‘Associated Entities’
UML class diagram
 Migrate the notes/documentation to the documentation field of the model (optional)
centraal bestand met de
invorderingsrekeningen van de
concessiehouders
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.