Skip to main content

Enabling Design Studio

Design Studio is activated per tenant through a platform-level configuration. Once enabled, the Design Studio option appears in the Admin panel and all client-facing pages switch to the new template-driven layouts.

TL;DR

Set ProtrakEnableDesignStudio = true in Platform Settings → refresh browser → done.

At a Glance​

┌───────────────────────────────────────────────────────────────────────┐
│                    ENABLING DESIGN STUDIO                             │
│                                                                       │
│  Setting exists?                                                      │
│      │                                                                │
│      ├── YES ──► Client → Platform Settings → Toggle ON → Refresh     │
│      │                                                                │
│      └── NO ───► Step 1: Create boolean attribute                     │
│                  Step 2: Add to PlatformSetting type + view layout    │
│                  Step 3: Toggle ON from client → Refresh              │
│                                                                       │
│  Result: Admin gets Design Studio button │ Client gets V2 layouts     │
└───────────────────────────────────────────────────────────────────────┘

Who Enables It​

Anyone with access to the Protrak admin application can enable Design Studio — no special permissions beyond admin app access are required.

The Setting​

Design Studio is controlled by a platform-level boolean attribute named ProtrakEnableDesignStudio. It lives inside the PlatformSetting type in your tenant's configuration.

  • Scope: tenant-wide — applies to all users and all pages
  • When it takes effect: immediately on next browser refresh — no redeployment needed

How to Enable​

If the setting already exists​

  1. Go to Client → Platform Settings
  2. Find the Enable Design Studio toggle
  3. Switch it on
  4. Refresh your browser — Design Studio is now active

If the setting has not been configured yet​

You will need to set it up once before you can use the toggle. Follow these steps:

Step 1 — Create the boolean attribute

  1. Go to Admin → Attributes
  2. Add a new attribute with:
    • Name: ProtrakEnableDesignStudio
    • Type: Boolean

Step 2 — Add the attribute to PlatformSetting layouts

  1. Add the new attribute to the Admin → Types → PlatformSetting
  2. Also add it to the View Layout of PlatformSetting so it is visible and editable on the client platform settings page

Step 3 — Enable it from the Client app

  1. Go to client app → Platform Settings type → View layout
  2. The Enable Design Studio toggle now appears
  3. Switch it on
  4. Refresh your browser — Design Studio is now active

What Changes After Enabling​

In the Admin Panel​

  • A Design Studio button appears in the Admin toolbar
  • Full access to the three modules: Page Templates, Type Widgets, and Forms

In the Client Application​

All page layouts switch from the classic server-configured layouts to Design Studio template-driven layouts:

PageSwitches to
Home PageGrid-based template layout (configured in Design Studio)
Type DashboardTemplate-driven dashboard with tab switching
Type ReportsTemplate-driven report layout
Instance ViewTemplate-driven layout with a Form widget plus tabbed panels for Relation, standard View, and Custom widgets
Instance EditTemplate-driven form layout
Instance CreateTemplate-driven form layout

Template Setup is Required​

Enable ≠ Ready

Enabling the setting is just step one. Until you create templates in Design Studio, the new layout pages will show a "no template configured" state.

Build order after enabling:

1. Query Definitions  ──►  2. Type Widgets  ──►  3. Forms  ──►  4. Page Templates
       (data)              (dashboard/report)    (fields)        (final layout)

→ Follow the Design Studio Workflow for a step-by-step guide, or see the Admin Configuration Guide for a detailed walkthrough.

Disabling Design Studio​

Set ProtrakEnableDesignStudio back to false in platform settings. On next browser refresh, all pages revert to classic layouts.

Nothing is deleted

All Design Studio templates are preserved — they will be available again if you re-enable. Nothing is lost.

Export / Import Between Environments​

Both environments must have Design Studio enabled

Importing a Design Studio export into a tenant where Design Studio is disabled may result in missing layout references.

When Design Studio is enabled, the Export Schema tool in Admin Settings includes Design Studio templates (Page Templates, Type Widgets, Forms) in the export package.

Next Steps​

What to do nextLink
Quick start — build your first templateDesign Studio Workflow
Detailed — understand the modules firstAdmin Configuration Guide