Skip to content

Entity History#

Overview#

This widget presents the history of an Entity. You can select services, which load the corresponding operations. From the operations, you can check the property changes. The operations are displayed in a nested way, which means it is possible to have multiple operations inside operations. You can also filter or search for specific operations, or just look at the service's comments in a separate tab. Below is an example of a UI Page with an Entity History widget, showing the history for a given Material.

Entity History widget on a UI page showing the event timeline for a selected Material.

General#

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

  1. In any UI Page in Build mode, select the Entity History 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.

Screenshot showing a settings page for entity history.

Style#

Optionally, in the Style tab, you can define a Border Width and Color.

Diagram showing a widget customization interface with options for border width and color.

Setup#

In the Setup tab, define the Entity Type and the Entity.

Screenshot showing the Entity History settings in the Setup tab of the widget customization interface.

Optionally, define the Links between this widget and other elements of the UI Page.

Screenshot showing the "Entity History Links" section of the UI page.

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

Real Use Case#

The Entity History widget can be easily configured to receive a user selected entity from, for example, a Form widget:

Screenshot showing a Form Widget with an entity type field.

  1. Create a Form Widget with an entity type field as described. For more information, see Form.

    Screenshot showing a form widget with an entity type field for creating an entity history.

  2. Add an Entity History widget and, in the Setup tab, add the Material Entity Type:

    Screenshot of the Setup tab of an Entity History widget.

  3. Link the entity field to the entity History Widget.

    Screenshot showing a link connecting an entity field to an entity History Widget.