Skip to content
View as markdown Ask ChatGPT Ask Claude

Create UI Page#

🔒 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#

There are several ways to create a new versioned object. Depending on the level, follow these steps to get started:

  • Entity - in the landing page of this entity type in the Business Data menu or in the details page of an existing entity of the same type, select New on the top ribbon. For more information, see Creating Entity Objects.
  • Revision - if you want to create a new revision, go to the New dropdown button on the top ribbon and select Revision. For more information, see Revisions.
  • Version - if you want to create a version associated to an existing revision, go to the New dropdown button on the top ribbon and select Version. For more information, see Versions.

Step 1: Change Set#

  1. Choose an existing Change Set or select Create to create a new Change Set. If configured to support implicit Change Sets, it is also possible to check the Use Automatic Change Set option.
  2. Optionally, select an Approval Role.
  3. Optionally, set the Make Change Set Items Effective on Approval to true so that the Change Set items become effective when the Change Set is approved.

Info

For more information, see Create Change Set.

Create UI Page with a change set.

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 Creating Steps and Wizards.

  5. The Folder is set to \Dashboards by default.

  6. Select the Scope accordingly.

    • Entity Type - use this scope for pages that you want to associate with an Entity Type. For more information, see Entity Type Scope.
    • General - use this scope for general purpose pages. For more information, see General Scope.
    • Menu Entry - use this scope for pages that you want to associate with a Menu Entry. For more information, see Menu Entry Scope.
    • Workspace - use this scope for pages that you want to associate with a Workspace. For more information, see Workspace Scope.

    Info

    • To understand where you can access the created page according to the selected scope, see Scopes.
    • Add properties to a UI Page in the Properties tab of the Page Builder settings wizard. For more information, see Design UI Page.

  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 Generic Table.

  8. Optionally, enter a comment.

  9. Select Create.

Screenshot showing a user interface page creation wizard with options for selecting data.

Note

You can only use a UI Page with Universal State set to Effective. Approve the Change Set before using any UI Page.

After Creation#

After successfully creating the UI Page, start designing your new UI Page. Drag and drop the widgets from the widget panel on the left into the desired areas. For more information, see Design UI Page.

If AI is configured for the environment, you can generate an initial UI Page structure from a natural language prompt. For more information, see Generate UI Pages with AI.

Screenshot showing a UI page creation interface with widgets on the left side and empty areas for dragging and dropping.

Optionally, select Settings on the top bar to define the UI Page settings. For more information, see Page Builder Settings.

Screenshot showing a page with various settings options, including Definition, Layouts, Properties, Action Buttons, Tasks, and more.

After finishing the design of the UI Page, request its approval to start using it.

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