Deploying Skuid from a Sandbox Org Building and testing Skuid in a sandbox org is a safe, easy way to customize your UX while avoiding the pitfalls of developing in a production org. Skuid pages and their resources can be packaged into static resources within Salesforce. This makes it easy to move your Skuid configuration from your sandbox to a different destination org. You’ll be completing three separate processes when you deploy your Skuid configuration while utilizing Skuid’s export and import feature. Warning:​ you need to do these processes in this order: 1. Packaging your Skuid pages​ and other configurations as ​static resources 2. Pushing those static resources ​from your sandbox org to your destination org using as an Outbound Change Set 3. Unpacking your Skuid pages​ and page assignments If you have a custom theme with your Skuid configuration, you’ll be exporting and importing that as well. Once all of your resources are in your destination org, you’ll just need to ensure you set your page overrides accordingly. Contents Contents Package your resources from your source org Step 1 (Optional): Group your pages inside a module In Salesforce In Skuid Step 2: Create a page pack from your selected pages If you've grouped your pages into a module If you have not grouped your pages in a module Step 3 (If applicable): Package your page assignments In Skuid Step 4 (If applicable): Export your theme In Skuid: Push Skuid resources to your destination org Step 1: Create a new outbound change set In Salesforce Step 2: Select the static resources you created for deployment Step 3: Upload your resources to your target org Unpack the Skuid resources inside your destination org Step 1 (Optional): Recreate your module Step 2: Unpack your Skuid pages In Skuid Step 3 (If applicable): Unpack your page assignments Step 4 (If applicable): Import your theme Deploying Skuid from a Sandbox Org
| 1 Step 5: Override list/view actions to redirect to your Skuid pages In Salesforce Additional Notes Deploying Skuid from a Sandbox Org
| 2 Package your resources from your source org Step 1 (Optional): Group your pages inside a module If you need to separate the pages you are deploying from other Skuid pages, you can organize them into a ​module​. Otherwise, proceed directly to ​Step 2​. In Salesforce 1. Enter your org’s Salesforce Setup. ○ If you’re currently in Skuid, you can do this by clicking your name to view your user menu and selecting ​Salesforce Setup​. 2. Navigate to or quick search for ​Create​>​Objects​. 3. Click the ​Page​ object that is associated with the Skuid Installed Package (see the Installed Package column). 4. In the Custom Fields & Relationships section, click the ​Module​ field to configure. 5. In the Picklist Values section, click ​New​. 6. Enter an appropriate name for your module (in this example we’ll use “Current”) 7. Click ​Save​. With your module created, you’ll now need to associate your pages with that module. In Skuid 1.
2.
3.
4.
5.
6.
Click ​Compose​>​All Pages​. Select the checkbox beside the pages you’ll be including in your module. Click ​Mass Update Selected Rows​. From the popup, select the module you just created. Click ​Apply​. Click ​Save​. Step 2: Create a page pack from your selected pages Whether you use modules or not, you’ll need to create a static resource containing your pages: If you've grouped your pages into a module 1. From Skuid, click ​Compose​>​All Pages​. 2. Click the down arrow beside ​Create New Page​ and select ​Package Pages in Module. Deploying Skuid from a Sandbox Org
| 3 3. In the Package Pages popup, select the appropriate module. 4. Click Package. If you have NOT grouped your pages in a module Alternatively, you can manually select Skuid pages and package them without leaving your Pages list: 1. From the Skuid app, click ​Compose​>​All Pages​. 2. Click the checkbox beside any pages you wish to deploy. 3. Click the down arrow beside ​Mass Update Selected Rows​ and select ​Build Page Pack​. 4. In the Build Page Pack popup, enter an appropriate name and description for your pages. 5. Click ​Build Page Pack​. Skuid will let you know the packaging of your pages was successful. Your static resource will have a similar name to the module it was created from: packaging a module named “Current”, for example, will create “CurrentPages” as a static resource. Step 3 (If applicable): Package your page assignments Nᴏᴛᴇ​: If you utilize page assignments in your sandbox, these will not be packaged with your Skuid pages. Instead, you must package them as a separate external resource, and push that using a change set. (Thankfully, this is an easy process!) In Skuid 1. Click ​Deploy​. 2. Select the page assignments relevant to your deployment: ○ If using only a selection of your page assignments: ■ Select your relevant page assignments, and the Mass Update Selected Rows button will appear. ■ Click the down arrow and select ​Package Selected Page Assignments​. ■ Enter an appropriate name and description for your static resource. ■ Click ​Build Page Assignment​ Pack. ○ If using all of your page assignments: ■ Click the down arrow beside​ Add new Page Assignments​, and select ​Package all Page Assignments​. ■ In the Packaging Options tab, keep the default “All” and “Include All” selections. Deploying Skuid from a Sandbox Org
| 4 ■ In the Choose Pack tab, give the page assignments a name and description that make sense for your deployment. ■ Click ​Package all Page Assignments​. You now have a static resource, with a name you will remember as you move through the next stages of deployment. Step 4 (If applicable): Export your theme If you’ve customized the theme used in your Skuid pages, you’ll want to export this as well. While themes are not packaged as a static resource, Skuid can still export them. In Skuid: 1. Click ​Theme​ at the top navigation.Locate the theme you would like to move and click Export in the column beside the theme’s name. This will generate a zip file that you will be uploading to your destination org later. 2. Save the zipped theme file to a location you can find on your computer. Push Skuid resources to your destination org In this step, you’ll be using an Outbound Change Set. Change sets are a useful way to push a variety of resources and metadata from one Salesforce org to another. In this case, you’ll be pushing the static resources containing your Skuid pages and (if applicable) your page assignments. Step 1: Create a new outbound change set
In Salesforce 1. Navigate to or quick search for Deploy>Outbound Change Sets. Deploying Skuid from a Sandbox Org
| 5 2. Click New.
3. Give the package a name and description that clearly identifies your change set and explains the change set’s purpose. 4. Click Save. Step 2: Select the static resources you created for deployment 1. In the Change Set Components area, click Add. Deploying Skuid from a Sandbox Org
| 6 2. Add the “Pages” static resource and the “Page Assignments” static resource you created in ​Package Your Resources​ (above).
3. Click Add To Change Set. Nᴏᴛᴇ: ​If this is the first time you are migrating to a new environment, or there are changes to these resources, you must include the resources for images, VisualForce pages used with overrides, page level CSS customizations, and any JavaScript you stored as a static resource. Deploying Skuid from a Sandbox Org
| 7 Step 3: Upload your resources to your target org 1. In the Change Set Detail pane, click ​Upload​.
2. On the next screen, choose your Target Organization and click ​Upload again. Nᴏᴛᴇ​: Some Visualforce pages that are built in the sandbox may be on a newer API version than what is in the destination org. These will have to be manually copied and pasted. Unpack the Skuid resources inside your destination org Step 1 (Optional): Recreate your module If your pages are grouped using a module, you must recreate your module in your destination org so that the page grouping is retained when the pages are unpacked. Simply the follow steps outlined in ​Group your pages inside a module Deploying Skuid from a Sandbox Org
| 8 Step 2: Unpack your Skuid pages Now that your module is created, and your static resources have been pushed into your destination org, you can actually unpack the Skuid page pack. In Skuid 1. Navigate to ​Compose​>​All Pages​. 2. Click the down arrow beside ​Create New Page​ and select ​Unpack Pages from Page Pack​. 3. Click the checkbox beside the page pack you created. 4. Click ​Unpack​. Once the pages are unpacked, you can use the Module filter to see the list of pages that you just added. Step 3 (If applicable): Unpack your page assignments 1. Click ​Deploy​ in the Skuid navigation bar. 2. Click the down arrow beside​ Add New Page Assignment​ and select Unpack Page Assignments from Pack(s)​. 3. Click the checkbox beside your page assignment static resource. 4. Click ​Unpack​. Step 4 (If applicable): Import your theme 1.
2.
3.
4.
Click ​Theme​ in the Skuid navigation bar. Click the down arrow beside ​Create New Theme​ and select ​Import Theme​. Click ​Theme File​ and locate the file you saved onto your computer. Confirm your selection. Nᴏᴛᴇ​: If this is the first time you’ve imported the theme, you must make sure that the imported theme EXACTLY matches what is in the original sandbox org, or it will not work. Step 5: Override list/view actions to redirect to your Skuid pages Now that all of your Skuid pages (and other resources) are inside your destination org, it’s time to make sure your overrides work as expected. You’ll need to ensure overrides set at the Object level in your sandbox match those in your production org. Deploying Skuid from a Sandbox Org
| 9 In Salesforce Locate the objects that have actions you want to override and check that the configuration of the Buttons, Links, and Actions in your production org matches the configuration of those elements in your sandbox org. For more on how to do this, read ​Overriding your Salesforce UI with Skuid​. Note​: Each user must have a valid subscription and the proper security permissions to access Skuid pages and resources. Additional Notes ● More complex configuration items within Skuid—such as ​data sources, component packs, auto­assignment rules​, and others—must be reconfigured manually in the production org. If you utilize these features, thoroughly test your page’s functionality in the production org to be sure that they are working properly. ● If you use a master page for your deployed pages, ​ensure that the master page is included in the page pack that you move​ using a change set. Failure to do so may result in broken child pages in the production org. ● While this process will work when deploying Skuid from a sandbox to that sandbox’s production org, change sets ​will not work when deploying to entirely separate orgs. For these types of deployments, you must use the Force.com Migration Tool​ and ​Apache’s Ant build tool​. Deploying Skuid from a Sandbox Org
| 10