Import/Export Page Packs and Modules

You’ve made some amazing Skuid pages and you want to use those same pages in different orgs. You’ve too many pages to conveniently export/import them one at a time and you don’t want to export all of your pages because there will be too many to sort out when you import them into your other org. What should you do? We suggest use the Build Page Pack, Package Pages in Module, and Unpack Pages options to bundle the exact Skuid pages you want to move between orgs.

Note

Page Packs provide a simple way to manage moving pages between orgs. Page Packs do NOT move any of your Salesforce configuration from one org to another. This means that pages may behave differently in one org from another because you have different security permissions on objects, records, and fields. Furthermore, you may have completely different Profiles, Permission Sets, Sharing Rules, Organization-wide Defaults… within each org. Please be mindful of the different configuration in each org.

For Single Pages in your org (or a handful of pages): follow the instructions in the Share a Skuid Page between orgs tutorial.

For Multiple Pages in your org: follow the instructions in the Import/Export Page Packs and Page Assignments tutorial (described below).

In the following tutorial, we will cover how to export and import 1) multiple pages and 2) entire modules.

What is a Page Pack?

A Page Pack is a collection of pages (or even one page) stored as a Static Resource in your org. Once you have created a Page Pack, you can view the Page Pack by going to Setup > Develop > Static Resources and locating the content in the list of Static Resources.

The Page Pack is saved as a MIME (Multipurpose Internet Mail Extension) type of application/json. This is an important detail because Skuid cannot use the Unpack Pages when the Static Resource/Page Pack is NOT of the application/json file type.

Fantastic! I’ve got a bunch of killer pages in a Static Resource! So… what do I do with them now?

How to export multiple pages using a Page Pack

image0

  1. Click on Compose > All Pages.
  2. Select the pages you want to export by checking the box next to those pages. Note: the pages do not have to be from the same Module.
  3. Click on the drop down arrow in the Mass Update Selected Rows button.
  4. Select Build Page Pack.

image1

  1. If you are creating a brand new Skuid Page Pack, then leave the default Create New selected. If you have an existing Page Pack that you would like to rebuild with new, updated, or different pages, then see the image below.
  2. Enter a Name for your Page Pack.
  3. Optional: enter a Description for your Page Pack.
  4. Click on the Build Page Pack button.

image2

Use the Select Existing option to rebuild a previously created Page Pack. After selecting a Page Pack, click the Build Page Pack button. Note: this will overwrite the data of the previous Page Pack! If you have an inkling that you might want to save the previous Page Pack, then preserve this Page Pack by choosing to Create New instead.

image3

  1. After the status message clears, click on the close button to exit out of the Page Pack window.

How to import a Page Pack

image4

  1. Click on Compose > All Pages in the navigation bar.
  2. Click on the down arrow in the Create New Page button.
  3. Select the Unpack Pages from Page Pack button.

image5

  1. Select the Page Pack you want to import.
  2. Click on the Unpack button.

image6

  1. After the status message clears, click on the Unpack Page(s) window’s close button to return to the Pages tab.

image7

The pages you imported from the Page Pack will all show an identical Last Modified timestamp.

You’ve successfully imported a Page Pack. (Great work!) Using Page Packs is so much easier than moving pages one at a time through exporting/importing XML.

How to move your Page Pack between Salesforce orgs

There are 3 recommended ways to move your Page Pack(s) between Salesforce orgs. You are not limited to these methods as long as you respect the limitation that the Page Pack is saved as a Static Resource of the type: application/json (which will have a .json extension if you download it to your computer).

Option 1.

Use change sets to move your Page Pack from one org to another. I know I sound like a broken record, but your Page Pack is a Static Resource (application/json) and Static Resources can be moved with change sets.

Option 2.

Download the Page Pack and upload it into the appropriate org.

Go to your Static Resources and click on the View file link on the Static Resource detail page. The link will open in a new tab. Use the “Save Page As…”” browser feature to save the Page Pac as a filetype of .json.

Also, you can copy and paste the code in the page into a text/code editor and save that new document as a JSON file. Then create a new Static Resource in the destination org and select the .json file you recently created.

Option 3.

Use the Force.com IDE application to move your Page Pack from one org to another. This application uses Java and the Eclipse IDE to access resources on your Salesforce orgs. Its a powerful tool that can do much more than just moving Static Resources around!

Note

Page Packs provide a simple way to manage moving pages between orgs. Page Packs do NOT move any of your Salesforce configuration from one org to another. This means that pages may behave differently in one org from another because you have different security permissions on objects, records, and fields. Furthermore, you may have completely different Profiles, Permission Sets, Sharing Rules, Organization-wide Defaults… within each org. Please be mindful of the different configuration in each org!

How to export a module or modules

Think of a module as a grouping of Skuid pages. Modules are necessary for creating and using custom Skuid components as well as for the inclusion of Skuid pages in an AppExchange package.

If you are neither creating custom components nor building AppExchange packages, then you can still use modules to create a group of Skuid pages. For example, you may want to regularly export 25 Skuid pages. Rather than individually selecting all 25 pages each time you want to build a Page Pack, you can create a module for the those 25 pages. You will, then, use the Package Pages in Module feature instead of Page Packs.

Want to know more about modules? Check out this tutorial to learn how to build one!

image8

  1. Click on Compose > All Pages in the navigation bar.
  2. Click on the drop down arrow on the Create New Page button.
  3. Select either Package Pages in Module or Unpack Pages from Page Pack to save the universe! Well, maybe not. You can, at least, make your day a whole lot easier!

image9

  1. In the Package Pages in Module(s) window, select the module or modules you want to export.
  2. Once you’ve selected your module or modules, click on the Package button.

image10

The UI will be blocked while the process of packaging your pages is running. When completed, you should see a message similar to what is pictured above.

image11

For the curious, you can find the Page Pack in Static Resources. The Page Pack will be named after the module you exported. Click on the name to bring up the details of your Page Pack.

How to import a module or modules

image12

  1. Click on the drop down arrow on the Create New Page button.
  2. Select Unpack Pages from Page Pack.

image13

  1. Check the name of the Page Pack you would like to extract.

Note

You may want to refresh or reload the Pages tab before you click on Unpack Pages. If you just moved the Page Pack, then it may not yet be visible to the browser in its current state. Reload the page to make sure the resources are fresh.

  1. Click on the Unpack button.

image14

After the Success! message appears, you will be returned to the Unpack Page(s) window. Click on the X to close the window.

image15

  1. To easily view the pages you just imported, click on the Last Modified by Me TODAY filter.