Object Editor  

Use

You can use the Object Editor pattern to design, create, or edit objects and object attributes within an application. The resulting editor, whose components are provided as component interface implementations for interface definitions in the Object Editor, contains the Attachments and Classification Assignment patterns.

Features

The Object Editor pattern consists of the following parts:

●     Object Editor Configurator, which also includes:

○     Header component configurations

○     Tab configurations

●     Generated Object Editor UI

Object Editor Configurator

You can divide the configuration screen into the sections Object Editor Configuration, Object-related Entries, and Tab Settings. They are described in detail below.

Object Editor Configuration

When you configure the Object Editor, you define the Service Module and Header Aspect and name the configuration (located at the base of the screen layout). Programming definitions in the Service Module and data types of the Header Aspect (Show Aspect Fields) influence the fields that can be selected for display in the Object Header Editor.

Object-related Entries

Object Related Entries lists the fields that are displayed in the Object Editor and shows which information appears at the base of the screen layout. These lists describe the various actions that are related to an aspect of an object.

Enterprise Service Framework (ESF) terms such as author and createdBy appear in the generated user interface as Author and Created By in the ID and name columns together with their respective data types (for example, date or string).

Actions such as Save and Close, which appear at the base of the generated Object Editor, are defined based on the parameters in the Buttons that should appear as footer of Object Editor window: They are listed in the table below.

 

Parameter	Description
action	ESF command leading to execution of desired action.
name	Command name that appears on the button.
application name	Lists the navigation to the specified WebDynpro application.
parameters	Points to the string of application parameters appended to the WebDynpro application.
DC name	This is the development component name used for launching the application.

 

Header Components

Above the Tab Settings window, you can specify the object title that will appear as the object header and select whether or not the object has its own component implementation. If this field is activated, the following need to be specified:

●     Component

A WebDynpro term used to describe application-level building blocks. They are the technical basis for generating the predefined header in Object Editor pattern.

●     Development Component

Contains project information for the application.

●     Configuration name

Header attributes for the resulting layout are defined using additional configuration parameters. The configuration results appear at the top of the generated user interface layout.

Header Attributes Configuration

The Service Module and Aspect definitions are the same as in the Object Editor configuration. The Header Attributes in the editor screen table contain the columns listed in the table below.

 

Header Attributes	Description
Mandatory	Activating this box indicates that an attribute field must be filled out or selected in the generated layout.
Name	ESF term used to describe which command will be executed after selection.
Description	The name that will appear as header.
Position	Describes numerically the order in which Description appears in the layout. Activating the box in the first unnamed column selects the entire row and object to be displayed.

 

The rest of the layout lists additional aspect fields and other configuration parameters:

Header Attributes	Description
User Assignment Configuration	Is the name of the configuration file for the User Assignment pattern. Selecting Configure leads to the User Assignment Configurator.
Name of configuration file	This is the name of the file for the defined parameters.
Default Subject for e-mail	Is the standard subject line for emails when sent to a recipient from the editor.
Default Body for e-mail	Standard text that appears when an email is sent from the object editor. It contains the URL pointing directly to the object within the application.

 

Tab Page Settings

As with the header components, you can define and configure the tab page for the application editor. The tab page definitions are listed in the table below:

Tab Page Definition	Description
Interface	Describes the function used in the user interface, in this case a tab page will be defined.
Component Name	The technical basis for generating the predefined tab page layout in the  Object Editor pattern.
Name to appear for Tab	This is the name that will appear on the tab page.
Associated Aspect	Is the name of the aspect used for the tab page settings. If you specify the aspect without changing the default component, then a flow layout of field label pairs is generated for the given aspect in the respective tab.
Development Component	Contains the application information for tab page layout. If you specify a component along with a development component, then this component is displayed in the tab page.
Configuration Name	Name the configuration
Configure	Choosing this leads you to the tab page attributes configuration screen.

 

Object Editor UI

After you have generated the Object Editor, you can see configuration definitions for the editor along the top and bottom of the layout. You can see tab configurations displayed with the corresponding tab strips in the middle of the screen. Embedded in this pattern are also the Attachments and Classification Assignment patterns.