Templates | QualiWare Center of Excellence

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:

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.

State Event Diagram

Purpose: The purpose of the State Event Diagram template is to document the time dependent behavior of a system by showing the different States and State Transitions a system can go through.

Core concerns: The State Event Diagram enables you to model States and connect them with State Transitions. The State can be manipulated by opening its properties dialog and chose ‘Final State’ to illustrate the end of the state. The Start event is created by choosing ‘Start’ in the properties of the State Transition.

Below, you can see an example of a State Event Diagram for an ordering system:

Relation to other templates: The State Event Diagram template should not be used to model Machines States. The State Machine Diagram template should be used to model these types of diagrams instead. The State Event Diagram offers a view of a system which is complimentary to those presented by for example, Use Case Diagrams Communication Diagrams, Component diagrams and Sequence Diagrams.

Properties and metadata: The State Event 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
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 Event Diagram template, where you can view and edit the diagram’s properties in QualiWare Lifecycle Manager.

Stakeholder Model

Purpose: The purpose of the Stakeholder Model template is to document internal and external individuals or groups who have a stake in for example an enterprise or a project. Below, you can see an example of a Stakeholder Model of Order Management:

Core concerns: Stakeholders can be grouped via Business Scope. Stakeholder relations are illustrated via the Interaction connection. Beyond this, you can enrich the Stakeholder Model with Capabilities, Business Processes, Information Systems, Initiatives, and Projects. Below, you can see several groupings of stakeholders:

Relation to other diagrams: The Interaction connections in the Stakeholder Model can be broken down into Requirement Models. The internal structure of the organization is modelled in an Organization Diagram while the interaction between the organization and its external environment can be modelled in a Business Ecosystem.

Properties and metadata: The Stakeholder Model 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 Stakeholder Model’s properties dialogue window, where the properties can be viewed and edited:

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:

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:

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:

Rule Family Table

Purpose: The Rule Family Table template is used as an auxiliary template to document Rule Family symbols from Decision Models in more detail.

Core concerns: The Rule Family Table template should be used to model Rule Family symbols in more detail, describing the decision in more detail and listing each eventuality relevant to the Rule Family. Each row represents a possible combination of rules in the Rule Family. For example, in the eventuality that there are 3 rules with 2 possibilities each, there will be 2^3=8 rows in the Rule Family Table. Below are two examples of Rule Family Tables:

Relation to other templates: The Rule Family template is used to detail Decision Models and should not be used to document decisions in a stand-alone context. It should always be used as an extension to Rule Family symbols.

Properties and metadata: The Rule Family Table 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 Rule Family Table’s properties dialogue window, where the properties can be viewed and edited:

Requirement Model

Purpose: The purpose of the Requirement Model template is to document goals, objectives and other requirements for the enterprise or a specific project. Below, you can see an example of a Requirement Model showing the Policies and Business Rules of an organization:

Core concerns: With the Requirement Model template, you can for example model Requirements, Goals, Change Requests, Policies, Business Rules, Critical Success Factors and Problems. This enables you to illustrate the interrelationships of requirements, for example showing which goals influence or contribute to each other, as the example below shows:

You can also divide goals up in different areas that may for example be subject to different regulations as below:

Relation to other templates: The Requirement Model offers a more detailed view on Requirements and Goals filtering out elements such as vision and mission compared to the Strategy Model. It can be used to detail how your organization live up to requirements specified in a Regulation Diagram or Requirements indicated in a Stakeholder Model.

Properties and metadata: The Requirement Model 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 Requirement Model’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.

Repository Desktop

Purpose: The primary purpose of The Repository Desktop template is to design toolbars in QLM.

Core concerns: The Repository Desktop enables you to use Button Panels and Icons to design additional toolbars that can be added to the desired diagram template types in the actions tab in QLM. The toolbars can, when assigned to a template type, be used to analyze the data shown in diagrams.

Below, you can see some examples of different toolbars:

The repository has several toolbars available when installed that you, through the repository template can assign to the desired template types.

Other functionalities: The Repository Desktop template can also be used as an overview page that links out to other diagrams relevant for certain stakeholders. Below, you can see an example of a strategy desktop where each icon links to the model illustrated:

Relation to other templates: The Repository Desktop is, like the Matrix template, an auxiliary diagram. As such it is not directly connected to other templates but can be used to enable certain analytical functions in all types of diagrams.

Properties and metadata: The Repository Desktop template can, for example, retain the following information:

A description of the template
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 Repository Desktop template where you can view and edit the diagram’s properties in QualiWare Lifecycle Manager.

Regulation Diagram

Purpose: The purpose of the Regulation Diagram template is to document those regulations the enterprise is subject to in detail, so it can be identified how the enterprise must adhere to them. Regulation diagrams is often used to document compliance by use of compliance matrices.

Core concerns: The Regulation Diagram template can model Regulations, Licenses, Business Scopes, Activities, Business Objects and their Connections. With this pallet of objects, you can model an overview of the regulations your organization must adhere to and break them down to more detailed diagrams describing their paragraphs. We recommend you keep it simple and link the regulations to the relevant Business Processes rather than modelling them in a complex diagram. Below, you can see two example of how you could model a Regulation Diagram for the ISO 9001:2008 standard:

Relation to other templates: As mentioned, the regulations can be linked to the relevant Business Processes or Activities, that typically are detailed in a Workflow Diagram or Business Process Diagram. The Regulation could then be shown as a link below the relevant Business Process or Activity:

How the enterprise will live up to the requirements from the different regulations can also be modelled in a Requirement Model.

Properties and metadata: The Regulation 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 Regulation Diagram’s properties dialogue window, where the properties can be viewed and edited:

Product Variant Master

Purpose: The purpose of the Product Variant Master template is to provide an overall view of a product’s variants and can be modelled from the viewpoints of the Customer, Engineer, Part, or Production.

Core concerns: The Product Variant Master template enables you to model product variants by mapping their parts and part variants. The template includes the following objects: Product, Product Rule, Product Attribute, External Document and General Concept. These objects can then be connected as being Part of Product, Kind of Product, or by a “View Connection”.

The abstraction level that defines whether the model is from the viewpoint of the Customer, Engineer, Part or Production is chosen in the model’s property window.

The model below is a Product Variant Master of a balcony:

Relation to other templates: The Product Variant Master is a decomposition of a Product. As such it is related to the Product Canvas and Product Architecture. It can contain a Product Rule Table and could also be linked to from a Product Roadmap.

Properties and metadata: The Product Variant Master can for example retain the following information:

A description of the model
Choice of the Kind of Notations Graphics
Choice of Abstraction Level
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 Product Variant Master where you can view and edit the diagram’s properties in QualiWare Lifecycle Manager.

For more information: You can learn more about the Product Variant Master model by reading the following article (page 1-7):

Mortensen, Niels Henrik; Hvam, Lars; Haug, Anders: Modelling Product Families for Product Configuration Systems with Product Variant Master. (p. 1-7) In: Wotawa, Franz & Pill, Ingo. (2010). On Classification and Modeling Issues in Distributed Model-based Diagnosis.