SAP BW

SAP BW

Web Reporting

Function Description

14. February 2001

Version 2.0B13

(Valid as of BW 2.0B Server Patch 13)

SAP AG assumes no responsibility for errors or omissions in these materials.

These materials are provided “as is" without a warranty of any kind, either express or implied, including but not limited to, the implied warranties of merchantability, fitness for a particular purpose, or non-infringement.

SAP shall not be liable for damages of any kind including without limitation direct, special, indirect, or consequential damages that may result from the use of these materials.

SAP does not warrant the accuracy or completeness of the information, text, graphics, links or other items contained within these materials. SAP has no control over the information that you may access through the use of hot links contained in these materials and does not endorse your use of third party web pages nor provide any warranty whatsoever relating to third party web pages.

Function Description

Contents:

1 Overview ......................................................................................................................... 4

2 Glossary .......................................................................................................................... 5

3 Templates ........................................................................................................................ 7

3.1

Structure ...................................................................................................................................................... 7

3.2

Object Tags .................................................................................................................................................. 7

3.2.1

Structure of the Data Provider Object Tag ............................................................................................... 8

3.2.2

Structure of the Item Object Tag .............................................................................................................. 8

3.3

Command URLs .......................................................................................................................................... 9

3.4

Language-Dependent Texts ....................................................................................................................... 9

4 Object Model ................................................................................................................. 10

4.1

Templates .................................................................................................................................................. 10

4.1.1

Calling up Templates .............................................................................................................................. 10

4.1.1.1

Standard Call-up ................................................................................................................................. 10

4.1.1.2

Call up template with another data provider ....................................................................................... 12

4.1.1.3

Using default template for a data provider .......................................................................................... 12

4.1.2

Exchanging Templates ........................................................................................................................... 12

4.1.3

Change Icon List .................................................................................................................................... 13

4.1.4

Release Page ......................................................................................................................................... 13

4.1.5

Call up Variable Screen .......................................................................................................................... 13

4.1.6

Exit Session ............................................................................................................................................ 13

4.1.7

Entering Variables .................................................................................................................................. 14

4.1.7.1

Characteristic Value Variables: ........................................................................................................... 14

4.1.7.2

Hierarchy node variables: ................................................................................................................... 14

4.1.7.3

Hierarchies, formulas and text variables ............................................................................................. 15

4.1.8

Change variable values .......................................................................................................................... 15

4.2

Data Providers ........................................................................................................................................... 15

4.2.1

Generic Attributes ................................................................................................................................... 15

4.2.2

Commands ............................................................................................................................................. 16

4.2.3

View ........................................................................................................................................................ 16

4.2.3.1

Back, Forward, and Back to Start ....................................................................................................... 17

4.2.3.2

Filter .................................................................................................................................................... 17

4.2.3.3

Remove Filter ...................................................................................................................................... 18

4.2.3.4

Call up Input Help ................................................................................................................................ 19

4.2.3.5

Drilldown .............................................................................................................................................. 19

4.2.3.6

Remove Drilldown ............................................................................................................................... 20

14.02.2001 Seite 2


4.2.3.7

Exchange Characteristics/Structures .................................................................................................. 20

4.2.3.8

Switching Axes .................................................................................................................................... 20

4.2.3.9

Set Navigational Status ....................................................................................................................... 21

4.2.3.10

Sort .............................................................................................................................................. 21

4.2.3.11

Calculate Lists ............................................................................................................................. 22

4.2.3.12

Operations in Display Hierarchies............................................................................................... 22

4.2.3.13

Set Exception Status ................................................................................................................... 24

4.2.3.14

Set Condition Status ................................................................................................................... 24

4.2.4

Alert Monitor ........................................................................................................................................... 25

4.3

Item ............................................................................................................................................................. 25

4.3.1

Generic Attributes ................................................................................................................................... 25

4.3.2

Items for Views ....................................................................................................................................... 26

4.3.2.1

Table ................................................................................................................................................... 26

4.3.2.2

Navigation Block.................................................................................................................................. 26

4.3.2.3

Filter .................................................................................................................................................... 27

4.3.2.4

Text Element ....................................................................................................................................... 28

4.3.2.5

Chart .................................................................................................................................................... 29

4.3.2.6

Exception Block ................................................................................................................................... 29

4.3.2.7

Condition Block ................................................................................................................................... 29

4.3.2.8

. Selection List ...................................................................................................................................... 29

4.3.2.9

Selection Button Group ....................................................................................................................... 30

4.3.2.8

Label .................................................................................................................................................... 31

4.3.3

Item Alert Monitor ................................................................................................................................... 31

5 Parameterizing Templates ........................................................................................... 33

6 Command Sequences .................................................................................................. 34

7 Forms ............................................................................................................................ 35

7.1.1

Parameterizing Templates ..................................................................................................................... 35

Buttons and Forms in Templates..................................................................................................................... 35

14.02.2001 Seite 3


1 Overview

Business Information Warehouse Web Reporting enables you to access BW data using an Internet browser. In most cases, an Internet browser is installed at the same time as the operating system. No additional software installation is required. Demands on the Web browser are minimal, as the solution offered is based entirely on HTML.

This document is intended for Web designers who want to create complex applications (information cockpits, and so on) on the basis of BW Web Reporting.

14.02.2001 Seite 4


2 Glossary

Alert Monitor

The Alert Monitor presents the views that were retrieved with the help of the Reporting Agent in a background process as a list or hierarchy, and supports jumps to these views.

BW URL

By using “<SAP_BW_URL Attribute1=‘Value1' ...>” in a template, you can create links that transfer data providers or items from one state to another document.

.

For example, you can alter the size of a chart, or set a filter value for a view. Possible attributes and their values will be explained later in this

Data Provider

Object that serves as a data source. Data for an item, for example, is obtained from this object.

Item

Object set into an HTML page that gets data from a data provider. Examples are tables, navigation

blocks, charts, exception blocks, condition blocks, text elements, filter values and the Alert Monitor.

Item Table

Item that gets data from a view in order to create a table for an HTML page. In addition to the table, navigation links are also incorporated.

Item Text Element

Item that presents the text elements of a view. Text elements include the general text elements, variables and static filter values. These are the same text elements that already exist in the Business

Explorer Analyzer. It is also possible to select individual text elements.

Item Filter

Item that displays the view's filter values created by navigating. It is also possible to select individual text elements.

Item Nav Block

Item that gets data from a view in order to create a generic navigation block for an HTML page. This block contains buttons that take characteristics into the rows or columns, for example.

Item Chart

Item that gets data from a view in order to create a diagram for an HTML page. The attributes (chart type,...) are specified in the Web Publisher.

Item Exception

Item that lists the available exceptions for a View with their status (active / not active). You can change the status of the exceptions using buttons.

Item Condition

Item that lists the available conditions for a View with their status (active / not active). You can change the status of the conditions using buttons.

14.02.2001 Seite 5


Comment Tag

Up to and including 2.0A Patch 4, a comment tag was delivered by the Web Publisher as a bookmark for an item with a view for use in a template. These comments looked like this: “”. An object tag has been used since 2.0A Patch 5 to enable you to better edit the template and to make better use of enhancements.

Object Tag

With the help of the object tag, you create data providers and items in a template. The object tags are replaced by the created items HTML when you create an HTML page.

Style Sheet

The Cascading Style Sheets (CSS) are an HTML enhancement. You can define formats in them.

Styles are used in HTML created by BW Web Reporting items. Example CSS files that customers can change are included in the ITS scope of supply. Access a style sheet in the template if possible.

Template

The template specifies the structure of an HTML page for Web Reporting. Using the Web Publisher, you can insert bookmarks for items, data providers and BW URLs in an HTML document. The HTML document with BW-specific bookmarks is named in the following template and can be checked into the Web Publisher. The page is then available for Web Reporting.

View

Synonym for a navigational state (view) stored in the BEx Browser.

Web Publisher

The Web Publisher is part of the Business Explorer Analyzer (BEx). You can store navigational states as views. In turn, you can create items for these views.

14.02.2001 Seite 6


3 Templates

A template specifies the structure of an HTML page for Web Reporting. Using the Web Publisher, you can insert bookmarks for items (in the form of object tags), data providers (in the form of Object tags) and BW URLs in an HTML document. The HTML document with BW-specific bookmarks is named in the following template and can be checked into the Web Publisher. The page is then available for Web

Reporting. A template is identified by the WbID (workbook ID), the key for the workbook under which the template is stored, and the PageID, the name of the template.

3.1 Structure

A template is a basic framework for an HTML page containing bookmarks for items and command URLs. Usually, data providers are created first, followed by items and command URLs for an HTML page.

The following is an example of a simple template with a navigation block and a table:

<html>

<head>

<link rel="stylesheet" href="/sap/its/mimes/webrfc/bw/SAPBEx.css">

<title>New Page 1</title>

</head>

<body>



<object>

<param name='OWNER' value='SAP_BW'>

<param name='CMD' value='SET_DATA_PROVIDER'>

<param name='DATA_PROVIDER' value='View 1'>

<param name='VIEWID' value='View abc'>

DATA_PROVIDER :View 1

</object>



<object WIDTH="350">


<param name='CMD' value='GET_ITEM'>

<param name='ITEM' value='Nav Block'>

<param name='ITEMID' value='Nav Block'>


ITEM :Nav Block

</object>

<br>



<object WIDTH="600">



<param name='ITEM' value='Table'>

<param name='ITEMID' value='Table'>


ITEM :Table

</object>

</body>

3.2 Object Tags

Using the object tag, you can create data providers and items in a template and provide them with parameters. The parameters for items can override settings made in the Web Publisher (for example, width and height). Additionally, you can send a generic command (filter, change attributes) or a command sequence (see “Command Sequences”

14.02.2001 Seite 7

Function Description section) to the data provider at the start of the page. To do this, the parameters are added to the object tag (see examples).

An object tag starts with “ <object...> ” and ends with “ </object> ” . For identification purposes, SAP_BW object tags are given the parameter “Owner” with the value “SAP_BW”. ”. Only objects of this type are transformed into templates.

All other objects are transferred unchanged into the HTML page.

Parameters can be set at the start of the object tag

<object WIDTH='350' HEIGHT='234' owner='SAP_BW' ...></object> as well as within the object tag in the form of parameter tags.

<object>

<param name='owner' value='SAP_BW'>

...

</object>

Object tags are displayed in many HTML editors as well as in non-HTML code mode. FrontPage offers the extra option of changing the size and maintaining the object tag parameters. Object tags can usually be moved using drag and drop

(within a page).

3.2.1 Structure of the Data Provider Object Tag

The parameters required to create a data provider are provided by the Web Publisher. You can add further parameters, for example, to set up input help or to send a command to the data provider before calling up the page.

The 'Cmd ' parameter must be filled with 'SET_DATA_PROVIDER' to indicate that you are creating a data provider.

Examples:

Create view:

<object>






</object>

Create view with filter on country USA and style sheet for input help:

<object>





<param name='FILTER_IOBJNM' value='0COUNTRY'>

<param name='FILTER_VALUE' value='US'>

<param name='STYLE_SHEET' value='/sap/its/mimes/webrfc/BWReport.css'>


</object>

3.2.2 Structure of the Item Object Tag

The parameters required to create an item are provided by the Web Publisher. You can add further parameters, for example, to subsequently adjust the size or to set a title.

The parameter 'Cmd' must be filled with 'Get_Item' to indicate that you are creating an item

Examples:

Create item:

<object>



<param name='ITEM' value='Nav Block'>

<param name='ITEMID' value='Nav Block'>


ITEM :Nav Block

</object>

Create item with height 400 pixels, width 500 pixels and title “Business Graphic”:

14.02.2001 Seite 8


<object WIDTH='400' HEIGHT='500'>



<param name='ITEM' value='Chart 1'>

<param name='ITEMID' value='Pie Chart'>


<param name='GENERATE_CAPTION' value='X'>

<param name='Caption' value='Business Grafik'>

ITEM :Chart 1

</object>

3.3 Command URLs

In addition to object tags, you can also set command URLs in a template. They serve as bookmarks for URLs or to mark the start of a URL. They have the following structure:

<SAP_BW_URL Parameter1='Value1' Parameter2='Value2' ...

> and create a URL in the HTML page similar to the URL shown below:

/scripts/wgate//?_function=WEBQUERY&~SESSION=0000.003f.5f516493&pageno=1&request

_No=8& Parameter1=Value1&Parameter2=Value2&...

This URL requests a new page from the ITS. The parameters are processed here.

You can find examples of command URLs in the following section.

3.4 Language-Dependent Texts

The SAP_BW_TEXT tag is another BW tag. Using this tag you can install language-dependent texts in a Web site. To do this, you create text elements for an ABAP report. These can then be translated.

You can access the texts as follows:

<SAP_BW_TEXT PROGRAM=’MYREPORT’ KEY=’001’>

14.02.2001 Seite 9


4 Object Model

alert_monitor template

1

1

0..*

0..* data_provider

0..*

1 item view item_table item_nav_block item_filter item_text_elements item_exception item_condition item_filter_ddown item_filter_radio item_label item_char item_map item_alert_monitor

The aim of Web Reporting is to create HTML pages that reproduce data from BW. The Web designer uses templates to specify the data providers that will supply the data, the way in which ( items ) this data will be presented, and in which additional operations are to be made available (BW URLs).

If a Web Reporting request is sent to the BW server, an object template is first created that decides the structure of the requested HTML page. On the basis of this template , the following objects are created:



Data Provider



Item

4.1 Templates

The template specifies the structure of an HTML page for Web Reporting. Using the Web Publisher, you can insert bookmarks for items , data providers and BW URLs in an HTML document. The HTML document with BW-specific bookmarks is named in the following template and can be checked into the Web Publisher . The page is then available for

Web Reporting.

4.1.1 Calling up Templates

4.1.1.1 Standard Call-up

CMD

Parameter

WBID

PAGEID

STATELESS (optional)

LDOC

Description

Excel workbook key under which the template is stored in the BEx

The workbook must be stored in BW (favorites, activity groups

/ roles).

Template name

Name under which the template is stored in the Web Publisher.

Reduce the link to the server as soon as possible

14.02.2001 Seite 10


'X' = Yes, ' ' = No

STYLE_SHEET (optional)

TRACE (optional)

'X' = switch on, ' ' = do not switch on

VARIABLE_SCREEN (optional)

'X' = Display variable screen, ' ' = do not display, if possible

For pages that are only used for display without further navigation, it is better to set the attribute STATELESS. The session on the application server according to the structure of the page is reduced again. This saves on resources on the application server. The GENERATE_LINKS attribute is automatically set to ' ' when you create the page.

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

Path to a style sheet, which is used for the presentation of the page. This overwrites any style sheet the template may have assigned already.

Switch OLAP Trace on

With SAP, you usually need a trace to analyze problems. You can switch it on with the help of note 112458 or by using the

TRACE parameter.

Display Variable Screen

If you call up a template containing views with variables ready for input, you can use this parameter to display the variable screen. If you do not set this parameter, or set it to ' ', the variable screen is suppressed if possible. In any case, you can see whether required variables have not been filled, for example.

MELT_VARIABLES (optional)

'X' = melt, ' ' = display every query separately

Melt Variables

If you call up a template containing several views with variables ready for input, and you want to display the variable screen, you can use this parameter to determine whether you want the variables that are used in all views in the same context

(same InfoCube, same values), to be ready for input once only.

VARIABLES_CLEAR (optional)

'X' = Reset variables, ' ' = do not reset

Reset Variables

If you call up a template containing several views with variables ready for input, you can specify this parameter to clear what you entered for the variables by the view. The variables take on the entries made in the variable definition.

SUPPRESS_WARNINGS (optional)

‘X’ = Do not display warnings, ‘ ’ = Display warnings

Suppress Warnings

You can suppress the warning display using this parameter.

Termination messages are still displayed.

DATA_MODE (optional)

‘NEW’ = Use current data

'STORED' = use precalculated data

'HYBRID' = use precalculated data, if this is missing, request current data

Data mode

This parameter is optional. If it is not specified, requests are always sent to the OLAP processor and current data is read.

For the modes ‘STORED’ and ‘HYBRID’ you have to have precalculated data using the Reporting Agent. You can find further information in the documentation enhancement ‘2.0B

Exceptions, Conditions, Reporting Agent’.

14.02.2001 Seite 11


Examples:

Call up template without navigating: http://your_its/scripts/wgate/WebRFC/!?_function=WEBQUERY&CMD=LDOC&WBID=D9EW857M

LP6EN0AEM9BZSQP3C&PAGEID=Template_Name &STATELESS=X

Call up template with trace switched on http://your_its/scripts/wgate/WebRFC/!?_function=WEBQUERY&CMD=LDOC&WBID=D9EW857M

LP6EN0AEM9BZSQP3C&PAGEID=Template_Name &TRACE=X

Call up template with cleared variables and active variable screen. http://your_its/scripts/wgate/WebRFC/!?_function=WEBQUERY&CMD=LDOC&WBID=D9EW857M

LP6EN0AEM9BZSQP3C&PAGEID=Template_Name &VARIABLE_SCREEN=X&VARIABLES_CLEAR=X

4.1.1.2 Call up template with another data provider

This method replaces all data providers of the type view with the specified data providers.

This makes it possible to make a query or view available without making any further settings in the Web, and then use predefined templates for the page layout.

As well as those used in the standard call-up, this method also has the following parameters:

Call-up for presenting a query:

Parameter Description

INFOCUBE

QUERY

Technical name of the InfoCube

Technical name of the query

Variant, if you need to enter a variable VARIANT (optional)

Call-up for presenting a different v iew :

Parameter

VIEWID

DATA_PROVIDER_WBID

Description

Key for a view

A v iew gets its initial status from the specified ViewID. The

ViewID identifies a view within a workbook

Excel workbook key under which the data provider is stored in the BEx


/ roles).

VARIANT (optional) Variant, if you need to enter a variable

Examples:

Displaying a query using a self-selected template: http://your_its/scripts/wgate/WebRFC/!?_function=WEBQUERY&CMD=LDOC&WBID=D9EW857M

LP6EN0AEM9BZSQP3C&PAGEID=Template_Name &infocube=myCube&query=myQuery

4.1.1.3 Using default template for a data provider

If you call the previous variant without specifying a WBID or a PAGEID, the default template is used. You can make this setting in BW Customizing under ‘Reporting-relevant Settings -> Web Reporting -> Determine default web page'.

If no setting is made here, a template created by SAP is used.

Example:

Query without making any settings on the Web: http://your_its/scripts/wgate/WebRFC/!?_function=WEBQUERY&CMD=LDOC &infocube=myCu be&query=myQuery

4.1.2 Exchanging Templates

As well as being able to call one up, you can exchange a template. All items and data_providers of the start template are retained. The items and data_providers that are in the new template and for which there is no object of the same name are created again. The objects are identified by their logical name.

The basic difference in calling up the template is that already existing objects are transferred unchanged, meaning, for example, the navigation status of a view is retained.

14.02.2001 Seite 12


This function is designed specifically to switch between overview pages (often only with diagrams) to detail pages

(with tables and navigation blocks).

CMD

Parameter

WBID

CHANGE_TEMPLATE

Description

PAGEID



/ roles).

Template name


Examples:

<SAP_BW_URL CMD='CHANGE_TEMPLATE' WBID='D9EW857MLP6EN0AEM9BZSQP3C'

PAGEID='DETAILS'>

4.1.3 Change Icon List

This command makes it possible to use more icons than usual for specific Web pages, for example, for expanding and collapsing hierarchies. A different list of icons is assigned to the template. This, however, does not affect the names of the icons. In the new list, the icons must appear with their original name, but can be formulated differently.

CMD

Parameter

ICON_PREFIX

SET_URLS

Description

Relative path for a list of icons on the ITS

Example:

Displaying a template with icons from a different list:

This example uses a command sequence. See "Command Sequences" for more details. http://your_its/scripts/wgate/WebRFC/!?_function=WEBQUERY&CMD=LDOC&WBID=D9EW857MLP6EN0AEM9

BZSQP3C&PAGEID=Template_Name &cmd_1=cmd%3DSET_URLS%26ICON_PREFIX%3DmyPath

4.1.4 Release Page

You can use this command to remove the current page with all its objects from the memory of the application server.

The page can no longer be addressed. You must create it anew with the command ‘Call up template’.

You can use other commands as follow-up commands to initialize other pages, for example.

CMD

Examples:

<SAP_BW_URL CMD='PAGE_FREE'>

PAGE_FREE

4.1.5 Call up Variable Screen

This command allows you to call up the variable screen again for the current page. The variable screen then displays the previous variable values to be changed.

New values can also be transferred as explained in the unit ‘Entering Variables’. Alongside the values that have already been set, these new values serve as preassignments for the variable screen.

If you want the variable screen to appear when you call up the page, you must adjust the template (see section Call up

Template -> Default Call-up ).

CMD PROCESS_VARIABLES

SUBCMD VARIABLE_SCREEN

Examples:

<SAP_BW_URL CMD='PROCESS_VARIABLES' SUBCMD='VARIABLE_SCREEN'>

4.1.6 Exit Session

You can use this command to close the active session on the application server.

14.02.2001 Seite 13


CMD

~command (optional)

'logoff' = log off from the ITS

LOG_OFF

End Logon to ITS

If this parameter is set, you need to log on again to the system with your user and password if you want to use the system again.

Example:

<SAP_BW_URL CMD='LOG_OFF' ~command='logoff'>

4.1.7 Entering Variables

Query variables play a central role in BW. They can be used to filter the entire query of only parts of the query by values, before the data is read for the first time. There are variables with automatic replacement, replacement from authorizations, or variables that are ready for input.

You can process these variables in a dark color (without variable screen), or in a light color (with variable screen). In both cases you should enter parameters for the variables. All types of variables ready for input are supported here.

Contrary to filtering, you must specify the external value of the variables. This means, for example, that the data is copied over as it was entered.

You can also fill variables by parameterizing the URL. The values of the variables are separated from one another by different indexes.

In the following, '_I' indicates the index in the parameter.

4.1.7.1 Characteristic Value Variables:

Parameter variables are filled as follows:

Parameter

VAR_NAME_I

VAR_VALUE_EXT_I

Description

Technical name of the variable

Characteristic value in external display

Key of the characteristic value as it is displayed externally.

Interval variables are filled as follows:

Parameter

VAR_NAME_I

VAR_VALUE_LOW_EXT_I

VAR_VALUE_HIGH_EXT_I

Description


From-characteristic value in external display


To-characteristic value in external display


Selection option variables are filled as follows:

Parameter

VAR_NAME_I

VAR_OPERATOR_I

VAR_VALUE_LOW_EXT_I

VAR_VALUE_HIGH_EXT_I

VAR_SIGN_I

Description


Operator

EQ' = single value, 'BT' = interval, 'LT' = less than, 'LE' less equal, 'GT' = greater than, 'GE' = greater equal

From-characteristic value in external display


To-characteristic value in external display


Only specify this value with VAR_OPERATOR='BT'.

Effect of the row

'I' found values add,

'E' found values remove.

4.1.7.2 Hierarchy node variables:

Parameter

VAR_NAME_I

VAR_VALUE_EXT_I

VAR_NODE_IOBJNM_I

Description


Node key in external display

Name of the node characteristic


For characteristic nodes, you must enter the characteristic

14.02.2001 Seite 14

Function Description name, like you do for text nodes (0HIER_NODE).

4.1.7.3 Hierarchies, formulas and text variables

Parameter Description

VAR_NAME_I

VAR_VALUE_EXT_I


Hierarchy name, formula value, text

Examples:

Filling parameter variables: http://yourITS/…&pageid=yourTemplate& var_name_1=myParameterVariable&var_value_ext_1=4711

Filling parameter variable (4711) and selection option variable (1, 7 to 12): http://yourITS/…&pageid=yourTemplate& var_name_1=myParameterVariable&var_value_ext_1=4711&var_nam e_2=mySelOptVar&var_operator_2=EQ&var_sign_2=I&var_value_low_ext_2=1&var_name_3=mySelOptVar

&var_operator_3=BT&var_sign_3=I&var_value_low_ext_3=7&var_value_high_ext_3=12

Hierarchy node variable (DE, 0HIER_NODE): http://yourITS/…&pageid=yourTemplate& var_name_1=myHryNodeVariable&var_value_ext_1=DE&var_node_io bjnm_1=0HIER_NODE

4.1.8 Change variable values

You can use this command to change variable values for the active page.

Variable values are enterd as explained in the unit ‘Entering Variables’. Variables that are not specified keep their previous value.

CMD

SUBCMD

PROCESS_VARIABLES

VAR_SUBMIT

Examples:

<SAP_BW_URL CMD='PROCESS_VARIABLES' SUBCMD='VAR_SUBMIT'

VAR_NAME_1=’myParameterVariable’ VAR_VALUE_EXT_1=’4711’>

4.2 Data Providers

Data providers are objects that deliver data. You can change the status of the data provider by navigating through the data or by setting parameters for the call. A data provider can supply any number of items with data.

4.2.1 Generic Attributes

Generic attributes are attributes that are valid for every data provider.

These attributes are required right from the point of creating the data provider

Attribute

DATA_PROVIDER ( or name )

You cannot change this attribute with a command URL.

WBID ( or DATA_PROVIDER_WBID )

(optional)


Description

Logical name of the data provider

This name is used to couple items with this data provider and to send commands to the data provider.

The name must be unique within the template .



/ roles).

If this parameter is not specified, the template WBID is used instead.

14.02.2001 Seite 15


4.2.2 Commands

You can use commands like “filter” with data providers. These commands usually have to be supplied with parameters.

Some commands allow you to enter a list of parameter values. The parameter name is given an index “_1“, “_2“, ... .

This is shown in the following by “Parametername_n”.

For every command at least one example is specified, relating in particular to the syntax, as described in the section

“Command URLs”.

All commands have the following parameters in common:

Parameter

CMD

DATA_PROVIDER

DATA_PROVIDER_N

Description

Command name

Most commands are triggered using this parameter. In addition to this kind of command there are also generic commands whose parameters can be added to other commands. Generic commands are always applied after the named commands.

Data provider name

A command can be applied to several data providers . In addition to explicit information from a data provider , you can also specify a list of data providers or restrict the quantity using wildcards (multi='X'). The command is then applied to all these data providers as long as they allow this operation.

You must specify the data provider(s) .

MULTI

Optional

'X' = Yes, ' ' = No

Use DATA_PROVIDER as template

If MULTI is set to 'X', then the command is applied to all the data providers that contain the template. ‘*’ corresponds, for example, to all data providers.

Examples:

Apply command to 'DP 1':

<SAP_BW_URL DATA_PROVIDER='DP 1' CMD='…' ...>

Apply command to 'DP 1' and 'DP 2':

<SAP_BW_URL DATA_PROVIDER_1='DP 1' DATA_PROVIDER_1='DP 2' CMD='...''

Apply command to all data providers containing 'USA' in the name:

<SAP_BW_URL DATA_PROVIDER='*USA*' MULTI='X' CMD='...' ...>

4.2.3 View

You can store different views of a BW query. When you call a template , a view (not a database view) with the saved navigational state is created on the server.

Views have the following attributes:

Attribute

ViewID


Description

Key for a view

A v iew gets its initial status from the specified ViewID. The

ViewID identifies a view within a workbook. By entering the

WbID you can use views from various workbooks in a template.

WBID ( or DATA_PROVIDER_WBID )

(optional)


VARIANT (optional)




/ roles).


Name of variant for variable assignment

When you save a view, the current variable values are also saved. You can override these values by entering a variant

(optional). You can create variants from the variable screen.

14.02.2001 Seite 16


STYLE_SHEET (optional)

HOME_FRAME (optional)

BLOCK_SIZE

The following commands can be applied for a view.

Path to style sheet to be used for displaying input help.

If you do not make an entry here, the template style sheet is used by default.

Mainframe name

If you are using HTML frame technology to display data, and want to display Input Help in a different frame to that of the template , then for the view , you have to fill the attribute

HOME_FRAME with the frame name of the frame in which the template is displayed. You also have to specify the attribute

TARGET_HELP_FRAME for the item navigation block.

Number of rows in a block

This parameter defines the amount of rows displayed before an index for navigating to other blocks is begun. If the value is

‘0’, the table is displayed in its entirety without taking the number of rows into account.

4.2.3.1 Back, Forward, and Back to Start

You can undo the last action in a view. Likewise, if you have undone one or more actions, you can redo them. Unlike the way you use the "Back" and "Forward" functions in the Web browser, these commands only apply to the specified data provider, and not to the entire page.

CMD

BACK

Description

Undoes the last action performed in this view.

RESET Jumps back to the navigational status that you saw when you called up the page.

Performs an undone action again. FORWARD

Examples:

You want to undo the last action in view 1:

<SAP_BW_URL DATA_PROVIDER='View 1' CMD='BACK'>

You want to reset all views to how they were when you called up the page:

<SAP_BW_URL DATA_PROVIDER='*USA*' MULTI='X' CMD='...'

4.2.3.2 Filter

You can set filter values for characteristics and structures for a view. You can also set several filters for the same characteristic / structure or even for different characteristics / structures within a command call. 'Filter' is a generic command and does not require any entry for the 'CMD' parameter.

The filter parameters can be added to every other command!

Filtering is carried out at the end of an operation.

Parameter

FILTER_IOBJNM

FILTER_IOBJNM_N (optional)

Description

Name of characteristic / structure according to which you want to filter

Specify the technical name of the characteristic (for example,

0COUNTRY) / structure (25 place character string) here.

FILTER_COLLAPS (optional)

'X' = Yes, ' ' = No

VAR_SIGN_N (optional)

Remove filter characteristics from drilldown

Take the characteristics that are specified under

FILTER_IOBJNM according to the axis filter. If the parameter is not specified, the value ‘X‘ = yes is used.

Effect of the row

'I' found values add,

'E' found values remove.

If the parameter is not specified, the default is 'I'.

If the entry for FILTER_IOBJNM_N is missing from an index n, the value FILTER_IOBJNM is used if available.

The following additional parameters are specified for the single value filters,:

14.02.2001 Seite 17


Parameter

FILTER_VALUE

FILTER_VALUE_N

FILTER_VALUE_EXT

FILTER_VALUE_EXT_N

Description

Filter value

Value by which you want to set the filter. If you choose the variant with the ending ‘EXT’, you must specify the complete compounded value externally, for example, 24.12.2000. If the ending ‘EXT’ is not used, you must specify the complete compounded value internally, for example, 20001224 for

24.12.2000.

FILTER_VALUE_TYPE (optional)

FILTER_VALUE_TYPE_N (optional)

OPERATOR (optional)

OPERATOR_N (optional)

Type of value, specified under FILTER_VALUE

'VALUE' : Key of a characteristic value.

'VARIABLE_EXIT' : Name of an exit variable. This resets the filter with the values of the variable exit. Parameter, interval, and selection option variables are supported for customer and

SAP exit variables and for the default values of variables.

Operator

'EQ' = Single value, 'LT' = less than, 'LE' less equal, 'GT' = greater than, 'GE' = greater than.

If you do not specify an operator, 'EQ' is used.

The following additional parameters are specified for filtering intervals:

Parameter

FILTER_VALUE_LOW

FILTER_VALUE_LOW_N

FILTER_VALUE_LOW_EXT

FILTER_VALUE_LOW_EXT_N

Description

Filter value lower limit (not compounded)

FILTER_VALUE_HIGH

FILTER_VALUE_HIGH_N

FILTER_VALUE_HIGH_EXT

FILTER_VALUE_HIGH_EXT_N

Filter value upper limit (not compounded)

The following additional parameters are given for filtering hierarchy nodes:

Parameter

FILTER_VALUE

FILTER_VALUE_N

FILTER_NODE_IOBJNM_(optional)

FILTER_NODE_IOBJNM_N (optional)

Description

Hierarchy node name


Must be specified if you are filtering by node hierarchy node.

For characteristic nodes, you must enter the characteristic name, like you do for text nodes (0HIER_NODE).

Examples:

Filter view 1 according to country Germany:

<SAP_BW_URL DATA_PROVIDER='View 1' FILTER_IOBJNM='0COUNTRY' FILTER_VALUE='DE'>

Filter view 1 according to the first 3 months:

<SAP_BW_URL DATA_PROVIDER='View 1' FILTER_IOBJNM='0CALMONTH'

FILTER_VALUE_LOW_EXT='1' FILTER_VALUE_HIGH_EXT='3'>

Filter all views according to cost and the countries Germany and USA:

<SAP_BW_URL DATA_PROVIDER='*' MULTI='X'

FILTER_IOBJNM_1='DRB9ZVVMBCHVX4F04Z1JGKYVC'

FILTER_VALUE_1='DTG057U7OQ8K2ALKCMR2AWM14' FILTER_IOBJNM_2='0COUNTRY'

FILTER_VALUE_2='DE' FILTER_IOBJNM_3='0COUNTRY' FILTER_VALUE_3='US'>

Filter all views according to the current month:

<SAP_BW_URL DATA_PROVIDER='*' MULTI='X' FILTER_IOBJNM='0CALMONTH'

FILTER_VALUE='0CMONTH' FILTER_VALUE_TYPE='VARIABLE_EXIT'>

4.2.3.3 Remove Filter

14.02.2001 Seite 18


By calling this command, you can remove the filter for one or more views relating to a characteristic or a structure.

CMD

Parameter

IOBJNM

IOBJNM_N

Remove_Filter

Description

Name of characteristic / structure

Enter here the technical name of the characteristic (for example, 0COUNTRY) / structure (25-place character string) whose filter you want to remove. You can also specify a list of characteristics/structures.

ALL

'X' = Yes, ' ' = No

Remove all filters

As an alternative to listing characteristics and structures, you can also remove all the filters.

Examples:

Remove filter from country for view 1:

<SAP_BW_URL DATA_PROVIDER='View 1' CMD='Remove_Filter' IOBJNM='0COUNTRY' >

Remove filter from country for all views and filter according to calendar year 2000:

<SAP_BW_URL DATA_PROVIDER='*' MULTI='X' CMD='Remove_Filter' IOBJNM='0COUNTRY'

FILTER_IOBJNM='0CALYEAR' FILTER_VALUE='2000'>

Remove all filters from all views and filter according to the calendar year 2000:

<SAP_BW_URL DATA_PROVIDER='*' MULTI='X' CMD='Remove_Filter' ALL='X'


4.2.3.4 Call up Input Help

When you call up this command, you can get to Input Help for a characteristic or a structure of a view.

CMD

HELP_SERVICE

Process_help_window

DP_VIEW_FILTER

Parameter

IOBJNM

BOOKED_VALUES

Description


Enter here the technical name of the characteristic (for example, 0COUNTRY) / structure (25-place character string) for which you want to call up Input Help.

Use booked values as Input Help

If you do not specify this parameter, or if it is set to 'X', the

Input Help shows only values that are also booked in the

InfoCube within the current valid filter conditions. Under certain circumstances, this can take a long time. If the parameter is set to ' ', all the values of the dimension table are displayed. This may be quicker, but it means that those values that do not meet the current filter conditions in the InfoCube are also shown. And they give the result "No relevant data found" when you filter.

4.2.3.5 Drilldown

By calling this command, you can change the position of a characteristic or a structure for one or more views.

CMD

Parameter

IOBJNM

Expand

Description

AXIS (optional)

'X' = Columns

'Y' = Rows

' ' = Free characteristic (=remove drilldown)


Enter here the technical name of the characteristic (for example, 0COUNTRY) / structure (25-place character string) you want to include in the drilldown.

Axis to which you want to move the characteristic / structure

The characteristic / structure is moved to the axis behind the other characteristics / structures if you do not specify

14.02.2001 Seite 19


PARENT_IOBJNM (optional)

PARENT_IOBJNM. If you do not specify the 'axis' parameter, then the value 'Y' is taken for characteristics and 'X' for structures.

Name of a characteristic / structure on the axis

You can move a characteristic / structure behind another on an axis if you enter this parameter.

Examples:

Drilldown view 1 according to country:

<SAP_BW_URL DATA_PROVIDER='View 1' CMD='Expand' IOBJNM='0COUNTRY' >

Drilldown view 1 according to country and filter according to calendar year 2000:

<SAP_BW_URL DATA_PROVIDER='View 1' CMD='Expand' IOBJNM='0COUNTRY'


Move periods 1, 2 and 3 (2000) from view 1 to the columns:

<SAP_BW_URL DATA_PROVIDER='View 1' CMD='Expand' IOBJNM='0FISCPER' AXIS='X'

FILTER_IOBJNM='0FISCPER' FILTER_VALUE_1='2000001' FILTER_VALUE_2='2000002'

FILTER_VALUE_3='2000003'>

4.2.3.6 Remove Drilldown

By calling this command you can remove a characteristic or a structure from the drilldown for one or more views. This command corresponds to the “drilldown” command if the parameter AXIS=' ' is set.

CMD

Parameter

IOBJNM

Collaps

Description


Enter here the technical name of the characteristic (for example, 0COUNTRY) / structure (25-place character string) that you want to remove from the drilldown.

Examples:

Remove drilldown according to country from view 1:

<SAP_BW_URL DATA_PROVIDER='View 1' CMD='Collaps' IOBJNM='0COUNTRY'>

4.2.3.7 Exchange Characteristics/Structures

By calling this command you can replace a characteristic or a structure with another characteristic or structure for one or more views.

CMD

Parameter

IOBJNM_1

IOBJNM_2

Exchange

Description

Name of characteristic / structure 1

Enter here the technical name of the 1 st characteristic (for example, 0COUNTRY) / 1 st structure (25-place character string).

Name of characteristic / structure 2

Enter here the technical name of the 2 nd characteristic (for example, 0COUNTRY) / 2 nd structure (25-place character string).

Examples:

Replace drilldown according to country with drilldown according to calendar year in view 1:

<SAP_BW_URL DATA_PROVIDER='View 1' CMD='Exchange' IOBJNM_1='0COUNTRY'

IOBJNM_2='0CALYEAR'> or:

<SAP_BW_URL DATA_PROVIDER='View 1' CMD='Exchange' IOBJNM_1='0CALYEAR'

IOBJNM_2='0COUNTRY'>

4.2.3.8 Switching Axes

You can use this command to swap the roles of the axes (list is copied). All chars and structures are taken from the rows and put in reverse in the columns.

14.02.2001 Seite 20


CMD Switch_Axis

Example:

Swap axes for view 1:

<SAP_BW_URL DATA_PROVIDER='View 1' CMD='SWITCH_AXIS'>

4.2.3.9 Set Navigational Status

When you call up this command, you can rearrange characteristics and structures on the axis.

CMD SET_NAV_STATE

Parameter

ALL

'X' = Yes, ' ' = No

Description

Arrange all characteristics and structures again

If this attribute is set to 'X', all characteristics and structures are first taken from the axis and then arranged again according to the other parameters. If you do not set the parameter, or it is set to ‘ ‘, the characteristics in the list are arranged by the axes parameter.

IOBJNM

IOBJNM_N

AXIS

AXIS_N

'X' = Columns

'Y' = Rows

' ' = Free characteristics


Enter the technical name of the characteristic (for example,

0COUNTRY) or the structure (25-characters), how you want it to appear on the axis.

Axis to which you want to move the characteristic / structure

The characteristic/structure is dragged to the axis. Its position on the axis is determined by the parameter ‘position’.

POSITION

POSITION_N

Position on an axis

The characteristic/structure is placed on the axis in the position you specify here. If you do not specify a position, or if it is set to ‘0’, the characteristic/structure is placed at the end of the drilldown sequence

Example:

Shift the key figure structure to the rows, and put calendar year and plan/actual structure in the columns:

<SAP_BW_URL DATA_PROVIDER='View 1' CMD='SET_NAV_STATE' ALL='X'

IOBJNM_1='DTG057U7OQ8K2ALKCMR2AWM14' AXIS_1='Y' IOBJNM_2='0CALYEAR'

POSITION_2='1' AXIS_2='X' IOBJNM_3='EFG057U7OQ8K2JKKCMR2AWM67' POSITION_3='2'

AXIS_3='X'>

Make sure that all the views have cost centers in their drilldown, and not materials:

<SAP_BW_URL DATA_PROVIDER='*' MULTI='X' CMD='SET_NAV_STATE'

IOBJNM_1='0COSTCENTER' AXIS_1='Y' IOBJNM_2='0MATERIAL' AXIS_2=' '>

4.2.3.10 Sort

Use this command to sort according to the parameters of the characteristics, or by value.

CMD

Parameter

Sort

Description

Sort_Type

'K' = key, 'T' = text, 'H' = hierarchy, 'S' = selection, 'V' = value

Sort_Direction

'A' = ascending, 'D' = descending

IOBJNM

Only for sorting characteristics.

Structure_Member_1

Type of sorting

Characteristics can be sorted according to key, name, hierarchy

(if there is an active display hierarchy) or by selection (if there is a restriction to several single values or dynamically in the query definition). You can also sort by value.

Required sort direction

The sort direction for Sort_Type=H is always 'A'.

Characteristic to be sorted

This parameter is left out when sorting by value.

Structure part of 1 st structure

14.02.2001 Seite 21


Only for sorting by value.


Only for sorting by value.

If you sort by value, you must specify the exact value cell. You must also specify the structure parts (25 characters) for all structures that appear (maximum 2).

Structure part of 2nd structure

If you have defined 2 structures in the query, you must also specify the structure part of the 2 nd structure.

Examples:

Sort customers ascending, according to text in view 1:

<SAP_BW_URL DATA_PROVIDER='View 1' CMD='SORT' IOBJNM='0CUSTOMER' SORT_TYPE='T'

SORT_DIRECTION='A'>

Ascending list by "actual" "sales":

<SAP_BW_URL DATA_PROVIDER='View 1' CMD='SORT' SORT_TYPE='V' SORT_DIRECTION='D'

STRUCTURE_MEMBER_1='DTG057U7OQ8K2ALKCMR2AWM14'

STRUCTURE_MEMBER_2='EFG057U7OQ8K2JKKCMR2AWM67'>

4.2.3.11 Calculate Lists

You can use this command to change the settings for list calculation for a value cell.

CMD

Parameter


SET_LIST_CALCULATION

Description

Structure part of 1 st structure

You must determine the value cell precisely for list calculation.

You must also specify the structure parts (25 characters) for all structures that appear (maximum 2).

Structure_Member_2 Structure part of 2nd structure

If you have defined 2 structures in the query, you must also specify the structure part of the 2 nd structure.

Also apply calculation settings to result cells. APPLY_TO_RESULTS (optional)

'X' = Yes, ' ' = No

CUMULATION (optional)

'X' = Yes, ' ' = No

Accumulated output

VALUE_CALCULATION (optional)

'X' = Columns

'Y' = Rows

RESULT_CALCULATION (optional)

Calculations

‘ ‘ = No list calculation

‘R’ = Standardization of query result

‘G’ = Standardization of overall result

‘C’ = Standardization of result

‘S’ = Ranking list

‘O’ = Ranking list (olympic)

Result cell calculations

‘00‘ = No list calculation

'01' = Summation

'02' = Maximum

'03' = Minimum

‘04’ = Including all values

‘05’ = Including all values <> 0

‘06’ = Average of all values

‘07’ = Average of all values <> 0

‘08’ = Standard deviation

‘09’ = Variant

‘10’ = Suppress result

‘11’ = First value

‘12’ = Last value

Examples:

Display maximum plan turnover:

<SAP_BW_URL DATA_PROVIDER='View 1' CMD='SET_LIST_CALCULATION'

STRUCTURE_MEMBER_1='DTG057U7OQ8K2ALKCMR2AWM14'

STRUCTURE_MEMBER_2='EFG057U7OQ8K2JKKCMR2AWM67' VALUE_CALCULATION='02'>

4.2.3.12 Operations in Display Hierarchies

You have the option of 4 operations for display hierarchies:

14.02.2001 Seite 22


With the command SET_HIERARCHY_STATE, you can activate or deactivate a display hierarchy that was assigned to a characteristic (in the query definition or in the view, for example).

CMD

Parameter

IOBJNM

Set_Hierarchy_State

Description

ACTIVE (Option 1)

'X' = activate, ' ' = deactivate

TOGGLE_STATE (Option 2)

'X' = switch over, ' ' = do not change

Characteristic name

Characteristic that already has a display hierarchy assigned to it.

Required status of the display hierarchy

Switch the status of the hierarchy

If this attribute is set to 'X', the display hierarchy is activated if it was not before and vice versa.

Example:

Activate hierarchies for the characteristic cost center for view 1:

<SAP_BW_URL DATA_PROVIDER='View 1' CMD='Set_Hierarchy_State'

IOBJNM='0COSTCENTER' ACTIVE='X'>

With the command SET_HIERARCHY, you assign a display hierarchy to a characteristic.

CMD Set_Hierarchy

Parameter

IOBJNM

Description


The characteristic to which you want to assign a display hierarchy.

HIERARCHY_NAME

HIERARCHY_VERSION

HIERARCHY_DATE

Technical name of the hierarchy

Version of the hierarchy

If the required hierarchy has a version, you must specify the version, otherwise, this parameter can be left out.

Key date of the hierarchy

For time-dependent hierarchies, you can enter a key date here.

You must use the format, yearmonthday (for example,

20002412). If this parameter is not used, the system takes the key date of the query.

Example:

Assign 'MyHierarchy' to the characteristic cost center for view 1:

<SAP_BW_URL DATA_PROVIDER='View 1' CMD='Set_Hierarchy' IOBJNM='0COSTCENTER'

Hierarchie_Name='MyHierarchy' ACTIVE='X'>

With the command Drill_To_Level, you can drilldown on a display hierarchy, to the predefined hierarchy level.

ACTIVE


Required status of the display hierarchy

CMD Drill_To_Level

Parameter

IOBJNM

Beschreibung


The characteristic that has an active display hierarchy assigned to it.

LEVEL Level of the hierarchy

Level to which you want to drilldown on the hierarchy. Level 1 is the level of the root.

If a hierarchy node is filtered at the same time, you must make sure that the level is higher than the filtered node.

Example:

Drilldown to level 3 on the hierarchy of the characteristic cost center for view 1:

<SAP_BW_URL DATA_PROVIDER='View 1' CMD='Drill_To_Level' Iobjnm='0COSTCENTER'

Level='3'>

14.02.2001 Seite 23


You can use the command Set_Drill_State to expand or collapse a node in a display hierarchy. When you do this, make sure that the node is visible in the list in the current navigational view. The command is designed to influence the expand level of the hierarchy when you call up a Web report, when you activate a hierarchy, or when you specify and activate a hierarchy To carry out both functions at the same time, you need a command sequence.

CMD Set_Drill_State

Parameter

IOBJNM

Description


The characteristic that has an active display hierarchy assigned to it.

NODE_NAME

NODE_IOBJNM

Node name

Technical name of the node (internal display).


For characteristic nodes, you must enter the characteristic name, like you do for text nodes (0HIER_NODE).

DRILL_STATE

'E' = expanded, 'C' = collapsed

Required drill state

Examples:

Determine the hierarchy for the characteristic cost center for the view 1 and expand the node

"myNode","0HIER_NODE" at the same time:

This example uses a command sequence. See "Command Sequences" for more details.

<SAP_BW_URL DATA_PROVIDER='View1' CMD='Set_Hierarchy' IOBJNM='0COSTCENTER'

Hierarchie_Name='MyHierarchy' ACTIVE='X'

CMD_1='CMD=set_Drill_State&Data_Provider=View1&iobjnm=0COSTCENTER&Node_name=myNo de&Node_iobjnm=0HIER_NODE&Drill_State=E'>

Determine the hierarchy for the characteristic cost center for the view 1 and expand the node

"myNode","0HIER_NODE" at the same time:

This example uses a command sequence. See "Command Sequences" for more details.

<SAP_BW_URL DATA_PROVIDER='View1' CMD='Drill_To_Level' Level='3'

CMD_1='CMD=set_Drill_State&Data_Provider=View1&iobjnm=0COSTCENTER&Node_name=myNo de&Node_iobjnm=0HIER_NODE&Drill_State=E'>

4.2.3.13 Set Exception Status

By calling this command you can change the status for a view exception.

CMD

Parameter

EXCEPTION_ID

Set_Exception_State

Description

Technical name of the exception

Enter the technical name of the exception here (25-place character string).





Required status of the exception

Switch the exception status

If this attribute is set to 'X', then the exception will be activated if it was not previously active, and deactivated if it was previously active.

Examples:

Set the exception “Problems in Sales” from view 1 to active:

<SAP_BW_URL DATA_PROVIDER='View 1' CMD='Set_Exception_State'

EXCEPTION_ID='DTG057U7OQ8K2ALKCMR2AWM14' ACTIVE='X'>

Switch exception “Problems in Sales” from view 1:

<SAP_BW_URL DATA_PROVIDER='View 1' CMD='Set_Exception_State'

EXCEPTION_ID='DTG057U7OQ8K2ALKCMR2AWM14' TOGGLE_STATE='X'>

4.2.3.14 Set Condition Status

By calling this command you can change the status for a view condition.

14.02.2001 Seite 24


CMD

Parameter

CONDITION_ID

Set_Condition_State

Description

Technical name of the condition

Enter the technical name of the condition here (25-place character string).





Required status of the condition

Switch the status of the condition

If this attribute is set to 'X', the condition is activated if it was not active previously, and vice versa.

Examples:

Set condition “Top 10 Customers” from view 1 to active:

<SAP_BW_URL DATA_PROVIDER='View 1' CMD='Set_Condition_State'

EXCEPTION_ID='DTG057U7OQ8K2ALKCMR2AWM14' ACTIVE='X'>

Switch exception “Top 10 Customers” from view 1:

<SAP_BW_URL DATA_PROVIDER='View 1' CMD='Set_Condition_State'

CONDITION_ID='DTG057U7OQ8K2ALKCMR2AWM14' TOGGLE_STATE='X'>

4.2.4 Alert Monitor

The Alert Monitor displays the results of the Reporting Agent background processing. The Exception Reporting results are made available via the Alert Monitor.

Since the Alert Monitor only has one data source, you not need to create it as a separate data provider . The Item Alert

Monitor automatically creates its own suitable data provider and automatically passes on the filter operations to the data provider .

Therefore, you do not have to manually create a data provider for the Alert Monitor .

See Item Alert Monitor for further information.

4.3 Item

Items are objects that obtain data from data providers and make it available in a particular way as HTML. Items have attributes, for example, header, width and height, create navigation links and so on. You can subsequently change these by setting parameters or calling commands. If you change the data, the navigational state or the attributes, the HTML is recreated for the item. An item always has to be assigned to a data provider .

4.3.1 Generic Attributes

Generic attributes are attributes that are valid for all items .

Attribute

ITEM ( or NAME )

Description


Logical name for the item

In addition to the ITEMID given when you create the item in the Web Publisher , you also have to use a logical name if you want to use the item for Web Reporting (pre-assigned with the

ITEMID ). This makes it possible to use the same item more

ITEMID


than once in a template . If you send commands to this item, always specify the name of the item as “item” parameter.

Item key

An item is created for a template on the basis of an item setting made in the Web Publisher . The ViewID identifies an item within a workbook By entering the WbID, you can use items from various workbooks in a template .

WBID ( or ITEM_WBID ) (optional)


DATA_PROVIDER

Key for the Excel workbook under which the item is stored in the Web Publisher


/ roles).


Logical name of the data provider for the item

14.02.2001 Seite 25


HIDDEN

'X' = Yes, ' ' = No

CLOSED

'X' = Yes, ' ' = No

GENERATE_CAPTION

'X' = Yes, ' ' = No

CAPTION

GENERATE_LINKS

'X' = Yes, ' ' = No

WIDTH

Entry in pixels

HEIGHT

Entry in pixels

Every item must be assigned to (exactly) one data source. From this data source the item gets the data and Metadata it needs to create output and commands

Hide item

If HIDDEN=X, then the item is not displayed, nor is the title with the open/close symbol.

Close item

In addition to the attribute HIDDEN, you can also close/open items. If an item is closed, you can only see its title (if available) and the open/close symbol.

Display item header

Style “SAPBEXTableCaption” is used for the header.

Header

If you do not specify a header, a suitable default value is used instead (if Generate_Caption is equal to 'X').

Create filter and navigation URLs

If you do not want the user to be able to navigate or to see a printable version, then set this attribute to ' ' = No

Item width

The specified width is used for graphics. The width for tables is generated in the table tag (HTML) for the table. In the latter case, the Web browser tries to retain the width. If the width is set too narrow, the Web browser automatically increases the width.

Item height

Exactly this height is used for graphics. This attribute has no function with HTML tables.

4.3.2 Items for Views

4.3.2.1 Table

The item table displays the values for a view in the form of a table. The same list geometry is supported as that which is available in BEx. You can display characteristics and structures in rows or in columns.

As well as the generic attributes, the table has the following additional attributes:

Attribute Description

ALT_STYLES

'X' = Yes, ' ' = No

BLOCK_SIZE

Alternate row format (zebra list)

The 'SAPBEXstdData' format and the 'SAPBEXstdDataOdd' format are used alternately for the rows to display numeric values (no sum cells). You can adjust them in the CSS file assigned to the template.

Number of rows per block

This parameter defines the amount of rows displayed before an index for navigating to other blocks is begun. If the value is

‘0’, the table is displayed in its entirety without taking the number of rows into account.

4.3.2.2 Navigation Block

The item navigation block displays the navigational state for a view in the form of a table. All the characteristics and structures for a view are listed in the table and their filter values are also displayed. You also have the option of changing the navigational state. You can add or remove characteristics and structures from an axis (rows or columns).

You can filter according to single values or remove filters completely.

As well as the generic attributes, the navigational block has the following additional attributes:


TARGET_HELP_FRAME

(optional)

Frame in which Input Help is displayed

If you use HTML frame technology, then you have the option

14.02.2001 Seite 26


FILTER_VALUE_LENGTH

(default value : 80)

HORIZONTAL_ALIGNMENT

'X' = Yes, ' ' = No

ITEM_NAV_BLOCK_IOBJNM_N

(optional)

HORIZONTAL_NUMBER

BOOKED_VALUES of displaying Input Help in a different frame to the data. If you have not maintained the parameter, then Input Help is output in the same window as the data.

This parameter is not offered in the Web Publisher, and can only be used for setting parameters in the template .

Number of characters after which a filter value is indicated with :

If the value is set to 0, the filter value is displayed in its complete form.

Horizontal display of the navigation block

As well arranging the characteristics one below the other, you can also display them side by side. In many cases, this makes better use of the interface and commands a stronger visual link between table and navigation block.

Maximum number of characteristics that can be placed side by side

You can only use this specification when

HORIZONTAL_ALIGNMENT = X.

If the navigation block contains more than the given number of characteristics, it is automatically displayed with several rows.

The number of characteristic per row is increased according to the equal distribution of rows and the required number.

Listing the entries in the navigation block

By listing the characteristic and structure names, you can see which entries appear in the navigation block and in which order.

If you do not specify a parameter here, all characteristics and structures are displayed.

Use booked values as Input Help

If you do not specify this parameter, or if it is set to 'X', the

Input Help shows only values that are also booked in the

InfoCube within the current valid filter conditions. Under certain circumstances, this can take a long time. If the parameter is set to ' ', all the values of the dimension table are displayed. This may be quicker, but it means that those values that do not meet the current filter conditions in the InfoCube are also shown. And they give the result "No relevant data found" when you filter.

4.3.2.3 Filter

The Item filter displays the filter values created by navigation for a view .

As well as the generic attributes, the filter has the following additional attributes:

Attribute

ONLY_VALUES

'X' = Yes, ' ' = No

Description

Display values only

The filter values are separated with a semicolon, without description or formatting.

FILTER_VALUE_LENGTH

(default value : 0)

FILTER_NODE_IOBJNM_N (optional)

(optional)

Number of characters after which a filter value is indicated with :

If the value is set to 0, the filter value is displayed in its complete form.

Listing characteristic and structures

By listing the characteristic and structure names, you can see which entries appear in the filter and in which order. Only those entries are displayed that have a filter value, the other entries are ignored.


Filter value display

14.02.2001 Seite 27


PRESENTATION_N (optional)

‘KEY’

‘TEXT’

'KEY_TEXT'

'TEXT_KEY'

The filter value is displayed according to the setting. If you do not specify a display for an index, the display of Index 0 (no index) is used.

If you do not use this parameter, the display used is that valid for the characteristic.

With the combination of ONLY_VALUES=X and ITEM_FILTER_IOBJNM=MyInfoObject, you can address a specific filter value in the template. You can also use this in titles, for example.

Examples:

Display the filter values for the characteristic calendar year, without formatting:

<object>



<param name='ITEM' value='Filter'>

<param name='ITEMID' value='Filter'>


<param name='ONLY_VALUES' value='X'>

<param name='ITEM_FILTER_IOBJNM' value='0CALYEAR'>

ITEM :Filter

</object>

Entry field for filtering by calendar year the dynamic filter preset (only applies for single value filters):

<form action="<SAP_BW_URL DATA_PROVIDER='View 1' FILTER_IOBJNM='0CALYEAR'>" method="post">

Calendar year: <input name="FILTER_VALUE_EXT" size=4 maxlength=4 value="

<object>



<param name='ITEM' value='Filter'>

<param name='ITEMID' value='Filter'>


<param name='ONLY_VALUES' value='X'>

<param name='ITEM_FILTER_IOBJNM' value='0CALYEAR'>

<param name='PRESENTATION' value='KEY'>

ITEM :Filter

</object> " >

<input type=submit value="Submit">

<input type=reset value="Reset">

</form>

4.3.2.4 Text Element

The item text element presents the text elements for a view . You can address the same text elements that appear in the

Business Explorer Analyzer.

As well as the generic attributes, the text elements have the following additional attributes:

Attribute

ONLY_VALUES

'X' = Yes, ' ' = No

Description

Display values only

The text element values are separated with a semicolon, without description or formatting.

SHOW_COMMON_ELEMENTS

'X' = Yes, ' ' = No

SHOW_VARIABLES

'X' = Yes, ' ' = No

SHOW_FILTERS

'X' = Yes, ' ' = No

ELEMENT_NAME_N

Display general text elements (validity of data, InfoCube, current users)

Display variable values

Display filter values that were defined in the filter area of the query definition

Listing text elements

By listing text elements in combination with their type

ELEMENT_TYPE_N, you can determine which entries appear as text elements and in which order.

With general text elements, the name corresponds to one of the values below; with variables, it corresponds to the variable

14.02.2001 Seite 28


ELEMENT_TYPE_N

COMMON = general text element

FILTER = static filter value

VARIABLE = variable value name and with filters it corresponds to the characteristic name.


Listing types of text elements

See ELEMENT_NAME_N

The combination of ONLY_VALUES=X, ELEMENT_TYPE =COMMON and ELEMENT_NAME=REPTXTLG, you can address a specific text element in the template, for example, query name. You can also use this in titles, for example.

General text elements:

REPTNAME

REPTXTLG

INFOCUBE

SRDATE

Technical name of the query

Description of the query

= InfoCube

Key date of the query

ROLLUPTIME validity of the data (date and time

AUTHOR Author of the query

MODTIME

MODUSER

= Last changed on (date and time)

= Last changed by

SYUSER

SYUZEIT

= Current user

= Last refresh (date and time)

4.3.2.5 Chart

The item table displays the values for a view in the form of a graphic.

As well as the generic attributes, the chart has the following additional attributes:

Attribute

SWITCHMATRIX

'X' = Yes, ' ' = No

SUPPRESS_OPENHIERARCHIENODES

'X' = Yes, ' ' = No

Description

Inverting data

Depending on the list geometry of the view , it is useful to swap the row roles and the columns in the diagram. By setting this attribute, you can swap the roles without affecting the navigational state of the view itself.

Hide open hierarchy node

If the hierarchy display is switched on, you can remove the expanded node from the graphic. This ensures that the total of all the displayed values is the overall total.

4.3.2.6 Exception Block

The item exception block displays the exception status of a view in the form of a table. All the exceptions are listed in the table along with their status (active / not active). You also have the option of switching the exception status.

This item only has the generic attributes.

4.3.2.7 Condition Block

The item condition block displays the condition status for a view in the form of a table. All the conditions are listed that can be applied in the current navigational state of the view . For every condition the status is displayed extra (active, not used, not active). You also have the option of switching the condition status

4.3.2.8

. Selection List

The item selection list puts characteristic values in the Web report for filtering in a selection list. If a value is selected, the view is filtered according to this value. If a filter value has been selected for the characteristic in the selection list in another way, the current filter value is put into the selection list.

The item selection list has the following attributes in addition to the generic attributes:

Attribute

IOBJNM

Description

Name of characteristic / structure according to which you want to filter



14.02.2001 Seite 29


SHOW_LABEL

'X' = Yes, ' ' = No

ONLY_VALUES (optional)

'X' = Yes, ' ' = No

(optional)

MAXVALUES (optional)

BW Use description as heading

If this attribute is activated, the characteristic descrption is used as the heading of the selection list.

Maximum number of values in selection list

Contains the maximum number of values that should be displayed in the selection list.

If this attribute has the value ‘0’, all values are displayed in the selection list.

Only create selection list

If this attribute is activated, only the HTML formular element is created for the value list. The form that contains the selection list must in this case be created by hand.

This attribute is designed for structuring forms which contain more than one selection list.

Index in filter command

Must have a unique value for all selection lists and selection button groups within the form tag.

You only need to use this attribute if the attribute

ONLY_VALUES is activated.

4.3.2.9 Selection Button Group

The item selection button group puts characteristic values for filtering in a group of selection buttons. If a value is selected, the view is filtered according to this value. If a filter value is selected for the charcteristic of the selection button group in another way, the current filter value is marked as selected.

The item selection button group has the following attributes in addition to the generic attributes:


IOBJNM Name of characteristic / structure according to which you want to filter



SHOW_LABEL

'X' = Yes, ' ' = No

BW Use description as heading

MAXVALUES (optional)

If this attribute is activated, the characteristic description is used as the heading of the selection list.

Maximum number of values in selection list

Contains the maximum number of values that should be displayed in the selection list.

If this attribute has the value ‘0’, all values are displayed in the selection list.

ONLY_VALUES (optional)

'X' = Yes, ' ' = No

Only create selection button group

If this attribute is activated, only the HTML formular element is created for the selection button group. The form that contains the selection button group must in this case be created by hand.

(optional)

This attribute is designed for structuring forms which contain more than one selection button group.

Index in filter command

Must have a unique value for all selection lists and selection button groups within the form tag.

HORIZONTAL_ALIGNMENT

You only need to use this attribute if the attribute

ONLY_VALUES is activated.

Entries on top of each other

14.02.2001 Seite 30


'X' = Yes, ' ' = No

HORIZONTAL_NUMBER

If this attribute is activated, the various characteristic values are displayed vertically. If this attribute is deactivated, the various characteristic values are displayed horizontally.

Number of entries next to / on top of each other

Contains the number of entries that may be displayed, vertically or horizontally as defined by the setting of the attribute HORIZONTAL ALIGNMENT. You can specify the required number of entries by double-clicking on the attribute or via Change Attribute.

4.3.2.8 Label

The item label allows you to display descriptions of parts of characteristics, attributes or structres, and to place a link from the context menu of the characteristic.

This item can be used with the items selection list and selection button group to make a comfortable Cockpit.

The item label has the following attributes in addition to the generic attributes:


IOBJNM

ATTRINM

STRUCTURE_MEMBER




Attribute name

Technical name of the attribute whose heading should be displayed as a label.

Structure part

Structure part whose text or context menu is displayed.

CONTEXT_MENU

'X' = Yes, ' ' = No

ONLY_VALUES

'X' = Yes, ' ' = No

Context menu

If you activate this attribute, a link is created in the description of the characteristic to the context menu of the characteristic.

Unformatted display

Display description without formatting.

4.3.3 Item Alert Monitor

The Alert Monitor presents the views, which were retrieved with the help of the Reporting Agent in a background process, as a list or hierarchy and supports jumps to these views. Furthermore, it is possible to set filters.


FILTER_RED

FILTER_YELLOW

FILTER_GREEN

'X' = Yes, ' ' = No

FILTER_INFOAREA

Only display rows with at least one red / yellow / green light.

For example, if you choose only FILTER_RED=X and

FILTER_YELLOW=X, you do not see any rows that are green.

Filter according to entries that are below a certain

InfoArea

If the attribute is empy, no filter is used.

FILTER_INFOCUBE

FILTER_QUERY

HIERARCHY

'X' = Yes, ' ' = No

DISPLAY_MAX_LEVEL

'X' = Yes, ' ' = No

Filter according to entries that are below a certain

InfoCube


Filter according to entries that are below a certain query


Hierarchical display

The hierarchical display copies the InfoArea, InfoCube and query to build a hierarchy that you see when you open a query for example. Alternatively, you can choose a flat list. This displays only the navigation statuses, without the InfoArea,

InfoCube and queries. This display variant is especially suited to a small amount of entries.

Only display the highest level

Instead of displaying the red, yellow and green lights with their frequency per navigation status, you can also only display the

14.02.2001 Seite 31


BLOCK_SIZE

(default value : 10

JUMP_WBID (optional)

JUMP_PAGEID (optional)

TARGET_FRAME (optional) light with the highest alert level . This makes the display more compact.

Number of rows before turning the page

Since the Alert Monitor potentially has a large number of entries, you can specify a maximum number of entries to be displayed. This can be used for layout especially. If more rows exist, an index is added to go to a different page.

If the value is set to 0, all entries are displayed.


You need this attribute if you want to display the detail view of a navigation status from the Alert Monitor in a different template as the default template The alternative template is characterized by JUMP_WBID and JUMP_PAGEID.

JUMP_WBID : The workbook must be stored in BW

(favorites, activity groups / roles).

Name of the template (see JUMP_WBID)


Name of the frame for the detail view

If this is not specified, the detail view is displayed in the same window if you are using pure HTML . With Java Script switched on, a separate window is opened.

14.02.2001 Seite 32


5 Parameterizing Templates

The URL for calling a template is generated by the Web Publisher. You can make a copy and use it again and again.

A typical URL looks like this: http://your_its/scripts/wgate/WebRFC/!?_function=WEBQUERY&CMD=LDOC&WBID=D9EW857M

LP6EN0AEM9BZSQP3C&PAGEID=Template_Name

The first part of the URL, ( http://your_its/scripts/wgate/WebRFC/!?_function=WEBQUERY)

calls the WebRFC Service for BW Web Reporting from the ITS. The template is called next. This takes place using the

'LDOC' command with the parameters 'WBID ' and 'PAGEID '.

The command LDOC requests a new HTML page and creates it according to the template.

By inserting other parameters, you can parameterize the template. These parameters are passed on to all data providers and items. By parameterizing the URL you can therefore filter all views according to a particular country or cost center, for example.

Examples:

Filter all views according to Germany: http://your_its/scripts/wgate/WebRFC/!?_function=WEBQUERY&CMD=LDOC&WBID=D9EW857M

LP6EN0AEM9BZSQP3C&PAGEID=Template_Name& FILTER_IOBJNM=0COUNTRY&FILTER_VALUE=DE

Filter all views according to Germany, 2000: http://your_its/scripts/wgate/WebRFC/!?_function=WEBQUERY&CMD=LDOC&WBID=D9EW857M

LP6EN0AEM9BZSQP3C&PAGEID=Template_Name& FILTER_IOBJNM_1=0COUNTRY&FILTER_VALUE_1=D

E&FILTER_IOBJNM_2=0CALYEAR&FILTER_VALUE_2=2000

Display all items with title: http://your_its/scripts/wgate/WebRFC/!?_function=WEBQUERY&CMD=LDOC&WBID=D9EW857M

LP6EN0AEM9BZSQP3C&PAGEID=Template_Name& GENERATE_CAPTION=X

14.02.2001 Seite 33


6 Command Sequences

There are many factors involved in the need to change several objects in various ways under one command. Until now it was not possible to filter a data_provider according to the fiscal year 1999 and another data_provider according to

2000 under one request (command).

Command sequences make it possible to add other commands to a command. Only after all commands have been executed is the data requested from the OLAP processor and the HTML page sent back to the Web browser.

The sequence commands are added to commands as parameter CMD_N. Please note that the characters '=' and '&' must be replaced in the sequence demand by their Hex display:

=' is replaced by '%3D' and '&' becomes '%26'.

Every sequence command can be up to 250 characters long. If there are other characters, they are omitted.

If the command sequence is too large to fit in a URL then you can add the attribute ‘NO_OUTPUT' to a command. As a result, the command is executed and a blank page is sent back. No data is read at this point. This is useful if you want to go to a main frame from a control frame, for example. With JavaScript you can lead a sequence of individual commands in the main frame and only leave out the ‘NO_OUTPUT' attribute when you get to the last command.

Examples:

Start page and filter DP1 according to DE and DP2 according to US: http://your_its/scripts/wgate/WebRFC/!?_function=WEBQUERY&CMD=LDOC&WBID=D9EW857M

LP6EN0AEM9BZSQP3C&PAGEID=Template_Name& CMD_1=DATA_PROVIDER%3DDP1%26FILTER_IOBJNM

%3D0COUNTRY%26FILTER_VALUE%3DDE & CMD_2=DATA_PROVIDER%3DDP2%26FILTER_IOBJNM%3D0COU

NTRY%26FILTER_VALUE%3DUS

Command URL to filter DP1 according to calendar year 2000, change title of graphic GRAPHIC to '2000' and change the title of table TABLE to ‘Details 2000'.

<SAP_BW_URL DATA_PROVIDER='DP1' FILTER_IOBJNM='0CALYEAR' FILTER_VALUE='2000'

CMD_1='ITEM=GRAPHIC&CAPTION=2000' CMD_2='ITEM=TABLE&CAPTION=Details2000' >

14.02.2001 Seite 34


7 Forms

With HTML forms you can integrate entry fields into an HTML page easily. It is possible to use this HTML technology in BW Web Reporting.

7.1.1 Parameterizing Templates

You can set parameters for calling Web Reporting pages that meet end user requirements by implementing forms. To do this, create an HTML document with a form from which the actual URL for Web Reporting is called with set parameters.

Example:

After calling the subsequent HTML document, the user is presented with a form in which s/he can select a calendar year and a country from the dropdown boxes. By executing the submit command, a Web Reporting page is displayed with view filters already set.

<html>

<body>

<table>

<form method="POST" action="http://your_its/scripts/wgate/WebRFC/!?_function=WEBQUERY&CMD=LDOC&WBID=D9EW857ML

P6EN0AEM9BZSQP3C&PAGEID=Template_Name&FILTER_IOBJNM_1=0CALYEAR&FILTER_IOBJNM_2=0COUNTRY

">

<tr>

<td>Kalenderjahr</td>

<td><select size="1" name="FILTER_VALUE_1">

<option value="1997">1997</option>




</select></td>

</tr>

<tr>

<td>Land</td>

<td><select name="FILTER_VALUE_2">

<option value="BR">Brazil</option>

<option value="DE">Germany</option>

<option value="FR">France</option>

<option value="GB">GreatBritain</option>

<option value="JP">Japan</option>

<option value="RU">Russia</option>

<option value="ES">Spain</option>

<option value="US">USA</option>

</select></td>

</tr>

</table>

<input type="submit" value="Submit" name="Submit">

</form>

</body>

</html>

Buttons and Forms in Templates

You can integrate commands into a template by using anchors (<a href=” ... ”></a>) and HTML forms. These commands can affect one or several items or data providers .

You can use the bookmarks described under “Command URLs” in the place where you would usually see URLs in

HTML appear. They are replaced automatically during processing so that only valid URLs appear in the created HTML page.

Examples:

Drilldown view 1 according to country and filter according to calendar year 2000:

14.02.2001 Seite 35


<a href="<SAP_BW_URL DATA_PROVIDER='View 1' CMD='Expand' IOBJNM='0COUNTRY'

FILTER_IOBJNM='0CALYEAR' FILTER_VALUE='2000'>">Jahr 2000 + Aufriß nach Land</a>

Forms where a user can select a calendar year and a country from dropdown boxes:

<form method="POST" action="<SAP_BW_URL DATA_PROVIDER='*' MULTI='X'

FILTER_IOBJNM_1='0CALYEAR' FILTER_IOBJNM_2='0COUNTRY'>">

<table>

<tr>

<td>Kalenderjahr</td>

<td><select size="1" name="FILTER_VALUE_1">





</select></td>

</tr>

<tr>

<td>Land</td>

<td><select name="FILTER_VALUE_2">

<option value="BR">Brazil</option>

<option value="DE">Germany</option>

<option value="FR">France</option>

<option value="GB">GreatBritain</option>

<option value="JP">Japan</option>

<option value="RU">Russia</option>

<option value="ES">Spain</option>

<option value="US">USA</option>

</select></td>

</tr>

<table>

<input type="submit" value="Submit" name="Submit">

</form>

Buttons that filter view 1 according to calendar year:

<form method="POST" action="<SAP_BW_URL DATA_PROVIDER='View 1'

FILTER_IOBJNM='0CALYEAR'>">

<input type="submit" value="1998" name="FILTER_VALUE">



</form>

14.02.2001 Seite 36

SAP BW - ITtestpapers.com

Web Reporting

Function Description

14. February 2001

Version 2.0B13

(Valid as of BW 2.0B Server Patch 13)

Contents:

1 Overview

2 Glossary

Alert Monitor

BW URL

.

Data Provider

Item

Item Table

Item Text Element

Item Filter

Item Nav Block

Item Chart

Item Exception

Item Condition

Comment Tag

Object Tag

Style Sheet

Template

View

Web Publisher

3 Templates

4 Object Model

5 Parameterizing Templates

6 Command Sequences

7 Forms

Related documents

Products

Support