- JavaScript 100%
| DXSummaryBox.js | ||
| DXSummaryBox.version.js | ||
| README.md | ||
Salesforce DX Sidebar Enhancer
A Tampermonkey userscript for the Trimble Salesforce DX Service Console.
This script adds a compact Case Summary panel to Salesforce Case pages and enhances Case list views with priority highlighting, Critical Case Notes hover text, ESB/Premium Support detection, and script version visibility.
Features
Case Summary panel
On Salesforce Case record pages, the script adds a summary box to the sidebar with configurable fields such as:
- Account Name
- Subject
- Description
- Date/Time Opened
- First Response Date
- Local Time
- Priority
- Case Product
- Product Version
- Contact Name
- Phone
- Special Account Instructions
- Critical Case Notes
- Internal Comments
The summary box includes a settings button where users can choose which fields to show and which fields should have copy buttons.
ESB / priority support detection
The script can mark a Case Summary box as ESB Priority Support when either:
- the Account Name matches a configured high-priority company rule, or
- the Account Special Account Instructions contain configured priority keywords such as
ESBorPremium Support.
Wildcard matching is supported in the company list. For example:
'CRH Americas Materials*'
matches:
CRH Americas Materials
CRH Americas Materials, Inc.
CRH Americas Materials, Inc. 10/APAC 1
Case list enhancements
On supported Case list / queue pages, the script can:
- highlight high-priority account rows
- highlight the Critical Case Notes cell when notes exist
- show the full Critical Case Notes text on hover
- detect high-priority accounts from Account Special Account Instructions
Version badges
The Case Summary header shows both:
- the installed local script version
- the remote version from the configured update URL
Example:
Case Summary v1.29 remote v1.30
If the remote version is newer, the remote badge is shown as stale so users can tell they need an update without digging through the Tampermonkey dashboard.
Requirements
- Google Chrome or a Chromium-based browser
- Tampermonkey extension installed
- Access to
https://trimbledx.lightning.force.com/ - Network access to the script host:
https://git.pc-logix.com/Michiyo/TrimbleScripts/raw/branch/main/DXSummaryBox.js
Install Tampermonkey in Chrome
-
Open Google Chrome.
-
Go to the Chrome Web Store page for Tampermonkey:
https://chromewebstore.google.com/detail/tampermonkey/dhdgffkkebhmkfjojejmpbldmpobfkfo -
Click Add to Chrome.
-
Confirm the install when Chrome prompts you.
-
After installation, pin Tampermonkey to the toolbar if desired:
- Click the puzzle-piece Extensions icon.
- Find Tampermonkey.
- Click the pin icon.
Install the script from URL
Use the URL install method instead of copy/paste. This gives Tampermonkey the best chance of tracking update metadata correctly.
-
Open this raw script URL in Chrome:
https://git.pc-logix.com/Michiyo/TrimbleScripts/raw/branch/main/DXSummaryBox.js -
Tampermonkey should open an install screen automatically.
-
Review the script details.
-
Click Install.
-
Open or refresh Salesforce DX:
https://trimbledx.lightning.force.com/ -
Open a Case. The Case Summary box should appear in the sidebar.
Confirm installation
- Click the Tampermonkey toolbar icon.
- Click Dashboard.
- Confirm that Salesforce DX Sidebar Enhancer is listed and enabled.
- Open a Salesforce Case and check for the Case Summary panel.
Updating the script
The script includes update metadata:
// @updateURL https://git.pc-logix.com/Michiyo/TrimbleScripts/raw/branch/main/DXSummaryBox.version.js
// @downloadURL https://git.pc-logix.com/Michiyo/TrimbleScripts/raw/branch/main/DXSummaryBox.js
Tampermonkey should check for updates automatically based on its update settings, but the timing is not always immediate. The Case Summary panel displays both the installed version and the remote version so users can tell when they are behind.
To manually check for updates:
- Open the Tampermonkey Dashboard.
- Find Salesforce DX Sidebar Enhancer.
- Use Tampermonkey's update/check update option for the script or for all userscripts.
- Refresh Salesforce after the update completes.
Recommended Tampermonkey settings
In Tampermonkey Dashboard settings, confirm:
- Script updates are enabled.
- The update interval is set to a reasonable value, such as daily.
- The script itself is enabled.
Even with daily checks enabled, updates may not happen immediately. Browser profile activity, extension restrictions, corporate policies, caching, and how the script was originally installed can affect update timing.
Debug mode
Debug output is normally hidden.
To enable debug mode temporarily, add this to the Salesforce URL:
?dxsummarydebug=1
Or run this in the browser console:
localStorage.setItem('DXSummaryBoxDebug', '1');
To disable debug mode:
localStorage.removeItem('DXSummaryBoxDebug');
Then refresh the page.
Configuration
Field display settings
Click settings in the Case Summary panel to choose which fields are visible and which fields have copy buttons.
Settings are stored locally in the browser using localStorage.
High-priority companies
High-priority companies are configured inside the script in LIST_CFG.highPriorityCompanies.
Example:
highPriorityCompanies: [
'ARCO*',
'Baker Concrete Construction',
'Bird Construction Group',
'CRH Americas Materials*',
'The Christman Company',
'EMCOR*',
'EMERY SAPP SONS',
'Faith Technologies, Inc.',
'FM SYLVAN HOLDING, LLC',
'Limbach Facility Services*',
'MasTec Oil & Gas Division',
'Precision Pipeline LLC',
'MMR Group, Inc',
'Nooter LLC',
'Primoris Services Corporation',
'Teichert Services Group',
'UNIVERSITY MECHANICAL CONTRACTORS INC',
]
Wildcard behavior:
*matches any text.- Matching is case-insensitive.
- Punctuation is normalized before matching.
High-priority instruction keywords
The script can also treat an account as high priority when Account Special Account Instructions contain configured keywords.
Example:
highPriorityInstructionKeywords: [
'ESB',
'Premium Support'
]
Troubleshooting
The script does not show on Salesforce
Check:
- Tampermonkey is installed and enabled.
- The script is installed and enabled.
- The current page is under
https://trimbledx.lightning.force.com/. - The page has been refreshed after installing or updating.
The version badge says the remote version is newer
The installed script is behind the remote version.
Open the Tampermonkey Dashboard and manually check for script updates.
Auto-update did not happen
Tampermonkey update checks are not always immediate. If a user is very stale, confirm they installed from the raw URL and not by copy/paste. Manual/pasted scripts may not update as reliably.
Case list highlights are delayed
Salesforce list views virtualize rows while scrolling. The script re-applies visible row decorations on a timer. If a row appears unhighlighted immediately after scrolling, wait briefly.
Debugging a problem
Enable debug mode, reproduce the issue, then check the browser console for messages prefixed with:
[SF Sidebar]
Security notes
This userscript runs only on:
https://trimbledx.lightning.force.com/*
It reads Salesforce UI/API data available to the logged-in user and modifies the page display locally in the browser.
If issue-submission support is enabled, it may send a request to the configured Forgejo/Gitea repository using the configured token. Use a low-privilege token and rotate it if it is exposed.
Uninstall
- Open the Tampermonkey Dashboard.
- Find Salesforce DX Sidebar Enhancer.
- Click delete/remove.
- Refresh Salesforce.