Skip to main content

Scripting Widget

Peter Novosel avatar
Written by Peter Novosel
Updated over a week ago

The Scripting Widget feature modernizes existing custom script functionality by migrating these scripts into a secure, SDK-enabled environment that leverages iFrame security. It features a unique two-column layout—with a resizable left column housing a Code Editor and Help Panel (API Reference) and a preview area on the right—supporting interactive testing and dynamic error messaging.

Plan Availability

All plan types

Permissions

Solution Creators - Can create, modify, delete, and manage Scripting Widgets in the Solutions they manage.

Related Reading

The Scripting Widget modernizes custom scripting by moving your code into a secure, SDK-enabled environment using iframe technology. With a sleek two-column layout and dynamic testing capabilities, it’s a game-changer for users who want to embed customized logic directly into their solutions.


What is the Scripting Widget?

The Scripting Widget lets you:

  • Write custom scripts directly inside SmartSuite.

  • Preview and test your scripts in real-time.

  • See clear error messages when something goes wrong.

It’s built for security, interactivity, and ease of use — making it easier than ever to extend your SmartSuite solutions.


Key Features

  • Two-Column Layout:

    • Left Panel: Code Editor + Help Panel (API Reference)

    • Right Panel: Preview Area

  • Resizable Panels: Adjust both code and preview areas to your preference.

  • Interactive Testing: Instantly run scripts and see results or errors.

  • Error Handling: Errors only display after testing, not while typing.

  • In-line Editing: Click the widget name to edit it directly (no separate settings icon).


How to Use the Scripting Widget

Step-by-Step Guide

  1. Add a New Widget

    • Navigate to your SmartSuite dashboard.

    • Click Add Widget and choose Scripting Widget.

  2. Name Your Widget

    • Click on the widget name to rename it right on the spot.

  3. Write Your Script

    • Use the Code Editor on the left side.

    • Refer to the Help Panel (API Reference) below the editor for guidance.

  4. Resize or Collapse Panels (Optional)

    • Drag to adjust the Code Editor or Help Panel sizes.

    • Minimum dimensions:

      • Left Column: 450px

      • Right Column: 300px

      • Help Panel Minimum Height: 130px

  5. Test Your Script

    • Click the Test button.

    • A loading message appears during execution.

    • See dynamic error messages if there are issues.

  6. View Output

    • Your script’s output appears in the Preview Area on the right.


Important Notes

  • Error Display:
    Errors appear after you hit Test, not while typing.
    For regular dashboard users (non-creators), we may only show a generic “Error” message instead of detailed error data to protect sensitive information.

  • Upcoming Usage:
    The Scripting Widget UI will also be used in the Automation Action: Run a Script feature, ensuring consistent behavior and styling across SmartSuite.

  • No Settings Icon:
    All key interactions happen within the widget itself. No external settings menu is needed.


Practical Scenarios and Use Cases

Departmental Custom Solutions

Scenario:
The Finance team requires a real-time, dynamic calculator to automate complex monthly projections, including revenue growth modeling, expense forecasting, and cash flow analysis. Traditional spreadsheets aren't scalable or easily integrated into their SmartSuite dashboards.

Solution:
Use the Scripting Widget to develop a custom script that:

  • Queries real-time financial data from multiple tables (e.g., Revenue, Expenses, Forecasts).

  • Performs multi-variable calculations like compound growth rates, rolling averages, and year-over-year comparisons.

  • Dynamically updates projection results in the dashboard preview.

  • Offers input fields within the table for scenario planning (e.g., adjusting revenue assumptions).

This enables the Finance team to simulate different financial scenarios instantly, improve forecasting accuracy, and make faster strategic decisions—all without leaving SmartSuite.

Consolidated Reporting for Client Projects

Scenario:
The Client Services team needs to generate a single PDF that includes multiple uploaded files (contracts, invoices) and images (product photos, signed agreements) from different fields in a SmartSuite record. Instead of manually combining documents, they want an automated way to generate and attach the final consolidated PDF directly to the record.

Solution:
Using the Scripting Widget, a Solution Creator writes a script that:

  1. Fetches all file uploads and images from designated fields in the record.

  2. Merges the files and images into a single PDF document.

  3. Attaches the newly created PDF back to the original record under a "Consolidated Files" field.

This saves the team hours of manual work and ensures consistent, professional documentation for each client.

Interactive Client Demos

Scenario: A Product Manager wants to demonstrate interactive features for clients without switching apps.

Solution: Set up a Scripting Widget to display live calculations or mini tools, customized for each client demo.

Testing API Integrations

Scenario: The IT team needs to test API calls within SmartSuite before deploying full automations.

Solution: Write and test small scripts inside the Scripting Widget, using the Help Panel for SmartSuite's SDK references.

Did this answer your question?