--- alias: user-guide-uipages-create-uipage description: "Create UI pages by defining name, type, layout, and scope within the system administration interface" --- # Create UI Page :lock: UIPage.**Create** By accessing the **UI Pages** in **Administration**, the system displays the available **UI Pages**. To create a **UI Page** you need to select **New** on the top ribbon and complete the information as described below. ## Sequence of Steps {% include-markdown 'includes/pages/info_creating_versioned_entities.md' %} ## Step 1: Change Set {% include-markdown 'includes/pages/step_one_versioned_entities.md' %} ![uipage_create1][uipage_create1] ## Step 2: General Data 1. Enter the **UI Page** name. 2. Optionally, enter the **Revision**. 3. Optionally, enter the **Description**. 4. Select the **UI Type**: * **Cluster** - a special type of page that organizes a navigation menu on the left and an information panel on the right, useful for elements with multiple layers of information. * **Page** - an organized set of elements that allow you to interact with the system. * **Step** - a specific step to be used in UI Pages of type Wizard. * **Wizard** - a set of steps that prepares data to call a system action. !!! info For more information on UI Types Step and Wizard, see [[user-guide-uipages-design#creating-steps-and-wizards|Creating Steps and Wizards]]. 5. The **Folder** is set to `\Dashboards` by default. 6. Select the **Scope** accordingly. For more information on the types of Scope, see [[user-guide-uipages-create-uipage#scope|Scope]]. * **Asset Dashboard** * **Entity Type** * **General** * **Menu Entry** !!! warning If the scope is Entity Type, the UI Page must include a property named `EntityTypeId` with its Source set to `UrlParameter` and the Required flag enabled (`true`). This can be configured in the Properties tab of the Page Builder settings wizard. For more information, see [[user-guide-uipages-design#properties]]. 7. Optionally, select the **Layout**: * **Desktop (1536 x 864)** * **Desktop (1920 x 1080)** * **Laptop (1280 x 720)** * **Laptop (1366 x 768)** * **Phone (360 x 800)** * **Phone (390 x 844)** * **Phone (414 x 896)** * **Tablet (1280 x 800)** * **Tablet (768 x 1024)** !!! info You can customize the default values for the Layouts or add new ones by editing the fields in the [[uipagelayouts-gt]] Generic Table. 8. Optionally, enter a comment. 9. Select **Create**. ![Screenshot showing a user interface page creation wizard with options for selecting data.](images/uipage_create2.png) ## After Creation After successfully creating the **UI Page**, you can start designing your new **UI Page** by dragging and dropping the widgets on the left into the desired areas. For more information, see [[user-guide-uipages-design]]. ![Screenshot showing a UI page creation interface with widgets on the left side and empty areas for dragging and dropping.](images/uipage_create6.png) Optionally, you can select **Settings** on the top bar to access the **Page Builder Settings** and its tabs: **Definition**, **Layouts**, **Properties**, **Action Buttons**, **Tasks** and **Links**. For more information, see [[user-guide-uipages-design#page-builder-settings|Page Builder Settings]]. ![Screenshot showing a page with various settings options, including Definition, Layouts, Properties, Action Buttons, Tasks, and more.](images/uipage_settings_wizard.png) After exiting the Edit mode, you can access the following buttons on the top ribbon: * New: Revision, Version * Refresh * Edit * Lock * More: * General: Clone, Terminate, Change Change Set, Mark Revision Obsolete, Export * Settings: Save, Reset * UI Page: New * Show Inactive Actions (show/hide action) ![uipage_create5][uipage_create5] ## Scope Scopes allow you to use the **UI Page** in the specific context defined by that scope. There are four types of **Scope**: * Asset Dashboards * Entity Type * General * Menu Entry ![Diagram showing a screenshot of the scope settings menu.](images/scope1.png) Additionally, the **Entity Type** and **Menu Entry** scopes allows you to **Pin To Quick Access**: === "Menu Entry" ![Screenshot showing the "Scope" menu entry options.](images/scope_menu_entry.png) === "Entity Type" ![Screenshot showing the Entity Type and Menu Entry scopes in the He Gea U Pane.](images/scope_entity_entry.png) This means that quick access should be visible in the **Dashboards** section of the menu entry for the **Menu Entry** scope, or under **View** for the **Entity Type** scope: === "Menu Entry" ![Screenshot showing a menu entry icon.](images/scope_menu_entry_icon.png) === "Entity Type" ![Screenshot showing a dashboard with quick access options in the Scope settings.](images/scope_entity_type.png) !!! note You can only use the **UI Page** if it is **Effective**. Therefore, for the quick access to be visible in the **Dashboards** you must approve the **Change Set** and the **Universal State** must be **Effective**. [uipage_create1]: images/uipage_create1.png [uipage_create5]: images/uipage_create5.png