Welcome to FlowZap dear Business Process Maniacs!

How to Write and Edit FlowZap Code (No Tech Skills Needed!)

FlowZap Code Generator screenshot 1FlowZap Code Generator screenshot 2

 

FlowZap is built for real business users—Accountants, Customer Sales Reps, Plant Managers—who want to map out processes quickly, clearly, and without technical jargon. Here’s your step-by-step guide to writing and editing FlowZap Code, the simple language that powers your FlowZap Diagrams.

 

What Is FlowZap Code?

 

FlowZap Code is a straightforward way to describe your workflow visually. You’ll write a few short lines to define steps (nodes), connect them (edges), and organize everything into swimlanes (lanes) that match your real-world teams or roles. Although FlowZap Code is a DSL (Domain Specific Language) designed specifically for describing business process diagrams, it is not a programming language. No programming background is needed.

1. Organize Your Process with Lanes

Think of lanes as rows in your diagram, each representing a team, department, or role. Every lane groups together related steps.

lane1 {
  ...nodes...
  ...edges...
}

lane2 {
  ...nodes...
  ...edges...
}
  • The lane name (like lane1, lane2) is up to you.
  • Use clear names that make sense for your process (like Sales, Accounting).

2. Add Steps with Nodes

Inside each lane, list every step in your process. Each step is called a node.

n1: circle      label:"Start"
n2: rectangle   label:"Enter data"
n3: taskbox     owner:"Alice" description:"Validate input" system:"FormApp"
n4: diamond     label:"Is valid?"

 

How to Write a Node:

 

  • ID: Short code for the step (like n1, n2).
  • Shape: Pick from circle, rectangle, diamond, or taskbox.
  • Attributes:
    • label:"Text" — what appears in the diagram.
    • For taskbox, add: owner:"Name", description:"Details", system:"SystemName".

Mix and match attributes as needed. Order doesn’t matter.

3. Connect Steps with Edges

After your nodes, describe how each step connects to the next.

n1.handle(right)  -> n2.handle(left)   [label="next"]
n2.handle(bottom) -> n3.handle(top)

 

How to Write an Edge:

 

  • From: Start node and which side to connect from (e.g., n1.handle(right)).
  • To: End node and which side to connect to (e.g., n2.handle(left)).
  • Arrow: Always use -> to show direction.
  • Label (optional): Add [label="Text"] for connector text, or leave blank.

4. Connect Across Lanes

If a step jumps from one lane to another, just add the lane name before the node:

n3.handle(bottom) -> lane2.n5.handle(top) [label="Send for Review"]

5. Full Example

Here’s a complete FlowZap Code sample for a two-lane process:

lane1 {
  n1: circle      label:"Start"
  n2: rectangle   label:"Collect Info"
  n3: diamond     label:"Needs Review?"
  n4: circle      label:"End"

  n1.handle(right)  -> n2.handle(left)
  n2.handle(right)  -> n3.handle(left)
  n3.handle(top)    -> n4.handle(left)         [label="No"]
  n3.handle(bottom) -> lane2.n5.handle(top)    [label="Yes"]
}

lane2 {
  n5: rectangle label:"Review Details"
  n6: circle    label:"End Review"

  n5.handle(right) -> n6.handle(left)
}

6. Tips & Best Practices

  • Keep IDs short: Use simple codes like n1, n2.
  • Help from AI : Ask your favourite AI Agent helper to draft a first template of FlowZap Code for you.
  • Auto-Layout checkbox: The Auto-Layout checkbox will take a first stab at organizing your Diagram. You can always tidy it up later.
  • Comments: Add inline comments after the opening brace using #, for example Sales { # internal SLA 48 h. Lines beginning with // are ignored and will not be preserved when you regenerate the code.
  • Labels: You can leave a connector label empty (label="") or leave it out.

  

Just write or paste your FlowZap Code into the editor and click “Update Diagram.” Your process comes to life—no technical skills required!

FlowZap makes process mapping as easy as writing a checklist. If you can describe your workflow, you can diagram it in FlowZap.