Академический Документы
Профессиональный Документы
Культура Документы
Web Reporting
Function Description
Version 2.0B13
Contents:
1 Overview............................................................................................................................4
2 Glossary.............................................................................................................................5
3 Templates..........................................................................................................................7
3.1 Structure.................................................................................................................................................... 7
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
14.02.2001 Seite2
Function Description
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.................................................................................................................................................. 30
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 Seite3
Function Description
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 Seite4
Function Description
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. 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
document.
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 Filter
Item that displays the view's filter values created by navigating. It is also possible to select
individual text elements.
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 Seite5
Function Description
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: <!-- BW HTML
START ItemId="Table" ViewId="View 1" -->. 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 Seite6
Function Description
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>
<linkrel="stylesheet"href="/sap/its/mimes/webrfc/bw/SAPBEx.css">
<title>NewPage1</title>
</head>
<body>
<!Createthedataprovider>
<object>
<paramname='OWNER'value='SAP_BW'>
<paramname='CMD'value='SET_DATA_PROVIDER'>
<paramname='DATA_PROVIDER'value='View1'>
<paramname='VIEWID'value='Viewabc'>
DATA_PROVIDER:View1
</object>
<!Createandgetthenavigationalblock>
<objectWIDTH="350">
<paramname='OWNER'value='SAP_BW'>
<paramname='CMD'value='GET_ITEM'>
<paramname='ITEM'value='NavBlock'>
<paramname='ITEMID'value='NavBlock'>
<paramname='DATA_PROVIDER'value='View1'>
ITEM:NavBlock
</object>
<br>
<!Createandgetthetable>
<objectWIDTH="600">
<paramname='OWNER'value='SAP_BW'>
<paramname='CMD'value='GET_ITEM'>
<paramname='ITEM'value='Table'>
<paramname='ITEMID'value='Table'>
<paramname='DATA_PROVIDER'value='View1'>
ITEM:Table
</object>
</body>
14.02.2001 Seite7
Function Description
Create view with filter on country USA and style sheet for input help:
<object>
<paramname='OWNER'value='SAP_BW'>
<paramname='CMD'value='SET_DATA_PROVIDER'>
<paramname='DATA_PROVIDER'value='View1'>
<paramname='VIEWID'value='Viewabc'>
<paramname='FILTER_IOBJNM'value='0COUNTRY'>
<paramname='FILTER_VALUE'value='US'>
<paramname='STYLE_SHEET'value='/sap/its/mimes/webrfc/BWReport.css'>
DATA_PROVIDER:View1
</object>
14.02.2001 Seite8
Function Description
<paramname='ITEMID'value='NavBlock'>
<paramname='DATA_PROVIDER'value='View1'>
ITEM:NavBlock
</object>
Create item with height 400 pixels, width 500 pixels and title Business Graphic:
<objectWIDTH='400'HEIGHT='500'>
<paramname='OWNER'value='SAP_BW'>
<paramname='CMD'value='GET_ITEM'>
<paramname='ITEM'value='Chart1'>
<paramname='ITEMID'value='PieChart'>
<paramname='DATA_PROVIDER'value='View1'>
<paramname='GENERATE_CAPTION'value='X'>
<paramname='Caption'value='BusinessGrafik'>
ITEM:Chart1
</object>
14.02.2001 Seite9
Function Description
4 Object Model
a le rt_ m o n ito r
d a ta _ p ro v id e r v ie w
0 ..*
1
te m p la te 1 1
0 ..*
ite m _ ta b le
ite m _ n a v _ b lo c k
ite m ite m _ filte r
0 ..*
ite m _ te x t_ e le m e n ts
ite m _ e x c e p tio n
ite m _ c o n d itio n
ite m _ filte r_ d d o w n
ite m _ filte r _ r a d io
ite m _ la b e l
ite m _ c h a r
ite m _ m a p
ite m _ a le r t_ m o n ito r
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.
CMD LDOC
Parameter Description
WBID Excel workbook key under which the template is stored in
the BEx
The workbook must be stored in BW (favorites, activity groups
/ roles).
PAGEID Template name
Name under which the template is stored in the Web Publisher.
14.02.2001 Seite10
Function Description
'X' = Yes, ' ' = No 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.
STYLE_SHEET (optional) 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.
TRACE (optional) Switch OLAP Trace on
'X' = switch on, ' ' = do not switch 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.
VARIABLE_SCREEN (optional) Display Variable Screen
'X' = Display variable screen, ' ' = do not If you call up a template containing views with variables ready
display, if possible 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.
14.02.2001 Seite11
Function Description
Examples:
Call up template without navigating:
http://your_its/scripts/wgate/WebRFC/!?
_function=WEBQUERY&CMD=LDOC&WBID=D9EW857MLP6EN0AEM9BZSQP3C&PAGEID=Template_Name&
STATELESS=X
Call up template with trace switched on
http://your_its/scripts/wgate/WebRFC/!?
_function=WEBQUERY&CMD=LDOC&WBID=D9EW857MLP6EN0AEM9BZSQP3C&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=D9EW857MLP6EN0AEM9BZSQP3C&PAGEID=Template_Name
&
VARIABLE_SCREEN=X&VARIABLES_CLEAR=X
Parameter Description
INFOCUBE Technical name of the InfoCube
QUERY Technical name of the query
Parameter Description
VIEWID Key for a view
A view gets its initial status from the specified ViewID. The
ViewID identifies a view within a workbook
DATA_PROVIDER_WBID Excel workbook key under which the data provider is
stored in the BEx
The workbook must be stored in BW (favorites, activity groups
/ 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=D9EW857MLP6EN0AEM9BZSQP3C&PAGEID=Template_Name&
infocube=myCube&query=myQuery
14.02.2001 Seite12
Function Description
CMD CHANGE_TEMPLATE
Parameter Description
WBID Excel workbook key under which the template is stored in
the BEx
The workbook must be stored in BW (favorites, activity groups
/ roles).
PAGEID Template name
Name under which the template is stored in the Web Publisher.
Examples:
<SAP_BW_URL CMD='CHANGE_TEMPLATE' WBID='D9EW857MLP6EN0AEM9BZSQP3C'
PAGEID='DETAILS'>
CMD SET_URLS
Parameter Description
ICON_PREFIX 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=D9EW857MLP6EN0AEM9BZSQP3C&PAGEID=Template_Name
&cmd_1=cmd%3DSET_URLS%26ICON_PREFIX%3DmyPath
CMD PAGE_FREE
Examples:
<SAP_BW_URL CMD='PAGE_FREE'>
14.02.2001 Seite13
Function Description
CMD PROCESS_VARIABLES
SUBCMD VARIABLE_SCREEN
Examples:
<SAP_BW_URL CMD='PROCESS_VARIABLES' SUBCMD='VARIABLE_SCREEN'>
CMD LOG_OFF
~command (optional) End Logon to ITS
'logoff' = log off from the 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'>
14.02.2001 Seite14
Function Description
Parameter Description
VAR_NAME_I Technical name of the variable
VAR_VALUE_EXT_I Node key in external display
Name of the node characteristic
VAR_NODE_IOBJNM_I Name of the node characteristic
For characteristic nodes, you must enter the characteristic
name, like you do for text nodes (0HIER_NODE).
Parameter Description
VAR_NAME_I Technical name of the variable
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_name_2=mySelOptVa
r&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
CMD PROCESS_VARIABLES
SUBCMD VAR_SUBMIT
Examples:
<SAP_BW_URL CMD='PROCESS_VARIABLES' SUBCMD='VAR_SUBMIT'
VAR_NAME_1=myParameterVariable VAR_VALUE_EXT_1=4711>
Attribute Description
DATA_PROVIDER ( or name ) Logical name of the data provider
You cannot change this attribute with a This name is used to couple items with this data provider and
command URL. to send commands to the data provider. The name must be
unique within the template.
WBID ( or DATA_PROVIDER_WBID ) Excel workbook key under which the data provider is
14.02.2001 Seite15
Function Description
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 Description
CMD 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 Data provider name
DATA_PROVIDER_N 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 Use DATA_PROVIDER as template
Optional If MULTI is set to 'X', then the command is applied to all the
'X' = Yes, ' ' = No 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='' ...>
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 Description
ViewID Key for a view
You cannot change this attribute with a A view gets its initial status from the specified ViewID. The
command URL. 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 ) Excel workbook key under which the data provider is
(optional) stored in the BEx
You cannot change this attribute with a The workbook must be stored in BW (favorites, activity groups
command URL. / roles).
14.02.2001 Seite16
Function Description
CMD Description
BACK Undoes the last action performed in this view.
RESET Jumps back to the navigational status that you saw when you
called up the page.
FORWARD Performs an undone action again.
Examples:
You want to undo the last action in view 1:
<SAP_BW_URLDATA_PROVIDER='View1'CMD='BACK'>
You want to reset all views to how they were when you called up the page:
<SAP_BW_URLDATA_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 Description
FILTER_IOBJNM Name of characteristic / structure according to which you
FILTER_IOBJNM_N (optional) want to filter
Specify the technical name of the characteristic (for example,
0COUNTRY) / structure (25 place character string) here.
FILTER_COLLAPS (optional) Remove filter characteristics from drilldown
Take the characteristics that are specified under
FILTER_IOBJNM according to the axis filter. If the parameter
'X' = Yes, ' ' = No is not specified, the value X = yes is used.
VAR_SIGN_N (optional) Effect of the row
'I' found values add,
14.02.2001 Seite17
Function Description
Parameter Description
FILTER_VALUE Filter value
FILTER_VALUE_N Value by which you want to set the filter. If you choose the
FILTER_VALUE_EXT variant with the ending EXT, you must specify the complete
FILTER_VALUE_EXT_N 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) Type of value, specified under FILTER_VALUE
FILTER_VALUE_TYPE_N (optional) '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 (optional) Operator
OPERATOR_N (optional) '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.
Parameter Description
FILTER_VALUE_LOW Filter value lower limit (not compounded)
FILTER_VALUE_LOW_N
FILTER_VALUE_LOW_EXT
FILTER_VALUE_LOW_EXT_N
The following additional parameters are given for filtering hierarchy nodes:
Parameter Description
FILTER_VALUE Hierarchy node name
FILTER_VALUE_N
14.02.2001 Seite18
Function Description
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_URLDATA_PROVIDER='*'MULTI='X'FILTER_IOBJNM='0CALMONTH'
FILTER_VALUE='0CMONTH'FILTER_VALUE_TYPE='VARIABLE_EXIT'>
CMD Remove_Filter
Parameter Description
IOBJNM Name of characteristic / structure
IOBJNM_N 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 Remove all filters
'X' = Yes, ' ' = No 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_URLDATA_PROVIDER='View1'CMD='Remove_Filter'IOBJNM='0COUNTRY'>
Remove filter from country for all views and filter according to calendar year 2000:
<SAP_BW_URLDATA_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_URLDATA_PROVIDER='*'MULTI='X'CMD='Remove_Filter'ALL='X'
FILTER_IOBJNM='0CALYEAR'FILTER_VALUE='2000'>
CMD Process_help_window
HELP_SERVICE DP_VIEW_FILTER
Parameter Description
IOBJNM Name of characteristic / structure
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.
BOOKED_VALUES 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 Expand
Parameter Description
14.02.2001 Seite19
Function Description
Drilldown view 1 according to country and filter according to calendar year 2000:
<SAP_BW_URLDATA_PROVIDER='View1'CMD='Expand'IOBJNM='0COUNTRY'
FILTER_IOBJNM='0CALYEAR'FILTER_VALUE='2000'>
CMD Collaps
Parameter Description
IOBJNM Name of characteristic / structure
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_URLDATA_PROVIDER='View1'CMD='Collaps'IOBJNM='0COUNTRY'>
CMD Exchange
Parameter Description
IOBJNM_1 Name of characteristic / structure 1
Enter here the technical name of the 1st characteristic (for
example, 0COUNTRY) / 1st structure (25-place character
string).
IOBJNM_2 Name of characteristic / structure 2
Enter here the technical name of the 2nd characteristic (for
example, 0COUNTRY) / 2nd structure (25-place character
string).
Examples:
Replace drilldown according to country with drilldown according to calendar year in view 1:
14.02.2001 Seite20
Function Description
<SAP_BW_URLDATA_PROVIDER='View1'CMD='Exchange'IOBJNM_1='0COUNTRY'
IOBJNM_2='0CALYEAR'>
or:
<SAP_BW_URLDATA_PROVIDER='View1'CMD='Exchange'IOBJNM_1='0CALYEAR'
IOBJNM_2='0COUNTRY'>
Example:
Swap axes for view 1:
<SAP_BW_URLDATA_PROVIDER='View1'CMD='SWITCH_AXIS'>
CMD SET_NAV_STATE
Parameter Description
ALL Arrange all characteristics and structures again
'X' = Yes, ' ' = No 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.
4.2.3.10 Sort
Use this command to sort according to the parameters of the characteristics, or by value.
CMD Sort
Parameter Description
14.02.2001 Seite21
Function Description
CMD SET_LIST_CALCULATION
Parameter Description
Structure_Member_1 Structure part of 1st 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 2nd structure.
APPLY_TO_RESULTS (optional) Also apply calculation settings to result cells.
'X' = Yes, ' ' = No
CUMULATION (optional) Accumulated output
'X' = Yes, ' ' = No
VALUE_CALCULATION (optional) Calculations
'X' = Columns = No list calculation
'Y' = Rows R = Standardization of query result
G = Standardization of overall result
C = Standardization of result
S = Ranking list
O = Ranking list (olympic)
RESULT_CALCULATION (optional) 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
14.02.2001 Seite22
Function Description
11 = First value
12 = Last value
Examples:
Display maximum plan turnover:
<SAP_BW_URLDATA_PROVIDER='View1'CMD='SET_LIST_CALCULATION'
STRUCTURE_MEMBER_1='DTG057U7OQ8K2ALKCMR2AWM14'
STRUCTURE_MEMBER_2='EFG057U7OQ8K2JKKCMR2AWM67'VALUE_CALCULATION='02'>
CMD Set_Hierarchy_State
Parameter Description
IOBJNM Characteristic name
Characteristic that already has a display hierarchy assigned to
it.
ACTIVE (Option 1) Required status of the display hierarchy
'X' = activate, ' ' = deactivate
TOGGLE_STATE (Option 2) Switch the status of the hierarchy
'X' = switch over, ' ' = do not change 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_URLDATA_PROVIDER='View1'CMD='Set_Hierarchy_State'
IOBJNM='0COSTCENTER'ACTIVE='X'>
CMD Set_Hierarchy
Parameter Description
IOBJNM Characteristic name
The characteristic to which you want to assign a display
hierarchy.
HIERARCHY_NAME Technical name of the hierarchy
HIERARCHY_VERSION Version of the hierarchy
If the required hierarchy has a version, you must specify the
version, otherwise, this parameter can be left out.
HIERARCHY_DATE 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.
ACTIVE Required status of the display hierarchy
'X' = activate, ' ' = deactivate
Example:
Assign 'MyHierarchy' to the characteristic cost center for view 1:
<SAP_BW_URLDATA_PROVIDER='View1'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.
CMD Drill_To_Level
Parameter Beschreibung
IOBJNM Characteristic name
The characteristic that has an active display hierarchy assigned
to it.
14.02.2001 Seite23
Function Description
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 Description
IOBJNM Characteristic name
The characteristic that has an active display hierarchy assigned
to it.
NODE_NAME Node name
Technical name of the node (internal display).
NODE_IOBJNM Name of the node characteristic
For characteristic nodes, you must enter the characteristic
name, like you do for text nodes (0HIER_NODE).
DRILL_STATE Required drill state
'E' = expanded, 'C' = collapsed
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_URLDATA_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_URLDATA_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'>
CMD Set_Exception_State
Parameter Description
EXCEPTION_ID Technical name of the exception
Enter the technical name of the exception here (25-place
character string).
ACTIVE (Option 1) Required status of the exception
'X' = activate, ' ' = deactivate
TOGGLE_STATE (Option 2) Switch the exception status
'X' = switch over, ' ' = do not change 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:
14.02.2001 Seite24
Function Description
<SAP_BW_URLDATA_PROVIDER='View1'CMD='Set_Exception_State'
EXCEPTION_ID='DTG057U7OQ8K2ALKCMR2AWM14'ACTIVE='X'>
CMD Set_Condition_State
Parameter Description
CONDITION_ID Technical name of the condition
Enter the technical name of the condition here (25-place
character string).
ACTIVE (Option 1) Required status of the condition
'X' = activate, ' ' = deactivate
TOGGLE_STATE (Option 2) Switch the status of the condition
'X' = switch over, ' ' = do not change 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_URLDATA_PROVIDER='View1'CMD='Set_Condition_State'
EXCEPTION_ID='DTG057U7OQ8K2ALKCMR2AWM14'ACTIVE='X'>
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.
Attribute Description
ITEM ( or NAME ) Logical name for the item
You cannot change this attribute with a In addition to the ITEMID given when you create the item in
command URL. 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
than once in a template. If you send commands to this item,
always specify the name of the item as item parameter.
ITEMID Item key
14.02.2001 Seite25
Function Description
You cannot change this attribute with a An item is created for a template on the basis of an item setting
command URL. 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) Key for the Excel workbook under which the item is stored
You cannot change this attribute with a in the Web Publisher
command URL. The workbook must be stored in BW (favorites, activity groups
/ roles).
If this parameter is not specified, the template WBID is used
instead.
DATA_PROVIDER Logical name of the data provider for the item
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
HIDDEN Hide item
'X' = Yes, ' ' = No If HIDDEN=X, then the item is not displayed, nor is the title
with the open/close symbol.
CLOSED Close item
'X' = Yes, ' ' = No 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.
GENERATE_CAPTION Display item header
'X' = Yes, ' ' = No Style SAPBEXTableCaption is used for the header.
CAPTION Header
If you do not specify a header, a suitable default value is used
instead (if Generate_Caption is equal to 'X').
GENERATE_LINKS Create filter and navigation URLs
'X' = Yes, ' ' = No If you do not want the user to be able to navigate or to see a
printable version, then set this attribute to ' ' = No
WIDTH Item width
Entry in pixels 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.
HEIGHT Item height
Entry in pixels Exactly this height is used for graphics. This attribute has no
function with HTML tables.
Attribute Description
ALT_STYLES Alternate row format (zebra list)
'X' = Yes, ' ' = No 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.
BLOCK_SIZE 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.
14.02.2001 Seite26
Function Description
Attribute Description
TARGET_HELP_FRAME Frame in which Input Help is displayed
(optional) If you use HTML frame technology, then you have the option
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.
FILTER_VALUE_LENGTH Number of characters after which a filter value is indicated
(default value : 80) with :
If the value is set to 0, the filter value is displayed in its
complete form.
HORIZONTAL_ALIGNMENT Horizontal display of the navigation block
'X' = Yes, ' ' = No 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.
HORIZONTAL_NUMBER 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.
ITEM_NAV_BLOCK_IOBJNM_N (optional) 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.
BOOKED_VALUES 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 Description
ONLY_VALUES Display values only
'X' = Yes, ' ' = No The filter values are separated with a semicolon, without
description or formatting.
FILTER_VALUE_LENGTH Number of characters after which a filter value is indicated
(default value : 0) with :
14.02.2001 Seite27
Function Description
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>
<paramname='OWNER'value='SAP_BW'>
<paramname='CMD'value='GET_ITEM'>
<paramname='ITEM'value='Filter'>
<paramname='ITEMID'value='Filter'>
<paramname='DATA_PROVIDER'value='View1'>
<paramname='ONLY_VALUES'value='X'>
<paramname='ITEM_FILTER_IOBJNM'value='0CALYEAR'>
<paramname='PRESENTATION'value='KEY'>
ITEM:Filter
</object>">
<input type=submit value="Submit">
<input type=reset value="Reset">
</form>
Attribute Description
ONLY_VALUES Display values only
'X' = Yes, ' ' = No The text element values are separated with a semicolon,
without description or formatting.
SHOW_COMMON_ELEMENTS Display general text elements (validity of data, InfoCube,
14.02.2001 Seite28
Function Description
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 Description
SWITCHMATRIX Inverting data
'X' = Yes, ' ' = No 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.
SUPPRESS_OPENHIERARCHIENODES Hide open hierarchy node
'X' = Yes, ' ' = No 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.
14.02.2001 Seite29
Function Description
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 Description
IOBJNM 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.
SHOW_LABEL BW Use description as heading
'X' = Yes, ' ' = No
If this attribute is activated, the characteristic descrption is used
as the heading of the selection list.
MAXVALUES (optional) 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) Only create selection list
'X' = Yes, ' ' = No
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.
(optional) 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.
Attribute Description
IOBJNM 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.
SHOW_LABEL BW Use description as heading
'X' = Yes, ' ' = No
If this attribute is activated, the characteristic description is
used as the heading of the selection list.
MAXVALUES (optional) 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) Only create selection button group
'X' = Yes, ' ' = No
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
14.02.2001 Seite30
Function Description
Attribute Description
IOBJNM Name of characteristic / structure
Specify the technical name of the characteristic (for example,
0COUNTRY) / structure (25 place character string) here.
ATTRINM Attribute name
Technical name of the attribute whose heading should be
displayed as a label.
STRUCTURE_MEMBER Structure part
Structure part whose text or context menu is displayed.
CONTEXT_MENU Context menu
'X' = Yes, ' ' = No If you activate this attribute, a link is created in the description
of the characteristic to the context menu of the characteristic.
ONLY_VALUES Unformatted display
'X' = Yes, ' ' = No Display description without formatting.
Attribute Description
FILTER_RED Only display rows with at least one red / yellow / green
FILTER_YELLOW light.
FILTER_GREEN For example, if you choose only FILTER_RED=X and
'X' = Yes, ' ' = No FILTER_YELLOW=X, you do not see any rows that are green.
FILTER_INFOAREA Filter according to entries that are below a certain InfoArea
If the attribute is empy, no filter is used.
FILTER_INFOCUBE Filter according to entries that are below a certain
InfoCube
If the attribute is empy, no filter is used.
FILTER_QUERY Filter according to entries that are below a certain query
If the attribute is empy, no filter is used.
14.02.2001 Seite31
Function Description
14.02.2001 Seite32
Function Description
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=D9EW857MLP6EN0AEM9BZSQP3C&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=D9EW857MLP6EN0AEM9BZSQP3C&PAGEID=Template_Name&
FILTER_IOBJNM=0COUNTRY&FILTER_VALUE=DE
14.02.2001 Seite33
Function Description
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=D9EW857MLP6EN0AEM9BZSQP3C&PAGEID=Template_Name&
CMD_1=DATA_PROVIDER%3DDP1%26FILTER_IOBJNM%3D0COUNTRY%26FILTER_VALUE
%3DDE&CMD_2=DATA_PROVIDER%3DDP2%26FILTER_IOBJNM%3D0COUNTRY%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 Seite34
Function Description
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.
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>
<formmethod="POST"action="http://your_its/scripts/wgate/WebRFC/!?
_function=WEBQUERY&CMD=LDOC&WBID=D9EW857MLP6EN0AEM9BZSQP3C&PAGEID=Template_Name&FILTER_IO
BJNM_1=0CALYEAR&FILTER_IOBJNM_2=0COUNTRY">
<tr>
<td>Kalenderjahr</td>
<td><selectsize="1"name="FILTER_VALUE_1">
<optionvalue="1997">1997</option>
<optionvalue="1998">1998</option>
<optionvalue="1999">1999</option>
<optionvalue="2000">2000</option>
</select></td>
</tr>
<tr>
<td>Land</td>
<td><selectname="FILTER_VALUE_2">
<optionvalue="BR">Brazil</option>
<optionvalue="DE">Germany</option>
<optionvalue="FR">France</option>
<optionvalue="GB">GreatBritain</option>
<optionvalue="JP">Japan</option>
<optionvalue="RU">Russia</option>
<optionvalue="ES">Spain</option>
<optionvalue="US">USA</option>
</select></td>
</tr>
</table>
<inputtype="submit"value="Submit"name="Submit">
</form>
</body>
</html>
14.02.2001 Seite35
Function Description
Drilldown view 1 according to country and filter according to calendar year 2000:
<ahref="<SAP_BW_URLDATA_PROVIDER='View1'CMD='Expand'IOBJNM='0COUNTRY'
FILTER_IOBJNM='0CALYEAR'FILTER_VALUE='2000'>">Jahr2000+AufrinachLand</a>
Forms where a user can select a calendar year and a country from dropdown boxes:
<formmethod="POST"action="<SAP_BW_URLDATA_PROVIDER='*'MULTI='X'
FILTER_IOBJNM_1='0CALYEAR'FILTER_IOBJNM_2='0COUNTRY'>">
<table>
<tr>
<td>Kalenderjahr</td>
<td><selectsize="1"name="FILTER_VALUE_1">
<optionvalue="1997">1997</option>
<optionvalue="1998">1998</option>
<optionvalue="1999">1999</option>
<optionvalue="2000">2000</option>
</select></td>
</tr>
<tr>
<td>Land</td>
<td><selectname="FILTER_VALUE_2">
<optionvalue="BR">Brazil</option>
<optionvalue="DE">Germany</option>
<optionvalue="FR">France</option>
<optionvalue="GB">GreatBritain</option>
<optionvalue="JP">Japan</option>
<optionvalue="RU">Russia</option>
<optionvalue="ES">Spain</option>
<optionvalue="US">USA</option>
</select></td>
</tr>
<table>
<inputtype="submit"value="Submit"name="Submit">
</form>
Buttons that filter view 1 according to calendar year:
<formmethod="POST"action="<SAP_BW_URLDATA_PROVIDER='View1'
FILTER_IOBJNM='0CALYEAR'>">
<inputtype="submit"value="1998"name="FILTER_VALUE">
<inputtype="submit"value="1999"name="FILTER_VALUE">
<inputtype="submit"value="2000"name="FILTER_VALUE">
</form>
14.02.2001 Seite36