History Log User Interface 

Use

This function enables you to display additional comments about an entity service during application runtime. As a result, you can see information about an entity without having to look into the entity service itself.

The History Log pattern is a component pattern that can be embedded in any composite application such as the Object Editor pattern. Comments are read-only and displayed in chronological order.

Features

The History Log pattern consists of two parts:

●     History Log Configurator

●     History Log user interface (UI)

History Log Configurator

With the configurator, you specify the component’s runtime data source and presentation properties seen in the UI. At the top of the History Log Configurator is a toolbar for managing log configurations. These commands include New, Open, Refresh, Save, Save as, and Delete. With Preview, you can view the results of your configuration without having to start a new session or refreshing the screen.

The History Log Configurator uses the following tab pages to define field values:

·        Physical data source

This includes configuration selections for:

○     Queries

○     Relations

·        Logical fields

Physical Data Source Tab Page: Query Configuration

The tab page is divided into sections for data source configuration and argument parameters. In Configuration, you can specify the component’s runtime data source either as a query or a relation to the aspect row. If you select Query, you must then define a set of parameters by specifying the ESF  (Enterprise Service Framework) Query in the repository browser.

The ESF Repository Browser appears as a dialog box and is divided into the following parts:

●     Service Modules

Lists the service modules available for implementation in this application. Each module contains aspects and queries associated with the service module.

●     Queries

The list is populated depending on the service module chosen. The query name consists of the operations command and attribute used in the query.

●     Aspects

Lists the set of logically grouped fields targeted in a query. The system populates the table only after selecting a query to use in the application. The list contains the aspect table name and aspect used as the unique identifier.

The chosen parameters are also listed next to Service module, Query, and Result aspect. The Parameters binding table lists the parameter name and data type of the parameter used in the query. You can generate a Binding path if you want to bind input parameters of the query to component arguments.

In Arguments, you define the parameters that are automatically applied by the History Log. These parameters can either be available as external node attributes with specified default values or as scoped variables. You use argument definitions in both query and relation configuration.

Physical Data Source Tab Page: Relation Configuration

You use the Relation selection to specify the runtime data source as a relation to an aspect row. This relation is passed along by the embedded component.

The relation configuration section of the physical data source tab page also contains sections for ESF configuration and argument parameters. In Configuration, you have to specify the following parameters from the Parent Aspect to determine the aspects used in data retrieval:

·        Service Module

·        Parent aspect

·        Retrieving mode

Logical Fields Tab Page

You use this tab page to bind component fields to the physical data source. The page is divided into the sections for general UI display information and logical fields. You use General to define the UI header, height, and scrolling mode. You use Logical fields to map aspects to the data source.

To map result aspects to the four predefined logical fields Icon, Title, Short Description, Full Description, you must use one of the following three variants:

·        Mapped

Is the mapped relation between a logical field name and aspect field.

·        Calculated

Logical fields calculated with this variant are intended to provide attribute values calculated at runtime. The real values will be supplied at runtime by programming actions in the callback function using the field ID of the component. This is what embeds the History Log pattern.

·        Macros

In using logical fields with macros, the user may enter expressions calculating the field value based on values of the physical fields. The macro language allows functions that reference to fields from query results, literal data types, typecast simple types, and predefined constants. These functions can be @switch, @format, @component_mime, and @dc_mime.

For more information on the macros used in the History Log pattern, see Macros.

Predefined Logical Fields

Name	Description
Icon	Indicates if and which icon the system uses to introduce the comment.
Title	Name of the comment.
Short Description	Contains a short description of the aspect used in the application.
Full Description	Is a more detailed description of the aspect used in the application. It includes the instance GUID and additional identifying information.

History Log UI

In the user interface, you can see the results of the pattern configuration. The UI contains a single-column table, which lists the entity information you want to view in the application.

Each entity contains two rows in the table: The first row shows the table title and the second row displays a short description of the entity service. You can toggle between the short and long description of the entity by clicking on any of the two rows.