Introduction to blueprinting

A blueprint is a shared canvas of connected blocks that does one job: a page, an API, a set of functions or a scheduled event. Several people can edit the same canvas at once, and every change is logged.

A blueprint is a canvas for one component

On the canvas you arrange blocks into flows. A blueprint usually covers a single component: a page, a modal, an API, or a set of public functions, much like one class in one file. It can also hold scheduled events that call functions from other blueprints.

Blueprints are built for working together:

  • Live collaboration. Several people can work on the same blueprint at the same time.
  • Clarity on the canvas. Add comments, group blocks under a custom title, and copy blocks between blueprints.
  • An automatic audit log. Every blueprint change and block interaction is recorded, like git commits but in real time.

A new blueprint starts with a name and a type

  1. Name it

    Fill in the name, and optionally a namespace. Press Next step.

  2. Pick a type

    The dialog asks what type of blueprint you would like. Your choice places the starting block on the canvas, so you do not wire everything from scratch.

  3. Keep building

    The type only seeds the canvas. You can add, remove and combine blocks of any kind afterwards.

Type Starting block Pick it when
Build a Web Pageweb_pageServer-rendered pages, public or internal
Build a Functiontrigger_custom_functionReusable logic shared between blueprints
Build an API endpointon_startup_register_uri_getREST endpoints for apps or integrations
Build an API Formon_startup_register_uri_postAPI-driven forms, internal or public
Database eventstorage_eventReactions to documents being created or updated (sync, notifications)
Time based eventschedule_repeating_eventSchedules: digests, polling, cleanup
Build a UI Pagestate_pageMaintaining a state page. Deprecated for new pages.
Build a UI Modalstate_flow_modalDialogs on a state page. Deprecated for new pages.
Build a UI Component Pageuicomponent_pageMaintaining a UI component page. Only listed on clusters that still allow UI components.
Building a new page? Use a web page Pick Build a Web Page. Build a UI Page seeds a state page, and state pages are deprecated, so it is there for apps that have not moved yet. Your First Page takes it from there, and shows what to do when your Studio does not list the option yet.
blueprint type select
The type dialog before Build a Web Page was added: a newer Studio lists it first
The type dialog before Build a Web Page was added: a newer Studio lists it first

Not sure which architecture fits? See Choosing Your Approach.

Blocks connect through pins

  • flow pins decide what runs after what.
  • value, object and array pins pass data.
  • Special pins (storage, httpconnection, state) carry their resource.

Drag from an out-pin to a matching in-pin. Or drag onto empty canvas and pick from the search results: the new block appears with the connection already made.

Every pin type and its colours is documented in Core Concepts. The connection shortcuts (smart pins, distant connections, auto-created blocks) are in Tips & Tricks.

Zoom with the scroll wheel or a pinch

  • The mouse scroll wheel zooms in and out of the current location.
  • On a trackpad, such as on a MacBook Pro, pinch to zoom.

Right-click the canvas for the context menu

In RUAL Studio, a right-click inside a blueprint opens this menu:

OptionWhat it does
Add new blockCreates any block at this location, whatever the pin type. Type the name of the block you need.
Add functionAdds a new, blank function block. Functions are private by default.
User guidGenerates a unique identifier (GUID) for the current user, to use elsewhere in the blueprint.
Go to centerCenters your view on the blueprint. You may need to zoom out if the view is still zoomed in.
Add markerPlaces a marker at your position, useful when collaborating in the same blueprint. A sound plays when you add one.
Add warningAdds a warning sign to prevent unintended changes when collaborating.
Add commentAdds a comment at your position. Type directly into the new block.
ReloadRefreshes the blueprint view. Resolves display issues that browser behaviour such as auto-input focus sometimes causes.
context menu
Blueprint Context Menu
Blueprint Context Menu

The top bar finds, tags and activates

  • Explorer: finds the different types of blocks in your blueprint. For instance, it groups all API blocks for easy navigation.
  • Tags: manages tags, so a blueprint's purpose is clear from the overview.
  • Copy Link: copies a link to this blueprint, and to the selected block if there is one.
  • Canvas and Code: the same blueprint as blocks, or as Blueprint Language source.
  • Feedback: share suggestions or report issues about the blueprint with the team.
  • Activate: when visible, activates the APIs, modals and pages in the blueprint. They stay inactive until you do.
  • Deactivate: when visible, deactivates them. It asks for confirmation and is audit-logged.
blueprint top options
Blueprint Topbar Right-side options
Blueprint Topbar Right-side options

The bottom bar holds your unsaved changes

Its buttons become active as you make changes. They act on your own edits, not on those of the people working next to you.

ButtonWhat it does
undoSteps back through your unsaved edits one change at a time.
redoRe-applies a change you just undid.
consoleOpens the console for the current blueprint.
changesShows how many unsaved changes are open. Expand it to review the blocks and their changes one by one.
ResetDiscards your unsaved changes and goes back to the most recent saved state. It asks you to confirm first.
SaveSaves your changes. Cmd/Ctrl + S does the same.

Saving makes undo unavailable, refreshes the precompiled blueprint on every node, and makes the change live on any page, API or event in an active blueprint. See Staging and saving.

bottom bar changes
Blueprint unified Bottom Bar
Blueprint unified Bottom Bar

Next steps

Web Pages Build a website in a blueprint: a template rendered on the server, and actions that update only what changed. Tips and tricks Every canvas shortcut: connecting, selecting, saving, simulating and searching. Block Execution The order blocks run in, and how they report a failure.

Frequently asked

What are the blueprint types in RUAL?

When you create a blueprint, RUAL asks what type you would like: Build a UI Page, Build a UI Modal, Build a Function, Build an API endpoint, Build an API Form, Database event or Time based event. Each type pre-arranges the canvas with the right starting blocks for that job, and the canvas stays free-form afterwards.

Can multiple people work on the same RUAL blueprint?

Yes. Blueprinting supports real-time collaboration on a shared canvas, with comments, titled groups, markers and warnings to coordinate, and every modification is recorded in the audit log automatically.

How do I undo a change in a RUAL blueprint?

The bottom bar gathers your unsaved changes: undo steps back one edit at a time, the changes counter expands into a per-block review, and Reset discards all unsaved modifications back to the most recent saved state, including changes made by collaborators.