---
alias: user-guide-uipages-workspaces
---

# Workspace Scope

## Overview

The context in which a **UI Page** can be used is determined by its Scope. The **Workspace** scope allows you to create a curated working environment tailored to a specific role, responsibility, or operational context. In this case, the UI Type must be set to Page and the system will set the Entity Type as **Workgroup**.

![scope Workspaces](../images/scope_workspace.png)

**Workspaces** provide out-of-the-box views and dashboards that are aligned with common manufacturing scenarios. At the same time, they remain configurable, allowing you to adapt and extend them to meet site-specific or process-specific needs.

Each **Workspace** can include one or more **UI Pages** (such as dashboards or operational views) and is designed to present:

* Only the views relevant to the user’s tasks;
* Only the data meaningful within the user’s operational context.

## Setting up a Workspace

To create a **Workspace**, follow the instructions described in [[user-guide-uipages-create-uipage]] and set the scope to **Workspace**.

![create workspace example](../images/create_workspace_quality.png)

After creating a **UI Page** with **Workspace** scope, you can customize the page by selecting the appropriate [[user-guide-uipage-widgets-uisystem-widgets-index]] or configuring the required [[user-guide-uipage-system-tasks-index]]. For more information, see [[user-guide-uipages-design]].

{% include-markdown 'includes/pages/ui_page_admonition.md' %}

### Default Properties

When the scope is set to **Workspaces**, the Properties tab of the **UI Page** settings automatically includes a Workgroup Id and a User Id properties with the following characteristics by default:

* Source set to `UrlParameter`;
* Required flag enabled (`true`).

=== "Workgroup Id"

    ![Workgroup Id settings](../images/uipage_settings_workgroup_id.png)

=== "User Id"

    ![user Id settings](../images/uipage_settings_user_id.png)

This configuration ensures that the **UI Page** always receives the entity identifier from the navigation context. For more information, see [[user-guide-uipages-design#properties]].

### Required Configurations

For the **Workspaces** to be available on the :core-static-home-sm: icon, follow the steps described below:

1. In the **User Profile**, open the **User Settings** and select the desired **UI Page** as the Home Page.

    ![create workspace example](../images/configure_homepage_workspace.png)

2. Create the required **Workgroups** by following the instructions in [[user-guide-create-workgroup]]. The examples below illustrate a typical **Workgroup** configuration.

    === "Create Workgroup"

        ![create workgroup example](../images/create_workgroup_quality.png)

    === "Create Workgroup Elements"

        ![create workgroup example](../images/create_workgroup_quality_areas.png)

3. Assign **Workgroups** to the **User** by selecting the target **User** and adding the necessary **Workgroups**. For more information, see [[user-guide-security-users#managing-user-workgroups|Managing User Workgroups]]. An example is shown below.

    ![manage workgroup example](../images/manage_workgroups_quality.png)

4. Associate each **Workspace** to the appropriate **Role**, as described in [[user-guide-security-roles#managing-role-workspaces|Managing Role Workspaces]].

    ![manage workspace example](../images/manage_workspaces_quality.png)

5. Ensure that the selected **User** has all the required **Roles** assigned. For more information, see [[user-guide-security-users#assigning-roles-to-a-user| Assigning Roles to a User]].

    ![Roles assigned to user](../images/roles_assigned_to_user.png)

After executing these steps, the **Workspace** configuration is complete.

## Viewing/Switching Workspaces

To provide quick access to role-specific views, the Home Page displays a dropdown listing all Workspaces configured for the logged-in user. After signing in, you can immediately see the available Workspaces and switch between them at any time, regardless of the current tab, by selecting the :core-static-home-sm: icon.

![view workspaces](../images/view_workspaces.png)

The :core-static-home-sm: dropdown displays:

* The **UI Page** selected as the Home Page, identified by the :core-static-home-sm: icon.
* Each **Workgroup** (for example, `Baking Lines`) and its associated **Workspaces**, identified by the :core-static-bringtofront-sm: icon. The default **Workspaces** are marked with `(default)` and the active **Workspace** is indicated by the :material-circle:{ class="twemoji green-icon" } icon.

Selecting a **Workspace** from this list immediately switches the context to the chosen Workspace and updates the displayed dashboards accordingly.

## Other Workspace Options

Although **Workspaces** and **Workgroups** can be marked as default for specific users and roles, some scenarios require different default Home Pages depending on the device used to access the MES (for example, desktop terminals versus shop-floor stations).

To support these scenarios, configure the [[workspacecontext-st]] Smart Table. This table allows you to define a preferred Workspace based on the access context, ensuring that the most appropriate Home Page is displayed immediately after login.

![add workspace context](../images/add_workspace_context.png)

### Configuring Widgets with Templates

A **UI Page** with the **Workspace** scope receives a **Workgroup** as its context. Supported widgets provide templates that use this context to create common Workspace configurations.

For example, **Filter**, **Filter Tabs**, and **Grid** widgets provide templates for configuring views related to the selected **Workgroup**. The templates configure widget settings and, where required, data sources and links.

For setup instructions, see the template sections for [[user-guide-uipage-widgets-filter#using-templates|Filter]], [[user-guide-uipage-widgets-filter-tabs#using-templates|Filter Tabs]], and [[user-guide-uipage-widgets-grid#using-templates|Grid]] widgets.