Configurable User Interface Components
Purpose
Configurable user interface (UI) components are reusable templates designed to simplify the creation of screen layouts in Web Dynpro. You use these UI components in support of the uniform layout and navigation paradigms of user interfaces in that they can be individually configured for use in different applications as per the intentions of developers or users.
By reusing existing UI components, you take advantage of already configured functions without needing additional coding. This pattern-based approach is therefore ideal for user interface generation. All patterns use the SAP UI development environment Web Dynpro.
Prerequisites
To run user interface patterns, you must start the J2EE engine and install the runtime component.
Integration
The generic client proxy (GCP) of the Enterprise Service Framework (ESF) is used to connect the object access layer (OAL) from Web Dynpro. The GCP provides an interface based on the ESF definition that a pattern can generically connect to any backend application.
UI patterns available for use in CAF can be accessed via the CAF Runtime Configuration tool at:
http://<host>:<port>/caf → User Interface Configuration → Configuration browser → Patterns
The configuration links for each of the patterns are also listed in the table below
Component Name |
Configuration Link |
Attachments |
sap.com/caf~UI~ptn~attachments/AttachmentsConfig |
Attach Image |
sap.com/caf~UI~ptn~attachments/AttachImageConfig |
Authorization Report |
sap.com/caf~UI~ptn~authorization/ReportConfig |
Classification Assignment |
sap.com/caf~UI~ptn~classification/ClassificationConfig |
Collaboration |
sap.com/caf~UI~ptn~collaboration/CollaborationConfig |
File Select |
sap.com/caf~UI~ptn~kmfileselect/FileSelectConfig |
Flex Tree |
sap.com/caf~UI~ptn~flextree/FlexTreeConfig |
History Log |
sap.com/caf~UI~ptn~historylog/HistoryLogConfig |
Navigation |
sap.com/caf~UI~ptn~navigation/NavigationConfig |
New Attachment |
sap.com/caf~UI~ptn~attachments/NewAttachmentsConfig |
Object Browser |
sap.com/caf~UI~ptn~objectbrowser/ObjectBrowserConfig |
Object Editor |
sap.com/caf~UI~ptn~objecteditor/ObjectEditorConfig |
Object List |
sap.com/caf~UI~ptn~objectselector/ObjectListConfig |
Object Selector |
sap.com/caf~UI~ptn~objectselector/ObjectSelectorConfig |
Property Editor |
sap.com/caf~UI~ptn~propedit/PropertyEditorConfig |
Property Editor Wrapper |
sap.com/caf~UI~ptn~propedit/PropEditCommandletCfgApp |
Relation Tab |
sap.com/caf~UI~ptn~objecteditor/RelationTabConfig |
Reporting |
sap.com/caf~UI~ptn~report/ReportingConfig |
Search Bar |
sap.com/caf~UI~ptn~searchbar/SearchBarConfig |
User Assignment |
sap.com/caf~UI~ptn~userassignment/UserAssignmentConfig |
You are to prefix the configuration links with the following syntax: http://<host>:<port>/webdynpro/dispatcher/. Exchange the host and port location to match the server’s parameters, where host is the full qualified name of the host machine and port is the engine instance.
For more information about how to configure and upload user interfaces into other applications, see User Interface Transport.
Features
There are two types of user interface components available:
● Component
● Page
Both types of configurable UI components or patterns consist of two parts:
● Component configurator, which is used to configure and generate the UI layout.
● Generated UI, which is the result of the component configurator configurations.
Component Patterns
A single UI component pattern is fully embedded in a Web Dynpro application. These components are embedded for use in various applications; moreover, they can be included in other UIs such as the more complex page pattern components.
The following configurable user interface components are available:
Page Patterns
Page components provide a user interface layout of combined component types such as the use of the Attachments and Search Bar functions. Page components are themselves applications that contain interfaces that plug into other components. They represent independent UIs.
The following UI page components are available: