Insights
Insights is a card on the right side of a play or pack page. It reads what is happening with the record you are looking at, tells you what matters, and, where it can, takes you straight to the place to act. Nothing in it changes your play. It only points things out.
When there is nothing to say, the card is not shown. Every insight can be dismissed with its close button until you reload the page, and the ? icon on the card brings you to this page.
Insights marked warning need your attention. Insights marked info are for awareness.
Who sees what
What you see depends on your role on the record:
- Owner or manager: you own the play or pack, or you can manage plays.
- Reviewer: you can manage approvals.
- Everyone else: any other person, including guests where your Playground allows public viewing.
If you have more than one role, you see the insights of each.
| Insight | Owner or manager | Reviewer | Everyone else | Applies to |
|---|---|---|---|---|
| Viewing a draft | Yes | Yes | No | Plays and packs with a newer draft behind the live version |
| Viewing the live version | No | Yes, when there is no draft | Yes | Plays and packs |
| Highlights of the live version | Yes | Yes | Yes | The live version has highlights |
| Highlights of your draft | Yes | Yes | No | A draft with highlights |
| What changed | Yes | Yes | Yes | Plays with an earlier version |
| Approval status (waiting, approved, rejected) | Yes | Yes | No | A version in the approval flow |
| Needs your review with Approve and Send back | No | Yes, never for your own submission | No | A version waiting for approval |
| Common files in a pack | Yes | Yes | Yes | Packs |
| Old API version | Yes, asks you to update | Yes, precaution | Yes, precaution | Salesforce and Apex Script plays that are 5 or more releases behind |
| Source structure | Yes | No | No | Salesforce and Apex Script plays that still use src |
| Tidy-up | Yes | No | No | Plays that contain system or VS Code files (not packs, not Package plays) |
Insights marked as warnings in the card need attention. The others are for awareness. Other people never see details of a draft that is not live yet, such as who submitted or reviewed it.
Draft and live versions
A record that is published can also have a newer draft version being prepared. See Draft and live versions.
- You are viewing draft version X: version Y is live, and search, links and everyone else see Y until you validate and publish X. You can also roll back from the Versions tab.
- You are viewing the live version X: you are looking at the latest published version.
Highlights
When the person who published a version wrote highlights, they appear as "<name> promoted vX on <date> with the following changes". For plays the card also offers View file changes to jump to the Changes tab. A draft with its own highlights shows them to its owner as "Highlights noted for your draft".
What changed
For plays, this insight links to the Changes tab, which compares the files of one version with the version before it. Owners and reviewers who have a draft in progress see the live version compared with the draft instead, so they can check everything that is about to go out.
Approvals
If your Playground requires approval before publishing, the card follows the version through the review:
- Needs your review: shown to a reviewer when a version waits for approval. It says who submitted it and when, links to the files or components to review, and offers Approve and Send back.
- Waiting for approval: shown to the owner. The version cannot be changed until it is reviewed.
- Rejected: shows who rejected the version and when. Update the play, validate again and resubmit.
- Approved: the version is ready to be published.
If a newer version is pushed while a reviewer has the page open, approving or publishing the older one is refused so nothing unreviewed goes live.
Common files in a pack
When two or more plays in a pack contain the same file, the file from the later play in the sequence replaces the earlier ones on deployment. The insight lists the common files and the plays that provide each, and opens the Components tab so you can review them and avoid unintended overrides.
Source structure (src folder)
Shown to owners and managers of Salesforce and Apex Script plays. If the files sit in the older metadata layout, in a top-level src folder, Playground suggests moving them to the source structure (force-app/main/default). The source format is easier to maintain and is what current Salesforce tooling expects. Update the play with the new structure to create a new version. The insight goes away when the src folder is gone.
Tidy-up: system and VS Code files
Shown to owners and managers of plays. If the files contain leftovers that only matter on your own machine, such as .DS_Store, Thumbs.db, desktop.ini, __MACOSX folders, editor backup files or a .vscode folder, Playground gently suggests removing them. The card lists the files so you can find them in the Components tab. Delete them and update the play to create a new version. Removing them keeps the play lean and the changes between versions easy to read.
Old API version
Shown on Salesforce and Apex Script plays whose API version is 5 or more releases behind the latest generally available version (for example version 56 when the latest is 61).
- Owners and managers are asked to update the play to a recent API version. Change it in the play's edit screen and save it as a new version.
- Everyone else gets a precaution: the play may rely on behaviour that has changed or been retired, so use it consciously and try it in a sandbox before deploying.
The text shows how far behind the play is.
tip
Insights are added over time. Tell us from the Help page if there is a hint you would like to see.