RabbinatixDocs
Sign inGet started

Documentation

Concepts and terms

The words Rabbinatix uses, from systems and contracts to test data, nodes and flows, in plain words. Where a term has its own page in the app, its link takes you there.

The basics

Who and what Rabbinatix is about.

Organization
Where a company or team works together. It owns its members, roles, teams and plan, and holds its projects. Switch between your organizations and Personal from the projects page, or from the menu at the top of the sidebar. See also:ProjectMemberPersonal
Project
One client’s or one product’s work inside an organization: its own systems, flows, logic, tickets, whiteboards and environments. Everyone in the organization can open it, unless it’s kept to the people added to it; someone may have a different role in one project. See also:OrganizationRole in a project
Role in a project
The role someone has in one project, in place of their usual one: higher or lower. The organization’s own settings still follow their usual role, and an owner is an owner everywhere. For example: Viewer in Bolt shop Settings → ProjectSee also:Project
Personal
Your own workspace, just for you: one per account. Like an organization, it holds projects. You can turn it into an organization later, with all its projects. See also:Organization
Trash
Where deleted systems, APIs, flows, logic and whiteboards wait for 30 days, with everything that went with them. Restore brings them back; after 30 days they are deleted for good. TrashSee also:System
Member
A person in an organization. Their role decides what they may see and change. Members and teams
System
One piece of software that you build or depend on: a website, an app, a service, a database or a partner such as a payment provider. A system can offer APIs and use other systems' APIs at the same time. For example: Web App, Auth Service, Stripe SystemsSee also:API (endpoint)
Key
A permanent, readable ID that never changes, for tickets, commits and code changes. Simple view hides them. For example: FLOW-AUTH-LOGIN-001, LOGIC-AUTH-002, TICKET-AUTH-001See also:Simple view
Simple view
A setting that swaps technical words for plain ones and hides keys, for people who don't write code. Turn it on in the account menu at the top right.

APIs and contracts

How systems talk to each other, and whether they still agree.

API (endpoint)
One thing a system can be asked to do, such as "log a user in", with what is sent and what comes back. The app calls each one an endpoint. For example: POST /auth/login API catalogSee also:ProviderConsumer
Provider
The system that offers an API. Its side says "I answer this request with this shape". See also:Consumer
Consumer
A system that calls another system's API. Its side says "I call this and expect this shape back". See also:ProviderContract
Not built yet (planned API)Simple view: Placeholder (its old name)
An API a provider has promised but not deployed yet, still to do or in progress. Consumers can build against it already.
Contract
What one consumer expects from one provider API, set against what that provider really offers. Rabbinatix works out every contract itself and checks that the two sides agree. System mapSee also:Contract statusMismatch
Contract status
Whether the two sides agree. Healthy: they do. Warning: they work, with small issues. Broken: a deployed provider no longer gives the consumer what it needs. Planned: the provider is not deployed yet. Design conflict: a planned provider would break the consumer once deployed. Unresolved: no provider offers what the consumer calls. Unknown: not checked yet.
Mismatch
One thing the two sides of a contract disagree on, such as a missing field or a different type. A breaking mismatch makes the contract Broken.
Connection
All contracts between one consumer system and one provider system together. Each line on the system map is one connection, coloured by its worst contract. System map
API version
The version of an API itself (v1, v2). A consumer of v1 is only matched with the provider's v1.
Environment
A place a system runs. Development and Production always exist; an organization adds its own between them, such as Staging, UAT or QA. Each one can run a different version. Deployments
Changes (unpublished)Simple view: Change set (its old name)
Your changes to systems, APIs, logic, flows and the rest, waiting to be published. Only you see them until they are published to Development, after the approvals Development asks for. With Review before publishing on, the top bar shows them as Unpublished · N changes. Changes
Move request
A request to move releases from one environment to the next, for example from Staging to Production. Where the target environment asks for approval first, it waits for its approvers, unless the person moving it chooses No approval needed: then it is recorded as without approval. Start one with Move to next environment. Once called a promotion. Deployments
Deprecation
Marking an API as retiring, with an optional shutdown date after which it counts as gone. Rabbinatix shows who still depends on it. Deprecations
Public API
One API a system provides, with all its versions, shared with other organizations, which they can subscribe to. The rest of the system stays private. Public APIs
Health check
A system's health address, called while someone has the Connections view open (or with Check now) to tell whether the service is up, degraded or down. This is separate from contract status.
Tenant
One of several copies of a service in one environment, such as one per country, each with its own health check, status, alerts and Down ticket: "Orders (Production · UK)".
Draft modeSimple view: What-if (its old name)
Changing an API as a draft, without changing anything for anyone, to see which contracts and flows it would break first. Publish the drafts when they are right, or share them as a change request.

Flows, logic and test data

What your systems do, step by step, and how to test it before it exists.

Blueprint
The old word for the things Rabbinatix describes without code, so they can be read, tested and turned into code: logic (the steps), test data and expected results. These are their names now. See also:LogicTest dataExpected result
Whiteboard
A drawing of how a journey should go, made with shapes and arrows before anything is built. Nothing in it runs or is tested. Project owners and leads draw it, approvers review it, a project owner publishes it, and developer leads turn it into systems, flows and logic. For example: Customer signs up and pays WhiteboardsSee also:FlowApprover
Space
A place for a team's or a topic's pages, inside a project, with a short key its pages are numbered with. Open to everyone in the project, or limited to some people. For example: Engineering (ENG), Runbooks (RUN) PagesSee also:Page
Page
A written document in a space: an overview, a decision, a runbook, meeting notes. It links live to systems, flows, logic, whiteboards and tickets, and keeps every version. For example: ENG-12 · Retry budget PagesSee also:SpaceDraft (of a page)
Draft (of a page)
Your changes to a page before you publish them. Only you see your draft; Publish makes it the page everyone reads. See also:Page
Sticky note
A short note on the System map, a flow, a logic or a whiteboard, placed anywhere on the canvas. It is Only me (nobody else sees it) or Organization (everyone who can open the canvas sees it). It can be folded down to an icon, for you alone. It is not part of what it sits on: no versions, no review. Not the same as a whiteboard's Note shape, which is part of the drawing. For example: Ask Priya about the retry budget System mapSee also:Whiteboard
Build progressSimple view: Hand-off (its old name)
How far development got with a published whiteboard: each shape is to do, in progress or done, and linked to what was built for it (a system, an API, a flow, logic, a ticket). “Start building” moves the plan into development; “Mark done” finishes it. WhiteboardsSee also:Whiteboard
Key stepSimple view: Milestone (its old name)
A step of logic marked as important. A flow’s business view shows only the key steps, so people who don’t need the details see the journey at a glance. See also:LogicFlow
Approver
Someone asked to approve something: a whiteboard, changes, a move, an AI batch, a team issue marked not valid, or a flow set to Approved or Verified. Approvals never block: an approver shares the call, and going ahead without one is recorded as Without approval. A whiteboard draft is only its creator’s; approvers see it from the moment it is submitted. See also:WhiteboardWithout approval
Without approval
Done where an approval was asked for first, with nobody approving it, by the person’s choice. The object keeps it for good (“Without approval — moved by Mia Lee”), and Activity can show only these. ActivitySee also:Approver
Team capacity
How many of a team are in on a day (4 of 6 in; away part of the day counts as half), or across a range of days in person-days. A day with fewer than half in, or under the team’s own number, is short (!). For example: Web: 18 of 25 person-days (72%) Time away
FlowSimple view: Business flow
A complete business journey with one starting point, across every system it touches. For example: Login, Checkout, Password reset FlowsSee also:Test caseRun
Logic
The steps a system follows when something happens, drawn as nodes joined by connections instead of written as code. It starts at one starting point and ends by answering or returning. It can be an API's logic, an event (a button press or a scheduled job), or a function that other logic calls. LogicSee also:Node (step)Connection (in logic)Reusable logic (function)
Reusable logic (function)
Logic that belongs to no system, so any logic in any system can call it. It runs in the system of whoever calls it. For example: Calculate VAT, Check email format
Node (step)
One box in a logic: one step such as Branch, For Each, Call API or Return. Each node has inputs on its left and outputs on its right. Node referenceSee also:Connection pointCalculation stepCall step
Connection point
A point on a node where a connection attaches: inputs on the left, outputs on the right. Triangle points set the next step, the order in which steps run; the other shapes carry values, one shape per kind (circle for text, square for number, diamond for yes/no). On the start step and Return they are the logic's inputs and what it gives back. Once called pins and sockets. Inputs and return valuesSee also:Connection (in logic)
Connection (in logic)Simple view: Wire (its old name)
An arrow from an output connection point to an input. A connection between triangle points says "do this next"; a connection between value points passes a value along.
Calculation step
A node with no triangle connection points, such as Add or Equals. It only works out a value, whenever a step needs it. Once called a pure node.
Call step
A node that reaches outside the logic: calling another system's API, reading a database, calling an external service or publishing an event. In tests, test data answers these. Once called a boundary node. See also:Test data
Variable
A named value a logic keeps while it runs, set by one step and read by later ones. Variables tab
Custom code
A small JavaScript function you write inside a node, for what no node does. In exported code it becomes a function you provide. Custom code
Test data
A rule "when this is asked, answer with that" for an API, database or outside service. It lets a flow run before every system is built. Once called a Data Blueprint. For example: When the database is asked for user "ana", answer with her record Test dataSee also:Test data and Real logic
Expected result
What a correct result looks like, as a list of checks. A test case passes when the real result passes every check. Once called a Response Blueprint. For example: Status is 200 and body.token is not empty Expected results
Test caseSimple view: Scenario (its old name)
One situation to test a flow with: the input, the test data to use and the expected result. For example: Correct password, Wrong password, Account lockedSee also:FlowRun
Run
One run of a flow, often for a test case, with every step it took and whether it passed. You can replay it step by step. See also:Step (in a run)
Step (in a run)
One entry in a run's record: which step ran, what went in, what came out.
Test data and Real logicSimple view: Simulation and integration, later Mock data (their old names)
Two ways to run a flow. Test data uses your test data and made-up data, so nothing real is touched. Real logic makes each system answer with its own logic, still without calling real APIs.
RequirementSimple view: Business rule
A rule in plain words, linked to the test cases that prove it works. For example: Lock the account after 5 wrong passwords Requirements

Screens

The pages people see in a website or app, and how they run logic.

Screen
One page of a website or app, built from widgets. Its buttons run the system’s logic, so it can be clicked through with test data and turned into code. For example: Login, Order details Screens guideSee also:WidgetLayoutLogic
Widget
One part of a screen: a text box, a button, a list, or a box that holds others. Its values come from the screen, and its actions run when it is clicked or changed. For example: WIDGET-WEB-LOGIN-003See also:Screen
Layout
A frame several screens share, such as a header and a menu. Each screen goes in its slot. See also:Screen
Theme
The colors, font, corner rounding and spacing every screen of a system uses. See also:Screen
Mismatch (screen)
Something on a screen no longer fits what it points at, such as a button that runs logic whose connection points changed. It shows on the screen until it is fixed. See also:ScreenMismatch

Code and text steps

Turning logic into something developers can use.

Generated code
TypeScript, Python, C#, Java, Go, Kotlin, Swift, Dart, PHP, Ruby or Rust made from a logic, which does exactly what the logic does. Each line links back to the node it came from. Code panel
Verify against test cases
Replaying recorded test case runs against the generated code, to prove it behaves like the logic before you download it.
Dependencies
The parts generated code needs you to provide: clients for the APIs, databases and services the logic calls, and your custom code functions.
Text steps
A logic or flow written as short, readable text instead of boxes, so it can be read, pasted into a ticket or given to an AI and turned back into logic. Developers know the format as Flow Pseudocode (FPC). Text steps guide
On the map
Code Rabbinatix knows about: a system, an API, a call or a logic someone (or their AI assistant) added and someone accepted. Code that isn’t on the map yet is listed as such, so the map never claims more than it shows. For example: 18 of 24 APIs on the map A system → ProvidesSee also:Written by an assistantSystem
Written by an assistant
A logic or flow an AI assistant drafted and a person accepted, with who accepted it. The mark stays until someone edits it by hand. The logic list can show only these. For example: Written by an assistant · accepted by Ana LogicSee also:On the mapLogicFlow

The Store

Ready-made flows, logic, system maps and whiteboards.

Package
A ready-made flow, logic, system map or whiteboard someone published to the Store. Adding it copies it into your organization or project, where it is yours to change. Nothing is installed. Store
Flow template
A flow package with roles instead of your systems, so it fits any organization. See also:Role
Role
A slot in a flow template, such as "Auth service", that you fill with one of your systems or a new one when you add it.
Copy inSimple view: Import (its old name)
Adding a customized package to your organization or project in one step, with Customize & copy in. It remembers where it came from and can be undone.

Working together

Tickets and chat about the things above.

Ticket
A piece of work to do, with a key, a type, people and links to the systems, contracts and flows it is about. Board
Auto ticket
A ticket Rabbinatix opens by itself, for example when a contract breaks or a test case starts failing, and closes once it is fixed.
Board
All tickets in columns by status, like sticky notes on a whiteboard. Each column is a status. Board
Mention
Typing @ in a ticket or chat message to point at a system, contract, flow, a single flow step or a teammate. It shows that thing's live status.
Channel
A shared conversation about one topic. Every system and every pair of systems can have its own channel, and Rabbinatix posts there when something breaks. Chat