Tour of Skuid Platform

image0

Compose

Hover over Compose to create a new page or see a list of Skuid pages.

Note

If you click New Page, you will not be able to use a page template until you set up a data source, since Skuid Platform has no built-in data to reference!

Theme

Click Theme to open a list of available themes, which are editable using the Theme Composer. Themes are stored as files within the Skuid site.

Apps

Apps are collections of Skuid pages. Built by bundling together routes—URLs that point to specific Skuid pages—apps structure a cohesive experience based on end users and their use cases. Listed as subdirectories beneath the Skuid site, apps allow users to find the appropriate Skuid pages based on logical URL paths.

Best Practices:

  • Create apps by use case and create routes within them for Skuid pages related to that use case.
  • Give routes intuitive names so it’s easier to find them in the routes list.

Note

Despite the name, a “route” is not an A->B path to a page or used for navigation in any way; it’s a URL that points to a specific page.

Here’s an example using a marketing app. When designing the app, there might be Skuid pages for the following:

  • Marketing dashboard with key metrics
  • Marketing calendar
  • Marketing product orders
  • Marketing collateral and customer data

To implement this within Skuid, create a new app called “Marketing.” This app’s base URL would be “/marketing,” which would point to the Skuid marketing dashboard or homepage. Then create the following routes:

  • /calendar, which would point to the calendar Skuid page
  • /swag, which would point to the product orders Skuid page
  • /data, which would point to the marketing data Skuid page

So, if end users navigated to the calendar page within the marketing app, they would arrive at a URL similar to …

glacier-us-trial.skuidsite.com/marketing/calendar.

Note

Apps are an important feature and are the key to an intuitive UX for end users. When using Skuid, consider the routes and design of apps as early as possible, and create Skuid pages to suit the needs of the target users.

Files

Files lets end users upload static content (such as images, JavaScript, or CSS libraries) to be used within Skuid. Uploaded files can be selected from the App Composer and used as an image source for Image and Wrapper components. Files can also be used as a source for JavaScript and CSS resources. Finally, themes and component packs are also stored in the Files tab.

To upload files, click Files from the navigation bar, then click Upload new File.

Configure

The Configure page allow you to configure available data sources and their authentication providers, add and manage end users, manage component packs, and review login history. This page should be the first one you visit, since Skuid Platform will have no data to access until you create a data source.

In addition to tabs that manage users, profiles, and subscriptions, the Configure page has the following:

  • Data Sources:
    • Data source: View a list of current data sources, or click New Data Source to create a new one.
    • Authentication providers: See a list of current authentication providers or click New Authentication Provider to create a new one.
  • Site:
    • Profile: Basic settings for the site, name, and subdomain.
    • Locale: Set the geographic location, language, and timezone for the site.
    • Single Sign On: Enable SAML protocol for use with single sign-on authentication.
    • Certificates: Configure necessary security certificates and settings needed for the site.
    • Offline: Activate or deactivate offline mode, which determines whether Skuid saves model data and metadata in cache for use when apps and pages are offline. (Offline Mode is deactivated by default.) Two additional properties determine syncing behavior—automatic or manual—when the internet connection is restored.
      • Auto-Sync Offline Changes when Connected
      • Require Confirmation Before Sync
    • Security:
      • Frame Embedding Options: Provides one (or more) frame-ancestors or base URLs that apps from the current site can be loaded or iframed into.
      • IP Whitelist: Allows Skuid builders to restrict user logins to a set of permissioned IP addresses.
      • Session Options: Allows Skuid builders to set the session timeout for all users to 15 or 30 minutes, or 1, 2, 4, or 8 hours. Once sessions timeout, users need to provide credentials to log into the site again.
  • Component Packs:
    • View a list of installed component packs, or click Add Component Pack to import a new one.
  • Login History: Lists site login information.