outsystems architecture canvas rules

Mastering OutSystems Architecture: Canvas Rules

By Michael Rodriguez
AD

OutSystems Architecture Canvas is a visual tool designed to help teams understand, document, and communicate the architecture of their applications. It's a key component of the OutSystems low-code development platform, enabling developers to create scalable, maintainable, and high-performing solutions. Let's delve into the rules and best practices that govern the use of OutSystems Architecture Canvas.

Before we dive into the specifics, it's crucial to understand that the Architecture Canvas is not just a static document but a living artifact that evolves with your application. It serves as a shared understanding among team members, stakeholders, and even future maintainers of the system.

Understanding the Canvas Structure

The OutSystems Architecture Canvas is composed of several sections, each serving a unique purpose in capturing the architecture of your application.

AD
the architecture types poster is shown in green and orange colors, with information about each type
the architecture types poster is shown in green and orange colors, with information about each type
an info sheet with different types of operating systems
an info sheet with different types of operating systems
The Operating System Canvas
The Operating System Canvas

Each section is represented by a card on the canvas, and these cards can be arranged, connected, and grouped to reflect the architecture's structure and behavior. The sections include:

  • Application: Represents the top-level application or service.
  • Module: Groups related functionality and business logic.
  • Screen: Represents user interfaces.
  • Entity: Models data structures.
  • Relationship: Defines connections between entities.
  • Action: Encapsulates business logic and operations.
  • Web Service: Represents external services and APIs.
  • Database: Models data storage.

Arranging and Connecting Cards

Cards can be arranged in a hierarchical or flat structure, depending on the complexity and nature of your application. For instance, a large application might have a deep hierarchy, while a simple one might use a flat structure.

Roadmap for system design
Roadmap for system design
a diagram showing the different types of apis and what they are used to describe
a diagram showing the different types of apis and what they are used to describe
an info sheet with different types of objects in it
an info sheet with different types of objects in it

Connections between cards represent dependencies and relationships. For example, an Entity card connected to a Screen card indicates that the screen uses data from that entity. These connections help visualize the flow of data and control through the application.

Using Groups and Folders

Groups and folders help organize the canvas, making it easier to navigate large and complex architectures. They can be used to cluster related functionality, separate concerns, or represent different layers of the architecture.

AD

For instance, you might use folders to separate front-end and back-end components, or groups to cluster functionality related to a specific business domain.

the basic structure of structural structures and how they are used to make them look like it is
the basic structure of structural structures and how they are used to make them look like it is
the six layers of construction, with each section labeled in different colors and numbers on it
the six layers of construction, with each section labeled in different colors and numbers on it
the book cover for what how & why of design systems by andra hock
the book cover for what how & why of design systems by andra hock
Information Architecture Made Simple
Information Architecture Made Simple
a diagram with the words design process written in black and white, on a white background
a diagram with the words design process written in black and white, on a white background
a flow diagram with words on it and some notes about building something in the background
a flow diagram with words on it and some notes about building something in the background

Documenting Architecture Decisions

The Architecture Canvas is not just about visualizing the architecture; it's also about capturing the decisions that led to that architecture. This is crucial for knowledge sharing, onboarding new team members, and maintaining the system over time.

Each card on the canvas has a 'Details' section where you can document architecture decisions, rationales, and any other relevant information. This could include design patterns used, trade-offs considered, or future improvements planned.

AD

Capturing Non-Functional Requirements

The Architecture Canvas also allows you to capture non-functional requirements (NFRs) at the card level. NFRs could include performance targets, security requirements, or usability goals. By capturing these early, you can ensure they're considered throughout the development lifecycle.

an image of some type of architecture
an image of some type of architecture
a man writing on a white board with the words build the system, not the prompt
a man writing on a white board with the words build the system, not the prompt
the system design with concepts interview guide is shown in this graphic above it's description
the system design with concepts interview guide is shown in this graphic above it's description
a diagram showing the different systems that can be used to create an impact map
a diagram showing the different systems that can be used to create an impact map
a triangle diagram with the words design triangle in black and white, on top of it
a triangle diagram with the words design triangle in black and white, on top of it
the wiring diagram for an appliance system, with instructions to install and configur
the wiring diagram for an appliance system, with instructions to install and configur
A567【办公】“ 极境穿越·奔赴山海 ”丨概念 - 小红书
A567【办公】“ 极境穿越·奔赴山海 ”丨概念 - 小红书
展板作品
展板作品
James - In 60 seconds, you'll understand the RAG architectures powering modern AI systems. Most developers think RAG is just: Documents → Embeddings → Vector Database → LLM That's only the beginning. As AI systems become more complex, retrieval architectures evolve to solve different challenges around relevance, reasoning, scale, and multimodal data. Here's the progression every AI builder should know: 1. Naïve RAG : • The foundation • Fast, simple, and great for prototypes 2. Retrieve-and-Rerank RAG : • Improves retrieval quality before generation • Higher relevance, lower noise 3. Multimodal RAG : • Retrieves across text, images, audio, and video • Essential for enterprise knowledge systems 4. Graph RAG : • Uses entity relationships and knowledge graphs • Better for complex rea
James - In 60 seconds, you'll understand the RAG architectures powering modern AI systems. Most developers think RAG is just: Documents → Embeddings → Vector Database → LLM That's only the beginning. As AI systems become more complex, retrieval architectures evolve to solve different challenges around relevance, reasoning, scale, and multimodal data. Here's the progression every AI builder should know: 1. Naïve RAG : • The foundation • Fast, simple, and great for prototypes 2. Retrieve-and-Rerank RAG : • Improves retrieval quality before generation • Higher relevance, lower noise 3. Multimodal RAG : • Retrieves across text, images, audio, and video • Essential for enterprise knowledge systems 4. Graph RAG : • Uses entity relationships and knowledge graphs • Better for complex rea
there are many different red and black images in this room with the same color scheme
there are many different red and black images in this room with the same color scheme
a diagram showing the different types of computer equipment and their functions to operate them in
a diagram showing the different types of computer equipment and their functions to operate them in
the six principals of design info
the six principals of design info
the design workflow diagram is shown in blue ink
the design workflow diagram is shown in blue ink
an architectural diagram showing the various spaces in which people can use their hands to work
an architectural diagram showing the various spaces in which people can use their hands to work

For example, you might set a performance target for a particular screen, or specify that a certain entity should be protected with encryption.

Versioning and Traceability

OutSystems Architecture Canvas supports versioning, allowing you to track changes to the architecture over time. This is crucial for understanding the evolution of the system and ensuring that changes don't introduce regressions.

AD

Moreover, the Architecture Canvas is integrated with other OutSystems tools, providing traceability from architecture to implementation and back. This means you can see how architecture decisions are reflected in the code, and vice versa.

In conclusion, the OutSystems Architecture Canvas is a powerful tool that helps teams create, understand, and communicate the architecture of their applications. By following the rules and best practices outlined here, you can ensure that your Architecture Canvas is a valuable asset that supports your development efforts and drives the success of your projects.

AD