Show TOC

Function documentationManaging of UI Configurations Locate this document in the navigation structure

 

You use this Web Dynpro application (USMD_UI_CONFIGURATION) to run functions of the Floorplan Manager (FPM), which enable you to create and edit UI configurations. UI configurations apply to all clients.

Integration

You implement UI configurations in the following places:

  • In editing of users and roles under Personalization

    System administration can assign a standard data model and a UI configuration for users.

  • When creating a change request

    You can assign the ID of a UI configuration for each change request type on the level of the entity type in Customizing for Master Data Governance under   General Settings   Process Modeling   Change Requests   Create Change Request Type  . This applies only to change request types with the Single Object attribute and only to the main entity type.

    The system sets this UI configuration assignment to the highest priority. If no entry is made for the change request type, the system uses the user-specific UI configuration assignment made under Personalization. If no UI configuration is assigned to the user, the system uses the UI configuration assigned to the role.

  • At the runtime of single processing

    You can adjust the user-specific (but not the role-specific) settings by choosing Change Model.

You can override the standard processing of the UI configuration by means of the Business Add-In BAdI: Adjust User Interface for Single Processing (USMD_UI_EVENT2). This BAdI allows for extensive UI adjustments.

Prerequisites

  • You run the Web Dynpro application USMD_UI_CONFIGURATION, for example, in Customizing for Master Data Governance under   General Settings   UI Modeling  , with activity Edit UI Configuration.

  • An active data model exists.

  • You have basic knowledge of how to use the FPM and of the configuration of applications and components with Web Dynpro ABAP.

Features

Creating UI Configurations

When creating a UI configuration, the system starts the FPM Application Hierarchy Browser. Creation is only possible in deep copy mode. At first, creation is concerned only with creating an ID for the UI configuration.

Recommendation Recommendation

We recommend that you at least change the Target Configuration ID in the row for the application configuration. The system uses this alphanumeric value for the personalization of the user and role settings.

The target configuration ID represents the UI configuration. In the FPM, the UI configuration is a Web Dynpro application configuration for the Web Dynpro application USMD_ENTITY_VALUE2 (single processing).

End of the recommendation.

During creation, the system generates a copy of the delivered UI configuration USMD_ENTITY_VALUE2 that contains all dependent UI configurations. From this copied template, the system applies all settings for the header data as well as the identification section (IDR) with all lower-level nodes. The system automatically creates a target configuration ID for each application configuration and each component configuration.

When you use Create with Template, the system also copies the data model assignment and the user-interface building blocks (UIBB) of the component configuration FPM_OIF_COMPONENT.

Editing UI Configurations

Recommendation Recommendation

We recommend that you do not edit the delivered UI configurations, if avoidable.

End of the recommendation.

The following editing options (among others) are available:

  • You can assign the data model.

    New UI configurations do not have an assigned data model. You can therefore assign a data model while editing the UI configuration.

  • In the component configuration, you can select and configure the UIBB.

    The selection that is available depends on the entity type and the data model. You can create one or more main views for each entity type with storage and use type 1. You create at least one UIBB per view.

  • You can link fields in UIBBs to one of the delivered standard events:

    • USMD_ENTER

      Event when pressing the Enter key

    • USMD_ACTION

      Event when choosing a pushbutton or executing a link

      If you use multiple pushbuttons or links, also specify an Identifier for this event ID. This lets you distinguish between different events in the BAdI USMD_UI_EVENT2.

  • If the entity type supports the respective function, you can add the following UIBBs:

    • For hierarchies, the Hierarchy Relationship UIBB

    • For sets, the Sets UIBB

    • For attachments, the Attachments UIBB

    • For language-dependent texts, the Text Translation UIBB

    When these are added, the system automatically copies the standard UI building blocks that are needed.

  • For entity types with storage and use type 4, you can configure the table display according to the master/detail principle. When you select a row in a higher-level table (master table), the system displays the dependent detail data in a form below the table.

    To configure a master/detail display, when you create a form UIBB, specify as the Contained Entity Type the entity type for which you configured the higher-level table.

    Note Note

    For a simple form, there is no need to enter the Contained Entity Type in the dialog box Edit Parameters. However, you do need to specify this if you want the system to display further details for the entity type of the master table.

    End of the note.

  • Embedding external entity types

    If you simply want to display the data for external entity types, you can also embed entity types other than the one you are currently editing into the UI. To do this, in the entity type you are currently editing, you simply specify the configuration ID of the external entity type (by overwriting the entry in the Config. Name field).

    Example Example

    You display the account for the entity type Account (Company Code) – this contains the company code-dependent data.

    End of the example.

    You can add any number of form or table UIBBs from external entity types of your own data model. To notify single processing of a unique ID for the value to be displayed, you might need to implement the BAdI USMD_UI_EVENT2.

  • Testing

    You can choose the pushbutton for testing in the application configuration to preview how your UI configuration will look in single processing.

Activities

Create

  1. You choose Create. The system opens the Floorplan Manager Application Hierarchy Browser.

  2. You overwrite the target configuration ID with a descriptive value within the customer namespace <Z...>.

  3. In deep copy mode you choose Start Deep Copy.

    1. You select the package for the Web Dynpro Component Configuration and confirm the dialog boxes that follow.

    2. The system creates a new UI configuration based on the template configuration USMD_ENTITY_VALUE2.

  4. You refresh the display of the Web Dynpro application Manage UI Configurations. Your new (custom) UI configuration appears in the list.

Create with Template

First, on the Manage UI Configurations screen, you select a UI configuration (for example, one delivered by SAP or one that has already been edited and has an assigned data model) and you choose Create with Template. The system creates a new UI configuration in which you assign a custom target configuration ID to a custom configuration ID.

Edit

  1. On the Manage UI Configurations screen, you select a UI configuration (for example, a new one that does not have an assigned data model) and you choose Edit. The system opens the editor for the Web Dynpro ABAP application configuration.

  2. You choose Change.

    1. On the Properties tab page, you change the description of the UI configuration.

    2. To assign a data model, you open the Application Parameters tab page, specify the data model under USMD_MODEL, and save your entries.

    3. On the Structure tab page, you choose Go to Component Configuration. (This is available only after you have assigned the data model.) The system displays the screen for editing the component configuration (configuration of the OIF component), which is divided into multiple views.

    Note Note

    The selection of standard entity types in the standard data model contains the dummy entry Must Be Deleted. You can delete this entry once you have created the first entity type.

    End of the note.

  3. You choose Add and, in the related context menu, you select the entry Entity Type, for example, for data model 0G you select the entity type Account (ACCOUNT).

    1. You create the entity type.

    2. You delete the dummy entity type (called Must Be Deleted).

  4. To create UI building blocks for the entity type, you choose Add UIBB.

    The system opens a default UI building block (UIBB). The system adds a template for a UIBB automatically for each main view. You need to delete this incomplete dummy entry prior to saving.

    1. You choose Add Form. The system opens a screen area with details for the UIBB you just created.

      The system offers you the following building blocks (among others):

      • Table

        This choice is available if the selected entity type has at least one entity type (storage and use type 4).

      • Attachments

        If this is chosen, the system immediately copies the standard UI building blocks that are needed for attachments.

      • Text Translation

      • Hierarchy Relationship

    2. If you haven't already done so, you now must delete the superfluous default UIBB. In either case, you save the configuration.

  5. For the new UIBB you choose Configure UIBB. The editor for the Web Dynpro ABAP Component Configuration appears. For more information, see Configuration of the User Interface of an Entity Type.

  6. You edit the UIBB attributes (in this case, form attributes) using the functions of the FPM.

    Note Note

    You can also use the FPM to configure sets, hierarchy relationships, and tables (but not attachments or text translation).

    End of the note.

  7. You choose Save.

More Information

Floorplan Manager for Web Dynpro ABAP

Application Hierarchy Browser for Floorplan Manager