Floorplan Manager for Web Dynpro ABAP

374 Pages·2014·9.35 MB·English

SAP NetWeaver
2014-10-29
Floorplan Manager for Web Dynpro
ABAP
Table of Contents
1 Floorplan Manager for Web Dynpro ABAP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
2 FPM Basics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.1 Structure of a Floorplan Manager Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
2.2 Floorplans. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.2.1 Floorplan for the Overview Page (OVP). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2.2.2 Floorplan for Guided Activity (GAF). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
2.2.3 Floorplan for Object Instances (OIF). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.2.4 Floorplan for Quick Activity (QAF). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
2.3 User Interface Building Blocks (UIBBs). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
2.3.1 Interface: IF_FPM_UI_BUILDING_BLOCK. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
2.3.2 Generic User Interface Building Blocks (GUIBBs). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
2.3.3 Reuse User Interface Building Blocks (RUIBBs). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
2.4 FPM Event Loop. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
2.4.1 Raising Standard FPM Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25
2.4.2 Triggering the FPM Event Loop. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26
2.4.3 Triggering Application-Specific Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
2.4.4 Asynchronous Callback. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
2.4.5 Interaction with Web Dynpro Phase Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28
2.4.6 Key Web Dynpro Methods used in FPM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
2.4.7 Different Categories of Web Dynpro Interfaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
2.4.8 Triggering a Data-Loss Dialog Box in the FPM Event Loop. . . . . . . . . . . . . . . . . . . . . . . . . . .30
2.5 FPM/Web Dynpro ABAP Adjustment Concept. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32
3 Developing FPM Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
3.1 FPM Developer Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34
3.1.1 FPM Workbench: Useful Tools in One Place. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
3.1.2 Creating FPM Applications with the ACT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
3.1.3 Application Hierarchy Browser for Floorplan Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
3.1.4 Flexible User Interface Designer (FLUID). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42
3.1.5 Analyzing Applications with the Runtime Analysis Tool (RAT). . . . . . . . . . . . . . . . . . . . . . . . 64
3.1.6 Comparing Configurations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66
3.2 Working with GUIBBs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67
3.2.1 GUIBBs in Detail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
3.2.2 Value/Input Helps for Generic UIBBs (GUIBBs). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
3.2.3 Dynamic GUIBB Configurations at Runtime. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
3.2.4 Context Menus and Action Menus in GUIBBs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
3.2.5 Quickviews. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
3.2.6 Moving Data between UIBBs at Runtime (Drag-and-Drop). . . . . . . . . . . . . . . . . . . . . . . . . .243
Floorplan Manager for Web Dynpro ABAP
2 © 2014 SAP SE or an SAP affiliate company. All rights reserved. Table of Contents
3.3 Working with Floorplans. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .254
3.3.1 Working with the OVP Floorplan. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
3.3.2 FPM Error Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
3.3.3 Variants. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
3.3.4 Initial Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .269
3.3.5 Confirmation Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
3.3.6 Default Actions (Hot Key = Enter). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
3.3.7 Dialog Boxes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .272
3.3.8 Identification Region (IDR) of GAF and OIF Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . .277
3.3.9 Adding and Activating Sub-Steps for GAF Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . .281
3.4 Working with FPM Framework Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .282
3.4.1 FPM Toolbars. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
3.4.2 Providing Users with Quick Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
3.4.3 Sharing Data between UIBBs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
3.4.4 FPM Message Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .306
3.4.5 Work-Protect Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .326
3.4.6 Transaction Handling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .326
3.4.7 Resource Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
3.4.8 Application Controllers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .332
3.4.9 Navigation with Launchpads. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .336
3.4.10 Determining Navigation State Information at Runtime. . . . . . . . . . . . . . . . . . . . . . . . . . . . .343
4 Adapting FPM Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .345
4.1 Customizing FPM Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .346
4.2 Personalizing FPM Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
4.2.1 Personalizing Pages in an Overview Page Floorplan. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
4.2.2 Personalizing the Hierarchical List Component. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .351
4.2.3 Personalizing the List ATS Component. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
4.2.4 Personalizing the Search Component. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
4.3 Context-Based Adaptations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
4.3.1 Enabling an Application for CBA. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
4.3.2 Creating and Editing an Adaptation of an Adaptable Application. . . . . . . . . . . . . . . . . . . . . .359
4.4 FPM Applications on Multiple Devices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .360
4.5 Application Enhancement Tool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
5 Special Topics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .362
5.1 FPM CHIP Integration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
5.1.1 Creating a CHIP for a Single UIBB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
5.1.2 Adding Systems to the Saved Searches CHIP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .365
5.2 Embedding an FPM Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .366
5.3 Setting a Default ALV View for a Freestyle UIBB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
5.3.1 Rendering ALV Views during Runtime. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
Floorplan Manager for Web Dynpro ABAP
Table of Contents © 2014 SAP SE or an SAP affiliate company. All rights reserved. 3
6 Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
6.1 Final Flags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .370
6.2 One-Click Actions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
6.3 Melting Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Floorplan Manager for Web Dynpro ABAP
4 © 2014 SAP SE or an SAP affiliate company. All rights reserved. Table of Contents
1 Floorplan Manager for Web Dynpro ABAP
Use
Floorplan Manager (FPM) is a highly configurable user interface (UI) framework for easy and efficient application
development and adaptation based on Web Dynpro ABAP.
With the help of predefined elements such as floorplans, toolbars and generic user interface building blocks, FPM
provides you with consistency across applications and compliance with SAP UI design guidelines, as well as
greatly reducing the time required to create such applications.
Central functions such as navigation, messaging, and personalization are embedded in the framework, and can be
easily defined by application programming interfaces (APIs).
FPM allows you to easily adapt delivered Web Dynpro ABAP UIs to your specific needs modification-free by
simple UI configuration, and to combine application-specific views of one or more business applications into new
Floorplan Manager applications.
Integration
FPM is a Web Dynpro ABAP application that is integrated into the Web Dynpro ABAP development environment.
Features
FPM supports you in creating and configuring UIs by providing you with, amongst other things, the following
components:
● SAP-Defined Floorplans
Combinations of UI patterns arranged in a specific order in an application, allowing the user to accomplish a
certain activity, such as searching for, identifying, and maintaining data for an object.
The areas of a floorplan such as a message area, navigation area, and content area are automatically
implemented by the FPM framework.
● Generic UI Building Blocks
SAP UI-compliant templates for displaying content. Examples include templates for displaying data in a form
or list view.
● FPM Configuration Editor (FLUID-Flexible User Interface Designer)
Editor allowing you to configure the application composition as a whole as well as the individual floorplan and
generic UI building blocks within it.
More Information
See also Floorplan Manager for Web Dynpro ABAP in the SAP Community Network (SCN). Here you will find other
useful information such as FPM tutorials, and documentation relating to adapting your FPM applications.
Floorplan Manager for Web Dynpro ABAP
Floorplan Manager for Web Dynpro ABAP © 2014 SAP SE or an SAP affiliate company. All rights reserved. 5
Related Information
FPM Basics [page 7]
An introduction to FPM concepts, and the essential components of an FPM application.
Developing FPM Applications [page 33]
This section comprises the main part of the document.
Customizing FPM Applications [page 346]
Personalizing FPM Applications [page 348]
End-users can personalize FPM applications at runtime to suit their own requirements.
Reference [page 370]
Floorplan Manager for Web Dynpro ABAP
6 © 2014 SAP SE or an SAP affiliate company. All rights reserved. Floorplan Manager for Web Dynpro ABAP
2 FPM Basics
An introduction to FPM concepts, and the essential components of an FPM application.
Related Information
Structure of a Floorplan Manager Application [page 7]
Floorplans [page 9]
User Interface Building Blocks (UIBBs) [page 18]
UIBBs are used to display the content on your UI, for example, data in a table or form.
FPM Event Loop [page 25]
An event loop is triggered in an application by an event, such as a mouse-click. When an event occurs, the Event
Loop ensures that the event is appropriately handled by ensuring that all relevant methods are triggered, and in
the correct sequence too.
FPM/Web Dynpro ABAP Adjustment Concept [page 32]
The concrete layout of an FPM application is determined by the application configuration, and the
configurations of the embedded components (UIBBs). These configurations can be adjusted or changed at any
time.
2.1 Structure of a Floorplan Manager Application
A Floorplan Manager (FPM) application is a Web Dynpro application that is assigned one of the following Web
Dynpro components:
● FPM_OVP_COMPONENT
● FPM_GAF_COMPONENT
● FPM_OIF_COMPONENT
Each of the above components provides the application with a different type of floorplan. Floorplans define the
general layout and interaction of an application. They are used for application composition and UI assembly. They
are explained in detail in another section.
Using explicit configurations of the above components, you can assign additional Web Dynpro components as
user-specific views to display your content. These user-specific views are referred to as UI building blocks
(UIBBs).
Note
There are different types of UIBBs:
● Freestyle UIBBs
These components are created outside the FPM framework, in the Web Dynpro ABAP development
environment, by application developers. FPM has, therefore, little control over the layout of their content.
● Generic User Interface Building Blocks (GUIBBs)
Floorplan Manager for Web Dynpro ABAP
FPM Basics © 2014 SAP SE or an SAP affiliate company. All rights reserved. 7
FPM makes life easier for application developers. To ensure that your application has a harmonized look
and feel, and that there is consistency in the UI screens, FPM provides you with templates, the GUIBBs, for
displaying your content. For example, there are templates to display your content in a form layout (Form
GUIBB), and in a list layout (List GUIBB). When using a Form GUIBB, for example, you don't have to worry
about aligning input fields - the FPM GUIBB takes care of that. UIBBs and GUIBBs are explained in greater
detail in another section.
By combining a configuration of a floorplan with configurations of the UIBBs, you can compile most of the
common application user interfaces.
The interfaces can be changed afterwards by changing both the floorplan and the UIBB component
configurations.
The figure below illustrates an FPM application, showing a floorplan configuration containing two GUIBBs (for
form layout and tab page layout) and a single freestyle UIBB. Note that the tabbed component is included only to
show that it is a special kind of GUIBB that contains other GUIBBs.
Figure 1: Example Structure of a Floorplan Manager Application
Related Information
Floorplans [page 9]
User Interface Building Blocks (UIBBs) [page 18]
UIBBs are used to display the content on your UI, for example, data in a table or form.
Floorplan Manager for Web Dynpro ABAP
8 © 2014 SAP SE or an SAP affiliate company. All rights reserved. FPM Basics
2.2 Floorplans
Concept
To improve the uniformity of user interfaces of applications in the Web Dynpro ABAP environment, Floorplan
Manager (FPM) lets you implement floorplans.
A floorplan is a template. It is a combination of user interface (UI) 'patterns' arranged in a specific order in an
application that allows a user to accomplish a certain activity, for example, searching for, identifying, and
maintaining data for an object.
Each floorplan represents a different type of user activity and, therefore, floorplans form the basis of an
application.
Each floorplan follows the SAP design standards for UI and is implemented as a separate Web Dynpro
component.
The following list displays the floorplan types that are available and provides guidelines as to when to use them:
● Floorplan for Guided Activities
Use this floorplan when the user carries out an activity for which he or she requires guidance, that is, an
activity that is not regularly performed or is unknown by the user. This floorplan provides a framework for
breaking down the activity step by step.
● Floorplan for Overview Page
Use this floorplan for activities that relate to managing business records, for example editing or deleting
records. The overview page (OVP) floorplan provides an overview of all important information regarding a
single instance of an object (such as a sales order, an employee, or an account). The OVP floorplan has highly
flexible page layout possibilities and numerous user personalization features.
The OVP floorplan supersedes the Object Instance floorplan (see below).
● Floorplan for Quick Activities
Use this floorplan when the user activity can be performed in one step and on one screen, that is, for a very
simple activity.
● Floorplan for Object Instances
Use this floorplan for activities that relate to managing business records or objects, for example, editing or
deleting records.
Integration
Floorplans form the basis of an application's layout. The content for an application is supplied by the user
interface building blocks (UIBBs) which are added to the pages within a floorplan configuration.
You edit the floorplan component configuration of an application using the FPM configuration editor, FLUID.
Related Information
Floorplan for the Overview Page (OVP) [page 10]
Floorplan Manager for Web Dynpro ABAP
FPM Basics © 2014 SAP SE or an SAP affiliate company. All rights reserved. 9
Floorplan for Guided Activity (GAF) [page 14]
Floorplan for Object Instances (OIF) [page 16]
Floorplan for Quick Activity (QAF) [page 18]
Working with Floorplans [page 254]
A section covering the features and activities concerning the various floorplans.
2.2.1 Floorplan for the Overview Page (OVP)
A design template that dictates the structure and behavior of a user interface of an overview page (OVP).
You can use this floorplan to model an application interface that initially displays an overview of the most
important data to users for a business object such as an employee or a sales order. From there, users can
navigate to various pages, for example, editing pages to add, change, or delete data. The OVP floorplan has
numerous layout possibilities at design-time and can be easily personalized at runtime.
Runtime Layout
At runtime, an OVP application consists of content displayed in a number of collapsible panels. Depending on the
configuration of the application, these panels can be moved around the UI, and even stacked upon each other to
form a tab-strip. An OVP application may also display a Page Master panel (explanation below). The following
screenshots illustrate how an application based on an OVP floorplan might look at runtime:
Floorplan Manager for Web Dynpro ABAP
10 © 2014 SAP SE or an SAP affiliate company. All rights reserved. FPM Basics