Start of Content Area

Object documentation Web Template Parameters  Locate the document in its SAP Library structure

Definition

Web item that you can use to specify the parameters of a Web template.

Structure

The following information lists the parameters for the Web Template Parameters Web item, arranged according to the various parameter groupings.

Internal Display

Parameter

Description

Errors Visible

(ERRORS_VISIBLE)

You use this parameter to specify whether error messages are to be displayed in the Web application.

Warnings Visible

(WARNINGS_VISIBLE)

You use this parameter to specify whether warnings are to be displayed in the Web application.

Information Visible

(INFORMATION_VISIBLE)

You use this parameter to specify whether information is to be displayed in the Web application.

System Messages Visible

(SYSTEM_MESSAGES_VISIBLE)

You use this parameter to specify whether system messages are to be displayed in the Web application. You can also select a value for Display Mode for System Messages (SYSTEM_MESSAGES_DISPLAY_MODE):

      Always Display Messages (ALWAYS)

      Display Messages Once a Day (ONCE_A_DAY)

Behavior

Parameter

Description

Display Variables Screen

(DISPLAY_VARIABLE_SCREEN)

Relevant when calling a Web template that contains one or more query views with input-ready variables.

You use this parameter to force display of the Variables screen. If this parameter is not set, the variable screen is suppressed when possible; however, it is displayed if input-ready mandatory variables have not been filled, for example.

Use Specific Variant Catalog

(USE_SPECIFIC_VARIANT_CATALOG)

Relevant when calling a Web template that contains one or more query views with input-ready variables.

Using this parameter, you can use the variant catalog for the queries used. If the Web application contains just one query, you can use the variants for this query.

Reset Variable Values to Default

(CLEAR_VARIABLES)

Relevant when calling a Web template that contains one or more query views with input-ready variables.

You use this parameter to remove the default values from the query view. The variables then have the default values from the variable definition.

Display Same Variable Only Once

(MELT_VARIABLES)

Relevant when calling a Web template that contains multiple query views with input-ready variables.

You use this parameter to specify for the variable screen whether variables that are used in all the query views and in the same context (same compounding and initial value) are to be displayed for input just once.

If the variables are based on different InfoProviders, the input help is read from the master data table.

Display Personalized Variables

(SHOW_PERSONALIZED_VARIABLES)

You use this parameter to specify whether the personalized variable values are already displayed as initial in the General Variables screen area. More information: Personalizing Variables  in Web Applications

Web Template Has Main Object

(TEMPLATE_HAS_MAIN_OBJECT)

You use this parameter to define a main object for a Web template and use it for personalization (for example, for generic Web templates) or the Text Web item.

You can use reports (report default template), or query views (query view template) as main objects.

If you activate this parameter, you specify the Web template (MAIN_TEMPLATE_OBJECT) as the main object:

      Data Provider (TEMPLATE_OBJECT_DATA_PROVIDER)

The main object is a data provider. Specify the relevant data provider.

      Web Item (TEMPLATE_OBJECT_ITEM)

The main object is a Web item. It is particularly useful to use the Report Web item.

RRI Open Mode (RRI_OPEN_MODE)

You use this parameter to specify how the jump target for the report-report interface (RRI) is to be opened.

      Open in Separate Window

(OPEN_IN_NEW_WINDOW)

      Replace Current Web Application

(REPLACE_WEB_APPLICATION)

      Replace the Parent Frame of the Current Web Application

(REPLACE_PARENT_FRAME)

      Replace the Top Frame of the Frameset

(REPLACE_TOP_FRAME)

      Open in Named Window

(OPEN_IN_NAMED_WINDOW)

You specify the name of the window in the parameter WINDOW_NAME.

      Replace Named Frame

(REPLACE_NAMED_FRAME)

You specify the name of the frame in the parameter FRAME_NAME.

More information:

      Goto  

      Report-Report Interface

Standard Actions of the Web Template

(WEB_TEMPLATE_ACTIONS)

You use this parameter to specify a command sequence that is to be executed at specific times on the server. The following times are currently supported:

      Action Before Rendering (ACTION_BEFORE_RENDERING)

The command sequence is always executed before a Web application is rendered. This allows you, for example, to set UI elements as active or visible depending on the status of Web items.

      Action Before First Rendering (ACTION_BEFORE_FIRST_RENDERING)

The command sequence is always executed once before a Web application is first rendered. By executing this command sequence once, you can use this command sequence to adjust the initial state of data providers, for example, by setting filter values or variables.

More information:

Using Parameters to Call Web Applications

Only Update Changes (USE_SNIPPETS)

You use this parameter to define whether the Web application should be displayed flicker-free. With flicker-free display of Web applications, only changes to Web template objects caused by navigation are updated. The unchanged parts of the Web application remain in their original state. This provides the user with a better (flicker-free) display.

Behavior when Loading a Bookmark

(BOOKMARK_LOADING)

Here you specify the behavior of the Web template when loading a bookmark. The following options are available for this purpose:

      Use parameter for Variables screen (VARIABLE_SCREEN_SETTING)

Here you decide whether the Variables screen is shown or hidden when a bookmark is loaded:

       Default (DEFAULT)

If you choose this option, the settings of the parameter Display Variables Screen (DISPLAY_VARIABLE_SCREEN) are applied.

       Show (SHOW)

       Hide (HIDE)

      Use parameter to reset variables

       Default (DEFAULT)

If you choose this option, the settings of the parameter Reset Variable Values to Default (CLEAR_VARIABLES) are applied.

       Reset (CLEAR)

       Retain (KEEP)

Stateless Navigation

(STATELESS)  

The status is removed on the server after each navigation step. Using this parameter is only recommended with pages that are rarely navigated to.

Take note of the following background information when setting this parameter: Between two navigation steps, the status of the web application on J2EE and ABAP is not retained in the main memory. During a navigation step, however, additional computing effort arises in order to restore the status at the beginning of the navigation step and to remove the status at the end of the navigation step.

This makes navigation slower for the user due to the additional computing effort. As users generally pause between two navigation steps, however, a larger throughput Is possible in multi-user operation, as the main memory is not in permanent use.

Note

In planning applications, the STATELESS setting only causes a minor reduction of the occupied memory on J2EE, as planning applications require the status to be retained on J2EE and ABAP.

Data Binding

Parameter

Description

Variant (VARIANT)

You use this parameter to specify the variant with which the Web application is to be executed.

Document Save Level for InfoProvider Data (DOCUMENT_SAVE_LEVEL)

You use this parameter to specify for which area the documents for InfoProvider data are to be created:

      Query Level (0):

New documents are assigned to the current InfoProvider and the current query (that is, the query on which the data provider is based). The documents are not displayed in other Web applications based on other queries, even if the selections are otherwise identical.

      InfoProvider Level (1):

New documents are assigned only to the current InfoProvider. The documents are displayed in other Web applications based on other queries, but only if the additional selections match and the queries are based on the same InfoProvider.

Example

Planning applications are typically created for the InfoProvider level: plan data is generally recorded with other data and later evaluated. If you create comments that are also to be visible for the analysis, you have to choose InfoProvider level for the planning application.

More information: Creating New Documents

Integration

From a technical point of view, Web template parameters are Web items. The Web item is not included in the list of Web items in the Web Application Designer, however, but is available in the Properties screen area in Web Application Designer.

More Information:

Web Template Properties

Overriding Parameters

 

End of Content Area