Upgrading Skuid SFX

To ensure you’re getting the latest features and improvements—while still maintaining proper lifecycle management—we’ve outlined some best practices for upgrading Skuid SFX. Read more to learn about this recommended process.

Already have your upgrade process down? See our releases page to find installation links.

Are you a new customer? See Installing Skuid SFX.

Note

Salesforce free trials are often the Professional edition, which isn’t supported in Skuid versions above Brooklyn. Group editions also aren’t supported in later versions of Skuid.

If using either Salesforce’s Group or Professional edition, you can only use previous versions of Skuid (Brooklyn or prior), which aren’t actively maintained.

Upgrade a sandbox

We always recommend upgrading SFX in a sandbox org before upgrading production orgs. This ensures that you can properly test your Skuid pages and fix any breaking changes without affecting your end users.

Install the upgrade

  1. Log in to the sandbox for your Salesforce org. The org you’re logged in to is where the upgrade installs, so make sure you’re logged out of any non-applicable orgs.

    Warning

    You can’t revert managed package upgrades in Salesforce. For example, accidentally upgrading production when you intended to upgrade a sandbox could cause breaking changes to appear in production—which can be costly to address. Always ensure you’re logged into the correct org.

  2. Prepare for potential issues with upgrading by reading the release notes in docs. Releases may include breaking changes to your Skuid pages, so plan for addressing any issues prior to upgrading.

  3. Go to the releases page.

  4. Under Skuid SFX, click Install. A modal appears.

    Note

    This installs the latest version of SFX. For previous versions, scroll to the Release notes: SFX section of the releases page. Only supported versions are available for download.

    From here, navigate to the release you want to upgrade to. Under the title, select the Sandbox install link.

  5. Click Install to Sandbox.

  6. If prompted, log into your Salesforce account for the sandbox. A new screen appears.

  7. Select Install for Admins Only.

  8. Click Upgrade. SFX begins upgrading. This may take awhile—you’ll receive an email when the upgrade is complete.

Manually update design systems

When new default design systems are installed with each Skuid upgrade, custom design systems need to be updated to match. That’s why you’ll need to use the Update all button to reconcile any updates to the default design system with the custom design system based upon it. For more info, see the Design System Studio doc.

After your upgrade has installed, update your design systems prior to testing:

  1. In the sandbox, navigate to Design Systems.
  2. Click Update all.

Test in the sandbox

Run QA and UAT

After upgrading your sandbox, it’s time to thoroughly test your pages—paying particular attention to any breakages in your common workflows.

  1. Run quality assurance (QA) tests. This includes testing critical functionality for errors—often with scripted tests that are run automatically. To learn more about automating testing, see the Automated Testing doc.
  2. Run user acceptance testing (UAT). This includes testing workflows with users to ensure that it meets their expectations. Your end users are the best possible candidates to ensure your pages meet their needs and properly address all use cases.

Test all custom code (if applicable)

Always thoroughly test pages that use custom code. While rare, you may need to replace deprecated APIs after an update. Check the Deprecated in Skuid doc to identify deprecated APIs and features. Note any alternatives for deprecated APIs or features and work with your code-savvy builders to modify your custom code accordingly.

Upgrade production

If—after thorough testing—you’re positive your org functions as expected, follow these steps:

Install the upgrade to production

  1. Log in to production for your Salesforce org. The org you’re logged in to is where the upgrade installs, so make sure you’re logged out of any non-applicable orgs.

    Warning

    You can’t revert managed package upgrades in Salesforce. For example, accidentally upgrading production when you intended to upgrade a sandbox could cause breaking changes to appear in production—which can be costly to address. Always ensure you’re logged into the correct org.

  2. Go to the releases page.

  3. Under Skuid SFX, click Install. A modal appears.

  4. Click Install to Production.

  5. If prompted, log into your Salesforce account for production. A new screen appears.

  6. Select Install for Admins Only.

  7. Click Upgrade. SFX begins upgrading. This may take awhile—you’ll receive an email when the upgrade is complete.

Manually update any design systems

After your upgrade has installed, you need to manually update your design systems to prevent styling issues:

  1. Navigate to Design Systems.
  2. Click Update all.

For more info, see the Design System Studio doc.

Deploy changes from the sandbox to production (if applicable)

If you didn’t make changes to the sandbox to work with the upgrade, you can skip this step.

If you did make changes (updated code or edited pages), you’ll need to deploy changes from the sandbox by migrating any updated code and Skuid pages to production through a change set. We recommend performing this step immediately following the production upgrade. If you don’t deploy changes immediately, you may end up with issues in production.

Troubleshooting

I receive a “data storage limit” error when attempting to upgrade. [[]]

It’s possible to see this error when upgrading:

Your company currently has exceeded its data storage limits including an extra overflow buffer. Per our terms and conditions, we cannot permit additional data creation within our system until your company first reduces its current data storage. Please contact your company's salesforce.com administrator to resolve this. We apologize for any inconvenience this may cause.

This error is caused by a static resource storage limit. By default, an organization can have up to 250 MB of static resources in total.

To resolve this error, you must remove static resources until you are under the 250 MB limit.

Getting help

If you’re encountering issues, you can get help from other Skuid builders by starting a community post. Enterprise, Premium, Growth, and Essential Support customers also have the option to submit a ticket in the support portal.