Team Review and Collaboration

Goal: Walk through the full collaborative review loop — draft → comments → resolve → publish — using an organization model and role-based access.

Prerequisites

An organization in OWB with at least one other member invited (any role)
An existing model in the organization's workspace
The model should be in Draft state (not yet published for the current round of changes)

Steps

1. Set up the organization and invite a collaborator

If you don't have an org yet: click the workspace switcher in the top-left header and choose Create organization. Give it a name.

From the workspace switcher, open Organization settings → Members → Invite. Enter your collaborator's email and assign the Member role.

They'll receive an invite email. Once accepted, they can access all models in the org.

Tip: Use the Commenter role if your reviewer should be able to leave feedback but not edit the schema.

2. Make draft changes to the model

Open the model you want to review. Edit freely — add or rename entity types, adjust properties, change relationship cardinality. All changes are saved as drafts immediately.

The toolbar shows the Draft badge, indicating unpublished changes exist.

3. The collaborator reviews and comments

Your collaborator opens the same model from their dashboard.

To leave a comment on a specific entity type: select it in the sidebar or canvas, then open the Comments tab in the right panel. Click Add comment and type the feedback.

They can comment on relationships the same way — select the relationship, switch to Comments, and post.

Comments are threaded, so they can reply to their own notes as they review multiple areas.

4. Author replies and resolves comments as changes land

You (the author) see the comments in the panel when you select the annotated entity type or relationship.

Click Reply to respond in-thread. When a discussion is settled and the change is made, click Resolve to collapse the thread. Resolved threads are retained for the record — click Show resolved to review them at any time.

Work through all open threads until none remain unresolved.

5. Take a snapshot labeled with the review milestone

Once all comments are resolved and the model reflects the agreed changes, click Version History (clock icon) in the toolbar.

Click + New snapshot and give it a meaningful label like Post-review v2 — team sign-off. Click Save.

This creates a permanent restore point for this state, independent of the eventual publish.

6. Publish the model

Click Publish in the toolbar. The current draft becomes the new published version.

The toolbar badge changes to Published. The share link and REST API now serve this updated snapshot.

7. Collaborator verifies the published state

Your collaborator opens the share link (you can share it from the Share dialog in the toolbar) or navigates to the model on their dashboard.

They see the published canvas — the entity types, relationships, and properties exactly as they were when you clicked Publish. They can confirm the review changes landed correctly without needing edit access.

What happens next

Invite a stakeholder commenter — add a commenter-role reviewer who can annotate without touching the schema. See Teams & Roles for role details.
Run another review cycle — make more edits in draft and repeat from Step 2. Each cycle builds on top of the previous published state.
Export the reviewed model — now that the schema is signed off, use the Multi-Stack Export workflow to generate target-format code.

Teams & Roles — role capabilities, invitations, org settings
Comments — threading, resolving, role permissions
Snapshots — point-in-time saves and restores
Sharing — read-only share links