Skip to content

How to

Use Sf Inspector with a connected app


For Chrome and Edge users

If you enabled "API client whitelisting" (a.k.a "API Access Control") in your org, SF Inspector may not work anymore.

To secure the extension usage, you can use a OAuth 2.0 flow to get an access token, linked to a connected app installed in your org.

  1. Open the extension and scroll down to the "Generate Access Token" button.
  2. You should see the "OAUTH_APP_BLOCKED" error which is normal at this stage.
  3. Go to "Connected Apps OAuth Usage" in setup and search for "Salesforce Inspector reloaded".
  4. Click "Install" and then confirm installation.
  5. Now configure the profiles or permissions sets which will have the right to use the extension.
  6. Go back to "Connected Apps OAuth Usage" and click "Unblock" next to "Salesforce Inspector reloaded"
  7. Once again, open the extension and scroll down to the "Generate Access Token" button

2024-05-28_16-12-29 (1)

This is it ! You can use the extension with the default connected app.

From now when the token will be expired, this banner will show up and provide a link to re-generate the access token

image

Warning Don't forget to grant access to the users by selecting the related profile(s) or permission set(s).

If you are a Firefox user, or if you want to have full control over the connected app settings, you can also use your own external client app by following these instructions:

External Client App Creation

The creation of Connected Apps is soon to be deprecated (planned for Spring 26'), so we will cover the creation of the new standard using an external Client App.

  1. Navigate to Setup | External Client App > New External Client App.
  2. Fill in the required details:
    • External Client App Name
    • Contact Email
    • Check Enable OAuth under the API (Enable OAuth Settings) accordion.
    • Set the Callback URL to [browser]-extension://[extension-id]/data-export.html, replacing [browser] with chrome or moz and [extension-id] with the extension ID found in the URL of any configuration page of the extension (e.g., by clicking See All Data).
  3. Configure the OAuth Scopes:

    • Select Manage user data via APIs (api).
    • Select Manage user data via Web browsers (web).

    External Connected App

    Warning If you don't select the web scope, you might not be able to use the Login As Incognito. 4. Flow Enablement * Check the Enable Authorization Code and Credentials Flow and then check Require user credentials in the POST body for Authorization Code and Credentials Flow 5. Configure Security settings: * IMPORTANT: Deselect (disable) Require secret for Web Server Flow. * Select (enable) Require Proof Key for Code Exchange (PKCE) extension for Supported Authorization Flows. 6. Get Consumer Key and save it in the Options page

    Option button

  4. Enter the consumer key

    Client Id

  5. Refresh page and generate new token

    Generate Token

Migrate saved queries from legacy extension to Salesforce Inspector Reloaded

  1. Open data export page on legacy extension Inspect legacy
  2. Get saved queries from insextSavedQueryHistory property Inspect legacy
  3. Open it in VS Code, you should have a JSON like this one:
[
  { "query": "select Id from Contact limit 10", "useToolingApi": false },
  { "query": "select Id from Account limit 10", "useToolingApi": false }
]

From there you have two options

Import the queries by adding a label for each one with the label in query property suffixed by ":" ie.

[
  {
    "query": "Contacts:select Id from Contact limit 10",
    "useToolingApi": false
  },
  {
    "query": "Accounts:select Id from Account limit 10",
    "useToolingApi": false
  }
]

Re-import this json in the new extension (with the same key insextSavedQueryHistory)

Define a CSV separator

Add a new property csvSeparator containing the needed separator for CSV files

Update csv separator

If you want to always open extension's links in a new tab, you can enable> Warning

Open link in a new tab

Warning Enabling this option will prevent you to use Lightning navigation which allows faster navigation.

  • Data Export : e
  • Data Import : i
  • Org Limits : l
  • Download Metadata : d
  • Explore API : x
  • Event Monitor : m
  • Field Creator : f

Disable metadata search from Shortcut tab

By default when you enter keyword in the Shortcut tab, the search is performed on the Setup link shortcuts AND metadata (Flows, PermissionSets and Profiles). If you want to disable the search on the metadata, update related option:

image

Enable / Disable Flow scrollability

Go on a Salesforce flow and check / uncheck the checbox to update navigation scrollability on the Flow Builder

2023-09-29_16-01-14 (1)

Compare Flow Versions

Salesforce Inspector Reloaded provides quick access to Salesforce's Flow Compare feature, allowing you to visually compare different versions of a flow side-by-side in the Flow Builder.

What is Flow Compare?

Flow Compare is a Salesforce feature (available from Winter '26) that enables you to:

  • View two flow versions side-by-side
  • Identify differences between versions visually
  • Understand what changed between versions
  • Review changes before deploying or activating a flow

For more details, see the official Salesforce documentation.

How to Access Flow Compare

  1. Open Flow Builder
  2. Open Salesforce Inspector Reloaded popup
  3. Look for the Flow Compare button (appears when viewing a flow version)
  4. Click the button to open Flow Builder with the compare view

Using Flow Compare

Once Flow Builder opens:

  1. The current flow version is automatically loaded
  2. Use the version selector dropdown to choose a different version to compare against
  3. Flow Builder will display both versions side-by-side, highlighting differences
  4. Review changes, elements, and logic differences between the versions

Use custom shortcuts

You can add custom links to the "Shortcut" tab. These links will be stored in the sfHost + "_orgLinks" localStorage variable. The links are stored as a JSON array with the following properties:

  • label: The label of the link
  • link: The link to the page
  • section: The section where the link will be displayed
  • isExternal: A boolean indicating if the link is external (starts with 'http' or 'www')

The links are displayed in a table format with the following features:

  • Sortable columns (click on column headers to sort)
  • Search functionality to filter links by label, link, or section
  • Edit and delete buttons for each link
  • Add button to create new links

To add a new link:

  1. Click the "+" button at the bottom of the table
  2. Fill in the label, link, and section fields
  3. Click the check icon to save or the X icon to cancel

To edit a link:

  1. Click the edit icon (pencil) next to the link
  2. Modify the fields
  3. Click the check icon to save or the X icon to cancel

To delete a link:

  1. Click the delete icon (trash) next to the link

To search links:

  1. Use the search box at the top of the table
  2. Type any text to filter links by label, link, or section
  3. The table updates in real-time as you type

To sort links:

  1. Click on any column header to sort by that column
  2. Click again to reverse the sort order
  3. The current sort column is indicated by an up/down arrow icon

The links are stored in the browser's localStorage, so they will persist between sessions. The links are specific to each org, so you can have different links for different orgs.

Custom Link Search

Enable summary view of PermissionSet / PermissionSetGroups from shortcut tab

Since Winter 24, there is a beta functionality to view a summary of the PermissionSet / PermissionSetGroups

image

You can enable this view for the Shortcut search by enabling the option as shown below.

Enable Summary

Then when you click on a PermissionSet / PermissionSetGroups search result, you'll be redirected to the summary.

Customize Create / Update rest callout headers (to prevent execution of auto assignment rules for Accounts, Cases, or Leads)

Assignment Rule Header

From the popup, click on "Options" button and select the API tab.

image

If you want to prevent auto assignment rules, set the createUpdateRestCalloutHeaders property to {"Sforce-Auto-Assign" : false}

Update API Version

Since the plugin's api version is only updated when all productions have been updated to the new release, you may want to use the latest version during preview windows.

[!IMPORTANT] When you manually update the API version, it won't be overridden by extension future updates.

2023-11-10_09-50-55 (1)

Delete All Apex Logs

Sometimes you need to purge the ApexLogs from you org, mostly when the maximum size limit is reached. You can now delete all apex logs with a simple click. From the popup, select 'Org' tab and click 'Delete All ApexLogs' button.

Delete All Apex Logs

Enable debug logs

Sometimes you may want to enable logs for a particular user. From User tab, click the "Enable Log" button.

By default, this will enable logs with level "SFDC_DevConsole" for 15 minutes.

Enable Log button

You can update the debug level (configuration is per organization) and duration (for all organizations) on the Options page.

DebugLog Options

Warning Increasing the default duration may lead to a high volume of logs generated.

Enable Debug Mode (for Lightning Components)

Enable debug mode to make it easier to debug JavaScript code from Lightning components. Warning: Salesforce is slower for users who have debug mode enabled.

Enable Debug Mode

Enable API Call Debug Statistics

Sometimes we may want to know which queries are performed to the Salesforce backend (by type, method, endpoint ...) This can help to correlate logs in Salesforce and what is performed by Salesforce Inspector Reloaded extension

Customize extension's favicon

From the option page, you can customize the default favicon by:

The customization is linked to the org, it means you can have different colors for DEV and UAT env for example.

image

Now if you want to populate all the orgs you visited with a custom favicon, you have two options:

  • Smart mode enabled: this will analyze your environment name and populate a favicon based on this (blue for dev, green for int, purple for uat and orange for full)
  • Random: this will choose a random color among all the predefined colors

Then you click on Populate All and that's it! Note: orgs with an existing customized favicon won't be affected.

Customize sandbox banner color

From the option page, enable "Use favicon color on sandbox banner" image

image

Customize extension's shortcuts

Navigate to your browser shortcut menu and choose dedicated shortcuts for the pages you want.

Use Chrome Shortcuts

Default shortcuts

If you want to open popup keyboard shortcuts, you can use the 'ctrl' (windows) or 'command' (mac) key with the corresponding key. Example:

  • Data Export : e
  • Data Import : i
  • Org Limits : l
  • Download Metadata : d
  • Explore API : x

Highlight PROD with a top border

Production environment are critical, to avoid confusion with other orgs, you can enable an option which will add a 2px border on the top of the Salesforce UI and also in the extension's pages.

Under User Experience tab, enable the option Highlight PROD with a top border (color from favicon).

highlight prod with a top border

Import / Export configuration (saved query etc.)

With 1.25 and above

To export and import your current configuration, go to the options page and click the corresponding icon in the header:

Import / Export Configuration

Hide some buttons in the popup

Since the extension offers more features, the number of button is increasing. Some of the users may don't need some of those, to make the popup lighter some of the buttons can be hidden:

Hide Buttons

Switch user language from the popup

From the User tab in the popup, click on the user language flag to display the available languages.

2024-12-04_16-07-35 (1)

Default Popup Tab

You can configure which tab should be selected by default when opening the popup. To do this:

  1. Open the options page
  2. Go to the "User Experience" tab
  3. Find the "Default Popup Tab" option
  4. Select your preferred tab:
  5. Object: Shows the SObject search and details
  6. Users: Shows the user search and details
  7. Shortcuts: Shows your configured shortcuts
  8. Org: Shows organization information

The selected tab will be remembered and used as the default when opening the popup.

API Cache Configuration

Salesforce Inspector Reloaded uses a caching system to reduce the number of API calls made to Salesforce, improving performance and reducing API usage. The extension caches API response data to optimize queries and avoid unnecessary API requests.

Cached Requests

The following API requests are cached:

  • User Object Describe (/services/data/vXX.0/sobjects/User/describe) - Caches field permission information to optimize user search queries and dynamically build SELECT clauses based on accessible fields

Why Use Caching?

  • Reduced API Calls: Caching field permissions means the extension doesn't need to call the describe API every time you search for users
  • Better Performance: Faster user searches since cached data is retrieved instantly
  • Optimized Queries: The extension builds queries dynamically based on cached field permissions, only including fields you have access to
  • API Limit Preservation: Helps preserve your Salesforce API request limits by avoiding redundant describe calls

Configuring Cache Period

You can configure how long cached data should be stored:

  1. Open the extension and click the "Options" button
  2. Navigate to the "User Experience" tab
  3. Find the "API cache period (days)" setting
  4. Enter the number of days you want cached data to remain valid (default: 7 days)
  5. Click the "Clear Cache" button if you need to immediately refresh cached data

Note The cache is org-specific, meaning each Salesforce org has its own cached data. Cache entries are automatically cleared when they expire based on your configured cache period.

Customize User Tab Search Filters and Fields

The User tab in the popup allows you to search for users across your Salesforce org. You can customize both the search fields used and apply filters to exclude certain types of users from the search results.

User Search Customization

Configuring Search Fields

By default, user searches look through Username, Email, Alias, and Name fields. You can customize which fields are searched by:

  1. Open the extension and click the "Options" button
  2. Navigate to the "User Experience" tab
  3. Find the "User Default Search Fields" section
  4. Check/uncheck the fields you want to include in searches:
  5. Username - The user's unique username (default: enabled)
  6. Email - The user's email address (default: enabled)
  7. Alias - The user's alias (default: enabled)
  8. Name - The user's full name (default: enabled)
  9. Profile Name - Search by the user's profile name (default: disabled)

The search placeholder text in the User tab will automatically update to reflect which fields are currently enabled for searching.

Applying Search Filters

You can exclude certain types of users from appearing in search results. Because the IsPortalEnabled field does not exist in orgs where there is no portal, we made this option org specific.

  1. In the same "User Experience" tab in Options
  2. Find the "Exclude users from search" section
  3. Enable the filters you want to apply:
  4. Exclude Portal users - Hides users who have portal access enabled
  5. Exclude Inactive users - Hides users who are marked as inactive

Dynamic Popup Height

You can leverage more window height in the popup, to reduce the scroll. To enable this feature, go to User Experience -> Enable Dynamic Popup Height and check it.

Generate a package.xml from a deployment

From a DeployRequest record, click on the Generate package.xml button to download the package.xml for this deployment.

[!NOTE] If you retrieve the related metadata it may have been modified since the deployment, so you are not sure to retrieve what was deployed.

Generate package.xml from a deployment

Perform a field usage analysis for an SObject

The field usage analysis feature helps you understand which fields in your Salesforce org are actually being used by calculating the percentage of records that have values for each field.

How to use

  1. Navigate to an SObject: Select an SObject from the popup or navigate to any SObject page in Salesforce
  2. Open Show All Data: Click the "Show all data" button to open the field inspection page
  3. Calculate Field Usage: You have two options:
  4. Individual field: Click on "Get field usage" link next to any field to calculate usage for that specific field only
  5. All fields: Click on the refresh icon (🔄) in the "Usage (%)" column header to calculate usage for all fields at once
  6. View Results:
  7. Hover over any percentage to see the detailed breakdown (e.g., "1,247 / 5,000 records (25%)")
  8. Required fields automatically show 100% usage
  9. Fields that can't be analyzed (like textarea or address fields) will be empty
  10. Export Results: Use the table settings menu (gear icon) to copy the table or download as CSV

Important Notes

Warning Field usage analysis uses Salesforce API calls and counts against your API request limits. For large orgs, consider using this feature in a copy of production to avoid hitting API limits.

  • The feature uses Composite API to efficiently batch multiple field queries
  • Loading indicators show when calculations are in progress
  • Results are cached during your session for better performance
  • Required fields (nillable = false) automatically show 100% usage without making API calls

Use Cases

This feature is particularly useful for:

  • Data cleanup projects
  • Field deprecation planning
  • Org optimization initiatives
  • Documentation and audit requirements
  • Understanding field adoption across your organization

Smart Field Usage demo

Use Agentforce to analyze formula fields

The Agentforce Helper feature provides AI-powered analysis and explanations for formula fields, helping you understand complex formulas, identify issues, and get recommendations for improvements.

Prerequisites

Prerequisite Agentforce needs to be enabled. The prompt FormulaHelper needs to be deployed in the org.

Note The standard Salesforce 'Prompt Template User' permission is required to use this feature.

How to use

  1. Navigate to an SObject: Select an SObject from the popup or navigate to any SObject page in Salesforce
  2. Open Show All Data: Click the "Show all data" button to open the field inspection page
  3. Access Agentforce Helper: For any calculated/formula field:
  4. Click the dropdown arrow (â‹®) in the Actions column
  5. Select "Agentforce Helper" from the menu
  6. Review the Analysis: The modal will display:
  7. Field metadata (name, type, formula expression)
  8. A customizable prompt with your instructions
  9. An "Analyze" button to generate the AI analysis
  10. Customize Instructions (optional):
  11. Click "Edit" to modify the prompt instructions
  12. Add specific requirements or questions about the formula
  13. Click "Reset" to restore default instructions
  14. View Results: After clicking "Analyze", Agentforce will provide:
  15. Plain language explanation of the formula
  16. Step-by-step logic breakdown
  17. Dependencies and referenced fields
  18. Edge cases and potential issues
  19. Best practices review and recommendations
  20. Example calculations with sample data

Configuration Options

Enable/Disable Agentforce Helper

You can control whether the Agentforce Helper link appears in the field actions menu:

  1. Open the extension and click the "Options" button
  2. Navigate to the "Show All" tab
  3. Find the "Enable Agentforce Helper for formula fields" toggle
  4. Enable or disable the feature as needed (enabled by default)

Note When disabled, the "Agentforce Helper" link will not appear in the field actions menu for formula fields.

Customize Prompt Template

You can configure which AI prompt template is used for formula analysis:

  1. In the same "Show All" tab in Options
  2. Find the "Formula Helper Prompt Template Name" field
  3. Enter the developer name of your custom prompt template (default: "FormulaHelper")

Important The prompt template must exist in your Salesforce org as a GenAI Prompt Template and should be configured to accept two inputs: Prompt and FieldMetadata.

Customize Analysis Instructions

For each formula field analysis, you can customize the instructions:

  1. Open the Agentforce Helper modal for any formula field
  2. Click the "Edit" button to modify the instructions
  3. Add or modify the analysis requirements
  4. Your custom instructions are saved per org and will be used for future analyses
  5. Click "Reset" at any time to restore the default instructions

Use Cases

This feature is particularly useful for:

  • Understanding complex formulas: Get plain-language explanations of intricate formula logic
  • Formula reviews: Identify potential issues, edge cases, and best practice violations
  • Knowledge transfer: Document formula behavior for team members
  • Formula optimization: Get recommendations for improving formula efficiency
  • Troubleshooting: Understand why a formula might not be working as expected
  • Modification planning: Get guidance on how to safely modify existing formulas

User Tab Toggle Reset Password button

This feature enables a Reset Password button on the User Tab page in Salesforce Inspector Reloaded. The button can be displayed on or off from the extension Options page.

How it works

  1. Open Salesforce Inspector Reloaded.
  2. Navigate to the Options page.
  3. Locate the Enable Reset Password button on User Tab option.
  4. Toggle the option:

  5. On – the Reset Password button is displayed on the User Tab.

  6. Off – the Reset Password button is hidden.

Rest Password option

When enabled, the Reset Password button appears while inspecting a User record and allows you to reset the user’s password directly from the User Tab, without navigating to Salesforce Setup.

Reset password success

Note: If the current session does not have sufficient permissions to access user information or perform a password reset, Salesforce returns an INSUFFICIENT_ACCESS error.

Reset password error