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. Optionally, Search or Create a Change Set.
2. If you enter a Change Set, the Approval Role is available and it is also optional.
3. Optionally, enter a comment.
4. Select Next to continue.

Step 2: General Data#

1. Enter the UI Page name.
2. Optionally, enter the Revision.
3. Optionally, enter the Description.
4. Optionally, enter the Data Group.

5. 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.

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

7. Select the Scope accordingly:

   • 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 Design UI Page.

8. Optionally, enter a comment.

9. Select Create.

After Creation#

After successfully creating the UI Page, the system will display an empty page as the UI Page is not configured yet. To configure the newly created UI Page, you need to select Edit as seen in the image below:

The top ribbon displays the following buttons:

• 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)

Now you can start designing your new UI Page by dragging and dropping the widgets on the right into the desired areas:

Optionally, you can select Settings on the top bar to access the Page Builder Settings and its tabs: Definition, Layouts, Properties, Action Buttons, Data Sources and Links. For more information, see Page Builder Settings.

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

Additionally, the Entity Type and Menu Entry scopes allows you to Pin To Quick Access:

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: