Web API Reference - Angelfire: Welcome to Angelfire · · 2005-04-08Commands for Exceptions ... URLs are configures to the SAP Web Application server. Web API Reference BW 3.5 9

Web API Reference

HE

LP

.BW

_IN

TE

RN

AL

Re lease BW 3 .5

SAP Online Help 25.02.2005

Copyright © Copyright 2004 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. IBM, DB2, DB2 Universal Database, OS/2, Parallel Sysplex, MVS/ESA, AIX, S/390, AS/400, OS/390, OS/400, iSeries, pSeries, xSeries, zSeries, z/OS, AFP, Intelligent Miner, WebSphere, Netfinity, Tivoli, and Informix are trademarks or registered trademarks of IBM Corporation in the United States and/or other countries. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C®, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.

Web API Reference BW 3.5 2


Icons in Body Text

Icon Meaning

Caution

Example

Note

Recommendation

Syntax

a glance. For more information, see Help on Help → General Information Classes nd Information Classes for Business Information Warehouse on the first page of any version of

.

ypographic Conventions

Example text quoted from the screen. These include field enu names, menu paths,

Additional icons are used in SAP Library documentation to help you identify different types of information ataSAP Library

T

Type Style Description

Words or charactersnames, screen titles, pushbuttons labels, mand menu options.

Cross-references to other documentation. Example text Emphasized words or phrases in body text, graphic titles, and table

titles.

Technical names of system objects. These include report names, program names, transaction codes,

EXAMPLE TEXT table names, and key concepts of a

Example text y names and their d

e

<Example text> user entry. Angle brackets indicate that you replace these ake entries in the

EXAMPLE TEXT Keys on the keyboard, for example, F2 or ENTER.

programming language when they are surrounded by body text, for example, SELECT and INCLUDE.

Output on the screen. This includes file and directorpaths, messages, names of variables and parameters, source text, annames of installation, upgrade and database tools.

Example text Exact user entry. These are words or characters that you enter in thsystem exactly as they appear in the documentation.

Variable words and characters with appropriate entries to msystem.



Web API Reference......................................................................................................................... 9 Web items .................................................................................................................................. 10

General Attributes .................................................................................................................. 12

Table....................................................................................................................................... 16

Chart....................................................................................................................................... 21

Dropdown Box........................................................................................................................ 24

Radio Button Groups.............................................................................................................. 27

Checkboxes............................................................................................................................ 30

Generic Navigation Block ....................................................................................................... 32

Hierarchical Filter Selection.................................................................................................... 36

Filters...................................................................................................................................... 38

Label....................................................................................................................................... 41

Text Elements......................................................................................................................... 43

List of Exceptions ................................................................................................................... 46

List of Conditions.................................................................................................................... 47

Alert Monitor ........................................................................................................................... 48

Role Menu .............................................................................................................................. 52

Ticker...................................................................................................................................... 56

Maps....................................................................................................................................... 57

Map Attributes..................................................................................................................... 59

Attributes for Map Layers................................................................................................ 63

Special Attributes for Color Shading ........................................................................... 65

Special Attributes for Bar Charts ................................................................................. 67

Special Attributes for Pie Charts ................................................................................. 69

Special Attributes for Pie Charts (split)........................................................................ 71

Special Attributes for Dot Density................................................................................ 72

Special Attributes for Symbols .................................................................................... 74

Special Attributes for Symbol (Size-dependent) ......................................................... 76

Special Attributes for Symbol (Color-dependent) ........................................................ 78

Special Attribute: Line.................................................................................................. 80

Special Attribute: Line (Size-dependent)..................................................................... 82

Special Attributes for Lines (Color-dependent) ........................................................... 84

Array Attributes ............................................................................................................... 86

Map Renderer ................................................................................................................. 88

Single Document .................................................................................................................... 91

List of Documents................................................................................................................... 95



Object Catalog of the Web Application .................................................................................. 98

Data Provider – Information ................................................................................................... 99

Web Template ...................................................................................................................... 100

Broadcaster .......................................................................................................................... 103

Query View – Selection ........................................................................................................ 104

Key Figure Overview ............................................................................................................ 107

Ad-hoc Query Designer........................................................................................................ 109

ABC Classification................................................................................................................ 114

What If Prediction ................................................................................................................. 115

Web Template Properties..................................................................................................... 117

Web Templates........................................................................................................................ 119 Overriding Attributes ................................................................................................................ 121 Object Tags.............................................................................................................................. 124

Object Tag for the Properties of Web Templates................................................................. 125

Adjusting and Enhancing the Context Menu .................................................................... 131

Adjusting the Context Menu.......................................................................................... 132

Enhancing the Context Menu........................................................................................ 139

Object Tag for Data Provider................................................................................................ 142

Object Tag for Web Items .................................................................................................... 144

Command URLs....................................................................................................................... 145 Changing Web Item Attributes ............................................................................................. 147

Resetting and Reinitializing Web Items................................................................................ 148

Commands for Web Templates............................................................................................ 150

Calling up Web Templates................................................................................................ 151

Calling Parameterized Web Templates ........................................................................ 153

Default Variables for Web Applications......................................................................... 154

Switching Web Templates ................................................................................................ 158

Personalizing Web Templates.......................................................................................... 159

Creating Bookmarks ......................................................................................................... 160

Changing Symbol Directory .............................................................................................. 161

Releasing Web Templates................................................................................................ 162

Ending the Session........................................................................................................... 163

Variables........................................................................................................................... 164

Calling up the Variables Screen.................................................................................... 165

Changing the Values of Variables................................................................................. 166

Calling the Broadcaster .................................................................................................... 167

Calling the Open Dialog.................................................................................................... 170



Data Provider - Commands.................................................................................................. 172

General Data Provider Commands .................................................................................. 174

Properties of Data Providers......................................................................................... 175

Resetting and Reinitializing Data Providers.................................................................. 177

Back and Back to Start.................................................................................................. 179

Jumping Using Report-Report Interface ....................................................................... 180

Exporting Data .............................................................................................................. 181

Saving the Query View.................................................................................................. 182

Displaying a Copy of the Data Provider on a New Page .............................................. 183

Calling the Ad-hoc Query Designer .............................................................................. 184

Filter .................................................................................................................................. 185

Removing Filters ........................................................................................................... 188

Drilldown ........................................................................................................................... 189

Remove Drilldown ......................................................................................................... 190

Switching Characteristics/Structures ................................................................................ 191

Swap Axes........................................................................................................................ 192

Setting the Navigational Status ........................................................................................ 193

Sorting............................................................................................................................... 195

Setting Properties of Display Attributes ............................................................................ 197

Results Row Position........................................................................................................ 198

Suppressing Result Rows................................................................................................. 199

Setting the Display............................................................................................................ 200

Displaying Documents ...................................................................................................... 201

Dialogs.............................................................................................................................. 202

Calling Dialog Query Properties.................................................................................... 203

Calling Up Dialog Box for Formula Definition................................................................ 204

Calling up Input Help..................................................................................................... 205

Calling the Characteristic Properties Dialog ................................................................. 206

Calling a Dialog for Currency Translation ..................................................................... 207

Calling a Dialog for Defining Exceptions....................................................................... 208

Calling a Dialog for Defining Conditions ....................................................................... 209

Calling a Dialog for Cell Properties ............................................................................... 210

Save Query View Dialog Box........................................................................................ 211

Creating Your Own Dialogs........................................................................................... 213

Exceptions and Conditions ............................................................................................... 216

Commands for Exceptions............................................................................................ 217

Setting the Status of an Exception................................................................................ 220



Commands for Conditions............................................................................................. 221

Setting the Status of a Condition .................................................................................. 223

Commands for Currency Translation................................................................................ 224

Commands for Values Cells ............................................................................................. 225

List Calculations................................................................................................................ 226

Operations for Display Hierarchies................................................................................... 228

Command Sequences.......................................................................................................... 232

Using Forms............................................................................................................................. 234 Use of JavaScript Functions .................................................................................................... 237

Send Commands.................................................................................................................. 238

Execute URL in the Same Window .................................................................................. 239

Execute URL in a New Window........................................................................................ 240

URL from a New Window in the Opening Window........................................................... 241

Closing Windows .............................................................................................................. 242

Executing a Form in a New Window................................................................................. 243

Executing a Form in the Opening Window ....................................................................... 244

Enhancing the Context Menu with JavaScript...................................................................... 245

Adding a Menu Entry using JavaScript............................................................................. 246

Command Processing ...................................................................................................... 248

Properties of Page Objects .................................................................................................. 251

Web Item Attributes .......................................................................................................... 252

Characteristics for Data Providers.................................................................................... 253

Specifying Properties for Web Templates ........................................................................ 255

Calendar for Date Filter ........................................................................................................ 257

Logon Language .................................................................................................................. 258

Language-Dependent Texts .................................................................................................... 259 Creating ABAP Programs for Maintaining Language-Dependent Texts.............................. 260

More Complex Examples of Applications ................................................................................ 262 Dynamically Changing Attributes ......................................................................................... 263

Using Several Tab Pages..................................................................................................... 266

Example Scenario for the Parameter NO_OUTPUT............................................................ 270

XML Web Item: Data Provider Information .......................................................................... 274

Web Design API for Tables...................................................................................................... 277 Creating and Using ABAP Classes ...................................................................................... 278

Table Interface ..................................................................................................................... 281

Attributes........................................................................................................................... 282

Datasets ........................................................................................................................ 284



AXIS_INFO................................................................................................................ 285

AXIS_DATA............................................................................................................... 287

CELL_DATA .............................................................................................................. 289

TXT_SYMBOLS ........................................................................................................ 291

Events ............................................................................................................................... 292

Manipulating Cell Contents............................................................................................... 293

Headers......................................................................................................................... 295

Scaling Factors ............................................................................................................. 296

Characteristic Values .................................................................................................... 297

Attribute Values............................................................................................................. 299

Structural Components ................................................................................................. 300

Data Cells...................................................................................................................... 301

Error Cells ..................................................................................................................... 302

Labeling Area of the Navigation Block .......................................................................... 303

Filter Area of the Navigation Block................................................................................ 305

Service Methods ............................................................................................................... 307

Creating Navigation URLs............................................................................................. 308

Information on the Navigation Status............................................................................ 309

Information on a Specific Cell ....................................................................................... 311

Symbols......................................................................................................................... 313

Sending Messages........................................................................................................ 314

JavaScript Functions..................................................................................................... 315

Determining Specific Attributes for the Table Interface ................................................ 316



Web API Reference Purpose The Business Explorer Web Application Design enables you to apply generic OLAP navigation to BW data in Web applications and Business Intelligence cockpits in simple to highly specialized scenarios. You can use standard markup languages and Web Design APIs to implement highly individual scenarios with user-defined interface elements. Web application design comprises a broad spectrum of interactive Web-based business intelligence scenarios that you can adjust to meet your requirements using standard Web technologies.

This document is intended for Web designers who want to create highly-specialized applications (BI cockpits, and so on) on the basis of Web application design.

You can access BW data in Web applications using a Web browser. This is usually installed with 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.

Within SAP BW 3.0A, the preferred method of accessing BEx Web Applications is via a conversion to the SAP Web Application Server. For this reason, all example-URLs are configures to the SAP Web Application server.



Web items Definition Web items are objects that obtain data from data providers [Seite 172] and make the data available as HTML. Web items have attributes such as header, width, height, and create navigation links. You use parameters or specific commands to change these attributes.

If the data, the navigational status, or the attributes change, the HTML for the Web item is regenerated. A Web item must always be assigned to a data provider.

Structure The following Web items are used in Web applications:

• Table [Seite 16]

• Chart [Seite 21]

• Dropdown Box [Seite 24]

• Radio Button Group [Seite 27]

• Checkboxes [Seite 30]

• Generic Navigation Block [Seite 32]

• Hierarchical Filter Selection [Seite 36]

• Filter [Seite 38]

• Label [Seite 41]

• Text Element [Seite 43]

• List of Exceptions [Seite 46]

• List of Conditions [Seite 47]

• Alert Monitor [Seite 48]

• Role Menu [Seite 52]

Ticker [Seite 56]•

• Map [Seite 57]

• Single Document [Seite 91]

• List of Documents [Seite 95]

Data Provider - Information [Seite 99] •

Object Catalog of the Web Application [Seite 98] •

Web Template [Seite 100] •

• Broadcaster [Seite 103]

Key Figure Overview [Seite 107] •

Query View - Selection [Seite 104] •



• Ad-hoc Query Designer [Seite 109]

• ABC Classification [Seite 114]

• What If Prediction [Seite 115]

Integration In the BEx Web Application Designer or the BEx Web Application wizard, on the Standard tab, you can use the Web items listed above as master Web items [Extern] You choose a master Weitem from the

ated your

b list, assign a data provider to the Web item and edit the attributes. You have now

own Web item that your can add to your Web template or save in the library to be sed again.

creu



General Attributes

Use General attributes are attributes that are valid for all Web items in Web applications.

Features The following general attributes are available:

Attributes Description

Logical name of a Web item (ITEM or NAME) As well as the Web item key (ITEMID) that is assigned when the Web item is created in the Web Application Designer you also have to assign a logical name when using the Web item in the Web application. This enables you to use the same Web item several times in a Web application. If commands are sent to this Web item you always have to specify the name of the Web item as the parameter ITEM.

SAP recommends that you keep to the conventions supported by the Web Application Designer when specifying names: The name should be a maximum of 30 characters long and consist of characters “A-Z”, “0-9” and “_”. It cannot start or end with “_”. Adhering to these conventions facilitates the upgrade to future SAP releases.

You cannot use a command-URL to change this attribute.

Web item key (ITEM_ID) (option 1)

You create a Web item for a Web application based on a Web item setting that you have made in the Web Application Designer.

You cannot use a command-URL to change this attribute.

Class name for the Web item class (ITEM_CLASS) (option 2)

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

The class name for the table is, for example, CL_RSR_WWW_ITEM_GRID



Logical name of the Data Provider for the Web item (DATA_PROVIDER)

You have to assign every Web item to (exactly) one data source. The Web item gets the data and metadata from this Data source that is needed to generate the output as well as commands.

SAP recommends that you keep to the conventions supported by the Web Application Designer when specifying names: The name should be a maximum of 30 characters long and consist of characters “A-Z”, “0-9” and “_”. It cannot start or end with “_”. Adhering to these conventions facilitates the upgrade to future SAP releases.

Height (HEIGHT) You can only specify the height in pixels.

This attribute is not used in tables.

The parameters ITEMID and WBID (ITEM_WBID) used in BW 2.x are still supported. However, we recommend that you no longer use these.

In the BEx Web Application Designer, in the Properties area, you can set the following attributes in the Web Item tab page, under General:


Caption (CAPTION) You can enter a caption. If you do not enter a caption, then an appropriate value is suggested.

Generate caption (GENERATE_CAPTION)

'X' = Yes, ' ' = No, 'BORDER' = Borders only

By activating this attribute ('X' = Yes), an additional row containing the Web item is generated in the table. The text you have entered under Caption is displayed in this table.

If you choose Borders Only, a border is generated without any additional lines for the caption. In this way you are able to realize all border types that are available under the Border Type attribute, without generating a caption line.

The SAPBEXTableCaption style is used for the caption.



Width in pixels (WIDTH) You can only specify the width in pixels. You can use the suggested width or determine a new width using Change Attribute...

Note that the Web browser automatically increases the widths of tables if the one you have chosen is too small.

Border type

(BORDER_STYLE)

'BORDER' = With border

‘NO_BORDER’ = Without border

‘FORM’ = Form

Here, you can choose the following display types for the Web item:

• With border

Set as default value for table, generic navigation block, Alert Monitor, filter, text elements, menu, list of conditions, and list of exceptions.

The border is only displayed if GENERATE_CAPTION=X.

• Without border

Set as default value for maps, charts, and individual documents.

• For form

The content of the Web item is normally displayed with a blue background. Set as default value for document list, hierarchical context menu, label, dropdown box, radio button group, and checkboxes.

The standard value settings represent the recommended display type for the Web item.

Closed (CLOSED)

‘X’ = Yes, ‘ ’ = No

You can close the Web item (CLOSED=X): The Web item is not displayed. Only the caption still appears (if there is one) and the open/close symbol for this Web item. By clicking on the open/close symbol, you can make the Web item visible or invisible.

To be able to see the caption, yhave to activate the attributes Generate Caption and O

ou

bjects with Navigation Links.



Hide object (HIDDEN)

‘X’ = Yes, ‘ ’ = No

You can hide the Web item (HIDDEN=X): Although the Web item embedded in the Web template, it is not visible. The Web item and the caption with the open/close symbol are not shown.

Objects with navigation links (GENERATE_LINKS)

‘X’ = Yes, ‘ ’ = No

If you do not want the user of the Web application to be able to navigate within it or if you want the user to be able to print the display, and therefore the context menu is no longer to be displayed, then deactivate this function.

This attribute creates the open/close symbol, with which you can open or close the Web item. Behind this symbol is a link that calls up the Web application with the corresponding parameters.

Web item controls different data providers (TARGET_DATA_PROVIDER_I) (optional) For many Web items, this attribute appears under the respective special attributes. These Web items obtain their data from a view.

If a Web item is to control several data providers, for example, a navigation block, it can be expressed by this parameter. If it is not specified, the Web item always controls its own data provider. The values specified under this parameter are the logical names of the data providers, for example, references using wild cards. You do not have to specify the data provider belonging to the Web item. If it is missing, the Web item does not control its own data provider.

The Web item output generation is always based on the item’s own data provider and does not include the others. The commands are forwarded to the target data provider.



Table

o create a table for a Web application.

Definition A Web item that obtains data from a query view tNavigation links are incorporated with the table.

Use The Web item Table displays the value of a query view in the Web application in the form of a table. The same list geometry that is used in the BEx Analyzer is supported. Characteristics and structures can be displayed in both the rows and the columns.

Structure As well as its general attributes [Seite 12], the Web item Table has the following attributes:


Alternating styles for table rows (ALT_STYLES)

'X' = Yes, ' ' = No

In the rows, the formats SAPBEXstdData and SAPBEXstdDataOdd are used alternately to display numerical values. You can adjust them in the CSS file assigned to the template.

Totals cells are removed from this display.

Only hierarchy navigation

(ONLY_HIERARCHY_NAVIGATION) you can only expand and collapse from the list.'X' = Yes, ' ' = No

Only allow hierarchy navigation The context menu is hidden in this mode, and

Suppress repetition texts

(SUPPRESS_REPETITION_TEXTS)

'X' = Yes, ' ' = No erged and the texts and keys

for this attribute,

Suppressing repetition texts

If you set this attribute to ‘ ‘, the cells in the table are not mare repeated.

If you do not specify a valuethe texts are suppressed.

Number of data rows displayed at one time (BLOCK_SIZE)

after which an area for scrolling is inserted.

Specifying this attribute allows you to determine the number of data rows that are displayed

If the value is set to 0, the complete table is displayed, regardless of the number of data

ute is set to 100 by default.

rows.

The attrib



Rows scrolled per step

(BLOCK_STEP_SIZE)

Default setting: “0”

This attribute allows you more flexibility in structuring the scrolling logic:

You are able to determine the number of data rows scrolled per step. The default setting “0” corresponds to 2/3 of the display rows.

The value entered corresponds to the number of rows scrolled through.

If you enter the value “2”, two rows will be scrolled through.

If you want to scroll through all the displayed data rows, enter the same value as you entered for the attribute Number of data rows displayed at one time (BLOCK_SIZE).

Number of data columns displayed at one time (BLOCK_SIZE_COLUMNS)

Specifying this attribute allows you to determined the number of data columns that are displayed after which an area for scrolling is inserted.

If the value is set to 0, the complete table is displayed, regardless of the number of data columns.

The attribute is set to 0 by default.

Columns scrolled per step

(BLOCK_STEP_SIZE_COLUMNS)

Default setting: “0”

This attribute allows you more flexibility in structuring the scrolling logic: You are able to determine the number of data columns scrolled per step. The default setting “0” corresponds to 2/3 of the display columns. The value entered corresponds to the number of columns scrolled through.

If you enter the value “2”, two columns will be scrolled through

If you want to scroll through all the displadata rows, enter the same value as you entered for the attribute Numbecolumns displayed at one time

. yed

r of data

(BLOCK_SIZE_COLUMNS). Table: Scrolling area top (SHOW_PAGING_AREA_TOP)

' = Yes, ' ' = No

y the scrolling area at the start of the

'X

Displatable The attribute is specified with default ' '.



Table: Scrolling area bott

(SHOW_PAGING_AREA_BOTTOM

om

)

d of the

The attribute is set to ‘X’ by default. 'X' = Yes, ' ' = No

Display the scrolling area at the entable

Display column headers (SHOW_COLUMN_HEADER)

'X' = Yes, ' ' = No

Display the labels above the data The attribute is set to ‘X’ by default.

Display column headers SHOW_ROW_HEADER)

'X' = Yes, ' ' = No

Display the labels to the left of the data The attribute is set to ‘X’ by default.

Display data cells (SHOW_DATA_CELLS) wn by default. That is,

'X' = Yes, ' ' = No

The data cells are shothe attribute is set to ‘X’ by default.

Affected data provider le

(TARGET_DATA_PROVIDER)

List of data providers to which all tabcommands are sent.

Display data from value row (DATA_ROW_FROM)

Data row after which data is displayed The attribute is set to 1 by default.

Display data to value row (0=to the end)

(DATA_ROW_TO)

e value is not 0, data is displayed no scrolling

Data row to which data is displayed The attribute is set to 0 by default. If the value is 0, the system tries to display all of the rows. If there are too many, a scrolling area isinserted. If thup to the specified row and there is area.

Display data from value(DATA_COLUMN_FROM

column )

Data column after which the data is displayed The attribute is set to 1 by default.

Display data to value column (0=to the end)

(DATA_COLUMN_TO) ere are too many, a scrolling area

Data column to which data is displayed The attribute is set to 0 by default. If the value is 0, the system tries to display all of the columns. If this inserted. If the value is not 0, data is

e displayed up to the specified column and theris no scrolling area.

Attributes that cannot be set in the Web Applicatio

MODIFY_CLASS s that changes the table contents , you

can adjust the contents of the table cells individually.

n Designer: ABAP clasBy using the Web design API for tables

Also see: Web Design API for Tables [Seite 277]

Displa ns and 10 visible y the table with a maximum of 5 visible data columdata ro e and below the ws. Start at row 30 and show a scrolling area abovvalues

<object>



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



<param name=’CMD’ value=’GET_ITEM’> <param name='ITEM' value='Table'> <param name='ITEM_CLASS' value='CL_RSR_WWW_ITEM_GRID'> <param name='DATA_PROVIDER' value='View1 > <param name='DATA_ROW_FROM' value='30'>

<param name='BLOCK_SIZE' value='10'> <param name='BLOCK_SIZE_COLUMNS' value='5'>

bject>

<param name='SHOW_PAGING_AREA_TOP' value='X'> <param name='SHOW_PAGING_AREA_BOTTOM' value='X'>

ITEM :Table

</o

Display only the 3 data rows without headers

<object>

<param name=’OWNER’ W’> ame=’CMD’ valame='ITEM' val

<param name='ITEM_ID' <param name='DATA_PR <param name='DATA_RO <param name='DATA_RO

<param name='SHOW_C

ITEM :Table

</object>

formation on using the Table

value=’SAP_B <param n <param n

ue=’GET_ITEM’> ue='Table'> value='MYTABLE'> OVIDER' value='View1 > W_FROM' value='3'> W_TO' value='3'>

OLUMN_HEADER' value=' '>

You can find more in Web item and its functionality under Context Menu Functions [Extern] and Table [Extern].



Chart

ery view to

DefinitionA Web item that obtains data from a qu

Use

create a graphic for a Web application.

The Chart Web item enables you t

Structure

o display da

ributes [Seite

ta graphically in your Web application.

As well as its general att 12], the Chart

Description

Web item has the following specific attributes:

Attributes

Edit Chart: Chart Designer pe

ettings for the chart. See Editing Charts [Extern]

(CUSTOMIZE)

The button with the three dots brings you to the Chart Designer. You can choose the chart tyand make a number of s

.

Suppress Totals

(SUPPRESS_SUMS)

'X' = Yes, ' ' = No

The totals rows/columns of the source data provider are not displayed in the chart. This means that you can suppress totals that may affect the chart display adversely, without having to change the data provider.

Swap Display Axes es in the display without changing the navigational state of the query view itself. (SWITCHMATRIX)

'X' = Yes, ' ' = No

You can swap the chart ax

This has the same effect as swapping the two free characteristics with one another in the initial query view.

Hide Expanded Hierarchy Nodes

DES) (SUPPRESS_OPENHIERARCHIENO

'X' = Yes, ' ' = No

You can remove open nodes when you create charts in active presentation hierarchies. This ensures that the total of the values displayed isthe overall result.

Affected Data Provider s are sent.


List of data providers to which all chart command

Automatic Display of Units and

(AUTOMATIC_LABELS)

Currencies

'X' = Yes, ' ' = No d

y of units

If the units and currencies or other settings in the query are the same, and you select the attribute, these are the units, currencies, ansettings which are displayed automatically on the chart. Alternatively, you can set the displaand currencies manually. See Formatting Axes and Gridlines [Extern] in the section „Inserting or Removing Axes Titles and Units “.



Chart Title (Language-Dependent) Language-dependent text for the title of the

(TITLE) chart.

Language-dependent text for the subtitle of the Chart Subtitle (Language-Dependent)

(SUBTITLE) chart.

Category Axis (X): Title (Language-Dependent)

(TITLE_CATEGORIES)

Language-dependent text for the title of the category axis (X).

Category Axis (X): Unit (Language-Dependent)

(UNIT_CATEGORIES)

Language-decategory axis

pendent text for the unit of the (X).

Primary Value Axis (Y): Title (Language-Dependent)

Language-deprimary value

pendent text for the title of the axis (Y).

(TITLE_VALUES)

Primary V Language-dependent text for the unit of the alue Axis (Y): Unit (Language-t) Dependen

(UNIT_VALUES)

primary value axis (Y).

Secondary Value Axis (Dependent)

Language-dependent text for the title of the secondary value axis (Y).

Y): Title (Language-

ITLE_SEC_VALUES) (T

Secondary Value Axis (Y): Unit (Language-Dependent)

Language-dependent text for the unit of the

(UNIT_SEC_VALUES)

secondary value axis (Y).

Another Axis: Title

(TITLE_SEC_CATEGORIES)

Language-dependent text for the title of another axis. This attribute is only needed for specific chart types such as a histogram or a scatter chart.

Another Axis: Unit

(UNIT_SEC_CATEGORIES)

Language-dependent text for the unit of another axis. This attribute is only needed for specific chart types such as a histogram or a scatter chart.

Ignore Exception in Chart Display

(IGNORE_EXCEPTIONS)

If you activate this attribute no exceptions are displayed in the chart, although the data provider on which it is based has exceptions. See Display of Exceptions for Maps and Charts [Extern].

Automatic Axis Labeling for Simple Charts

(AUTOMATIC_DESCRIPTION)

This attribute enables the system to create labels automatically for the chart axes for very simple charts such as column-, bar, or line diagrams. For example, the name of a key figure appears on the Y axis in a bar chart. For more information, see Automatic Axis Labels for Simple Charts [Extern].

The texts, such as chart title, chart subtitle, as well as title and units of the axes, are all language dependent. You can find additional information under Language-Dependent Texts [Seite 259].



Yo the Web Application Designer for the respective attributes and in the

g for the Heading attribute under General (general attributes):

heading is not a part of the chart.

u can enter the texts both in Chart Designer.

Note the followin

Heading You can enter a heading for the chart. This

Within Chart Designer, you also have the option of specifying a heading. This is not a part of the chart, however.

The heading is displayed only if the attribute Generate Heading is active at the same time.

In addition, Web Applic

you can use the following attribute (pa ch is not available to you in the ation Designer, which, however, can b ing the HTML view of the Web

Attribute

rameter), whie inserted us

template.

Description

Show Data Table

(SHOW_DATATABLE)

If you use this attribute the system shows the data in a table below the chart.

the Chart You can find more information on using Web item and its functions under Context Menu Functions [Extern].



Dropdown Box Definition The Web item Dropdown Box allows you to filter cha in a dropdown box.

Use When you select a value, the assigned query view is filtemethod is used to select a filter value for the characteris value appears in the dropdown box.

Structure As well as its general attributes [Seite

racteristic values from a Web application

red according to this value. If a different tic in the dropdown box, the current filter

12], the Dropdo llowing attributes:

Attributes Descr

wn Box Web item also has the fo

iption

Index in the filter command (INDEX) Must h wn boxes and ra s [Seite

ave a clear value for all dropdodio button group 27] within the

form tag.

This attribute must be changed only if the ONLY_VALUES attribute is active.

Characteristics / structure (IOBJNM) Name of cha re according

racteristic / structuto which you want to filter

Specify the technical name of the characteristic(for example, 0COUNTRY) or the structure (25 characters)

The technical namcharacteristic is stored in the

e of the

query definition. In the BEx toolbar, choose Change Query View → Change Query (Local View) or (Global View) → . The technical names of the InfoObjects are displayed.

Note that the characteristic you have chosen must be included inthe query that the Web

application is based on.



Read mode (BOOKED_VALUES) es Web item as

filter values:

• M: All table.

In somnot ap e currenthe resfilteredHowev st under

ted, whereby the current drilldown status is not fully taken into consideration.

• Q: Only values that are also posted in the Data Provider under the currently valid filter conditions are displayed. It can take a long time under certain circumstances.

Specifies which values in the master data table are copied to the Checkbox

values from the master data

e circumstances values that do pear in the data provider under tht filter conditions and that produce ult No suitable data found when , might also be displayed. er, this process is faste

certain conditions.

• D: Values that are basically pos

Maximum number of values in the dropdown box (MAXVALUES)

(optional)

Contains the maximum number of values that are displayed in the dropdown box.

If this attribute has the value 0, all the available values are written in the dropdown box.

Label (SHOW_LABEL)

'X' = Yes, ' ' = No

Use BW description as label

If this attribute is activated, the long text of the characteristic is written as a label in front of the dropdown box. In addition, you can use the context menu related to the description of the characteristic in this label.

Display values only (ONLY_VALUES)

'X' = Yes, ' ' = No

(optional)

Create dropdown box only

If you activate this attribute, only the HTML form Web item for the value list is created. In this case you have to create the form in which the dropdown box is contained manually.

This attribute is suitable for creating forms [Seite 234] that contain several dropdown boxes.

Do not display entry All values

(NO_REMOVE_FILTER)

'X' = Do not offer “All values”,

' ' = Display entry “All values”

If this field is not blank, the entry All values is not set as a selection option in the radio button group.



Data provider affected

(TAR

Contains a list of all data providers to which the filter commands are sent.

GET_DATA_PROVIDER)

If you filter according to a

providers for the Web item are notified. For further information about this attribute, see General

characteristic and then activate this attribute, the different data

Attributes [Seite 12].

You will find more information on using the Dropdown Web item and its functionality under Dropdown Box, Radio Button Group, Checkboxes, Hierarchical Filter Selection. [Extern]



Radio Button Groups Definition The Radio Button Group Web Item allows you to filtebuttons.

Use When you select a value, the assigned query view is filte t a filter value in another way for the characteristic of the r e current filter value is selected.


r characteristic values in a group of radio

red according to this value. If you selecadio button group, th

12], the Radioattributes:

Attributes Descr

Button Group Web item has the following

iption

Characteristics / structure (IOBJNM) Name ristic / structure by

teristic (for example, 0COUNTRY) or the structure (25 c acters)

of the charactewhich the system is to filter

Specify the technical name of the charac

har

The technical name of the characteristic is stored in the query definition. In the BEx toolbar, choose Change Query View → Change Query (Local View) or (Global View) → . The technical names of the InfoObjects are displayed.

Note that the characteristic you

have chosen must be included inthe query that the Web application is based on.



Read mode (BOOKED_VALUES) Specifies which values in the master data table

.

o ppear in the data provider under the

current filter conditions and that produce the result No suitable data found when filteredHowev certain

• D: Valu sically posted,

so posted in the data provider under the currently valid filter conditions are displayed. It can

are copied to the Checkboxes Web item as filter values:

• M: All values from the master data table

In some circumstances values that dnot a

, might also be displayed. er, this process is fastest under conditions.

es that are bawhereby the current drilldown status is not fully taken into consideration.

• Q: Only values that are al

take a long time under certain circumstances.

Maximum number of displayed values Contains the maximum number of values that (MAXVALUES)

(optional)

are displayed in the radio button group.

If you set the value to 0, all the available values in the radio button group are displayed.

Label (SHOW_LABEL)

'X' = Yes, ' ' = No

Use BW des

If this attribut ng text of the the

e context menu related to the description of the characteristic in this label.

cription as label

e is activated, the locharacteristic is written as a label in front of radio button group. In addition, you can use th

Entries next to one another (HORIZONTAL_ALIGNMENT)

'X' = Yes, ' ' = No

If this attribute is activated, the different characteristic values are grouped vertically. If this attribute is deactivated, the characteristic values are grouped horizontally.

Number of entries next to one another/below one another (HORIZONTAL_NUMBER)

Contains the number of entries listed next to one another or below one another, depending on the attribute settings for HORIZONTAL_ALIGNMENT.



Display values only (ONLY_VALUES)

‘X’ =

Create radio button group only

If you activate this attribute, only the HTML form Web item for the radio button group is created. Here you have to create the form, in which the radio button group is contained,

Yes, ‘ ’ = No

manually.

This attribute is suitable for creating forms [Seite 234] that contain several radio button groups.

Do not display entry All values If this field is not blank, the entry All values

(NO_REMOVE_FILTER)

ay entry “All values”

is not set as a selection option in the radio button group.

'X' = Do not offer “All values”,

' ' = Displ

Affected data provider


List of data provbutton command

iders to which all selection s are sent.

Index in the filter command (INDEX)

(optional)

Must have a uniboxes and radio

que value for all dropdown button groups [Seite 27] within

the form tag.

Thonlattr

is attribute must be changed y if the ONLY_VALUES ibute is active.

You will find more information on usi p We ctionality under Dropdown Box, Radio Butt chica l

ng the Radio button-grou b item and its funon Group, Checkboxes, Hierar l Fi ter Selection [Extern].



Checkboxes Definition Checkboxes is a Web item that places characteristic values to be filtecheckboxes.

Web item can be used to easily filter a connected ording to a tic.

move filter values in the Web application by settin

ture ral attributes [S

red in a group of

Use The Checkboxes query view accparticular characteris

You can set or re g the indicators.

StrucAs well as its gene eite 12], the Checkboxes Web ite

Attribute Values

m has the following attributes:

Description

Characteristic/structure

(IOBJNM)

Selection list Select the technical name of the characteristic.

Characteristics and structures rs.

cteristic values are are read from data provideThe charaprovided in a dropdown box in the Web application as filter values.

Read mode

(BOOKED_VALUES)

• Master data table (M)

• Dimension table (D)

• )

Standard setting “Dimension table”

ied

b item

the current filter conditions and that produce the result No suitable data found when filtered, might also be displayed. However, this process is fastest under certain conditions.

• D: Values that are basically posted, whereby the current drilldown status is not fully taken into consideration.

Posted values (Q

Specifies which values in themaster data table are copto the Checkboxes Weas filter values:

• M: All values from the master data table.

In some circumstances values that do not appear in the data provider under



• Q: Only values that are also posted in the data provider under the currently valid filter conditions are displayed. This can take a long time in some instances.

Maximum number

ALUES)

Default value: “0” Maximum number of displayed filter values If "0", all values are displayed. (MAXV

Maximum length

(MAXLENGTH)

Maximum number of characters in the label.

Label ‘X’ = Yes, ‘ ’ = No If this attribute is

(SHOW_LABEL) Default setting: ‘X’ = Yes

activated, the long text of the characteristic is written as a label in front of the control box.

Affected data provider Selection list List of data providers to whi


ch all checkbox commands are sent.

Entries next to one another ENT)

‘X’ = Yes, ‘ ’ = N

Default setting: ‘ the

(HORIZONTAL_ALIGNM

o

‘ = No

Order entries next to one another

If this attribute is activated,different characteristic values are grouped vertically. If this attribute is deactivated, the characteristic values are grouped horizontally.

Number of entries next to/under one another (HORIZONTAL_NUMBER)

Default value: 1 entries

another, depending r

Contains the number oflisted next to one another or below oneon the attribute settings foHORIZONTAL_ALIGNMENT.

You will find more information on using the Checkboxes r Dropdown Box, Radio Button Group, Checkboxes, H a

Web item and its functionality undeier rchical Filter Selection. [Extern]



Generic Navigation Block

ata from a query view tontains keys that you can xample, into

Definition A Web item that obtains dapplication. This block co

create a generic navigation block for a Web use to transfer characteristics, for e

rows or columns.

Use The Web item (Genethe Web application

ric Navigation Block) disp tate of a query view in in the form of a table. All characteristics and structures in the query view are

heir filter values are displayr characteristics a

single val

l Attributes [Seite

lays the navigational s

listed in the table and t ed. You can change the navigational status of nd structures to an axis (rows or columns) or ues and remove the filter again.

the query view. You can transfefrom an axis. You can filter according to

Structure As well as its Genera 12], the Generic Navigation Block Web item has the following attributes:


Read mode

(BOOKED_VALUES)

(BOOKED_VALUES_N)

“Master data table” that do e

e

r

status is not fully taken into consideration.

• Q: Only values that are also posted in the davalid filter conditions are displayed. It can take a circum

Read mode f

es” read mode may be slow.

“Dimension table”

“Posted values”

This attribute specifies which values in the master data table are copied to the Checkboxes Web item as filter values:

• M: All values from the master data table.

In some circumstances valuesnot appear in the data provider under thcurrent filter conditions and that producthe result No suitable data found when filtered, might also be displayed. However, this process is fastest undecertain conditions.

• D: Values that are basically posted, whereby the current drilldown

ta provider under the currently

long time under certain stances.

or filter items

The “master data” read mode may lead to many unposted values being displayed; the “posted valu

Grouping axes

(SHOW_AXES_GROUPING)

‘X’ = Yes, ‘ ’ = No

If you set the indicator for this attribute, free

the columns will be displayed in groups.

characteristics, characteristics in the rows and the characteristics in



Characteristics of the rows collapsed

) ollapsed in the grouped display. (ROWS_CLOSED

‘X’ = Yes, ‘ ’ = No

If you set the indicator for this attribute, the characteristics for the rows are displayed c

Characteristics of the columns collapsed

) collapsed in the grouped display. (COLUMNS_CLOSED

‘X’ = Yes, ‘ ’ = No

If you set the indicator for this attribute, the characteristics for the columns are displayed

Free characteristics collapsed

) collapsed in the grouped display. (FREE_CHARACTERISTICS_CLOSED

‘X’ = Yes, ‘ ’ = No

If you set the indicator for this attribute, the free characteristics will be displayed

Display empty filter

(SHOW_EMPTY_SLICER) 'X' = Yes, ' ' = No

If you set the indicator for this attribute, the empty filters will be displayed in the grouped display.

Delimitation between the characteristics ibute, the haracteristics in the non-grouped display are eparated from one another. (SHOW_MARGIN)

‘X’ = Yes, ‘ ’ = No

If you set the indicator for this attrcs

Order entries next to one another TAL_ALIGNMENT)

‘X’ = Yes, ‘ ’ = No

w o

one another. In many cases, this makes better use of the display area and there is a stronger visual link betthe navigatio

(HORIZONAs well as arranging the characteristics beloone another, you can also display them next t

ween, for example, the table and n block.

Entries next to one another (HORIZONTAL_NUMBER)

Default value: 3

Describes the characteristic one another. ation block contains

and the

maximum number ofs that can be displayed next toIf the navig

more than the specified number of characteristics, then it is automatically displayed in more than one row, where the number of characteristics per row is optimized regarding the equal distribution of rowsrequired number of characteristics.

This attribute is only included when HORITONTAL_ALIGNMENT (Define entries next to one another) is activated.

Maximum filter value length NGTH)

Default value: 80

r of characters, (FILTER_VALUE_LE

You specify the numbeaccording to which filter value is indicated, by<Number>.

If you set the value to 0, then the complete filter value is displayed.



Display characteristics of the row

(SHOW_ROWS)

s

’ = No ‘X’ = Yes, ‘

If you set the indicator for this attribute, the characteristics of the rows are displayed.

Display characteristics of the columns

(SHOW_COL

‘X’ = Yes, ‘ ’

If you set the indicator for this attribute, the characteristic ayed. UMNS)

= No

s of the columns are displ

Display free If you set the attribute, the free characteristics

(SHOW_FREE_CHARACTERISTICS)

‘X’ = Yes, ‘ ’ = No

characteristics are displayed. indicator for this

Displaying navigation icons

(SHOW_NAVIGATION_ICONS)

If you set the indicator for this attribute, the icons for navigation are displayed.

Display filter icons

(SHOW_FILTER_ICONS)

‘X’ = Yes, ‘ ’ = No

If you set the indicator for this attribute, the icons for filtering are displayed.

Frame name for input help (TARGET_HELP_FRAME)

(optional)

You can display input help in a different frame from the data. If you activate this attribute, input help is displayed in the same window.

This parameter is not offered in the Web Application Designer and can only be used for parameterization in the Web template.

List of characteristics with read mode

(IOBJNM_LIST)

This attribute contains a list of characteristics with read mode. You can select a characteristic of a structure and activate the read mode for it.



This attribute contains a list of all data providers to which the navigation block is sent.

If you filter according to a characteristic and then activate this attribute, the different data providers for the Web item are notified. For further information about this attribute, see General Attributes [Seite 12].

Table interface class

(MODIFY_CLASS)

Table interface class By using the Web design API for tables, you can adjust the cell content individually in the navigation block. See also:

Web Design API for Tables [Seite 277]



List of navigation block entries (ITEM

(optio

_NAV_BLOCK_IOBJNM_N)

nal)

In the WAD, this attribute is displayed using the List of Characteristics with Read Mode attribute (IOBJNM_LIST).

Listing the names of characteristics and ures enables you to determine which s appear in the navigation block, and in

which order.

structentrie

If you do not specify this parameter, all characteristics and structures in the navigation block are displayed.

You can find more information on using the Generic navigation block Web item and its functions avigation Block [Extern]under Generic N .



Hierarchical Filter Selection

Web item

Definition that creates a hierarchical filter selection from the hie

structure. The hierarchy nodes appear as menu entries and can be

Use ierarchical filter select query view by

utes [Seite

rarchy of a characteristic or set as a filter.

Using the h ion you can filter a hierarchy nodes.

Structure As well as its general attrib 12], the Web item Hierarchic

Values ption

al Filter Selection has the

Descri

following attributes:

Attribute Reload lev(D

el dynamically YNAMIC)

‘X’ = Yes, ‘ ’ = No Default setting: ‘X’ = Yes

Reload from levels underneath the start level.

If this attribute is set, the levels below the start level are reloaded dynamically, if required. Otherwise, they are not offered.

Characteristic/structure

(IOBJNM)

Selection list Select the technical name of the characteristic/structure.

The hierarchy and structure nodes are read from the data provider and can be used as filter values in the selection.

Hierarchy name

(HIERARCHY_NAME)

Selection list Technical name of the hierarchy which should be used for filtering nodes. If the field is blank, the system uses the hierarchy that is currently set.

Version

(HIERARCHY_VERSION)

Selection list Version of the hierarchy that should be used for filtering nodes. If the field is blank, the current version of the presentation hierarchy is used.

Key Date

(DATE)

Key date for which the hierarchy is evaluated.

The hierarchy is used as it existed on the given date. If this field is blank, the key date of the query is used.



You can remove the key date using the Delete Date pushbutton.

Label

(SHOW_LABEL)

‘X’ = Yes, ‘ ’ = No Default setting: ‘X’ = Yes

Display the description for thcharacteristic.

e

This attribute allows you to either show or hide the display of the characteristic description.

Drill level

)

Default value: “3” Maximum drill level of the filter selection (blank= drill level corresponding to query

(DRILL_LEVEL

definition)


VIDER

List of data providers to which

(TARGET_DATA_PRO)

all hierarchy commands are sent.



Filters Definition A filter is a W ues resulting from navigation for a query view in the Web app

Use he Web item

eb item that displays the filter vallication.

T Filter displays the filter values that have beenquery view in a Web application. You also use filters to select in ues.

As well as its eneral attributes [Seite

generated by navigating in a dividual val

Structure g 12], the Filter Web item has the following attributes:


Display Filte

PRESENTATIO (o

PRESENTATIO N

'KEY' = key

'TEXT' = Descri io

'KEY_TEXT' = K

'TEXT_KEY' = Description and key

The filter value is displayed in accordance with specified for an

0 display (no index) is used.

r Values

N ptional)

N_ (optional)

prt n

ey and description

the setting. If no display is index, the index

If this parathe lay, which icharacteristic, is used

meter is not specified, disp s valid for the

.

List of chara

(ITEM_LIST)

List of characteristics with display cteristics

Maximum fil(FILTER_VA

Default value

of characters, r value is indicated, by

ter value length LUE_LENGTH)

You specify the number according to which a filte“...”. : 0

If y(deis

ou keep the value as 0 fault), the complete filter value

displayed.

Only display va

(ONLY_VALUES)

"X" = Yes, " " = No

thout any labeling, and separated using semi-colons.

lues When you activate this attribute, the filter values are displayed withe formatting is



List characteristics and structures (ITEM_FILTER_IOBJNM_N)

(optional)

This attribute is displayed in the Web Application Designer in the attribute list of the characteristic (ITEM_LIST).

Listing the names of characteristics and structures enables you to determine which entries appear in the filter and in which order. Only those entries for which a filter value exists are displayed. The remaining entries are skipped over.

If you do not specify this parameter, all the characteristics and structures that are filtered are displayed.

If you combine ONLY_VALUES=X and ITEM_FILTER_IOBJNM=MyInfoObject, it is possible to identify a single filter value in the Web template. This is also useful in headers, for example.

Displaying filter values for the characteristic Calendar year without formatting

<object>

<param name=’OWNER’ value=’SAP_BW’> <param name=’CMD’ value=’GET_ITEM’> <param name=’ITEM’ value=’Filter’> <param name='ITEM_ID' value='FILTER'> <param name='DATA_PROVIDER' value='View1 > <param name=’ONLY_VALUES’ value=’X’> <param name=’ITEM_FILTER_IOBJNM’ value=’0CALYEAR’> ITEM :Filter

</object>

Input field for filtering according to Calendar year with preassigned dynamic filters (only works with 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=’OWNER’ value=’SAP_BW’> <param name=’CMD’ value=’GET_ITEM’> <param name=’ITEM’ value=’Filter’> <param name='ITEM_ID' value='FILTER'> <param name='DATA_PROVIDER' value='View1 > <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>





LabDefinitionThe

el

Web item Label allows you to display the descriptions of characterismponents. You can also create a link to the context menu of these cha

tics, attributes, or structural co racteristics, attri

UsThis

butes, or structural components.

e Web item, together with the Web items Dropdown-Box [Seite 24] and Radio Button-Group

[Seite 27], can be used for configuring a comfortable cockpit. You can create navigation blocks by putting differe

StrAs well

nt labels for characteristics and structural components into a table.

ucture as its general attributes [Seite 12], the Label Web item has the following attributes:

Attribute Description

Context menu (CONTEXT_MENU) If this attribute is activated, a link to the conte

'X' = Yes, ' ' = No

xt menu of the characteristic or the structural component is displayed in the description of the characteristic.

Characteristics / structure (IOBJNM) Name of the characteristic/structure

Specify the technical name of the characteristic (for example, 0COUNTRY) or the structure (25 characters)

The technical name of the characteristic is stored in the query definition. In the BEx toolbar, choose Change Query View → Change Query (Local View) or (Global View) →

. The technical names of the characteristics are displayed.

Structural component (STRUCTURE_MEMBER)

Structural component whose text or context menu is displayed.

Attribute name (ATTRINM) Technical name of the attribute whose header is to be displayed as a label.

Only display values

(ONLY_VALUES)

'X' = Yes, ' ' = No

Unformatted display

Only the link to the context menu is generated.

If this attribute is activated, only the link to the context menu is displayed. The label is displayed without formatting. You can determine in the Web template how you would like to put the link underneath.



If you would like to add a label for a structural component in your Web application,

n you have to enter the technical name of the structure under InfoObject and ter the filter value of the structure under Structural Component

ollows:

Execute a Web application that contains the structural component.

Filter according to the structural component in question: Choose Keep as filter value in

the attribute in the Web Application Designer and enter the value that was saved

ural component from the Web item Label in the Web nd enter the value that was saved in the clipboard.

You n el Web item and its functionality under Context

theen(STRUCTURE_MEMBER). The correct values are determined as f

a.

b. the context menu of the structural component.

c. Copy the parameter value FILTER_IOBJNM from the URL into the clipboard.

d. Choosein the clipboard.

e. Copy the parameter value FILTER_VALUE from the URL into the clipboard.

f. Choose the attribute StructApplication Designer a

g. Save your entries.

ca find more information on using the LabMenu Functions [Extern].



Text Elements Definition Web item that displays the text elements for a que

Use The Web item

ry view in a Web application.

Text Element provides informattherefore the Web application, is based. You can al ually.

Structure The text elements are similar to the text elements of the following parts:

− technical name of the query (REPTNAME

− description of the query (REPTXTLG)

− InfoP

− key d

− valid LUPTIME)

− the p UTHOR)

− the last time the que e and time) (MODTIME)

− the last person to make changes to the query (MODUSER)

t time the query was refreshed (dat

• Variables

l attributes [Seite

ion on the query, on which the query view, and so select text elements individ

in the BEx Analyzer and are made up

• general text elements:

)

rovider (INFOCUBE)

ate for the query (SRDATE)

ity of the data (date and time) (ROL

erson who wrote the query (A

ry was changed (dat

− current user (SYUSER)

− the las e and time) (SYUZEIT)

• static filter values

As well as its genera 12], the Text Elements Web item has the following attributes:


Display general text elements (SHOW_COMMON_ELEMENTS)

If you activate this attribute, the commonelements are displayed.

‘X’ = Yes, ‘ ’ = No

text

Display stat(SHOW_FILT

‘X’ = Yes, ‘ ’

lues that you determined in the filter area of the query definition are displayed.

ic filter values ERS)

If you activate this attribute, the filter va

= No

Display variable va(SHOW_VARIABLE

‘X’ = Yes, ‘ ’ = No

his attribute, the variable values on which the Web application is

are displayed.

lues S)

If you activate tfor the query (based)



List of text elemen

e to text items

sponds to

nder General Text Items). With variables the name corresponds to the variable name, and with filters the name corresponds to the name of the characteristic.

ts (ELEMENT_NAME_N) By listing the text element names in combination with their type ELEMENT_TYPE_N, you are abldetermine which entries appear asand the order in which they appear. Withgeneral text elements the name correone of the values listed above (u

If you do not specify this parameter, all the filtered characteristics and filtered structures are displayed.

List of the types of text elements (ELEMENT_TYPE_N)

Both attributes, List of Text Elements (ELEMENT_NAME_N) and List of Text Element Types (ELEMENT_TYPE_N), are addressed in the Web Application Designer in the Element List (ITEM_LIST) attribute that lies below.

See above: List of Text Elements

COMMON = General text element

FILTER = Static filter value

VARIABLE = Variable value

VARIABLE_KEY = Key for variable value

List of elements

(ITEM_LIST)

This attribute contains a list of text elements with type and name. You can choose the type of text element from the list or enter the name of the item manually.

Only display values

(ONLY_VALUES)

‘X’ = Yes, ‘ ’ = No

If you activate this attribute, the values for the text elements are displayed without any labeling, and the formatting is separated by semi-colons.

The combination of ONLY_VALUES=X, ITEM_TYPE =COMMON, and ITEM_NAME=REPTXTLG, makes it possible to access a text element directly in the Web template, here for example, the query name. The name is used in a title, for example.

Display of validity of data, filter value for cost center and values for 2 variables

<object>

<param name='OWNER' value='SAP_BW'> <param name='CMD' value='GET_ITEM'> <param name='ITEM' value='Text'> <param name='ITEM_CLASS' value='CL_RSR_WWW_TEXT_ELEMENTS'> <param name='ELEMENT_TYPE_1' value='COMMON'>



<param name='ELEMENT_NAME_1' value='ROLLUPTIME'> NT_TYPE_2' value='FILTER'>

MENT_NAME_2' value='0COSTCENTER'> MENT_TYPE_3' value='VARIABLE'>

<param name='ELEMENT_NAME_3' value='myFirstVariable'> <param name='ELEMENT_TYPE_4' value='VARIABLE'>

ame='DATA_PROVIDER' value='MyDataProvider'>

ITEM :Text

<param name='ELEME<param name='ELE<param name='ELE

<param name='ELEMENT_NAME_4' value='mySecondVariable'> <param n

</object>



List of Exceptions

tatus (active/not active) for a stored query

Definition A Web item that lists the existing exceptions and their sview in the Web application.

Use The List of Exceptions Web item displays the status of the exceptions for a stored query viein the Web application, in the form of a table. For each exception, the status of the exception (active/not active) is also displayed. You can activate or deactivate the exceptions by clickinthe

w

g on symbol.

ist of Exceptions has only general attributes.

tributes [Seite

Structure The Web item L

See General At 12]

You can find more information on using exceptions under Exception Reporting [Extern].

sing the List of Exceptions Web item and its functions under ontext Menu Functions [Extern]

You can find more information on uC and List of Exceptions [Extern].



List of Conditions Definition A Web item that displays all of the existing conditions and their status (active/not applicable/not used) for a stored query view in the Web application.

Use The List of Conditions Web item displays the status of conditions for a stored query view in tWeb application, in the form of a table. All of the conditions that can be applied to the current navigation status for the query view are listed. The status of the condition is d

he

isplayed for every condition (active/not applicable/not used). You use the symbol to activate/deactivate the conditions.

You can find additional information on navigation options in the list of conditions under List of Conditions [Extern].

Structureist of Conditions only has general attributes. The Web item L

See General Attributes [Seite 12].

Also see:

You can find additional information about the scope of functions of conditions under Conditions [Extern].

sab under itions [Extern]

You can find additional information about the u ility and status descriptions of conditions Using Cond .

formation on using the List ofList of Conditions [Extern]You can find more in Conditions Web item and its functions under

.



Alert Monitor Definition A Web item that the query views display as a list o ery

ring background processing br a hierarchy in a Web application. These quy the views were found du Reporting Agent [Extern].

Use With the help of the Alert Monitor Web item, yo

g [Extern]u can go to the query views generated in the

Exception Reportin and Reporting Agen iceable, deviating key figures from defined threshold value

t processes and see at a glance any nots. You can also set filters.

Since there is only one data source for the Alert Mthe Alert Monitor Web item as a separate data pr generates a suitable data provider for itself and tradata provider automatically.

Structure In addition to its general attributes [Seite

onitor, there is no need to set up ovider. The Alert Monitor Web itemnsfers the filter operations to this

12], the Alert Monitor Wattributes:


eb item has the following

Query (FILTER_QUERY) You can use bute to filter according to you

this attrientries that come under a specific query. Ifdo not specify a query, no filter applies.

Display minimal view list (MINIMAL_VIEW)

(optional)

'X' = Yes, ' ' = No

When you go to the detail view, only the key figure columns are displayed for which exceptions can arise.

If you do not specify the parameter, the key figures are shown as scheduled.

InfoCube (FILTER_INFOCUBE) g to e. If

an InfoCube, no filter applies.

You can use this attribute to filter accordinentries that come under a specific InfoCubyou do not specify

InfoArea (FILTER_INFOAREA) You can use this attribute to filter according to entries that come under a specific InfoArea. If you do not specify an InfoArea, no filter applies.

Red entries (FILTER_RED)

"X" = Yes, " " = No

If you activate this attribute, you see the rows with at least one red entry.

Yellow entries (FILTER_YELLOW)

"X" = Yes, " " = No

If you activate this attribute, you see the rows with at least one yellow entry.

Green entries (FILTER_GREEN)

"X" = Yes, " " = No

If you activate this attribute, you see the rows with at least one green entry.



Do not display number of alerts )

"X" = Yes, " " = No

e (SUPPRESS_NUMBERS

You can use this attribute to determine that thnumber of alerts not be displayed in the alert monitor. Only the current alert symbol is shown.

Display highest alert level (DISPLAY_MAX_LEVEL)

"X" = Yes, " " = No

In a and green entrie r each query vie entry with the hi e display easi

ste d of displaying red, yellow,s with their frequency fo

w, you can display just the ghest alert level. This may make th

er to study.

Number of rows in table (BLOCK_SIZE)

Default value: 10

Numb table.

With the help e, you can de entries you want to

er of rows displayed at once in the

of this attributtermine the number of

display at the same time.

We recommend that you restrict the number of entries, especialwhen the number of alerts is high

ly .

If you set the entries are di

value to 0, all splayed.

ore rows with alerts, If there are man index is added for you to scroll down.

Display as hierarchy (HIERARCHY)

"X" = Yes, " " = No

If y e diof o d going up dedisplayed aquIn r

ou activate this attribute, the alerts arsplayed in a hierarchy, starting with the level Inf Area, InfoProvider, and query, an to the individual query views. If you activate this attribute, the alerts are

s a flat list. This means only the ery views are displayed (no InfoAreas,

foP oviders, or queries).

Template for display

(TARGET_TEMPLATE_ID)

(optional)

W t e detail view display is ba

eb emplate upon which thsed.



List display

(LIST_FOCUS_LEVEL)

This setting only affects the non-hierarchical display. You can set the criteria accowhich alerts are to be displayed. You cchoose from the following types:

• VIE

rding to an

n.

W: Navigational state

• CELL: Individual Cells

• EXCEPTIONS: Exceptions

• INFOAREA: InfoArea

• InfoCube: INFOCUBE

• QUERY: Query

Only lines of this type are displayed according to the selectio

List of columns with labels

(COLUMN_LIST)

ou

pes are available:

• TEXT: Text

dual cells

• DOCUMENT: Document display

• MAX_LEVEL: Display greatest alert level

• RED: Number of red exceptions

• YELLOW: Number of yellow exceptions

• GREEN: Number of green exceptions

• DATE: Creation date

• TIME: Creation time

In the Reporting Agent you can make a setting so that the alert monitor entries are given a URL. To do this you need to maintain an entry in the Action (ACTION) column here. You can find more information under Editing Follow-Up

You can structure the columns however ywant and display headers for the individual columns. Under Column Name, choose the type of column and enter the desired column heading for each.

The following column ty

• ACTION: Action

• VALUE: Value with indivi

Actions: Alert Monitor Entry [Extern].

This attribute compounds the attributes COLUMN_NAME and COLUMN_CAPTION.

Display column captions

(DISPLAY_COLUMN_CAPTION)

'X' = Yes, ' ' = No

If you do not activate this attribute, then the column headings are not displayed.



Displa

(DI

o

If this attribute is specified, then the user can control the attributes FILTER_RED, FILTER_YELLOW, FILTER_GREEN, HIERARCHY, and LIST_FOCUS_LEVEL using a toolbar.

y toolbar

SPLAY_TOOLBAR)

'X' = Yes, ' ' = N

Displ Data Provider The detail view for an entry can alay

OVIDER)

so be displayed in the same Web template. To do this, the logical name of the DataProvider to be

the Alert Monitor entry automatically.

(DISPLAY_DATA_PR

(optional)

'X' = Yes, ' ' = No

used for the display must be specified. The Web items that retrieve your data from this DataProvider display the detail view for

In addition, you can use the following attribute, which is not available to you in the Web Application Designer, which, however, can be inserted using the HTML view of the Web template.


Detail frame (TARGET_FRAME) Name of the frame for the detail view

If you do not specify a detail frame, the detail view is displayed using pure HTML in the same window and opens a separate window using activated Java Script.

The parameters JUMP_supported. Howeve

WBID and JUMP_PAGEID used in Br, we recommend that you no longer use these.

W 2.x are still



Role Menu Definition The Role Menu Web item displays user favori

Prerequisites You have maintained roles and assigned them to tUsers and Roles (BC-SEC-USR) [Extern]

tes and/or roles in a tree.

he users. You can find more information under and under Setting Up Authorizations with Role

Maintenance [Extern].

Use You can restrict the role menu to user favorites and roles or to aare shown if the user is not assigned to this particular role. You ntries

gories. A menu entry is a le. TARGET to define in wh

tructure As well as its general attributes [Seite

particular role. No menu entries can filter the menu e

according to various cateYou can use the attribute

URL in a BEx Web application, for exampich window the URL is executed.

S12], the Rol the following attributes: e Menu Web item has


List of Roles

(ROLE_1, ROLE_2, ROLE_...)

• Restriction to favorites and/or specific roles

• If no entry is made, the assigned roles and favorites of the user are displayed.

an be displayed with

y individual roles within a

b

• The favorites cROLE=SAP_BW_FAVORITES_ (with two ‘_’ between SAP_BW and FAVORITES_). Do so by selecting theentry Own Favorites from the list.

• If you want to restrict the display to specific roles, choose these roles from the list.

• You can also use multiple selection ofroles to displacollective role using the Role Menu Weitem. However, the collective roles arenot available as F4 help.

Number of levels.

(LEVEL)

‘0’ = all levels

ally loaded with the specified levels. Further levels are read dynamically by expanding folders. All levels are read for LEVEL=0.

Number of levels that are initially read.

The role menu is initi



Filters

(FILTER)

Filter menu entries according to type

You can filter according to the following types or type combinations.

• 'U' = URLs

• 'P ' = Web templates

• ‘Y’ = Queries

• 'R ' = Crystal Reports

n a All entries for these types are displayed whefilter is not specified.

For examall URLs

ple, the filter ‘UP’ shows and Web templates with

reference to ROLE.

Name of Target Frame

(TARGET)

Name of the frame for executing menu entries.

The URL is executed in the specified frame behind a menu entry.

Scroll Bar Display

(SCROLL_STYLE)

“Auto” = Automatic (when needed)

ways displayed

o” = Scrollbars never displayed

tly on nts (Auto) or independently

of the size, either always (Yes) or never (No). “Yes” = Scrollbar al

“N

Scrollbar display

Scrollbars are displayed either dependenthe size of the conte



Displa

(IF

o

Display as IFrame

You can display the Role Menu Web item in an Iframe (a frame imbedded in HTML) or in a frameset. On the one hand, the combination

ole Menu Web n the other

hand, Netscape 4.7 and PDAs do not support IFrames. Only the Role Menu Web item is

ameset. The other Web

The advantage of IFrames is that they allow

s. The role menu in the frame nd cannot be

y with IFrame

RAME)

'X' = Yes, ' ' = N

from other Web items with the Ritem is possible for an IFrame. O

displayed for the Fritems are ignored.

you to structure the HTML page for the role menu freely, for example, with text, logos, or other Web itemset is created generically achanged externally.

If a role menu is called IFrame on Netscape 4.

up with 7 or on a

is automatically sent to PDA, the IFrame is ignored and a frameset the Web browser.

Display with Frame around IFrame ing the frame around the IFrame

A frame border is displayed around the IFrame. The proposed value is ‘ ‘ = No.

(IFRAME_STYLE)

‘X’ = Yes, ‘ ’ = No

Display

User and logo display

)

User and logo display

Above the role menu, the user name is displayed along with a logo.

(DISPLAY_USER

'X' = Yes, ' ' = No

Logo Icon Path

(ICON_LOGO)

Path of the logo icon

The path of the icon in the MIME repository that is displayed as a logo. You can only use this attribute in the context of DISPLAY_USER. For example: ‘Bex/Icons/s_logo.gif’

Logo Height in Dots Logo height in dots

You can use this attribute to individually adjust the height of your logo. It particularly makes sense to set this attribute when you have specified your own logo using the attribute Logo Icon Path (ICON_LOGO), and where the height of this logo does not match the default SAP logo height.

(HEIGHT_LOGO)

Hierarchy display with colors

(HIERARCHY_COLOR)

‘X’ = Yes, ‘ ’ = No

Each hierarchy level is displayed with a different color.



First lev t displayed

(HI LEVEL)

The entries in the second hierarchy level are displayed.

el no

DE_FIRST_

‘X’ = Yes, ‘ ’ = No

Display with icons

(DIFF_ICONS)

‘X’ = Yes, ‘ ’ = No

The entries in the role menu are each giveappropriate icon, regardless of the type.

n an



Ticker Definition The Web item Ticker enables you to display the content of a table as a ticker.

Use To use the ticker, you need a Web browser that enables JavaScript.

Structure As well as its general attributes [Seite 12], the Role Menu Web item has the following attributes:


Create invisible form

(ONLY_VALUES)

‘X’ = Yes, ‘ ’ = No

Create invisible form.

You can create an invisible form so that you can further process the ticker text.

Separator (SEPARATOR)

Separator between two ticker rows.

Separators are added when the data for a new data row is displayed.

Speed

Def

ime in milliseconds until the ticker moves in milliseconds. T

(SPEED)

ault value: 200

again.

Width

(TICK

of the ticket text in characters

ER_SIZE)

Width of the ticket text in characters.

Default value: 60

Pla

(US

‘X’ = Y

ing: ‘X’ = Yes

ce title at start of ticker text

E_CAPTION)

Place title at start of ticker text.

es, ‘ ’ = No

Default sett

Delay in milliseconds

(DELAY)

Default value: 3000

Delay in milliseconds until the ticker starts run.



Maps Purpose Many characteristics in the Busiregion, and country, contain importa

ness Information Warehouse, for example, customer, sales nt geographical characteristics. The geographical information

ated in a map together with the business-orientated, relevant key figures.

distributions. You can clearly display rts for a country, a region, or a city.

can be evalu

Use maps to visualize business-oriented connections andspecific key figures as color shading, pie charts, or bar cha

You h view osales the po at a glance.

ave the option to change the view of a map in which you either zoom in to display a detailedr zoom out for an overall view. In this way, it becomes easier to view, for example, the analysis of a specific product that refers to a specific region or a country You can recognizetential or dangers of a market all

Integration Maps help you with reporting geo elevant data. By using the map Web item, you determine a

hical display in the BEx W Designer for your plication.

nt InfoObjects are sto Metadata Repository. The master is equip ributes. Assigning

riented data (mapping external toontal Systems Researc

re and evaluate dat graphical naturen, and coun -releva

n a map. Using enhanced navigation o cal drilld

-rgeograpWeb ap

eb Application business-oriented data for the

Geo-releva red and maintained in the data for geo-InfoObjects ped with geo-att the range of geographic to

l: ArcView from ESRI business-o(Environme

/geocoding) using anh Institute).

Features With maps you prepacustomer, sales regio

a of a geo (characteristics such as nt data is displayed graphically own”), regional information can

try, for example). The geoptions (“geographio



be evaluated more easily at different levels of detail. A map shows the spatial proximity of places and regions, allowing geographical connections to be more clearly represented.

The following graphic illustrates the g tion of data run by the system:

Process Flow eographic evalua

Business Explorer

BW Server

Administrator Workbench

Staging EngineS etaging Engin

BAPIBAPI

InfoCubesMaster DatInfoCubesInfoCubes

Master DataMaster Data

An

a

alyzerAn

G

alyzer

rid Data Grid Data Map DataMap Data

APIAPI

OLAP ProcessorOL P

Br

AP rocessor

owserBrowser

Meta Datay

Meta DataRepositorRepository

GeoCoding

GISInfoObject

GeoCoordinates

InfoObject maintenance, flag the geo-relevant characteou want to use as geo-characteristics.

. You load the corresponding shapefiles [Extern]

...

1. In the ristics (country, for example) that y

2 into the BW sysassignment of shape file and master data (mapping between gefile). See SAPBWKEY Maintenance for Static Geo-Characteristi

tem. You maintain the o-characteristic and shape cs [Extern]

s to report on geo-characteristics t plant, sales office, for example) you have to

See Geocoding [Extern]

If you want to use the map hat show information in point geocode these characteristics. form (customer,

.

Designer u map in yoururce and a previo query. By us

determine the map display and th a.

Finally, you publish the application on the Web. You navigate rt further o-relevant data.

dditional Cartographic Information [Extern]

3. In the BEx Web Application yo include a Web application and connect ing these attributes, you

in the map to repo

these with a data so usly-definede business-oriented dat

on the ge

See also:

A

Displaying Additional Cartographic Information [Extern]



Map Attributes Definition The Map Web item consists of the objects Map and Map Layer. They are used tobusiness data geographically.

Use You use the Map object to define a map’s basic display.

The Map Layer object is used to define the different map layers. Map layers are cwhich you construct a map.

Attributes control how a map and its layers are displayed in the Web

You can find information about layer attributes under Attributes for M

display

omponents, with

application.

ap Layers [Seite 63].

The following section describes the attributes for the Map object.

Structure The Map object has two kinds of attributes, as do all Web items: ...

1. General attributes that are fundamental to all display types.

The general attributes for the Map object are the same as the general attributes [Seite 12] al attributes. In the Web e Properties window, on the

for all Web items. The Map object has a few additional generApplication Designer, you can find the general attributes in thWeb Item → General tab page.

2. Special attributes which are particular to the individual Web it

In the Web Application Designer, you can find the special attr s e Web Item → Speci ta

ttribute Values Description

em.

ibutes in the Propertiewindow, on th al b page.

General Attributes

A

Caption (CAPTION) Title of the map

Generate caption

(GENERATE_CAPTION)

• ‘X’ = Yes

• ‘ ’ = No

Default setting ‘X’ =

Setting the indicatoa for the map in accordance with "SAPBEXTableCaption". Yes

r utomatically generates a title

Width

(WIDTH)

Entry in

Default t

Wi

pixels

set ing “300”

idth of the map and legend n pixels

Height of map in pixels

(HEIGHT)

Entry in pixe

Default setting “300

Ht i

ls

”

eight of the map in pixels aking geographical relationnto consideration

Calculate map height automatically

‘ ’ = No

Default t s

Ignores the height set manually (map height attribute) ah(IGNORE_HEIGHT)

• ‘X’ = Yes

•

set ing ‘X’ = Yend calculates the

eight automatically using the



hueight/width relationship in the nderlying map.

Border style (BORDER_STYLE)

With border

• Without border

fault tting “No borders”

To

•

• For form

De se

ype of border drawn around bject.

Closed

(CLOSED)

• ‘X’ = Yes

• ‘ ’ = No

Default setting ‘ ’ = No

I the map is collapsed when the Web a

f you set this indicator,

pplication is opened.

Hide object

(HIDDEN)

‘X’ = Yes

• ‘ ’ = No


Itda

• f the indicator is set, neither he map nor the title is isplayed in the Web pplication.

Objects with navigation links

(GENERATE_LINKS)

‘X’ = Yes

• ‘ ’ = No

Default setting ‘X’ = Yes

Wi for the map which enables nsame time, the corresponding attributes of all the levels b also set to ‘X’ = Yes.

•

hen the indicator is set, an mage map is generated

avigation within it. At the

elonging to the map are

Special Attributes

Attribute Values Description

Map layers This attribute defines the laye

(LAYERS)

rs and the number of layers on which your map is structured. See Attributes for Map Levels [Seite 63].

AXL file (cartography)

(CART_AXL_NAME)

Name of AXL file for cartography description (stored in directory for shape files)

Cartography information on/off

(CART_AXL_VISIBLE)

• ‘X’ = Yes

• ‘ ’ = No


With this attribute you can specify whether additional cartography information, which you described in an AXL file, needs to be displayed. See…

Geo-functions

(GEO_FUNCTIONS_POS)

• Do not display

• Top

• Bottom

• Left

• Right

Default setting: "Do not display"

Position of the geographic function bar in relation to the map.



Advance

(G

Yes

No


Enhancement of the geo-function bar for executing interactive functions on the map itself.

d geo-function bar

EO_FUNCTIONS_ADVANCED)

• ‘X’ =

• ‘ ’ =

The advanced geo-function bar is supported by Web

t and

You determine the position of the advanced geo-function bar using

ions NCTIONS_POS)

attribute. If you do not select the Advanced Geo-function Bar

CED)

splayed for the Geo-functions (GEO_FUNCTIONS_POS)

e, corresponding to the

See also:

Functions of the Advanced Geo-

browsers from Microsoft InterneExplorer 5.0 Netscape 6.2 andhigher

the Geo-funct(GEO_FU

(GEO_FUNCTIONS_ADVANattribute, the basic geo-function bar is di

attributvalue you selected.

Function Bar [Extern]

Position of le

(LEGE

• No legend

ight of the

tion to the map.

gend • Left of the map Position of the legend in rela

ND_POSITION) • Right of the map

Default setting "Rmap"

Size o

(LEGE

ls

0”

Size of the legend in pixels

f legend Entry in pixe

ND_SIZE) Default setting “15

Exten

(MAP

ith hy

available

ith

Specifies which areas of a map are displayed in the Web application. This depends on the data stored in the application.

“Data with geography”, the default setting, allows you to display data taking the corresponding geographic context into account.

t of the map • Data wgeograp_EXTENT)

• Data only

• Data and complete geography

Default setting: “Data wgeography”

Map background transparent • ‘X’ = Yes If you set this indicator, the "Map



(CART_COLOR_TRANSPARENT) • ‘ ’ = No

Default setting ‘X’ = Yes

background color" attribute is ignored and the background appears as transparent in the Web application.

Background color

(CART_BACKGROUND_COLOR)

Color value

Background color of the map.

You select the color values in a color selection dialog.

Fill color (no data)

(CART_FILL_COLOR)

Color value

Fill color of a region if it is not stored with data.


Map outline color

(CART_OUTLINE_COLOR)

Color value

Color of the map outline.


Map outline width

(CART_OUTLINE_WIDTH)

Entry in pixels

Default setting “1”

Width of the map outline in pixels.

Projection

(PROJECTION)

No projection = ‚NONE’

Flat projection = ‚FLAT’

Mercator projection = ‘MERC’

Projection used in map

You can find more information on using the Map Web item and its functions under Navigating in Maps [Extern].



Attributes for Map Layers Definition Objects that define the different layers in a map.

other in the Web application and, in this way, make up the overall view of the how or hide individual layers and change the information contained in a map.

ap layer, you must de the data is displayed in t is by selecting a erer [Seite

Use The layers of a map contain different geographic and business information. The individual layers are laid over one anmap. You can s

For each m fine how his layer. Do thMap Rend 88].

yer object has two kin es, as do all other W

utes that are fundamental to all display types.

The general attributes for the Map Layer object are the same or all Web items. In the Web Application Designer, you can find the gProperties window, on the Web item → General tab page.

General Attributes [Seite

StructureThe Map La...

ds of attribut eb items:

as the general attributes feneral attributes in the

1. General attrib

See 12]

2. Special attributes that vary ac cted map re

butes appear in the Web Application Designer d erer, in the Web item → Special tabpage.

cording to the sele nderer.

epending on the map rendSpecial attri

You can select the map renderer from the selection li on the Web Item → Special tabpage.

additional informatio cial attributes for er

lor

st of the Renderer for a Map

You can find renderer und

n about the spe the individual map

Special Attributes for Co Shading [Seite 65]

Special Attributes for Bar Charts [Seite 67]

Special Attributes for Pie Charts [Seite 69]

Special Attributes for Pie Charts (split) [Seite 71]

Special Attributes for Dot Densities [Seite 72]

Special Attributes for Symbol [Seite 74]

Special Attributes for Symbol (Size-dependent) [Seite 76]

Special Attributes for Symb t) [Seite ol (Color-dependen 78]

Special Attributes for Line [Seite 80]

Special Attributes for Line (Size-dependent) [Seite 82]

Special Attributes for Lines (Color-dependent) [Seite 84]





Special Attributes for Color Shading

espond to special

Definition A map renderer with which you determine how BW data is displayed on a map layer.

Use The color shading map renderer allows you to display color classes that corrvalue classes.

Structure Attribute Values Description

Number of classes

LASSES) (C

Number of color levels (variable “n”)

Initial color

TART)

Color value lor of the

ta source.

s in election dialog.

(COLOR_S

Defines the cosymbol that represents the smallest data value in the connected da

You select the color valuea color s

End color Color value efines the color of the symbol that represents the

lect the color values in

(COLOR_END)

D

largest data value in the connected data source.

You sea color selection dialog.

Individual values

(CS_DYN)

List Individual values entry for color and class boundaries.

Color interpolation

OLOR_INTERPOLATION)

e)

)

ine the color terpolation method here. olors between the start and

the end color are interpolated linearly.

(C

RGB (Color valu

HSB (color area

You can determinC

Color (if no data) lling all the regions of a map that

t the color values in ection dialog.

(COLOR_NONE)

Color value Defines a color value for fi

do not have data in the connected data source.

You seleca color sel

Tooltip for map layer

(GENERATE_TOOLTIP)

‘X’ = Yes, ‘ ’ = No

Default setting: ‘X’ = Yes

This attribute allows you todisplay tooltips for the map layer.

Generate class boundaries

(GENERATE_BREAKS) efault setting: ‘ ‘ = No e color shading.

‘X’ = Yes, ‘ ’ = No

D

This attribute enables better automatic distribution of th



Map Layer Label

(LABEL)

“No Label”

“Text as Label”

“Key as Label”

Default setting: “No Label”

ibute allows you to This attrlabel the map.

Highlight label ‘X’ = Yes, ‘ ’ = No Highlig

(HIGHLIGHT_LABEL)

ht map layer label



List mands of the map layer

List of data providers to whichall comare sent.

Map interaction control

(IMAGEMAP_PATTERN)

“Noc

rmal context menu with lick on map”

“Filtering for data providers with click on map”

you click on the map, as an alternative to the context menu.

You can find additional information about this attribute in the WEB API Reference, section Web Item → Map → Map Layer.

How the map interaction appears. You can use this attribute to determine which action is to take place when

Ignore exceptions when displaying the map level

(IGNORE_EXCEPTIONS)

‘X’ = Yes, ‘ ’ = No Exceptions that are activated with the basic data provider are not displayed in the map level.

See Display of Exceptions for Maps and Charts [Extern].

Attribute to be displayed in the map

(ATTRINM)

Name of the characteristic attribute, the value of which is to be displayed on the map.



Special Attributes for Bar Charts

A map renderer with which you determine how BW data is displayed on a map layer.

Definition

Use You can display values in the form of bars with the bar chart map renderer.


Bar height

(BAR_HEIGHT)

Entry in pixels ght of a bar in the diagram. This Default value: “30”

Defines the maximum hei

height corresponds to the largest value of the connected data source.

Bar width

(BAR_WIDTH)

Entry in pixels

Default value: “10”

Defines the width of the bar in the diagram.

Individual color values

(COLOR_VALUE)

Entry for individual color values


‘X’ = Yes, ‘ ’ = No

‘X’ = Yes (GENERATE_TOOLTIP) Default setting:

This attribute allows you to display tooltips for the map layer.


(GENERATE_BREAKS)

‘X’ = Yes, ‘ ’ = No

Default setting: ‘ ‘ = No

This attribute enables better automatic distribution of the color shading.

Map Layer Label

(LABEL)

“No Label”

“Text as Label”

“Key as Label”


This attribute allows you to label the map.

Highlight label

(HIGHLIGHT_LABEL)

‘X’ = Yes, ‘ ’ = No

Highlight map layer label


(TARGET_DATA_PROVI)

DER er List

List of data providers to which all commands of the map layare sent.


AP_PATTERN)

text menu with

a providers

an use this ttribute to determine which tion is to take place when

you click on the map, as an alternative to the context

(IMAGEM

“Normal conclick on map”

“Filtering for datwith click on map”

How the map interaction appears. You caac



menu.

You can find additional information about this attribute

ayer.

in the WEB API Reference, section Web Item → Map → Map L

Ignore exceptions when ted

r

displaying the map level

XCEPTIONS) (IGNORE_E

‘X’ = Yes, ‘ ’ = No Exceptions that are activawith the basic data providerare not displayed in the map level.

See Display of Exceptions foMaps and Charts [Extern].


(ATTRINM)




Special Attributes for Pie Charts Definition

with which you determine how BW data is displayed on a map layer.

n display values in the form of pie charts with the pie chart renderer.

Description

A map renderer

Use You ca

Structure Attribute Values

Individual color values Entry for individual color values (COLOR_VALUE)

Pie diameter (maximum) Entry in pixels Defines the largest diameter of a circle in the diagram. This diameter is the sum of all the maximum values displayed in the Web application.

If you set "circle diameter (minimum) = circle diameter (maximum)“, all the circles in the Web application are displayed with the same diameter.

(PIE_MAX)

Pie diameter (minimum)

(PIE_MIN)

Entry in pixels Defines the smallest diameter of a circle in the diagram. This diameter is the sum of all the minimum values displayed in the Web application.

If you set "circle diameter (minimum) = circle diameter (maximum)“, all the circles in the Web application are displayed with the same diameter.


(GENERATE_TOOLTIP)

‘X’ = Yes, ‘ ’ = No




(GENERATE_BREAKS)

‘X’ = Yes, ‘ ’ = No



Map Layer Label

(LABEL)

“No Label”

“Text as Label”

“Key as Label”





Highlig

(HI

Highlight map layer label ht label

GHLIGHT_LABEL)

‘X’ = Yes, ‘ ’ = No

Affected data provider List List of data providers to which all commands of the map layer (TARGET_DATA_PROVIDER

) are sent.

Map interaction control “Normal context menu with


How the map interaction se this

ne which action is to take place when you click on the map, as an

the context

(IMAGEMAP_PATTERN) click on map” appears. You can uattribute to determi

alternative to menu.

You can find additional information about this attributein the WEB API Reference, section Web Item → Map → Map Layer.


(IGNORE_EXCEPTIONS)

‘X’ = Yes, ‘ ’ = No ted

ions for

Exceptions that are activawith the basic data provider are not displayed in the map level.

See Display of ExceptMaps and Charts [Extern].


(ATTRINM)




Special Attribut ie Charts (s

Definition , with which you d ata is display

e chart re r to display values in the fora ally if there is a "change of grou

nd quarter of 2001).

e split pie cha ie chart renderer.

See Special Attributes for the Pie Chart Renderer [Seite

es for P plit)

A map renderer etermine how BW d ed in a map layer.

Use You can use the split pi ndere m of split pie charts. In a split

p" (that is from sales for the 1pie chart, the split occurs automquarter of 2001 to the sales for the 2

tic st

Structure The special attributes of th rt renderer are identical with the special attributes of thep

69].



Special Attributes for Dot Density

sing dot densities.

Definition A map renderer with which you determine how BW data is displayed on a map layer.

Use You can use the dot density renderer to display values in a map u


Dot base value

LUE)

a

”),

7400, the system

ance ea, and these dots are

distributed randomly.

(BASE_VA

Describes the basis value fordot (symbol). Example: When choosing the value 1000 for the BASE_VALUE (“BASE_VALUE = 1000and the data value for France, say, isproduces the result 7400/1000= 7.4 (rounded to 7). 7 dots appear in the Frmap ar

Color (COLOR) alue Dot color (symbols)

ia

Color v

The color value is selected va color selection dialog box.

Maximum density, per cent put in percent Defines how dense the points

symbol" and "Maximum

ay not be sed at the same time.

(DENSITY)

Inshould be displayed in a region for the largest value ofthe connected data source.

The attributes "Value for a

density in %" are self-exclusive and mu

Size/Width

(SIZE)

Defines the size of the points (symbols).

Entry in pixels

Symbol type

(STYLE)

“Circle”

“Rectangle”

ngle”

ross”

the data is displayed in a

“Tria

“C

Defines the symbol with which

layer.


)

‘X’ = Yes, ‘ ’ = No his attribute allows you to display tooltips for the map (GENERATE_TOOLTIP Default setting: ‘X’ = Yes

T

layer.

Generate class boundaries ‘X’ = Yes, ‘ ’ = No This attribute enables better



(GENERATE_BREAKS) Default setting: ‘ ‘ = No automatic distribution of the color shading.

Map Layer Label

(LABEL)

o Label”

“Text as Label”

“Key as Label”


o map.

“N This attribute allows you tlabel the

Highlight label ‘X’ = Yes, ‘ ’ = No p layer label

(HIGHLIGHT_LABEL)

Highlight ma



List

List of data providers to whichall commands of the map layer are sent.

Map interaction control “Normal context menu with lick on map”


alternative to the context menu.


(IMAGEMAP_PATTERN)

cHow the map interaction appears. You can use this attribute to determine which action is to take place when you click on the map, as an


(IGNORE_EXCEPTIONS)




(ATTRINM)




Special Attributes for Symbols Definition A map renderer with which you determine how BW data is displayed on a map layer.

Structure Values Description

Use You can display values using symbols with the Symbol renderer.

Attribute

Color

(VALUE)

Color value as RGB value

or selection dialog.

Symbol color

You select the color values in a col

Size/Width

Entry in pixels Defines the size of the resent the (SIZE) symbols that rep

data.

Symbol type

TYLE)

ircle

Rectangle

gle

Cross

(S

C

Trian

Defines the symbol with which the data is displayed in alayer.


OLTIP)

No

efault setting: ‘X’ = Yes

(GENERATE_TO

‘X’ = Yes, ‘ ’ =

D

This attribute allows you to display tooltips for the maplayer.


‘X’ = Yes, ‘ ’ = No

‘ ‘ = No

This attribute enables better

(GENERATE_BREAKS) Default setting:

automatic distribution of the color shading.

Map Layer Label “No Label”

Label”

l”

ting: “No Label”

to

(LABEL)

“Text as

“Key as Labe

Default set

This attribute allows you label the map.

Highlight label

, ‘ ’ = No Highlight map layer label

(HIGHLIGHT_LABEL)

‘X’ = Yes



List

List of data providers to whicall com

h mands of the map layer

are sent.


AP_PATTERN)

text menu with

attribute to determine which (IMAGEM

“Normal conclick on map”

How the map interaction appears. You can use this



“Filtering for data providers ction is to take place when he map, as an

alternative to the context

You can find additional information about this attribute

r.

with click on map”

ayou click on t

menu.

in the WEB API Reference, section Web Item → Map → Map Laye

Ignore exceptions whendisplaying the map level

ted

r

(IGNORE_EXCEPTIONS)




(ATTRINM)

characteristic ich is

Name of the attribute, the value of whto be displayed on the map.



Special Attributes for Symbol (Size-dependent) Definition A map renderer with which you determine how BW data is displayed on a map layer.

Use You can use the symbol (size-dependent) renderer to display values using size-dependent symbols. The renderer takes the location and data values for this location into consideration. The size of the symbols depends on the data.


Number of classes

(CLASSES)

Number of size levels (variable “n”)

Color

(COLOR)

Color value

es in

Symbol color

You select the color valua color selection dialog.

Individual values

(SG_SYM_DYN)

List Individual values entry forsymbol sizes and class boundaries.

Symbol (end size)/

Entry in pixels

Line (end width)

(SIZE_END)

Defines the symbol size / line width that represents the largest data value in the connected data source.

Symbol (starting size) /

Line (starting width)

(SIZE_START)

Entry in pixels

line Defines the symbol size / width that represents the smallest data value in the connected data source.

Symbol type “Circle”

riangle”

“Cross”

ol with which (Style) “Rectangle”

“T

Defines the symbthe data is displayed in alayer.


_TOOLTIP)

‘X’ = Yes, ‘ ’ = No

Yes p (GENERATE Default setting: ‘X’ =

This attribute allows you to display tooltips for the malayer.


_BREAKS)

’ = Yes, ‘ ’ = No

No

atic distribution of the (GENERATE

‘X

Default setting: ‘ ‘ =

This attribute enables betterautomcolor shading.

Map Layer Label e allows you to “No Label” This attribut



(LABEL)

abel”

Label”

Label”

label the map.

“Text as L

“Key as

Default setting: “No

Highlight label

(HIGHLIGHT_LABEL)

‘X’ = Yes, ‘ ’ = No



(TARGET_DATA_PROVIDER f the map layer

)

List List of data providers to which all commands oare sent.


MAGEMAP_PATTERN)

menu with teraction ppears. You can use this

attribute to determine which action is to take place when

n

menu.

B API Reference, ction Web Item → Map Map Layer.

(I

“Normal context click on map”


How the map ina

you click on the map, as aalternative to the context

You can find additional information about this attribute in the WEse→

Ignore exceptions when

GNORE_EXCEPTIONS)

ted

r

displaying the map level

(I




(ATTRINM)

tic Name of the characterisattribute, the value of which is to be displayed on the map.



Special Attributes for Symbol (Color-dependent)

A map renderer with which you determine how BW data is displayed on a map layer.

dent) nderer takes the location and data values for this location into consideration. The bols depends on the data.

ture alues

Definition

Use You can display values using color-dependent symbols with the Symbol (color-depenrenderer. The recolor of the sym

StrucAttribute V Description

Individual values

(CG_SYM_DYN)

color values and class Individual values entry for

boundaries.

Number of classes

LASSES)

Number of color levels (variable “n”) (C

End color

(COLOR_END)

Color value

sents the

rgest data value in the

he color values in color selection dialog.

Defines the color of thesymbol that reprelaconnected data source.

You select t

a

Color interpolation

(COLOR_INTERPOLATION)

Color interpolation method

Defines the method with which

located between the starting and end colors are

lor

of ource.

RGB

HSB the color values that are

interpolated. These covalues represent the data that is located between the smallest and largest valuesthe data s

Initial color Color value presents the

lect the color values in

Defines the color of the symbol that re(COLOR_START) smallest data value in the connected data source.

You se

a color selection dialog.

Size/Width Entry in pixels

(SIZE)

Defines the size of the symbols that represent the data.

Symbol type

TYLE)

a symbol is isplayed. (S

Circle

Rectangle

Describes how d



Triangle

Cross


(GENERATE_TOOLTIP)

’ = Yes, ‘ ’ = No

ult setting: ‘X’ = Yes

This attribute allows you to ‘Xdisplay tooltips for the map layer. Defa


(GENERATE_BREAKS)

’ = Yes, ‘ ’ = No ute enables better automatic distribution of the

‘X


This attrib

color shading.

Map Layer Label

(LABEL)

ey as Label”


“No Label”

“Text as Label”


“K

Highlight label

(HIGHLIGHT_LABEL)

‘X’ = Yes, ‘ ’ = No

l Highlight map layer labe


(TARGET_DATA_PROVIDER

List s of the map layer

)

List of data providers to which all commandare sent.


(IMAGEMAP_PATTERN)

“Normal context menu with click on map”

“Filtering for data providers ith click on map”

e map interaction


How thappears. You can use this attribute to determine which action is to take place when you click on the map, as analternative to the context menu.

w


(IGNORE_EXCEPTIONS)




(ATTRINM)




Special Attribute: Line Definition A map renderer with which you determine how BW data is displayed on a map layer.

Use The Line renderer displays values with a line going from a starting to an end point.


Color

(COLOR)

Color value

select the color values in ction dialog.

Line color.

You a color sele

Layer (starting points)

ROM_LAYER)

h the ne’s starting points lie.

ne layer.

(F

Layer for starting points

Defines the layer on whicli

All starting points must be located on o

Line type

(LINE_STYLE)

ontinuous”

“Dotted”

Dashed”

“C

“

Defines how the lines are displayed.

Size/Width

(SIZE)

Entry in pixels Defines the width of the line.

Layer (end points) Layer for end points

h the end points of the lines are

All end points must be located on one layer.

(TO_LAYER) Defines the layer on whic

located.


(GENERATE_TOOLTIP)

‘X’ = Yes, ‘ ’ = No




(GENERATE_BREAKS)

‘X’ = Yes, ‘ ’ = No Default setting: ‘ ‘ = No


Map Layer Label

(LABEL)

“No Label”

“Text as Label”




el”

“Key as Label”

Default setting: “No Lab

Highlight label

(HIGHLIGHT_LABEL)

‘X’ = Yes, ‘ ’ = No Highlight map layer label


(TARGET_DATA_PROVIDER

ist

s of the map layer

)

L List of data providers to which all commandare sent.


(IMAGEMAP_PATTERN)

t menu with

roviders ith click on map”

n

ve to the context

e

→ Map →

“Normal contexclick on map”

“Filtering for data pw

How the map interaction appears. You can use this attribute to determine which action is to take place when you click on the map, as aalternatimenu.

You can find additional information about this attributin the WEB API Reference, section Web ItemMap Layer.


(IGNORE_EXCEPTIONS)

‘X’ = Yes, ‘ ’ = No

t displayed in the map

or

Exceptions that are activatedwith the basic data provider are nolevel.

See Display of Exceptions fMaps and Charts [Extern].

Attribute to be displayed in the

TTRINM)

to be displayed on the map. map

Name of the characteristic attribute, the value of which is

(A



Special Attribute: Line (Size-dependent) Definition A map renderer with which you determine how BW data is displayed on a map layer.

Use You can use the bar chart map renderer to display values in the form of bars.


Number of classes

(CLASSES)

Number of size levels (variable “n”)

Color

(COLOR)

Color value

color values in a color selection dialog.

Line color.

You select the

Line type

(LINE_STYLE)

“Continuous”

“Dotted”

“Dashed”

Defines how the lines aredisplayed.

Individual values

(SG_LI_DYN)

Entry of individual values for line width and class boundary.

Symbol (end width) / line (end width)

(SIZE_END)

Symbol/line end width

Symbol (start width) / line (start width)

Symbol/Line start width

Layer (starting points)

(FROM_LAYER)

Layer for starting points

Layer (end points)

(TO_LAYER)

Layer for end points


TE_TOOLTIP)

‘X’ = Yes, ‘ ’ = No

: ‘X’ = Yes

to (GENERA Default setting

This attribute allows you display tooltips for the maplayer.


RATE_BREAKS)

= No

No

his attribute enables better stribution of the (GENE

‘X’ = Yes, ‘ ’

Default setting: ‘ ‘ =

Tautomatic dicolor shading.

Map Layer Label

“No Label”

ext as Label”

“Key as Label”

his attribute allows you to . (LABEL) “T

Tlabel the map




Highlight label

(HIGHLIGHT_LABEL) ’ = Yes, ‘ ’ = No-{}-

bel ‘X Highlight map layer la


)

h

t. (TARGET_DATA_PROVIDER

List

List of data providers to whicall commands of the map layer are sen


(IMAGEMAP_PATTERN)


“Filtering forwith click on

data providers map”

which

map, as an lternative to the context

You can find additional bute

section Web Item → Map

How the map interaction appears. You can use this attribute to determine action is to take place when you click on theamenu.

information about this attriin the WEB API Reference,

→ Map Layer.

Ignore exceptions when displaying the map level- (IGNORE_EXCEPTIONS)

’ = Yes, ‘ ’ = No asic data provider

are not displayed in the map

r

‘X Exceptions that are activated with the b

level.



(ATTRINM)

h is played on the map.

Name of the characteristic attribute, the value of whicto be dis



Special Attributes for Lines (Color-dependent) ition

the end point. a line.

SAttribute Values Description

DefinA map renderer with which you determine how BW data is displayed on a map layer.

Use The line (color-dependent) renderer displays values with a line from the starting toThe data values define the color of

tructure

In id

(C

Individual values entry for color values and class boundaries.

div ual values

G_LI_DYN)

Number of cl

(CLASSES)

Number of color levels (variable “n”)

asses

End color

(COLOR_EN largest data value in the connected data source.

You select the color values in

D)

Color value Defines the color of the symbol that represents the

a color selection dialog.

Color interpolation RGB

HSB

Defines the method with which the color values that are

is located between the smallest and largest values of the data source.

located between the starting and end colors are interpolated. These color values represent the data that

In l

(C

Color value

Defines the color of the symbol that represents the smallest data value in the


itia color

OLOR_START)

connected data source.

Line type

(LINE_STYLE)

“Continuous”

“Dotted”

“Dashed”

Defines how the lines are displayed.

Siz /Width

(SIZE)

Entry in pixels Defines the width of the line.

e

Layer (starting points) Layer for starting points



(FROM_LAYER)

Layer (end p

(TO_LAYER)

oints)

Layer for end points


ENERATE_TOOLTIP)

‘X’ = Yes, ‘ ’ = No


This attribute allows you to display tooltips for the map layer. (G


(GENERATE_BREAKS)

‘X’ = Yes, ‘ ’ = No



Map Layer Label

(LABEL)

“No Label”

“Text as Label”

“Key as Label”



Highlight label

(HIGHLIGHT_LABEL)

‘X’ = Yes, ‘ ’ = No




List

List of data providers to which all commands of the map layer are sent.


(IMAGEMAP_PATTERN)



How the map interaction appears. You can use this attribute to determine which action is to take place when you click on the map, as an alternative to the context menu.



(IGNORE_EXCEPTIONS)




(ATTRINM)




Array Attributes

There are certain map attributes that are known as array attributes. You can recognize these suffix “(n)” (see Attributes for Maps [Seite

Use

attributes by the 59] andAttributes for Map Layers [Seite 63]).

This section describes the function of array attributes.

The following are array attributes:

• Symbol size (n)

• Class boundary (n)

• Color value (n)

• Line width (n)

• Bar Color (n)

• Segment color (n)

The variable n is the number of classes. You can set this variable with the attribute class number

Example Use the above attributes to change the default settings in the system. The default settings provide a rim values for each class.

Fo x

If starting with starting valu r of cla asses, a starting size of 8 and an end size of 20 points, you wo d values for the individual class sizes:

•

•

•

You c es for the attribute symbol

•

linear calculation of the inte

r e ample: symbol size (n)

the attribute symbol size (n) is not set, the size of the symbols displayed in a map, e A and ending with end value B, are distributed linearly across the numbe

sses. If you have for example 4 clul get the following

• Class 1 -8 points

Class 2 -12 points

Class 3 -16 points

Class 4 -20 points

an adjust this automatic assignment by manually setting the valusize (n), for example, in the following way:




Class 4 -20 points



The attributes symbol size (n), color value (n) and line width (n) are always bound to the attribute class boundary (n). That is, when you set one of these attributes, you

also need to set a value for the corresponding class boundary.



Map Renderer Definition With a map renderer, you determine how BW data is displayed on a map layer.

Structure There are 11 different map renderers in the BEx Web Application Designer. These renderers are divided into three different classes:

Class 1: Renderers that relate to polygonal areas (static geo-characteristics). They display the following:

• Color shading (COLORSHADING or CS)

• Bar charts (BAR)

• Pie charts (PIE)

• Pie charts (divided) (SPLITPIE)

• Pixel density (DOTDENSITY or D_DENSITY)

For these renderers, the static geo-characteristic must appear in the related data provider in the rows and the values to be displayed in the renderer must be in the columns. You can use hierarchies in both cases. You cannot have any other characteristic other than the geo-characteristic, or any key figure in the rows. You can use several characteristics or key figures in the columns.

Class 2: Renderers that relate to locations (dynamic geo-characteristics). They display the following:

• Symbol (SYMBOL)

• Symbol (size-dependent) (SIZEGRADUATEDSYMBOL or SG_SYMBOL)

• Symbol (color-dependent) (COLORGRADUATEDSYMBOL or CG_SYMBOL)

• Bar charts (BAR)

• Pie charts (PIE)

• Pie charts (divided) (SPLITPIE)

For these renderers the dynamic geo-characteristic must appear in the data provider belonging to it in the rows. You must have also selected the Longitude and Latitude display attributes to be displayed. You cannot have any other characteristics or key figures in the rows. Only the first column is considered by the symbol renderers. The renderers bar chart, pie chart and pie chart (divided) consider all columns.

Class 3: Renderers that display relationships between locations (dynamic geo-characteristics):

• Line (LINE)

• Line (size-dependent) (SIZEGRADUATEDLINE or SG_LINE)

• Line (color-dependent) (COLORGRADUATEDLINE or CG_LINE)

It is important to have at least three map layers for these renderers. You define Start Point in one map layer and the End Point in another map layer. The prerequisites described in class 2 are also valid for both of these map layers. The third map layer contains the relationship between the dynamic geo-characteristics Start Point and End Point, that is,



both characteristics must be in the rows. The same prerequisites are valid for the columns as described in class 2.

For those map renderers that have a long technical name, you can specify a shorter, alternative name (for example, COLORGRADUATEDLINE or CG_LBoth variations are supported.

INE).

ration

f a Renderer in Class 3

Sales Representative Sales

IntegSo that you can present the BW business data on individual map layers graphically, you have to assign a map renderer to each map layer in the BEx Web Application Designer and determine the properties for this renderer.

Example oMap layer query view that describes the relationship

Sales Office

A 1 100 $

A 2 150 $

A 3 120 $

B 11 90 $

B 12 80 $

Map layer query view that describes the start point

Sales Office Longitude Latitude # Employees

A 2.3 3.4 120

A 2.3 3.4 15

A 2.3 3.4 120

B -3.5 -2.0 87

B -3.5 -2.0 80

Map layer query view that describes the end point

Sales

Representative

Longitude Latitude # Customers

1 2.8 4.7 12

2 2.6 5.7 11

3 2.4 6.7 13

11 -3.8 -1.2 23

12 -3.4 -1.8 21





Single Document Definition Web item allowing you to display single documentWorkbench or in master data maintenance for ma

Use You can create the documents in different formats Documents [Extern]

s that you created in the Administrator ster data in the Web application.

and versions (see ). You can add several documents such as route directions and a picture of the local office for each value of a characteristic, such as Business Partner. You can use the document type attribute to decide which document you want to display in the Web applica


tion.

12], the Web item Sing g specific attributes:

Attributes

le Document has the followin

Description

Document class (DOCUMENT CLASS)

‘MAST’ = master data (default setting)

‘TRAN’ = InfoProvider data

Do are dis r data).

ST’ = master data, you characteristic. The

ocument that is relevant for

report on the

ns of

e

in the Web item for the

cument class for which documentsplayed (master data or InfoProvide

• If you choose ‘MAhave to specify adocuments for the values of this characteristic are then displayed in the Web item.

• If you choose ‘TRAN’ = InfoProvider data, the dthe current navigational state is displayed in the Web item. This is worthwhile, for example, if you havecreated a document (a business area) for all combinatiomonth and business area and both of these characteristics are contained in thfilter. The document is then always displayed selected business area and month.



Document type (WWW_DOC_TYPE) You can specify a type of document here. Only documents of this type are then displayed.

You can display several documents for the values of a characteristic at the same time in a Web application.

For example, for the characteristicCustomer, you can display a logo(in a Web item of the docu

ment

f the

n

this document. The various

offered for you to choose from in the Web item.

type LOGO)and a sketch with directions (in a Web item odocument type MAP

If you create a new document or change aexisting document, you can maintain the document type for document types for the existing document are

If you do not make any entries here, the system assumes that only one document is suitable for the Web item.

If this is not the case you get a message

− That no document was found or

− That the document is not unique (there is more than one)

Characteristic (IOBJNM) Characteristic for which master data documents are displayed

You need to select a characteristic in this attribute when you have chosen in the attribute Document Class (DOCUMENT_CLASS) the entry ‘MAST’ = master data:



Displa HTML frame for displaying the document (IFrames are possible). If you are working with frames in your Web application (including internal frames, or IFrames), you can divert the document output

Web item itself. This is useful for documents that you cannot display in the Web item itself, such as Microsoft Word and PDF

y frame (TARGET_FRAME)

into a different frame instead of displaying it in the

documents, but which you want to display immediately.

We recommend that you do not create a title for the Single Document Web item if you want

lay the following types

to display the document in a different frame.

At the moment, you can dispof files [Extern] in the Web item itself:

: image/jpeg, image/gif

• Text: text/plain

• Html: text/ html

• Images

Nes

(TA E

Def t

This attribute specifies how many levels in the frame hierarchy have to be skipped to reach

bute is

frames are addressed on the same HTML page.

at contains the current HTML page is also defined .

ting depth of frame

RG T_FRAME_LEVEL) the display frame. Setting this attriaul setting “0” particularly worthwhile when you are working

with framesets.

• With the default setting “0”, the display

• With the setting “1”, frames are addressed that are defined on the same hierarchy level on which the frame th

Display in same bro(IS_INPLACE

‘X’ = Yes, ‘ ’

You can define if the single document is

ute

n only display documents in the same er window (‘X’) for file types specified in

E. The other file types are always displayed as a link.

wser window )

= No

displayed

• In the Web application (‘X’) or

• As a link that the document calls up in a separate browser window (‘ ‘)

. This attribute is interpreted only if the attribTARGET_FRAME is empty. You cabrowsthe attribute TARGET_FRAM



Links

’ = No

ute to determine whether

set to X, clicking on the picture cuments for the currently filtered

r the he

to document display You can use this attrib(LINK_TO_BROWSER)

‘X’ = Yes, ‘

you can link from the document to the generaldocument display. If the value is displays all docharacteristic value (or all documents focharacteristic master data, if no value is in tfilter) in a separate browser window. This attribute is interpreted only if the attribute TARGET_FRAME remains empty.

Default picture (DEFAULT_PICTURE_URL) layed in a Web item if no

document has been found, or if the document is not consistRepository crelative addre

Absolute or relative URL for a picture. Thispicture is disp

ent. Pictures from the MIME an be selected here using a ss.

You can find more information on using the Single Document W tionality under Using Documents in Web Applications [Extern]

eb item and its func.



List of Documents Definition Web item that displays a list of documents in the Web application. You can also create new documents [Extern] yourself in the Web application.

Use The Web item List of Documents enables you to call or create c bout the transaction data used in the Web application. , for example, restrict a characteristic to a certain charaautomatically adjusted. This means that only the dnavigation status appear.

ontext-sensitive information aIf you navigate in the Web application andcteristic value, the list of documents is ocuments that are relevant for the restricted

The documents for the characteristic in the Administrator Workbench appea lly in the list.

Structure The Web item

s that were set as the Document Propertiesr automatica

List of Documents has the follow

• Functions

You can also:

− Create a New Document [Extern]

ing structure:

− Set whether or not the characteristics of th isplayed

you can look for documents in other areas. In order to be able to change the selection, the attribute Display Selection (see below) must be set accordingly.

• Selection

The selection is the counterpart to the navigation block and shows the characteristics that are Document Properties and are contained in the basic data provider (query or query view), and their values.

e documents are to be d

− Define whether the selection for the documents is to be displayed. If the selection is displayed, you can also change it so that

If you have already inserted a navigation block into your Web template, you do not need the selection information in the list of documents if you want to see only those documents that refer to the numbers of the table.

The selection is adjusted dynamically depending on the navigation in the Web application. This means that the list of documents displays only those documents that refer to the requested data in the table. If the selection can be changed, you can also focus on the documents and, for example, display all the documents that refer to the InfoProvider.

You can set the following in the Web Application Designer using attributes:

Whether you want to display the selection

Whether or you can change the selection in the Web application



• List of documents

In ad

The links to the documents are listed here in alphabetical order.

dition to its general attributes [Seite 12], the List of Documents Web item has the following attributes:


Display Properties

(SHOW_PROPERTIES)

This attribute indicates if the document property is to be displayed. The document

‘X’ = Yes, ‘ ’ = No properties tell you about how the documents are assigned, for example base planning object 4711, month of May. The selection to which the document was restricted determines the assignment.

If a document property is identifor all selected documents, this property is not displayed u

cal

nder

rties on/off

the document link.

You define the initial display with the Document Properties attribute. Using the Propebutton, you can toggle the display of the properties in the Web application.

Furthermore, in the PROPERTY_LIST attribute you can set which additional document properties need to be displayed here.

Display Selection

(SHOW_CONTEXT)

' ' = can be changed, is not displayed at first

'N' = cannot be changed, is displayed at first

'X' = can be changed, is displayed at first

'0' = cannot be changed, is not displayed at first

With this attribute you can indicate whether the the selection conditions for the documents for the List of Documents Web item are displayed as well as whether these selection conditions are changeable.

Number of Rows in the Table

(BLOCK_SIZE)

With this attribute you can define the number of rows (document links and properties) that are displayed at one time. If there are not enough rows, an index for scrolling appears in the bottom row.

Maximum Number of Displayed Values

(MAXVALUES)

With this attribute you can define the maximum number of characteristic values to be displayed in the dropdown box of the selection.



Docume

(DOCU

o

bute you can define whether cuments can be created, changed, or leted.

nt Changeable

MENTS_ARE_CHANGEABLE)

With this attridode

‘X’ = Yes, ‘ ’ = N

Frame for Display

(TARGET_FRAME)

Here, you can specify an HTML frame in which the individual documents that you call from the list of documents is displayed.

The HTML frame must be integrated in the Web template.

e e set, you can also

nt

ate

If you use the Web templatwithin a framintegrate the called-up documein another frame of this set.

If you do not define an HTML frame, the individual documents are displayed in separwindows.

Additional Properties

(PROPERTY_LIST)

s that are displayed for each document displayed in the Web item. Here, you can set the following

CREATED_BY: Creator

CHECKOUT_USER: Editor

LANGUAGE: Language

Additional document propertie

properties:

LAST_CHANGED_BY: Last person to make changes

LAST_CHANGED_AT: Change time

CREATED_AT: Creation time

You can find more information on using the List of Documents Web item and its functions under Using Documents in Web Applications [Extern].



Object Catalog of the Web Application

Web item with which you can generate information (as XML) about the current Web template ies, data providers and Web items used in the Web template. The Web item is not ed in the Web application. You can see the generated XML in the source text for the Web

Definition

propertvisualizapplication.

Structure In addition to its general attributes [Seite 12], the Object Catalog of the Web Application Web item has the following attributes:


Output Web template properties If you set the indicator for this attribute, the

(PROPERTIES) Web template properties are output as XML in the source text of the Web application.

Output list of the data providers indicator for this attribute, a list of ders used is output as XML in the (DATA_PROVIDERS)

If you set the the data provisource text of the Web application.

Output list of Web items

(ITEMS)

If you set the indicator for this attribute, a list of the Web items used is output as XML in the source text of the Web application.



Data Provider – InformatioDefinition Web item that you can use for XML generation of query. The Web item is not visualized in the Web the source text for the Web application.


n

query results data or of the navigation state of a application. You can see the generated XML in

12], the Dfollowing attributes:

Attribute

ata Provider Information Web item has the

Description

Output navigational state

(NAVIGATIONAL_STATE)

If you set the indicator for this attribute, the navigational state of the query is output as XML in the source text of the Web application.

Output results data

(RESULT_SET)

If you set the indicator for this attribute, the query results are output as XML in the source text of the Web application.

You can generate a description of th e amount of

of XML, using the Web service for accessing the ovider command EXPORT. See also Web Service for

e navigation state, as well as thresults for a query in the formquery data or with the data prAccessing Query Data [Extern] and Exporting Data [Seite 181].

Example You can find a description of an e Webxample scenario under XML Item: Data Provider Information [Seite 274].



Web Template

n easilyd can i

r foheading as a Web template and can integrate thisWeb Template Web item. This Web template is thframe technology, the system does not generate a is process. The context of

In addition to its general attributes [Seite

Definition Web Item used to help you insert other Web templates into a Web template.

Use With the Web Template Web Item, you caapplications centrally in a Web template an

manage consistent sections in your Web ntegrate them into any Web template as oter section with the corporate logo and Web template into your Web applications as a en inserted during runtime. In contrast to HTML new page during th

needed. In this way, you can define a header o

the main template remains the same.

Structure 12], the Web item Web Template has the following

specific attributes:


Only <body> tag

(USE_ONLY_BODY)

'X' = Yes (sta dard setting), ' ' = No

Only use the contents of the <body> tag

If you set this attribute, only the contents of the body tag will be used for the Web template to be inserted. n

This attribute has to be set if the Web template to be inserted represents an entire HTML document including <HTML> tag.

Web Template

(TEMPLATE_ID)

Technical name of the Web template that is to be inserted.



Prefix for the logical name

(NAM

Prefix for the logical name of the objects that are contained in the Web template.

Since the objects in the main template and in the inserted Web template share a namespace and can be linked to one another through their

ue in an nment

for the main template and the inserted Web template. The prefix assignment is useful when

a the main template

and in the inserted Web template, but when these should be separated from one another.

DP1 in plate with the query “sales he inserted Web template, a data

sary to assign the data provider for

Th vides you with an overview of the effects of the prefix assignment on the Web API.

E_PREFIX) (optional)

names, you can make them uniqassociated scenario with the prefix assig

the same logical name for Web items and datproviders are used in both

Example: You are using a data provider the main temrevenue". In tprovider DP1 is also used, but this time with the query "costs". In order to have the „costs“ query displayed in the inserted Web template, it is necesthe inserted Web template with a prefix.

e following table pro

working with

Prefix assignment and its significance

Prerequisites Name Prefix As signment No Name Prefix Assignment

Same logical name of Web items in the main template and

Web API – commaddress the Webinserted Web temname prefix andThe following coapply:

PREFIX.NAME

Example: The Web Item oinserted Web temlogical name ITEprefix is ABC. The Web item is addressed with A

in the inserted Web template.

ands must item of the

Initialization of the Web item corresponds to the

plate with logical name. nventions

initialization of the main template.

f the plate has the

M_1 and the

BC.ITEM_1.

Same logical name of data providers in the main template and in the inserted Web

address the data provider of the inserted Web template

using the data provider of themain template.

template.

Web API – commands must

with name prefix and logical name. The following conventions apply:

PREFIX.NAME

Example: The data provider of the inserted Web template has the logical name ITEM_1 and the prefix is ABC. The data

The data binding takes place



provider is addressed with ABC.DP_1.

can use the following attributes (parameters), which are not available to you in of the Web

template.

te Description

In addition, you the Web Application Designer, which, however, can be inserted using the HTML view

Attribu

Overwriting the Web item initialization

(SET_ITEM_I; ITEM_ID_I / ITEM_CLASS_I)

If you use this attribute, the initial Web item settings in the Web template to be inserted will be overwritten. For a possible scenario for the use of this attribute, see example 3 under Web Template [Extern].

Overwriting the data provider initialization If you use this attribute, the initial data pro

(SET_DATA_PROVIDER_I) (optional)

vider settings in the Web template to be inserted will be overwritten.

All executed attributes cannot be cha

For more information about using the Web Templa

nged using command URLs.

te Web item and its functions, see Web Template [Extern].



Broadcaster Definition A Web item that serves as a tool for precalculation

Use When you use the Web item

and distribution of BW objects.

Broadcaster, youworkbooks and can distribute them by e-mail or in


can precalculate Web templates, queries and to the Enterprise Portal.

12], the Broa ng attributes:

Attribute Descr

dcaster has the followi

iption

Type of reporting object

(SOURCE_OBJECT_TYPE)

Using e of repis star

Yo ing objects:

•

•

•

•

Depen ich object you select, one of th the co

this attribute, you can determine the typorting object with which the broadcaster ted.

u can choose from the follow

Web template

Query

Workbook

Data providers

ding on whe following attributes appears for specifying

rresponding technical name.

Name of the Web template

(SOURCE_TEMPLATE)

Technwhich

ical name of the Web template with the Broadcaster should be started.

Name of the query

(SOURCE_QUERY)

TechnBroad

ical name of the query with which the caster should be started.

Name of the workbook

(SOURCE_WORKBOOK)

TechnBroad

ical name of the workbook with which the caster should be started.

Name of the data provider

(SOURCE_DATA_PROVIDER)

Logical name of the data provider with which the Broadcaster should be started.

You can find more information on using the Broadcaster Web item and its functions under BEX Broadcaster Functions [Extern].



Query View – Selection

n between

Use Selection, in one

sentatio ferent w mple).


Definition Web item with which you can navigatio various queries and query views.

With the Web item Query View – step you can switch from a data provider n (such as a table, for example) to another dataay (in a chart, for exa

(query or query view) and its graphical preprovider that is perhaps presented in a dif

12], the Q s the uery View – Selection Web item hafollowing attributes: Attribute Description Affected Web item

(VIEW_DD_TARGET_ITEM) mplate. This

Enter the name of the Web item here that is to be used for visualization of the data and that you have inserted into the Web teattribute is mandatory because the Web item Query View – Selection can only be dragged into a Web template in connection with a Webitem for visualization off the data.



List of query

(AS

List of data providers, their description and their assignment to a Web item

Before you set this attribute, you must first assign a data provider to the Web template.

is query or the query view once in the rows of the list. This data provider will then be displayed initially in the Web application.

• Name of the query

You can specify the technical name of here.

specify a query view, skip this column. e of the Query View

See Name of

at rary and

ualization of

you do

e used for visualization.

r every

views

SIGNMENT)

Depending on whether you select a query or aquery view as data provider, you will have to specify th

Every row in the list represents an entry in the dropdown box. For each entry, establish the following:

the query that you want to visualize This entry is optional: If you want to

See Nam

• Name of the query view

You can specify the technical name of the query view here or you can select an entry from the input help for the query view. Specification of the query view is optional: If you want to specify a query, go back to the first column.the Query

• Technical name of the Web item thwas previously saved in a libthat should be used for visthe data. This information about the Web item for visualization is optional. Ifnot specify anything, the affected Web item will b

• Description for the entry in the dropdown box. A description is mandatory foentry in the dropdown box.

Display create/delete button

determine whether entries

een

r for this attribute, a standard Web template for display will be

(VIEW_DD_SHOW_BUTTONS)

With this attribute, you canthe buttons for creating or deleting newin the dropdown box should be displayed. Newentries in the dropdown box are only visible locally. This means that they can only be sby the person that created them.

If you set the indicato

provided. If you want to use your own Web template for display, enter this under the Web Template to Create New Entries for the Dropdown Box attribute (VIEW_DD_CREATE_TEMPLATE).



Keep filter values for query views If you set the indicator for this attribute, the

(VIEW_DD_RRI) filter values are kept when you swap query views in the dropdown box.

Keep settings for the affected Web item

(VIEW_DD_KEEP_SIZ

If you set the indicator for this attribute, the

E) settings for the affected Web item (width and size of the Web item, as well as number of data rows) are kept when you switch to another entry in the dropdown box.

Use all query views for a query

(VIEW_DD_

If you set the indicator for this attribute, all query views for a query are used as entries in USE_ALL_QUERY_VIEWS) the dropdown box.

ct the desired query as data provider. s for the List of Query Views

attribute are not used in this case.

First seleThe setting

Sort query views alphabetically

(VIEW_DD_SORT)

If you set the indicator for this attribute, the query views are sorted alphabetically in the dropdown box. Otherwise the query views are sorted according to the sequence of entries for the List of Query Views attribute.

Web template for creating new entries for the dropdown box

(VIEW_DD_CREATE_TEMPLATE)

Specify the technical name of the Web item to create new entries for the dropdown box using the create button. It only makes sense to set this attribute if you would like to have the create/delete buttons displayed (see Display Create/Delete Button).

You can find more information on the use and function of the Query View – Selection Web item under Query View - Selection [Extern].



Key Figure Overview Definition Web item [Seite 10] that displays a table containing important key figures for business from thecompo

nent Strategic Enterprise Management (SAP SEM).

Use The Web item Key Figure Overview provides the user with a selection of important keyfor business. For each key figure, the user has the option of navigating to the associated Web templates. The Web template shows the user the

figures

origin of the key figure (that is the query or query view).

SAs we

tructure ll as its General Attributes [Seite 12], the Key Figure Overview Web item also has the ing special attributes: follow

At b cription tri ute Des

Au m(A O

-

ure catalog. If this attribute is highlighted, the n

ntly transferred.

omatic personalization, general

r more information, see

to atic Personalization Using this attribute, you can enable automaticUT MATIC_PERSONALIZATION) personalization, that is a permanent user

specific selection of key figures from the key figselection of key figures that a user can makeusing the Display Key Figure Catalog functiocan be permane

To use autpersonalization must be activated in the system. FoPersonalization in BEx [Extern].

Custo(CUST_TEMPLATE_PREFIX)

ute contains the Web template prefix that should be positio n front of the

query or query view of

mer Web Template Prefix This attribned i

technical name of the the customer.

SAP Web Template Prefix (SAP_TEMPLATE_PREFIX)

This attribute contains the Web template prefix that should be positioned in front of the

f technical name of the query or query view osupplied by SAP.

RFC(SE

In this attribute you can store an RFC connection to an SEM system from which the Key Figure Catalog is read. The user (current user or fixed user) maintained in the RFC connection is used for the authorization check in the SEM system.

Connection SEM System M_RFC_DEST)

In the Strategic Enterprise Management (SAP SEM) component, only queries and query views are saved, not Web templates. The special attributes of the Web item are thus required to make the Web templates from the Web item callable. The



technical name of a Web template is made up of the following: Web template name= prefix + query/query view name.

er for the Web item Key Figure Overview is the Measure Builder (CPM-MB) of the

Key Figure Overview are defined in the Measure Builder and are put catalog.

sure Builder, P Financials →

documentation for Release SAP SEM-BW 3.50 (o Strategic Enterprise Management → Corporate Performanc(CPM-MB).

See also:

Function description Key Figure Overview [Extern]

Integration The data providSAP SEM component Corporate Performance Monitor (SEM CPM). The key figures that aredisplayed in the Web item together as a

For more information about the MeaCross Industry Solutions → mySAP

see the Internet under help.sap.com → SASAP Strategic Enterprise Management in ther in the SAP Library) under SEM – e Monitor (SEM CPM) → Measure Builder



Ad-hoc Query Designer Definition A Web item that enables you to create and chang d-hoc basis.

Use You can use the

e queries in a Web application on an a

Ad-hoc Query Designer Web item in Designer to structure Web applications in which you create or change qu m is as a tool for designing ad-hoc queries in a Web environment.

In particular it enables you to: • Create queries by assigning characteristics from a ,

and free characteristics, and including key figuresstructure of the query.

• Restrict or filter key figures and characteristics

• Use predefined key figure structures and restricte uery

• Set or change query properties and key figure/cha

• Create or change conditions and exceptions

When compared with the BEx Query Designer [Exte

the Web Application eries. The Web ite

n InfoProvider to rows, columns, filters from the InfoProvider in the key figure

d or calculated key figures in the q

racteristic properties in the query

rn], the Ad-hoc Query D esigner Web item has the following restrictions when creating or changing

• You cannot integrate variables into the query direc

However, you can use variables in reusable struct r restricted or calculate key figures, which are used in the Ad-hoc Query Desig

• The query can contain only one structure. This stand be in the rows or columns of the query.

− You cannot use key figures or key figure structures in the filter.

− You cannot define exception cells, since this requires two structures.

queries: tly.

ures, oner

ructure has to be the key figure structure

You cannot create the following objects using the Ad-hoc Query Designer Web item:

− Reusable structures

− Reusable restricted key figures

− Reusable calculated key figures

− Local calculated key figures You can create local, restricted key figures using the Ad-hoc Query Designer Web item.



You caadhere to the

n edit existing queries in the A s restrictions laid out abo

uirements when loading a query. loaded into the Ad-hoc Query Designreceive the appropriate message. Yo


d-hoc Query Designer Web item, if the querieve The Ad-hoc Query Designer checks these

If the query is too complex, the query can be er but you cannot change it there. You then u can still check and execute the query.

req

12], the Ad m has the following attributes:

Attributes Descr

-hoc Query Designer Web ite

iption

InfoProvider Name (INFOCUBE) Technstart t

Do l pty value cell next to the attribudialogthat yo om your history or from the co

ical name of the InfoProvider used to he Ad-hoc Query Designer.

ub e-click on the emte InfoProvider Name. The BEx Open box appears. Select the InfoProvider u want to use frmplete list under InfoAreas.

Name of Query (QUERY) Techn rt the Ad-ho

Doublattribubox aphistory e lis

ical name of the query used to stac Query Designer.

e-click on the empty value cell next to the te Name of Query. The BEx Open dialog pears. Select the query from your , favorites or roles of from the complet

t under InfoAreas.

Template for Output (TARGET_TEMPLATE_ID)

optional

Namequery

Doubl he attribu dialogfrom your hi

of the Web template used to display the result.

e-click on the empty value cell next to tte Template for Output. The BEx Open box appears. Select the Web template

story, favorites, roles, or the list of workbooks.

If you do not specify a Web template, the default Web template is used.

Frame for Query Output (TARGET_FRAME)

optional If you specify a frame, the query output is controlled within this fram Otherwise the query is displ

Prerequisites

You have creHTML editor

Frame in which the query is displayed when executed.

e.ayed in a new browser window.

for specifying a frame:

ated a frameset in an external or manually (in Notepad).



Action on Execution

(ON_EXECU

You can use this attribute to determine what Web

The following options are available:

The query is executed.

No change is made to the Ad-hoc Query Designer Web item.

• Item is hidden

The Ad-hoc Query Designer disappears when executing the query.

If you want to open the Ad-hoc Query Designer again, while using the standard Web template, click on

TE) happens to the Ad-hoc Query Designer item in the Web Application after clicking on the Execute pushbutton in the Ad-hoc Query Designer.

• No change to the item

in the symbol toolbar.

If you are using a different Web template, you need to install the option of calling up the Ad-hoc Query Designer again manually in the Web template.

• Item is collapsed

The Ad-hoc Query Designer is collapsed when executing the query. You now see the Web item with a collapsed arrow and title.

If you want to open the Ad-hoc Query Designer again, use the arrow to open it.



Ac

(O

You can use this attribute to determine what happens to the Ad-hoc Query Designer Web item in the Web Application after clicking on the Close pushbutton in the Ad-hoc Query Designer.

During closing the query is closed in the

characteristics) are now empty. There is no change to the Web item itself.

The Ad-hoc Query Designer disappears when closing.

in the

tion on closing

N_CLOSE)

The following options are available:

• No change to the item

Ad-hoc Query Designer. The individual fields (rows, columns, filter, free

• Item is hidden

If you want to open it againstandard Web template, click on in the symbol toolbar.

of

again manually in the Web template.

collapsed

psed Web

uery Designer again, use the arrow to open it.

If you are using a different Web template, you need to install the optioncalling up the Ad-hoc Query Designer

• Item is

The Ad-hoc Query Designer is collawhen closing. You now see the item with a collapsed arrow and title.

If you want to open the Ad-hoc Q

Display Data Provider (DISPLAY_DATA_PROVIDER) te

d it.

ouble-click on an empty l next to the Data Provider Display

wn box containing a list of

optional

Data provider through which you want to display the query in the current Web templaafter you have execute

Specify the name of the DataProvider with which you want to display the query in the Web template. When you dvalue celattribute, a dropdothe data providers available appears.

If you specify DISPLAY_DATA_PROVIDER but not TARGET_FRAME or TARGET_TEMPLATE_ID, when you execute the query the display data provider specified is replaced in the current Web template.



If you do not specify the optional attributes DISPLAY_DATA_PROVIDER,

RGET_FRAME and TARGET_TEMPLATE_ID, the query results are displayed in ew browser window in the Standard Web Template for Ad-hoc Analysis [Extern]

TAa n .

Integration You can work with all queries in the BEx Query Designer, regardless of the tool with which they were created.



ABC ClassificatioDefinition The ABC Classification

n

web itemEmployees) based on a particular m For further information, see ABC Class tion [Extern]

allows you to classify objects (Customers, Products or easure (Revenue or Profit) using certain classification rules.

ifica and Using ABC Classification in Web Applications [Extern].

This web item supports only the old applicable to the results of transform ssification in the Analysis Process Designer.

The ABC Classification web item has the following specific attributes:

Attributes D

data mining models in the Data Mining Workbench. It is not ation of ABC Cla

Structure

escription

ABC_NAME (optional) N

Tu

If you do not enter a model name, a drop down box containing the names of all the models that are ready for pi

ame of the ABC Classification

he name of the ABC Classification model that would be sed.

rediction in the selected service would appear in the web tem.

SHOW_ABC_CLASSIFICATION

"X" = Yes, " " = No

S

Specifies whether the drop down box for selecting ABC C displayed in the web item.

TC therwise, it will not have any effect.

how ABC Classification

lassification should be

his option is relevant only if you have specified the ABC lassification. O

SHOW_STAT

"X" = Yes, " " = No

D

S the selected ABC Classification should be displayed in the web item.

isplay Statistics

pecifies whether statistical information about

SHOW_CHART

"X" = Yes, " " = No

D on Chart

d art in the web item.

isplay ABC Classificati

Specifies whether the selected ABC Classification should beisplayed as ch

SHOW_MODEL D

S (which Info Object is classified b h Query) about the selected A .

"X" = Yes, " " = No

isplay Model Name

pecifies whether meta data y which key figure from whicBC Classification should be displayed in the web item



What If Prediction Definition The What If Prediction web item enables you to perform online prediction for a single customer

efined under services such as Decision Tree, Scoring and Clustering. For Executing What If Prediction Analysis [Extern]

record on models dmore details, see and Using What If Prediction in Web Applications [Extern].

Use The prediction for prospect

n a cuive customer behavior

stomer applies for a loan, rtain attributes such as income

em has the following specific attributes:

escription

is based on specific attributes of that customer. you can predict if the customer is creditworthy , profession or transaction history.

For example, wheor not, based on ce

Structure The What If Prediction web it

Attributes D



MODEL_NAME (optional) Name of the The name of prediction. If you do not containing th e ready for prediction in th e item. If you specify acorresponding servi ill be generated.

mining model the model that would be used to perform the

enter a model name, a drop down box e names of all the models that ar

e s lected service would appear in the web

model name, but do not specify the ce name to which it belongs, an error w

SERVICE_NAME (optional) Name of the serviThe name of the servi If you do not enter the

If you specify the service name and the model name, then the web item will be for that particular service and model

odel ervice.

odel from the drop down

ce ce for the web item.

the service name, you can chooseservice from a drop down box containing the list of services that support What If Prediction.

only. If you specify the service name but do not specify the mname, then the web item will be published for that sYou can choose the name of the mbox.

DISPLAY_MODEL "X" = Yes, " " = No

Display Model Name

Specifies whether the model name should be displayed in the web item.

is relevant only if you have specified the model name. Otherwise, it will not have any effect.

This option

DISPLAY_SERVICE

" = Yes, " " = No

Display Service Name Specifies whether the service name should be displayed in the web item. This option is relevant only if you have specified the service name.

"X

DISPLAY_CHART_OPT

"X" = Yes, " " = No

Display Chart Customize

Specifies whether the option to customize the what if prediction analysis chart must be displayed or not.



Web Template Properties Definition Web Item that is used to determine the properties of a Web template.

Structure The Web item Web Template Properties has the following general attributes:


Status-free navigation The status is removed on the server after each navigation step. Only recommended with STATELESS pages that are rarely navigated to.

Use personalized template, if available If available, a personalized Web template is

USE_PERSONALIZATION used.

Do not display system messages System messages are not displayed.

SUPPRESS_SYSTEM_MESSAGES

Do not display warnings Apart from error messages, warnings are not displayed. SUPPRESS_WARNINGS

For n display

EN

The variable screen display is forced. Otherwise the variable screen is only displayed if mandatory variables have not been filled. Also see Object Tag for Properties of Web

ce variable scree

VARIABLE_SCRE

Templates [Seite 125].

Reset variables to default values

VARIABLES_

Variables are reset to default values. Also see Object Tag for Properties of Web Templates CLEAR [Seite 125].

Display sam

s are only displayed once. Also see Object Tag for

e variables only once The same variables for different querie

MELT_VARIABLES Properties of Web Templates [Seite 125].

Open dialogs in new windows

ENABLE_OPEN_

Dialogs are displayed in new windows. Also see WINDOW

Object Tag for Properties of Web Templates [Seite 125].

Read mode for data

ODE

With this attribute you determine the read mode for data. Also see Object Tag for DATA_M Properties of Web Templates [Seite 125].

Output optimization (device-dependent)

OPTIMIZATION

Automatic device-dependent optimization of Web item settings for runtime (chart size for PDAs, for example). DEVICE_

Session encoding in the URL

O_SESSION_COOKIE)

Session encoding in the URL, instead of by cookie. Each application runs in its own session. Also see Object Tag for Properties of (N

Web Templates [Seite 125].



Autom

(USE_

re automatically released on the n you leave the page. See Web

atic session management

PAGE_WRAPPER)

Resources aserver wheTemplate Properties [Extern].

Show jump target in

RI_DISPLAY_TARGET)

With this attribute you are able to control Report/Report Interface jumps:

• When the standard setting is selected (menu bar RRI), the jump takes place in a window with a menu bar.

If you do not make an entry, the jump ce using a new window.

u specify a frame name, the jump e in this frame.

• If you enter the name of a window, the jump takes place in this window.

(R

• takes pla

• If yotakes plac

As well as the general attributes, you are also able to determine entries for the context menu. Also see Modifying the Context Menu [Seite 132] on this.

From f Web template properties. This means that yo Web item in a library in the Web Application Desig ss Information Warehouse → Repor ermining Settings for Web Temp nden.

em Web Template Properties is not listed in the Web item tree in the Web Application

lso:

eb Template Properties [Extern]

Integration a technical perspective, a Web item is made up ou can also save the Web Template Properties

ner, and reuse them in SAP Reference IMG → Busineting-Relevant Settings → Web-Based Settings → Detlates → Template Properties. Eigenschaften wiederverwe

The Web itDesigner.

See a

W

Working with the Library for Web Items [Extern]

Overriding Attributes [Seite 121]



Web Templates Definition

A Web template determines the structure of a Web application. You use the Web ApplicationDesigner to insert placeholders into a HTML document for Web items [Seite 10] (in the form of object tags [Seite 124]), data providers [Seite 142] (in the form of object tagsHTML document with the BW-specific placeholders is called a Web template. We

) and BW URLs. The b templates are

r

ms

checked into the Web Application Designer. The HTML page that is displayed in the Internet browseis called a Web application. Depending on which Web items you have inserted into the Web template, a Web application contains one or more tables, an alert monitor, charts, maps, and so on.

Structure The Web template is the keystone of a Web application. It contains placeholders for Web iteand command URLs [Seite 145]. Data providers, Web items, and command URLs are generated for Web applications.

In the Web template, you determine from which data provider and it what way (Web items) the BW data is displayed. You also determine which additional options there are (BW URLs).

When a request is sent from a Web application to the SAP Web Application Server, a template object is generated. The structure of the requested HTML page is derived from this object. The following objects are generated on the basis of this template:

• Data Providers

• Web Item

Integration As of BW 3.0, Web templates are stored on the SAP Web Application Server.

The option to store Web templates (for BW 2.0B or BW 2.1C, for example) on the ITS is still possible. We recommend, however, that you use the SAP Web Application Server.

Example The following is an example of a simple Web template with a navigation block [Seite 32] and a table [Seite 16]:

< d>

link rel="stylesheet" href="Bex/StyleSheets/BWReports.css">

</hea

<body>



<object>

<html>

hea

<

<title>New Page 1</title>

d>



<param name=’OWNER’ value=’SAP_BW’> <param name='CMD' value='SET_PROPERTIES'> <param name='VARIABLE_SCREEN' value='X'> <param name='USE_PERSONALIZATION' value='X'>

</object>



<object>

<param name=’OWNER’ value=’SAP_BW’> <param name=’CMD’ value=’SET_DATA_PROVIDER’> <param name='DATA_PROVIDER' value='View1 > <param name='DATA_PROVIDER_ID' value='VIEW1'> DATA_PROVIDER :View1

</object>



<object WIDTH=”350”>

<param name=’OWNER’ value=’SAP_BW’> <param name=’CMD’ value=’GET_ITEM’> <param name=’ITEM’ value=’Nav Block’> <param name='ITEM_ID' value='NAVBLOCK'> <param name='DATA_PROVIDER' value='View1 > ITEM :Nav Block

/object>

<br>



<object WIDTH=”600”>

<param name=’OWNER’ value=’SAP_BW’> <param name=’CMD’ value=’GET_ITEM’> <param name='ITEM' value='Table'> <param name='ITEM_ID' value='TABLE'> <param name='DATA_PROVIDER' value='View1 > ITEM :Table

</object>

</body>

<



Overriding Attributes

sequence

g in Web Template -> Library Web Item -> System Default

Exam f ints) for the Web item Table

Use All attributes for Web items and all Web template properties can be overridden. At the time of execution, the respective attribute value is specified for Web items, corresponding to the

URL->Object Ta

of the corresponding attribute value. This is likewise valid for the Web template properties. Herethe specification occurs, corresponding to the sequence

URL-> Web Template Properties -> Library Web Item -> Web Template Properties defined in Customizing for the Business Information Warehouse under Web-based Settings -> System Default.

ple o the Web item attribute WIDTH (Width in Po

URL Parameterization

WIDTH = ‘600’

Web Item in Web Template

WIDTH = ‘500’

Library Web Item WIDTH = ‘400’

WIDTDefault

H = ‘300’

Example of Web template property SUPPRESS WARNINGS



SUPPRESS_WARNINGS = ‘X‘URL Parameterization

SUPPRESS_WARNINGS = ‘ ‘Web Template

SUPPRESS_WARNINGS = ‘ ‘

SUPPRESS_WARNINGS = ‘X‘

XLibrary Web Item SUPPRESS_WARNINGS = ‘X‘

Web TemplatePr perties inCustomizing

X

o

X

Default

General Rules for Overriding Setting

s

priority rules when overriding settings of the Web template bute.

The following graphic shows the properties and the Web item attri

SAP Standard

Library Settingfor Web Item Attribute

Customizing Settingfor Web Template

Properties

Settings forWeb Template Properties

URL Parameterization URL Parameterization

Web Template Properties W

Template

SAP Standard

Template Settings forWeb Item Attributes

eb Item Attributes

Library Setting for Web Template Properties





Object Tags Definition By using object tags, you can determin s of Web templates, create data provider and

te, and sup se object tags are created in

t tags are h object is replaced in

plate. All other types of obj

ould be

ner' value='SAP_BW'> value='350'>

...

o

' o

t is not su

ags are also displayed in non-HTML code mode in many HTML editors. Some HTML of changing the size, and maintaining the attributes of the object

rag and drop function to move the object tags around a

important role in BEx Web Applications:

Tag for Properties of Web Templates [Seite

e propertieWeb items in a Web templathe Web Application Designer.

ply them with attributes. The

Structure An object tag starts with “<object...>” and endsidentified by the attribute “owner” and tthe Web tem

with “</object>”. The SAP_BW objece value “SAP_BW”. Only this type ofect are transferred unchanged into the Web application.

Attributes for BW object tags sh<object>

set within the object tag in the form of a parameter tag.

<param name='ow <param name='WIDTH'

</object>

In runtime, however, attributes can als be set in the object tag at the beginning:

<object WIDTH='350' HEIGHT='234

This is not recommended as i

wner='SAP_BW' ...></object>

pported in the Web Application Designer.

Object teditors also give you the optiontag. It is usually possible to use the dpage.

The following object tags play an

Object 125]

Object Tag for Data Provider [Seite 142]

Object Tag for Web Items [Seite 144]



Object Tag for the PDefinition Object Tag for defining the properties of Web templates.

Use The attributes of a Web template can b ed in an object tag. In addition to the Web template attributes listed below, all of the context menu prbe transferred with URL when calling up t W

roperties of Web Templates

e definoperties also belong. These properties can also

he eb template.

Parameter 'CMD' must be set toattributes of the Web template.

Attributes Descr

'SET_PROPERTIES' to indicate that these are the

iption

TEMPLATE_ID Na e

NameApplic

m of the Web template

under which you stored the Web template in the Web ation Designer.

STATELESS (optional)

‘X’ = Yes, ‘ ’ = No

Statu

For W lay without furtheThe stempla

s-free navigation

eb templates that are used almost exclusively for dispr navigation, it is more useful to set the attribute STATELESS. ession on the application server is terminated when the Web te is created. This saves resources on the application server.

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

USE_PERSONALIZATION (optional)

'X' = Yes, ' ' = No

Use pe

If th currentemplawithou

rsonalized Web template, if available

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

STYLE_SHEET (optional)

to template.

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

This overwrites any stylesheet that you may have already assignedthe Web

Example for a path specification:

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



JAVASCRIPT (optional)

’X’ = activate, ‘ ’ = do not activate

Us g

ed vaScript (extensive interaction options) or suppress the use of

in JavaScript

Using this parameter, you ensure that Web applications are creatusing JaJavaScript (restricted interaction).

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

SNIPPET_OPERATIONS (optional)

d objects are rowser

requirements. For this reason, this function is only supported by MS Internet Explorer version >=5.0.

’X’ = activate, ‘ ’ = do not activate You use this attribute to control whether only changeloaded in navigation. This function has higher Web b

Reload changed components of the page

If automa

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

ENABLE_OPEN_WINDOW (optional)

Open dialogs in ne

Using this attribute, you caate, ‘ ’ = do not activate

w windows

n control whether a new browser window is opened, for example, for the properties dialog box or for filtering. If this

pecified, new windows are opened (if supported by the ’X’ = activ

attribute is not sWeb browser).

VARIABLE_SCREEN (optional) Force variable s

‘Xd

’ = activate variable screen, ‘ ’ =

creen display

If you call up a Web template that has query views containing

r set it to ‘ ver, it is still

ady for input have not yet been filled.

o not activate, if possible variables that are ready for input, you can use these attribute to display the variable screen. If you do not set this attribute, o’, the variable screen is hidden, wherever possible. Howeshown if, for example, the required variables that are re

MELT_VARIABLES ( top ional)

‘ ’ = display each query

Display same variables only once

The same ifferent queries are only displayed once.

If you call uery views that have variables that screen display, yo parameters, whether variables, ame context (same com t only once.

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

‘X’ = merge,individually

variables for d

up a Web template containing several q are ready for input and you go to the variable

u can determine, through these which are used in all query views and in the spounding, same initial value), are to be provided for inpu



VARIABLES_ AR (optional)

‘X’ = reset va

Reset variables to default values

ery views cify this

attribute to reset the default variables through the query view. les have the default settings from the variable

CLE

riable, ‘ ’ = do not reset If you call up a Web template that contains one or more quthat have variables that are available for entry, you can spe

Afterwards, the variabdefinition.

SUPPRESS_WARNINGS

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

Do not dis s

With this a erminations are still displayed.

(optional) play warning

ttribute, warnings are not displayed. T

SUPPRESS_SYSTEM_ME(optional)

SSAGES

tem

'CONDITIONAL' = only display system messages for the user once

Do not dis

With this a ot displayed.

If you assi ges are only displayed

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

play system messages

ttribute, system messages are n

gn the value ‘CONDITIONAL’, system messaonce a day for each user.

a day.

DATA_MODE (optional)

urrent data

‘STORED’ = Use precalculated data

‘HYBRID’ = use precalculated data; his is

‘STATIC’ = use pre-calculated HTML pages

-ere are

none, search for pre-calculated data; if nothing found, request current data.

Read mod

If you do n is without exception sent to the OLA is read.

For the mo calculated using the Re

‘NEW’ = use c

request current data if tmissing.

‘STATIC_HYBRID’= use precalculated HTML pages. If th

e for data

ot specify this attribute, a requestP processor and the current data

di ‘STORED’ and ‘HYBRID’, data has to be preporting Agent [Extern].

See Defini plates Setting [Extern]ng the Web Tem .

DEVICE_OPTIMIZATION Output op

By selectin bute, you bring about an automatic, device-specific op t runtime (for example, chart size f

timization (device-dependent)

g this attritimization of Web item settings aor PDAs).



NO_SESSION_COOKIE

‘X’ = ‘ = no

Session encoding in the URL, instead of by cookie. Each Web

ession for a stateful BEx Web Application. This can lead to possible problems; however, you can eliminate these with the help of this attribute.

session encoding in the URL, ‘ session encoding in the URL

application runs in its own session.

A cookie is used by default to manage the s

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

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

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

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

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

USE_PAGE_WRAPPER

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

Automatic session management

If you select this attribute, the resources are automatically released to the server. You can find additional information about this attribute under Web Template Properties [Extern].



RR

Sta

mp target in

ute you can control the RRI jump from the context menu.

When the standard setting is selected, the RRI jump takes place in a

lace using a new window.

I jump takes place in this frame.

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

I_DISPLAY_TARGET

ndard setting: menu barRRI

• Show ju

With this attrib

window with a menu bar.

If you do not make an entry, the RRI jump always takes p

If you enter a frame name, the RR

Also see Web Template Properties [Seite 117] and Properties of a Web Template [Extern].

Examples The Web template should appear with variables entry <object>

<param name=’OWNER’ value=’SAP_BW’> me='CMD' value='SET_PROPERTIES'>

EEN' value='X'>

nhanced me

<param na <param name='VARIABLE_SCR</object>

Context menu should not contain an e nu <object>

<param name=’OWNER’ value=’SAP_BW’> me='CMD' value='SET_PROPERTIES'>

D' value=' '>

ional attributes for setting data rs / Web items in conjunction with command URLs for calling up Web templates. However, ar statically in the object tag. The index in the parameter is indicated in the

Description

<param na <param name='MENU_ENHANCE

</object> The following, addit providers or special data provideare usually set onlythey can also appefollowing by '_I'.

Displaying a query

Attributes

INFOCUBE Technical name of the InfoProvider

QUERY Technical name of the query

VARIANT (optional) Variant, if you are not required to enter a variable.

Display of another query view

cription Attributes Des

DATA_PROVIDER_ID Technical name of the saved query view




The attributes PAGEID and WBID th

emplates created under BW 2.

vider ini

Attributes

at are used in BW 2.x are supported for the x. However, we recommend that you no longer

tialization

Description

Web tuse these.

Attributes for overwriting the data pro

SET_DATA_PROVIDER_I Logical name of the data provider

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

INFOCUBE_ I (Option 1) Technical name of the InfoProvider

QUERY_ I (Option 1) Technical name of the query

DATA_PROVIDER_ID_ I (Option2) Technical name of the saved query view


Attributes for overwriting the Web item initialization

Description Attributes

SET_ITEM_I Logical name of the Web item

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

ITEM_ID_I (Option 1) Web item ke

A Web item i mplate on e basis of a Web item setting made in the

cation Designer.

y

s created for a Web tethWeb Appli

ITEM_CLASS_I (Option 2) Class name of the Web item class

Name of the ABAP object class that output generation transfers. This corresponds to the use of non-reusa dard Web items) in the eb items are cre alues for the attribute.

CL_RSR_WWW_ITEM_GRID for example.

ble Web items (stanWeb Application Designer. Wated with the default v

The class name for the table is



Adjusting and Enhancing the Context Menu

created automatically for table cells to your company-

ns of the enhanced context menu to the context menu that is not enhanced

ate your own context-specific entries in the context menu.

u [Seite

Use You can adjust the context menu that isspecific needs and scenarios.

You can copy functioor you can hide functions.

You can also integr

Functions The following options are available:

Adjusting the Context Men 132]

Enhancing the Context Menu [Seite 139]



Adjusting the Context Menu

E_SCREEN, you can also modify the context menu for a in the menu on or off or pl .

ntext menu are listed in the following list of attributes:

Use Along with properties such as VARIABLWeb template. You can turn every entry ace it in the Enhanced Menu

Features All entries in the co

Menu entries that are not specified retain their default value. The default values are underlined in the list


Back

(MENU_BACK)

‘ ’= Not displayed

‘X’= “Always Display” in the basic menu

u”

Menu entry: “Back” Undo one navigation step on a data provider

‘E’= Displayed in the “enhanced men

Back to start

(MENU_BACK_TO_START)



nu”

Menu entry: “Back to Start” Undo all navigation steps on a data provider

‘E’= Displayed in the “enhanced me

Keep filter value

(MENU_FILTER)



Menu entry: “Keep Filter Value”

‘E’= Displayed in the “enhanced menu”

Keep filter value on axis

(MENU_FILTER_ON_AXIS)




Menu entry: “Keep Filter Value on Axis”



Select Filter Value

(MENU_SELECT_FILTER)




Menu entry: “Select Filter Value”

Keep Filter Value on Axis for Diagram

HART) (MENU_FILTER_ON_AXIS_C




Menu entry: “Keep Filter Value on Axis for Diagram” When considering diagrams, it is often more useful to use the command “Keep Filter Value on Axis” than it is to keep the filter, which is removed when you drilldown. The geometry of the list remains the same and the chart/or map

separate settings for these Web items. can still be interpreted. Therefore, there are

Keep Filter Value for Diagrams

HART)

d in the “enhanced menu”

(MENU_FILTER_C



‘E’= Displaye

Menu entry: “Keep Filter Value” for Diagrams When considering diagrams, it is often more useful to use the command “Keep Filter Value on Axis” than it is to keep the filter, which is removed when you drilldown. The geometry of

and the chart/or map d. Therefore, there are these Web items.

the list remains the same can still be interpreteseparate settings for

Filter and Drilldown According to

enu

(MENU_FILTER_DrILL_DOWN)


‘X’= “Always Display” in the basic m

Menu entry: “Filter and Drilldown According to”


Drilldown According to

(MENU_DRILL_UP)



nced menu”

g to”

‘E’= Displayed in the “enha

Menu entry: “Drilldown Accordin

“Drilldown” with the exception of

navigation in maps.

Drilldown According to in Context of Map

u

(MENU_DRILL_UP_GIS)


‘X’= “Always Display” in the basic men

Menu entry: “Drilldown According to” in Context of Map


“Drilldown” in the context of navigation in maps.



Insert Drilldown According to

(MENU_DRILL_DOWN)




Menu entry: “Insert Drilldown According to”

Swap ... with ...

(MENU_EXCHANGE_OBJECTS)




Menu entry: “Swap ... with ...” Swap characteristics or structures.

Remove drilldown

(MENU_REMOVE_DRILL_DOWN)




Menu entry: “Remove Drilldown”

Swap Axes

(MENU_SWITCH_AXIS)




Menu entry: “Swap Axes”

Expand/Collapse Hierarchy Nodes

ODE_DRILL) (MENU_HIERARCHY_N




Menu entry: Expand/Collapse Hierarchy Nodes

Expand Hierarchy

(MENU_HIERARCHY_DRILL)

play” in the basic menu

anced menu”


Menu entry: “Expand Hierarchy

‘X’= “Always Dis

‘E’= Displayed in the “enh

”

(De)activate Hierarchy

(MENU_HIERARCHY_STATE)

‘ ’= No

‘X’= “A

t displayed

lways Display” in the basic menu

isplayed in the “enhanced menu” ‘E’= D

Menu entry: “(De)activate Hierarchy”



Sorting

ENU_SORT)

’= Not displayed


(M

‘


Menu entry: “Sort” Sort by characteristic cells and data cells.

Calculate result as...

(MENU_CALCULATE_RESULT)




Menu entry: “Calculate Result as” Calculations for value cells.

Calculate single values as...

(MENU_CALCULATE_VALUE)




Menu entry: “Calculate Single Values As...” Calculations for value cells.

Cumulated

(MENU_CUMULATE_VALUE)




Menu entry: “Cumulated” Calculations for value cells.

Displaying Documents

(MENU_DISPLAY_DOCUMENTS)




Menu entry: “Display Documents”

Create Document

(MENU_DOCUMENT_CREATE)




Menu entry: “Create New Document”

Show/Hide Document Properties

(MENU_DISPLAY_DOCUMENT_PROP)




Menu entry: “Show/Hide Document Properties” In the context of the Web item List of Documents.



Sho

(M

displayed

w/Hide Document Selection Criteria

ENU_DISPLAY_DOCUMENT_SELEC)

‘ ’= Not



Menu entry: “Show/Hide Document tion Criteria” context of the Web item List of

Documents.

SelecIn the

Report/Report Jump Targets

(MEN

‘ ’= o

U_RRI)

N t displayed



Menu entry: For report/report jump targets

Export as …C

(MENU_EXPO

SV File

RT_TO_CSV)

s Display” in the basic menu


‘X’= “Alway

anced menu”

Menu entry: “Export as... CSV File”


Export as ... MS Excel 2000 File

(MENU_EXPORT_TO_XLS)



nced menu”

Excel 2000 File”

‘E’= Displayed in the “enha

Menu entry: “Export as ... MS

Bookmark

(MENU_BOOKMARK)



anced menu”

kmark”


Menu entry: “BooCreate bookmarks.

Bookmark with Displayed Data


(MENU_BOOKMARK_WITH_DATA)


‘X’= “A

ced menu”

data is displayed.

‘E’= Displayed in the “enhan

Menu entry: “Bookmark with Displayed Data” Create bookmark with the current data. When you call up the bookmark later, the “historical”

Personalize Web Page

(MENU_PERSONALIZE)



Menu entry: “Personalize Web Page”




Display Charactieristic Properties

ENU_CHARACTERISTIC_PROPERTIES)




(M

Menu entry: “Display Characteristic Properties” Properties for characteristic cells.

Value Cell Properties

(MENU_VALUE_PROPERTIES)



hanced menu”‘E’= Displayed in the “en

Menu entry: For value cell properties Properties for value cells.

Query Properties

the basic menu

u”

(MENU_QUERY_PROPERTIES)


‘X’= “Always Display” in

‘E’= Displayed in the “enhanced men

Menu entry: “Query properties”

Display variable screen Menu entry: For calling up variables screen Variable entry call up if there are queries havevariables in the Web Application.

(MENU_VARIABLE_SCREEN)



the “enhanced menu”‘E’= Displayed in

Currency translation

URRENCY_CONVERSION)

‘X’= “A

‘E’= D

(MENU_C



isplayed in the “enhanced menu”

Menu entry: “Currency Translation” Calls up the currency translation dialog box.

Enhan

(MEN _

‘ ’= No

‘X’= “A

ced Menu

U ENHANCED)

t displayed


Menu entry: “Enhanced MenDisplay optiocontext menu.


u” n for entries in the enhanced

ENHA

‘ ‘ = S

NCED_MENU

tart with basic menu

tart with enhanced menu

Start with Enhanced MeYou decide here whether ththe basic menu (standard seenhanced m‘X’ = S

nu e page opens with tting) or the

enu.

Examples For th enu and the currency is example, Swap Axes appears in the basic context mtransl ta ion is completely hidden.



<objec >

lue=' '>

t

<param name='OWNER' value='SAP_BW'> <param name='CMD' value='SET_PROPERTIES'> <param name='MENU_SWITCH_AXIS' value='X'> <param name='MENU_CURRENCY_CONVERSION' va

</object>



Enhancing the Context Menu Use As well as being able to make entries in the context menu visible, entries in the enhanced menu

ntries in the enhanced menu invisible, you can also hang scenario-specific entries in u. You have two options:

dd the new entries to the menu using the JavaScript function.

this section.

s, you have to write a nction that transfer cessing when you Command Processing [Seite

visible or ethe men

• You define the new entries using the Web Template Properties object tag.

• You a

The first way is described in

In both case JavaScript fu s the proselect the menu entry. You can find out more about this under 248].

atures New entries are defined using dif Wfollows:

Attribute ption

Feferent series of attributes in the

Descri

eb template properties as

CMENU_LABEL_I t inLabeling tex the menu

CMENU_FUNCTION_I ript funccommand

You implement t ipt and execute

men

JavaSc tion for processing the

his function in JavaScruse it toselected the

commands after you have u entry.

CMENU_PARAMETER_I Free parameter

is pfunction 'CMENUevaluated there he attribute

possibl menu e

This attribute assed to the JavaScript _FUNCTION' and can be

as required. Tmakes itthan one

e to use a function for more ntry.

CMENU_CELL_TYPE_I

‘ ’ = No restriction

= Characte

‘CHARACTERISTIC_VALUE’ = Cvalue

‘STRUCTURE’ = Structure

‘STRUCTURE_VALUE’ = Structuvalue

‘DATA’ = Data cell

‘EXCEPTIONS’ = Exceptions item

ns item

'DOCUMENT_LIST' = Document

Context of the e

If you want the mcertain contexts and not in s,

th er’. ‘CHARACTERISTIC’ ristic

haracteristic you can define

re component

‘CONDITIONS’ = Conditio

list item

ntry

enu entry to appear only in all context menu

is with ‘cell_type’ and ‘filt



CMENU_FILTER_I

the entry

the value of ‘cmenu_cell_type’,

UE’, ‘STRUCTURE’, E_VALUE’: Iobjnm

S’: Exception ID

ID

‘DOCUMENT_LIST’: Document ID

Context of

According to different values are useful here:

‘CHARACTERISTIC’, ‘CHARACTERISTIC_VAL‘STRUCTUR

‘EXCEPTION

‘CONDITIONS’: Condition

See Examples.

CMENU_VISIBILIT

‘ ’= Not displaye

‘X’= Displayed in the

‘E’= Displayed i e

Visibility of the entry

so in the enhanced menu.

Y_I

d

“basic menu”

You specify whether the entry is to appear in the basic menu or al

n th “enhanced menu”

CMENU_POSITION_I

‘TOP’ = Before the “normal” entries

e “normal” entries

Position of the entry

The entries are inserted in the order in which they were called up. You can choose whether the entry is to appear before the “normal” entries or after them in the menu. You cannot

ion the entries in between the “normal”

‘BOTTOM’ = After th

positentries.

Examples .

<object>

n customer cells

aram name=’OWNER’ value=’SAP_BW’> S'>

ils'> enuProcessor'>

STIC_VALUE'> USTOMER'>

IBILITY_1' value='X'> aram name='CMENU_POSITION_1' value='TOP'>

Menu entry at the end for IT homepage

<param name='CMENU_LABEL_2' value='Customer details'> <param name='CMENU_FUNCTION_2' value='myMenuProcessor'> <param name='CMENU_PARAMETER_2' value='2'> <param name='CMENU_VISIBILITY_2' value='X'> <param name='CMENU_POSITION_2' value='BOTTOM'>

// Menu entry at the beginning and only on material groups

<param name='CMENU_LABEL_3' value='Materials'> <param name='CMENU_FUNCTION_3' value='myMenuProcessor'>

// Menu entry at the beginning and only o

<p <param name='CMD' value='SET_PROPERTIE <param name='CMENU_LABEL_1' value='Customer deta <param name='CMENU_FUNCTION_1' value='myM <param name='CMENU_PARAMETER_1' value='1'> <param name='CMENU_CELL_TYPE_1' value='CHARACTERI <param name='CMENU_FILTER_1' value='0C <param name='CMENU_VIS <p

//



<param name='CMENU_PARAMETER_3' value='3'> ='CHARACTERISTIC_VALUE'>

'0MATGROUP'> e='X'>

name='CMENU_POSITION_3' value='TOP'>

You can find an example implementation for the JavaScript function “myMenuProcessor” under ript [Seite

<param name='CMENU_CELL_TYPE_3' value <param name='CMENU_FILTER_3' value= <param name='CMENU_VISIBILITY_3' valu <param

</object>

JavaSc 237].



Object Tag for Data Provider Definition

Object tag for creating Data Providers (BW-BEX) [Extern].

Use The attributes that you need for creating a data provider are available in the Web Application Designer.

Data provider properties

Attributes Description Notes

DATA_PROVIDER ( or Name )

Logical namprovider

e of the data

provider. The name must be unique within the Web

This name is used to attach Web items to a particular data provider and to send commands to the data

template [Seite 119]. Adhering to these conventionfacilitates the upgrade to future SAP releases

SAP recommends that you keep to the conventions

y the Web esigner when

ames: The name

characters long and consist of characters “A-Z”, “0-9” and “_”. It cannot start or end with “_”.

s

.

supported bApplication Dspecifying nshould be a maximum of 30

DATA(optio

this mand URL

_PROVIDER_ID nal)

Key for a query view You cannot changeattribute with a com [Seite 145].

QUERL

Y (optional) Technical name of a query You cannot change this attribute with a command UR [Seite 145].

INFOC Technical name of the This attribute is necessary if the QUERY attribute is specified. You cannot change this attribute with a command

UBE (optional) InfoProvider

URL [Seite 145].

VARIAfill the variables

the current variable values are

ecifying a variant (optional). u create variants on the

attribute with a command URLNT (optional) Name of the variant used to You cannot change this

When you save a query view,

saved with it. You can overwrite the values by

[Seite 145].

spYovariables screen.

HOME tional) Name of the main frame

If you use HTML frame

and you want to display the F4

_FRAME (op

technology to display the data,



Help in a separate frame to the Web template, for query views, you have to specify in the HOME_FRAME attribute, the name of the frame where the Web template is displayed. You also have to specify the attribute TARGET_HELP_FRAME for the navigation block Web item.

• The attributes VIE

2.x are still supporWID and WBID (DATA_PROVIDER_WBID) used in BW ted. However, we recommend that you no longer use

TA_PROVIDER’ to indicate that you are creating a data provider

vider before calling up the page.

’SAP_BW’> lue=’SET_DATA_PROVIDER’> ROVIDER' value='View1 >

VIDER_ID' value='VIEWABC'>

Query<o c

<param name=’OWNER’ value=’SAP_BW’> <param name=’CMD’ value=’SET_DATA_PROVIDER’> <param name='DATA_PROVIDER' value='View1 > <param name='DATA_PROVIDER_ID' value='VIEWABC'> <param name=’FILTER_IOBJNM’ value=’0COUNTRY’> <param name=’FILTER_VALUE’ value=’US’> DATA_PROVIDER :View1

</object>

these.

• The ‘CMD’ parameter has to be filled with the ‘SET_DA

• You can add additional attributes, for example, in order to send a command to the data pro

Examples Create query view <object>

<param name=’OWNER’ value= <param name=’CMD’ va <param name='DATA_P <param name='DATA_PRO DATA_PROVIDER :View1

</object>

view filtered by country (USA) bje t>



Object Tag for Web Items Definition

a Web item are available in the Web Application can add additional attributes to adjust the size at a later point, or to set a title, for

Object tag for creating a Web item.

Use The attributes that you need for creating Designer. You example.

The parameter ‘CMD’ has to be filledcreating a Web item.

Example Creating a Web Item

with ‘GET_ITEM’ to indicate that you are

<object>

<param name=’OWNER’ value=’SAP_BW’><param name=’CMD’ value=’GET_ITEM’

<param name='ITEM' value='NavBlock'> <param name='ITEM_ID' value='NAVBLO <param name='DATA_PROVIDER' value

ITEM :Nav Block

</object>

Creating a Web item with height 400 pixels, wi the title “Business

>

CK'> ='View1 >

dth 500 pixels, andGraphic”

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

> e='View1 >

<param name=’GENERATE_CAPTION’ value=’X’> <param name='CAPTION' value='Business Grafik'> ITEM :Chart 1

</object>

<param name=’OWNER’ value=’SAP_BW’> <param name=’CMD’ value=’GET_ITEM’> <param name='ITEM' value='Chart1'> <param name='ITEM_ID' value='PIECHART' <param name='DATA_PROVIDER' valu



Command URLs Definition You can set command URLs in a Web template [Seite 119], as well as an object tag [Seite 124].

With the help of command URLs, you make changes, such as to properties of Web items or to the conditions of data providers. Furthermore, you can also realize several other navigation options (for example, report/report interface, export as Excel file, and call-ups from other Web templates).

Command Ucommand UR

s have the following structure: BW_URL Parameter1='Value1' Parameter2='Value2' ...>

add other parameters with “&“ behin W_URL> tag.

se command URLs as hyperlinks in a Web tems:

3. Hyperlink as text

<a href="<SAP_BW_URL cmd='LDOC' target="_Blank">Example Call up Template in New Window</a>

4. Hyperlink behind pushbutton

<table><tr><td class="SAPBEXBtnStdBorder" cellspacing="0" cellpadding="0" er="0"><tr><td>

e><tr><td class="sapbexbtns f="<SAP_BW_URL LDOC' TEMPLATE_ID='EXAMPLE_ target="_Blank">Call

xample Template in Separate Win

d></tr></table>

OpenURL('<SAP_BW_URL cmd=”LDOC” TEMPLATE_ID=”EXAMPLE_TEMPLATE”>’);

Within JavaScript you can also use the JavaScript function SAP_BW_URL_Get(), for example:

SAPBWOpenURL(SAP_BPLATE

In contras ed in Java

6. Enhan

You ca

RLs are usually visualized by means of text hyperlinks or pushbuttons. In addition, Ls can be used to enhance the context menu or when using formulas.

Structure Command URL<SAP_

You can also d the <SAP_B

If you u plate, the command URLs are embedded in the Web template as follow

TEMPLATE_ID='EXAMPLE_TEMPLATE'>"

bord

<tablcmd='

td" ><a hreTEMPLATE'>"

E dow</a></td></tr></table>

</t

5. Using hyperlinks in JavaScript functions

SAPBW

W_URL_Get()+’&cmd=LDOC&TEMPLATE_ID=’);

EXAMPLE_TEM

t to the <SAP_BW_URL> form, the SAP_BW_URL_Get() form can also be usScript includes because the URL is first composed at runtime.

cing the context menu

n also use command URLs during Enhancing the Context Menu with JavaScript [Seite 245].

orms 7. Using F

You can also use command URLs when Using Forms [Seite 234].



8. Command URLs act as placeholders that are replaced at runtime by the required rt number and status

ecify absolute URLs when naming command URLs with the

and URLs are transportable between different BW s when they are replaced at runtime.

information, such as the log (HTTP, HTTPS), server name, poinformation (request number, page number). Do not spthe log, server name and port number, instead specify <SAP_BW_URL> form. Note only commsystem

Use language-dependent texts [Seite 259] during visualization of command URLs

buttons or in enhancement of the context menu. P_BW_TEXT> can be combined in one link.

PLATE_ID=’EXAMPLE_TEMPLATE’>”></a>

e Web template is started by the user:

_no=8&cmd=ldoc&template_i

e from the BW server. The parameters are removed from the BW s of the previous page is changed due to the transfer of the parameters (for

Command Sequences [Seite

as hyperlinks, push<SAP_BW_URL> and <SA

Example:

Command URL in the Web template:

<a href=”<SAP_BW_URL cmd=’ldoc’ TEM

Command URL for the runtime if th

<a href=”http://myAppServer:myPort/SAP/BW/BEx?pageno=1&requestd=EXAMPLE_TEMPLATE“></a>

This URL requests a new pagserver side. The statuexample, filters are set).

See also:

232]

Sending Commands [Seite 238]

Different Command Types There are different types of commands:

• Commands for Changing Attributes of a Web Item [Seite 147]

• Data Provider Dependent Commands [Seite 172]

• Commands for Web Templates [Seite 150]



Changing Web Item Attributes

Yo c

Use In a Web application you can reset the Web item attributes for the runtime in a simple and easy way. All attributes are available for this, which you can also set in the Web Application Designer.

u an find the attributes available for this under Web Items [Seite 10] as well as an explanatio individual Web items.

n of the

Features Description Parameter

ITEM Item name

are able to apply a command to several Web items. In addition to the explicit specification of Web items, the quantity can

s, as long as they support this action.

st

You

also be limited by means of wild cards (MUTLI=’X’). The command is applied to all Web item

You mu specify the Web item(s).

MULTI Use Web item as template

If MULTI is set to ‘X’, the command is applied to all the Web items that have ITEM in their name. ’*’ corresponds to all Web items.

This parameter is optional.

‘X’ = Yes, ‘ ’ = No

Example s fo

<table class="SAPBEXBtnStdBorder" cellspacing="0" cellpadding="0" border="0"><tr><td><table><tr><td class="SAPBEXBtnStd"><a href=”<SAP_BW_URL item=’TABLEStyles</a></t

Pushbutton for activating alternating style r table rows:

_1’ ALT_STYLES=’X’>”>Alternierende d></tr></table></td></tr></table>



Resetting and Reinitializing Web Items Use You use this command to reinitialize an existing Web item. The Web item is recreated according to the parameters and is given the data provider [Seite 172] and the logical name of its predecessor. This allows you, for example, to create a graphic easily from a table without having to create both objects in the Web template.

You can use this command to create almitem is however an exception.

ost every kind of Web item. The Map Web Map Web items cannot be created consistently using

this command.

Features CMD RESET_ITEM

Parameter Description

ITEM Name of the Web item that is to be reinitialized.

ITEM_CLASS

SR_WWW_ITEM_GRID

Name of the ABAP object class that generates the output.

The class name for the Web item Table is, for example

CL_R

or

CMD RESET_ITEM


ITEM Name of the Web item that is to be reinitialized.

ITEM_ID Technical name of a library Web item

In order to overwrite individual attributes of the Web item to be reinitialized you can enter them as parameters.

Conversion of Web item “item1” to a Web item table without alternating rows:

<SAP_BW_URL ITEM='Item1' CMD='RESET_ITEM' ITEM_CLASS='CL_RSR_WWW_ITEM_GRID' ALT_STYLES=''>

Conversion of the Web item “item1” to a pre-defined Web item Chart.

<SAP_BW_URL ITEM='Item1' CMD='RESET_ITEM' ITEM_ID='myChart'>

When combined with a dropdown box (as HTML form), you can display several charts in one place by leafing through the dropdown box. You can find an example of this in the standard Web template for the Ad-hoc Analysis (subtemplate 0ADHOC_CHARTS).





Commands for Web Templates Use Commands for Web templates include all commands that are neither specific to data providers to Web items. They include commands for calling up and changing Web templates and for generating

or

bookmarks.

For more information, see:

Calling up a Web Template [Seite 151]

Calling up Parameterized Web Templates [Seite 153]

Changing a Web Template [Seite 158]

Personalizing Web Templates [Seite 159]

Generating Bookmarks [Seite 160]

Changing the Symbol Directory [Seite 161]

Releasing Web Templates [Seite 162]

Ending a Session [Seite 163]

Variables [Seite 164]



Calling up Web TemplateUse The URL for calling a Web template is generated n Designer. You can extend the URL by various parameters when you arameters can:

or display of the data p

s

by the Web Applicatiocall up a Web template. These p

• influence the contents for the result that is returned (see Calling UParameterized Web Templates [Seite 153])

• activate or deactivate different functions on

Choose from the following options to call up the template:

Standard call up and properties of Web templates

the server.

Features

You can find the permitted attributes under Object Tag for Web template propertiesfor Properties of Web Templates [Seite 125].

CMD LDOC


TEMPLATE_ID Web template eb

Application Designer.

Name of the Name under which you stored the Wtemplate in the Web

TRACE (optional)

= do not activate You usually need a trace to analyze’X’ = activate, ‘ ’

Activate OLAP trace problems

an activate the trace with the TRACE

in SAP. You chelp of note 112458 or by using theattribute.

Any other parameters for parameterizing your Web template

Web See Object Tag for Properties ofTemplates [Seite 125].

The parameters PAGEID and WBID r the Web templates created under BW 2. commend that you no longer

that are used in BW 2.x are supported fox. However, we re

use these.

Calling up the Web template without navigating

http://youmplate&STATELESS=

rAppServer:yourPort/SAP/B yourTeX

lling up the Web template with an activated trace

W/BEx?CMD=LDOC&TEMPLATE_ID=

Ca

rPort/SAP/BW/BEx?CMD=LDOC&TEMPLATE_ID=yourTe

ariables and active variable screen

http://yourAppServer:youmplate&TRACE=X

Calling up the Web template with reset v



http://yourAppServer:yourPort/SAP/BW/BEx?CMD=LDOC&TEMPLATE_ID=yourTemplate&VARIABLE_SCREEN=X&VARIABLES_CLEAR=X

Calling up the Web template with a different data provider

This call-up replaces all data providers [Seite 172] of the type 'query view' with the data provider

b

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

You can find the description of the necessary parameters under Object Tag for Properties of WeTemplates [Seite 125]

Displaying a query by using a Web template of your choice

http://yourAppServer:yourPort/SAP/BW/BEx?CMD=LDOC&TEMPLATE_ID=yourTemplate&infocube=myCube&query=myQuery

Setting your own Web template objects

As well as being able to define a new initialization for all data providers of a Web template, you can also convert each data provider specifically and each Web item, using parameterization. By doing this, you allow even your more complicated Web templates to be reused. You can find the description of the necessary parameters under Object Tag for Properties of Web Templates [Seite 125]

Swapping two data providers and a Web item when calling up a Web template

http://yourAppServer:yourPort/SAP/BW/BEx?CMD=LDOC&TEMPLATE_ID=yourTemplate&SET_DATA_PROVIDER_1=myDataProvider1&infocube_1=myCube&query_1=myQuery&SET_DATA_PROVIDER_2=myDataProvider2&data_provider_id_2=mySpecialView&SET_ITEM_3=myItem&ITEM_ID_3=myPieChart

Using a standard Web template for a data provider

If you call up the previous variant without specifying a TEMPLATE_ID, a standard Web template is used automatically. To make a Web template the standard Web template, go to BW Customizing Implementation Guide → Business Information Warehouse → Settings Relevant for Reporting → Web-Based Settings → Determine a Standard Web Template.

If there is no setting made here, the system uses a Web template generated by SAP. You can find more information on the Standard Web Template under Standard Web Template for Ad-hoc Analysis [Extern].

Calling up a query without making any preparations in the Web

http://yourAppServer:yourPort/SAP/BW/BEx?CMD=LDOC&infocube=myCube&query=myQuery



Calling Parameterized Web Templates Use The URL for calling a Web template is generated by the Web Application Designer. It is possible to copy the URL, and use it again as many times as you like.

A typical URL looks like this:

http://myAppServer:myPort/SAP/BW/BEx?CMD=LDOC&template_id=yourTemplate

The first part of the URL ((http://myAppServer:myPort/SAP/BW/BEx?) calls the BEx service in the SAP Web Application Server in the BW system. The next step is to call the Web template. The command ‘LDOC’ with the parameters 'TEMPLATE_ID' calls the Web template.

The command LDOC requests a new HTML page. The Web template is used to construct this HTML page. The Web application corresponding to the Web template is displayed in the Web Browser.

You parameterize the Web template by adding further parameters to the URL. These parameters are passed on to all data providers and Web items. Parameterizing the URL allows you to filter all the query views according to a particular country or cost center.

Examples Filtering all query views according to Germany

http://myAppServer:myPort/SAP/BW/BEx?CMD=LDOC&template_id=yourTemplate&FILTER_IOBJNM=0COUNTRY&FILTER_VALUE=DE

Filtering all query views according to Germany, 2000

http://myAppServer:myPort/SAP/BW/BEx?CMD=LDOC&template_id=yourTemplate&FILTER_IOBJNM_1=0COUNTRY&FILTER_VALUE_1=DE&FILTER_IOBJNM_2=0CALYEAR&FILTER_VALUE_2=2000

Displaying all Web items with title

http://myAppServer:myPort/SAP/BW/BEx?CMD=LDOC&template_id=yourTemplate&GENERATE_CAPTION=X



Default Variables for Web Applications Use Variables [Extern] play a central role in BW queries. For example, the entire query or only individual parts of the query can be filtered before reading data according to values. There are variables with automatic substitution, substitution from authorizations, or variables that are readfor input.

y

ify

r

The variables for Web applications can be processed in the background (without a variable screen) using the parameter VARIABLE_SCREEN=%20 or in the foreground (with a variable screen) using the parameter VARIABLE_SCREEN=X. In both cases, we recommend you specdefault variables through parameterization. Therefore, all types of variables that are ready for input are supported. For more information about the VARIABLE_SCREEN, see Object Tag fothe Properties of Web Templates [Seite 125].

In contrast to filtering, the external value for specifying default values has to be specified for the date, for example, is transferred as it has been entered.

ures efault variables is achieved by param RL. The variable values are

ach other by different indexes.

The index in the parameter is indicated in the follo

Characteristic Value Variables

Parameter variables or variables for several single values are predefined as follows:

Parameter

variables. The

FeatSpecifying d eterizing the Useparated from e

wing by '_I'.

Description

VAR_NAME_I Technical name of the variables

VAR_VALUE_EXT_I Key for characteristic value in external display

Attribute value in external display

Interval variables are predefined as in the following:



VAR_VALUE_LOW_EXT_I “From” characteristic value in external display Key for characteristic value in external display

VAR_VALUE_HIGH_EXT_I “To” characteristic value in external display Key for characteristic value in external display

Selection option variables are predefined as in the following:

parameter Description




VAR_OPERATOR_I An operator ividual value

erval 'LT' = Less than 'LE' = Less than or equal to

'EQ' = Ind'BT' = Int

'GT' = Greater than 'GE' = Greater than or equal to

VAR_VALUE_LOW_EXT_I “From” characteristic value in external

istic value in external display display Key for character

HIGH_EXT_I “To” characteristic value in external display Key for characteristic value in external display

VAR_VALUE_

This value must only be specified with VAR_OPERATOR='BT'.

VAR_SIGN_I Row properties 'I' found values are added, 'E' found values are removed.

Variables for precalculated value sets are preassigned as follows:

Description Parameter


VAR_VALUE_EXT_I Name of value set

Variables for Single Hierarchy Nodes or Variables for Several Hierarchy Nodes

arameter Description P


VAR_VALUE_EXT_I Node key in external display Key for hierarchy node

VAR_NODE_IOBJNM_I Node characteristic name With characteristic nodes and text nodes, you have to specify the characteristic name (0HIER_NODE).

Hierarchy, Formula, and Text Variables



VAR_VALUE_EXT_I Hierarchy name, formula value, text

Examples

Predefining the parameter variable

http://yourAppServer:yourPort/SAP/BW/BEx?CMD=LDOC&template_id=yourTemplate&var_name_1=myParameterVariable&var_value_ext_1=4711

Predefining the parameter variable (4711) and select options variable (1, 7 to 12)



http://yourAppServer:yourPort/SAP/BW/BEx?CMD=LDOC&template_id=yourTemplate&var_name_ ext_1=4711&var_name_2=mySelOptVar&var_operator_ _ext_2=1&var_name_3=mySelOptVar&var_operator

ar_sign_3=I&var_value_low_ext_3=7&var_value_high_ext_3=12

1=myParameterVariable&var_value_2=EQ&var_sign_2=I&var_value_low

_3=BT&v

Predefining hierarchy nodes variable (DE, 0HIER NODE)

http://yourAppServer:yourPort/SAP/BW/BEx?CMD=LDOC&template_id=yourTemplate&var_name_1=myHryNodeVariable&var_value_ext_1=DE&var_node_iobjnm_1=0HIER_NODE





Switching Web Templates Use As well as being able to call up Web templates [Seite 151] you are also able to switch between different Web templates. When you switch to a different Web template, all the Web items and data providers in the Web template in which you started, are retained. The Web items and data providers that appear in the new Web template, and for which there is no object with the same name, are generated from scratch. The system identifies the objects by their logical name.

The main difference between calling a Web template and switching to a different Web template is that when you switch to a different Web template, the objects from the initial Web template are transferred without being modified into the new Web report. This means, for example, that the query view of the navigation status stays the same.

This function is particularly useful for switching from overview pages (often containing only diagrams) to detailed pages (with tables and navigation blocks).

Features CMD CHANGE_TEMPLATE


TEMPLATE_ID Name of the Web template

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

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

If you still want to set paratmeters for the new Web template, you can use command sequences [Seite 232]. With the parameter APPLY_CMD_ON_TARGET = X, the command sequence can then be used from the newly created page.

<SAP_BW_URL CMD='CHANGE_TEMPLATE' TEMPLATE_ID=’DETAILS'>



Personalizing Web Templates Use With this command you can personalize a Web template for the user who is logged on. The next time this user calls up the Web template with parameter USE_PERSONALIZATION=X, the navigational state in the personalization template is displayed. This mechanism is especially useful for portal pages.

CMD PERSONALIZE

Example <SAP_BW_URL CMD='PERSONALIZE'>

Removing Personalization You can use this command to reset the Web template personalization for the current user.

CMD RESET_PERS

Example <SAP_BW_URL CMD='RESET_PERS'>



Creating Bookmarks Use Command that allows you to mark a Web application as a bookmark. The result of this instruction is to display a Web application with a bookmark-enabled URL. You can call this URL at any time, which results in a Web application that displays the same navigation status (including whether the hierarchy is expanded) as the Web application from which the instruction was called.

CMD BOOKMARK


BOOKMARK_DATA

(optional)

'X' = Yes, ' ' = No

Store historical data about the bookmark

The Web application with the historical data is displayed when you call up the bookmark. Bookmarks are normally used without data.

Example <SAP_BW_URL CMD='BOOKMARK'>



Changing Symbol Directory Use You use this command if you are working on a special Web application, and you want to use symbols other than the symbols that are generally used, for example, for expanding and collapsing hierarchies. The command assigns a different symbol directory to the Web template.

The names of the symbols remain unchanged. In the new directory the symbols have to appear with their original names, but you are able to alter them in other ways.

Features CMD SET_URLS


ICON_PREFIX Relative path to a symbol directory in the MIME repository or on the ITS

Example Displaying a Web template using symbols from a different directory

http://yourAppServer:yourPort/SAP/BW/BEx?CMD=LDOC&template_id=yourTemplate&cmd_1=cmd%3DSET_URLS%26ICON_PREFIX%3DmyPath

A command sequence is used in this example.

See also:

Command Sequences [Seite 232]



Releasing Web Templates Use You use this command to remove the current Web template and all its objects from the memory of the application server. The Web template can no longer be accessed once you have carried out this command. If you want to access the Web template again, you have to use the Call up Web Template [Seite 151] command to recreate it.

You can call up other Web templates by using commands in a command sequence.

Features CMD PAGE_FREE

<SAP_BW_URL CMD='PAGE_FREE'>



Ending the Session Use This command closes the current session on the application server.

Features CMD LOG_OFF

~command (optional)

‘logoff’ = log off from ITS

Delete ITS logon

If you transfer this parameter, you need to log on to the system again with your user and password to reconnect.

This parameter is only required when accessing via ITS.

<SAP_BW_URL CMD='LOG_OFF>

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



Variables Use With the commands for variables you can call up the variable screen again or change the variable values.

For more information, see:

Calling the Variable Screen [Seite 165]

Changing Variable Values [Seite 166]

Default Variables for Web Applications [Seite 154]



Calling up the Variables Screen Use This command allows you to call up the variables screen again for the current page. In the variables screen, you are able to change the values of the variables that have been used so far.

You can also transfer new values over, as described in Default Variables for Web Applications [Seite 154]. Along with the values already set, these new values are used as the default values in the variables screen.

If the variables screen appears when you call up a Web application, you have to adjust the Web template call (see Calling Web Templates [Seite 151]→ Standard Call).

You are not able to add filter parameters to the Call Variables Screen command.

Features CMD PROCESS_VARIABLES

SUBCMD VARIABLE_SCREEN

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



Changing the Values of Variables Use You can use this command to change the values of variables on the current page.

Enter the variable values as described in Default Variables for Web Applications [Seite 154]. Variables that you do not specify maintain their previous value.

With the Variable Value Change command, you cannot append filter parameters.

Features CMD PROCESS_VARIABLES

SUBCMD VAR_SUBMIT

Example <SAP_BW_URL CMD='PROCESS_VARIABLES' SUBCMD='VAR_SUBMIT' VAR_NAME_1=’myParameterVariable’ VAR_VALUE_EXT_1=’4711’>



Calling the Broadcaster Use You can use this command to call the BEx Broadcaster. If nothing else is defined, the standard Web template for broadcasting is called (0BROADCASTING_TEMPLATE). This is set in the Customizing of SAP BW.

You can specify your own standard Web template for broadcasting in Customizing under the following path: SAP Customizing Implementation Guide→ SAP NetWeaver → SAP Business Information Warehouse → Reporting-Relevant Settings → BEx Web → Determine Settings for Web Templates

Features CMD START_BROADCASTER


SOURCE_OBJECT_TYPE (optional) Type of reporting object

This parameter establishes the type of reporting object with which the broadcaster is started.

The following values are possible:

HT: Web template

QU: Query

WB: Workbook

DP: Data provider

SOURCE_TEMPLATE (optional)

Technical name of the Web template with which the Broadcaster should be started.

SOURCE_WORKBOOK (optional) Technical name of the workbook with which the Broadcaster should be started.

SOURCE_QUERY (optional) Technical name of the query with which the Broadcaster should be started.

SOURCE_DATA_PROVIDER (optional) Logical name of the data provider with which the Broadcaster should be started.

START_WIZARD (optional) Using this parameter, you determine whether the Broadcaster should be started as a wizard.

X = Yes, ' ' = No

The wizard mode is only possible when the source object is known.



DISTRIBUTION_TYPE (optional) Presetting of distribution type.

In order to be able to work with this parameter, you must start the Broadcaster as a wizard (see the parameter START_WIZARD).


KM_EXPORT: Distribute to Enterprise Portal

MAIL: Distribute by e-mail

• If the SOURCE_OBJECT_TYPE parameter is not specified, however one of

the SOURCE_TEMPLATE, SOURCE_WORKBOOK, SOURCE_QUERY or SOURCE_DATA_PROVIDER parameters is, the type of the reporting object is determined automatically. If the SOURCE_OBJECT_TYPE parameter is specified, it has to match the corresponding reporting object.

• Only one of the SOURCE_TEMPLATE, SOURCE_WORKBOOK, SOURCE_QUERY or SOURCE_DATA_PROVIDER parameters may be used.

An additional command LAUNCH_BROADCASTER exists for calling the BEx Broadcaster from a running Web application:

CMD LAUNCH_BROADCASTER

In contrast to the START_BROADCASTER command, the running Web application is automatically distributed when the BEx Broadcaster is called and the current navigation state and stylesheet are transferred.


START_WIZARD (optional)

‘X’ = Yes default setting

‘ ’ = No

Using this parameter, you determine whether the Broadcaster should be started as a wizard.

DISTRIBUTION_TYPE (optional)

Presetting of distribution type.

In order to be able to work with this parameter, you must start the Broadcaster as a wizard (see the parameter START_WIZARD).


KM_EXPORT: Distribute to Enterprise Portal

MAIL: Distribute by e-mail

Example Calling the Broadcaster for the DP1 data provider in wizard mode, and for distribution by E-Mail



<SAP_BW_URL CMD='START_BROADCASTER ' SOURCE_OBJECT_TYPE=’DP’ SOURCE_DATA_PROVIDER='DP1' START_WIZARD=’X’ DISTRIBUTION_TYPE=’MAIL’>



Calling the Open Dialog Use You can use this command to call an open dialog for queries or query views. You can then determine follow-up actions.

Prerequisites In order to use this command you have to register the help service to a Web item. The following additional attributes have to be added to a Web item in the HTML view in the Web Application Designer:


HELP_SERVICE Name of the help service:

HW_OPEN_DIALOG

HELP_SERVICE_CLASS Technical name of the help service class: CL_RSR_WWW_HWIND_OPEN_DIALOG

Features Command structure

CMD Process_help_window



HW_OPEN_DIALOG

ITEM Logical name of the Web item with which you have registered the help service.

SUBCMD Subcommand:

SELECTION

OBJECT_TYPE Type of reporting object:

QU: query; VW: query view

SUBMIT_PARAMETER Command that is to be executed after successful object selection. Parameters DATA_PROVIDER_ID or QUERY and INFOCUBE are added to this command.

ies and reinitialize DATAPROVIDER_1 with the selected query

LP_WINDOW' HELP_SERVICE='HW_OPEN_DIALOG' bcmd='SELECTION' object_type='QU'

D=RESET_DATA_PROVIDER&DATA_PROVIDER=DATAPROVID

Example Call open dialog for quer

<SAP_BW_URL cmd='PROCESS_HEitem='WEB_ITEM_1' suSUBMIT_PARAMETER='CMER_1'>





Data Provider - Commands Defi ition Commands It is possible to apply commands, such as filters, to data providers. In most cases, you must specify parameters for these commands. Some commands allow you to specify a list of parameter values. The parameter name is given an index “_1”, “_2”, ... This is shown in the following with “Parametername_N”.

There is at least one example given for every command. This is displayed in the same syntax as described under Command URLs [Seite

n

145].

All commands have the following parameters in common:


CMD Name of the command

Most commands are triggered by this parameter. As well as this type of command, there are also generic commands with parameters that you are able to assign to other commands. Generic commands are always applied after the named command.

DATA_PROVIDER

DATA_PROVIDER_N

Name of the data provider You are able to apply a command to several data providers. You either specify a particular data provider, or display a list of possible data providers, or restrict the number of data providers by using wildcards (MULTI=‘X’). The command is applied to all these data providers, as long as they support this action.

You must specify the data provider(s).

MULTI

Using the DATA_PROVIDER as a reference If MULTI is set to ‘X’, the command is applied to all the data providers that have ‘DATA_PROVIDER’ in their name. ‘*’ means all data providers, for example. The parameter has to be set to ‘X’ if several data providers are specified in the form DATA_PROVIDER_N.

This parameter is optional.

‘X’ = Yes, ‘ ’ = No

• For some data provider commands you have to specify the 25-character

UIDs for structures or their elements. This can be specified as follows:



In the Web application designer, drag the Web item Dropdown Box into your Web template. Assign the desired data provider to the Web item. Under the attribute Characteristic/Structure for the Web item Dropdown Box, select the respective structure. Here you can see the UID. If you execute the Web template, you can copy this UID from the HTML code. To do this, find the input tag with the name FILTER_IOBJNM_1; the UID is in the attribute ‘value’. For the individual structure items, you find the UID in the ‘value’ attribute for the respective option tags.

• Since the commands for variables technically belong to the Web templates and not to the data providers, you can also find the commands for variables under the commands for Web templates. See Variables [Seite 164].

Example Applying the command to the data provider ‘DP 1’

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

Applying the command to the data providers ’DP 1’ and ’DP 2’ <SAP_BW_URL DATA_PROVIDER_1='DP 1' DATA_PROVIDER_2='DP 2' MULTI='X' CMD='...' ...>

Applying the command to all the data providers that contain ‘USA’ in their name

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



General Data Provider Commands Use General data provider commands include:

Properties of Data Providers [Seite 175]

Resetting and Reinitializing Data Providers [Seite 177]

Back and Back to Start [Seite 179]

Jumping using the Report-Report Interface [Seite 180]

Exporting Data [Seite 181]

Saving Query Views [Seite 182]

Displaying a Copy of the Data Provider on a New Page [Seite 183]



Properties of Data Providers Definition Command for a data provider.

Use A data provider has a great variety of properties. You can change the properties by specifying the parameter and its value. Therefore, you do not have to specify parameter 'CMD'.

The data provider properties are evaluated after the command processing has ended.

Structure Parameter Description

ZERO_SUPPRESSION

' ' = do not hide any zeros

'X' = hide overall results columns and rows which contain zero values

'1' = only hide columns which have zeros in ied table

overall results columns which s

which have zeros in the fied table

ide rows and columns which have cross-classified table

ide overall results rows which contain zeros

Hide zeros which occur in the inner or outer rows and columns of a cross-classified table. A cross-classified table contains characteristics in both the rows and columns. Example of a cross-classified table: You create a query in which you analyze the

f your products in relation to your tic is er

nd the key figure Net Revenue d in the columns.

tructures. d Zero

net revenue ocustomers. The Product characterislocated in the rows and the Customcharacteristic a2004 are locateSee also the table below on Zero Suppression for SFor more information, see Zero Row anColumn Suppression [Extern].

the cross-classif

e'2' = only hidcontain zero

'3' = only hide rowscross-classi

'4' = only hzeros in the

'6' = only h

ZERO_PRESENTATION Zero value display

'0' = display

'1' = display without currency/unit

'2' = do not display

'3' = display zero text

ZERO_TEXT Text for zero value display '3'

SHOW_SCALING_FACTORS

'X' = Yes, ' ' = No

Display scaling factors and exclude currency / unit

SIGN_PRESENTATION

'1' = sign before number

'2' = sign after number

'3' = concatenated display

+/- sign display



FULL_CONCAT_KEYS

'X' = Yes, ' ' = No

Display of characteristic and attribute keys fully concatenated

SHOW_DOCUMENTS

'X' = Yes, ' ' = No

Show document links for each characteristic variant

SHOW_DR_LINKS

'X' = Yes, ' ' = No

Show Drag&Relate master data

UHRY_ACTIVE_ROWS

'X' = Yes, ' ' = No

Display rows as hierarchy

UHRY_CAPTION_ROWS Labeling for rows for hierarchical display

UHRY_LEVEL_ROWS Number of objects (characteristics, hierarchies, structures) on the rows that are initially visible as hierarchy when display is switched on.

UHRY_ACTIVE_COLUMNS

'X' = Yes, ' ' = No

Display columns as hierarchy

UHRY_CAPTION_COLUMNS Labeling for columns for hierarchical display

UHRY_LEVEL_COLUMNS Number of objects (characteristics, hierarchies, structures) on the columns that are initially visible as hierarchy when display is switched on.

Zero Suppression for Structures


SUPPRESSION

'X' = Yes, ' ' = No

The structure is included In the zero suppression.

STRUCTURE_NAME Technical name of structure (UID)

In order to use zero suppression for structures, both parameters have to be specified.

<sap_bw_url data_provider='*' multi='X' structure_name='DTG057U7OQ8K2ALKCMR2AWM14' suppression=’X’>

<sap_bw_url data_provider='*' multi='X' structure_name_1='DTG057U7OQ8K2ALKCMR2AWM14' suppression_1=’X’ suppression_2=’ ‘ structure_name_2=’ EFG057U7OQ8K2JKKCMR2AWM67’>

Integration The data provider properties can be added to every other command.



Resetting and Reinitializing Data Providers Use You use this command to reinitialize existing data providers [Seite 172] of the query or query view type. The data provider is recreated according to the parameters. The corresponding Web items display the data for the new data providers [Seite 142].

If you are using a Web item that requires, for example, a specific characteristic (such as filter dropdown box [Seite 24] ), you need to make sure that the new data provider also supports this characteristic.

Features CMD RESET_DATA_PROVIDER


INFOCUBE Technical name of the InfoCube

QUERY Technical name of the query

VARIANT (optional) Variants, if you are required to enter a variable

RRI (optional)

‘X’ = Yes, ‘ ’ = No

The report-report interface is used to convert the data provider. Jump targets by report-report interface do not have to be maintained for this purpose.

or

CMD RESET_DATA_PROVIDER


DATA_PROVIDER_ID Technical name of the view

VARIANT (optional) Variants, if you are required to enter a variable

RRI (optional)

‘X’ = Yes, ‘ ’ = No

The report-report interface is used to convert the data provider. Jump targets by report-report interface do not have to be maintained for this purpose.

Converting the ‘View1’ data provider to another query:

<SAP_BW_URL DATA_PROVIDER='View1' CMD='RESET_DATA_PROVIDER' INFOCUBE='myCube' QUERY='myQuery'>

Converting the ‘View1’ data provider to a saved view:

<SAP_BW_URL DATA_PROVIDER='View1' CMD='RESET_DATA_PROVIDER' DATA_PROVIDER_ID='myViewID'>



Converting the ‘View 1’ data provider to a saved view with transfer of filters and variable values:

<SAP_BW_URL_DATA_PROVIDER=’View1’ CMD=’RESET_DATA_PROVIDER’ DATA_PROVIDER_ID=’myViewID’ RRI=’X’>



Back and Back to Start Definition Back and Back to Start is a command for a data provider in the Web template.

Use With the help of this command, you can perform the following functions for a data provider:

• undo the last action

• undo all actions

In contrast to using the Back function in the Web browser, these commands only affect the specified data provider and not the entire page.

Structure CMD Description

BACK Undoes the last action executed for this data provider.

RESET Goes back to the navigation status that was visible when the Web application was called

The last action for data provider ‘View 1’ is to be undone <SAP_BW_URL DATA_PROVIDER='View1' CMD='BACK'>

All query views are to be reset to the status that was set when they were called up <SAP_BW_URL DATA_PROVIDER='*' MULTI='X' CMD='RESET'>



Jumping Using Report-Report Interface Definition Command for a data provider.

Use You can use this command to execute a report-to-report jump. You can jump from one Web template to another Web template, to another query, or to a transaction in an R/3 system and much more.

Structure CMD RRI


RRI_RECEIVER RRI Recipient ID

You can determine this ID in the Maintain Sender Receiver Assignment screen in the BW system (choose SAP Menu → Business Explorer → Query → Jump Targets in the SAP Easy Access Menu of the BW system).

DATA_ROW

(optional)

Data row

Context from which jump is made

DATA_COLUMN

(optional)

Data column Context from which jump is made

IOBJNM

(optional)

A characteristic Context from which jump is made

Example Jump to QURY0001 <SAP_BW_URL DATA_PROVIDER='View1' CMD='RRI' RRI_RECEIVER='QURY0001'> See also:

Report-Report Interface [Extern]

Editing Sender/Receiver Assignments to the R/RI in BW [Extern]



Exporting Data Definition Command for a data provider.

Use You can export the data of a data provider to a CSV or MS Excel 2000 file or an XML file with this instruction.

Structure CMD EXPORT


FORMAT Format

'CSV' = CSV file 'XLS' = MS Excel 2000 file 'XML' = XML file

REDIRECT_URL (optional) This parameter is optional for use fort he XML format: The generated XML can be automatically forwarded to antoher service as a form field if this address is specified as the REDIRECT_URL when the export command“is called. This enhancement is especially useful for integration scenarios in which post-processing of query data should occur in another service.

Notes about the XML format

The XML scheme is equivalent to data description in the Table Interface [Seite 281] of the Web API reference. You can find more information under Web Service for Access to Query Data [Extern].

Example Exporting data to MS Excel 2000

<SAP_BW_URL DATA_PROVIDER='View1' CMD='EXPORT' FORMAT='XLS'>



Saving the Query View

ommand for a data provider.

command to save a data provider as ject (query view).

MD SAVE_VIEW

Definition C

Use You use this a reusable ob

Structure C


TECH_NAME Technical name of the view

DESCRIPTION Description

OVERWRITE

'X' = Yes, ' ' = No

Overwrite existing view



Displaying a Copy of the Data Provider on a New Page Use This command enables you to display a copy of the current navigation status of a data provider [Seite 172] on a new page. This command is suitable for detailed windows, in which you navigate independently of the overview window (see example).

Features CMD RELEASE_DATA_PROVIDER


TEMPLATE_ID (optional) Name of the Web template

Name under which you stored the Web template in the Web Application Designer. If the parameter is not specified, the standard Web template is used.

Any other parameters for parameterizing your Web template

See Object Tag for Properties of Web Templates [Seite 125].

Displaying a copy of the status of the “View 1” data provider on a new page:

<SAP_BW_URL DATA_PROVIDER='View1' CMD='RELEASE_DATA_PROVIDER'>

Displaying a copy of the status of the “View 1”data provider in a new window with template 1:

JavaScript call: SAPBWOpenWindow("<SAP_BW_URL DATA_PROVIDER='View1' CMD='RELEASE_DATA_PROVIDER'>","Details",600,400);

If you still want to set parameters for the new page, you can use command sequences [Seite 232]. With the parameter APPLY_CMD_ON TARGET = X, the command sequence can then be used from the newly created page.



Calling the Ad-hoc Query Designer Use With this command, you can call the Ad-hoc Query Designer for a data provider in its own window (Web Template). If the data provider has already been installed, the query it is based on is transferred to the Ad-hoc Query Designer. Otherwise the Ad-hoc Query Designer is started initially. When closing the Ad-hoc Query Designer, the data provider with the associated query is reinitialized.

To execute a command, you need a Web template as a target template that contains the Web item Ad-hoc Query Designer. An example of the construction of a target template is Web template 0ADHOC_QUERYDESIGN.

Features CMD LAUNCH_QUERY_DESIGNER


TEMPLATE_ID Technical name of the Web template that contains the Web item Ad-hoc Query Designer.

Example Calling the Ad-hoc Query Designer for the Data Provider 'DP1'

<SAP_BW_URL DATA_PROVIDER='DP1' CMD='LAUNCH_QUERY_DESIGNER' TEMPLATE_ID=’0ADHOC_QUERYDESIGN’>



Filter Definition Filter is a command for a data provider in the Web template.

Use Filter values can be set for characteristics and structures for a data provider. When calling the command you can set several filters for the same characteristic/structure, or the same filter for several different characteristics/structures. Filter is a generic command, which means you do not

arameter. have to set the ‘CMD’ p

The filter parameters can be added d, with the exception of calling the variable screen [Seite

to any comman165] and changing the values of variables [Seite

166].

he actual filtering process is carried out at the enT d of the operation.

In the internal display (see table belo f the characteristic and the filter value using the URL parameter &snippet_operations=%20 (see also Object Tag for the Properties of Web

w) you can easily determine the name o

Templates [Seite 125]). Call the Web application with this URL parameter. If you

ou can then use the desired values with Command URLs [Seite

filter using the context menu, the parameters FILTER_IOBJNM and FILTER_VALUE are automatically added to the URL in the Web browser. Y

145] in hyperlinks.

Structure Parameter Description

FILTER_IOBJNM

FILTER_IOBJNM_N (optional)

Name of the characteristic / structure by which the system is to filter

Specify the technical name of the characteristic (for example, 0COUNTRY) or the structure (25 characters)

FILTER_COLLAPSE (optional)

‘X’ = Yes, ‘ ’ = No

Removing filter characteristics from the drilldown The characteristics that are specified under FILTER_IOBJNM are taken from the axes after the filter has been applied. If you do not specify the parameters, the system assumes you want to use the value ‘X’ = Yes.



FILTER _SIGN_N (optional) Row properties 'I' found values are added, 'E' found values are removed.

If the parameter is not specified, then the system assumes you want to use the value 'I'.

If FILTER_IOBJNM_N is not specified for index n, the value from FILTER_IOBJNM is used, if available.

For filtering individual values, the following parameters are also specified:


FILTER_VALUE

FILTER_VALUE_N

FILTER_VALUE_EXT

FILTER_VALUE_EXT_N

Filter Value Value, by which the system is to filter.

If the variant with ending 'EXT' is selected, the fully compounded value has to be entered in the external format, for example, 24.12.2000.

If the ending 'EXT' is not used, the fully compounded value has to be entered in the internal format, for example, 20001224 for 24.12.2000.

FILTER_VALUE_TYPE (optional)

FILTER_VALUE_TYPE_N (optional)

Type of value specified under FILTER_VALUE ‘VALUE’ : Characteristic value key 'VARIABLE_EXIT' : Exit variable name. The filter is set using the values returned by the variable exit. Parameter, interval, and selection option variables are allowed for customer and SAP exit variables, as well as for default values.

FILTER_OPERATOR (optional)

FILTER_OPERATOR_N (optional)

An operator 'EQ' = Individual value 'LT' = Less than 'LE' = Less than or equal to 'GT' = Greater than 'GE' = Greater than or equal to

If no operator is specified, then the system assumes you want to use the value 'EQ'.



The following parameters are also accepted for filtering intervals:


FILTER_VALUE_LOW

FILTER_VALUE_LOW_N

FILTER_VALUE_LOW_EXT

FILTER_VALUE_LOW_EXT_N

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 parameters are also accepted for filtering hierarchy nodes:

parameter Description

FILTER_VALUE

FILTER_VALUE_N

Hierarchy node name

FILTER_NODE_IOBJNM (optional)

FILTER_NODE_IOBJNM_N (optional)

Node characteristic name This parameter must be specified if the system filters by hierarchy nodes. The characteristic name has to be specified for characteristic nodes and for text nodes (0HIER_NODE).

Examples Filter Data Provider ’View1’ by Country: Germany <SAP_BW_URL DATA_PROVIDER='View1' FILTER_IOBJNM='0COUNTRY' FILTER_VALUE='DE'>

Filter Data Provider ’View1’ by First 3 Months <SAP_BW_URL DATA_PROVIDER='View1' FILTER_IOBJNM='0CALMONTH' FILTER_VALUE_LOW_EXT='1' FILTER_VALUE_HIGH_EXT='3'>

Filter All Data Providers by Costs and 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 Data Providers by Current Month <SAP_BW_URL DATA_PROVIDER='*' MULTI='X' FILTER_IOBJNM='0CALMONTH' FILTER_VALUE='0CMONTH' FILTER_VALUE_TYPE='VARIABLE_EXIT'>



Removing Filters Definition Remove Filter is a command for a data provider in the Web template.

Use You use this command to remove the filter from a characteristic or a structure for one or more data providers.

Structure CMD Remove_Filter


IOBJNM

IOBJNM_N

Name of the characteristic/structure

Specify here the technical name of the characteristic (0COUNTRY, for example) or structure (25 characters) from which you want to delete the filter. It is also possible to specify a list of characteristics/structures.

ALL

'X' = Yes, ' ' = No

Remove all filters

Alternatively to listing characteristics and structures, you can remove all filters.

Examples Remove filter by country for data provider ‘View1’ <SAP_BW_URL DATA_PROVIDER='View1' CMD='Remove_Filter' IOBJNM='0COUNTRY' >

Remove filter for country from all data providers 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 by country from data providers and filter according to calendar year 2000 <SAP_BW_URL DATA_PROVIDER='*' MULTI='X' CMD='Remove_Filter' ALL='X' FILTER_IOBJNM='0CALYEAR' FILTER_VALUE='2000'>



Drilldown Definition Drilldown is a command for a data provider in the Web template.

Use Use this command to change the position of a characteristic or a structure for one or more data providers.

Structure CMD Expand


IOBJNM


Specify the technical name of the characteristic here (for example, 0COUNTRY) or the structure (25-place character sequence that you want to bring into the drilldown.

AXIS (optional)

‘X’ = columns

‘Y’ = rows

’ ’ = Free characteristics (=remove drilldown)

Axis on which the characteristic/structure is to be based

If the PARENT_IOBJNM parameter is not specified, the characteristic/structure is brought onto the axis behind the other characteristics/structures. If you do not specify the parameter AXIS, the value ‘Y’ is used for characteristics, and ‘X’ for structures.

PARENT_IOBJNM (optional) Name of a characteristic/structure on the axis

Specify this parameter to move a characteristic/structure behind another one on an axis.

Examples Drilldown data provider, ‘View1’ by country <SAP_BW_URL DATA_PROVIDER='View1' CMD='Expand' IOBJNM='0COUNTRY' >

Drilldown data provider view1 according to country and filter according to calendar year 2000 <SAP_BW_URL DATA_PROVIDER='View1' CMD='Expand' IOBJNM='0COUNTRY' FILTER_IOBJNM='0CALYEAR' FILTER_VALUE='2000'>

Drag periods 1, 2, and 3 (2000) from data provider ‘View1’ to the columns <SAP_BW_URL DATA_PROVIDER='View1' CMD='Expand' IOBJNM='0FISCPER' AXIS='X' FILTER_IOBJNM='0FISCPER' FILTER_VALUE_1='2000001' FILTER_VALUE_2='2000002' FILTER_VALUE_3='2000003'>



Remove Drilldown Definition Remove Drilldown is a command for a data provider in the Web template.

Use Use this command to remove a characteristic or a structure from the drilldown for one or more data providers. This command is the same as the command Drilldown [Seite 189] if the parameter AXIS=’ ‘ is set.

Structure CMD Collapse


IOBJNM


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

Example Remove drilldown by country for data provider ‘View1’

<SAP_BW_URL DATA_PROVIDER='View1' CMD='Collapse' IOBJNM='0COUNTRY'>



Switching Characteristics/Structures Definition Swap characteristics/structures is a command for a DataProvider in the Web template.

Use Calling up this command allows you to switch characteristics/structures for one or more DataProviders.

Structure CMD Exchange


IOBJNM_1

Name of characteristic/structure

Specify the technical name of the 1st characteristic (0COUNTRY, for example) or the 1st structure (25 characters) here.

IOBJNM_2

Name of characteristic/structure

Specify the technical name of the 2nd characteristic (0COUNTRY, for example) or the 2nd structure (25 characters) here.

Example Replace drilldown by country with drilldown by calendar year in DataProvider ‘View1’

<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’>



Swap Axes Definition Swap Axes is a command for a DataProvider in the Web template.

Use This command switches the roles of the axes (the list is reversed). All the characteristics and structures in the rows are moved into the columns, and all the characteristics and structures in the columns are moved into the rows.

Structure CMD Switch_Axes

Swap axes for DataProvider ‘View1’

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



Setting the Navigational Status Definition Set Navigation Status is a command for a Data Provider in the Web Template.

Use By calling up this command, you can restructure or redistribute characteristics and structures on the axes.

Structure CMD SET_NAV_STATE


ALL

'X' = Yes, ' ' = No

Redistribute all characteristics and structures

If this parameter is set to ‘X’, then all characteristics and structures are taken from the axes and redistributed according to the other parameters.

If the parameter is not set or is set to ‘ ‘, then the listed characteristics are assigned according to the parameters on the axes.

IOBJNM

IOBJNM_N


Specify here the technical name of the characteristic (such as 0COUNTRY) / structure (25 character string) that you want to place on the axis.

AXIS

AXIS_N

‘X’ = columns

‘Y’ = rows

' ' = free characteristics

Axis on which the characteristic/structure is to be based

The characteristic or structure is based on the axis. The parameter POSITION determines its position on the axis.

POSITION

POSITION_N

Position on an axis

By specifying the position, the characteristic or structure is set for this position on the axis.

If the position is not specified or set to ‘0’, the characteristic/structure is placed at the end of the drilldown sequence.



Moving the key figure structure to the rows and removing the calendar year and planned/actual structure from the columns

<SAP_BW_URL DATA_PROVIDER='View1' 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 the cost centers are in drilldown for all DataProviders and not the materials

<SAP_BW_URL DATA_PROVIDER='*' MULTI='X' CMD='SET_NAV_STATE' IOBJNM_1='0COSTCENTER' AXIS_1='Y' IOBJNM_2='0MATERIAL' AXIS_2=' '>



Sorting Definition Sort is a command for a DataProvider in the Web template.

Use You use this command to sort according to characteristics or values, depending on parameterization.

Structure CMD Sort


SORT_TYPE

'K' = Key

'T' = Text

'H' = Hierarchy

'S' = Selection

'W' = Value

Type of sort

Characteristics can be sorted by key, by name or by hierarchy (if a display hierarchy is active for the characteristic). Or they can be sorted according to a selection (providing that there is a restriction on several single values in the query definition or dynamically on the DataProvider. You can also sort according to values.

SORT_DIRECTION

'A' = Ascending

'D' = Descending

Required sort direction

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

IOBJNM

Only for sorting characteristics.

Characteristic that you want to sort

This parameter is omitted when you are sorting according to values.

STRUCTURE_MEMBER_1

Only for sorting according to value.

Structural component of the first structure

If the system sorts by a value, the value cell must be set precisely. To do this, you have to specify the components of the structure (25-character string) for all the occurring structures (maximum 2).

STRUCTURE_MEMBER_2

If 2 structures are defined in the query, thestructural component of the second structure must alOnly for sorting according to

value.

so be specified.

Component of the second structure



Sort customers for DataProvider ‘View1’ by Text in ascending order

<SAP_BW_URL DATA_PROVIDER='View1' CMD='SORT' IOBJNM='0CUSTOMER' SORT_TYPE='T' SORT_DIRECTION='A'>

Sorting List According to Actual Sales, in Descending Order

<SAP_BW_URL DATA_PROVIDER='View 1' CMD='SORT' SORT_TYPE='V' SORT_DIRECTION='D' STRUCTURE_MEMBER_1='DTG057U7OQ8K2ALKCMR2AWM14' STRUCTURE_MEMBER_2='EFG057U7OQ8K2JKKCMR2AWM67'>



Setting Properties of Display Attributes Definition Command for a data provider.

Use You can change the properties of display attributes with this command.

Structure CMD SET_ATTRIBUTE


IOBJNM

Name of characteristic

Specify the technical name of the characteristic (0COUNTRY, for example) to which the attribute belongs here.

ATTRINM

Name of the attribute

Define the technical name of the display attribute here.

ACTIVE

' = Yes, ' ' = No

Display attribute

'X

POSITION Position of the attribute within the attribute

PRESENTATION

'KEY' = key

'TEXT' = shortest text

'TEXT_MD' = middle-length text

'TEXT_LG' = long text

'KEY_TEXT' = key and text

'TEXT_KEY' = text and key

Layout



Results Row Position Definition Command for a data provider.

Use You can define the position of the results row with this command. Hierarchy nodes are also based on this setting if there are other objects with competing settings on the hierarchy axis.

Structure Results Position

CMD SET_RESULT_POSITION


AXIS

‘X’ = columns

‘Y’ = rows

Axis on which the result position should be set

RESULT_POSITION

'TOP' = Top/left

'BOTTOM' = Bottom/right

Results Position

Hierarchy Node Position

CMD SET_RESULT_POSITION


IOBJNM


Enter the technical name of the characteristic on which the hierarchy node position should be defined here.

RESULT_POSITION

'TOP' = Top (left)

'BOTTOM' = Bottom (right)

Node position

The information in brackets represent what happens if the characteristic is on the columns.



Suppressing Result Rows Definition Command for a data provider.

Use You can suppress results row with this command.

Structure CMD SET_SUPPRESSION


IOBJNM


Define the technical name of the characteristic (e.g. 0COUNTRY) here.

RESULT_SUPPRESSION

'NEVER' = No suppression

'CONDITIONAL' = Conditional suppression

'ALWAYS' = Always suppress

Suppression method



Setting the Display Definition Command for a data provider.

Use You can change the display of characteristics, hierarchy node types and attributes with this command.

Structure CMD SET_PRESENTATION


IOBJNM

Name of characteristic Define the technical name of the characteristic (e.g. 0COUNTRY) here.

NODE_IOBJNM (Option 1) Node characteristic name With characteristic nodes and text nodes, you have to specify the characteristic name (0HIER_NODE).

ATTRINM (Option 2)

Name of the attribute Define the technical name of the display attribute here.

PRESENTATION

'NONE' = No display (only for characteristics)

'KEY' = key

'TEXT' = shortest text

'TEXT_MD' = middle-length text

'TEXT_LG' = long text

'KEY_TEXT' = key and text

'TEXT_KEY' = text and key

'KEY_TEXT' = Key and medium text

'KEY_TEXT' = Key and long text

Layout

For data provider DATAPROVIDER_1, set the display of the InfoObject 0CUSTOMER to key and text

<SAP_BW_URL DATA_PROVIDER='DATAPROVIDER_1' CMD='SET_PRESENTATION' IOBJNM='0Customer' PRESENTATION='KEY_TEXT'>



Displaying Documents Definition Command for a data provider.

Use You can call the document display for the selected context with this command.

Structure You can access four different contexts:

CMD DOCUMENTS


NAVIGATIONAL_STATE (Option 1)

'X' = Yes, ' ' = No

Documents for the current navigation status

DATA_ROW (Option 2) Documents for a data cell: Y coordinate

Coordinates in the data block

DATA_COLUMN (Option 2) Documents for a data cell: X coordinate

Coordinates in the data block

IOBJNM (Option 3) Documents for a characteristic

IOBJNM (Option 4) Documents for a characteristic value: characteristic

VALUE (Option 4) Documents for a characteristic value: key

Characteristic value in internal representation (without conversion exit)



Dialogs Use With the commands for dialogs, you can call up the respective dialogs in order to make settings there. You can find the descriptions for individual dialogs in Web applications under Analysis & Reporting: BEx Web Applications [Extern].

For more information on the individual commands for dialogs, see

Calling the Query Properties Dialog Box [Seite 203]

Calling the Dialog Box for Defining Formulas [Seite 204]

Calling up Input Help [Seite 205]

Calling the Dialog Box for Properties of Characteristics [Seite 206]

Calling the Currency Translation Dialog Box [Seite 207]

Calling the Dialog Box for Defining Exceptions [Seite 208]

Calling the Dialog Box for Defining Conditions [Seite 209]

Calling the Dialog Box for Cell Properties [Seite 210]

Saving the Dialog Query View [Seite 211]

Under Creating Your Own Dialogs [Seite 213] you can find information on how you can implement your own dialogs using an ABAP class.



Calling Dialog Query Properties Definition Command for a data provider.

Use You can call the Query Properties dialog with this instruction.

Structure CMD Process_help_window



QUERY_PROPERTIES



Calling Up Dialog Box for Formula Definition Definition Command for a data provider.

Use You can use this command to call up a dialog box for defining a new or an existing formula.




DP_VIEW_SET_CALC_MEMBER

SUBCMD NEW

FORMULA_STRUCTURE Technical name of structure

CMD Process_help_window



DP_VIEW_SET_CALC_MEMBER

SUBCMD CHANGE

FORMULA_ID Technical name of formula



Calling up Input Help Definition Calling Value Help is a command for a data provider in the Web template.

Use With the help of this command, you can call up input help for a characteristic or a structure of a data provider.




DP_VIEW_FILTER

IOBJNM


Specify the technical name of the characteristic here (for example, 0COUNTRY) or the structure (25-place character sequence) for which you want to call value help.

BOOKED_VALUES Using posted values for value help

If this parameter is not specified or is not set to ‘X’, only values are displayed in the input help that are also booked in the InfoProvider within the scope of the currently valid filter conditions. It can take a long time under certain circumstances.

If the parameter is set to ' ', all dimension table values are displayed. This can be quicker, but can also display values that do not appear in the InfoProvider under the current filter conditions and when filtering can give the result No corresponding data found.



Calling the Characteristic Properties Dialog Definition Command for a data provider.

window

Use You can call the Characteristic Properties dialog with this command.

Structure CMD Process_help_


HELP_SERVICE lp service: Name of the heCHAR_PROPERTIES

IOBJNM

Define the technical name of the characteristic (e.g. 0COUNTRY) here.




Calling a Dialog for Currency Translation Definition Command for a data provider.

Use You can call the dialog for currency translation with this command.


HELP_SERVICE CURRENCY_CONVERSION



Calling a Dialog for Defining Exceptions Definition Command for a data provider.

Use You can call the dialog for defining exceptions with this command.




EXCEPTION_DEFINITION

EXCEPTION_ID Name of exception

Enter the technical name of the exception here if you want to change an existing exception. If no value is defined for this parameter, a new exception will be created.



Calling a Dialog for Defining Conditions Definition Command for a data provider.

Use You can call the dialog for defining conditions with this command.




CONDITION_DEFINITION

CONDITION_ID Name of the condition

Enter the technical name of the condition here if you want to change an existing condition. If no value is defined for this parameter, a new condition will be created.



Calling a Dialog for Cell Properties Definition Command for a data provider.

Use You can call the dialog for cell properties with this command.



HELP_SERV Name of the help service:

RTIES

ICE

STRUC_MEMBER_PROPE

STRUCTURE

omponent of the first structure

Enter the value of the first structural component here. The combination of structural

nts defines the coordinates for a cell.

_MEMBER_1 Structural c

compone

STRUCTURE component of the second cture (if it exists)

Enter the value of the second structural component here. The combination of structural components defines the coordinates for a cell.

_MEMBER_2 Structuralstru



Save Query View Dialog Box Use With this command you call a dialog for saving a query view. You can specify a follow-up action here if necessary. Also see Saving Query Views [Seite 182].

Prerequisites In order to use this command you have to register the help service to a Web item. The following additional attributes have to be added to a Web item that is assigned to the corresponding data provider in the HTML view in the Web Application Designer:


HELP_SERVICE Name of the help service

(SAVE_VIEW)

HELP_SERVICE_CLASS Technical name of the help service class (CL_RSR_WWW_HWIND_SAVE_VIEW)

Features Command structure

CMD Process_Help_Window



SAVE_VIEW

ITEM Logical name of the Web item with which you have registered the help service.

LOCAL_VIEW A query view can be saved locally (that is, without specifying a technical name). The query view does not appear in the open dialog in this case. When you save locally, only a GUID (Global Unique Identifier) is generated.

'X' = Yes; ' ' = No (standard setting)

It is usually only useful to use this parameter if you also specify the SUBMIT_TARGET parameter.

SUBMIT_TARGET URL for the follow-up action. When you execute the URL the parameters DATA_PROVIDER_ID (technical name of the query view) and DESCRIPTION (name of the query views) are added to it.



Example Call dialog for saving a query view that is connected to Web Item WEB_ITEM_1

<SAP_BW_URL CMD="PROCESS_HELP_WINDOW" HELP_SERVICE="SAVE_VIEW" item="WEB_ITEM_1">

Call help service for save view, where the view is saved as a local view (parameter LOCAL_VIEW) and a new entry is added to item VIEWDDITEM in the template that is calling the help service (parameter SUBMIT_TARGET).

Call help service for the Save Query View dialog, where the query view is saved as a local query view (parameter LOCAL_VIEW) and a new entry is to be added to the Web item VIEWDDITEM (query view – selection) in the Web template calling the help service (parameter SUBMIT_TARGET)

SAPBWOpenURL('<SAP_BW_URL CMD="PROCESS_HELP_WINDOW" HELP_SERVICE="SAVE_VIEW" item="WEB_ITEM_1" LOCAL_VIEW="X">&SUBMIT_TARGET=' + escape(opener.SAP_BW_URL_Get() + '&CMD=ADD&ITEM=VIEWDDITEM&ITEM_ID=MYITEM')



Creating Your Own Dialogs Use With your own dialogs, you can generate your own HTML pages and call them from Web applications. To do this, you create your own ABAP class that inherits the associated properties and parameters from the class CL_RSR_WWW_HELP_WINDOW and you redefine one or more methods for this class. In your own ABAP class, you create the HTML code or create an URL for redirecting. The ABAP class enables access to the current navigational state of the Web application. Within the ABAP class you can process commands and call any ABAP code (function modules and so

t is possible to display data as ch using ABAP function modules.

on). In this way idatabase tables

eckboxes, to change it, and then to write it to

Your own Business Server Page (BS native to this procedure. BSP applications, howevstate of the Web application. For mo Pages

P) applications provideer, cannot access the

an altercurrent navigational

re information, see Business Server [Extern].

your own dialogs allows redirects of URparameters that are not known when the Web appknown during the first call, they can be inserted in bles using

wever, p only required for specific, rare e cases, due to performance

determine the parameters using your own dialog.

If standalone HTML pages or redirects are not necnged, it makes sense to bles [Seite

The use of Ls. URLs can be extended with additional lication is first called. If the parameters are

to the HTML code as JavaScript variathe Web Design API for tables. Often, houser actions. In thes

arameters areand network issues, it makes sense to

essary, and instead only parts of the Web application need to be cha use the Web Design API for Ta 277]

ctions.

Prerequisites You have created a Web application that contains s necessary to use the ABAP class in the Web temp

Procedure Creating an ABAP Class

P Easy Access screen, choose kbench → Development → r (transaction SE24). See also ]

or JavaScript fun

at least one Web item. This Web item ilate (see below).

...

1. From the SA Tools → ABAP WorClass Builder [ExternClass Builde .

You can also use the Object Navigator from the ABAP Workbench (transaction SE

xtern]80) to generate a class. See also Object Navigator [E .

2. To create a ne (for example, ZCL_RS

w class, under Object Type, enter a technical name for your class R_WWW_HELP_WINDOW) and choose (Create). The Create Class

YourClassName dialog box then appears.

3. Save your class. You get to the Object Catalog screen.



4. Depending oneither choose eak to your system ator. The Class Builder: Change Class YOURCLASSNAME

5. Choose Superclass on the Properties tab page. Under Inherits from, enter CL_RSR_WWW_HELP_WINDOW as the superclass.

6. To see all of the inherited properties and methods of the class CL_RSR_WWW_HELP_WINDOW in your ABAP class, choose

the system configuration in regard to changes and the transport of objects, a package or save your class as a local object. For more information, sp administr

screen.

(Save).

7. On the Methods tab page, choose the method PROCESS_CMD that you want to redefine and choose (Redefine).

8. To change the implementation of the method, call up the method name by double clicking.

9. To get back to the original screen, choose (Back)

10. Save your changes.

11. To activate event linking, choose (Activate).

Using the ABAP Method PROCESS_CMD • The ABAP method PROCESS_CMD is automatically called by the Web Application

Framework when you call your own dialog from a Web application. Using this method, the commands received and their parameters can be processed.

• The commands and parameters from the URL are transferred to the method PROCESS_CMD in the import parameter I_R_PARAMETER. With the I_R_PARAMTER->GET ABAP method, individual commands and parameters can be queried.

• Access to the information from the Web Application Framework is possible using the attribute N_R_PAGE.

data: l_cmd type string.

l_cmd = i_r_parameter->get( i_id = cl_rsr_www_page=>c_parameter_subcmd ).

• For better structuring, it makes sense to distribute processing of individual commands to separate ABAP methods. These methods generate the HTML.

• The result of the ABAP method PROCESS_CMD can be an HTML page or redirecting for a URL. The HTML page is returned to the attribute N_SX_OUTPUT-STRING as a character string. The return of the URL occurs in the attribute N_SX_OUTPUT-REDIRECT_URL.

Using an ABAP Class in a Web Template 12. To be able to use the ABAP class you created, it must be included in a Web template.

...

1. Open your Web template, which includes at least one Web item, in the BEx Web Application Designer.

2. Use the HTML tab page to switch to the HTML view of the Web Application Designer.

3. Navigation to the object tag of the Web item and insert the following parameter lines into the HTML, to make the ABAP class known as HELP_SERVICE within the Web template.

<object>…

<param name="HELP_SERVICE" value=“YourDialog"/>

<param name=“ HELP_SERVICE_CLASS “ value=”YourClassName”/>



…</object>

<object>…

<param name=“HELP_SERVICE “ value=”DIALOG_1”/>

<param name=“HELP_SERVICE_CLASS“ value=” ZCL_RSR_WWW_HELP_WINDOW”/>

…</object>

The parameter HELP_SERVICE contains the name of your own dialog within the Web template. The parameter HELP_SERVICE_CLASS includes the name of the ABAP class.

4. Insert a Command URL [Seite 145] as a hyperlink, context menu or form. Specification of the parameter CMD; HELP_SERVICE, ITEM is mandatory. You can also attach your ownoptional commands (for example, SUBCMD, and so on).

Example in HTML

<a href="<SAP_BW_URL CMD='PROCESS_HELP_WINDOW’ HELP_SERVICE='DIALOG_1’ ITEM=’TABLE_1’ SUBCMD=’COMMAND_2’>">Open Dialog</a>

Example in JavaScript

SAPBWOpenURL( SAP_BW_URL_Get()

+ "&CMD=PROCESS_HELP_WINDOW”

+ “&HELP_SERVICE=DIALOG_1”

+ “&ITEM=TABLE_1”

+ “&SUBCMD=COMMAND_2");

For more information on calling dialogs, see Saving Dialog Query Views [Seite 211].

5. Save the changes.

6. Execute the Web template in the browser.

Note that already existing Bookmarks [Seite 160] for a Web template into which you have integrated your own dialog (HELP_SERVICE) in the meantime do not recognize this dialog. In addition to the current navigational state (data provider), bookmarks also save the current state of the Web item.

Debugging the ABAP Class For more information on debugging ABAP classes in Web applications, see Creating and Using ABAP Classes [Seite 278].

Result You have created an ABAP class and have redefined one or more methods to extend a Web application with your own HTML pages.



Exceptions and Conditions Use With the commands for exceptions and conditions, you can create new exceptions or conditions, change existing exceptions or conditions, or set their status (inactive/active).

You can find additional information about the individual commands under

Commands for Exceptions [Seite 217]

Setting the Status of an Exception [Seite 220]

Commands for Conditions [Seite 221]

Setting the Status of a Condition [Seite 223]



Commands for Exceptions Definition Command for a data provider.

Use 'You can change existing (local) exceptions and define new (local) ones with this command.

Exceptions that were defined in the Query Designer cannot be changed.

Structure CMD SET_EXCEPTION


EXCEPTION_ID

(optional)

ID of the exception to be changed If there is no exception with this ID, a new one is created. A new exception is also created if this parameter is not filled. For how to determine the Exception_ID, see the notes below.

ACTIVE

'X' = Yes, ' ' = No

Exception active

DESCRIPTION Description This text is displayed in the list of exceptions.

IOBJNM_I Context in which a characteristic must be The exception is only evaluated if the data cell for the given characteristic is in the context described by parameters OPERATOR and VALUE.

STRUCTURE_MEMBER_1

alues: ‘UID’ or ‘ALL’

STRUCTURE_NAME_1

Structural component of the first structure

If the exception refers to one specific structural component, you have to specify this by entering the unique ID (UID). This is the 25 character string.

If the exception refers to all structural elements and you have assigned the value ‘ALL’ to the STRUCTURE_MEMBER parameter, you also have to specify the parameter STRUCTURE_NAME_1 by entering the structure name (25 character string).

V

STRUCTURE_MEMBER_2

STRUCTURE_NAME_2

Component of the second structure See the remarks on STRUCTURE_MEMBER_1.



RELATIVE_VALUES (optional) Validity area for all characteristics not listed

If you assign the value ‘X’ to the parameter, the values for all characteristics that are not listed can be arbitrary. This is to be recommended for relative values such as, for example, percentage deviations.

If you assign the value ‘ ’ to the parameter, all characteristics that are not listed have to be aggregated. The exception is only valid fort he aggregated values of the characteristics that are not listed.

See Defining Exceptions [Extern].

OPERATOR_I Context in which a characteristic must be Valid operators are: 'AL' = No restrictions 'AG' = Aggregated (no filtering) 'EQ' = A certain value 'NA' = Restricted to a value 'HL' = Hierarchy level

VALUE_I Context in which a characteristic must be Key of the characteristic value if operator 'EQ' and hierarchy level if operator 'HL'.

ALERT_LEVEL_J Alert Level The alert level can have the values 1, 2 and 3 for good numbers, 4, 5 and 6 for critical numbers and 7, 8, and 9 for bad numbers.

OPERATOR_J Operator for the data values 'EQ' = Equal to 'NE' = Not equal to 'BT' = Interval 'LE' : Less than or equal to 'LT' = Less than 'GE' : Greater than or equal to 'GT' = Greater than

VALUE_LOW_J Data cell value

VALUE_HIGH_J Data cell value to This parameter is only needed for interval operators.

To determine the Exception_ID, proceed as follows:

• Create a Web application with the List of Exceptions Web item.

• Call the Web application and deactivate the snippet operations (SNIPPET_OPERATIONS=' ') in the Web application URL.



• Choose Activate or Deactivate in the context menu for the List of Exceptions or choose (Activate/Deactivate).

You can now see the Exception_ID in the URL. Alternatively, you can also see the Exception_ID in the source code for the Web application (View Source).



Setting the Status of an Exception Definition Set Status of an Exception is a command for a DataProvider in the Web template.

Use Calling up this command allows you to change the status for a DataProvider exception.

Structure CMD Set_Exception_State


EXCEPTION_ID

Technical name of the exception

Give the technical name of the exception here (25 character string).

ACTIVE (Option 1)

‘X’ = activate, ‘ ’ = deactivate

Required exception status

TOGGLE_STATE (Option 2)

‘X’ = switch, ‘ ’ = do not switch

Change the exception status

If this parameter is set to ‘X’, the exception is activated if it was previously not active and deactivated if active.

Examples Set exception “Problems in Sales” from DataProvider ‘Query View 1’ to active

<SAP_BW_URL DATA_PROVIDER=’View1’ CMD=’Set_Exception_State’

EXCEPTION_ID=’DTG057U7OQ8K2ALKCMR2AWM14’ ACTIVE=’X’>

Switch exception “Problems in Sales” from DataProvider ‘Query View1’

<SAP_BW_URL DATA_PROVIDER=’View1’ CMD=’Set_Exception_State’

EXCEPTION_ID=’DTG057U7OQ8K2ALKCMR2AWM14’ TOGGLE_STATE=’X’>



Commands for Conditions Definition Command for a data provider.

Use 'You can change existing (local) conditions and define new (local) ones with this command.

Conditions that were defined in the Query Designer cannot be changed.

Structure CMD SET_CONDITION


CONDITION_ID

(optional)

ID of the condition to be changed If there is no condition with this ID, a new condition is created. A new condition is also created if this parameter is not filled. For how to determine the CONDITION_ID, see the notes below.

ACTIVE

'X' = Yes, ' ' = No

Condition active

DESCRIPTION Description This text is displayed in the list of conditions.

IOBJNM_I List of characteristics List of the characteristics for which the condition should be applied in combination. If no characteristic is specified, the condition is applied to all characteristics.

STRUCTURE_MEMBER_1_I Structural component of the first structure A condition always refers to exactly one value cell. To do this, you have to specify the components of the structure (25-character string) for all the occurring structures (maximum 2).

STRUCTURE_MEMBER_2_I Structural component of the second structure (if it exists)



OPERATOR_I An operator 'EQ' = Equal to 'NE' = Not equal to 'BT' = Interval 'LE' : Less than or equal to 'LT' = Less than 'GE' : Greater than or equal to 'GT' = Greater than 'TC' = Top n 'TP' = Top percent 'TS' = Top sum

'BC' = Bottom n 'BP' = Bottom percent 'BS' = Bottom sum

VALUE_LOW_I Numerical value for operator

VALUE_HIGH_I Numerical value for operator Only the interval operator needs this value.

To determine Condition_ID, proceed as follows:

• Create a Web application with the List of Conditions Web item.

• Call the Web application and deactivate the snippet operations (SNIPPET_OPERATIONS=' ') in the Web application URL.

• Choose Activate or Deactivate in the context menu for the List of Conditions or choose (Activate/Deactivate).

You can now see the Condition_ID in the URL. Alternatively, you can also see the Condition_ID in the source code for the Web application (View Source).

•



Setting the Status of a Condition Definition Set Status of a Condition is a command for a DataProvider in the Web template.

Use Calling up this command allows you to change the status for a DataProvider condition.

Structure CMD Set_Condition_State


CONDITION_ID Technical name of the condition

Give the technical name of the condition here (25 character string).

ACTIVE (Option 1)


Required status for the condition



Change the status of the condition

If this attribute is set to ‘X’, the condition is activated, if it is not active already, and deactivated, if it is active.

Examples Set condition “Top 10 Customers” from the DataProvider ‘Query View1’ to Active

<SAP_BW_URL DATA_P

CONDITION

S

ROVIDER='View1' CMD='Set_Condition_State'

_ID='DTG057U7OQ8K2ALKCMR2AWM14' ACTIVE='X'>

witch condition “Top 10 Customers” from DataProvider ‘Query View1’

<SAP_BW_URL DATA_PROVIDER='View1' CMD te'

_ID='DTG057U7OQ8K2ALKCMR2AW _STATE='X'>

='Set_Condition_Sta

CONDITION M14' TOGGLE



Commands for Currency Definition Command for a data provider.

Use You can define a new currency translation for the data provider with this command.

Structure CMD CURRENCY_CONVERSION

Translation


CUR_CONV_METHOD Currency translation type

CUR_CONV_TYPE ‘0’ = database currency '1' = as in the query definition '2' = to target currency '3' = to target currency via query definition currency

Translation type

TARGET_CURRENCY Target currency Only need be specified for CUR_CONV_TYPE 2 and 3



Commands for Values CeDefinition Command for a data provider.

Use You can change the properties of value cells with

Structure

lls

this command.

CMD SET_VALUE_PROPERTIES


STRUCTURE_MEMBER_1

ponent of the first structure

ure (25-character string) for all the

Structural com

The properties are defined for a value cell. To do this, you have to specify the components ofthe structoccurring structures (maximum 2).

STRUCTURE_MEMBER_2 Structural component of the second structure (if it exists)

SCALING_FACTOR Scaling s

0=No scaling, 1=Factor 10, 2=Factor 100, ...

factor

DECIMAL_PLACES Number of displayed decimal places

EMPHASIS

'X' = Yes, ' '

Display with highlighting

= No



List Calculations Definition List Calculations is a command for a data provider in the Web template.

Use With this command you can change the settings for calculating lists for a value cell.

Structure CMD SET_LIST_CALCULATION


STRUCTURE_MEMBER_1 Structural component of the first structure The value cell must be determined exactly for calculating lists. To do this, you have to specify the components of the structure (25-character string) for all the occurring structures (maximum 2).

STRUCTURE_MEMBER_2 Structural component of the second structure (if it exists)

APPLY_TO_RESULTS (optional)

'X' = Yes, ' ' = No

Use calculation guidelines also for event cells

CUMULATION (optional)

'X' = Yes, ' ' = No

Cumulated output

VALUE_CALCULATION (optional) Calculations ' ' = No list calculation 'R' = Normalizing for query result 'G’ = Normalizing for overall result 'C' = Normalizing for result 'S' = Ranking list 'O' = Ranking list (Olympic)



RESULT_CALCULATION (optional) Calculations for result cells '00' = No list calculation '01' = Summation '02' = Maximum '03' = Minimum '04' = Count of all values '05' = Count of all values <> 0

'08' = Standard deviation

'06' = Average using all values '07' = Average using all values <> 0

'09' = Variance '10' = Suppress results '11' = First value '12' = Last value

Examp eDisplay x

l ma imum plan sales

<SAPSTRUSTRUCT 67' VALUE_CALCULATION='02'>

See also:

OLAP Functions for Active Cells [Extern]

_BW_URL DATA_PROVIDER='View1' CMD='SET_LIST_CALCULATION' CTURE_MEMBER_1='DTG057U7OQ8K2ALKCMR2AWM14'

URE_MEMBER_2='EFG057U7OQ8K2JKKCMR2AWM



Operations for Display Hierarchies Definition Operations on Display Hierarchies contains commands for a data provider in a Web template.

Use There are five operation...

1. With activate a display query definition or

MD SET_HIERARCHY_STATE

s that you apply to display hierarchies:

the SET_HIERARCHY_STATE command, you activate or dehierarchy that has been assigned to a characteristic (for example, in thein a query view).

C


IOBJNM Name of characteristic Characteristic with a display hierarchy assigned to it already.

ACTIVE (Option 1)


Required status of the display hierarchy.



Switch the status of a hierarchy If this parameter is set to ‘X’, the display hierarchy is activated if it was previously not active and deactivated if active.

Activating a Hierarchy for the Cost Center Characteristic for Data Provider ‘View1’

<SAP_BW_URL DATA_PROVIDER='View1' CMD='Set_Hierarchy_State' IOBJNM='0COSTCENTER' ACTIVE='X'>

2. You use the SET_HIERARCHY command to assign a display hierarchy to a characteristic.

CMD SET_HIERARCHY


IOBJNM Name of characteristic Characteristic that you want to assign a display hierarchy to.

HIERARCHY_NAME Technical name of the hierarchy

HIERARCHY_VERSION Hierarchy version If the hierarchy has a particular version, you must specify the version. Otherwise you can leave out this parameter.



HIERARCHY_DATE Key date for the hierarchy You specify the key date for time-dependent hierarchies here. The date must be formatted as YearMonthDay (for example, 20001224).

If the parameter is not transferred, the key date in the query is copied.

ACTIVE


Required status of the display hierarchy.

Assigning ‘MyHierarchy’ to the Cost Center Characteristic for Data Provider ‘View1’

<SAP_BW_URL DATA_PROVIDER='View1' CMD='Set_Hierarchy' IOBJNM='0COSTCENTER' Hierarchie_Name='MyHierarchy' ACTIVE='X'>

3. You use the DRILL_TO_LEVEL command to expand the display hierarchy up to a specified hierarchy level.

CMD DRILL_TO_LEVEL


IOBJNM Name of characteristic Characteristic, to which an active display hierarchy is assigned.

LEVEL Hierarchy level Level to which you want to expand the hierarchy. Level 1 is the root level.

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

Drilldown Cost Center Characteristic for Data Provider ‘View1’ up to Level 3

<SAP_BW_URL DATA_PROVIDER='View1' CMD='Drill_To_Level' Iobjnm='0COSTCENTER' Level='3'>

4. You use the SET_DRILL_STATE command you can expand and collapse a node from a display hierarchy.

Note that the node must be visible in the list in the current navigation status.

The command is a useful way of influencing the extent to which the hierarchy is expanded when you are calling a Web application, activating a hierarchy, or determining and



activating a hierarchy. Command sequences are used in order to execute both commands at the same time.

CMD SET_DRILL_STATE


IOBJNM Name of characteristic Characteristic, to which an active display hierarchy is assigned.

POSITION Data position in the drilldown

Since several objects can be drilled down on an axis, the node specifications are no longer unique. Therefore, the axis position is used instead. For example, the fifth data line.

DRILL_STATE (optional) Level to which you want the hierarchy to be expanded

'E' = hierarchy nodes expanded

'C' = collapse 'U' = by activating “Display as Hierarchy” on the axis: drilldown according to the next object on the axis If the parameter is not specified, the collapsed or expanded status will change. This means that a collapsed hierarchy node will be expanded and an expanded hierarchy node will be collapsed.

Specifying the Hierarchy for the Cost Center Characteristic for Data Provider ‘View1’ and Simultaneously Expanding the Fifth Node on the Axis

<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&POSITION=5&Drill_State=E'>

A command sequence is used in this example.

See also:

Command Sequences [Seite 232]

5. With the co HIERARY_NO erty Display/Suppress Nodes with Only One Child can be set.

SET_HIERARY_NODE_SUPP

mmand SET_ DE_SUPP, the prop

CMD


IOBJNM Name of characteristic

Characteristic, to which an active display hierarchy is assigned.



RESULT_SUPPRESSION

‘CONDITIO with e Child

‘NEVER’ = Display Nodes with Only One Child

Display/Suppress Nodes with Only One Child NAL’ = Suppress Nodes

Only On

Activate For Cost Center Characteristic for Data Provider ‘View1’ Suppress Node with Only One Child

<SAP_BW_URL DATA_PROVIDER='View1' CMD='SET_HIERARCHY_NODE_SUPP' Iobjnm='0COSTCENTER' RESULT_SUPRESSION='CONDITIONAL'>

6.



Command Sequences Use Many questions require you to change several objects in different ways with commands [Seite 145]. For example, you cannot use the current methods with a single request (command) for filtering a data provider [Seite 172] for the fiscal year 1999 and another data provider for 2000.

A command sequence allows you to add new commands to an original command. Data is requested from the OLAP processor and the HTML page is sent back to the Web Browser only after all of the commands have been processed.

• The subsequent command sequences are added to the original command as parameter CMD_N. If the command is within an >SAP_BW_URL> tag, you need to make sure that the complete command sequence is set in quotation marks. No quotation marks can be set within the command sequence. If the command sequence is transported using a URL, you have to make sure that you replace the characters ‘=’ and ‘&’ with their hexadecimal display in the command sequence

Replace ‘=’ with ‘%3D’

Replace ‘&’ with ‘%26’

Each subsequent command can have a maximum of 250 characters. If it contains more characters, these extra characters are cut off.

If the command sequence is too large to fit in a URL then you can add the parameter ‘NO_OUTPUT' to a command. As a result, the command is executed and an empty page is returned. However, no data is read. This is useful, for example, if a main frame is addressed from a control frame. Using JavaScript, you can carry out a sequence of single commands in the main frame and leave out the ‘NO_OUTPUT’ parameter from the last command. See also Example Scenario for the Parameter NO_OUTPUT [Seite 270].

See examples 1 and 2 below.

• The parameter APPLY_CMD_ON_TARGET and its values “X” and “ ” allow you to choose whether the subsequent commands are used in a new page created by the main command or whether they are used in the same page as the main command.

See example 3 below.

Examples ...

1. Start a Web application and filter data provider 1 according to DE and data provider 2 according to US

http://myAppServer:myPort/SAP/BW/BEx?CMD=LDOC&template_id=yourTemplate&CMD_1=DATA_PROVIDER%3DDP1%26FILTER_IOBJNM%3D0COUNTRY%26FILTER_VALUE%3DDE&CMD_2=DATA_PROVIDER%3DDP2%26FILTER_IOBJNM%3D0COUNTRY%26FILTER_VALUE%3DUS

2. Command URL to filter Data Provider 1 according to calendar year 2000, change the title of the GRAPHIC graphic to ‘2000’, and change the title of the TABLE table to ‘Details2000’



<SAP_BW_URL DATA_PROVIDER='DP1' FILTER_IOBJNM='0CALYEAR' FILTER_VALUE='2000' CMD_1='ITEM=GRAPHIC&CAPTION=2000' CMD_2='ITEM=TABLE&CAPTION=Details2000'>

3. Page 1 contains a link to the details. This link starts page 2. The navigation status of the page 1 print parameters is transferred and at the same time the target page is parameterized, for example, navigation is switched off.

<SAP_BW_URL cmd="release_data_provider" data_provider="dp" template_id="template_2" apply_cmd_on_target="X" cmd_1="item=*&multi=X&generate_links=">

4. Swap the axes of DataProvider 1 and place the 0Country characteristic in the rows

<SAP_BW_URL cmd=“SWITCH_AXES“ data_provider=“dp“ cmd_1=“data_provider=dp&cmd=expand&iobjnm=0Country&axis=y“>



Using Forms Use With HTML forms you can integrate input fields easily into an HTML page. You can also use this HTML technology to create BEx Web applications.

Features Web Template Parameterization

By using forms, you can set customized parameters when calling up Web applications. Do this by creating an HTML document with a form from which the actual Web application URL is called up with set parameters.

After calling up the following HTML document, the user is offered a form in which he or she can choose a calendar year and a country from dropdown boxes. After clicking on submit, the Web application appears with preset filters in the query views.

<html> <body> <table> <form method="POST" Action="

http://myAppServer:myPort/SAP/BW/BEx?CMD=LDOC&template_id=yourTemplate&FILTER_IOBJNM_1=0CALYEAR&FILTER_IOBJNM_2=0COUNTRY ">

<tr> <td>calendar year</td> <td><select size="1" name="FILTER_VALUE_1">

<Option value="1997">1997</Option> <Option value="1998">1998</Option> <Option value="1999">1999</Option> <Option value="2000">2000</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">Great Britain</Option> <Option value="JP">Japan</Option> <Option value="RU">Russia</Option> <Option value="ES">Spain</Option> <Option value="US">USA</Option>

</table> <input type="submit" value="Submit" name="Submit"> </form> </body>



</html>

Buttons and Forms in Web Templates

<form method="POST" action="<SAP_BW_URL DATA_PROVIDER=’*’ MULTI=’X’ FILTER_IOBJNM_1=’0CALYEAR’ FILTER_IOBJNM_2=’0COUNTRY’>">

<table>

<tr> <td>calendar year</td> <td><select size="1" name="FILTER_VALUE_1">

<Option value="1997">1997</Option> <Option value="1998">1998</Option> <Option value="1999">1999</Option> <Option value="2000">2000</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">Great Britain</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>

You can also generate the <option> tags from the BW system. Do so using the Web item Dropdown Box. Set the attributes ONLY_VALUES (Only Display Values) to ‘X’ and GENERATE_CAPTION (Generate Caption) to ‘ ‘. As a result, the system generates the characteristic values of the InfoObjects as an <option> tag. You can then set the enclosing select and form tag into your HTML coding as you require. You can use this to create a multi-select box for example – displayed in the example below, in order to refrain from sending the request to the server until all dropdown boxes. <form name="form_1" method="post" action="<SAP_BW_URL DATA_PROVIDER='DATAPROVIDER_1' FILTER_IOBJNM_1=’MYOBJ_1’ FILTER_IOBJNM_2='MYOBJ_2'>">

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

<object>

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

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

<param name="NAME" value="DROPDOWNBOX_1">

<param name="ITEM_CLASS" value="CL_RSR_WWW_ITEM_FILTER_DDOWN">

<param name="DATA_PROVIDER" value="DATAPROVIDER_1">

<param name="GENERATE_CAPTION" value="">

<param name="IOBJNM" value="MYOBJ_1">



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

ITEM: DROPDOWNBOX_1

</object>

</select>

<select name="FILTER_VALUE_2" size="1">

<object>



<param name="NAME" value="DROPDOWNBOX_2">

<param name="ITEM_CLASS" value="CL_RSR_WWW_ITEM_FILTER_DDOWN">



<param name="IOBJNM" value="MYOBJ_2">

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

ITEM: DROPDOWNBOX_2

</object>

</select>

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

</form>

Buttons that filter the Data Provider ‚View1’ according to calendar years <form method="POST" action="<SAP_BW_URL DATA_PROVIDER=’View1’ FILTER_IOBJNM=’0CALYEAR’>"> <input type="submit" value="1998" name="FILTER_VALUE"> <input type="submit" value="1999" name="FILTER_VALUE"> <input type="submit" value="2000" name="FILTER_VALUE"> </form>



Use of JavaScript Functions Use You can execute commands or command sequences with JavaScript as well as by using <SAP_BW_URL> tags.

Another JavaScript application is the enhancement of the context menu to include customer-specific entries.

All subsequent examples refer to excerpts from JavaScript.

Features You can choose from the following functions:

Send Commands [Seite 238]

Enhancing the Context Menu with JavaScript [Seite 245]

Properties of Page Objects [Seite 251]

Logon Language [Seite 258]



Send Commands Use You have to create a URL before you can send it. The following options are available:

• Use the <SAP_BW_URL> tag

• Using the BW JavaScript function <SAP_BW_URL_Get>(). This produces the same result as the <SAP_BW_URL> tag, but can also be called up outside of your own frame.

Features JavaScript Function SAP_BW_URL_GET

Return value Start of an URL for calling an instruction that should be executed in the same page context.

Prepare Bookmark URL

url = "<SAP_BW_URL CMD='BOOKMARK'>";

produces the same result as

url = "<SAP_BW_URL>" + "&CMD=BOOKMARK";

or

url = SAP_BW_URL_Get() + "&CMD=BOOKMARK";

There are a number of JavaScript functions for sending instructions. As a result, functions are made available that simplify the management of windows. For example, these functions allow properties dialog boxes to be called up in separate windows. These functions take into account whether or not the Web browser can use JavaScript. Thus, with a pocket IE device, no new windows are generated.

You can choose from the following JavaScript functions:

Execute URL in the Same Window [Seite 239]

Execute URL in a New Window [Seite 240]

URL from a New Window in the Opening Window [Seite 241]

Close Window [Seite 242]

Execute Form in a New Window [Seite 243]

Execute Form in the Opening Window [Seite 244]



Execute URL in the Same Window Use JavaScript function for sending commands.

Features JavaScript Function SAPBWOpenURL


url URL to be launched.

Example Send Bookmark URL

SAPBWOpenURL(SAP_BW_URL_Get() + "&CMD=BOOKMARK");

or in HTML:

<a href="JavaScript:SAPBWOpenURL(SAP_BW_URL_Get() + '&CMD=BOOKMARK');">Create Bookmark</a>

Open SAP Portals Homepage

SAPBWOpenURL("http://www.sapportals.com");



Execute URL in a New Window Use JavaScript function for sending commands.

Features The URL is executed in a new window (output device permitting). This can be useful for selecting filter values and in properties dialogs.

JavaScript Function SAPBWOpenWindow


url URL to be launched.

Name Window name

Width Width of the window

Height Height of the window

Example Call Select filter value dialog for characteristic 0Costcenter of Data Provider ABC

SAPBWOpenWindow(SAP_BW_URL_Get() + "&CMD=PROCESS_HELP_WINDOW&HELP_SERVICE=DP_VIEW_FILTER&DATA_PROVIDER=ABC&IOBJNM=0COSTCENTER","FILTER",800,600);

or in HTML:

<a href="JavaScript:SAPBWOpenWindow(SAP_BW_URL_GET() + '&CMD=PROCESS_HELP_WINDOW&HELP_SERVICE=DP_VIEW_FILTER&DATA_PROVIDER=ABC&IOBJNM=0COSTCENTER','FILTER',800,600);">Define filter value for cost center</a>

Display tailor-made form in a new window

SAPBWOpenWindow("http://.../CustomerForm.htm","CONFIG",300,200);

Open SAP Portals homepage in a new window

SAPBWOpenWindow("http://www.sapportals.com","SAPPORTALS",800,600);



URL from a New Window in the Opening Window Use JavaScript function for sending commands.

Features You can send a URL on the opening window from a new window with this function. The properties of the output device are taken into acccount here.

JavaScript Function SAPBWSetOpenerUrl


url URL to be launched in the opening window.

close

true = close, false = leave open

Then close window

Example Start a new Web application in the main window

SAPBWSetOpenerUrl(SAP_BW_URL_Get() + "&CMD=LDOC&TEMPLATE_ID=NewTemplate");

or in HTML:

<a href="JavaScript:SAPBWSetOpenerUrl(SAP_BW_URL_GET() + "&CMD=LDOC&TEMPLATE_ID=NewTemplate");">New Web report</a>



Closing Windows Use JavaScript function for sending commands.

Functions With this function you can close a window without having to execute a command.

The properties of the output device are taken into consideration. If the output device does not accept JavaScript, the function pages back by one page.

JavaScript Function SAPBWCloseWindow

Example Close window

SAPBWCloseWindow();

or in HTML:

<a href="JavaScript:SAPBWCloseWindow();">Close window</a>



Executing a Form in a New Window Use JavaScript function for sending commands.

Functions The form is executed in a new window (if the output device permits this). You can use this function to create your own forms for control in a Web template.

JavaScript Function SAPBWWForm


name Window name

formname Name of form

width Width of the window

height Height of the window

Example Execute a Form in a New Window

SAPBWWForm("WindowName","FormName",800,600);

or in HTML:

<a href="JavaScript:SAPBWWForm("WindowName","FormName",800,600);">Evaluate form in a new window</a>



Executing a Form in the Opening Window Use JavaScript function for sending commands.

Functions You can execute a form on the opening window from a new window with this function.

The properties of the output device are taken into consideration.

JavaScript Function SAPBWOpenerSubmitForm


formname Name of form

close

true = close, false = leave open

Then close window

Example Execute form in the opening window and close window

SAPBWOpenerSubmitForm("FormName",true);

or in HTML:

<a href="JavaScript:SAPBWOpenerSubmitForm('FormName',true);">Execute form and close window</a>



Enhancing the Context Menu with JavaScript Use As well as being able to make entries in the context menu visible, entries in the enhanced menu visible or entries in the enhanced menu invisible, you can also hang scenario-specific entries in the menu. There are several options:

• You define the new entries for the Web template properties with the object tag. You can find additional information under Object Tag for the Properties of Web Templates [Seite 125] and Enhancing Context Menus [Seite 139].

• You hang the new entries in the context menu with a JavaScript function. You can find additional information under Adding Menu Entries with JavaScript [Seite 246] and Command Processing [Seite 248].

In both cases you must write a JavaScript function that processes the menu entry selection.



Adding a Menu Entry using JavaScript Use You can add new entries to the context menu either using the Web template property or with a JavaScript call.

Functions JavaScript Function SAPBWAddToMenu


label Labeling text in the menu

func JavaScript function for processing the command

You implement this function in JavaScript and use it to execute commands after you have selected the menu entry.

parameter Free parameter

This parameter is passed to the JavaScript function ‘func’ and you can evaluate it there as required. The parameter allows you to use a function ‘func’ for more than one menu entry.

cell_type

‘ ’ = No restriction

‘CHARACTERISTIC’ = Characteristic

‘CHARACTERISTIC_VALUE’ = Characteristic value


‘STRUCTURE_MEMBER = Structural component


‘EXCEPTIONS’ = Exceptions item

‘CONDITIONS’ = Conditions item

‘DOCUMENT_LIST’ = Document list item

Context of the entry

If you want the menu entry to appear only in certain contexts and not in all context menus, you can define this with ‘cell_type’ and ‘filter’.



filter

Context of the entry

Different values are relevant here, depending on the value of ‘cell_type’:

‘CHARACTERISTIC’, ‘CHARACTERISTIC_VALUE’, ‘STRUCTURE’, ‘STRUCTURE_VALUE’: Iobjnm

‘EXCEPTIONS’: Exception ID

‘CONDITIONS’: Condition ID

‘DOCUMENT_LIST’: Document ID

See Examples.

visibility


‘X’= Displayed in the “basic menu”


Visibility of the entry

Here you define if the entry is to appear in the basic menu or in the enhanced menu.

position

‘TOP’ = Before the “normal” entries

‘BOTTOM’ = After the “normal” entries

Position of the entry

The entries are inserted in the order in which they were called. You can choose if the entry is to appear before the “normal” entries or after them in the menu. You cannot position the entries in between the “normal” entries.

Data_provider Name of the data provider

Name of the data provider (if the entry is to be made only for a specific data provider).

Item Name of the Web item

Name of the Web item (if the entry is to be made only for a specific Web item).

Example See the examples under Command Processing [Seite 248]



Command Processing Use When you enhance the context menu with customer-specific entries (with Web template properties or JavaScript function 'SAPBWAddToMenu'), you must define a JavaScript function that is executed when a customer-specific entry is selected. This function is responsible for processing the command.

Features The function must support the following interface:

JavaScript Function JavaScript function for processing the command


parameter Free parameter The parameter makes it possible to process more than one menu entry with one function. See Examples.

cell_type

' ' = No special

‘CHARACTERISTIC’ = Characteristic

‘CHARACTERISTIC_VALUE’ = Characteristic value


‘STRUCTURE_VALUE’ = Structure component value


'EXCEPTIONS' = Web Item List of Exceptions

'CONDITIONS' = Web Item List of Conditions

'DOCUMENT_LIST' = Web Item List of Documents

Context of cell

Filters Context of cell

Different values are suitable, depending on the

‘CHARACTERISTIC’, ‘CHARACTERISTIC_VALUE’, ‘STRUCTURE’, ‘STRUCTURE_VALUE’: Iobjnm ‘EXCEPTIONS’: Exception ID ‘CONDITIONS’: Condition ID ‘DOCUMENT_LIST’: Document ID See Examples.

value of ‘cell_type’:



parameter1 Exact definition of the context of the cell cell_type = 'CHARACTERISTIC_VALUE': Key for characteristic value cell_type = 'STRUCTURE_VALUE': STRUCTURE_MEMBER_ID_1

parameter2 Exact definition of the context of the cell cell_type = 'CHARACTERISTIC_VALUE': Node type for a hierarchy node cell_type = 'STRUCTURE_VALUE': STRUCTURE_MEMBER_ID_2

item Name of the Web item on which the menu is called

dataprovider Name of the data provider for which the menu is called up

x Cell is on data column x This parameter is needed especially for the report/report interface.

Y Cell is on data row y This parameter is needed especially for the report/report interface.

You can use all the JavaScript functions that were listed for processing.

Example <SCRIPT language="JavaScript">  </SCRIPT>

"&IOBJNM=0M+ "&FILTER_VALUE= "&FILTER_NODE_IOB



Properties of Page Objects Use This section lists the JavaScript functions for the properties of Web items and data providers:

• You can access the current attribute value of a Web item. See Web Item Attributes [Seite 252]

• You can determine which characteristics a data provider has. See Data Provider Characteristics [Seite 253].

• You can specify the properties of a Web template. See Determining Web Template Properties [Seite 255].



Web Item Attributes Use You can access the current attribute values of a Web item using this JavaScript function. For example, you can specify whether a Web item is visible. This will help you to create a Web application in which you can switch between two views, for example between a chart and a table, using a link.

Features JavaScript Function SAPBWGetItemProp


Name Logical name of the Web item

Return value Array with Web item properties

The information is stored as follows:

new Array(itemName, new Array(attributeName1,attributeValue1), new Array(attributeName2,attributeValue2), ...)

Specifying whether a Web item is visible:

<SCRIPT language="JavaScript">



</SCRIPT>

if (prop[i][0] == "HIDDEN") hidden



Characteristics for Data Providers Use You can use this JavaScript function to determine which characteristics belong to a data provider. By doing this, you can then, for example, fill a dropdown box for changing drilldowns with the relevant characteristics and do not have to create a dropdown box manually for each data provider.

Moreover, this function is language-independent, which means the selections are adjusted automatically for each language. The texts are shown according to the logon language.

Features JavaScript Function SAPBWGetDataProviderDimensions


Name Logical name of the saved query view

Return value Array of characteristics and structures of the data provider

The individual characteristics and structures are stored as arrays, as in the example:

new Array(dimArray1, dimArray2, ...)

The individual characteristics and structures have the following structure:

new Array(iobjnm,is_structure ( ,X),hierarchyAssigned( ,X), activeHierarchy( ,X), axis (X,Y, ), filtered ( ,1 (single value), X(multiple filter values)), caption, unsupported properties)

There are other properties in addition to those listed, but these have not yet been officially released.

Listing characteristics and structures:




</SCRIPT>



Specifying Properties for Web Templates Use With this JavaScript function you can specify properties for Web templates. See also Object Tag for Properties of Web Templates [Seite 125]. For example, you can specify a technical name for the Web template or decide if dialogs need to be displayed in a new window.

Features JavaScript Function SAPBWGetProperty


Name Name of Web Template Property

SUPPORTS_OPEN_WINDOW: Are you permitted to open new windows? (true, false)

SUPPORTS_DOCUMENTS: Can document links be displayed? (true, false)

SUPPORTS_EXPORT: Is an export according to XLS/CSV possible? (true, false)

SUPPORTS_PERSONALIZATION: Is personalization possible? (true, false)

TEMPLATE_PERSONALIZED: Is the Web template already personalized? (true, false)

NO_BOOKMARKING_SUPPORTED: Are bookmarks impossible? (true, false)

SUPPORTS_VARIABLE_SCREEN: Is a variable screen possible? (true, false)

DD.MM.YYYY, 2: MM/DD/YYYY, 3: MM-DD-:

ACCESSIBILITYMODE_ACTIVE: Web h parameter

also Barrier Freedom

DATE_FORMAT: Date format (1:

YYYY, 4: YYYY.MM.DD, 5: YYYY/MM/DD, 6YYYY-MM-DD)

template was called up witACCESSIBILITY=X (seefor Web Applications [Extern]) (true, false)

TEMPLATE_ID: Technical name for Web template

RUNS_AS_IVIEW: Web Application runs as iView (true, false)

Object Tag for RRI_TARGET_FRAME: Attribute RRI_DISPLAY_TARGET (see Properties of Web Templates [Seite 125])

Return value See above



The Web template properties do not have to completely agree with the set properties in the Web template. Sometimes when the device recognition properties are switched off, the Web template properties are then activated.

Example Specifying the technical name of the Web template




</SCRIPT>



Calendar for Date Filter Use You can use this JavaScript function to call up a calendar. When you select a value, the system filters the data characteristic for the specified DataProvider.

Features JavaScript Function SAPBWSetFilterByCalendar


dataProvider Logical name of the DataProvider

When the filter operation is only to be applied to a DataProvider, specify its logical name here.

dataProviderArray Logical name of data provider

When the filter operation is to be applied to several data providers, specify their logical names here, for example, new Array (“DP1”,“DP2”,“DP3”)

iobjnm Date characteristic

The system is to filter according to this characteristic.

displayDate (optional) Start date

Date the calendar displays when it appears. This parameter is optional. The date format has 4 characters for the year, 2 for the month and 2 characters for the day: YYYYMMDD

Filter DP1 according to 0CALDAY

<a href=”Javascript:SAPBWSetFilterByCalendar(‘DP1’,’null’,’0CALDAY’,’20020213’);”>Filter Calday</a>



Logon Language Use With this function you can define the logon language and thereby take the different input formats of the various languages into consideration in JavaScript.

Features ript Function SAP_BW_Get_Language JavaSc

Return value Logon Language

For example, EN for English and DE for German.



Language-Dependent Texts Definition By using this BW-specific tag, you can install language-dependent texts in a Web application.

Use You create text elements for an ABAP report. These can then be translated.

With the help of the SAP_BW_TEXT tag that you insert into a Web template, you can access the texts as follows:

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

You can also use language-dependent headings for Web items. You can specify the headings as parameters either in the object tag of the Web item

<param name=’CAPTION’ value=’SAP_BW_TEXT?PROGRAM=MYREPORT&KEY=001’>

Or fill the heading in the Web Application Designer as follows:

SAP_BW_TEXT?PROGRAM=MYREPORT&KEY=001

You can find additional information about language-dependent texts under Creating ABAP Programs for Maintaining Language-Dependent Texts [Seite 260].



Creating ABAP Programs for Maintaining Language-Dependent Texts Use To make Web applications independent from static texts, you can maintain and translate the text in an ABAP table. The Web application is then filled with the corresponding texts according to the logon language.

Prerequisites You are in the ABAP Editor (transaction SE38)

Procedure ...

1. In the Program field enter the name of the program, for example ZHTML_TEXTS and in the subobject screen, select Source Code.

2. Choose (Create). You reach the ABAP: Program Properties <Name of Program> Change screen.

3. Enter the title of the program, for example Web Application Texts.

4. Under Type in the Attributes field, choose Executable Program and then Save. You reach the Create Object Catalog Entry dialog box.

5. In the Attributes field under Package enter $TMP and save the program as a Local Object.

You have created an ABAP report called ZHTML_TEXTS

6. In the menu bar choose Goto → Text Elements → Text Symbols. You reach the ABAP Text Elements: Display Text Symbols Language English screen. Choose (Create <-> Change).

Enter your texts in the empty table. ...

a. In the Sym field enter the numerical key of the new text element (0-999), for example, 001.

b. In the Text field, enter the name of the text element, for example, Credit Memos.

The dLen field is filled automatically with the actual length of the text you entered, for example, 12 in the case of Credit Memos.

c. In the mLen field, enter the maximum length of the text field.

If the maximum length of the text field (mLen) is smaller than the actual length of the text field (dLen), the system asks you whether you want the text to be shortened to the maximum length.

d. When you have entered all your texts, choose (Activate). You reach the ABAP Text Elements: Change Text Symbols Language English screen.

7. In the menu bar of the ABAP Text Elements: Change Text Symbols Language English, choose Goto → Translation. You reach the Target Language for Translation screen.

...

a. Select the target language, into which you want to translate the texts, for example, DE and choose (Continue). You reach the Translation: ABAP Text Pool: <Name



of Program> ($) from Language <X> to <Y>, on which your texts and translation proposals from the ABAP text pool are displayed. For example, “Credit Memos” is translated as “Gutschriften”. You can transfer the proposals or edit them as you wish.

The program generated the text translations from the ABAP text pool if corresponding entries are available there. For texts without proposals you have to enter the translation yourself.

b. Choose Save.

Result In the Web template, you can now insert the following tag for the example text used here ZHTML_TEXTS: <SAP_BW_TEXT PROGRAM=’ZHTML_TEXTE’ KEY=‘001’>.

The command inserts the text that you maintained with the key 001 in the table, in accordance with the logon language in the Web template, for example as the table title.

<th><SAP_BW_TEXT PROGRAM=‘ZHTML_TEXTE’ KEY=‘001‘></th>



More Complex Examples of Applications In th ore complex examples of applications that show you how you can

our own cockpits and execute command sequences in an optimized way with the help of URLs and with the JavaScript functions. To understand the examples, you need to

ave an understanding of JavaScript and HTML.

wing examples of applications are available:

ally Changing Attributes [Seite

e following you will find mcreate ycommand h

The follo

Dynamic 263]

Using Several Tab Pages [Seite 266]

Example Scenario for the Parameter NO_OUTPUT [Seite 270]

XML-Web Item: Data Provider Information [Seite 274]



Dynamically Changing Attributes A toggle button needs to be activated and deactivated for the alternate table styles. The toggle

changes according to the currently set attribute (ALT_STYLES) for the table.

, a toggle button is created in HTML. The style class for the toggle button is set

source object tags -->

param name="OWNER" value="SAP_BW">

param name="NAME" value="DATAPROVIDER_1">

<param name="DATA_PROVIDER_ID" value="">

PROVIDER: DATAPROVIDER_1

</object>

"OWNER" value="SAP_BW">

am name="CMD" value="SET_PROPERTIES">

PLE_TEMPLATE_1 ">

TEMPLATE PROPERTIES

ample Template 1</TITLE>

href= "/sap/bw/mime/BEx/StyleSheets/BWReports.css" type="text/css" rel="stylesheet">

/* This function switches the attribute ALT_STYLES (alternate Tablestyles) for item mytable

W Server */ function switch_table_style(mytable) {

1;i<prop.length;i++){

if (prop[i][0] == "ALT_STYLES") table_style = prop[i][1];

}

}

if (table_style =='X') {

button style

To do thisdynamically.



</script>

</HEAD>

<BODY>

<P><object>



<param name="NAME" value="TABLE_1">

<param name="ITEM_CLASS" value="CL_RSR_WWW_ITEM_GRID">



<param name="WIDTH" value="399">

ITEM: TABLE_1

</object></P>



<table class="SAPBEXBtnStdBorder" cellspacing="0" cellpadding="0" border="0"><tr><td>

<table>

<tr>

<td class="SAPBEXBtnStd" id="mybutton1"><A href="javascript:switch_table_style('TABLE_1');">Alternate Styles</A>

table_style = 'X';

/* function

function



</td>

</tr>

</table>

</td>

</tr>

</table>






</script>

</BODY>

</HTML>

If you copy the code from the example, make the following changes in the formatting:

• Remove the space between the character ‘=’ and ‘”’ in the BW object tags.

• Make sure that the character string for HTML comments is set correctly. Before ‘<! ‘ (Beginning of HTML comment) or before ‘>’ (end of HTML comments) there should be two minus signs / hyphens (--).



Using Several Tab Pages In this example, a tab page is to be created. Tab pages can also be created using frameset technology in which different Web templates are used. This example uses DHTML to create the tab page; all objects are contained in a Web template.

You cannot work with pure DHTML since the complete page is frequently reloaded for server requests. Instead, the page status must be transferred back to the server. A dedicated BW object whose attribute is set or not set to ‘hidden’ is suitable here.

The HTML tags that display the tab pages are accessed via head_TABx. X is a whole number counting up from 1.

The HTML tags for the actual display area are accessed via TABx. There is a Web item in each display area (technical name: TABx). Additional Web items can also be added. The technical names of these Web items must begin with TABx.

When switching the tab pages, a request is sent to the server that sets the hidden attribute of the appropriate Web item to ‘ ‘. All other Web items are set to hidden=’X’.

The JavaScript function set_actual_tab checks which Web item (TABx) is currently visible. The respective tab page is marked as selected for this Web item. For other Web items, the associated display area is switched to hidden.

From Release SAP BW 3.5, you can also work with the Web item Web Template as an alternative. When you do this, each display area is saved in a subtemplate. The subtemplates are inserted into the main template using the Web Template Web item and are made visible or hidden as needed. You can find more information on the Web Template Web Item under Web Template [Seite 100].



<object>



<param name="NAME" value="DATAPROVIDER_2">

<param name="DATA_PROVIDER_ID" value="">

DATA_PROVIDER: DATAPROVIDER_2

</object>

<object>



<param name="NAME" value="DATAPROVIDER_1">

<param name="DATA_PROVIDE ID" value="">


</object>

<object>

R_




<param name="CMD" value="SET_PROPERTIES">

<param name="TEMPLATE_ID" value="EXAMPLE_TEMPLATE_2">

TEMPLATE PROPERTIES

</object>

<HTML>

<HEAD>

<TITLE>BW Web Application</TITLE>

<link href= "/sap/bw/mime/BEx/StyleSheets/BWReports.css" type="text/css" rel="stylesheet">




</script>

</HEAD>

<BODY>

<table cellspacing="0" cellpadding="5" border="0" id="tabheader">

<tr>

<td class="SAPBEXTbsTab" id="head_TAB1"><A href="javascript:goto_tab('TAB1')">Tab 1</A>

</td>

<td class="SAPBEXTbsTab" id="head_TAB2"><A href="javascript:goto_tab('TAB2')">Tab 2</A>

</td>

</tr>

</table>

<table width="100%" class="SAPBEXTbsBdyEdg" cellspacing="0" cellpadding="5" border="0">

<tr>

<td valign="top" >

<span id="TAB1">

<object>



<param name="NAME" value="TAB1">



ITEM: TAB1

</object>

</span>

<span id="TAB2" >

<object>



<param name="NAME" value="TAB2">



<param name="HIDDEN" value="X">

ITEM: TAB2

</object>

</span>

</td>

</tr>



</table>




/script> <

</BODY>

</HTML>

If you want to copy the coding from the example, you need to remove the space

gs. between ‘ =’ and ‘ “ ‘ in the BW object ta



Example Scenario for the Parameter NO_OUTPUT ample scenario, you use a frameset with a display area and a control frame. You want to

display area from the control frame. For each structure element of the data provider, ctor should be set to 1,000. Since, potentially, there could be some structure

of commands becomes to large due to the length mmands (SET_VALUE_PROPERTIES) are sent meter NOT_OUTPUT is used during this process so mand.

TPUT_EXAMPLE_FRAMESET

HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" 3.org/TR/html4/frameset.dtd">

<title>No Output Example Frameset Template</title>

PLATE_ID='NO_OUTPUT_FRAME_TOP'>"

' _DISPLAY'>" name="display">

es>

er doesn’t support frames

<noframes>

</frameset>

</html>

The frameset template loads the Web template NO_OUTPUT_FRAME_TOP into the upper frame and the Web template NO_OUTPUT_FRAME_DISPLAY into the lower frame.

In the exinfluence thethe scaling faelements, it could happen that the sequence limitations for URLs. For this reason, the coindividually to the display template; the parathat the data are read only after the last com

The following describes the example scenario for the involved Web templates:

Web Template NOT_OU

<!DOCTYPE"http://www.w

<html>

<head>

</head>

<frameset rows="20%,80%">

<frame src="<SAP_BW_URL cmd='LDOC' TEMname="Top">

<frame src="<SAP_BW_URL cmd='LDOCTEMPLATE_ID='NO_OUTPUT_FRAME

<nofram

Brows

Note that this example can only be edited in text mode due to the use of framesets in the Web Application Designer. For more information, see Enhanced Editing in Text Mode [Extern].

Web Template NO_OUTPUT_FRAME_DISPLAY <HTML>


<object>



<param name="OWNER" value="SAP_BW"/>

<param name="CMD" value="SET_DATA_PROVIDER"/>

<param name="NAME" value="DATAPROVIDER_1"/>


</object>

<object>


<param name="CMD" value="SET_PROPERTIES"/>

<param name="TEMPLATE_ID" value="NO_OUTPUT_FRAME_DISPLAY"/>

<link href= "/sap/bw/Mime/BEx/StyleSheets/BWReports.css" type="text/css" rel="stylesheet"/>

<object>


<param name="CMD" value="GET_ITEM"/>

<param name="NAME" value="TABLE_1"/>

<param name="ITEM_CLASS" value="CL_RSR_WWW_ITEM_GRID"/>

<param name="DATA_PROVIDER" value="DATAPROVIDER_1"/>

ITEM: TABLE_1

</object></P>

<P id="keyfigures" style="DISPLAY: none; VISIBILITY: hidden"><object>



<param name="NAME" value="DROPDOWNBOX_1"/>

<param name="ITEM_CLASS" value="CL_RSR_WWW_ITEM_FILTER_DDOWN"/>


<param name="GENERATE_CAPTION" value=""/>

<param name="IOBJNM" value="BHEFB4AILNIG728R8DP3ET51R"/>

<param name="SHOW_LABEL" value=""/>

<param name="ONLY_VALUES" value="X"/>

ITEM: DROPDOWNBOX_1

</object></P>

</BODY>

</HTML>

TEMPLATE PROPERTIES

</object>

<HEAD>

<META NAME="GENERATOR" Content="Microsoft DHTML Editing Control">


</HEAD>

<BODY>

<P>



In addition to containing the table for data display, the Web template contains the Web item Dropdown Box, with which the structure elements can be selected. This Web item possesses the attribute SHOW_LABEL=” “, ONLY_VALUES=X and GENERATE_CAPTION=” “. This leads to generation of <Oprtion> tags only. The Web item can be found within a <P> tag that is switched to hidden. In order to address the <P> tag, an ID is also assigned.

Web Template NO_OUTPUT_FRAME_TOP <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"

"http://www.w3.org/TR/html4/loose.dtd">

<html>


<object>



<script>



</script>

</head>

<body>

<A href="javascript:set_scaling()">Set Scaling factor</A>

</body>

</html>

The complete JavaScript logic is contained in this Web template. If you click on the link Set Scaling Factor link in the Web application, the JavaScript function set_scaling is called. This JavaScript function processes the generated <Option> tags of the Web item from the Web template NO_OUTPUT_FRAME_DISPLAY. If a corret tag is found, the tag attribute „value“ is read. The Unique-ID (UID) of the structure element is found here that is used to change the scaling factor of the structure element with the help of the Web API command SET_VALUE_PROPERTIES. The NO_OUTPUT parameter is used so that the data are not yet read. Once all of the key figures have been processed, a command is sent to the server again without setting the parameter NO_OUTPUT this time. The data is read and returned.



XML Web Item: Data Provider Information For clarity we are providing a short example of using the Web item Data Provider Information. In order to make good use of the XML Web item, you will need JavaScript or XSLT knowledge. In this example, the internal values of a data provider will be read and displayed in a message box using the Web item Data Provider - Information [Seite 99]).

<HTML>


<object>


<param name="CMD" value="SET_DATA_PROVIDER"/>

<param name="NAME" value="DATAPROVIDER_1"/>


</object>

<object>



<param name="TEMPLATE_ID" value="XML_EASY_EXAMPLE"/>

TEMPLATE PROPERTIES

</object>

<HEAD>

<META NAME="GENERATOR" Content="Microsoft DHTML Editing Control">


<link href= "/sap/bw/Mime/BEx/StyleSheets/BWReports.css" type="text/css" rel="stylesheet"/>




</script>

</HEAD>

<BODY>

<P><object>



<param name="NAME" value="TABLE_1"/>

<param name="ITEM_CLASS" value="CL_RSR_WWW_ITEM_GRID"/>


ITEM: TABLE_1

</object></P>

<P><object>



<param name="NAME" value="XMLQUERYVIEWDATA_1"/>

<param name="ITEM_CLASS" value="CL_RSR_WWW_ITEM_XML_QUERYVIEW"/>


<param name="GENERATE_LINKS" value=""/>

<param name="GENERATE_CAPTION" value=""/>

<param name="NAVIGATIONAL_STATE" value=""/>

<param name="RESULT_SET" value="X"/>

ITEM: XMLQUERYVIEWDATA_1

</object></P>

<A href="javascript: alert_internal_values();">Click here to see the internal values of the table </a>

</BODY>

</HTML>

The generated XML is provided here to explain the JavaScript function alert_internal_values:

<xml id="XMLQUERYVIEWDATA_1">

<queryview status="DataAvailable">

<?xml version="1.0" encoding="iso-8859-1"?>

<asx:abap xmlns:asx="http://www.sap.com/abapxml" version="1.0">

<asx:values...</asx:values></asx:abap>

<?xml version="1.0" encoding="iso-8859-1"?>

<asx:abap xmlns:asx="http://www.sap.com/abapxml" version="1.0">

<asx:values>

<CELL_DATA>

<item><CELL_ORDINAL>000000</CELL_ORDINAL><VALUE>1931710.04800</VALUE><FORMATTED_VALUE>$ 1.931.710,05</FORMATTED_VALUE>...</item>



<item><CELL_ORDINAL>000001</CELL_ORDINAL><VALUE>153849431</VALUE><FORMATTED_VALUE>153.849.431 PC</FORMATTED_VALUE>...</item>

...

</CELL_DATA>

</asx:values>

</asx:abap>

</queryview>

</xml

With startnode = document.getElementById('XMLQUERYVIEWDATA_1');

you get the start node <xml id="XMLQUERYVIEWDATA_1">.

The first lower level node of the start node is the tag <queryview>. The first lower level node of this node is the control statement <?xml >. The second lower level node of the <queryview> tag is <asx:abap xmlns:asx="http://www.sap.com/abapxml" version="1.0">. Since only the cell data are of interest for this scenario, the fourth lower level node of the <queryview> tag is relevant. The first lower level node of this tag is <asx:values>. The lower level node of this node is then <CELL_DATA>. Within the <CELL_DATA>, there are individual <item> tags.

In order to get to the internal value (tag <VALUE>) within the <item> tags, the second lower level node has to be considered. The content of the <VALUE> tag is an (implicit) text node, thus it is a lower level node of the <VALUE> tag.



Web Design API for Tables Purpose The Web Design Application Programming Interface (Web Design API) is aimed at Web designers and ABAP programmers that want to create Web applications for highly individual scenarios, such as BI cockpits, based on BEx Web application design and want to change the display of tables or navigation blocks to meet their own requirements.

The Web Design API enables you to modify individual cell data (characteristic values, column headers, value cells, and so on) with relation to content, display and navigation options.

Making good use of the Web Design API for tables depends on the technical design and economic questions. Thus it does make sense to use the Web Design API for Tables in every case. Certain modifications in relation to content, display and navigation options can also be made with the BEx Query Designer [Extern]. Other adaptations can be made with the BW Stylesheets [Extern].

In this way, many changes to the display can be made using BW stylesheets (for example, color) or the Query Designer (for example, scaling). This is especially important when all cells of a cell type (for example, all number values in data cells) are to be changed. When only certain cells of a cell type are to be changed in their display, the Web Design API for Tables with its own CSS classes would be useful.

Complex modifications to the content (for example display as symbol) or to the navigation options (for example, inserting your own links) can usually only be done using the Web Design API for Tables.

Process Flow For extensive information on the required creation of the ABAP class for the Web Design API for Tables, see Creating and Using an ABAP Class [Seite 278].

For extensive information on the options that are available with the Web Design API for Tables for modification of cell contents and display, see Table Interface [Seite 281]. ...

Result The next time you call up the Web template, your class for adjusting the table contents is called up.

For test purposes, you can examine the generation of the HTML in the ABAP debugger. For more information, see Using and Creating ABAP Classes [Seite 278].



Creating and Using ABAP Classes Use The Web Design API for Tables enables you to modify individual cell data in relation to content, display and navigation options. To do this, you create your own ABAP class that inherits the associated properties and parameters from the class CL_RSR_WWW_MODIFY_TABLE and you redefine one or more methods for this class.

Prerequisites You have created a Web application that includes the Web item Table and/or the Web item Generic Navigation Block.

Procedure Create ABAP Class ...

1. From the SAP Easy Access screen, choose Tools → ABAP Workbench → Development → Class Builder (transaction SE24). See also Class Builder [Extern].

You can also use the Object Navigator from the ABAP Workbench (transaction SE 80) to generate a class. See also Object Navigator [Extern].

2. To create a new class, under Object Type, enter a technical name for your class (for example, ZCL_RSR_WWW_MODIFY_TABLE) and choose (Create). The Create Class YourClassName dialog box then appears.

3. Save your class. You get to the Object Catalog screen.

4. Depending on the system configuration in regard to changes and the transport of objects, either choose a package or save your class as a local object. For more information, speak to your system administrator. The Class Builder: Change Class YOURCLASSNAME screen.

5. Choose Superclass on the Properties tab page. Under InCL_RSR_WWW_MODIFY_TABLE as the superclass.

6. To see all of the inherited properties and methods of the class CL_RSR_WWW_MODIFY_CLASS in your ABAP class, choose

herits from, enter

(Save).

7. On the Methods tab page, choose a method (for example, CHARACTERISTIC_CELL or GET_CELL_INFO) that you want to redefine and choose (Redefine).

8. To change the implementation of the method, call up the method name by double clicking.

9. To get back to the original screen, choose (Back)

10. Save your changes.

11. To activate event linking, choose (Activate).

Using an ABAP Class in a Web Template To be able to use the ABAP class you created, it must be included in a Web template. ...



1. Open your Web template that contains the Web item Table and/or Generic Navigation Block in the BEx Web Application Designer.

2. Use the HTML tab page to switch to the HTML view of the Web Application Designer.

3. Navigate to the Object Tag of the Web Item Table and/or the Web Item Generic Navigation Block (CL_RSR_WW_ITEM_GRID and/or CL_RSR_WWW_ITEM_NAV_BLOCK) and insert the following parameter line into the HTML:

<object>…

<param name=“MODIFY_CLASS“ value=”YourClassName”/>

…</object>

<object>…

<param name=“MODIFY_CLASS“ value=”ZCL_RSR_WWW_MODIFY_TABLE”/>

…</object>

4. Save the changes.

5. Execute the Web template in the browser.

Debug ABAP Class For test purposes, you can debug the ABAP class. By setting breakpoints in the redefined methods and using the ABAP debugger, you can determine when the individual methods are called and which information they provide. To better understand the individual methods, you can redefine the methods for test purposes. You can set a breakpoint on the individual method without inserting code. You can see all values for the parameters assigned to the method in the debugger. See also Debugger [Extern]. ...

1. From the SAP Easy Access screen, choose Tools → ABAP Workbench → Development → Class Builder (transaction SE24).

2. Under the object type, enter the name of the ABAP class you created.

3. Choose (Change).

4. Double click on one of the methods in the Methods tab page that you have changed when creating your ABAP class.

5. To set an external (HTTP) breakpoint in your method, in the menu, choose Utilities → Breakpoints → Set/Delete.

• Two types of breakpoints exist: External (HTTP) Breakpoints enable

debugging in the Web browser. Session Breakpoints enable debugging within transactions. BEx Web Applications are usually executed in the Web browser. The query monitor (RSRT2) transaction allows you to display a BEx Web application in the SAP GUI. Depending on how you call up your Web application you can choose the appropriate breakpoint type.

• To be able to set an external breakpoint, you have to set the external debugging to active. You can set external debugging to active in the menu under Utilities → Settings... → ABAP Editor → Debugging in the External Debugging field. .



6. Close all Web browser windows or query monitor instances (RSRT2) before you call the Web application in which you have included your ABAP class. Otherwise the debugger could not stop at the set breakpoint.

7. Execute the Web application in the Web browser or in the query monitor transaction. You reach the ABAP debugger that stops at the breakpoint you set.

Result You have created an ABAP class and have redefined one or more methods to specifically change the display of tables and the generic navigation block with the help of the Web Design API for tables.



Table Interface Use The table interface enables you to display tables or navigation blocks in BEx Web applications as you choose.

Features Your options include anything from making simple changes to the display to making data-specific enhancements to the navigation options and display.

The technical realization is done with an ABAP class. For extensive information on creating the ABAP class and its use in a Web template, see Creating and Using an ABAP Class [Seite 278].

The table interface has the following functions:

• Attributes [Seite 282]

The attributes include the data from the data provider and general information, such as generation parameters of the table (parameters from the URL), as well as information on whether navigation links are to be created or whether the use of JavaScript is allowed.

• Events [Seite 292]

The results enable determination of information on various times, such as at the time of initialization of the table.

• Methods for Manipulation of Cell Contents [Seite 293]

The methods for manipulation of cell contents are central to the table interface. Only implement (redefine) the methods for the cell types that you want to manipulate. Note that generally, not all cells of a cell type are manipulated - only specific cells depending on the characteristic, the key figure and/or the value. These specific cells can be identified using the importing parameters of methods for manipulation of cell contents.

• Service Methods [Seite 307]

Service methods can be used within methods for manipulation of cell contents or within the events. Service methods enable you to generate links, insert JavaScript, send messages, request information on specific cells or on the current navigational state, read the path of symbol directories in the MIME Repository and to determine specific attributes for the table interface.



Attributes Definition Functional components of the table interface.

Structure The following instance attributes of the class are filled automatically. They get their values from the Web application framework.

The attributes are read-only.


N_ITEM_NAME Logical name of the table

This attribute is needed for command URLs. You can use this attribute, for example, to change attributes in the table.

N_GENERATE_LINKS Generate navigation links

If the value = “X”, URLs can be generated.

If the value is blank, the item is for display only. It is not possible to interact with the item.

N_ALT_STYLES Display zebra list

If the value = “X”, the formatting is the same in every other row.

N_STATELESS Calling the Web application without interaction

If the value = “X”, the Web application is called and the session is dismantled on the application server. SAP BW 2.0 supports no further interaction.



N_R_CREATION_PARAMETERS Creation parameters for the table

Using the reference for an instance of the class CL_RSR_PARAMETER, the system is able to read the value-name pairs that have been used in the generation of the table. Methods such as GET are used to read the values.

The parameters of the start URL and the name-value pairs specified in the object tag of the item in the Web template belong to these name-value pairs.

This means that the start URL or object tag (in the Web template) can transfer parameters to the class. This increases the number of times a class can be reused and the different areas where the class can be used, for example, by using customer-specific parameters that configure the class individually.

N_JAVASCRIPT Using Java Script

If the value = “X”, Java Script functions are supported. Otherwise, you must not use Java Script functions, since you cannot be sure that the requesting Web browser supports Java Script.

N_DATA_PROVIDER_NAME Logical name of the data provider

Needed in the generation of navigation URLs.

N_NO_DATA No relevant data found

N_NO_AUTHORIZATION No authorization for displaying data

N_R_DATA_SET Data in the data provider

This attribute is needed only for special applications.

As a rule, the information that is transferred by the method interfaces is enough to determine the cell contents.

For more information see Datasets [Seite 284].



Datasets Definition The dataset contains the data for the query view.

Use Special applications require information that cannot be obtained using the method interfaces. For some applications you need more information than is contained in the cell contents. For example, you need the list of available characteristics or the contents of the dynamic filter before you are able to jump from one report into another.

An understanding of the enhancement described below is not necessary for the use of the table interface.

You have made sure that the data from the dataset (N_R_DATA_SET) is always up to date. The N_SX_VERSION_20A_1 attribute, type RSRDS_SX_DATA_SET_20A_1, is filled automatically. The data consists of both the metadata (a catalog of characteristics (AXIS_INFO) and so on) and the displayed values (AXIS_DATA and CELL_DATA).

Structure The instance attribute N_R_DATA_SET → N_SX_VERSION_20A_1 has the following components:

Component Description

AXIS_INFO [Seite 285] Metadata description of the characteristics, attributes, and structures on the axes.

AXIS_DATA [Seite 287] Characteristic values, attribute values, and structural components according to the sequence they appear in on the axes.

CELL_DATA [Seite 289] Value cells: The cells are arranged by row first, and then by column.

TXT_SYMBOLS [Seite 291] Text elements for the query



AXIS_INFO Definition This component describes the properties of the structures, characteristics, and attributes, and how they are distributed between the axes.

Structure The AXIS_INFO is a table of axes (rows, columns, and filters) with the appropriate axes components.

AXIS_INFO Description

AXIS Axis ID

0 : Columns

1 : Rows

255 : Filters

NCHARS Value cells

The cells are arranged by row first, and then by column.

NCOORDS Number of objects on the axis (number of rows / columns / filter values)

CHARS Characteristics with their attributes and structures on the axis.

The complex table CHARS has the following structure:

CHARS Description

CHANM Name of the characteristic or of the structure

HIENM Hierarchy name, if the hierarchy is active

VERSION Hierarchy version

DATETO Key date for the hierarchy

CAPTION Name of the characteristic or of the structure

CHAPRSNT Characteristic display

0 : key and text

1 : Text

2 : Key

3 : Text and key

4 : Long text

5 : Medium text

6 : No display

ATTRINM Attributes for this characteristic



ATTRINM is a table of the attributes for the characteristic. It has the following structure:

ATTRINM Description

ATTRINM Name of the attribute

CAPTION Name of the attribute

CHAPRSNT Attribute display

0 : key and text

1 : Text

2 : Key

3 : Text and key

4 : Long text

5 : Medium text



AXIS_DATA Definition The component AXIS_DATA describes the contents of the axis.

Structure AXIS_DATA is a table with the following structure:

AXIS_DATA Description

AXIS Axis ID

0 : Columns

1 : Rows

255 : Filters

SET Axis contents

The complex table SET has the following structure:

SET Description

TUPLE_ORDINAL Number of the entry beginning with 0 on the axis

CHANM Name of the characteristic or of the structure

CAPTION Text for the characteristic value

CHAVL Internal key value for the characteristic value

This is needed, for example, for the filter operations.

CHAVL_EXT External key value for the characteristic value

This corresponds with CHAVL after the application of the conversion exit.

NIOBJNM With hierarchy nodes, this is the name of the node characteristic (0HIERNODE for text nodes).

TLEVEL Hierarchy level of the entry

DRILLSTATE Extent to which the entry is expanded (for an active hierarchy).

L : Hierarchy leaf

- : Expanded node

+ : Collapsed node



OPT Only with filters:

EQ : Single value

LT : Less than

LE : Less than or equal to

GT : Greater than

GE : Greater than or equal to

BL : From-value with intervals (two rows)

BH : To-value with intervals

SIGN I : Include

E : Exclude

ATTRIBUTES Attribute values

ATTRIBUTES is a table with the following structure:

ATTRIBUTES Description

ATTRINM Name of the attribute

CAPTION Text for an attribute value

ATTRIVL Key for the attribute value

This describes the contents of an axis.



CELL_DATA Definition The CELL_DATA component describes the value cells.

The number cells of the query view are given as the assigned table of rows for BAPI type BAPI6111CD. If you display the query view data as a table, the assignment of cells corresponds to that of the data block, in which the assignment is run first using the rows and then using the columns.

The index of a specific value is therefore calculated as follows:

Index = Column position + (row position – 1)* number of columns

Structure The data structure is as follows:


CELL_ORDINAL Numbering of the values begins with 0

CELL_ORDINAL is always smaller by 1 than the index of the rows

VALUE Value

FORMATTED_VALUE Formatted value

Unit and currency are used already in this field

VALUE_TYP

‘1’ value cannot be determined

m different currencies

‘5’ zero value

‘9’ surplus

‘D’ date

‘T’ time

‘A’ no authorization for this value

E Value type

The value type accepts the following values:

‘ ’ normal, valid value

‘0’ division by 0

‘3’ value constructed fro

CURRENCY Currency identifier

UNIT Unit identifier



MWKZ Amount/value key figure

The amount/value key figure accepts the following values:

'W' value

‘M’ amount

‘P’ price

‘Q’ ratio

‘%’ percentage value

‘C’ counter

‘F’ real number

‘D’ date

‘T’ time

NUM_SCALE Scaling factors

0 for 1, 1 for 10, 2 for 100, 3 for 1000, ...

NUM_PREC Precision of the number in decimal places

CELL_STATUS Not used

BACK_COLOR Not used



TXT_SYMBOLS Definition The component TXT_SYMBOLS describes the text elements of the query. The text elements are available as a table made up of RRX_TXT_SYMBOLS rows.

Structure The text elements have the following structure (only the most important components):


SYM_TYPE Type of text element

‘V’ for variable

‘F’ for filter value

‘C’ for general text element

SYM_NAME Name of the object

With variables this is the variable name, with filters it is the filter characteristic, and with general text elements it is the name of the element.

A list of the names of the general text elements is stored under Text Elements [Seite 43].

SYM_FS Follow-on record number

A text element can be distributed over several rows, for example, in intervals. This field gives you the row number of a component within a text element. If SYM_FS=0, the text element is a new text element.

SYM_BEGIN_GROUP New group within a text element

Groups are usually separated by semicolons (;)

SYM_CAPTION Name of the text element

SYM_VALUE Value of the component of the text element



Events Definition Functional components of the table interface.

Use Events allow you to initialize tables.

Structure Initialization

Initializing a table: You call this method is before processing. Using the reference from the dataset, you can analyze metadata for the navigational state as well as the data itself. All attributes of the class that were listed beforehand are filled at this point.

Method Start

New Rows

You call the following method before starting a new row. You can execute a suitable initialization for the rows.

Method New_Row

Importing Parameter Description

I_Y New row numbers

Header Completed

The following method is called after you have processed the table header. You can execute a suitable initialization for the rows.

Method Header_Finished


I_Y New row numbers

Completion

This method gives you the option of carrying out further operations after you have finished the table. For example, setting Java Script functions using the method “Set_Javascript_Function” (see Service Methods [Seite 307]) or cleaning up the table.

Method Finished



Manipulating Cell Contents Definition Functional components of the table interface.

Use You can use a set of methods to manipulate cell contents. Only implement the methods for the cell types that you want to manipulate. Standard contents will be used for all other cell types.

Standard contents may change between releases/support packages. If you want to change the contents of a cell, we recommend that you overwrite the contents of, for example, C_CELL_CONTENT completely and do not process the field with REPLACE or a similar operation.

Features You can use the following methods to manipulate cell contents:

• CAPTION_CELL: Headers [Seite 295]

• SCALING_FACTOR_CELL: Scaling Factors [Seite 296]

• CHARACTERISTIC_CELL: Characteristic Values [Seite 297]

• ATTRIBUTE_CELL: Attribute Values [Seite 299]

• STRUCTURE_CELL: Structural Components [Seite 300]

• DATA_CELL: Data Cells [Seite 301]

• ERROR_CELL: Error Cells [Seite 302]

• NAV_BLOCK_LABEL: Label Area of Navigation Block [Seite 303]

• NAV_BLOCK_VALUE: Filter of Navigation Block [Seite 305]

All methods for manipulation of cell contents include Importing and Changing Parameters. The importing parameters provide cell-specific information such as content, style, coordinates, characteristic, key figure, value, etc. The importing parameters depend on cell type. You can use the changing parameters, which provide the standard values, to change the ID of the cell, the cell content, the style of the cell and the extension of the TD tag. As these parameters are method-independent, they are listed only once here.

Changing Parameter Description

C_CELL_ID Cell ID If you leave this parameter empty, the cell has no ID. The ID is used to process the cell contents with JavaScript.

C_CELL_CONTENT Cell Contents The cell contents themselves can be very simple (for example, a number) or very complex (for example, for hierarchy nodes: icons with expanded/collapsed URL and text).



C_CELL_STYLE Style of Cell The style defines the color, font, font size, spacing, and so on of the cell. The styles are defined in the cascading stylesheet. The cascading stylesheet is assigned to the Web template.

C_CELL_TD_EXTEND Extension of TD tag Here you can set the properties such as the width, height, alignment or color of the cell. This parameter is not normally set because many of the properties are already defined when the style is defined.

The cell contents (C_CELL_CONTENT) corresponds to the inside part of the TD tag. The extension of the TD tag is inserted into the opening TD tag. The HTML <td> and </td> is automatically generated by the Web Application Framework:

..._CELL

<td C_TD_EXTEND> C_CELL_CONTENT </td>

The changing parameters can be changed depending on the importing parameters. If the information from the importing parameters is not sufficient, additional information can be found using the attributes or the service method GET_CELL_INFO (see Information for a Specific Cell [Seite 311]).

Detailed information about the individual importing parameters can be found in the description of the methods for the individual cell types. For more information, see the links under “Features”.

You can easily insert MIME objects (images, symbols, logos, etc.) into the contents of the cells. To do this, enter the relative path as a URL, that is, the path information is provided without naming the Web protocol, the host name and the port number. The path should begin with /sap/bw/Mime. This corresponds to the path for service of the SAP Web Application Server (see the transaction maintenance of the service, SICF). Extend the path with the path information for the MIME object in the MIME Repository (transaction SE80) below the /SAP/BW level.

Example:

Path in the MIME Repository: /SAP/BW/BEx/Icons/pixel.gif

Relative path : /asp/bw/Mime/BEx/Icons/pixel.gif

For more information on the use of SAP MIME objects, as well as your own MIME objects, see Storing Stylesheets and Symbols [Extern].



Headers Definition You use the Caption_Cell method to adjust the contents of header cells.

Structure Method Caption_Cell


I_X X coordinate of the cell in the table

I_Y Y coordinate of the cell in the table

I_IS_EMPTY Cell is empty

'X' = empty

I_IOBJNM_ROW Characteristic in the rows

In the rows axis, the characteristic, whose header you want to display in the cell.

I_ATTRINM_ROW Attribute for characteristic in the rows

In the rows axis, the attribute for the characteristic, whose header you want to display in the cell.

I_TEXT_ROW Text for characteristic / attribute

I_IOBJNM_COLUMN Characteristic in the columns

In the columns axis, the characteristic, whose header you want to display in the cell.

I_ATTRINM_COLUMN Attribute for characteristic in the columns

In the columns axis, the attribute for the characteristic, whose header you want to display in the cell.

I_TEXT_COLUMN Text for characteristic / attribute

I_ROWSPAN Number of cells that you want to merge along the rows axis

I_COLSPAN Number of cells that you want to merge along the columns axis

I_IS_REPETITION Repetition

'X' = cell contents is a repetition



Scaling Factors Definition You use the Scaling_Factor_Cell method to adjust the contents of cells that display the scaling factors.

Structure Method Scaling_Factor_Cell




I_TEXT Scaling text

I_IS_SUM Sum total cell

‘X’ = sum total cell

I_NUM_SCALE Scaling factor

I_CURRENCY Currency

I_UNIT Unit



Characteristic Values Definition You use the Characteristic_Cell method to adjust the contents of cells containing values for characteristics.

Structure Method Characteristic_Cell




I_IOBJNM Name of characteristic

I_AXIS Axis on which the characteristics are arranged in the drilldown

'X' = columns, 'Y' = rows

I_CHAVL_EXT Characteristic value in external display

Key value of the characteristic value according to its application in the conversion exit.

I_CHAVL

Characteristic value in internal display

Key value of the characteristic value. This is needed for the filter operations.

I_NODE_IOBJNM Name of the node characteristic

With characteristic nodes and text nodes, you have to specify the characteristic name (0HIER_NODE).

I_TEXT Text for characteristic value

I_HRY_ACTIVE Status of the display hierarchy

‘X’ = active

I_DRILLSTATE Extent to which the node is expanded

'E' = expanded, 'C' = collapsed

I_DISPLAY_LEVEL Display hierarchy level of the node / leaf

I_USE_TEXT Cell contents

'X' = text, ' ' = key





I_FIRST_CELL First data cell of the characteristic value



I_LAST_CELL Last data cell of the characteristic value

I_CELLSPAN Number of cells that you want to merge along the drilldown axis

I_CELLSPAN_ORT Number of cells that you want to merge vertically along the drilldown axis



Attribute Values Definition You use the Attribute_Cell method to adjust the contents of the cells containing attribute values.

Structure Method Attribute_Cell




I_IS_EMPTY Cell is empty

'X' = empty

I_IOBJNM Name of characteristic

I_ATTRINM Name of attribute



I_CHAVL_EXT Attribute value in external display

Key value of the attribute value according to its application in the conversion exit.

I_CHAVL

Attribute value in internal display

Key value of the attribute value.

I_TEXT Text for attribute value

I_USE_TEXT Cell contents

'X' = text, ' ' = key








Structural Components Definition You use the Structure_Cell method to adjust the contents of structural components.

Structure Method Structure_Cell




I_IOBJNM Name of the structure



I_STRUCTUR_MEMBER Name of the structural component

Key value of the structural component.

I_STRUCTUR_MEMBER_2 Name of the structural component of the other structure

Key value of the structural component of a second structure (if a second structure is available). This is needed, for example, for sort operations.

I_TEXT Name of the structural component






I_CELLSPAN_ORT Number of cells that you want to merge vertically along the drilldown axis



Data Cells Definition You use the Data_Cell method to adjust the contents of data cells.

Structure Method Data_Cell




I_VALUE Values of the cell without scaling

I_DISPLAY_VALUE Values of the cell after scaling

I_NUMERICAL_SCALE Scaling factors

I_NUMERICAL_PRECISION Number of places after the decimal point

I_CURRENCY Currency

Three-character currency ID, for example, USD, ATS, or DEM.

I_UNIT Unit

Unit according to the application of the three-character conversion exit.

I_ ALERTLEVEL Alert level

1, 2, 3 = green; 4, 5, 6 = yellow; 7, 8, 9 = red



You can make many changes, for example, choose to display the alerts as icons, or change the way currencies and units are displayed (units as text, for example).



Error Cells Definition You use the Error_Cell method to adjust the contents of error cells.

Structure Method Error_Cell




I_TEXT Error text

I_TYPE Error type (S, E, A, I, W)



Labeling Area of the Navigation Block Definition You can adjust the contents of the labeling cells of the navigation block with method NAV_BLOCK_LABEL.

Structure The area for labeling can be divided in up to 4 columns.

Method NAV_BLOCK_LABEL


I_IOBJNM Technical name of the characteristic or structure

I_IS_STRUCTURE Object is a structure

‘X’ = Yes, ‘ ’ = No

I_AXIS Axis on which the characteristics / structure are arranged in the drilldown


I_CAPTION Label text


'X' = Active


C_CELL1_ID ID of cell 1

If you leave this parameter empty, the cell has no ID. The ID can be used to process the cell contents with JavaScript.




C_CELL1_CONTENT Cell contents 1

The cell contents themselves can be very simple (for example only a number) or very complex (for example for hierarchy nodes: icons with expanded/collapsed URL and text).






C_CELL1_STYLE Style of cell 1

The style defines the color, font, font size, distances, etc. of the cell. The styles are defined in the Cascading Style Sheet. The Cascading Style Sheet is assigned to the template.




C_CELL1_TD_EXTEND Extension of TD tag 1

Here you can set the properties such as the width, height, alignment or color of the cell. This parameter is not normally set because many of the properties are already defined

defined. when the style is




C_CELL1_WIDTH Width of column 1






Filter Area of the Navigation Block Definition You can adjust the contents of the filter cells of the navigation block with method NAV_BLOCK_VALUE.

Structure The area for the filter can be divided in up to 4 columns.

Method NAV_BLOCK_VALUE


I_IOBJNM Technical name of the characteristic or structure

I_IS_STRUCTURE Object is a structure

‘X’ = Yes, ‘ ’ = No

I_AXIS Axis on which the characteristics / structure are arranged in the drilldown


I_CAPTION Label text


'X' = Active



If you leave this parameter empty, the cell has no ID. The ID can be used to process the cell contents with JavaScript.





The cell contents themselves can be very simple (for example only a number) or very complex (for example for hierarchy nodes: icons with expanded/collapsed URL and text).







The style defines the color, font, font size, distances, etc. of the cell. The styles are defined in the Cascading Style Sheet. The Cascading Style Sheet is assigned to the template.





Here you can set the properties such as the width, height, alignment or color of the cell. This parameter is not normally set because many of the properties are already defined when the style is defined.










Service Methods Definition Functional components of the table interface.

Use Service methods are offered along with methods for manipulating cell contents [Seite 293]. You need these when creating new cell contents.

You can use the following service methods:

Creating Navigation URLs [Seite

Features

308]

Information on the Navigation Status [Seite 309]

Information on a Specific Cell [Seite 311]

Symbols [Seite 313]

Sending Messages [Seite 314]

JavaScript Functions [Seite 315]

Determining Specific Attributes for the Table Interface [Seite 316]



Creating Navigation URLs Use You generate command URLs using the following method. This ensures that the request is sent to the correct page instance of the current session.

Features Method GET_URL

Importing parameter Description

I_R_PARAMETER Command parameter

The command parameter is transferred using instances of the class CL_RSR_PARAMETER. Use the methods in this class, for example, ADD, to fill the parameter.

Returning parameter Description

R_URL Command URL

You can also use the following service methods:

Symbols [Seite 313]

Information on the Navigation Status [Seite 309]







Information on the Navigation Status Use This method returns information on the current navigation status. You can call it up at any time.

Features Method GET_STATE_INFOS

Exporting parameter Description

E_THX_AXIS_INFO Distribution of the structures, characteristics and attributes on the axes and their properties

For details about structures, see Dataset [Seite 284] and AXIS_INFO [Seite 285]

E_T_SLICER Dynamic filter

Filter that you can change in navigation and, for example, see in the navigation block.

For details about tables, see Dataset [Seite 284] and Axis Data [Seite 287]

Unlike in the set, the ATTRIBUTES component is not offered.

E_T_TXT_SYMBOLS Query text element

The text element contains general information (for example, the query key date), information about the variable values and information for fixing query filters.

For details about tables, see Dataset [Seite 284] and TXT_SYMBOLS [Seite 291]

In addition, you can use the following service methods:

Creating Navigation URLs [Seite 308]


Symbols [Seite 313]








Information on a Specific Cell Use This method returns details for cells at a specific cell coordinate.

Prerequisites

You cannot call up this method in the START method.

Features Method GET_CELL_INFO


I_ROW Row co-ordinate of cell in table

I_COLUMN Column co-ordinate of cell in table

Exporting parameter Description

E_AXIS Axis of the cell

0 = on the columns, 1 = on the rows, -1 otherwise

E_DATA_ROW Data row

Row coordinate in data area This information is important, for example, when jumping from one report to another.

E_DATA_COLUMN Data column Column coordinate in data area. This information is important, for example, when jumping from one report to another.

E_CELL_TYPE Type of cell 0 = Empty cell 1 = Data cell 2 = Structure component 3 = Characteristic value 4 = Characteristic header 5 = Display attribute value 6 = Display-attribute header 7 = Scaling factor

E_IOBJNM Characteristic/structure name This parameter is filled only for cells of type 2, 3, 4, 5 and 6.

E_ATTRINM Display-attribute name This parameter is filled only for cells of type 5 and 6.




E_T_CELL_RESTRICTIONS Cell Restrictions

Restrictions arising from the position of the cell in the table. For example, there are restrictions on the display of data cells on the axes.

For details about tables, see TDataset [Seite 284]T and TAxis Data [Seite 287]T

Unlike in the set, the ATTRIBUTES component is not offered.

E_S_CELL_DATA Information about data cells Information about data cells, for example, the value of the data cell, is available from here. For details about structures, see TDataset [Seite 284]T and TCELL_DATA [Seite 289]T


TCreating Navigation URLs [Seite 308]T

TInformation on the Navigation Status [Seite 309]T

TSymbols [Seite 313]T

TSending Messages [Seite 314]T

TJavaScript Functions [Seite 315]T

TDetermining Specific Attributes for the Table Interface [Seite 316]T



Symbols Use You use IMG tags in HTML for symbols. To fill the IMG tag attribute SRC, you need the path of the symbol directory from the MIME Repository or the ITS. The following method returns this path:

Features Method GET_ICON_PATH

Returning parameter Description

R_PATH Path to symbol directory

You use this path in the HTML IMG tag for SRC. You only need to enter the screen name.




TInformation on a Specific Cell [Seite 311]T






Sending Messages Use You use the following method to send messages. These appear as a table at the start of the HTML page. You mostly use this function to notify users of errors.

Features Method SEND_MESSAGE


I_CLASS Message class

I_TYPE Message type (I, W, E, A, X)

I_NUMBER Message number

I_MSGV1 Message variable value 1













JavaScript Functions Use The following method enables you to manage JavaScript source code centrally. The source code is set at the start of the HTML page. You can use this function to construct your own JavaScript source code and, for example, call up manipulated cells from there.

Features Methods SET_JAVASCRIPT_FUNCTION


I_NAME Name of the section of source code

This name is unique. Any source code already stored that has the same name is overwritten. The name I_NAME is not the name of a JavaScript function (see I_CODING).

I_CODING JavaScript source code

The source code I_CODING is the inner part of the HTML tag script and can be the definition of JavaScript functions (with TfunctionT) and/or the definition of JavaScript variables (with TvarT).

The source code of one or more calls of the method is collected and automatically positioned at the beginning of the HTML page.


TGenerate a Navigation URL [Seite 308]T

TInformation on the Navigational State [Seite 309]T




TDetermining Specific Attributes for the Table-Interface [Seite 316]T



Determining Specific Attributes for the Table Interface Use You need this method if you have defined your own attributes for an object tag for the table interface. The basic table does not recognize these and are lost when you drilldown on a bookmark if you do not do anything with them.

To make the Web application suitable for bookmarks, you have to use the following method to make important attributes for your table interface known to the Web item.

We recommend that you call this method in the initialization (START method).

Features Method SET_TABLE_INTERFACE_ATTRIBUTE


I_ID Attribute name

I_VALUE Attribute value