Skip to content

Entity Details#

entityDetails

Overview#

The Entity Details widget displays a set of selected properties and attributes for a given entity instance. For example, it can be used to display the properties of a given Material or Resource. An example is shown below, where this widget is used to show the details of a Production Order.

entityDetailsExample

General Steps#

To use the Entity Details widget in a UI Page, follow the steps below:

  1. In any UI Page in Build mode, select the Entity Details from the widgets list located on the left side of the page; drag and drop to the desired place in the UI Page.
  2. Enter the Settings section of the widget through the three vertical dots.
  3. In the General tab, provide a name and a description for the widget. Use the toggle buttons to specify whether the widget should be visible, display the header, or allow full screen mode. Additionally, determine if the widget can be opened as an image in a new tab or exported as an image. You can also select the navigation mode behavior: open a new page, replace the current page, or none.

entityDetailsGeneral

Widget Customization#

  1. Optionally, in the Style tab, you can define a Border Width and Color as well as the Font and Font Size.

    Screenshot showing customization options for an entity's details page, including border width and color, font, and font size settings.

  2. In the Setup tab provide visualization and data related properties, such as:

    • Show Entity Icon - Choose if the widget displays the icon of the Entity selected. This option is set to true by default.
    • Entity Icon Size - Choose the size of the icon (Small or Large).
    • Entity Type - Choose the Entity Type available on your MES system.
    • Entity - Choose the Entity instance.

    entityDetailsSetup

  3. Optionally, define Properties that will be displayed. It is necessary to provide a name, that will be displayed to identify the property. If it's not user defined, select a value from the provided list of properties; if it is user defined, input a value.

    entityDetailsProperties

  4. Optionally, define the Links between this widget and other elements of the UI Page. In this section, it's necessary to define the input to the instance to be displayed by the widget.

    entityDetailsLinks

  5. By saving and closing the settings, the widget will be changed accordingly.

Real Use Case#

It often makes sense to see selected Entity Details displayed on a UI Page to avoid having to open the entity itself. To accomplish this, the Entity Details widget can be linked to an Entity List widget or a Form widget that provides the entity.

Depending on the properties to be displayed, a Load Entity converter may be used to load additional data of the selected entity.

Info

An example of the need for converters can be the access to the name of an area of a Resource. Since this information is not stored directly in the same database table as the Resource but linked to it as a foreign key in the same table. This means that in order for the information to be displayed in an Entity Details widget, the Resource entity has to be loaded for more levels. Each level in this context represents the distance of the desired property from the initial entity. For example, the Area name is 1 level away since Area is directly linked to Resource.

  1. Add an integer property to the page (later required to define how many levels to load):

    Screenshot showing a UI with an incomplete properties section, including "Properties" and "DT property Details".

  2. Configure entity details widget for entity:

    entityDetailsSetup

  3. Add properties as required:

    Screenshot showing a UI with a property name labeled "Lproperty" and an option to add more properties.

    Note

    Adding properties (i.e. Area Description) which are not in the provided list, select option User Defined and provide the path of the property in syntax as shown in the picture below:

    Screenshot showing a UI with properties listed, including "Property" and "User Defined" options.

  4. Link the resource entity form field to the Entity Details widget and use the converter Load Entity, specifying the number of levels to load.

    ![entityDetailsLinks][entityDetailsLinks]

    Screenshot showing the Entity Details widget with settings.

  5. The final result should look like this:

    Screenshot showing a sample user interface with a completed configuration.