Skuid Docs
    Skuid Docs
  • Concepts
  • Reference
  • Site Administration
  • Tutorials
  • Release Notes
v16.0.3
2
https://docs.skuid.com/latest/v2/en/
False
  • Concepts
    • Data
      • Authentication Providers and Data Sources
      • Authentication and Skuid
      • Callback URLs/Redirect URIs
      • Data Source Objects
      • Google
        • Google Calendar
        • Google Drive
      • Salesforce
      • SQL
      • REST
        • URL Merge Condition Example
      • OData
        • Create, update, and delete records from SQL Server
      • Troubleshooting
    • Build
      • The Composer
      • The Page Index
      • Context
      • Pages
        • API Versioning in Skuid
          • v2 Page API Migration Utility
        • Create and Customize Skuid Pages
        • Principal and Dependent Pages
        • Page Revisions
        • Optimize Pages
        • Page Packs
        • Modules
        • Page Parameters
      • Models
        • Create and Configure Models
        • Model Conditions
          • Limit Records with a Subquery Condition
        • Model Actions
        • Include Child Fields in a Parent Object
        • Aggregate Models
          • Aggregations in Table and Chart Components
          • An Aggregation Case Study
        • Using Fields
          • UI-Only Fields and Models
            • UI-Only Field Use Cases
          • Field Metadata Overrides
      • Components
        • Layout
          • Accordion
          • Button Set
            • Create a Show/Hide Toggle Button
          • Carousel
          • Masthead
          • Navigation
          • Responsive Grid
          • Tab Container
          • Tab Set
          • Vertical Navigation
          • Wizard
            • Create a New Account Wizard
          • Wrapper
        • Data
          • Calendar
          • Deck
          • File Upload
          • Filter Set
          • Form
          • Header
          • Image
            • Add a Record-Sensitive Image
          • List
          • Message Area
          • Search
            • Creating Search Form and Search Results Pages
          • Table
          • Text
        • Advanced
          • Chatter Feed
          • Page Include
        • Visualizations
          • Before You Chart
          • Chart
          • Geochart
          • Enhancing Charts with Actions
        • Component Accessories
          • Add Drawers to a Table or List
          • Modals
            • Use a Modal to Create New Records
          • Sliding Panels
          • Sort Builder
        • Display Logic
      • Best Practices
        • Page Performance Guide
        • Skuid and Salesforce Lightning Performance Tips
        • Working with Images
      • Debugging Skuid in the Console
      • Logic
        • Filters
          • Filter on Date Ranges
          • Filter on Numeric Ranges
          • Create a Selectable Filter
            • Use Select option to Filter on Date Ranges
            • Use Select option to Filter on a Number Range
            • Use Select option with Builder-generated Options
            • Use Select option with Multiple Conditions and Fields
          • Create a Toggle Filter
          • Filter by Related Objects
        • Action Framework
          • Actions Reference
            • Visual Navigation
            • Model Conditions / Querying Actions
            • Model Data Changes Actions
            • Data Source Specific Actions
            • Platform Actions
            • Logic Actions
            • Component-Context Actions
          • Action Sequences
            • Inputs How-To: Activate and Set a Condition and Requery Model
        • Merge Syntax
          • Global Merge Variables / Functions
          • Row Merge Variables
          • Data source Merge API Reference
        • Skuid and Date/Time
        • Client-Side Validation
    • Style
      • Design System Studio
        • Property Reference
        • Lightning in Skuid
        • Fonts in the Design System Studio
        • Extending Design Systems with Code
      • Label Localization
    • Deploy
      • Salesforce Lightning
      • Salesforce Classic
        • skuid:page Visualforce component
        • Salesforce Dashboards
        • Force.com Sites
      • Page Assignments
      • Salesforce Communities
      • Sandboxes and Connected Orgs
      • License and Permission Assignments
      • ISV and Managed Packages
      • Skuid and the Salesforce Guest User
    • Extend
      • Skuid and Code
        • Skuid and JavaScript
          • Resource Types
          • UI Code
            • Custom Field Renderers
              • Basic virtual-based field renderer
              • Native Date Renderer
              • jQuery Mask
              • Ratings Icons
              • Embedded YouTube Player
        • Salesforce Languages
          • Skuid and Apex
            • Apex Triggers
            • Invocable Methods and the Apex Data Source Action
            • Remote Actions
            • Access Apex as a REST data source
            • Access Web Services using the AJAX Toolkit
          • Skuid and Aura
        • Skuid and Analytics
      • CI/CD with Skuid
      • Automated Testing
        • Example Automated Test with Node.js, Selenium, and Jasmine
  • Reference
    • The Property Library
    • API Reference
      • skuid.debug
      • skuid.runtime
        • skuid.$
        • skuid.actions
        • skuid.ajax
        • skuid.builder.core
        • skuid.builder.core.coreProps
        • skuid.calendar
        • skuid.collaboration
        • skuid.component
        • skuid.componentType
        • skuid.events
        • skuid.formula
        • skuid.hotkeys
        • skuid.label
        • skuid.lightning
        • skuid.load
        • skuid.model
        • skuid.model.Model
        • skuid.mustache
        • skuid.page
        • skuid.sfdc
        • skuid.snippet
        • skuid.time
        • skuid.utils
        • skuid.version
        • Component-Specific APIs
        • Skuid Model Metadata Object
        • Skuid Model Child Relationship Metadata Object
        • Skuid Model Condition Metadata Object
        • Skuid Model Field Metadata Object
        • Skuid Model Record Type Metadata Object
    • Page XML API
    • skuid-sfdx
    • Skuid Metadata Object Reference
      • Authentication providers
      • Data sources
      • Design Systems
      • Files
      • Pages
      • Themes
    • Skuid Glossary
    • Formula and Function Reference
    • Skuid and Date/Time
    • Open Source Software Attributions
  • Site Administration
    • Installing Skuid SFX
    • Upgrading Skuid SFX
    • Single Sign-On
      • SAML 2.0 for Skuid data sources
        • Access Salesforce Data through SSO
      • Implementation Expectations
    • Deprecated in Skuid
    • Content Delivery Network
    • Supported Browsers
    • Using the Keyboard: Shortcuts, Hotkeys, and Accessibility
    • Skuid VPAT for v2
  • Tutorials
    • Skuid Page Tutorials
      • Build a Custom List Page
      • Build a Custom Detail Page
      • Compose a Branded Header and Navigation
      • Compose a One-Page App Using Tab Actions and Conditional Rendering
      • Conditionally Display Fields
      • Highlight Critical Data: Wrappers, Rich Text, and Ui-Only Fields
      • Mass Create Records
      • Show Products in an Opportunity Page
      • Skuid Pages for standard Salesforce CRM
    • Salesforce Tutorials
      • Add Products to an Opportunity via a Modal
      • Add Gmail to Salesforce functionality in your email fields
      • Create a Custom Edit Page and Set Visualforce Overrides
      • Getting Help: Grant Skuid Login Rights to your Org
      • Reclaim the Salesforce Home Page
      • Add and Display Images for a Single Record
    • JavaScript Tutorials
      • Using Skuid with JavaScript: A Primer
  • Legal terms and conditions
  • Skuid SFX Evaluation Guide
    • Overview​
      • What Is Skuid?
      • What are the benefits of Skuid?
      • How does Skuid maximize my Salesforce investment?
      • When is Skuid a good fit?
      • When is Skuid not a good fit?
      • Who uses Skuid?
      • What do customers say about us?
      • What steps does Skuid take to ensure compatibility with future Salesforce releases?
    • Developing Apps with Skuid​
      • The Scalable Kit for User Interface Design (Skuid)
        • Models
        • UI components
        • The Action Framework
        • Display Logic
        • Event System
        • Design System Studio
        • Code Extension
      • The Salesforce Ecosystem​
        • Does Skuid work with Lightning?
        • Does Skuid work with Salesforce Experience Cloud?
        • Is Skuid compatible with other AppExchange apps?
        • What Salesforce products and services does Skuid support?
      • Mobile
    • App Lifecycle Management​
      • Can I build with Skuid in different production environments?
      • Can my entire team develop with Skuid?
      • How does Skuid fit into my company’s CI/CD practices?
      • Analytics​
        • Does Skuid work with my third-party analytics software?
        • Does Skuid work with Einstein Analytics?
        • Build your own analytics tracker with Skuid
    • Architecture​
      • Skuid SFX Architecture
        • How does Skuid work?
        • How does Skuid get data and does Skuid consume API calls?
        • Is Skuid limited to one sObject or Record Type per page?
        • Does my Salesforce application have to be built completely from Skuid?
        • How does Skuid work with Salesforce Process automation and validation?
      • Lightning​
        • How do Skuid pages work in Lightning?
        • Where else in Lightning can I use Skuid?
        • Can I use Lightning components in Skuid pages?
      • Salesforce Classic​
        • How do Skuid pages work in Salesforce Classic?
        • Where else in Classic can I use Skuid?
        • What happens if I need to migrate to Lightning after building with Skuid in Classic?
    • Data​
      • Skuid and the Salesforce data model
      • Can Skuid Access…​
        • Objects?
        • Object Relationships?
        • Salesforce field types?
        • Custom settings?
        • Custom metadata?
        • Big Objects?
        • External Objects?
        • Other Salesforce Orgs?
    • Security​
      • Does Skuid store my Salesforce or third-party data?
      • How does Skuid work with Salesforce permission sets, sharing rules, field-level security, and profiles?
      • Does Skuid override Salesforce validation rules and error messages?
      • What security certifications does Skuid have?
    • Performance​
      • Does Skuid have data limits?
      • How can Skuid builders optimize for page performance?
  • Legal terms and conditions
    • Terms of use
    • Trademarks

In This Section

  • Concepts
    • Data
      • Authentication Providers and Data Sources
      • Authentication and Skuid
      • Callback URLs/Redirect URIs
      • Data Source Objects
      • Google
        • Google Calendar
        • Google Drive
      • Salesforce
      • SQL
      • REST
        • URL Merge Condition Example
      • OData
        • Create, update, and delete records from SQL Server
      • Troubleshooting
    • Build
      • The Composer
      • The Page Index
      • Context
      • Pages
        • API Versioning in Skuid
          • v2 Page API Migration Utility
        • Create and Customize Skuid Pages
        • Principal and Dependent Pages
        • Page Revisions
        • Optimize Pages
        • Page Packs
        • Modules
        • Page Parameters
      • Models
        • Create and Configure Models
        • Model Conditions
          • Limit Records with a Subquery Condition
        • Model Actions
        • Include Child Fields in a Parent Object
        • Aggregate Models
          • Aggregations in Table and Chart Components
          • An Aggregation Case Study
        • Using Fields
          • UI-Only Fields and Models
            • UI-Only Field Use Cases
          • Field Metadata Overrides
      • Components
        • Layout
          • Accordion
          • Button Set
            • Create a Show/Hide Toggle Button
          • Carousel
          • Masthead
          • Navigation
          • Responsive Grid
          • Tab Container
          • Tab Set
          • Vertical Navigation
          • Wizard
            • Create a New Account Wizard
          • Wrapper
        • Data
          • Calendar
          • Deck
          • File Upload
          • Filter Set
          • Form
          • Header
          • Image
            • Add a Record-Sensitive Image
          • List
          • Message Area
          • Search
            • Creating Search Form and Search Results Pages
          • Table
          • Text
        • Advanced
          • Chatter Feed
          • Page Include
        • Visualizations
          • Before You Chart
          • Chart
          • Geochart
          • Enhancing Charts with Actions
        • Component Accessories
          • Add Drawers to a Table or List
          • Modals
            • Use a Modal to Create New Records
          • Sliding Panels
          • Sort Builder
        • Display Logic
      • Best Practices
        • Page Performance Guide
        • Skuid and Salesforce Lightning Performance Tips
        • Working with Images
      • Debugging Skuid in the Console
      • Logic
        • Filters
          • Filter on Date Ranges
          • Filter on Numeric Ranges
          • Create a Selectable Filter
            • Use Select option to Filter on Date Ranges
            • Use Select option to Filter on a Number Range
            • Use Select option with Builder-generated Options
            • Use Select option with Multiple Conditions and Fields
          • Create a Toggle Filter
          • Filter by Related Objects
        • Action Framework
          • Actions Reference
            • Visual Navigation
            • Model Conditions / Querying Actions
            • Model Data Changes Actions
            • Data Source Specific Actions
            • Platform Actions
            • Logic Actions
            • Component-Context Actions
          • Action Sequences
            • Inputs How-To: Activate and Set a Condition and Requery Model
        • Merge Syntax
          • Global Merge Variables / Functions
          • Row Merge Variables
          • Data source Merge API Reference
        • Skuid and Date/Time
        • Client-Side Validation
    • Style
      • Design System Studio
        • Property Reference
        • Lightning in Skuid
        • Fonts in the Design System Studio
        • Extending Design Systems with Code
      • Label Localization
    • Deploy
      • Salesforce Lightning
      • Salesforce Classic
        • skuid:page Visualforce component
        • Salesforce Dashboards
        • Force.com Sites
      • Page Assignments
      • Salesforce Communities
      • Sandboxes and Connected Orgs
      • License and Permission Assignments
      • ISV and Managed Packages
      • Skuid and the Salesforce Guest User
    • Extend
      • Skuid and Code
        • Skuid and JavaScript
          • Resource Types
          • UI Code
            • Custom Field Renderers
              • Basic virtual-based field renderer
              • Native Date Renderer
              • jQuery Mask
              • Ratings Icons
              • Embedded YouTube Player
        • Salesforce Languages
          • Skuid and Apex
            • Apex Triggers
            • Invocable Methods and the Apex Data Source Action
            • Remote Actions
            • Access Apex as a REST data source
            • Access Web Services using the AJAX Toolkit
          • Skuid and Aura
        • Skuid and Analytics
      • CI/CD with Skuid
      • Automated Testing
        • Example Automated Test with Node.js, Selenium, and Jasmine
  • Reference
    • The Property Library
    • API Reference
      • skuid.debug
      • skuid.runtime
        • skuid.$
        • skuid.actions
        • skuid.ajax
        • skuid.builder.core
        • skuid.builder.core.coreProps
        • skuid.calendar
        • skuid.collaboration
        • skuid.component
        • skuid.componentType
        • skuid.events
        • skuid.formula
        • skuid.hotkeys
        • skuid.label
        • skuid.lightning
        • skuid.load
        • skuid.model
        • skuid.model.Model
        • skuid.mustache
        • skuid.page
        • skuid.sfdc
        • skuid.snippet
        • skuid.time
        • skuid.utils
        • skuid.version
        • Component-Specific APIs
        • Skuid Model Metadata Object
        • Skuid Model Child Relationship Metadata Object
        • Skuid Model Condition Metadata Object
        • Skuid Model Field Metadata Object
        • Skuid Model Record Type Metadata Object
    • Page XML API
    • skuid-sfdx
    • Skuid Metadata Object Reference
      • Authentication providers
      • Data sources
      • Design Systems
      • Files
      • Pages
      • Themes
    • Skuid Glossary
    • Formula and Function Reference
    • Skuid and Date/Time
    • Open Source Software Attributions
  • Site Administration
    • Installing Skuid SFX
    • Upgrading Skuid SFX
    • Single Sign-On
      • SAML 2.0 for Skuid data sources
        • Access Salesforce Data through SSO
      • Implementation Expectations
    • Deprecated in Skuid
    • Content Delivery Network
    • Supported Browsers
    • Using the Keyboard: Shortcuts, Hotkeys, and Accessibility
    • Skuid VPAT for v2
  • Tutorials
    • Skuid Page Tutorials
      • Build a Custom List Page
      • Build a Custom Detail Page
      • Compose a Branded Header and Navigation
      • Compose a One-Page App Using Tab Actions and Conditional Rendering
      • Conditionally Display Fields
      • Highlight Critical Data: Wrappers, Rich Text, and Ui-Only Fields
      • Mass Create Records
      • Show Products in an Opportunity Page
      • Skuid Pages for standard Salesforce CRM
    • Salesforce Tutorials
      • Add Products to an Opportunity via a Modal
      • Add Gmail to Salesforce functionality in your email fields
      • Create a Custom Edit Page and Set Visualforce Overrides
      • Getting Help: Grant Skuid Login Rights to your Org
      • Reclaim the Salesforce Home Page
      • Add and Display Images for a Single Record
    • JavaScript Tutorials
      • Using Skuid with JavaScript: A Primer
  • Legal terms and conditions
  • Skuid SFX Evaluation Guide
    • Overview​
      • What Is Skuid?
      • What are the benefits of Skuid?
      • How does Skuid maximize my Salesforce investment?
      • When is Skuid a good fit?
      • When is Skuid not a good fit?
      • Who uses Skuid?
      • What do customers say about us?
      • What steps does Skuid take to ensure compatibility with future Salesforce releases?
    • Developing Apps with Skuid​
      • The Scalable Kit for User Interface Design (Skuid)
        • Models
        • UI components
        • The Action Framework
        • Display Logic
        • Event System
        • Design System Studio
        • Code Extension
      • The Salesforce Ecosystem​
        • Does Skuid work with Lightning?
        • Does Skuid work with Salesforce Experience Cloud?
        • Is Skuid compatible with other AppExchange apps?
        • What Salesforce products and services does Skuid support?
      • Mobile
    • App Lifecycle Management​
      • Can I build with Skuid in different production environments?
      • Can my entire team develop with Skuid?
      • How does Skuid fit into my company’s CI/CD practices?
      • Analytics​
        • Does Skuid work with my third-party analytics software?
        • Does Skuid work with Einstein Analytics?
        • Build your own analytics tracker with Skuid
    • Architecture​
      • Skuid SFX Architecture
        • How does Skuid work?
        • How does Skuid get data and does Skuid consume API calls?
        • Is Skuid limited to one sObject or Record Type per page?
        • Does my Salesforce application have to be built completely from Skuid?
        • How does Skuid work with Salesforce Process automation and validation?
      • Lightning​
        • How do Skuid pages work in Lightning?
        • Where else in Lightning can I use Skuid?
        • Can I use Lightning components in Skuid pages?
      • Salesforce Classic​
        • How do Skuid pages work in Salesforce Classic?
        • Where else in Classic can I use Skuid?
        • What happens if I need to migrate to Lightning after building with Skuid in Classic?
    • Data​
      • Skuid and the Salesforce data model
      • Can Skuid Access…​
        • Objects?
        • Object Relationships?
        • Salesforce field types?
        • Custom settings?
        • Custom metadata?
        • Big Objects?
        • External Objects?
        • Other Salesforce Orgs?
    • Security​
      • Does Skuid store my Salesforce or third-party data?
      • How does Skuid work with Salesforce permission sets, sharing rules, field-level security, and profiles?
      • Does Skuid override Salesforce validation rules and error messages?
      • What security certifications does Skuid have?
    • Performance​
      • Does Skuid have data limits?
      • How can Skuid builders optimize for page performance?

In This Topic

  • Legal terms and conditions
    • Terms of use
    • Trademarks

Legal terms and conditions¶

Use these links to get the most current information:

  • About Skuid
  • Terms of service

Terms of use¶

Information in this document, including URL and other Internet Web site references, is subject to change without notice. Unless otherwise noted, the companies, organizations, products, domain names, e-mail addresses, logos, people, places, and events depicted in examples herein are fictitious. No association with any real company, organization, product, domain name, e-mail address, logo, person, place, or event is intended or should be inferred. Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under copyright, no part of this document may be reproduced, stored in or introduced into a retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or for any purpose, without the express written permission of Skuid.

Skuid may have patents, patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this document. Except as expressly provided in any written license agreement from Skuid, the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other intellectual property.

Trademarks¶

Skuid (including Skuid NLX and Skuid SFX), skuidify, and the Skuid logo are registered trademarks of Skuid, Inc., registered in the United States.

Additionally:

  • Apple, iPhone, and iPad are trademarks of Apple, Inc.
  • AWS, AWS Dynamo, AWS SNS, AWS S3, and Amazon Web Services are trademarks of Amazon.com, Inc.
  • Box is the trademark of Box, Inc.
  • Dropbox is the trademark of Dropbox, Inc.
  • Google, G Suite, Google Drive, Google Docs, Google Calendar, and Android are trademarks of Alphabet, Inc.
  • Microsoft, Microsoft Dynamics, Microsoft Outlook, Microsoft OneDrive, Microsoft Sharepoint, and Microsoft Azure are registered trademarks of the Microsoft Corporation.
  • Salesforce, Salesforce Lightning Experience, and Salesforce1 are trademarks of Salesforce.com, Inc.
  • SAP is the trademark of SAP SE.
  • Slack is the trademark of Slack Technologies.

All other trademarks are the property of their respective owners.

© 2017 Skuid, Inc. All rights reserved.

Back to top

Last updated on Mar 22, 2023.

Documentation

  • Concepts
  • Reference
  • Site Administration
  • Tutorials
  • Release Notes

Resources

  • Skuid Skool
  • Community
  • Support
  • Contact
  • Skuid
Start building for free

© 2023 Skuid, Inc.

Terms of Use | Privacy Policy | Legal Terms and Conditions