This paper presents a domain-specific language (DSL) in the form of a UML profile that facilitates efficient modeling and generation of fully-functional UIs of enterprise business applications. DSL is based on an internal HCI standard that defines layout and behaviour of coarsegrained objects for business applications. Being a regular UML extension, this language can be used in any general-purpose UML modelling tool and can easily be integrated with other UML-based models of the application.
Various aspects of model-based development of user interfaces (UIs) are the
subject of intensive research efforts. However, the majority of presented solutions
is hardly applicable to development of real-world information systems because
too much time and effort is spent on developing and synchronisation of different
types of user interface models (for example, presentation model, content model,
navigation model, interaction model), the complexity of sharing the knowledge
embedded in different models, the lack of support in development tools, and the
lack of consensus over which types of models best describe UIs [
In order to overcome the problem of integration and to facilitate the exchange
of information among different tools, UML can be used to model all aspects of
an application, including the user interface [
This paper presents a UML extension in the form of a UML profile for specifying UIs of business applications named EUIS (Enterprise User Interface Specification profile). EUIS is developed in order to enable rapid user interface modelling at a high level of abstraction. EUIS is based on an internal HCI (humancomputer interaction) standard of a business application that defines functional and presentational features of coarse-grained building blocks thus enabling the generation of a fully functional UI, without the need for defining a multitude of models used for developing UIs in the general case.
It is important to note that the UI model is not a model of an application
(from the implementation standpoint); it defines the structure of the
application using building blocks at a high abstraction level (different types of screen
forms, reports, procedures) and their relationships. Depending on the
development platform, the intended application architecture, and the implementation
of a code generator, one class from the UI model may be mapped to one or
more classes or modules of an application, or may even be not mapped to the
program code at all but to application repository data instead, if a data-driven
application architecture is used (for example, see [
Problem domain model Database model
Middleware / Business logic model
PIM
PSM
User interface model Database scripts
Middleware
User interface
Generated Application elements meta-data
The development of a whole business application using the EUIS profile comprises the following activities (see Figure 1): – The development of PIM (platform independent model) of a problem domain by means of class diagrams in a general-purpose UML modelling tool. – The automatic transformation of a PIM to PSMs (platform-specific model): database schema model, user interface model, and the middle-tier model (in the case a three-tier architecture is chosen). – Automatic generation of artifacts needed for implementation based on PSMs: database schema creation or alteration scripts, middle-tier implementation artifacts (such as EJBs), fully functional application UI (depending on the target architecture of the client application), and atomic “CRUD” transactions implementing creation, retrieval, update, and deletion of every entity in the persistence layer.
The rest of the paper is structured as follows. Section 2 describes the basics of the internal HCI standard. Section 3 presents the EUIS profile. Section 4 reviews the related work. The last section concludes the paper and outlines some directions of future work.
Our internal human-computer interaction (HCI) standard is aimed at defining functional and visual features of course-grained application components. Its goals include the following: simplicity of use, quick user training, and the automation of user interface construction.
The papers [
Standard form is designed to display data and all available operations so
the user can choose a data item and invoke an operation on it without memorising
commands (the object-action approach [
Title
Operations common to all entities include search (query by form), display, addition, update, removal, copying, data navigation and view mode toggle (grid view or single record view). Specific operations include complex data processing procedures associated with the given entity (transactions), invocation of related (next ) screen forms, and invocation of reports. The standard mandates that the specific operations always use the currently selected (viewed) record.
Standard panel has the appearance and the behaviour of the standard form but, instead being shown in its own window, it is used as an element of a complex form. Standard panels are regularly used for parent-child and many-tomany forms.
A parent-child form is used for data that have hierarchical structure, where each element in the hierarchy is modelled as an entity in the database. Each element in the hierarchy is represented by a standard panel, where a panel at the n-th hierarchy level filters its content according to the selected data item at the level n − 1.
The many-to-many form is used for intensive management of data belonging to entities connected by “many-to-many” relationships, with or without associate classes. Its layout is presented in Figure 3. This screen form is used as follows: – A number of desired records are selected in the upper panel. These records are “dragged” to the lower panel by clicking the button with the downwards arrow. If a record is dragged by mistake, it can be revoked back by clicking the upwards arrow button. – The values of non-key attributes of a record selected in the lower panel may be changed.
Title
Relationships among screen forms are represented by three mechanisms: zoom, next, and activate. The zoom mechanism represents the invocation of the form associated with the given entity where the user can choose a data item and “drag” it (pick its values) to the fields of the previously viewed form.
The next mechanism, invoked from the form associated with the current entity, displays the form associated with the child entity with its data filtered so that only connected objects are displayed. The key or a representation of the parent entity is displayed in the form header, so the user easily recognises the current context. A next can be invoked by menu items, buttons, or links.
The activate mechanism enables direct invocation of a form by another form, without restrictions on the data displayed. The invoked form does not need to be related to the current one. 3
The EUIS profile extends the following metaclasses from the UML::Kernel package: Element, Class, Property, Operation, Parameter, Constraint, and Package. It is complementary to the profile for modelling persistent data that is available in a majority of modelling tools (see Figure 4). Therefore, EUIS is independent on modelling tools, persistence layer and the database of choice. Profile that models persistent data comprises only the stereotypes present in the majority of modelling tools (possibly under a different name): persistent class, persistent property, persistent data type, and persistent operations (methods implemented in the persistence layer) – see Figure 5. When using the EUIS profile, these stereotypes are replaced with concrete stereotypes of the chosen modelling tool.
In order to specify additional information needed for transforming a problem
domain model to a user interface model, another profile is developed (see Figure
6) that provides the following: defining a set of one or more properties as a
business key – the BusinessKey stereotype [
– a visible element: extension of Element metaclass – visible classes (panels): extensions of Class metaclass – visible properties: extensions of Property metaclass – visible methods: extensions of Operation metaclass – visible parameter: extension of Parameter metaclass – a group of elements: extension of Property metaclass – visible association ends: extensions of Property metaclass – validators: extension of Constraint metaclass – a business subsystem: extension of Package metaclass
Due to space constraints, the rest of the section presents only the most important stereotypes and tags. Validators, business subsystem and formal OCL constraints are not presented. 3.1
Stereotype VisibleElement (see Figure 7) represents a model element that is mapped to a user interface element in the generated application. Since Element metaclass is a common superclass of all UML metaclasses, this facilitates the representation of all model elements with a UI component and a label, where applicable.
«metaclass» Element
«stereotype»
VisibleElement
label : String [0..1]
visible : Boolean [
«enumeration» ComponentType textField passwordField textArea column checkBox comboBox selectionList radioButton label image tabbedPane panel grid border menu menuItem button
The enumerated type ComponentType defines a set of available UI component types. The set of components is designed to be platform-independent. Mapping these values to particular UI components of the chosen development platform is performed in the application generator. 3.2
Stereotype VisibleClass (see Figure 8) represents a class that is mapped to a panel (a regular or a tabulated panel) in the application UI. If a panel is associated to an empty window or a web page, it becomes a screen form that can be independently activated (opened).
Stereotype VisibleClass is not abstract because of the possibility of modelling specific panels that are not comprised by the HCI standard, but still occur rarely enough that there is no need to extend the HCI standard with a new element.
The inherited tag label is used as a window title or a label that explains the purpose of the panel if displayed within a complex panel.
Stereotype StandardPanel denotes that the given persistent class is associated with a standard panel whose layout and behaviour are defined by the internal HCI standard. The standard panel implements three interfaces: StandardOperations – operations defined by the HCI standard: add, update, copy, delete, search, change mode, navigate data; StdPanelSettings – settings that define panel’s runtime behaviour; and DataSettings – defines data filtering and sorting.
Stereotype ParameterPanel represents a class that is mapped to a panel for entering parameters for a visible method (see VisibleOperation stereotype) that is invoked by a button or a menu item. Since the majority of parameter panels in an application is created implicitly, as a result of a visible method and its parameters, classes with this stereotype rarely occur. It can be used in situations where a user successively invokes a number of methods with the same set of parameter values.
The ContainerPanel is an abstract stereotype that represents a complex panel that can contain other panels (simple or complex), as well as a number of properties and methods. It defines additional attributes, methods, and constraints for its descendants (ParentChild, ManyToMany, and PanelGroup). The layout and behaviour of ParentChild and ManyToMany panels is defined by the HCI standard, while their relationship to the contained panels is defined by hierarchical relationships (associations with ends having the Hierarchy stereotype). For details on associating panels, see section 3.7.
The layout and behaviour of a PanelGroup is not defined by the HCI standard. It is used for modelling special-purpose complex panels. The class with a PanelGroup stereotype defines only the contained elements, while their relationship is implemented in application code.
Classes with the MainPanel stereotype are used for modelling the main form of a business subsystem 3.3
Stereotype VisibleProperty (see Figure 9) is a property of a “visible” class and is mapped to a UI component contained in the panel associated to the class. Its tags provide customisation of appearance and behaviour of the UI component, or the table column in the case of tabular display of data (label, columnLabel, dataFormat, disabled ), default values in the UI component (default, defaultValueGetter ), and automatic focus traversal (autoGo). Tag default contains an OCL expression that defines the initial value, while defaultValueGetter contains the reference to the method used for fetching the default value (in cases when OCL expression cannot be used). Tag representative indicates that the given property can be used to represent the whole class from the users’ point of view (for example, company name, first name + ” ” + last name).
Aggregated represents an aggregated property, whose value is calculated using one of the aggregation functions (min, max, sum, avg, count) over the selected property (aggregatingAttribute). The set of values being aggregated is specified by an OCL expression (selection) or by a method (performsSelection).
Stereotype Calculated represents a property whose value is calculated according to the given formula over the values in objects of this or some other class. Calculation method can be specified by an OCL expression (expression) or by a method (performsCalculation).
Abstract stereotype Persistent represents a property that is mapped to a persistent property in the problem domain model. Its descendants include Editable (enables editing the value of the persistent property in the UI component) and ReadOnly (disables editing). Editing values is allowed if the user has appropriate permissions.
Editable has an AutoDuplicate descendant that represents a persistent property where the value entered in the UI component is kept as default when entering a new record. It is usually applied to properties whose values are repeated across many records, so the user is spared some effort while entering data.
ReadOnly has an AutoIncrement descendant that denotes a persistent property whose value is automatically incremented with each new record entered. Contrary to identity columns or database sequences, this property allows the counter value to be reset if a condition is met (using an OCL expression in incrementSpec or a method in performsIncrement ).
Stereotype Lookup describes a property whose value is formed from property values of referenced objects, directly or indirectly. Direct reference means that there is an association with the class that provides the data; indirect reference means that such class can be reached by traversing a series of associations. Properties forming a lookup can be specified as an OCL expression (expression) or by specifying the class that provides the data. In the latter case, the representative property of that class is used. 3.4
Stereotype VisibleParameter (see Figure 10) denotes a parameter of a visible method (having the VisibleOperation stereotype) that behaves as follows. If it is an input or an input/output parameter, then – it enables entering parameter values by means of a UI component contained in the parameter panel associated with a visible method, or – it defines the way of fetching the parameter values in the case when the user is not supposed to enter its value (using tag valueSpec contains an OCL expression that calculates the value, or tag valueGetter that specifies the method for calculating the value). If it is an output parameter or a method result, it enables the display of its value by means of a UI component contained in the parameter panel associated with a visible method. 3.5
«stereotype»
VisibleElement 1..* element {ordered}
Stereotype ElementsGroup (see Figure 11) represents an attribute of a class with the VisibleClass stereotype used for grouping its elements (properties, methods, associations), thus forming semantic groups that map to groups of UI components in a panel associated with the class. Each group can define the following: an ordered collection of contained elements (tag element ), the UI element orientation in layout (orientation), the location of the group in the panel (location), and the alignment of elements in the group (alignment ).
The inherited tag label represents a label displayed in a UI component associated with the group (frame title, panel title, name of the menu item that opens a submenu). 3.6
Stereotype VisibleOperation (see Figure 12) denotes the method of a visible class that has an associated UI component (a button or a menu item) that enables its invocation by the user. If the method has input parameters, they must have the VisibleParameter stereotype (see section 3.4).
Abstract stereotype BusinessOperation represents a method that is mapped to an activity in the problem domain. Its descendants are Report and Transaction. Report describes a method that invokes a report created by one of the reporting tools. Report ’s tags enable specifying the report name, and the filtering and sorting criteria. Transaction represents a complex business transaction that is implemented as a stored procedure in the database or a method in a middle tier. Its tags enable specifying the UI behaviour immediately before and after its invocation (requesting the confirmation from the user, display refresh mode, error display mode, etc). «stereotype»
PersistentOperation persistentOperation 0..1
* Abstract stereotype VisibleAssociationEnd (see Figure 13) is applied to a property belonging to a binary association between two visible classes. It defines the relationship between the panel belonging to the class that owns the property (activation panel) and the panel belonging to the class at the other end (destination panel). The nature of the relationship is determined by this stereotype’s descendants. VisibleAssociationEnd only introduces common properties and constraints that enable destination panel to adjust its layout and behaviour to the context it is used in. For this purpose, VisibleAssociationEnd implements the following interfaces: StandardOperations, DataSettings, StdPanelSettings, and PanelAdjustment. Tag values specified by PanelAdjustment can be set for all types of panels (VisibleClass and its descendants), while tag values specified by StandardOperations, DataSettings, and StdPanelSettings can be applied to standard panels only (stereotype StandardPanel, see section 3.2).
If tag values are not defined at the association end, values defined at the standard panel are used. If values of tags add, update, copy, delete, search, and changeMode are set to false in the standard panel, the value set at the association end is ignored. This helps adhering to rules that are usually consequences of problem domain constraints independent of the usage context.
Stereotypes Zoom, Next, and Activation model the corresponding type of activation as defined by the HCI standard. Stereotype Hierarchy denotes that the destination panel has the role of an element in the parent-child or many-tomany panel. Role of the destination panel is set by the value of the level tag. For many-to-many complex panels, level = 1 is the panel that represents the header, level = 2 is the panel for choosing data, and level = 3 is the panel that contains the transferred data (for example, see class PickAuthors in Figure 15). For parent-child complex panels, level = 1 is the standard panel being the «stereotype»
Next
autoActivate : Boolean [
StandardPanel root of the tree, level = 2 is the child panel, level = 3 is the child of the child panel, and so forth: for n > 2, level = n is a panel that is the child for panel at level = n − 1 (for example, see class JournalPaperComposite in Figure 15).
Composing parent-child and many-to-many complex panels requires defining only levels of hierarchy for each contained panel; runtime association of panels is performed by analysing their associations. If two or more associations exist between two panels, or there is a recursive association, association end to be used must be explicitly stated in the viaAssociationEnd tag.
Stereotype GroupElement denotes that the destination panel is an element
of a complex panel, where its role and behaviour are defined in the application
code and/or using values of tags inherited from VisibleAssociationEnd.
Figure 14 presents a domain model of a part of a CERIF-compliant research
management system presented in [
The problem domain model in Figure 14 is automatically transformed into the UI model presented in Figure 15 that contains an initial version of the user interface. The application developer can manually change this version to meet the users’ requirements. The diagram in Figure 15 shows manually added classes PickAuthors (a many-to-many form for choosing paper authors) and JournalPaperComposite (a parent-child form for managing journal papers) with corresponding associations. Properties with Lookup and ElementsGroup stereotypes in all classes are also manually added. The rest of the model is automatically generated: persistent classes from the domain model was mapped to UI classes with StandardPanel stereotype, persistent properties to UI properties with Editable stereotype, association ends with cardinality 0..* to UI association ends with Next stereotype and association ends with cardinality 0..1 or 1 to UI association ends with Zoom stereotype. Fig. 15. A UI model of a part of CERIF-compatible system
An example of a web-based form generated for JournalPaperComposite is presented in Figure 16. In order to compare the EUIS profile with other profiles presented in the literature, this section reviews recent papers ranging in subject from modelling user interfaces of business applications to complete methodologies and tools for information system development, including its presentation aspects. Papers that deal with developing user interfaces in general are not discussed here.
The papers [
The papers [
In [
Compared to elements of the standard presented in Section 2, the patterns
used in [
The paper [
The series of papers [
The concept of modelling an application in UWE methodology is the closest to the proposition in this paper – in both cases, the starting point is the problem domain model expressed as a class diagram that is automatically mapped to the application model, data model, and other models needed. Thanks to this approach, there is a direct mapping of application elements to the layer that implements business logic, a feature missing in the majority of reviewed solutions. The most notable differences between UWE and EUIS approaches are the following: – The UWE methodology and profile are focused solely on developing webbased systems, while the methods presented here can be applied to both web and “classical” information systems. – The UWE method does not rely on an internal HCI standard (there is only one type of forms). – Our approach proposes a single user interface model that defines coarsegrained application building elements, their structure and layout (using the ElementsGroup stereotype), and navigation among them. Sketches of forms need not be made thanks to the mechanism for intelligent component layout that forms a usable user interface according to rules and groups, and which can be further adapted during implementation.
Although not based on a UML profile, the concept of specifying GUI forms
and generating the database schema and the functional prototype of the
application using the IIS*Case tool [
Our previously implemented tools for generating UIs of business applications
for various platforms are presented in [
Automatic generation of UIs in the general case requires the development of a number of UI models and thus requires much time and effort, often with unsatisfactory results. Synchronisation and integration among different UI models, as well as with domain models, is another big problem.
If we restrict to the problem of developing special-purpose UIs, these problems are largely simplified. This paper presents UML profile that facilitates efficient modeling and generation of fully-functional UIs of enterprise business applications which is based on an internal HCI standard that defines layout and behaviour of coarse-grained objects for business applications. Relying on this standard has enabled the rapid development of UIs for this particular type of applications. Being a regular UML extension, this language can be used in any general-purpose UML modelling tool and can easily be integrated with other UML-based models of the application.
Our tools developed to support the presented concepts [