Skip to main content

Upgrading Sprocket from Older Versions

This guide covers upgrading between major versions of Sprocket. Each version transition involves package file name changes that require specific upgrade steps.

Upgrading from Sprocket v4.x to v5.x​

When we released v5, we changed our product name from Sproket 365 to Sprocket 365 (notice the 'c'). This name change meant the package files required for upload to the App Catalog were renamed.

warning

We recommend you perform this upgrade after business hours. As the filename of the packages have changed, SharePoint doesn't clear cache and users may receive web part errors until server cache is cleared. The cache will clear itself within 8 hours.

Steps to upgrade from v4 to v5​

  1. Delete both the existing sproket-library.sppkg and sproket-365.sppkg files in the app catalog.
  2. Follow the Installing Sprocket steps.

If by accident you forgot to delete the v4 files (the Sproket packages without the 'c') before you tried to upload the v5 packages, you will see an error message when SharePoint tries to activate the package. Don't stress, it's not a big deal. Just delete all the Sprocket & Sproket packages and then follow the Installing Sprocket steps.

Upgrading from Sprocket v5.x to v6.x​

When we released v6, we changed from having to upload two package files (sprocket-library.sppkg and sprocket-365.sppkg) to the App Catalog to now only needing one sprocket-365.sppkg.

Steps to upgrade from v5 to v6​

  1. Delete both the existing sprocket-library.sppkg and sprocket-365.sppkg files in the app catalog.
  2. Follow the Installing Sprocket steps.

Upgrading from Sprocket v6 to v6.2+​

When we released v6.2, we changed our product file name from sprocket-365.sppkg to WA200006393.cab to align with Microsoft's App Store naming convention.

warning

We recommend you perform this upgrade after business hours. As the filename of the packages have changed, SharePoint doesn't clear cache and users may receive web part errors until server cache is cleared. The cache will clear itself within 8 hours.

Steps to upgrade from v6 to v6.2+​

  1. Delete the existing sprocket-365.sppkg file in the app catalog.
  2. Follow the Upgrading Sprocket steps. Note that you won't need to reapprove the API requests as these would have been done on your initial installation.

If by accident you forgot to delete the sprocket-365.sppkg file before you tried to upload the WA200006393.cab package, you will see an error message when SharePoint tries to activate the package. Don't stress, it's not a big deal. Just delete the Sprocket packages and then follow the Installing Sprocket steps.

General Upgrade Notes​

Important: Normally when you upgrade Sprocket you can just upload the new package files into the App Catalog and replace the files that were already uploaded. However, when package filenames change (as in the upgrades described above), uploading the newly named package files will not replace the existing ones. This is why deletion of old files is required first.

FAQs​

Will I lose any data when I upgrade?

No data will be lost when doing the upgrade. When uploading packages you are simply updating the Javascript files that are being executed.

Are there any additional fees to access the latest version?

No, all updates are included in your subscription.