LogoLogo
HomeDocumentation
  • 🐳Using Whaly Guides
  • Core concepts
    • 📚Getting started
      • Data stack architecture
      • Consumers vs Builders
      • Data layers in Whaly
      • License Mapping
    • 🪄Data modeling
      • Understanding data models
      • Designing data models
      • Common modeling patterns
        • Event schema
      • Maintaining data models
      • Data models best practices
    • 🖌️Explorations
      • Understanding Explorations
      • Designing Explorations
      • Maintaining Explorations
      • Mistakes to avoid
  • Training
    • 👁️For viewers
    • 👩‍💻For editors
    • 🧙For builders
      • Setting up the training material
      • Creating a chart
      • Using and editing explorations
      • Filtering a dashboard
      • Creating explorations and models
  • Inspiration
    • 🗒️Use cases
      • Billing / Invoicing
      • Customer success
      • Fundraising
      • Marketing
      • Partnerships
      • Product
      • Sales
      • Strategy
    • 💬Communication
    • 💡Tips
  • Recipes
    • 🤝Customer care
      • How to build a 360° customer dashboard
    • 🏦Finance
      • Modeling your recurring revenue
        • SQL for simplified MRR calculation
        • SQL for advanced MRR calculation
    • 📣Marketing
      • Track your entire Marketing Funnel
      • Calculate your Customer Acquisition Cost
      • Create a partner dashboard
    • 💼Sales
      • Analyze the impact of your Sales velocity on your closing rate
      • Create a sales performance dashboard
      • Build a target oriented sales dashboard
  • Misc
    • 🧐SQL Fanout
    • 📦Backup your data using BigQuery
    • ☁️Embedding reports in Salesforce
    • 👨‍💻Useful SQL operations
      • Flattening categories
Powered by GitBook
On this page
  • Setting up your Salesforce org
  • Adding your app to your home or object page
  • Forwarding context to your report
  • To go further
  1. Misc

Embedding reports in Salesforce

This guide aims at explaining how to embed a report in salesforce on the home page or on a specific object page.

PreviousBackup your data using BigQueryNextUseful SQL operations

Last updated 3 years ago

In order to embed Whaly reports in Salesforce, you need to:

  • Be an developer on your Salesforce org

  • Have at least a report created in your Whaly instance

Setting up your Salesforce org

First of all you need to create the necessary component in your salesforce org to embed Whaly. In order to speed up the process we have created a git repository with all the code required to embed Whaly.

Adding your app to your home or object page

In order to add your newly created app to your home page or record page, you should navigate to the page you wish to embed your report on and click on settings and edit page as shown below.

Once you are on the edition menu you can drag and drop the WhalyEmbed app and enter your credentials as show below.

Forwarding context to your report

By default the app that we created on salesforce pass three filters

  • userId: Contains the connected user ID from Salesforce

  • userEmail: Contains the connected user email from Salesforce

  • recordId: When displaying your report on a record page you will get the current recordId otherwise you should expect it to be null

Therefore on Whaly side you can set up filters with a api name to either userId, userEmail, or objectId to take advantage of those prebuilt features.

To go further

You can read our documentation on how our embedding mechanism works there:

Learn how to deploy a lightning app

☁️
https://developer.salesforce.com/docs/atlas.en-us.236.0.apexcode.meta/apexcode/apex_debug_test_deploy.htm
GitHub - whalyapp/salesforce-embed: This repository help you understand how to embed Whaly reports in a salesforce lightning component that can be exposed on any objects.GitHub
Embed a reportDocumentation
Logo
Logo
Embeding Whaly
Page builder