Playbook and Library Overview

Updated

Playbooks are OnRamp's templates for projects. This short video explains the relationship between Playbooks, the Library, Modules, and Tasks β€” and how they all work together to keep your workflows reusable and your existing projects untouched when you make updates.

What You'll Learn

This video explains the key distinction between Playbooks and Projects, how Modules and Tasks in the Library work as reusable standalone components, and the important rule that governs what happens when you edit anything in the Library.

Chapter Breakdown

πŸ“˜ Playbooks vs. Projects

A Playbook is a template. A Project is what gets created from that template and sent to a customer. You can create a project from the same Playbook multiple times β€” once for each customer that needs that workflow. Crucially, the Playbook stays in your Library after a project is created from it. You can continue editing the Playbook at any time without affecting the projects that are already live.

πŸ“š The Library β€” Where Playbooks, Modules, and Tasks Live

Your Library is the central repository for everything reusable in OnRamp. It contains three types of items:

  • Playbooks β€” full workflow templates you create projects from

  • Modules β€” reusable groups of related tasks, separate from any specific Playbook

  • Tasks β€” individual reusable task components, also separate from any specific Playbook

Modules and Tasks in the Library are independent from Playbooks and Projects. They can be added to an existing Playbook or dropped into an active Project at any time.

πŸ”„ The Golden Rule: Edits Only Affect Existing Projects With Your Approval

This is the most important thing to understand about how the Library works: when you publish changes to a playbook or a Library module, new projects use the published version. Publishing a Library module also updates the playbooks that link it. Unless someone chooses to update them, existing projects stay as they are.

Updating active projects is available when it's turned on for your organization. If you don't see it, contact your OnRamp team. When it's on, Super Admins and Creators choose what happens to active projects as they publish:

  • Update N projects now pushes the changes into the active projects. Tasks that are started or done aren't touched. Customers may see new or changed tasks in their portal. You can undo the update from the playbook's or module's Activity for 14 days.

  • Only use version N for new projects (for a module, Only use the published module for new projects) leaves active projects as they are.

When it's not turned on, only new projects get your changes. Either way, you can improve and iterate on your playbooks without changing projects that are already underway unless you choose to.


πŸ“Ί Continue learning: Visit the OnRamp Tutorials YouTube Playlist for the full collection of video walkthroughs.

More in Playbooks & Templates