A workspace allows you to safely develop and test site features in the Frosmo Control Panel without affecting the live content of your site. You can create both new features and edit existing ones in a workspace. You can also safely preview the workspace content on the site.

Workspaces in the Frosmo Platform

Figure: Workspaces in the Frosmo Platform

You can develop the following features in a workspace:

  • Modifications
  • Placements
  • Templates
  • Triggers

You can think of a workspace as a walled-off area of the Control Panel where you create and edit features without impacting your production content, that is, the features currently active on your site. When you add an existing feature, such as a modification, from production to a workspace, the Control Panel creates a duplicate of the feature in the workspace. In production, the original feature remains unaffected and continues to work as before for your visitors. The original feature is overwritten by its workplace counterpart only when you publish the workspace and explicitly choose to overwrite the original. You can also choose to publish the workplace feature as a new production feature instead of overwriting the original.

Workspaces are for anyone developing modifications and other features in the Control Panel.

Workspace with five features in development

Figure: Workspace with five features in development

For more information, see:

Workspace pros and cons

Developing features in a workspace offers several advantages:

  • You can safely develop features on a production server. Workspace features share the same server environment with production features, but in no way interfere with them. In other words, you do not need a separate development server to manage your in-development features.
  • You can safely test features on the site, in their actual context, before publishing them to production:
    • You can see any side effects to existing features, since the workspace preview loads the workspace features alongside the production features.
    • You can test the features on any browser or device.
    • You can share a workspace preview URL with others, so that they can independently test the features.
  • You can easily single out an implementation you want to develop and test before it's visible (or creates errors) to anyone outside the development team.

Workspaces also have a few limitations you need to be aware of:

  • Workspaces currently fully support only basic and cached modifications. You can add existing recommendations to a workspace, but you cannot get any automatically generated data for them, and you cannot create new ones in a workspace. If you want to test recommendations in a workspace, you must manually copy data to them. For more information about modification types, see Working with modifications.

Workspaces and test mode

You don't need to use test mode within a workspace, since workspaces are already separated from production and previewing their content is only accessible through a specific URL. Moreover, unless you specifically want to remove a modification from the production flow for testing purposes, there's no reason to use test mode over a workspace.

However, if you want to use test mode within a workspace, you can do so, as the two features are compatible. Enabling test mode for a workspace modification means that the modification is only visible to visitors who activate both test mode and workspace preview mode when browsing the site.

Workspaces and FProxy

 FProxy supports workspaces. You can use FProxy to develop and test workspace modifications the same way you would production modifications:

  • Download and develop workspace modification content locally on your computer.
  • Live-preview and hot-reload the downloaded modification content on your site in workspace preview mode.

The only difference to working with production modifications is that you cannot hot-reload changes to workspace modification content made in the Control Panel.

If a workspace modification uses a template, the template must also be in the workspace. If you try to download a workspace modification that uses a production template, FProxy throws an error and fails the download.

For more information about FProxy, see FProxy.

Where to go next

To get started with using workspaces, see Development workflow with workspaces.

If you're impatient and just want to get working on an example, see Example: Developing a site banner in a workspace.

  • No labels