GuideAPI

Scenarios (Design, Preview, Test)

Designing dynamic Templates and complex Blueprints involves defining logic that reacts to data. How do you verify this logic works correctly before running a live Workflow? Scenarios are the answer.

A Scenario is a reusable packet of sample Entity data that you can create and save within your SignStack workspace. Think of it as a predefined set of "test inputs" representing a specific real-world situation (e.g., "New Customer - Pro Plan," "High-Value Deal - Enterprise Tier").

Scenarios are a game-changing tool used throughout the design and testing process in SignStack.

The Challenge: Designing & Testing Blind

When you write complex logic, whether it's a valueExpression in a Template or an inclusionCondition in a Blueprint, verifying it requires realistic data. Running full workflows repeatedly just to test different data inputs is slow and inefficient.

The Solution: Instant Feedback with Scenarios

Scenarios integrate directly with both the Template editor and the Blueprint simulator to provide instant feedback.

How it Works (UI Concept):

  1. Create Scenarios: You define Scenarios containing realistic sample data for the Entities your Templates and Blueprints use (like clientInfo, dealInfo). The SignStack UI provides built-in AI assistance to help you generate diverse and comprehensive examples based on your Schemas, making it easy to cover various edge cases.
  2. Select Scenario:
    • In the Template Editor: Choose a Scenario from a dropdown. The document preview instantly re-renders using that data, showing how dynamic fields (valueExpression) and visibility rules (displayCondition) behave.
    • In the Blueprint Simulator: Select a Scenario. The simulator then runs the entire workflow logic using that data, allowing you to interactively step through the process, see which steps are included/skipped, and inspect how the EntityContext evolves via onCompleteMappers.
  3. Iterate Rapidly: Instantly switch between different Scenarios in either editor to see how your designs react to various data conditions in real-time.

Benefits: Design & Test with Confidence

Using Scenarios throughout the lifecycle is powerful:

  • Instant Design Feedback: See the results of template expressions immediately.
  • Interactive Blueprint Simulation: Test workflow logic, conditions, and mappers without running a live workflow.
  • Catch Errors Early: Identify incorrect logic or typos during design time, not in production or staging.
  • Verify All Paths: Easily test different branches of your conditional logic by switching scenarios.
  • Faster Iteration: Quickly refine dynamic content, workflow logic, and data transformations with realistic data, leading to better designs in less time.

Scenarios are a fundamental tool for designing, previewing, simulating, and testing both your Templates and Blueprints, ensuring high confidence before you deploy.