Modules

Modules are a way to group related pages, similar to folders. Every page can be linked to a single module. Pages can then be filtered by module on the Pages screen or quickly bundled into page packs.

Modules are also useful for extending Skuid applications with code, or distributing Skuid pages in an AppExchange package.

Note

  • The Skuid module contains pages necessary for Skuid, the managed package, to function. It is not meant to include user-created pages. You can’t make any changes to pages within the module.
  • Modules are only available on |skuid.name|.

Creating Modules

  1. In Salesforce Setup:
    • Classic: Navigate to Create > Objects.
    • Lightning: Navigate to the Object Manager.
  2. Click the Page object label.
  3. In the Custom Fields & Relationships (Classic) or Fields & Relationships (Lightning) section, click Module.
  4. In the Values section, click New.
  5. Enter the desired module name.
  6. Click Save.

Assigning Pages to Modules

Pages can only be assigned to one module. If you assign a page to a new module, it’ll be removed from its previous one. You can assign a page to a module within the Pages screen or within the Composer.

In the Pages screen:

  1. Click the dots-vertical More Options icon on the page’s row.
  2. Click Edit module.
  3. Select the module to assign the page to.
  4. Click Save.

In the Composer:

  1. Open the page you wish to assign in the App Composer.
  2. Within Page Properties, select the module within the Module picklist.
  3. Click Save.

Deploying Modules to Other Orgs

Because modules are picklist values on Skuid’s Page object, they will not automatically transfer to a new org when you move your pages. If a page is moved to an org where its module does not exist, it will function and retain its module information. However, you’ll still need to recreate missing modules in any orgs that you deploy to.

You can recreate modules manually or by deploying those picklist values in a change set. For more information about change sets, see Salesforce documentation.

(ISVs Only) Using Module Pages in Customer Orgs

Note

This section applies only to independent software vendors (ISVs) publishing a managed package that extends Skuid.

Because extension packages cannot add additional picklist values to a picklist owned by a base package, you’ll need to manually add your module’s name as a picklist value in whatever org your package is installed into.

For ISVs using Trialforce, all you have to do is to add your module name as a picklist value in your Trialforce template.