Cabrechart Documentation

Quick Start

Get a live Salesforce dashboard running in under 60 seconds.

1. 1

   Connect your Salesforce org

   Click Sign In and authorize with your Salesforce credentials. Cabrechart uses OAuth 2.0 PKCE — no passwords stored. A 24-hour free trial begins immediately, no credit card required.
2. 2

   Create a dashboard

   From the Dashboards page, click New Dashboard. Give it a name and click Create.
3. 3

   Add a widget

   In the editor, click Add Widget. Search for a Salesforce report by name, pick a chart type, set a title, and click Add.
4. 4

   Resize & arrange

   Drag widgets by their header to reorder. Drag the bottom-right handle to resize. The grid snaps automatically.
5. 5

   Export or share

   Click Export in the toolbar to open Export Studio and download a branded PDF or PowerPoint. Or click Share to generate a live public link.

Requirements

How Authentication Works

Cabrechart uses OAuth 2.0 Authorization Code flow with PKCE (Proof Key for Code Exchange) — the industry standard for secure browser-based app integrations with Salesforce.

Every subsequent request includes the session cookie. Middleware validates the session and injects the user ID as a request header before API routes run. All Salesforce calls use the user's own token — never a shared admin token.

AppExchange Installation

With the managed package, Cabrechart handles all OAuth infrastructure automatically. The Connected App, OAuth scopes, callback URLs, and PKCE configuration are bundled inside the package and deployed to your org at install time.

How installation will work

1. 1

   Find Cabrechart on AppExchange

   Search for Cabrechart Analytics on the Salesforce AppExchange and click Get It Now. You can install into a sandbox first to validate before pushing to production.
2. 2

   Choose installation scope

   Select Install for Admins Only to review first, then expand access via Permission Sets. The package installs the Connected App and all required metadata automatically.
3. 3

   Assign the permission set

   The package includes a Cabrechart Analytics Access permission set. Assign it to any users who should be able to log in. It grants the minimum required access: API Enabled · View Reports in Public Folders · View Dashboards in Public Folders.
4. 4

   Authorize in Cabrechart

   Navigate to cabrechart.com, click Sign In with Salesforce, and authorize the connection. Cabrechart uses OAuth 2.0 PKCE — no passwords are stored, and you authenticate directly on Salesforce's own login page.

What the package configures automatically

Environment Variables

Cabrechart is a fully managed SaaS platform — there are no environment variables for customers to configure. All Salesforce OAuth credentials, encryption keys, and infrastructure secrets are managed by Cabrechart on your behalf.

The table below is provided for reference only, relevant to Cabrechart's own infrastructure team:

Sessions & Tokens

Creating Dashboards

Dashboards are the top-level container for your visualizations. Each dashboard has a name, optional description, and a set of widgets arranged on a 12-column grid.

Adding Widgets

In dashboard edit mode, click Add Widget. The configuration panel opens on the right side of the screen.

Widget configuration fields

Widget Reference

Cabrechart supports 11 widget types across three categories.

Chart widgets

KPI / indicator widgets

Data & layout widgets

Grid Layout

The dashboard canvas is a 12-column responsive grid powered by react-grid-layout. Each widget occupies a rectangular slot defined by { x, y, w, h } where x/w are column units and y/h are row units (1 row ≈ 60px).

• ›Widgets snap to grid cells on drag and resize.
• ›Rows expand downward automatically as widgets are added.
• ›Minimum widget size is 2×2 columns×rows. There is no maximum.
• ›On screens narrower than 768px, widgets reflow into a single-column vertical stack.
• ›The save button persists the current layout to the database.

Filters & Date Ranges

Cabrechart supports two levels of filtering:

Widget-level date filters

Applied to a single widget's data source. Configured in the widget editor. Override the report's built-in date range for that widget only.

Dashboard-level global filters

Configured in the dashboard header bar. Applied to all compatible widgets simultaneously. Viewers can change the dashboard filter without editing the dashboard.

Available presets

Salesforce Reports

The Reports browser (sidebar → Reports) shows all Salesforce reports accessible to the current user. Reports are fetched live from the Analytics REST API.

Running a report

Click Run to execute a report. Results appear inline below the report row in a sortable, searchable, paginated table (100 rows/page). Click CSV to download the full result set.

Inline filters

Click Filter to open the filter panel before running. Filter parameters are sent to the Salesforce Reports API at query time and do not modify the underlying report definition.

Adding a report to a dashboard

Click the + icon on any report row, choose a widget type and target dashboard. The widget is created with the report as its data source, pre-baked filters included.

SOQL Queries

Instead of a Salesforce report, widgets can use a raw SOQL query as their data source. This gives you full control over which fields, objects, and aggregations are returned.

Example queries

-- Pipeline by stage
SELECT StageName, COUNT(Id) Deals, SUM(Amount) TotalValue
FROM Opportunity
WHERE IsClosed = false
  AND CloseDate = THIS_QUARTER
GROUP BY StageName
ORDER BY TotalValue DESC

-- Top 10 accounts by ARR
SELECT Account.Name, SUM(Amount) ARR
FROM Opportunity
WHERE IsWon = true
  AND CloseDate = THIS_FISCAL_YEAR
GROUP BY Account.Name
ORDER BY ARR DESC
LIMIT 10

-- Rep activity last 7 days
SELECT Owner.Name, COUNT(Id) Activities, ActivityDate
FROM Task
WHERE ActivityDate = LAST_N_DAYS:7
GROUP BY Owner.Name, ActivityDate
ORDER BY ActivityDate DESC

The query is executed using the jsforce client with the user's own OAuth token. Row-level security and field-level security are enforced by Salesforce before results are returned.

Importing Salesforce Dashboards

Sidebar → SF Dashboards lists all native Salesforce dashboards accessible to the current user. Each shows the dashboard name, description, folder path, and component count.

• ›Click a dashboard to view its components and metadata.
• ›Click Import to Cabrechart to auto-create a Cabrechart dashboard with the corresponding widgets. Salesforce dashboard component types are mapped to the closest Cabrechart widget type automatically.
• ›Imported dashboards are fully editable — they are not kept in sync with the original Salesforce dashboard.

AI Analyst Overview

The AI Analyst is a conversational interface that gives you natural-language access to your Salesforce data. It uses a Salesforce-aware AI model with structured tool use — instead of generating hallucinated answers, it runs real queries and reasons over real data before responding.

Access it two ways:

• ›Full-page mode — sidebar → AI Analyst. Open-ended research, multi-step analysis.
• ›Dashboard panel mode — click AI icon inside any dashboard. The model has direct access to the widget data on that dashboard.

AI Analyst — Available Tools

The model has access to these read-only Salesforce tools. Tool activations are shown as animated pills in the chat UI while the model is working.

AI Analyst — Credits & Limits

When credits are exhausted, the chat interface shows a Top up $5 now button that redirects to a Stripe checkout. Credits reset at the start of each billing month.

The model receives a maximum of 50 rows per tool call result. PII beyond what is strictly necessary for the analysis is stripped before data leaves the server.

Export Studio

Open Export Studio from any dashboard via the Export toolbar button. The Studio is a full-page interface with a configuration panel on the left and a live cover-page preview on the right.

Workflow

1. 1

   Choose export type

   Toggle between PDF and PowerPoint at the top of the Studio.
2. 2

   Set metadata

   Enter the report title, subtitle/date, and select a logo from your Logo Library (or enter a URL). These appear on the cover page.
3. 3

   Choose a template

   Select a visual template. A mini preview updates as you pick.
4. 4

   Exclude widgets (optional)

   Toggle off any widgets you don't want in the export. Section headers and rich text can also be excluded independently.
5. 5

   Configure page options

   For PDF: choose page size (Letter / A4 / Legal) and orientation. For PPTX: choose slide size (16:9 / 4:3).
6. 6

   Download

   Click Generate PDF or Generate PPTX. The file downloads immediately.

PDF Reference

PDF template guide

PowerPoint Reference

PPTX exports place each widget on its own slide. The first slide is always a branded title slide.

PPTX template guide

Branding & Templates

Set company identity once in Settings. It is automatically applied to every PDF, PPTX, and share-link dashboard.

Logo Library

Upload up to 10 logos (PNG · JPG · SVG · max 300 KB each). When exporting, choose which logo to use from a dropdown. Logos are stored securely and referenced by ID in export requests.

PPTX Template Library

Upload up to 5 branded .pptx files (max 10 MB). Cabrechart extracts theme colors and fonts via the Office Open XML spec. The original file is discarded; only color/font metadata is stored. Mark a template as Active to apply it automatically to all PPTX exports. When a custom template is active, its colors and fonts override the built-in template palette.

Scheduled Reports

Scheduled reports automatically generate a branded PDF and email it to any list of recipients on a recurring schedule. Recipients do not need a Cabrechart account.

Schedule configuration

Plan limits

Schedule states

• ›Active — will run at next scheduled time.
• ›Paused — skips all future runs until manually resumed. Configuration is preserved.
• ›Error — last run failed. The error message is shown on the schedule card. The schedule retries on the next interval.

Share Links

Share links generate a public, read-only URL for a dashboard. Recipients see live Salesforce data with no login required.

• ›Generated from the dashboard toolbar → Share → Generate link.
• ›Each link is a cryptographically random token stored in the database.
• ›Optional expiry date — link returns 410 Gone after expiry.
• ›Revoke at any time by deleting the share record.
• ›Share link pages apply the same branding (logo, colors) as the regular dashboard view.
• ›Widget data is fetched on-demand using a scoped service token — not the user's personal OAuth token.

Plan Comparison

All plans include the 24-hour free trial. Billed monthly. Cancel anytime — access continues through the end of the billing period. Payments processed by Stripe (PCI-compliant).

Rate Limits & Quotas

Security Model

Authentication & authorization

Infrastructure

SOQL injection prevention

The SOQL execution layer enforces an allowlist at the API layer before sending any query to Salesforce:

// Blocked at /api/salesforce/query
const FORBIDDEN = /\b(INSERT|UPDATE|DELETE|UPSERT|MERGE|CREATE|ALTER|DROP|EXEC|EXECUTE)\b/i
if (FORBIDDEN.test(query)) {
  return 400 // Bad Request
}
if (!query.trim().toUpperCase().startsWith('SELECT')) {
  return 400
}

Data & Privacy

What Cabrechart stores

AI data handling

• ›Maximum 50 rows of Salesforce data sent per AI tool call.
• ›PII beyond what is strictly necessary for the analysis is excluded before data leaves the server.
• ›The AI model has no write access to Salesforce — all tool calls are read-only.
• ›AI conversations are not persisted to the database.