Show TOC Entering content frame

Object documentation Object Tag for the Properties of Web Templates Locate the document in its SAP Library structure

Definition

Object Tag for defining the properties of Web templates.

Use

The attributes of a Web template can be defined in an object tag. All of the properties of the context menu are also part of the Web template attributes listed below. These properties can also be transferred, together with the URL, when calling up the Web template.

Note

Parameter 'CMD' must be set to 'SET_PROPERTIES' to indicate that these are the attributes of the Web template.

Attributes

Description

TEMPLATE_ID

Name of the Web Template

Name under which you stored the Web template in the Web Application Designer.

STATELESS (optional)

‘X’ = Yes, ‘  ’ = No

Stateless Navigation

For Web templates that are used almost exclusively for display without further navigation, it is more useful to set the attribute STATELESS. The session on the application server is terminated when the Web template is created. This saves resources on the application server.

Note

If this attribute is not specified, it is assumed that the page is still needed for navigating.

 

USE_PERSONALIZATION (optional)

'X' = Yes, '  '  = No

Use personalized Web template, if available

If the parameter is set to ‘X’, the personalized Web template for the current user is used. If personalization does not exist for the Web template or the parameter is not set, the Web template is executed without personalization.

STYLE_SHEET (optional)

Path to a stylesheet that you want to use to display the Web template.

This overwrites any stylesheet that you may have already assigned to the Web template.

Example
Example for a path specification:

/sap/bw/mime/BEx/StyleSheets/Meadow_BWReports.css

JAVASCRIPT (optional)

’X’ = activate, ‘    = do not activate

Using JavaScript

Using this parameter, you ensure that Web applications are created using JavaScript (extensive interaction options) or suppress the use of JavaScript (restricted interaction).

Note

If this attribute is not transferred, JavaScript is activated automatically in Web browsers of version >=4.0.

 

SNIPPET_OPERATIONS (optional)

’X’ = activate, ‘    = do not activate

Reload changed components of the page

You use this attribute to control whether only changed objects are loaded in navigation. This function has higher Web browser requirements. For this reason, this function is only supported by Microsoft Internet Explorer version >=5.0.

Note

If this attribute is not transferred, loading is activated automatically for the suitable Web browsers.

 

ENABLE_OPEN_WINDOW (optional)

’X’ = activate, ‘    = do not activate

Open dialogs in new windows

Using this attribute, you can control whether a new browser window is opened, for example, for the properties dialog box or for filtering. If this attribute is not specified, new windows are opened (if supported by the Web browser).

Note the following:

If you use the parameter ENABLE_OPEN_WINDOW=’ ‚ in combination with the parameter USE_PAGE_WRAPPER=’X’ or within a frameset, a Web browser window is not opened automatically when a bookmark is called. In this case, the bookmark URL and the associated bookmark functions cannot be used as such.

If you want to use the bookmark function, choose either

ENABLE_OPEN_WINDOW=’ ’ or  USE_PAGE_WRAPPER=’X’ (not in combination, however); as an alternative you can call the bookmark function yourself in a separate window.

VARIABLE_SCREEN (optional)

‘X’ = activate variable screen, ‘  ’ = do not activate, if possible

Force variable screen display

If you call up a Web template that includes the query views containing variables that are ready for input, you can use these attribute to display the variable screen. If you do not set this attribute, or set it to ‘  ’, the variable screen is hidden, wherever possible. However, it is still shown if, for example, the required variables that are ready for input have not yet been filled.

MELT_VARIABLES (optional)

‘X’ = merge, ‘  ’ = display each query individually

Display same variables only once

The same variables for different queries are only displayed once.

If you call up a Web template containing several query views that have variables that are ready for input and you go to the variable screen display, you can determine, through these parameters, whether variables that are used in all query views and in the same context (same compounding, same initial value), are to be provided for input only once.

If the variables correspond to different InfoProviders, the input help is automatically read from the master data table.

VARIABLES_CLEAR (optional)

‘X’ = reset variable, ‘  ’ = do not reset

Reset variables to default values

If you call up a Web template that contains one or more query views that have variables that are available for entry, you can specify this attribute to reset the default variables through the query view. Afterwards, the variables have the default settings from the variable definition.

SUPPRESS_WARNINGS (optional)

‘X’ = do not display warnings, ‘  ’ = display warnings

Do not display warnings

With this attribute, warnings are not displayed. Terminations are still displayed.

SUPPRESS_SYSTEM_MESSAGES (optional)

‘X’ = do not display system messages, ‘  ’ = display system messages

'CONDITIONAL' = only display system messages for the user once a day.

Do not display system messages

With this attribute, system messages are not displayed.

If you assign the value ‘CONDITIONAL’, system messages are only displayed once a day for each user.

DATA_MODE (optional)

‘NEW’ = use current data

‘STORED’ = use precalculated data

‘HYBRID’ = use precalculated data; request current data if this is missing.

‘STATIC’ = use precalculated HTML pages

‘STATIC_HYBRID’=  use precalculated HTML pages. If there are none, search for precalculated data; if nothing found, request current data.

Read mode for data

If you do not specify this attribute, a request is without exception sent to the OLAP processor and the current data is read.

For the modes ‘STORED’ and ‘HYBRID’, data has to be precalculated using the Structure linkReporting Agent.

See Structure linkDefining the Web Templates Setting.

DEVICE_OPTIMIZATION

Output optimization (device-dependent)

When this attribute is selected, automatic, device-specific optimization of Web item settings at runtime (for example, chart size for PDAs) is performed.

NO_SESSION_COOKIE

‘X’ = session encoding in the URL,    ‘ = no session encoding in the URL

Session encoding in the URL, instead of by cookie. Each Web application runs in its own session.

A cookie is used by default to manage the session for a stateful BEx Web Application. This can lead to possible problems, however, you can eliminate these with the help of this attribute.

Background documentation

In the following cases it is preferable to use session encoding in the URL:

·        You are integrating a BSP Application (BC-BSP) into a BEx Web Application. The BEx Web Application is also sent to the BSP application. The BSP application exits the session, for example because it is stateless. This causes a timeout in the BEx Web Application. You can use the attribute Session Encoding in the URL instead of by Cookie to avoid this problem. The BEx Web Application then uses the session coding in the URL and no session cookie is sent to the BSP application.

·        Several initial call-ups from different BEx Web Applications occur simultaneously in the same Web browser (for example in the case of a frameset, where the frames contain different URLs from BEx Web Applications). In this case the default use of session cookies causes errors. As there is no initial session, each request produces a new session on the server. Accordingly, each reply sent back to the Web browser contains a new session cookie. However the session cookie always has the same name and is therefore overwritten in the Web browser with each reply. Navigation to the BEx Web Application, for example sent back from the server first, also uses the session cookie from the previous reply. However, in this session the state of the Web application is not given. You can use the attribute Session Encoding in the URL instead of by Cookie to avoid this problem. The session is then always contained within the URLs and is not influenced by other BEx Web Applications.

·        The Web browser used does not support cookies (this is the case for example with some mobile devices). However in this case, the automatic device recognition starts the application for such devices in the NO_SESSION_COOKIE=X session.

When using the attribute Session Encoding in the URL Instead of by Cookie, no session bundling between different BEx Web Applications follows. Each Web application is allocated its own session on the server.

USE_PAGE_WRAPPER

' ' = not active, 'X' = active, 'PING' = prevent timeout

Automatic Session Management

If you select this attribute, the resources are automatically released to the server. For more information about this attribute, see Web Template Properties.

See the note for the use of the parameter USE_PAGE_WRAPPER=’X’ in combination with the parameter ENABLE_OPEN_WINDOW=’ ’ (see above).

RRI_DISPLAY_TARGET

Default setting: menu bar RRI

·        Show jump target in

With this attribute you can control the RRI jump from the context menu.

When the default setting is selected, the RRI jump takes place in a window with a menu bar.

If you do not make an entry, the RRI jump always takes place using a new window.

If you enter a frame name, the RRI jump takes place in this frame.

If you enter the name of an existing window, the RRI jump takes place in the window with the specified name.

Also see Web Template Properties and Properties of a Web Template.

Examples

The Web template should appear with variables entry

<object>

   <param name='OWNER' value='SAP_BW'>
   <param name='CMD' value='SET_PROPERTIES'>
   <param name='VARIABLE_SCREEN' value='X'>
</object>

Context menu should not contain an enhanced menu

<object>

   <param name='OWNER' value='SAP_BW'>
   <param name='CMD' value='SET_PROPERTIES'>
   <param name='MENU_ENHANCED' value=' '>

</object>

 

The following additional attributes for setting data providers or special data providers / Web items are usually set only in conjunction with command URLs for calling up Web templates. However, they can also appear statically in the object tag. The index in the parameter is indicated in the following by '_I'.

Displaying a Query           

Attributes

Description

INFOCUBE

Technical name of the InfoProvider

QUERY

Technical name of query

VARIANT (optional)

Variant if you are not required to enter a variable.

 

Display of another query view

Attributes

Description

DATA_PROVIDER_ID

Technical name of the query view

VARIANT (optional)

Variant if you are not required to enter a variable.

Recommendation

The attributes PAGEID and WBID that are used in BW 2.x are supported for the Web templates created under BW 2.x. However, we recommend that you no longer use these.

Attributes for overwriting the data provider initialization

Attributes

Description

SET_DATA_PROVIDER_I

Logical name of the data provider

Name of the data provider for which you want to set a new initialization.

INFOCUBE_ I (Option 1)

Technical name of the InfoProvider

QUERY_ I (Option 1)

Technical name of query

DATA_PROVIDER_ID_ I (Option2)

Technical name of the query view

VARIANT (optional)

Variant if you are not required to enter a variable.

Attributes for overwriting the Web item initialization 

Attributes

Description

SET_ITEM_I

Logical name of the Web item

Name of the Web item for which you want to set a new initialization.

ITEM_ID_I (Option 1)

Web item key

A Web item is created for a Web template on the basis of a Web item setting made in the Web Application Designer.

ITEM_CLASS_I (Option 2)

Class name of the Web item class

Name of the ABAP object class that output generation transfers. This corresponds to the use of non-reusable Web items (standard Web items) in the Web Application Designer. Web items are created with the default values for the attribute.

The class name for the table is  CL_RSR_WWW_ITEM_GRID for example.

 

 

 

 

 

 

 

Leaving content frame