Rev Cloud Blueprint Documentation

A comprehensive Visual Studio Code extension for automating regression testing across the entire Salesforce Revenue Cloud ecosystem - Pricing, Configurator, Order Decomposition, and Billing.

🚀 Public Beta - Free Access!

Revcloud Blueprint is currently in its Early Adopter Program. For a limited time, all professional features are enabled for free! We invite you to use the tool and provide feedback to help shape its future.

Key Features

  • Zero-Touch Pricing Validation - Automatically verify pricing accuracy across environments with enterprise-grade reliability
  • Smart Test Organization - Group and manage hundreds of pricing scenarios with intuitive hierarchical workflows
  • Lightning-Fast Regression Testing - Catch pricing breaks instantly with Git-integrated snapshot comparisons
  • Seamless Multi-Org Workflows - Switch between Production, UAT, and Dev orgs effortlessly
  • Executive-Ready Reports - Generate stunning HTML reports with expandable details

🚀 Getting Started

📋 Prerequisites

  • VS Code: Version 1.74.0 or higher
  • Salesforce CLI: Latest version (npm install -g @salesforce/cli)
  • Revenue Cloud: Enabled in your Salesforce orgs

⚡ Installation & Setup

Complete setup in under 5 minutes with automated configuration:

Step 1: Install Extension

  • From VS Code: Extensions (Ctrl+Shift+X) → Search "Revcloud Blueprint" → Install
  • From Marketplace: Install Extension →

Step 2: Authenticate Salesforce Orgs

# Production/Source org (where your pricing snapshots come from)
sfdx auth:web:login -a ProductionOrg

# Development/Test org (where you test pricing changes)
sfdx auth:web:login -a DevOrg

# Verify authentication
sfdx org:list

Step 3: Automated Project Setup

  1. Open Your Project: Open your Revenue Cloud project workspace in VS Code
  2. Setup Notification: Extension automatically detects missing configuration
  3. Click "Setup Now": Or use the setup icon (🛠️) in the RevCloud Blueprint sidebar
  4. Configuration Created: Extension automatically creates required configuration files

Step 4: Verify Installation

  • Look for the Rev Cloud Blueprint icon in the VS Code Activity Bar
  • Click the icon to open the dedicated sidebar with your snapshots tree
  • Click the ➕ button to create your first snapshot

🔐 Extension Authentication & Activation

Revcloud Blueprint uses a seamless browser-based authentication flow to manage your account and license tier:

How it Works

  1. Click "Sign In" - Open the extension by clicking the Rev Cloud Blueprint icon in the Activity Bar, then click the User/Account icon (👤), and click "Sign In"
  2. Browser Opens - Your default browser opens automatically to https://blueprint.forceweaver.com/login
  3. Log In or Sign Up -
    • Existing users: Enter your email and password
    • New users: Click "Create Account" to sign up (you'll receive a confirmation email)
  4. Auto-Redirect - After logging in, you're automatically redirected back to VS Code
  5. Done! - Your extension is authenticated and your tier is displayed - no codes, no manual steps

Your License Tier

After signing in, you'll see your current tier in the account view:

  • Free Tier - 2 snapshots, 1 group, basic features
  • Pro Tier - 50 snapshots, 20 groups, advanced features including batch testing, group management, and PDF export
  • Enterprise Tier - Unlimited snapshots and groups, priority support, SSO, and dedicated assistance

Public Beta Note: During the public beta period, all users have access to Pro-level features for free. Your actual tier will be enforced when paid plans are introduced.

Key Features

  • 🌐 Automatic Callback - No device codes or manual copy-paste required
  • 🔒 Secure - Token-based authentication with automatic fallback storage for reliability
  • ⚡ Fast - Complete authentication in under 30 seconds
  • 🎯 Simple - One click to start, automatic completion
  • 💾 Persistent - Stay signed in across VS Code restarts

Troubleshooting

Browser doesn't open?

  • • Manually visit: https://blueprint.forceweaver.com/login
  • • After logging in, you'll be automatically redirected back to VS Code

"Authentication timed out" error?

  • • Click "Retry" to try again
  • • Complete the login within 5 minutes
  • • Check your internet connection

Port conflict errors?

  • • The extension uses a random port between 49152-65535 for the callback
  • • Check firewall settings if issues persist
  • • You can configure the port range in VS Code settings: revCloudBlueprint.auth.localServerPortRange

📋 How to Use

🔐 Before You Start: Sign In to Your Account

To use Revcloud Blueprint, you'll need to sign in to your account. This allows the extension to track your usage, enforce license limits, and sync your settings.

First-Time Setup

  1. Open the Extension

    Click the Rev Cloud Blueprint icon in the VS Code Activity Bar (left sidebar)

  2. Access Account View

    Click the User/Account icon (👤) in the extension's title bar

    You'll see the account page with a "Sign In" button

  3. Sign In

    Click "Sign In"

    Your browser opens automatically to the login page at https://blueprint.forceweaver.com/login

  4. Authenticate
    • Existing users: Enter your email and password, then click "Sign in"
    • New users: Click "Create Account" to register (free tier available)
      • • Fill in your email and password
      • • Check your email for a confirmation link
      • • After confirming, return to the login page and sign in
  5. Automatic Return

    After successful login, you're automatically redirected back to VS Code

    The account view updates to show:

    • ✅ Your current tier (Free, Pro, or Enterprise)
    • ✅ Your account email
    • ✅ "Sign Out" button
    • ✅ "Manage License" button (to upgrade or view billing)

Viewing Your Account Status

Once signed in, you can view your account anytime:

  • • Click the User/Account icon (👤) in the extension title bar
  • • You'll see your tier, feature limits, and account options
  • • Click "Manage License" to visit the dashboard at https://blueprint.forceweaver.com/dashboard

Signing Out

To sign out of your account:

  1. Click the User/Account icon (👤)
  2. Click the "Sign Out" button
  3. Confirm sign out
  4. You'll need to sign in again to use the extension

💡 Tip: You stay signed in across VS Code restarts, so you only need to sign in once!

1. 📁 Organizing with Smart Groups

Creating Your First Group

  1. Locate RevCloud Blueprint: Find the RevCloud Blueprint section in VS Code Explorer
  2. Create Group: Click the ➕ folder icon next to "RevCloud Blueprint"
  3. Name Your Group: Enter a descriptive name (e.g., "Q4 Release Tests", "Bundle Pricing")
  4. Group Created: Your new group appears in the hierarchical tree structure

Managing Groups

  • Rename Group: Right-click group → "Rename" → Enter new name
  • Delete Group: Right-click group → "Delete" (snapshots move to "Uncategorized")
  • View Groups: All groups stored in .revcloud/groups.json

2. 📸 Creating Pricing Snapshots

Method 1: Create in Specific Group

  1. Right-click Group: Choose your target group in the tree view
  2. Select "Create Snapshot": Snapshot will be placed directly in this group

Method 2: Create at Main Level

  1. Click Main ➕: Use the main "Create Pricing Snapshot" button
  2. Auto-placed: Snapshot automatically goes to "Uncategorized" group
  3. Move Later: Drag-and-drop to move to desired group

Snapshot Creation Process

  1. Select Source Org: Choose your source org (Production, UAT, or reference)
  2. Enter Quote ID: 15 or 18 character Salesforce Quote ID
  3. Description: Meaningful test description (e.g., "Enterprise bundle with 20% discount")
  4. Generated: Creates JSON in revcloud_blueprint/pricing/snapshots/

3. ▶️ Running Tests

Individual Tests

  1. Locate your snapshot in any group
  2. Click ▶️ icon next to the snapshot
  3. Choose testing approach:
    • "Use same opportunity" - Best for testing configuration changes
    • "Use different opportunity" - Test across different customer scenarios
  4. Monitor real-time progress
  5. View detailed HTML report

Batch Tests (Groups)

  1. Locate the group you want to test
  2. Click ▶️ next to the group name
  3. All snapshots run automatically with original settings
  4. View comprehensive batch report with pass/fail summary

💡 Pro Tip: Create groups by feature, release, or customer type. Use batch runs to validate entire feature sets, then drill down to individual snapshots for detailed analysis.

⚙️ Configuration

Extension Settings

Access via: Ctrl+Shift+P → "Preferences: Open Settings" → Search "Revcloud Blueprint"

{
  "revCloudBlueprint.pricing.productExternalIdField": "ProductCode",
  "revCloudBlueprint.pricing.attributeDefinitionExternalIdField": "Code",
  "revCloudBlueprint.pricing.attributePicklistValueExternalIdField": "Code",
  "revCloudBlueprint.api.version": "v64.0",
  "revCloudBlueprint.verboseLogging": true,
  "revCloudBlueprint.pricing.snapshotDirectory": "revcloud_blueprint/pricing/snapshots"
}

Core Settings

SettingDefaultDescription
productExternalIdField"ProductCode"External ID field on Product
api.version"v64.0"Salesforce API version
verboseLoggingfalseEnable detailed debug logging

Project-Specific Field Configuration

Configure which custom fields to capture and compare by editing .revcloud/settings.json in your workspace root.

Two Field Types

snapFields (Input Fields)
  • ✓ Captured from your source quote/line items
  • ✓ Written to new quote/line items when running tests
  • ✓ Compared to verify data was correctly applied
  • Use for: Fields that your pricing procedures READ (contract terms, pricing models)
reportFields (Output Fields)
  • ✓ Captured from your source quote/line items
  • ✗ Never written to new quote/line items
  • ✓ Compared to verify calculations
  • Use for: Fields that your pricing procedures CALCULATE (totals, costs, margins)

Example Configuration

{
  "pricing": {
    "snapFields": {
      "quote": {
        "fields": ["ContractTerm__c", "PricingModel__c"]
      },
      "quoteLineItem": {
        "fields": ["ServiceType__c", "PriceMethod__c"]
      }
    },
    "reportFields": {
      "quote": {
        "fields": ["TotalServiceCost__c", "TotalCost__c"]
      },
      "quoteLineItem": {
        "fields": ["SellPrice__c", "BandPrice__c"]
      }
    }
  }
}

⚠️ Known Issues

Configuration Refresh Required

Issue:

When making changes to .revcloud/settings.json to add project-specific fields, the changes are not immediately reflected in snapshot creation or pricing test runs.

Workaround:

After modifying .revcloud/settings.json, refresh VS Code to apply the configuration changes:

  1. Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (Mac)
  2. Type "Developer: Reload Window"
  3. Press Enter
  4. Configuration will now be loaded correctly

💡 Tip: This is a temporary limitation. We're working on hot-reloading configuration changes in a future release.

Ready to Get Started?

Install Rev Cloud Blueprint from the VS Code Marketplace and start automating your Revenue Cloud testing today.