Olivier Béghain IT Specialist olivier.beghain @ be.ibm

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

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

3. The UML Models • The Business Use-Case model • The Business Analysis model • The System Use-Case model • The Analysis model • The Data Model

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

5. The Business Use-Case Model in XDE • Note: This model is not valuable for the project

6. The Business Analysis Model in XDE • Note: this model is not valuable for the project

7. The System Use-Case Model structure in XDE UML package all actors identified for the system XDE model UML actor UML package all use-cases identified for the system UML use-case

8. The ‘Global View’ use-case diagram 1 NEED TO BE DOCUMENTED ONCE THE USE-CASE MODEL WILL BE POPULATED WITH ELEMENTS

9. The ‘Local View’ use-case diagram 2 NEED TO BE DOCUMENTED ONCE THE USE-CASE MODEL WILL BE POPULATED WITH ELEMENTS

10. The System Analysis Model structure in XDE (1/2) UML package holding the architectural mechanisms XDE model UML class representing an architectural mechanism 1 UML class diagram showing all identified entities (persistent and transient ones) UML package holding all ‘Boundary’ analysis classes UML package holding all ‘Control’ analysis classes 2 UML class diagram showing only the peristent entities (without their attributes) UML package holding all ‘Entity’ analysis classes 3 UML class diagram showing all entities with their attributes UML class attribute UML dependency relationship from the entity to the ‘Persistency’ mechanism

11. The System Analysis Model structure in XDE (2/2) UML package holding the realizations of all use-cases 4 UML class diagram showing the association between the identified analysis classes and the architectural mechanisms UML package holding the realization of a specific use-case UML collaboration instance used to represent a use-case realization 5 UML class diagram showing all analysis classes identified as participating in the realization of the use-case UML interaction instance used to document a specific scenario 6 UML sequence diagram depicting visually a specific use-case scenario UML messages « exchanged » between the analysis classes

12. The ‘Overview – All Entities’ class diagram 1

13. The ‘Persistent info’ class diagram 2

14. The ‘Responsabilities – All Entities’ class diagram 3

15. The ‘Mechanisms’ 4

16. The ‘Participants’ class diagram 5

17. The ‘Main’ sequence diagram 6

18. The Data Model structure in XDE (for relational DBs) XDE model UML package holding the relational elements shared accross all domains 1 UML class diagram showing all identified relational elements 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

19. The ‘Main’ class diagram 1

20. The Data Model Structure in XDE (for Hierarchical DBs) UML package holding all logical information XDE model 1 UML association between entities UML class diagram showing all identified entities manipulated through the ISAM / VSAM files UML class representing an information stored in the ISAM / VSAM file 2 UML component diagram showing all ISAm / VSAM files UML package holding all physical information 3 UML component representing an ISAM / VSAM file UML class diagram showing the relationships between the files and the entities UML dependency to the entity stored in the ISAM / VSAM file

21. The ‘All entities’ class diagram 1

22. The ‘All files’ component diagram 2

23. The ‘All associated entities’ class diagram 3

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

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

26. Modeling a VSAM/ISAM information system (2/4) • Former representation:

27. Modeling a VSAM/ISAM information system (3/4) • Transformation steps: • 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 = ‘All ISAM files’ UML component diagram = ‘All Entities’ UML class diagram UML Classes representing an entities

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

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