Dialog Layout

Purpose: The purpose of the Dialog Layout template is to provide a representation of a dialog design for the system developed in the Dialog Model.

Core concerns: The Dialog Layout template enables you to model Windows, Fields, Menu Layouts and General Concepts.

Relation to other templates: The Dialog Layout is a QualiWare system template and is related to the Dialog Model, Menu Layout, Report Layout and Help Model.

Properties and metadata: The Dialog Layout template ­­­­can for example retain the following information:

  • A description of the diagram
  • A link to Epilog and Prolog
  • Audits (auto generated information regarding its current state and access rights)
  • Associated documents, diagrams and other objects
  • Inherent Risk detailing risk considerations
  • Governance information detailing information about the published model and who has been involved in the approval of the layout

The above picture shows the properties dialogue window for the Dialog Layout template where you can view and edit the model’s properties in QualiWare Lifecycle Manager.

Dialog Model

Purpose: The purpose of the Dialog Model is to enable the creation of customized applications for your QualiWare solution that, for example, can generate codes for the Data Model Diagram.

Core concerns: The Dialog Model template enables you to model Dialog Layout, Menu Layout, Report Layout, Help Model and Application Specifiers. These elements can be associated through Connections.

Relation to other templates: The Dialog Model is a QualiWare system template and is related to the Dialog Layout, Menu Layout, Report Layout and Help Model.

Properties and metadata: The Dialog Model template ­­­­can for example retain the following information:

  • A description of the diagram
  • Audits (auto generated information regarding its current state and access rights)
  • Associated documents, diagrams and other objects
  • Inherent Risk detailing risk considerations
  • Governance information detailing information about the published model and who has been involved in the approval of it.

The above picture shows the properties dialogue window for the Dialog Model template where you can view and edit the template’s properties in QualiWare Lifecycle Manager.

Help Model

Purpose: The purpose of the Help Model is to provide the structure of a help system for the system developed in the Dialog Model.

Core concerns: The Help Model template enables you to model Help Items and attach them to each other using connections.

Relation to other templates: The Help Model is a QualiWare system template and is related to the Dialog Model, Dialog Layout, Menu Layout and Report Layout.

Properties and metadata: The Help Model template ­­­­can for example retain the following information:

  • A description of the diagram
  • Audits (auto generated information regarding its current state and access rights)
  • Associated documents, diagrams and other objects
  • Inherent Risk detailing risk considerations
  • Governance information detailing information about the published model and who has been involved in the approval of it.

The above picture shows the properties dialogue window for the Help Model template, where you can view and edit the model’s properties in QualiWare Lifecycle Manager.

Menu Layout

Purpose: The Purpose of the Menu Layout template is to provide the menu structure for the system developed in the Dialog Model.

Core concerns: The Menu Layout template enables you to model Menu Items which can be connected by containing each other – as is the case with the HTML Mega Menu template.

Relation to other templates: The Menu Layout is a QualiWare system template and is related to the Dialog Model, Dialog Layout, Report Layout and Help Model.

Properties and metadata: The Menu Layout template ­­­­can for example retain the following information:

  • A description of the diagram
  • Audits (auto generated information regarding its current state and access rights)
  • Associated documents, diagrams and other objects
  • Inherent Risk detailing risk considerations
  • Governance information detailing information about the published diagram and who has been involved in the approval of the Menu Layout

The above picture shows the properties dialogue window for the Menu Layout template, where you can view and edit the template’s properties in QualiWare Lifecycle Manager.

Use Case Diagram

Purpose: The purpose of the Use Case Diagram template is to document user interactions in a system context, as well as the context between different cases of user interactions. Below, you can see an example of a Use Case Diagram for the service at a restaurant:

UseCaseDiagram_2

Core concerns: The available objects you have to model use cases include: System Boundary, Actors, Use Cases, and connectors such as Association, Generalization, Include and Extend. Below, you can see an example of a Use Case Diagram for a booking system at a car rental service:

UseCaseDiagram_1

Relation to other diagrams: It is important to break down use cases into other diagrams such as Sequence Diagrams, Communication Diagrams, and Activity Diagrams templates for elaboration.

Properties and metadata: The Use Case Diagram can for example retain the following information:

  • A description of the diagram
  • Link to the owner of the diagram
  • Link to the one responsible for the accuracy of the diagram
  • Audits (auto generated information regarding its current state and access rights)
  • Associated documents, diagrams and other objects
  • Inherent Risk detailing risk considerations
  • Governance information detailing information about the published diagram and who has been involved in the approval of the diagram
  • Project status: information about budgeted and actual man-hours spent, percentage completed and the latest milestone, result and quality control of a change process.

In the picture below you can see the Use Case Diagram’s properties dialogue window, where the properties can be viewed and edited:

State Machine Diagram

Purpose: The purpose of the State Machine Diagram template is to document the dynamic behavior of a class or an object.

Core concerns: The State Machine Diagram template enables you to model States, Pseudo States, History States, Lines and Annotations. These can be connected by Transitions.

As such, the State Machine Diagram can be used to show the different states of a class or an object and how the class or object responds to various events by changing from one state to another.

Below, you can see an example of a State Machine Diagram for an ATM:

StateMachineDiagram_1

Relation to other templates: The State Machine Diagram can be a decomposition of a State and can also be derived from a Class. The State Machine Diagram template is related to, but cannot replace the State Event Diagram, which is used to document Event States and time dependent behavior of systems.

Properties and metadata: The State Machine Diagram can for example retain the following information:

  • A description of the diagram
  • Link to the owner of the diagram
  • Link to the one responsible for the diagram
  • Link to a specific State of an object the diagram specializes
  • Audits (auto generated information regarding its current state and access rights)
  • Associated documents, diagrams and other objects
  • Inherent Risk detailing risk considerations
  • Governance information detailing information about the published diagram and who has been involved in the approval of the diagram

The above picture shows the properties dialogue window for the State Machine Diagram where you can view and edit the diagram’s properties in QualiWare Lifecycle Manager.

 

 

 

Sequence Diagram

Purpose: The purpose of the Sequence Diagram template is to document interactions between processes over time. Below you can see a Sequence Diagram for a car rental’s booking system:

SquenceDiagram_1

Core concerns: Sequence Diagrams are typically used to document object interactions over time in a use case for an Information System. Objects are situated along vertical Lifelines. Horizontal arrows that travel between the lifelines in a set sequence are used to illustrate how message exchanges occur at a specific point in time. The objects available in this model are Lifelines, Combined Fragments, Interaction Use, Gates, Time Constraints and Duration Constraints and Messages. Below, you can see an alternate example of a Sequence Diagram for a car rental’s booking system:

SquenceDiagram_2

Relation to other templates: Though the customer can be included in this type of diagram, you should use the Customer Journey Map to document and analyze the customers’ interactions with your organization. If you want to map a simpler view of actors’ interactions with a system without details on time constraints, you can use a Use Case Diagram.

Properties and metadata: The Sequence Diagram can for example retain the following information:

  • A description of the diagram
  • Link to the owner of the diagram
  • Link to the one responsible for the accuracy of the diagram
  • Audits (auto generated information regarding its current state and access rights)
  • Associated documents, diagrams and other objects
  • Inherent Risk detailing risk considerations
  • Governance information detailing information about the published diagram and who has been involved in the approval of the diagram
  • Project status: information about budgeted and actual man-hours spent, percentage completed and the latest milestone, result and quality control of a change process.

In the picture below you can see the Sequence Diagram’s properties dialogue window, where the properties can be viewed and edited:

Report Layout

Purpose: The purpose of the Report Layout is to provide the layout of a report for the system developed in the Dialog Model.

Core concerns: The Report Layout template enables you to model Report Pages and Report Fields which can be related by connections.

Relation to other templates: The Report Layout is a QualiWare system template and is related to the Dialog Model, Dialog Layout, Menu Layout and Help Model.

Properties and metadata: The Report Layout template ­­­­can for example retain the following information:

  • A description of the diagram
  • Audits (auto generated information regarding its current state and access rights)
  • Associated documents, diagrams and other objects
  • Inherent Risk detailing risk considerations
  • Governance information detailing information about the published diagram and who has been involved in the approval of the Report Layout template

The above picture shows the properties dialogue window for the Report Layout template where you can view and edit its properties in QualiWare Lifecycle Manager.

Object Diagram

Purpose: The purpose of the Object Diagram is to document an instance of a class diagram accounting for objects and attributes at a specific point in time. An object diagram may be considered a special case of a Class Diagram.

Core concerns: The Object Diagram enables you to model Packages, Classes, Interfaces, Data Types, Enumerations, Primitive Types, Instance Specifications and Annotations. These elements can then be connected by Associations, Generalizations, Dependencies, Interface Realizations and Usage.

The Object Diagram template should be used to document specific objects of interest in a predefined scenario. This makes Object Diagrams especially useful for documenting examples or test cases for Class Diagrams.

Below, you can see an example of an Object Diagram for a Car Rental Agreement, where specific requirements for the car must be met:

Relation to other templates: The Object Diagram is part of the UML templates QualiWare supports along with the Activity Diagram, Communication Diagram, Deployment Diagram, Class Diagram, Composite Structure Diagram, State Diagram, Package Diagram, Component Diagram, Sequence Diagram, Use case diagram, Timing Diagram, Composite structure Diagram

Properties and metadata: The Object Diagram template ­­­­can for example retain the following information:

  • A description of the diagram
  • Link to the owner of the diagram
  • Link to the one responsible for the diagram
  • Extensions (Stereotypes, Constraints, Tagged values)
  • Audits (auto generated information regarding its current state and access rights)
  • Associated documents, diagrams and other objects
  • Inherent Risk detailing risk considerations
  • Governance information detailing information about the published diagram and who has been involved in the approval of the diagram

The above picture shows the properties dialogue window for the Object Diagram template, where you can view and edit the diagram’s properties in QualiWare Lifecycle Manager.

For more information: about the UML, please visit the Object Management Group’s Website, where you can find the complete specification. The Object Diagram is described in version 1.4.

Integration View

Purpose: The purpose of the Integration View template is to document the routing of integrations between systems.

Core concerns: The Integration View template enables you to model Information Systems, System Components and External Entities (a source to or a receiver of information from a system), and connect them using Integration Flows.

Below is an example of an Integration View concerning the flow of test data:

Relation to other templates: The Integration View belongs to the Application layer of the architecture and is as such related to the Application Architecture Diagram, the Data Flow Diagram and the Component Diagram.

Properties and metadata: The Integration View template can for example retain the following information:

  • A description of the model
  • Audits (auto generated information regarding its current state and access rights)
  • Associated documents, diagrams and other objects
  • Inherent Risk detailing risk considerations
  • Governance information detailing information about the published diagram and who has been involved in the approval of the diagram

The above picture shows the properties dialogue window for the Integration View template where you can view and edit the diagram’s properties in QualiWare Lifecycle Manager.