SAP BusinessObjects Web Intelligence Users Guide
■ SAP BusinessObjects Business Intelligence Suite 4.0 Support Package 4

2012-06-11

Copyright

© 2012 SAP AG. All rights reserved.SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP
BusinessObjects Explorer, StreamWork, SAP HANA 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 other countries.Business Objects and the Business Objects logo, BusinessObjects,
Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Business Objects Software Ltd. Business Objects is an SAP company.Sybase and
Adaptive Server, iAnywhere, Sybase 365, SQL Anywhere, and other Sybase products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Sybase,
Inc. Sybase is an SAP company. Crossgate, m@gic EDDY, B2B 360°, B2B 360° Services are registered trademarks of Crossgate AG in Germany and other countries. Crossgate is an SAP company. 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.
2012-06-11

Contents

Chapter 1

1.1

Document History: Web Intelligence .....................................................................................17

Chapter 2

About Web Intelligence.........................................................................................................19

Chapter 3

Application structure.............................................................................................................21

Chapter 4

Using the BI launch pad........................................................................................................25

4.1
4.2
4.3
4.4
4.4.1
4.4.2
4.4.3

About the BI launch pad.........................................................................................................25

Chapter 5

Working with documents......................................................................................................35

5.1
5.2
5.2.1
5.2.2
5.2.3
5.2.4
5.3
5.4
5.5
5.6
5.6.1
5.6.2
5.6.3
5.7

3

About this users guide..........................................................................................................17

To start the Web Intelligence interface...................................................................................35

To log in to the BI launch pad.................................................................................................26
To log out of the BI launch pad...............................................................................................27
About setting Web Intelligence preferences...........................................................................27
Choosing the viewing and design interfaces...........................................................................27
Setting the interface and document locales............................................................................29
Setting application modes......................................................................................................31

Creating and editing documents.............................................................................................35
To create an empty document................................................................................................36
To create a new document based on a universe.....................................................................36
To create a new document based on a BEx query..................................................................37
To create a new document based on an Analysis View..........................................................37
To open a document from the repository................................................................................38
To open a document in Web Intelligence................................................................................38
To delete a document from the repository..............................................................................39
Sending documents...............................................................................................................39
To send a document by email.................................................................................................39
To send a document to another user......................................................................................39
To send a document by FTP...................................................................................................40
Managing reports in documents.............................................................................................40

2012-06-11

Contents

5.7.1
5.7.2
5.7.3
5.7.4
5.7.5
5.7.6
5.8
5.9
5.10
5.11
5.11.1
5.11.2
5.11.3
5.11.4
5.11.5
5.12
5.12.1
5.12.2
5.12.3
5.12.4
5.12.5
5.13
5.13.1
5.13.2
5.13.3
5.14
5.14.1
Chapter 6

Returning data using queries................................................................................................57

6.1
6.1.1
6.1.2
6.1.3
6.1.4
6.1.5
6.1.6
6.1.7
6.1.8
6.1.9
6.1.10
6.1.11

4

To rename a report.................................................................................................................40

Queries defined......................................................................................................................57

To duplicate a report..............................................................................................................41
To delete a report...................................................................................................................41
To change the order of reports...............................................................................................41
To add a report......................................................................................................................41
To save a report locally..........................................................................................................42
About saving documents, reports and data in Web Intelligence..............................................42
About saving documents to MS Excel....................................................................................42
To set preferences for saving documents as Excel.................................................................43
Saving documents using Rich Client or the Java interface......................................................43
To save a document in the corporate repository (with the Java interface or Rich Client)........43
To save a document as an Excel spreadsheet (with the Java interface or Rich Client ) ..........44
To save a document as PDF (with the Java interface or Rich Client) .....................................45
To save a document as Text (with the Java interface or Rich Client) .....................................45
To save document data as CSV (with the Java interface or Rich Client) ................................46
Saving documents using the HTML interface.........................................................................46
To save a document in the corporate repository (with the HTML interface) ...........................47
To save a document or report as an Excel spreadsheet (with the HTML interface) ................47
To save a document or report as PDF (with the HTML interface) ..........................................48
To save a document or report as Text (with the HTML interface) ..........................................48
To save document data as CSV (with the HTML interface) ...................................................49
Automatic saving and recovery...............................................................................................49
Saving documents automatically............................................................................................50
Recovering autosaved documents..........................................................................................50
Management of autosaved documents...................................................................................51
Setting document properties..................................................................................................51
To display and set document properties.................................................................................55

Queries defined......................................................................................................................57
About query and document user rights ..................................................................................58
Classes and subclasses.........................................................................................................58
Analysis dimension.................................................................................................................58
Dimension..............................................................................................................................58
Attribute.................................................................................................................................59
Hierarchy...............................................................................................................................59
Level object...........................................................................................................................59
Member.................................................................................................................................60
Named set.............................................................................................................................60
Calculated member................................................................................................................61

2012-06-11

Contents

6.1.12
6.2
6.2.1
6.2.2
6.2.3
6.2.4
6.2.5
6.2.6
6.2.7
6.2.8
6.2.9
6.2.10
6.2.11
6.2.12
6.2.13
Chapter 7

Refreshing Web Intelligence documents based on PDP / CDP data sources from the BI launch pad......................................................................................................................................107 7.1

Points to consider before refreshing a document from BI launch pad...................................109

Chapter 8

Filtering data using query filters..........................................................................................111

8.1
8.2
8.3
8.3.1
8.4
8.4.1
8.4.2
8.4.3
8.4.4
8.5
8.5.1
8.5.2

Query filters defined.............................................................................................................111

Chapter 9

Filtering data using prompts...............................................................................................131

9.1
9.1.1
9.1.2
9.1.3
9.2

5

Measure................................................................................................................................61

Prompts defined...................................................................................................................131

Building and working with queries...........................................................................................61
Hierarchical and non-hierarchical queries................................................................................62
Building queries on universes.................................................................................................64
Building queries based on BEx queries...................................................................................84
Building queries on Advanced Analysis views.........................................................................97
Working with multiple queries.................................................................................................98
Managing queries...................................................................................................................99
To sort query results............................................................................................................101
To preview query results......................................................................................................102
Displaying data from an added query....................................................................................102
To interrupt a query..............................................................................................................102
To remove a query...............................................................................................................103
To duplicate a query.............................................................................................................103
Changing the data source of a query....................................................................................104

Query filters and report filters compared..............................................................................112
Structure of query filters......................................................................................................112
Query filter and prompt operators........................................................................................114
Types of query filter.............................................................................................................118
Predefined query filters........................................................................................................118
Quick filters..........................................................................................................................119
Custom query filters.............................................................................................................120
Combining query filters........................................................................................................125
Filtering hierarchical queries.................................................................................................127
How levels filter hierarchical queries.....................................................................................128
How measures filter hierarchical queries..............................................................................129

Merged prompts..................................................................................................................132
Merging and unmerging prompts coming from BEx variables................................................132
Hierarchical prompts............................................................................................................132
Query filter and prompt operators........................................................................................133

2012-06-11

Contents

9.2.1
9.2.2
9.3
9.4
9.5
9.6
9.7
9.7.1
9.8
Chapter 10

Using combined queries.....................................................................................................143

10.1
10.2
10.3
10.4
10.5
10.5.1
10.6
10.6.1
10.6.2

Combined queries defined....................................................................................................143

Chapter 11

Filtering data using subqueries...........................................................................................149

11.1
11.2
11.3

Subqueries defined..............................................................................................................149

11.4

Subquery parameters...........................................................................................................151

Chapter 12

Ranking data using database ranking.................................................................................153

12.1
12.2
12.3
12.4

Database ranking defined.....................................................................................................153

Chapter 13

Working with reports...........................................................................................................157

13.1
13.1.1
13.1.2
13.2
13.2.1

6

List of operators...................................................................................................................133

Hierarchical and non-hierarchical data...................................................................................157

Restrictions on filter operators.............................................................................................137
To build a new prompt..........................................................................................................138
To select an existing prompt................................................................................................139
To remove a prompt.............................................................................................................140
Defining how prompts display..............................................................................................140
Combining prompts..............................................................................................................141
Combining prompts with query filters...................................................................................141
To change the order of prompts...........................................................................................141

Uses of combined queries....................................................................................................144
How combined queries are generated..................................................................................144
To build a combined query....................................................................................................145
Combined query structure....................................................................................................145
To return a list of years and reservation years based on the number of guests.....................145
Combined query precedence...............................................................................................146
Nesting combined queries....................................................................................................147
To set the order of precedence of combined queries...........................................................148

To build a subquery..............................................................................................................149
To find out which customers bought a service that had previously been reserved in Q1 of 2003, and how much revenue have they generated........................................................................150

Database ranking parameters...............................................................................................153
To create a database ranking...............................................................................................154
To rank the top 10 employees by salary in each department................................................155

Working with non-hierarchical data.......................................................................................157
Working with hierarchical data..............................................................................................157
Finding text..........................................................................................................................170
To find text in a report..........................................................................................................170

2012-06-11

Contents

13.3
13.3.1
13.3.2
13.4
13.4.1
13.5
13.6
13.6.1
Chapter 14

Displaying data in tables.....................................................................................................177

14.1
14.2
14.2.1
14.2.2
14.2.3
14.2.4
14.3
14.3.1
14.3.2
14.3.3
14.3.4
14.3.5
14.3.6
14.3.7
14.3.8
14.3.9
14.3.10
14.4
14.4.1
14.4.2
14.4.3
14.4.4
14.4.5
14.4.6
14.4.7
14.4.8
14.4.9
14.4.10
14.5
14.5.1
14.5.2

7

Viewing modes....................................................................................................................170

Overview of tables...............................................................................................................177

Viewing modes defined........................................................................................................171
To switch between viewing modes.......................................................................................173
Folding and unfolding report data.........................................................................................173
To fold and unfold report data..............................................................................................173
To redisplay all hidden content in a report............................................................................174
Printing reports....................................................................................................................174
To print reports....................................................................................................................174

Table types..........................................................................................................................177
Vertical table........................................................................................................................177
Horizontal table....................................................................................................................178
Cross tables........................................................................................................................178
Forms..................................................................................................................................179
Creating and editing tables...................................................................................................179
To create a table by dragging objects onto a report..............................................................180
To create a table by selecting a template.............................................................................180
To apply a different template to a table with Turn Into...........................................................181
To add table rows or columns..............................................................................................181
To remove table rows or columns........................................................................................181
To move a row or column.....................................................................................................181
To swap a row or column.....................................................................................................182
To clear cell contents from a table........................................................................................182
To remove a table................................................................................................................182
To copy a table....................................................................................................................182
Formatting tables and table cells..........................................................................................183
To select a background color for the table or cells...............................................................183
To define alternate row and column colors for a table...........................................................183
To insert an image or skin in a table.....................................................................................184
To format table or cell borders.............................................................................................184
To format text in table cells..................................................................................................184
To set cell height and width..................................................................................................185
To copy formatting using the Format Painter........................................................................186
To set the position of a table or chart on the report page.....................................................187
To layer tables and cells.......................................................................................................187
To merge table cells.............................................................................................................187
Controlling the display of tables...........................................................................................188
To show or hide tables, rows or columns.............................................................................188
To redisplay hidden tables, cells or sections.........................................................................188

2012-06-11

Contents

14.5.3
14.5.4
14.5.5
14.5.6
14.5.7
14.5.8
14.5.9
14.5.10
Chapter 15

Displaying data in free-standing cells.................................................................................191

15.1
15.2
15.3
15.4
15.5

Free-standing cells defined...................................................................................................191

Chapter 16

Organizing data with sections, breaks and sorts................................................................195

16.1
16.1.1
16.1.2
16.1.3
16.1.4
16.1.5
16.1.6
16.1.7
16.1.8
16.1.9
16.1.10
16.1.11
16.2
16.2.1
16.2.2
16.2.3
16.2.4
16.2.5
16.2.6
16.2.7
16.2.8
16.3
16.3.1

8

To hide dimensions in tables................................................................................................189

Using sections to group data................................................................................................195

To redisplay hidden dimensions............................................................................................189
To avoid duplicate row aggregation......................................................................................189
To show or hide table headers and footers...........................................................................189
To start tables on a new report page....................................................................................190
To display object names in headers on cross tables.............................................................190
To avoid page breaks in tables.............................................................................................190
To repeat table headers or footers on report pages.............................................................190

To insert a free-standing cell in a report................................................................................191
To hide free-standing cells....................................................................................................192
To redisplay hidden tables, cells or sections.........................................................................192
To copy a free-standing cell..................................................................................................192

Grouping information with sections......................................................................................195
Applying filters to sections...................................................................................................197
To create a section from a column.......................................................................................197
To create a section from a dimension...................................................................................197
Creating sections from a hierarchy.......................................................................................198
Creating subsections...........................................................................................................199
To remove a section cell or section......................................................................................200
To set the page layout of a section.......................................................................................200
To hide sections...................................................................................................................200
To redisplay hidden tables, cells or sections.........................................................................200
To define colors and images in a section..............................................................................201
Using breaks........................................................................................................................201
Breaks defined.....................................................................................................................201
Breaks compared to sections...............................................................................................201
Applying breaks to hierarchies..............................................................................................202
Default sort order in breaks..................................................................................................203
To insert a break..................................................................................................................203
To remove a break...............................................................................................................204
To manage breaks................................................................................................................204
Break properties..................................................................................................................204
Using sorts to organize data.................................................................................................205
Sorting the results displayed on reports...............................................................................206

2012-06-11

Contents

16.3.2
16.3.3
16.3.4
16.3.5
Chapter 17

Displaying data in charts....................................................................................................211

17.1
17.1.1
17.2
17.2.1
17.2.2
17.2.3
17.2.4
17.2.5
17.2.6
17.2.7
17.2.8
17.2.9
17.2.10
17.3
17.3.1
17.3.2
17.3.3
17.3.4
17.3.5
17.4
17.4.1
17.4.2
17.4.3
17.5
17.5.1
17.5.2
17.5.3
17.6
17.6.1
17.6.2
17.6.3
17.6.4
17.6.5
17.6.6
17.6.7

9

Sorting hierarchical data.......................................................................................................207

Creating charts....................................................................................................................211

To insert a sort.....................................................................................................................208
To remove a sort..................................................................................................................209
To manage sorts..................................................................................................................209

Opening charts created with Web Intelligence 3.x ...............................................................211
Chart types..........................................................................................................................211
Bar charts............................................................................................................................212
Box plot charts.....................................................................................................................212
Column charts......................................................................................................................212
Line charts...........................................................................................................................213
Map charts...........................................................................................................................213
Pie charts.............................................................................................................................214
Point charts..........................................................................................................................214
Radar charts........................................................................................................................215
Tag cloud charts...................................................................................................................215
Waterfall charts....................................................................................................................215
Adding, copying and removing charts...................................................................................216
To add a chart to a report.....................................................................................................216
Chart feeding: Binding objects to a chart..............................................................................216
To apply a chart style...........................................................................................................218
To copy a chart....................................................................................................................218
To remove a chart................................................................................................................219
Changing the chart type.......................................................................................................219
To change the chart type by using Turn Into.........................................................................219
Turning Hierarchical queries into charts................................................................................220
To switch between bars, lines and surfaces.........................................................................220
Positioning and sizing charts................................................................................................221
To set the position of a table or chart on the report page.....................................................221
To position a chart in relation to another chart or table.........................................................221
To resize a chart...................................................................................................................222
Formatting charts.................................................................................................................222
Formatting chart areas.........................................................................................................222
To format a chart..................................................................................................................222
Formulas in chart elements..................................................................................................223
Warning icons in charts........................................................................................................223
To insert and format a chart title...........................................................................................224
To display a chart with a 3D look..........................................................................................225
Assigning colors to charts....................................................................................................225

2012-06-11

Contents

17.6.8
17.6.9
17.6.10
17.6.11
17.6.12
17.6.13
17.6.14
17.6.15
17.6.16
17.6.17
17.6.18
17.6.19
17.6.20
Chapter 18

Formatting numbers and dates...........................................................................................235

18.1
18.1.1
18.1.2
18.2

Predefined and custom formats............................................................................................235

Chapter 19

Highlighting data using conditional formatting...................................................................241

19.1
19.2
19.3
19.4
19.5
19.6

Conditions in conditional formatting......................................................................................241

Chapter 20

Filtering report data.............................................................................................................247

20.1
20.2
20.3
20.3.1
20.3.2
20.3.3
20.3.4
20.3.5
20.3.6
20.3.7
20.3.8

10

To add background colors to a chart....................................................................................225

Report filters defined............................................................................................................247

To modify chart borders.......................................................................................................226
To format the Plot Area background.....................................................................................226
To show and format chart legend.........................................................................................227
To avoid page breaks in charts.............................................................................................227
To manage stacking options.................................................................................................227
To assign axis labels in data values......................................................................................228
To format axis label text, borders, and background...............................................................228
To format the axis grid..........................................................................................................228
To format axis values, numbers and text..............................................................................229
To show a specific range of axis values................................................................................229
Linear and logarithmic axis scales.........................................................................................230
Displaying and formatting chart data.....................................................................................231

Predefined formats...............................................................................................................235
Custom formats...................................................................................................................236
To format a number as a currency........................................................................................239

To build a conditional formatting rule....................................................................................242
To set the format displayed by a conditional formatting rule.................................................243
To apply conditional formatting.............................................................................................243
To manage conditional formats.............................................................................................244
Using formulas to create advanced conditional formatting rules...........................................244

Query filters and report filters compared..............................................................................247
Report filter operators..........................................................................................................248
Equal To operator.................................................................................................................248
Not Equal To operator..........................................................................................................248
Different From operator.......................................................................................................248
Greater Than operator..........................................................................................................248
Greater Than Or Equal To operator......................................................................................249
Less Than operator..............................................................................................................249
Less Than Or Equal To operator...........................................................................................249
Between operator................................................................................................................250

2012-06-11

Contents

20.3.9
20.3.10
20.3.11
20.3.12
20.3.13
20.4
20.5
20.5.1
20.6
20.7
Chapter 21

Filtering data with prompts.................................................................................................257

21.1

To supply values for prompts...............................................................................................257

Chapter 22

Filtering data using input controls.......................................................................................259

22.1
22.2
22.3
22.4
22.5
22.6
22.7
22.8
22.8.1
22.9

Input controls defined...........................................................................................................259

Chapter 23

Enhancing reports with calculations, formulas and variables.............................................265

23.1
23.2
23.2.1
23.2.2
23.3
23.3.1
23.3.2
23.4
23.4.1
23.4.2
23.4.3
23.4.4

11

Not Between operator.........................................................................................................250

Calculations, formulas and variables.....................................................................................265

In List operator.....................................................................................................................250
Not In List operator..............................................................................................................251
Is Null operator....................................................................................................................251
Is Not Null operator..............................................................................................................251
Types of report filter.............................................................................................................251
To create, edit, and delete standard report filters.................................................................252
To select values from a list...................................................................................................253
To create simple report filters...............................................................................................254
To create nested filters........................................................................................................256

Using input controls with hierarchical data............................................................................259
To add an input control.........................................................................................................259
To edit an input control.........................................................................................................261
To highlight input control dependencies................................................................................261
To organize input controls....................................................................................................262
To view the input controls map.............................................................................................262
Using tables and charts as input controls.............................................................................262
To define a table or chart as an input control........................................................................262
To filter data using input controls..........................................................................................263

Working with standard calculations......................................................................................265
To insert a standard calculation in a table or cross table.......................................................265
To remove a standard calculation.........................................................................................266
Working with formulas..........................................................................................................266
To enter a formula by typing.................................................................................................266
To build a formula using the Formula Editor..........................................................................266
Working with variables.........................................................................................................266
To create a variable..............................................................................................................267
To edit a variable..................................................................................................................267
To delete a variable..............................................................................................................267
To rename a variable............................................................................................................268

2012-06-11

Contents

Chapter 24

24.1
24.1.1
24.1.2
24.1.3
24.2
24.2.1
24.2.2
24.3
24.3.1
24.3.2
24.3.3
24.3.4
24.3.5
24.4
24.5
24.5.1
24.6
24.7
24.8
24.8.1
24.8.2
24.8.3
24.9
24.9.1
24.9.2
24.10
24.11
24.11.1
24.11.2
24.11.3
24.12
24.12.1
24.12.2
24.13
24.14
24.15
24.15.1

12

Drilling on report data.........................................................................................................269
Drill defined..........................................................................................................................269
Scope of analysis.................................................................................................................269
To set the scope of analysis.................................................................................................270
Drill paths and hierarchies....................................................................................................271
Setting drill options..............................................................................................................272
To set drill options in the BI launch pad................................................................................272
To set drill options in Web Intelligence Rich Client...............................................................272
Drill options explained..........................................................................................................272
Prompt when drill requires additional data option..................................................................272
Synchronize drill on report blocks option..............................................................................273
Hide drill toolbar option........................................................................................................273
Start drill session on existing report option...........................................................................273
Start drill session on a duplicate report option......................................................................274
To switch to drill mode.........................................................................................................274
Retrieving more levels of data to the report..........................................................................274
To drill out of the scope of analysis......................................................................................275
To choose a drill path when more than one is available.........................................................275
To take a drill snapshot........................................................................................................276
Drilling on dimensions in tables and sections........................................................................276
Drilling down........................................................................................................................276
Drilling up.............................................................................................................................278
Drilling by.............................................................................................................................278
Drilling on measures in tables and sections..........................................................................280
To drill down on a measure value.........................................................................................281
To drill up on a measure value..............................................................................................281
Synchronizing drill across multiple tables and charts............................................................281
Drilling on charts..................................................................................................................282
Drilling on dimensions via chart axes....................................................................................282
Drilling on measures in charts..............................................................................................283
Drilling on axis legends.........................................................................................................284
Using filters when you drill....................................................................................................285
To change a filter value on the Drill toolbar...........................................................................286
To add or remove a drill filter ...............................................................................................286
Saving reports with drill filters..............................................................................................286
Refreshing data in a drilled report with prompts....................................................................287
Drilling with query drill..........................................................................................................287
Query drill defined................................................................................................................287

2012-06-11

Contents

Chapter 25

25.1
25.1.1
25.2
25.3
25.4
25.5
25.6
25.7
25.7.1
25.7.2
25.7.3
25.7.4
25.8
25.8.1
25.8.2
25.8.3
25.8.4
25.8.5
25.8.6

Merging defined...................................................................................................................291

Chapter 26

Ranking report data.............................................................................................................307

26.1
26.2
26.3
26.4
26.4.1
26.5
26.6
26.6.1
26.7

Ranking data........................................................................................................................307

Chapter 27

Tracking changes in data....................................................................................................317

27.1
27.2
27.3
27.3.1
27.3.2
27.4

13

Merging data from dimensions and hierarchies..................................................................291

Tracking changes in your data..............................................................................................317

Merging data providers based on keys.................................................................................291
Choosing which data to merge.............................................................................................292
Merged dimension example..................................................................................................292
Merging hierarchies..............................................................................................................293
Merging different types of object.........................................................................................296
Forcing merged calculations with the ForceMerge function..................................................297
Creating, editing and deleting merged objects......................................................................298
To merge details, dimensions, or hierarchies........................................................................299
To merge dimensions automatically......................................................................................299
To edit merged objects........................................................................................................299
To delete merged objects.....................................................................................................300
Understanding the effects of merged data...........................................................................300
Synchronizing data providers with different aggregation levels.............................................300
Attributes and merged dimensions.......................................................................................301
Incompatible objects and merged dimensions......................................................................302
Filtering merged dimensions.................................................................................................303
Drilling on merged dimensions.............................................................................................304
Extending the values returned by merged dimensions..........................................................305

Rankings and sorts..............................................................................................................307
Tied rankings........................................................................................................................308
Ranking parameters.............................................................................................................309
Example of a ranking............................................................................................................310
Ranking and data order........................................................................................................311
Ranking workflows...............................................................................................................311
To create a ranking...............................................................................................................312
Ranking examples................................................................................................................312

Types of data change...........................................................................................................317
Data tracking modes............................................................................................................318
Automatic data tracking mode..............................................................................................318
Manual data tracking mode..................................................................................................318
To activate data tracking......................................................................................................318

2012-06-11

Contents

27.5
27.5.1
27.5.2
27.5.3
27.5.4
27.5.5
27.5.6
27.5.7
27.6
27.6.1
27.6.2
27.7
27.7.1
27.7.2
27.7.3
27.7.4
27.8
Chapter 28

Sharing content with other applications.............................................................................331

28.1
28.1.1
28.1.2
28.1.3
28.1.4
28.1.5
28.2
28.2.1
28.2.2
28.3
28.3.1
28.4
28.4.1
28.4.2
28.4.3
28.4.4
28.4.5

Publishing content as web services......................................................................................331

Chapter 29

Linking to other documents................................................................................................355

29.1
29.1.1

14

Displaying changed data.......................................................................................................319

Linking to other documents..................................................................................................355

To display changed data.......................................................................................................319
Configuring the appearance of changed data........................................................................319
How changed data is displayed in blocks..............................................................................320
How changed data is displayed in reports with merged dimensions......................................321
How changed data is displayed in sections...........................................................................323
How changed data is displayed in blocks with breaks...........................................................324
How changed data is displayed in charts..............................................................................325
Data tracking restrictions.....................................................................................................325
Data tracking and drill...........................................................................................................325
Data tracking and Refresh on Open.....................................................................................326
Using the formula language to track changed data...............................................................326
The RefValue function..........................................................................................................326
The RefValueDate function..................................................................................................327
The RefValueUserResponse function...................................................................................327
Building formulas using the RefValue function......................................................................327
Changed data and the calculation context............................................................................328

To publish a report block as a web service...........................................................................331
To identify duplicate content.................................................................................................332
To publish prompts...............................................................................................................332
To define the web service....................................................................................................333
To save and publish a web service.......................................................................................334
Viewing and managing published content.............................................................................335
To view and manage published content................................................................................335
To test published content.....................................................................................................336
Importing and converting QaaWS (Query as a Web Service) queries...................................337
To publish a QaaWS query...................................................................................................337
BI service structure..............................................................................................................338
GetReportBlock_blockname.................................................................................................338
Drill_blockname....................................................................................................................341
BI Services output parameters.............................................................................................342
Sample BI service return data..............................................................................................344
BI service WSDL definition..................................................................................................347

Cell text defined as a hyperlink.............................................................................................355

2012-06-11

Contents

29.1.2
29.1.3
29.2
29.2.1
29.2.2
29.2.3
29.2.4
29.3
Chapter 30

Formatting your reports using Cascading Style Sheets......................................................365

30.1
30.2
30.3
30.4
30.5
30.5.1
30.5.2
30.5.3
30.6
30.7

Style sheets explained ........................................................................................................365

Chapter 31

Creating a corporate palette for charts...............................................................................379

31.1
31.2
31.3

About corporate palettes......................................................................................................379

Chapter 32

Error Messages...................................................................................................................381

32.1
32.1.1
32.1.2
32.1.3
32.1.4
32.1.5
32.1.6
32.2
32.2.1

15

A hyperlink associated with a cell.........................................................................................356

Web Intelligence Error Messages.........................................................................................381

A link to another document in the CMS................................................................................358
Working with hyperlinks.......................................................................................................362
To link to another document from a hyperlink.......................................................................362
To edit a hyperlink................................................................................................................363
To delete a hyperlink............................................................................................................363
Formatting hyperlink colors..................................................................................................363
Linking report elements in a document.................................................................................364

Using the style in documents...............................................................................................365
Modifying the document default style...................................................................................366
Modifying and using the standard default style.....................................................................366
Web Intelligence CSS syntax ..............................................................................................367
Elements..............................................................................................................................367
Properties............................................................................................................................368
Units....................................................................................................................................375
Style and 3.x documents......................................................................................................376
Web Intelligence CSS restrictions .......................................................................................376

Corporate palette configuration file syntax...........................................................................379
To define a corporate palette for charts................................................................................380

Web Intelligence (WIJ) Error Messages...............................................................................381
Web Intelligence Desktop (WIO) Error Messages................................................................389
Web Intelligence Server (WIS) Error Messages...................................................................390
Web Intelligence Desktop HTML Interface (WIH) Error Messages.......................................400
ReportEngine Web Intelligence (RWI) Error Messages ........................................................402
Custom Data Source (CDS) Framework Error Messages....................................................417
Information Engine Services (IES) Error Messages...............................................................428
Information Engine Services (IES) Error Messages...............................................................429

2012-06-11

Contents

Appendix A
Index

16

More Information.................................................................................................................455
459

2012-06-11

About this users guide

About this users guide

This user guide describes the Web Intelligence Java and HTML applications.
The Web Intelligence Rich Client application is described in the SAP BusinessObjects Web Intelligence
Rich Client Users Guide.

1.1 Document History: Web Intelligence
The following table provides an overview of the most important document changes.

17

2012-06-11

About this users guide

Version

Date

SAP BusinessObjects Interactive
Analysis Desktop 4.0

30, Novem- Initially rebranded Interactive Analysis. First release ber 2010 of this document.

SAP BusinessObjects Interactive
Analysis Desktop 4.0 SP01

25, February 2011

BusinessObjects Web Intelligence 15, June
Rich Client 4.0 SP02
2011

Description

Support Package 1
Support Package 2. Rebranded back to Web Intelligence
Additional administrator-defined security right called
“Download connection locally” for connection objects
Query Panel enhancements:
• BEx Query Scaling factor information is displayed.
• The Query Panel indicates which hierarchy is activated in a BEx Query.
• Techname is displayed in reports.
• Default hierarchies managed.
• Prompt on member selection.
• Can select all hierarchy members to a specified depth. • Member selection based on level.
Charts:
• Waterfall charts can be used to display vertical bars. • Hierarchical navigation is available

BusinessObjects Web Intelligence 20, FebruRich Client 4.0 FP03 ary 2012

Feature Pack 3 zero line feature
Custom sort feature
Query Panel functionality

BusinessObjects Web Intelligence July 2012
Rich Client 4.0 SP04

Support Package 4
Purge last selected prompt values. (When editing queries in the Data Manager)
Merge/Unmerge prompts (BEx variables) (Set in the document properties pane)

18

2012-06-11

About Web Intelligence

About Web Intelligence

You perform data analysis with SAP BusinessObjects Web Intelligence by creating reports based on data you want to analyze, or by opening pre-existing documents. Depending on your license and security rights, you can then analyze the data in your reports by, for example, filtering, drilling down to reveal more details, merging data from different data sources, displaying data in charts, or adding formulas.
Data comes from universes, which organize data from relational or OLAP databases into objects or hierarchies, from personal data providers such as Microsoft Excel or CSV files, from BEx queries based on SAP Info Cubes, from web services, or from Advanced Analysis workspaces. You build data providers to retrieve data from these data sources and you create reports from the data in data providers. Web
Intelligence also supports Hadoop data sources, but Custom SQL is not supported.
You can also connect to the HANA (SAP High-Performance Analytical Appliance) data source to take advantage of the benefits of in-memory computing.
You can use the Java or HTML interface of SAP BusinessObjects Web Intelligence to perform data analysis from the BI launch pad. Which interface is launched depends on your Preferences settings in the BI launch pad.
You can also use Web Intelligence Rich Client to perform data analysis. Web Intelligence Rich Client allows you to work locally without a connection to a repository. Additional information is available in the
SAP BusinessObjects Web Intelligence Rich Client User's Guide.
Note:
When you have launched the desktop tool once and closed it, the quick start icon is available in the toolbar. This quick start icon allows you to launch the desktop tool rapidly.
About the three Web Intelligence interfaces
There are three different interfaces available via the BI launch pad for creating and editing queries, and creating and editing documents, and creating, editing, and refreshing reports:

19

2012-06-11

About Web Intelligence

Table 2-1: The three Web Intelligence interfaces
Interface

Web

Description

Also referred to as the DHTML interface. You launch this via the BI launch pad. Depending in your rights, you can do the following:
• Create and edit queries based on 'no data source', .unx, and .unv universes (but not on
BEx queries).
• Create, edit and refresh all types of reports.
Note:
In 4.0 SP02, it was not possible to create queries.
It was only possible to work with documents and reports. Rich Internet Application

Also referred to as the Java applet. You launch this via the BI launch pad. Depending on your permissions, you can do the following:
• Create and edit queries based on 'no data source', .unx and .unv universes, BEx queries,
Analysis views (Advanced Analysis workspaces), and Text sources.
• Create, edit and refresh all types of reports.
You download and install this version of the Web
Intelligence Rich Client via the BI launch pad. This is known as the 'zero administration Business
Objects' version of the Web Intelligence Rich
Client. Depending on your permissions, you can do the following:
• Create queries based on 'no data source', .unx and .unv universes, and Text sources.
• Create, edit and refresh all types of reports.

Web Intelligence Rich Client

20

Note:
The connection mode used by this version of the Web Intelligence Rich Client does not support BEx queries or Analysis Views. You must use either the Rich Internet Application described above, or perform a full installation of Web Intelligence Rich Client, but do not use
'zero administration Business Objects' mode
(also referred to as HTTP mode), since that mode uses the same connector that does not support use of BEx queries or Analysis Views.

2012-06-11

Application structure

Application structure

The application has the following components:
Component

Description

You use the main toolbar to open, save and print documents, track data changes and display the report outline.
The main toolbar
The main toolbar appears in the File tab when the application is in Design mode.
You work with data providers and perform report design and analysis tasks using the toolboxes.
Toolboxes

21

Toolboxes appear at the top of the application in Data and
Design mode only. In Data mode, only those toolboxes related to working with data providers are active.

2012-06-11

Application structure

Component

Description

The Left Panel groups several panes that provide different views of the current document. Refer to the table below to see which panes are available in the different modes.
• The Document Summary provides an overview of the document properties.
• The Available Objects pane lists the data providers and objects available for inclusion in reports.
Note:
The Web interface (DHTML mode) does not display formulas in this panel.
•
•
•
Left Panel

The Input Controls pane allows you to add and edit input controls applied to the document.
User Prompt Input
The Document Structure and Filters pane displays the structure of the document in a tree view, and displays filters applied to different report elements.
Note:
The Web interface (DHTML mode) does not display filters in this pane. If you want to use filters, use the Rich Internet
Application (Java applet).

•

•

•
•

(Rich Internet Application mode only) The Navigation Map pane lists all the reports in a document. This pane is the same as the Report Map in HTML mode.
(Web mode only) The Report Map pane lists all the reports in a document. This pane is the same as the Navigation
Map in Rich Internet Application mode.
The Web Services Publisher pane lists the BI Services published from the document.
The Data pane appears in Data mode only and allows you to navigate the data providers in a document.

File and Properties tabs

Report Panel

The "Report Panel" displays the report.

Status Bar

22

The FIle and Properties tabs are available in Design and
Data mode only. The File tab contains the main file menu tools . The Properties tab allows you to set View, Document, and Application properties.

The "Status Bar" appears beneath the repory and allows you to perform actions such as activating data tracking or changing the display mode. It can be activated and deactivated in the
View menu of the Properties tab.

2012-06-11

Application structure

The tabs available in the left panel depend on your choice of interface: Rich Internet Application (the
Java applet mode), Web (HTML mode), or Desktop (Web Intelligence Rich Client):
Rich
Client

Client

Client

Data

Design

Reading

RIA

RIA

Pane

Data

Design

Reading Design

Reading

Document
Summary

No

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes
Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Report Map
Input Controls

Yes

User Prompt
Input

Yes

Web

Rich

RIA

Navigation
Map

Web

Rich

Available
Objects

Yes

Yes

Yes

Document
Structure
and Filters

Yes

Yes

Yes

Web Service
Publisher

Yes

Data pane

23

Yes

Yes
Yes

2012-06-11

Application structure

24

2012-06-11

Using the BI launch pad

Using the BI launch pad

4.1 About the BI launch pad
The BI launch pad has the following main tabs: Home, Documents, and any open document.

Table 4-1: BI launch pad panes
Tab pane

Description

Home

Shows recent documents, messages, alerts, and applications that you can run.

Documents

Allows you to navigate through the available folders and documents. You can view, organize, and manage documents in this pane.

Web Intelligence Documents

One tab for each open document.

Use the Applications tab of the BI launch pad to start an application including Web Intelligence.
Use the Preferences menu to set the preferences shown in the table below.

Table 4-2: Preferences menu items
Option

General

Set the user default settings. (These are Administrator defined.)

Change Password

Change your password. Enter your old password, then enter the new password twice.

Locales and Time Zone

Set the Product Locale, Preferred Viewing Locale, and Current Time Zone.

Analysis edition for OLAP

25

Description

Set the Accessibility mode. (Not described here).

2012-06-11

Using the BI launch pad

Option

Description

Choose the interfaces you want to use for View and Modify modes.
Web Intelligence

Select a default universe.
Set the drill options.
Set the saving priorities when saving as Excel.

BI workspaces

Set a default style. (Not described here) .

Crystal Reports

Set Crystal Reports options. (Not described here).

4.2 To log in to the BI launch pad
Before you can perform interactive analysis from the BI launch pad, you need the following information:
•
•
•

a URL to the BI launch pad (for example http://arcachon:8080/BOE/BI). your login and password your authentication, which controls the resources available to you

Contact your adminstrator for these details if you do not already know them.
Note:
By default the server name and authentification method are not displayed on the BI launch pad logon page. You need to supply this information only if your administrator has made these options visible.
You launch SAP BusinessObjects Web Intelligence by using your web browser to log into the BI launch pad. 1. Launch your web browser.
2. Point your browser to the BI launch pad bookmark or URL.
The login page appears.
3. If the System box is blank, type the name of the server followed by a colon (:), and then type the port number.
4. In the Username box, type your user name.
5. In the Password box, type your password.
6. In the Authentication box, select the authentication provided to you by your administrator.
7. Click Log On.
The BI launch pad home page appears.

26

2012-06-11

Using the BI launch pad

4.3 To log out of the BI launch pad
You need to log out when you have finished working in the BI launch pad instead of simply closing your web browser.
Logging out ensures that any preferences you modified during your session are saved. It also lets your administrator track how many users are logged into the system at any given time. Your administrator can use this information to optimize system performance.
•

Click Log Off.

4.4 About setting Web Intelligence preferences
Use the Preferences tab of the BI launchpad to do the following:
•
•
•
•

View the General preferences (These are usually administrator defined).
Change your password.
Set the Locales and Time Zone preferences.
Set the Web Intelligence preferences, select an interface for the read mode and modify mode.

4.4.1 Choosing the viewing and design interfaces
You can set options to determine how you view and explore existing documents (using the Read interface) and how you create new documents or edit and analyze existing documents (using the Modify interface). You set these options in the Preferences panel in the BI launch pad.
Depending on your permissions, you have a choice of Reading mode, Design mode, and Data mode.
Note:
Your choice of interface can be further restricted by your security profile.
The Reading interface is launched when you select an existing document from the list of corporate documents, right-click and select View from the menu. The Design interface is launched when you create a new document, or select an existing document, and select Design from the interface.
In the BI launch pad, you have the following choice of Read interfaces:

27

2012-06-11

Using the BI launch pad

Interface

Description

Web

You view documents using the Web interface within the BI launch pad.

Rich Internet Applica- You view documents using the Rich Internet Application interface within the BI tion launch pad.
Note:
This interface requires the download of a Java applet.
Desktop

You view documents using Web Intelligence Rich Client, a standalone interface that works outside the BI launch pad and allows you to work with documents without being connected to a corporate repository.
Note:
Web Intelligence Rich Client requires an install on your local machine.

PDF

You view documents statically in PDF format.

In the BI launch pad, you have the following choice of Modify interfaces:
Interface

Description

Web

You create, edit and analyze documents using the Web interface within the
BI launch pad.

Rich Internet Application

You create, edit and analyze documents using the Rich Internet Application interface within the BI launch pad. You can select Design or Data mode.
Note:
This interface requires the download of a Java applet.

Desktop

You create and edit documents using Web Intelligence Desktop, a standalone interface that works outside the BI launch pad and allows you to work with documents without being connected to a corporate repository. You can select
Design or Data mode.
Note:
Web Intelligence Rich Client requires an install on your local machine.

Once you begin working in a specific interface, you remain in that interface for the rest of your session.
For example, if you select Web as your Read interface and Rich Internet Application as your Modify interface, you remain in the Web interface even if you switch to Design mode (which uses the Modify interface) within the application.

4.4.1.1 To select the document viewing and design interfaces

28

2012-06-11

Using the BI launch pad

1. Click Preferences in the BI launch pad to open the "Preferences" dialog box.
2. Click Preferences in the left pane of the "Preferences" dialog box to display the list of preferences, then select Web Intelligence from the list.
3. Select the viewing interface from the Read options.
4. Select the design interface from the Modify options.
This allows you to access the Data and Design editing modes with your chosen interface. The Data editing mode is not available in Web interface)
5. Click Save and Close.
6. To make the changes permanent, log out of the BI launch pad and Log on again.

4.4.2 Setting the interface and document locales
Locales determine the appearance of the application interface (for example, menu items and button text) and data (for example, date and number formatting).
There are three locales:
Locale

Description

Product Locale

The locale of the Web Intelligence interface

Document Locale

The locale of the data currently contained in the document Preferred Viewing Locale

The preferred locale for displaying document data

The locale settings determine how the locales interact to display document data.

4.4.2.1 The Product locale
The product locale is used to display the user interface (for example, menu items and button text).
Note:
The GetLocale function returns the Product Locale.

4.4.2.1.1 To set the Product locale in the BI launch pad
1. Click Preferences on the BI launch pad toolbar.
2. Click Locales and Time Zone to display the available options.

29

2012-06-11

Using the BI launch pad

3. Select the product locale from the Product Locale list.
4. Click Save and Close.

4.4.2.2 The Document locale
The Document locale formats the data in documents. For example, the Document locale determines the display of dates and numbers.
By default, the browser locale is used. A user can permanently associate the current Document locale with a document by saving the document with the Permanent Regional Formatting option selected.
Once a document has been saved with the option selected, the settings are ignored and the document data is always formatted using the saved Document Locale. This applies to all users, not just the user who selected the Permanent Regional Formatting option.
Note:
The GetContentLocale function returns the Document locale.
Related Topics
• To associate a locale with a document permanently

4.4.2.2.1 To set the Document locale in the BI launch pad
1. Click Preferences on the BI launch pad toolbar to display the Preferences panel.
2. Click Web Intelligence.
3. In the section "When viewing a document", select Use the document locale to format the data or select Use my preferred viewing locale to format the data.
4. Click Save and close.
Related Topics
• The Preferred Viewing locale
• To set the Preferred Viewing locale in the BI launch pad

4.4.2.3 The Preferred Viewing locale
The Preferred Viewing locale is a user's preferred locale for displaying document data. The Document locale becomes the user's Preferred Viewing locale when the BI launch pad settings give the Preferred
Viewing locale priority.

30

2012-06-11

Using the BI launch pad

If the locale settings give the user's Preferred Viewing locale priority through the Use the Preferred
Viewing Locale to format the data setting, the Document locale is set to the Preferred Viewing locale when the user opens a document. When the user saves the document, this Document locale is saved with the document.
If the settings do not give the user's Preferred Viewing locale priority, the data is formatted according to the Document locale saved with the document.
When a user creates a document, the user's Preferred Viewing locale is always assigned as the initial
Document locale, whether or not the locale settings give the Preferred Viewing locale priority.
Note:
The GetPreferredViewingLocale function returns the Preferred Viewing locale. The GetLocalized function also uses the Preferred Viewing locale to display translated strings.

4.4.2.3.1 To set the Preferred Viewing locale in the BI launch pad
1. Click Preferences on the BI launch pad toolbar to display the "Preferences" dialog box.
2. Click General to display the general options.
3. Select the preferred viewing locale from the Preferred Viewing Locale list.
4. Click Web Intelligence to display the Web Intelligence options.
5. If you want data to be formatted using the preferred viewing locale, click Use my Preferred Viewing
Locale to format the data beneath When viewing a document.
6. Click Save and Close.

4.4.2.4 To associate a locale with a document permanently
1. In Design mode, click Document on the Properties tab in the left panel to display the "Document
Summary" dialog box.
2. Select Permanent regional formatting.
3. Click OK.
4. Save the document.

4.4.3 Setting application modes
You build queries, documents and reports and analyze the data in reports using three application modes:
Data, Reading and Design.

31

2012-06-11

Using the BI launch pad

Mode

Description

In Data mode you create, edit and manage queries that supply data to reports. You can, for example, create a new data provider, rename a data provider, or change the source from which a data provider draws its data.
Data

All the data providers used by the current document appear in a list in Data mode, and all toolboxes not related to working with data providers are disabled.
Data view is not available in the Web interface.
Reading mode allows you to view existing reports, search for text in reports, track changes in report data or drill down on report data.

Reading
The main application toolbar and the Left Panel are available in Reading mode. Toolboxes are not available.
Design mode allows you to perform a wide range of analysis tasks. You can, for example, add and delete report elements such as tables or charts, apply conditional formatting rules, and enhance reports with formulas and variables.
You can work with the report structure only in
Design mode, or with the report populated with data. Design mode

Working with the report structure only allows you to make modifications without accessing the server. When you work with reports populated with data, each change you make is applied on the server.
If you are making numerous modifications, you are recommended to work with the report structure only, and to populate the report with data when you have finished your modifications.

32

2012-06-11

Using the BI launch pad

4.4.3.1 To switch between application modes
1. To work in Data mode, click Data.
2. To work in Reading mode, click Reading.
3. To work in Design mode with the report structure only, click Design > Structure Only.
4. To work in Design mode with report data, click Design > With Data.
Depending on the mode you choose, the toolboxes and toolbars relevant to the mode are made available and other toolboxes and toolbars are either invisible or disabled.

33

2012-06-11

Using the BI launch pad

34

2012-06-11

Working with documents

Working with documents

5.1 To start the Web Intelligence interface
•

Start Web Intelligence, in the "BI launch pad": click Applications > Web Intelligence Application or select Web Intelligence Application in the application shortcuts.
Web Intelligence starts. The "Web Intelligence" tab is active in the main pane. To check which interface has started (Web, Rich Internet Application, or Rich Client), click Preferences and select
Web Intelligence.

Related Topics
• Queries defined
• Choosing the viewing and design interfaces

5.2 Creating and editing documents
You can create or edit documents from the BI launch pad using SAP BusinessObjects Web Intelligence or Web Intelligence Rich Client, which allows you to work with documents offline without a connection to the corporate repository.
You can work with documents either by selecting an existing document, or by starting your selected interface which you then use to open existing documents or create new documents.
You can base documents on universes, which present data in relational or OLAP datasources as collections of objects, on local data sources such as Microsoft Excel or CSV files, on SAP BEx Queries, or on Advanced Analysis workspaces.
You creat a new document, either a blank document, or a document based on a data source. The data sources you can use depend on the interface you are using.

35

2012-06-11

Working with documents

Table 5-1: Available data sources
Data source

Web interface

Rich Internet Application interface

Web Intelligence Rich
Client

No data source

Yes

Yes

Yes

Universe (unx or unv)

Yes

Yes

Yes

BEx query

No

Yes

Yes

Analysis View

No

Yes

Yes

Text source

No

Yes

Yes

Note:
•
•

For information specific to Web Intelligence Rich Client, see the SAP BusinessObjects Web
Intelligence Rich Client User's Guide or the online help for Web Intelligence Rich Client.
In order to connect to an Essbase OLAP data source from SAP BusinessObjects OLAP products including universe design tool, Web Intelligence Rich Client and Web Intelligence, ensure that
Essbase Client middleware is properly installed and configured on machines hosting those SAP
BusinessObjects OLAP products. Specifically, ensure that Essbase Client environment variables
ARBORPATH and ESSBASEPATH are created and set as Windows system environment variables
(as opposed to Windows user environment variables).

5.2.1 To create an empty document
You have started the Web Intelligence interface in Design mode.
You want to create a blank document for working with later.
1. Click the New icon in the toolbar.
2. Select No data source, and click OK.
A blank document opens. The "Available Objects" pane contains no objects.

5.2.2 To create a new document based on a universe
You have the necessary permissions to access a universe data source and create a query and document.
Certain universe objects may not be available depending on your permissions.

36

2012-06-11

Working with documents

You want to create a document based on either a .unx universe created with the information design tool, or you want to create a document based on a .unv universe created with the universe design tool.
1. Click the New icon in the toolbar.
2. Select Universe, and click OK.
3. Select a .unx or .unv universe as required. A default universe is proposed, you can use this universe or select a different universe. .unx universes have the file extension .unx, the .unv universes have no file extension.
4. Click Select.
A blank document is created, and the "Query Panel" is open, showing "Universe outline" in the left pane, and the "Result Objects", "Query Filters", and "Data Preview" panels in the main pane. You can build and run queries on the selected universe.

5.2.3 To create a new document based on a BEx query
•
•

You can only access BEx queries that have the flag "Allow External Access to the Query" is enabled.
The object mapping is not all equivalent, refer to the equivalents and restrictions pages to ensure that the queries can be used correctly.

Note:
You cannot use the Web Intelligence Web interface to create documents based on BEx queries.
You want to run queries on a BEx query data source.
1. Click the New icon in the toolbar.
2. Select BEx, and click OK.
The "Select a BW BEx query" pane displays. You can only see BEx queries that allow external access, and for which you have permissions to use.
3. Choose the appropriate connection folder. When a connection folder contains several BEx queries, select the appropriate BEx query and click OK.
A blank document is created, and the "Query Panel" is open, showing "Universe outline" in the left pane where the available BEx query objects are displayed, and the "Result Objects", "Query Filters", and
"Data Preview" panels in the main pane. You can build and run queries on the selected BEx query.

5.2.4 To create a new document based on an Analysis View
You have the appropriate permissions to acces Analysis Views and use them for reporting.
Note:
You cannot use the Web Intelligence Web interface to create documents based on Analysis Views.

37

2012-06-11

Working with documents

1. Click the New icon in the toolbar.
2. Select Universe, and click OK.
3. Navigate to the Analysis View that you want to use, select the Analysis View, and click OK.
A new blank document is created and the Query Panel is opened showing the avaliable query objects.
You can add objects to the query and filter panes, and run the query.

5.3 To open a document from the repository
You have logged in to BI launch pad.
1. In the BI launch pad, click the Documents tab to show the documents available in the repository.
2. Click the Folders tab on the left, and navigate to the folder containing your document.
3. Select the document, right-click and select View to open the document with the chosen View interface, or Modify to open the document with the chosen Modify interface.
When a document is set to refresh its data on opening (when the “Refresh on open” document property is selected), the document displays the latest information.
Note:
The Refresh on open option is dependent on two CMS settings (document and user-related security settings): "Check automatic refresh on open" in the CMC/Application/Webi/Properties and the "Disable automatic refresh on open" in the CMC/Application/user security settings. If the property Check automatic refresh on open security setting is ENABLED/checked in
CMC/Application/Webi/Properties and in the CMC/Application/user security settings, the security right Disable automatic refresh on open is DISABLED for this user, then even if the document is not set as being Refresh on open, it will still be refreshed on opening.
The document opens in the interface you selected in the Preferences options.
Related Topics
• Choosing the viewing and design interfaces

5.4 To open a document in Web Intelligence
You have access to the documents and have the appropriate permissions to open the document.
1. Launch Web Intelligence: click Applications > Web Intelligence Application
2. Click the Open icon in the toolbar.
The "Choose a document" dialog displays.
3. Navigate through the folders to the file you want to open. Select the file, click Open.

38

2012-06-11

Working with documents

The document is opened in Design mode. depending on your rights, you can work in reading and Design modes. 5.5 To delete a document from the repository
You have started the appropriate permissions to delete the file.
1. Log into the BI launch pad
2. Click the Documents tab to show the documents available in the repository.
3. Navigate to the folder that contains the document you want to delete .
4. Right-click the document that you want to delete and click Organize.
5. Click Delete.

5.6 Sending documents

5.6.1 To send a document by email
1. Select the document you want to send.
2. To send the document:
a. In the Web interface, select Send on the toolbar and select Email.
b. In the Rich Internet Application (Java applet), and in Web Intelligence Rich Client, click the arrow next to Send by E-mail attachment.
3. Fill in the email information and type a message if required.
4. Click Send.

5.6.2 To send a document to another user
Note:
This option is not available in Web Intelligence RIch Client.
1. Select the file you want to send.
2. Click Send on the toolbar and select BI Inbox.

39

2012-06-11

Working with documents

3. Select the users or groups to which you want to send the document from the list of users and groups.
4. Click Automatically generated to send the document with an automatically-generated name.
5. Click Specific name and type the name in the box to send if you want to name the document.
6. Click Shortcut to send a shortcut to the document or Copy to send a copy of the document.
7. Click Send.

5.6.3 To send a document by FTP
You have a document open in Web Intelligence and you have the required permissions to send files via FTP. If you do not have the permissions, the "Send to FTP" dialog will not display.
You want to transfer the current document via FTP.
1. Save the document before sending.
2. Click the Mail icon in the toolbar and select Send to Ftp.
3. Type the host name in the Host box.
4. Type the port in the Port box.
5. Type the username and password in the User Name and Password boxes.
6. Type the account in the Account box.
7. Type the directory in the Directory box.
8. Click Automatically generated to send the document with an automatically-generated name.
9. Click Specific name and type the name in the box to send if you want to name the document.
10. Click Send.

5.7 Managing reports in documents
Each Web Intelligence document contains one or more reports. You can add, delete, duplicate, or change the order of reports.

5.7.1 To rename a report
You have opened a document in Design mode.
1. Right-click the Report tab of the report you want to rename.
2. Select Rename Report on the menu and type the new report name.
3. Click outside the report name tab and save the document.

40

2012-06-11

Working with documents

5.7.2 To duplicate a report
You have opened a document in Design mode.
1. Right-click the report tab of the report you want to duplicate.
2. Click Duplicate Report.
3. Rename the duplicated report, if required.
4. Save the document.

5.7.3 To delete a report
1. Right-click the report tab of the report you want to delete and select Remove Report.
2. Save the document.

5.7.4 To change the order of reports
1. Right-click the report tab of the report whose order you want to change in the document.
2. Click Move Report on the menu, then select one of the menu options.
Option

Description

First

The report becomes the first report in the document

Previous

The report is moved to the previous position in the document

Next

The report is moved to the next position in the document

Last

The report is moved to the last position in the document

5.7.5 To add a report
You have opened a document in Design mode.
•

41

Right-click the report tab of any existing report and click Add Report.

2012-06-11

Working with documents

A new blank report is added to the document with the default name Report n.

5.7.6 To save a report locally
1. Right-click the report tab and select Export Current Report As.
2. Click PDF to save in PDF format, Excel to save in Excel format, or Excel 2007 to save in Excel
2007 format, click Text to save the report in text format.
3. Click Save on the "File Download" dialog box and navigate to the location where you want to save the file.
4. Navigate to the folder where you want to save the document.
5. Click Save.
The document is saved in the folder of your choice.

5.8 About saving documents, reports and data in Web Intelligence
You can save Web Intelligence documents in the corporate repository, export them locally, or export the data as CSV format. You can also export reports locally. You can do the following:
• Save a Web Intelligence document in the corporate repository
• Export a document locally as a PDF file
• Export a document locally as an Excel file
• Export a document locally as an Excel 2007 file
• Export a document locally as a Text file
• Export a report locally as a PDF file
• Export a report locally as an Excel file
• Export a report locally as an Excel 2007 file
• Export a report locally as a Text file
• Export data locally in CSV format file
Refer to the appropriate topics for instructions on how to save the different formats in the interface you are using.

5.9 About saving documents to MS Excel
You can select a priority for saving to MS Excel.

42

2012-06-11

Working with documents

•
•

Prioritize the formatting of the documents. Choose this option if you want to display the data in a format that is similar to working in SAP BusinessObjects Web Intelligence.
Prioritize easy data processing in Excel. Choose this option if you want to display the data in a text format. 5.10 To set preferences for saving documents as Excel
You are logged into the BI launch pad.
You can select a priority for saving to MS Excel. You can
1. In the "Header" panel, click Preferences.
2. Click Web Intelligence.
3. Under "Select a priority for saving to MS Excel", select the option that best fits your needs:
a. Choose Prioritize the formatting of the documents to display the data in a format that is similar to working in Web Intelligence.
b. Choose Prioritize easy data processing in Excel to display the data in a text format.
4. Click Save and Close.

5.11 Saving documents using Rich Client or the Java interface

5.11.1 To save a document in the corporate repository (with the Java interface or
Rich Client)
You are using the Java interface to perform this action.
1. Click the arrow next to Save on the toolbar in the File tab and select Save As to display the "Save
As" dialog box.
2. Select the corporate repository on the left of the dialog box.
3. If you are using the desktop interface, you can save to any available corporate repository by selecting
My Enterprise on the left of the dialog box, then logging in to the repository.
4. Click Folders or Categories to display the repository by folders or by categories.
5. In the Name box, type the name of the document.
6. Click Advanced to display additional document options.
The additional options are always displayed in the desktop interface.

43

2012-06-11

Working with documents

7. Type a description of the document in the Description box.
8. Type keywords that you or other users can use to search for the document in the future in the
Keywords box.
9. Select Refresh on open to refresh the document each time it is opened.
10. Select Permanent regional formatting to preserve the document regional formatting with the document. 11. Select Remove document security to remove all document security and make the document accessible in Standalone mode (desktop interface only).
12. Select Save for all users to ensure the document is not locked by the current user (desktop interface only). 13. Click OK.
Note:
If the property Check automatic refresh on open security setting is ENABLED/checked in
CMC/Application/Webi/Properties and in the CMC/Application/user security settings, the security right Disable automatic refresh on open is DISABLED for this user, then even if the document is not set as being Refresh on open, it will still be refreshed on opening.
The document is saved in the corporate repository.

5.11.2 To save a document as an Excel spreadsheet (with the Java interface or Rich
Client )
You are using the Java interface to perform this action. You can set formatting preferences when saving as Excel. This is done separately, see the related links below.
Note:
The table cell formatting Read content as HTML is not supported when exporting a document or report as pdf. Any table cells with this setting will appear blank in the generated pdf. To obtain the content in pdf, unselect this property. Right-click in the table cell, select Format Cell, and in the Display section of the General tab, change the "Read contents as" to some other value than HTML. The setting is applied to the entire column.
1. Click the arrow next to Save on the toolbar in the File tab and select Save As to display the "Save
As" dialog box.
2. Select My Computer , My Desktop, or My Documents on the left of the dialog box and navigate to the folder where you want to save the document.
3. Select Excel or Excel 2007 from the Files of Type list.
Each Excel 2007 worksheet can contain up to 1 million rows of exported data. If you save to Excel rather than Excel 2007, each 65,000 rows of exported data start on a new worksheet.
4. Select the reports you want to save as Excel or select Select All to save all reports
Each report within the document is saved as separate worksheet within the Excel file if you chose to save the entire document to Excel.

44

2012-06-11

Working with documents

5. Select Prioritize the formatting of the documents to match the layout and formatting of the document as closely as possible in the Excel file. (As a trade-off, this option does not exploit the data processing features of Excel to the same extent.)
6. Select Prioritize easy data processing in Excel to avoid merging multiple cells into Excel cells as much as possible to exploit the data processing features of Excel.
7. Click Save.
In Web Intelligence, all charts are automatically converted to images in Excel. You can use the exported data to create your own chart using the functionality of Excel.
Related Topics
• About saving documents to MS Excel
• To set preferences for saving documents as Excel

5.11.3 To save a document as PDF (with the Java interface or Rich Client)
You are using Web Intelligence Rich Client or the Java interface to perform this action.
Note:
The table cell formatting Read content as HTML is not supported when exporting a document or report as pdf. Any table cells with this setting will appear blank in the generated pdf. To obtain the content in pdf, unselect this property. Right-click in the table cell, select Format Cell, and in the Display section of the General tab, change the "Read contents as" to some other value than HTML. The setting is applied to the entire column.
1. Click the arrow next to Save on the toolbar in the File tab and select Save As to display the "Save
As" dialog box.
2. Select My Computer , My Desktop, or My Documents on the left of the dialog box and navigate to the folder where you want to save the document.
3. In the Files of Type field, select PDF.
4. Select Export current report as > PDF to save the current report as PDF.
When a report contains charts and images, you can optimize the size of the exported document by choosing the 96 dpi size. This can be useful for online publishing.
5. Select Select reports to select reports to save, then select the reports from the list, or select Current report to save the current report and select the pages you want to save.
6. Click Save.

5.11.4 To save a document as Text (with the Java interface or Rich Client)

45

2012-06-11

Working with documents

You are using the Java interface to perform this action.
•
1.
2.
3.
4.

Report elements are exported in the following order.
Based on report element (upper left corner) position.
Left to right, then top to bottom.
In page mode, report elements are exported page by page.
If the report element upper left corner is in page n, then all the report element data is exported with this page.
5. The exported file in page mode can be different from the result in draft mode.
• The separator used is a tab space.
• Charts /images are not exported
• Size limit for text file is defined in the CMC (export limit) – default value is 5 Mb – error message displays if the size limit is exceeded.
• If several reports are selected, they are appended one after another in the same text file.

1. Click the arrow next to Save on the toolbar in the File tab and select Save As to display the "Save
As" dialog box.
2. Select My Computer , My Desktop, or My Documents on the left of the dialog box and navigate to the folder where you want to save the document.
3. In the Files of Type field, select TXT File.
4. Select the reports to save from the list, or select Select All to export all reports.
5. Click Save.

5.11.5 To save document data as CSV (with the Java interface or Rich Client)
You are using the Java interface in Design or Data mode to perform this action. Saving to CSV only saves the raw data from the cube.
1. In Design or Data mode, select the query whose data you want to save as CSV and selectData
Access > Tools > Export Data.
2. Click on the file name.
3. Choose the text qualifier, column delimiter and character set in the dialog box.
4. Select Set as default values if you want the options you chose in the previous step to be the default options when you save to CSV.
5. Click Save.

5.12 Saving documents using the HTML interface

46

2012-06-11

Working with documents

5.12.1 To save a document in the corporate repository (with the HTML interface)
You are using the HTML interface to perform this action.
1. Click the arrow next to the Save icon and select Save As to display the "Save As" dialog box.
2. Select the folder where you want to save the document.
3. In the File Name box, type the name of the document.
4. Click the expand button to display additional document options.
The additional options are always displayed in the desktop interface.
5. Type a description of the document in the Description box.
6. Type keywords that you or other users can use to search for the document in the future in the
Keywords box.
7. Select the categories you want to associate with the document in the Assign Category box.
8. Select Refresh on open to refresh the document each time it is opened.
9. Select Permanent regional formatting to preserve the document regional formatting with the document. 10. Click OK.
The document is saved in the corporate repository.

5.12.2 To save a document or report as an Excel spreadsheet (with the HTML interface)
You are using the HTML interface to perform this action. To save the document or report locally, use
Export As. You can set formatting preferences when saving as Excel. This is done separately, see the related links below.
Note:
The table cell formatting Read content as HTML is not supported when exporting a document or report as pdf. Any table cells with this setting will appear blank in the generated pdf. To obtain the content in pdf, unselect this property. Right-click in the table cell, select Format Cell, and in the Display section of the General tab, change the "Read contents as" to some other value than HTML. The setting is applied to the entire column.
1. Click the Export icon on the toolbar and selectExport Document As/Export Current Report As
> Excel or select Export Document As/Export Current Report As > Excel 2007.
•
•

47

Each Excel 2007 worksheet can contain up to 1 million rows of exported data. If you save to
Excel rather than Excel 2007, each 65,000 rows of exported data start on a new worksheet.
Each report within the document is saved as separate worksheet within the Excel file if you chose to save the entire document to Excel.

2012-06-11

Working with documents

2. Click Save on the "File Download" dialog box that appears and navigate to the folder where you want to save the file.
All charts are automatically converted to images in Excel. You can use the exported data to create your own chart using the functionality of Excel.
3. Close the file download box.
Related Topics
• About saving documents to MS Excel
• To set preferences for saving documents as Excel

5.12.3 To save a document or report as PDF (with the HTML interface)
You are using the HTML interface to perform this action. You save the current document or the current active report.
Note:
The table cell formatting Read content as HTML is not supported when exporting a document or report as pdf. Any table cells with this setting will appear blank in the generated pdf. To obtain the content in pdf, unselect this property. Right-click in the table cell, select Format Cell, and in the Display section of the General tab, change the "Read contents as" to some other value than HTML. The setting is applied to the entire column.
1. Click the arrow next to Export on the toolbar in the File tab and select Export Document As/Export
Current Report As > PDF.
2. Click Save on the "File Download" dialog box that appears and navigate to the folder where you want to save the file.

5.12.4 To save a document or report as Text (with the HTML interface)
You are using the HTML interface to perform this action. You can save the current document or the current active report.

48

2012-06-11

Working with documents

•
1.
2.
3.
4.

Report elements are exported in the following order.
Based on report element (upper left corner) position.
Left to right, then top to bottom.
In page mode, report elements are exported page by page.
If the report element upper left corner is in page n, then all the report element data is exported with this page.
5. The exported file in page mode can be different from the result in draft mode.
• The separator used is a tab space.
• Charts /images are not exported
• Size limit for text file is defined in the CMC (export limit) – default value is 5 Mb – error message displays if the size limit is exceeded.
• If several reports are selected, they are appended one after another in the same text file.

1. Click the arrow next to Export on the toolbar in the File tab and select Export Document As/Export
Current Report As > Text.
2. Click Save on the "File Download" dialog box that appears and navigate to the folder where you want to save the file.
3. Close the file download box.

5.12.5 To save document data as CSV (with the HTML interface)
You are using the HTML interface to perform this action. Saving to CSV only saves the raw data from the cube.
1. Click the arrow next to Export on the toolbar in the File tab and select Export data to CSV .
2. Choose the text qualifier, column delimiter and character set in the dialog box.
3. Select Set as default values if you want the options you chose in the previous step to be the default options when you save to CSV.
4. Click OK, then click Save on the "File Download" dialog box that appears and navigate to the folder where you want to save the file.

5.13 Automatic saving and recovery

49

2012-06-11

Working with documents

5.13.1 Saving documents automatically
If autosave is active, and if you have the appropriate security rights, your documents are saved automatically in the My Favorites/ folder as you work. Autosaved document names consist of the document name prefixed by the document ID and followed by the autosaved document ID. If the document ID is -1, the document was not saved before being autosaved.
Note:
Web Intelligence Rich Client does not save documents automatically.
The interval at which documents are autosaved is defined in the CMC. This interval is reset each time you save a document manually, and each time a document is saved automatically. The autosaved document is also deleted when you save a document manually.
In addition to regular autosaving, documents are saved when your session times out.
Note:
If you lose a document before you can save it, check the folder immediately for the autosaved version.
The My Favorites/ folder is not a permanent storage location for autosaved documents.
For more information on the settings and security rights that impact automatic saving, see the documentation for the Central Management Console.
Related Topics
• Management of autosaved documents
• Recovering autosaved documents

5.13.2 Recovering autosaved documents
If your session times out while you are working on a document, your document is saved in the My
Favorites/ folder and displays a dialog box explaining that the session has ended.
You can select Restore on the dialog box, to launch a new session and re-open the autosaved document.
The next time you save the document manually, it is saved in its original folder.
If you select Close, you are redirected to the home page of the BI launch pad. The autosaved document is available in the My Favorites/ folder.
It is not always possible to link to the autosaved document after a server timeout or connection loss. In this you do not have the option to restore the autosaved document. You must check the My Favorites/ folder immediately for your autosaved document. Documents are regularly deleted from this folder based on the autosave settings.

50

2012-06-11

Working with documents

Related Topics
• Saving documents automatically
• Management of autosaved documents

5.13.3 Management of autosaved documents
Documents are autosaved in the My Favorites/ folder.
As a general rule, autosaving is transparent and you do not access autosaved documents directly. You need to access them directly when your session times out and it was not possible to retrieve your autosaved document manually.
Note:
If you need to access an autosaved document directly, check the My Favorites/ folder immediately.
This folder is not a permanent storage location for autosaved documents.
The My Favorites/ folder has a maximum size limit, which is set in the CMC. When the total size of the documents in the folder exceeds this limit, the application deletes as many of the oldest documents in the folder as necessary to make way for the latest document.
All documents are also deleted from the folder at a defined interval, which is set in the CMC.
If you navigate away from your document in your browser without saving the document, the document is lost and the contents of the My Favorites/ folder are cleared.
Related Topics
• Saving documents automatically
• Recovering autosaved documents

5.14 Setting document properties
The following table lists the document properties that you can view and/or set in the "Document Summary" pane: Property

Title

51

Description

The name of the document in the BI launch pad.
This is displayed above the general properties and cannot be edited.

2012-06-11

Working with documents

Property

Description

Type (Web interface only)

The type of document.

Author

The creator of the document.

Creation date

The date the document was created.

Locale

Tells you the formatting locale of the document.

Description

Optional information that describes the document.

Keywords

Optional keywords that can be used to search for the document in the BI launch pad.

Last refresh date

Informs you when the results were last refreshed with the latest data from the database.

Last modified

Informs you when the document was last modfiied.

Last modified by

Informs you who the last person was to modify the document.

Duration of the previous refresh

Informs you how long it took to retrieve the data from the database the last time the results were refreshed. Enhanced viewing

When this option is checked, the appearance of reports is optimized for onscreen viewing.
Automatically refreshes the results in reports with the latest data from the database each time the document is opened.

Refresh on Open

When Refresh on open is selected, data tracking does not display the difference between the data prior to the refresh and the data after the refresh.
Data after the refresh is treated as new data because the refresh purges the document.

Permanent regional formatting
Use query drill

Drills in query drill mode.

Enable query stripping

52

Formats the document according to the format locale with which it was saved.

Generates queries that only use objects that contribute to the reports in which they are used.
Each time a query is refreshed, non-contributing objects are ignored. Only relevant data is retrieved from the data provider. This feature enhances performance. 2012-06-11

Working with documents

Property

Description

Hide warning icons in chart

Hides warning icons in order to enhance readability.

Change Default Style (not available in the Web interface) You can change the default style for the document when working in the Rich Internet Application interface. You can import a new style or export the current style.

Data tracking

Track the following kinds of data changes:
• Inserted data
• Deleted data
• Changed data
• Increased values
• Decreased values

Auto-merge dimensions

Automatically merges dimensions with the same name and from the same universe. You see the merged dimension in the list of available objects with the dimensions merged within it below.
Merged dimensions are the mechanism for synchronizing data from different data providers.
Extends values of merged dimensions. Merged dimensions are the mechanism for synchronizing data from different data providers. This controls the results when a table contains synchronized data. Extend merged dimension values

When selected, if a table contains a dimension used in a merge, this dimension returns the value of its query plus the values of the other dimensions merged from other data providers for which there is an object in the table.
When this is not selected, if a table contains a dimension used in a merge, this dimension returns the value of its query.

53

2012-06-11

Working with documents

Property

Auto-Refresh

Description

Automatically refresh document: When this option is selected, and an object is added to or removed in the query, or when a different value is selected from a list in the Filter bar (All values, Simple values) , for example, the document is refreshed automatically. The #TOREFRESH message will not appear in the report because the refresh is automatic. This option only applies to aggregated delegated measures. For example when you add a total to a table in a report. Using this option can slow down the performance. If the drop in performance is a problem, consider deselecting this option. In this case #TOREFRESH will display when the report is modified.
Note:
This option can only be modified if the administrator has enabled it in the Web Intelligence Application properties from the CMC.

Default Style

You can change the default style that is used for the document. You can do the following:
• Import a different css stylesheet to replace the existing stylesheet.
• Export the current stylesheet to save or use elsewhere. • Reset the document to use the original stylesheet installed with the product. This option is only available when the current document stylesheet is different from the original stylesheet. Merge prompts (BEx variables)

Select this option if you want to merge prompts that are created in Web Intelligence from BEx variables in the original BEx query. Only BEx variables that have the same technical name are merged. When this option is unselected, any previously merged BEx variables are unmerged and treated as separate prompts.

Note:
You can set Web Intelligence to refresh automatically on opening the document without enabling
“Refresh on open” in the Document Properties by using the Central Management Console to unselect the security right "Disable Automatic Refresh on Open for all documents".

54

2012-06-11

Working with documents

Related Topics
• Merging defined
• Query drill defined

5.14.1 To display and set document properties
You have a document opened with the interface in Design mode.
1. Click Document on the Properties tab to display the "Document Summary" dialog box.
2. View or edit the properties in the dialog box as described above.
3. Click OK when you have finished.

55

2012-06-11

Working with documents

56

2012-06-11

Returning data using queries

Returning data using queries

6.1 Queries defined

6.1.1 Queries defined
When you create a document or add new data to a document, you use queries to retrieve data from a data source to the document. You build queries using a "Query Panel", and the type of query panel depends on the data source of the query.
Depending on the interface, on the interface you are using, you can create queries based on universes, which represent data in relational or OLAP databases as objects, on local data sources such as text files or Microsoft Excel files, on SAP Info Cubes in a SAP BW Business Warehouse by using BEx queries, on Pioneer data sources or on web services. You run the query to return data in a report which you can then analyze further by, for example, filtering or ranking its data.
Measures are common to all queries. Measures return data, often numeric, that is calculated based on the other objects in the query (dimensions or hierarchies).
Queries based on universes can be hierarchical or non-hierarchical. Non-hierarchical queries organize data in dimensions which have no hierarchical relationship. For example, a query containing a customer dimension and a revenue measure calculates revenue per customer.
Hierarchies organize data into hierarchical relationships. For example, a geographical hierarchy can contain data about countries, states and cities (different levels of the hierarchy). A query containing a geographical hierarchy and a revenue measure calculates revenue at the different levels of the hierarchy
(country, state, city).
Whether a universe query is hierarchical or non-hierarchical depends on the database from which the universe retrieves its data.
Note:
You cannot build queries using the Web interface (the DHTML interface): the "Query Panel" is not available. 57

2012-06-11

Returning data using queries

6.1.2 About query and document user rights
Whether you can view, create, modify, or delete queries and their related objects depends on your user rights. Whether you can view, create, modify, or delete documents and reports also depends on your user rights. Also, you will not be able to view certain elements of reports if you do not have the appropriate rights. These rights are defined by administrators. Administrators can view and edit queries even when the access rights have been limited to a restricted sub-set of users.

6.1.3 Classes and subclasses
Objects are grouped into folders called classes. Each class can also contain one or more subclasses.
Subclasses contain objects that are a further subcategory of the objects in the upper level of the class.
The role of classes is to organize the objects into logical groups. When you create queries on the universe, classes help you to find the objects that represent the information that you want to use in a query. 6.1.4 Analysis dimension
An analysis dimension contains a collection of related hierarchies. Analysis dimensions do not appear as result objects in queries . If you select an analysis dimension, its default hierarchy appears in the query. Analysis dimensions appear as follows:

6.1.5 Dimension
A dimension represents non-hierarchical data that can provide the basis for analysis in a report.
Dimensions typically retrieve character-type data, for example; customer names, resort names, or dates.
A query containing the [Customer] dimension and the [Revenue] measure, for example, returns the revenue generated by each customer.
Dimensions produce non-hierarchical columns in the result set generated by the query.

58

2012-06-11

Returning data using queries

In hierarchical data sources, hierarchies are based on dimensions. Hierarchies appear beneath the dimensions on which they are based in the list of available objects. You can include the dimension in the query to return non-hierarchical data, or one or more of its associated hierarchies to return hierarchical data. 6.1.6 Attribute
An attribute provides descriptive data about a dimension or hierarchy. For example, Age can be an attribute of the Customer dimension.
Attributes must have a one-to-one relationship with their associated dimension. Each value of a dimension object can have only one associated value of any attribute. In the above example, each Customer value can have only one associated value in the Age detail object.
If, due to incorrect universe design, a detail object tries to return multiple values for one dimension value, its cell displays the #MULTIVALUE error message.
Attributes appear as follows:

Note:
For .unv universes (created with the universe design tool), attributes are referred to as details, and apply to relational data sources.

6.1.7 Hierarchy
A hierarchy is a set of data members arranged in levels or parent-child relationships. For example, a
[Geography] hierarchy might contain the [Country], [State] and [City] levels.
Hierarchies produce hierarchical columns in the result set produced by the query. You can expand the items in the hierarchy to explore its data. For example, you can expand the [California] level in a
[Geography] hierarchy to explore data related to California.
You can select which members appear in the result set by using the Member Selector.
In hierarchical data sources, hierarchies are associated with a dimension and appear beneath the dimension with which they are associated in the list of available objects.

6.1.8 Level object

59

2012-06-11

Returning data using queries

A level is a set of members in a hierarchy at the same distance from the root of the hierarchy. For example, [City] might be a level in a [Geography] hierarchy which contains members such as [Los
Angeles] and [San Francisco].
Levels produce flat columns in the result set generated by the query. For example, a query containing the [Country] level and [Revenue] objects produces a result such as the following:
Country

Revenue

US

10,123,121

France

8,232,231

Germany

7,342,342

UK

9,343,092

Not all hierarchies contain levels. Levels are not available in hierarchies in BEx queries.
Levels appear as follows:

Related Topics
• BEx queries defined

6.1.9 Member
A member is an individual data item in a hierarchy. For example, the [Geography] hierarchy can contain members such as [France] at the [Country] level, or [Las Vegas] (at the [City] level).
You select individual members from a hierarchy for inclusion in the query result if you do not want to include all members in the hierarchy. You can also define a named set containing a set of members.

6.1.10 Named set
A named set is a named expression that returns a set of members. Named sets can be defined in OLAP databases, or in universes based on relational or OLAP databases.

60

2012-06-11

Returning data using queries

6.1.11 Calculated member
Calculated members are members returned by an MDX expression. MDX is the language used to access hierarchical data in OLAP databases.
The administrator of an OLAP database can create calculated members that are available to MDX queries that access the database.
Calculated members appear as follows:

6.1.12 Measure
Measures retrieve data, usually numeric, that is the result of calculations on data in the database. For example, Revenue is the calculation of the number of items sold multiplied by item price. Measures are often located in a Measures class.
By default, measures are calculated by aggregating detailed values returned from the database. Smart measures are a special kind of measure that are calculated by the database itself and returned by the query already aggregated.
In certain situations, smart measures impact the way in which calculations are displayed. For more information on smart measures, see the Using functions, formulas and calculations in Web Intelligence guide. Measures return results based on the objects with which they are associated in a query. For example, a query containing the [Customer] dimension and [Revenue] measure returns revenue by customer. A query containing the [Geography] hierarchy and [Revenue] measure returns revenue calculated for all the different aggregations possible in the hierarchy.
Measure objects appear as follows:

6.2 Building and working with queries

61

2012-06-11

Returning data using queries

6.2.1 Hierarchical and non-hierarchical queries

6.2.1.1 Non-hierarchical queries defined
Non-hierarchical queries are universe-based queries that do not include objects that organize data hierarchically. You build a non-hierarchical query using dimensions, attributes and measures. Dimensions represent business objects such as customers or cities. Measures derive results, usually numerical, from the dimensions you include in the query. For example, a query containing the [Customer] dimension and the [Revenue] measure returns revenue by customer.
Non-hierarchical queries produce result sets in which dimensions are not related. Each object in the query produces one flat column in the result set.
Non-hierarchical queries do not include the following objects: hierarchies, levels, members or named sets. Related Topics
• To build a query on a universe

6.2.1.2 Hierarchical queries defined
A hierarchical query contains at least one hierarchy object. You have the option to build hierarchical queries on universes that support hierarchical data, or on BEx queries which access SAP Info Queries directly. Hierarchical data can come from relational or OLAP databases, depending on how the universe structures the data.
Note:
For a relational Data Source, it is not a true hierarchy but a navigational path.
You can include hierarchies either as result or filter objects. When you build a hierarchical query, the query panel provides you with additional features for working with hierarchical data. For example, if you include a hierarchy as a result object, you have the ability to choose members from the hierarchy to appear in the result. These hierarchical features are not available when you build a query on non-hierarchical data. The exact features available in the hierarchical query panel also depend on the source of the hierarchical data you are accessing.

62

2012-06-11

Returning data using queries

The result set generated by a hierarchical query allows you to perform hierarchical data analysis. Each hierarchy object in the query produces a hierarchical column in the report. You can expand members to reveal their child members; for example, you can expand the [US] member to reveal US states in a
[Geography] hierarchy.
Measures in the block are aggregated depending on the member with which they are associated. For example, a hierarchical query containing the [Customers] hierarchy and the [Unit Sales] and [Store
Cost] measures gives the following result set:
Customers

Unit Sales

Store Cost

All Customers

364,707

371,579

276,773

234,555

CA

45,506

67,999

OR

32,104

56,700

10,324

12,325

US

Albany

Related Topics
• Hierarchical member selection in BEx queries
• Using contexts in BEx queries

6.2.1.2.1 Including multiple hierarchies in a query
When you combine multiple hierachies in a query, the query returns results for all the combinations of members in the different hierarchies.
Example: Including two hierarchies in a query
You have two hierarchies, [Gender] (containing the members [All], [Male] and [Female]) and [Customer
Geography]. Combined in a query with a measure, the two hierarchies give the following result:
Customer Geography

Internet Sales Amount

All Gender
All Customers

Gender

$29,358,677

Female

$10,000,000

Male

$19,358,677

All Gender

$2,644,017

63

Female

$1,058,677

Male

France

$1,285,340

2012-06-11

Returning data using queries

Customer Geography

Gender

Internet Sales Amount

All Gender

$1,249

Pierre
Female
All Gender

$1,249
$1,155

Alain
Female

$1,155

6.2.2 Building queries on universes

6.2.2.1 Universes defined
Universes present data from relational or OLAP data sources as collections of related objects. Universes contain two types of data:
Data Type

Description

Relational

Relational data organizes data as a collection of related objects (dimensions, details and measures). You combine universe objects in a query which you run to generate a report. For example, a query containing the Customer dimension and the Revenue measure generates a report showing revenue generated by customer. Hierarchical

Hierarchical data organizes data hierarchically as members in related hierarchies.
For example, a Geography hierarchy can contain levels showing countries, states and cities. A query built on the Geography hierarchy and Revenue measure generates a report showing revenue generated at different levels of the hierarchy
(revenue by country, by state and by city). The query automatically calculates the revenue values at different levels of the hierarchy.

The features available in the query panel you use to build a query on a universe are determined by the data in the universe. For example, the hierachical query panel allows you to select data members from a hierarchy.

64

2012-06-11

Returning data using queries

6.2.2.2 To select a default universe
You can select a default universe for universe-based queries. When the user creates a new document, the Select a universe dialog will show the default universe as selected.
1. In the BI launch pad, click Preferences.
2. Click Preferences in the left pane of the dialog box to display the list of preferences, then select
Web Intelligence from the list.
3. Click Browse beneath Select a default universe and browse to the universe you want to select as the default.
4. Select a universe and click OK at the bottom of the pane.
5. Click Save and Close.
6. You must Log Off and then Log On for the change to take effect.
When you create a new document based on a universe, when you choose the data source, the new default data source is selected. You can select a different data source if required.

6.2.2.3 To build a query on a universe
1. Click Data.
The Data Manager displays all the queries available in the document.
2. Select Data Providers > New > From Universe
3. Select the universe on which you want to create a document (then click Select if you are using the
Web Intelligence Rich Client).
The query panel opens.
4. Select the objects you want to include in the query and drag them to the Result Objects pane. To add all the objects in the class, drag the class to the Result Objects pane.
5. Repeat the previous step until the query contains all the objects you want to include.
6. Click Sort on the Result Objects toolbar and use the "Sort" dialog box to sort the query result.
7. Select the objects on which you want to define query filters and drag them to the Query Filters pane. To create a quick filter on an object, select the object in the Result Objects pane then click
Add Quick Filter at the top right of the pane.
8. Set the scope of analysis and other query properties.
9. To remove an object from the Result Objects or Query Filters panes, click Remove at the top right corner of the pane.
10. To remove all objects from the Result Objects or Query Filters panes, click Remove All at the top right corner of the pane.

65

2012-06-11

Returning data using queries

11. Click Run Query to run the query.
Note:
If a document is created with two data providers (Queries) based on same source (universe), when you change the source of one of the queries, the source of the other data provider is not changed.
Related Topics
• To preview query results
• Non-hierarchical queries defined
• To sort query results

6.2.2.4 Selecting members of a hierarchy
When you use a hierarchy in a query, you use the Member Selector to select members of the hierarchy to appear in the report generated from the query result set. After you have selected members, they appear below the hierarchy object in the query panel.
You can select members explicitly, or implicitly through functions. For example, you can explicitly select the [California] and [Los Angeles] members of the [Geography] hierarchy. You can select the child members of the [US] member (to give US states). You can also select the members included in a named set, for example Top Cities by Revenue, to include the cities that generate the most revenue.
Related Topics
• Overview of the Member Selector
• Member selection and hierarchical filtering compared

6.2.2.4.1 Member selection and hierarchical filtering compared
When you filter members in a query filter, you also impact measure aggregation. This is different from member selection in the Member Selector, which does not impact measures.
Example: Member selection and hierarchical filtering
In this example you have the following data:
Customer Geography

Internet Sales Amount

All Customers

$29,358,677.22
France

$2,644,017.71
Hauts de Seine

66

$263,416.19

2012-06-11

Returning data using queries

Customer Geography

Internet Sales Amount

Seine (Paris)
Germany

$539,725.80
$2.894,312.34

Brandenburg

$119,871.08

Hessen

$794,876.08

If you select only the France-related members in the Member Selector, the measure value for All
Customers is not impacted:
Customer Geography

Internet Sales Amount

All Customers

$29,358,677.22
France

$2,644,017.71
Hauts de Seine

$263,416.19

Seine (Paris)

$539,725.80

If you filter the Germany and its child members using a query filter, the All Customers measure is affected because the German figures no longer appear in the aggregation:
Customer Geography

Internet Sales Amount

All Customers

$26,464,364.08
France

$2,644,017.71
Hauts de Seine

$263,416.19

Seine (Paris)

$539,725.80

Related Topics
• Selecting members of a hierarchy

6.2.2.4.2 Overview of the Member Selector
You use the Member Selector to visualize and select members in a hierarchy. You can work with members explicitly, or with sets of members given, for example, by functions, named sets or hierarchy levels. 67

2012-06-11

Returning data using queries

You can also use the Member Selector to define prompts, which allow users to select which members they wish to include in a hierarchy when they run the query.
You launch the Member Selector from hierarchy objects that you include in queries in the query panel.
The following table describes the tabs available in the Member Selector.
Tab

Description

Members

The Members tab displays the members arranged hierarchically. Calculated members appear at the position in the hierarchy defined by the administrator.

Metadata

The Metadata tab shows the hierarchy levels (if the hierarchy supports levels), named sets and calculated members.

Prompts

The Prompts allows you to defer member selection until the query is run by displaying a prompt that allows the users to select members.

Note:
The "Query Panel" displays the technical name and the Business Name of objects or hierarchy objects.
The Technical Name is the name that identifies the object in addition to its Business Name. Technical
Names are not localized whereas Business Names are localized. For example, a Business name would be 'Customer', and the Technical Name could be Z_CUSTOMER.
Related Topics
• Selecting members of a hierarchy

6.2.2.4.3 To select hierarchy members
You have launched the query panel and there is at least one hierarchy object available for inclusion in the query.
1. Add the hierarchy object to the Result Objects pane in the query panel.
2. Click the arrow to the right of the hierarchy object to launch the Member Selector.
3. Use the Member Selector to select members for incusion in the query.
4. Close the Member Selector.
The selected members appear below the hierarchy object in the Result Objects pane. When you run the query, only those members are included in the query result.
Note:
If you do not select members, the default member for the hierarchy (defined in the database) is used in the query result. If no default member is defined, the top-level member is used.

68

2012-06-11

Returning data using queries

6.2.2.4.4 Showing the selected hierarchy members
The Query Panel indicates which members are selected.

6.2.2.4.5 To select hierarchy members explicitly
You have launched the query panel, selected a hierarchy object and launched the Member Selector.
1. Click Members to display the hierarchy members.
2. Select the members by clicking the check-box next to the member in the hierarchy display.
The members appear in the list of selected members in the Member Selector.
3. To select all members in the hierarchy, click All Members at the top of the hierarchy.
This option is useful when you want to include all members even if the hierarchy structure changes in the future.
4. Close the Member Selector
The members you selected appear below the hierarchy object in the query panel.
Related Topics
• To select hierarchy members

Hierarchical member selection in BEx queries
Use the "Query Panel""Member Selector" to select members of a hierarchy for your query.
Note:
When a BEx query contains a mandatory variable without a default value, you must open the "Set
Variables" pane in the "Query Panel" and enter a default value in the "Set Variables" pane before you can open the "Member Selector".
The following hierarchy illustrates member selection behavior in BEx queries.
World
EMEA
Europe
Middle East
Africa
North America
Asia PAC
Asia

69

2012-06-11

Returning data using queries

Pacific
Australia
Philippines
New Zealand
South America

Rule

When you select a member of a hierarchy at a given level.

All of the parent members in the hierarchy are selected. The root is always selected. It is not possible to select one specific level.

If you deselect a member when its parent member is already selected, all child members of the parent are also deselected.

If Pacific and all its child members are already selected and you deselect Australia, Philippines and New Zealand are also deselected. The following member selections appear:
• Europe
• Pacific

If you select a member when some of its child members are already selected, all child members are selected.

If Europe is selected and you select EMEA, Middle East and Africa are also selected. The following member selections appear:
• EMEA
• Children of EMEA

If you select a member when descendant members are already selected, all children of the member, and all siblings of the selected descendant members are also selected.

70

Example

If you select Asia PAC when Australia was already selected, Asia, Pacific (children of Asia PAC) and
Philippines and New Zealand (siblings of Australia) are also selected. The following member selections appear:
• Asia PAC
• Children of Asia PAC
• Pacific
• Children of Pacific

2012-06-11

Returning data using queries

Rule

Example

If you select a member when descendant members are already selected, all children of the member, and all siblings of the selected descendant members are also selected.

If you select Asia PAC when Australia was already selected, Asia, Pacific (children of Asia PAC) and
Philippines and New Zealand (siblings of Australia) are also selected. The following member selections appear:
• Asia PAC
• Children of Asia PAC
• Pacific
• Children of Pacific

Related Topics
• Restrictions when using BEx queries
• About selecting hierarchy members to a specified depth
• Hierarchical member selection in BEx queries
• Using contexts in BEx queries

About hierarchy node variables in BEx queries
When a prompt is present on a characteristic of a hierarchy node in a BEx query, this is referred to as a hierarchy node variable. When this occurs, the member selection function is disabled for that hierarchy.
The prompt related to the hierarchy node variable displays at run time.

6.2.2.4.6 To select hierarchy members using functions
You have launched the query panel, selected a hierarchy object and launched the Member Selector.
1. Click Members to display the hierarchy members.
2. Right-click the member to which you want to apply a function.
The menu displays the following options:

71

2012-06-11

Returning data using queries

Option

Description

Adds all child members of the member to the list of selected members.
.
The members immediately below the selected member are its children.
Children

The members apppear as Children of
[selected member] in the list.
Note:
You cannot include children and descendants of the same member. If you had already selected Descendants before selecting Children, the descendants are removed from the list and replaced by children.
Adds all descendant members of the member to the list of selected members.
All members below the selected member in the hierarchy are its descendants.

Descendants

The members apppear as Descendants of
[selected member] in the list.
Note:
You cannot include children and descendants of the same member. If you had already selected Children before selecting Descendants, the children are removed from the list and replaced by descendants

72

2012-06-11

Returning data using queries

Option

Description

Adds the parent member of the member to the list of selected members
The member immediately above the selected member is its parent.
The member appears as Parent of [select ed member] in the list.
Parent

Note:
You cannot include the parent and ancestors of the same member. If you had already selected
Ancestors before selecting Parent, the ancestors are removed from the list and replaced by the parent.
The Parent function is not available in BEx queries. Adds the ancestor members of the member to the list of selected members.
All members above the selected member in the hierarchy are its ancestors.
The members appear as Ancestors of
[selected member] in the list.

Ancestors

You cannot include the ancestors and parent of the same member in the list. If you had already selected Parent before selecting Ancestors, the parent is removed from the list and replaced by the ancestors.
The Ancestors function is not available in BEx queries. Adds the selected member and its sibling members to the list of selected members.

Siblings

All members at the same level as the selected member and that share the same parent are its siblings. The members appear as Siblings of [selected member] in the list.
The Siblings function is not available in BEx queries. 73

2012-06-11

Returning data using queries

3. Close the Member Selector.
The selected members appear below the hierarchy object in the Result Objects pane. When you run the query, only those members are included in the query result.
Related Topics
• To select hierarchy members

6.2.2.4.7 About level-based member selection
You can select members by level in the Metadata pane of the Query Panel. You can select members based on level and depth in the hierarchy.

6.2.2.4.8 About selecting hierarchy members to a specified depth
In the "Query Panel", you can select all members of a hierarchy to a specified depth. All members of the selected hierarchy until the specified depth are displayed in the report.

6.2.2.4.9 When a hierarchy variable is defined on a characteristic
When a hierarchy variable is defined on a characteristic, only one default hierarchy is displayed in the
Query Panel's universe outline.

6.2.2.4.10 To select hierachy members from a level
You have launched the query panel, selected a hierarchy object that supports levels and launched the
Member Selector.
You can select all the members at a level in the hierarchy if the hierarchy is organized into levels.
Note:
Not all hierarchies are organized into levels.
1. Click Metadata to display the hierarchy levels.
2. Select the levels whose members you want to include.
The members appear as All members of the [selected level] level in the list.
3. Close the Member Selector.
The selected members appear below the hierarchy object in the Result Objects pane. When you run the query, only those members are included in the query result.
Related Topics
• To select hierarchy members

74

2012-06-11

Returning data using queries

6.2.2.4.11 To select calculated members
You have launched the query panel, selected a hierarchy object, launched the Member Selector, and the database on which your universe is based supports calculated members.
1. Click Metadata and select the calculated member, or click Members and select the calculated member from the hierarchy.
• The position of the calculated member in the hierarchy is determined by the administrator.
• You cannot apply functions (for example Children or Parent) to a caculated member.
2. Select the calculated member from the list of calculated members.
3. Close the Member Selector.
The selected members appear below the hierarchy object in the Result Objects pane. When you run the query, only those members are included in the query result.
Related Topics
• To select hierarchy members
• Calculated member

6.2.2.4.12 To select named sets
You have launched the query panel, selected a hierarchy object and launched the Member Selector.
1. Click Metadata.
2. Select the named set from within the Named Sets folder.
3. Close the Member Selector.
The selected members appear below the hierarchy object in the Result Objects pane. When you run the query, only those members are included in the query result.
Note:
You can also include a named set by selecting it in from the list of available query objects. Named sets appear beneath the analysis dimension containing the hierarchy with which they are associated. When you select a named set, its parent hierarchy is included as a result object and the named set appears as a member selection beneath the hierarchy object.

6.2.2.4.13 To exclude hierarchy members
You have launched the query panel, selected a hierarchy object and launched the Member Selector.
1. Select the members or member sets that you want to exclude.
2. Click Exclude next to the selected members.
3. Close the Member Selector.
The excluded members appear below the hierarchy object in the Result Objects pane. When you run the query, these members are excluded from the hierarchy.
Note:
You cannot exclude members in BEx queries.

75

2012-06-11

Returning data using queries

6.2.2.4.14 To search for members
You have launched the query panel, selected a hierarchy object and launched the Member Selector.
You can search a hierarchy for specific members using the Member Selector.
Note:
The search is always performed on the entire hierarchy stored in the database, rather than only on the members already retrieved by the Member Selector.
1. Click Members.
2. Click the search button at the bottom right of the member display to launch the "Search" dialog box.
3. Type your search text in the "Search pattern" box.
You can use wildcards in the search.
Wildcard

Description

*

Replaces any string of characters

?

Replaces any individual character

4. Click Search in Text to search the display text of the members, or Search in Key to search their database keys.

6.2.2.4.15 To build prompts for selecting members
You have launched the query panel, selected a hierarchy object and launched the Member Selector.
You can defer member selection until the query is run. When you do so, the user is prompted to select members when they run the query.
Note:
•

Selection in member prompts is restricted to explicit selection of members. The user cannot select members using functions such as Ancestors or Parent.
• The rules about selecting members using functions apply here. Refer to the link at the bottom of this topic. 1. Click Prompts .
2. Click Enable Parameter to enable member selection when the query is run.
You cannot access the other tabs in the Member Selector when this option is selected.
3. Type the prompt text in the Prompt Text box.
4. Click Keep last values selected if you want the prompt to select the previously-chosen values by default when it is displayed.
5. Click Set default values, click Edit and select the default values if you want the prompt to select default values when it is displayed.
6. Close the Member Selector
The prompt text appears beneath the hierarchy in the query panel.

76

2012-06-11

Returning data using queries

Related Topics
• To select hierarchy members using functions

6.2.2.5 Resolving ambiguous queries

6.2.2.5.1 Ambiguous queries defined
An ambiguous query is a query that contains one or more objects that can potentially return two different types of information.
In a universe, certain dimensions may have values that are used for two different purposes in the database. For example, the [Country] dimension in the query below can return two types of information:
•
•

Customers and the country in which they spent their vacation.
Customers and the country for which they have made their reservation.

The role that Country plays in this query is ambiguous. A country can be either the country where a vacation was sold, or a country where a vacation is reserved. One is existing information (sales), and the other is future information (reservations).
To avoid ambiguities in a query, the universe designer identifies the different ways that objects can be used in the universe, and implements restrictions on how these objects can be combined. These restrictions are called contexts.

6.2.2.5.2 Contexts defined
A context is a defined group of objects that share a common business purpose. This business purpose is usually the type of information that these related objects represent. For example, a sales context is a grouping of all the objects that can be used to create sales queries. A reservations context is a grouping of all the objects that can be used in reservation queries. Contexts are defined in the universe by the universe designer.
You can combine any objects within the same context to create a query. You can also combine objects in different contexts. If you use an object that is common multiple contexts in a query and it is not possible to determine the best context that fits all the other objects in the query, you are prompted to choose the context to apply.

6.2.2.5.3 To choose a context when you run a query
When you create a query or refresh a report, you may be asked to choose a context before the query can run. Contexts are set up in a universe to avoid ambiguous queries.
You need to choose a context each time you run the query if the Reset contexts on refresh query property is selected. You will also need to choose contexts if you select the Clear contexts option in the query properties.

77

2012-06-11

Returning data using queries

1. Run the query containing multiple contexts.
The "Select a Context" dialog box appears.
2. Select the context in the "Select a Context" dialog box.

6.2.2.5.4 To reset contexts when a query is refreshed
The query panel is open.
1. Click Query properties on the query panel toolbar to display the "Query Properties" dialog box.
2. Select Reset contexts on refresh.

6.2.2.5.5 To clear contexts from a query
The query panel is open.
1. Click Query properties on the query panel toolbar to display the "Query Properties" dialog box.
2. Click Clear contexts.

6.2.2.6 Scope of analysis
The scope of analysis for a query is extra data that you can retrieve from the database to give more details on the results returned by each of the objects in a query. This extra data does not appear in the initial result report, but it remains available in the data cube, so you can pull this data into the report to allow you to access more details at any time. This process of refining the data to lower levels of detail is called drilling down on an object.
Note:
This option in the Query Panel is only available for relational unx universes and not for OLAP.
In the universe, the scope of analysis corresponds to the hierarchical levels below the object selected for a query. For example, a scope of analysis of one level down for the object Year, would include the object Quarter, which appears immediately under Year.
You can set this level when you build a query. It allows objects lower down the hierarchy to be included in the query, without them appearing in the Results Objects pane. The hierarchies in a universe allow you to choose your scope of analysis, and correspondingly the level of drill available. You can also create a custom scope of analysis by selecting specific dimensions to be included in the scope.
Note:
You cannot set the scope of analysis when working in query drill mode because this drill mode modifies the scope dynamically in response to drill actions.

78

2012-06-11

Returning data using queries

6.2.2.7 Levels of scope of analysis
You can set the following levels for scope of analysis:
Level

Description

None

Only the objects that appear in the Results Objects pane are included in the query.

•
•
•

For each object in the Result Objects pane, one, two, or three objects lower down the hierarchy tree are included in the query. The data from these objects is stored in the cube until you add them to the document.

One level down
Two levels down
Three levels down

Custom

All objects added manually to the Scope of Analysis panel are included in the query.

Including a scope of analysis in a document increases the document size significantly. This is because the data necessary for the scope you specify is saved with the document, even though it is not visible in the reports unless you start drill mode and drill down to the data to display the corresponding values.
In order to minimize the size of documents and optimize performance, include a scope of analysis only in documents where you are certain that users will need to drill.

6.2.2.8 To set the scope of analysis
1. Click the Show/Hide Scope of Analysis Pane button so that it appears pressed in.
The Scope of Analysis panel appears at the bottom of the Result Objects pane. The default scope of analysis is None. Each dimension in the Result Objects pane appears in the Scope of Analysis pane. 2. Click the down arrow in the Scope of Analysis drop-down list box.
3. Select a level for the scope of analysis.
The level appears in the list box and the dimensions that are hierarchically below each dimension in the Result Objects pane appear in the Scope of Analysis pane.
4. If you want to add selected dimensions to the scope of analysis or create a custom scope of analysis, select dimensions in the Query Manager and drag them across to the Scope of Analysis panel.

79

2012-06-11

Returning data using queries

6.2.2.9 Viewing the script generated by a query
When you build a query, the query generates SQL or MDX script behind the scenes to run against the database to return the query result. SQL is the query language understood by all relational databases.
MDX is the query language understood by OLAP databases.
You can view and edit the SQL generated by the query. You can view MDX queries but you cannot edit them. Note:
You cannot view the script of queries that call database stored procedures.

6.2.2.9.1 To view and edit the generated script
Note:
You cannot edit the query SQL when the query contains optional prompts. Edit the query to remove the optional prompts before attempting to edit the SQL.
1. Click SQL on the query toolbar to display the "SQL Viewer" dialog box.
When SQL is not editable, values supplied in response to prompts appear directly in the query.
For example, if "UK" was supplied in response to a prompt on [Country], a line similar to
Resort_country.country In ('UK')

appears in the query.
If no value has yet been supplied for the prompt, the Web Intelligence syntax for prompts (described below) appears in the query.
2. Click Use custom SQL to make the generated SQL editable.
When you make the SQL editable, the Web Intelligence syntax for prompts appears in the query.
For example, a line similar to
Resort_Country.country = @prompt('Enter Country:','A','Resort\Country',
Mono,Free,Persistent,,User:0)

appears in the query.
3. Click Validate after editing the script to check that your edits are valid.
4. Click Copy to copy the script to the clipboard. This option is not available in the Web interface.
5. Click Print to print the script. This option is not available in the Web interface.

6.2.2.10 Restricting the amount of data returned by queries

80

2012-06-11

Returning data using queries

6.2.2.10.1 To restrict the amount of data returned by a query
The query panel is open.
You can restrict the amount of data returned by queries by setting the maximum number of rows a query can return, using a sampled result set, choosing whether to retrieve empty rows, and choosing whether to retrieve duplicate rows.

Table 6-13: How you can restrict the amount of data returned by a query
Function

Available in

Retrieving duplicate rows

Relational .unx, OLAP , but not available in BEx queries. Returning sample result sets

Available in relational .unx, but not available in
OLAP .unx or BEx queries.

Retrieving/excluding empty rows

Available in OLAP .unx only. Not available in BEx queries. 1. Click Query properties on the query panel toolbar to display the "Query Properties" dialog box.
2. To exclude duplicate rows, make sure that Retrieve duplicate rows is not selected (this option is not available in BEx queries).
3. To select a maximum numbers of rows for retrieval, select Max rows retrieved and set maximum number of rows to be retrieved.
4. To return a sample result set, click Sample result set. To use fixed sampling, click Fixed. Sampling is not available in BEx queries.
The Fixed option is visible, but not activated if this option is not supported by your data source.
5. To exclude empty rows from the result, make sure that Retrieve empty rows is not selected.
Related Topics
• Retrieve empty rows query property
• Retrieve duplicate rows query property
• Sample result set query property
• Max rows retrieved query property

6.2.2.10.2 Max rows retrieved query property
The Max rows retrieved query property determines the maximum number of rows of data that are displayed when a query is run. If you only need a certain amount of data, you can set this value to limit the number of rows of data in your document.
Max rows retrieved is applied at the database level if the database supports it. If not, rows are discarded after retrieval from the database.

81

2012-06-11

Returning data using queries

Max rows retrieved does not distinguish between levels in hierarchical data. If Max rows retrieved is set to 3, the data in the first table below is truncated as in the second table.
Customers

Unit Sales

Store Cost

US

276,773

234,555

CA

45,506

67,999

OR

32,104

56,700

10,324

12,325

Customers

Unit Sales

Store Cost

US

276,773

234,555

CA

45,506

67,999

OR

32,104

56,700

Albany

The Sample result set query property also applies a restriction on the number of rows in the query, but at the database level. If you set Max rows retrieved to 2000 and Sample result set to 1000, the query retrieves a maximum of 1000 rows only.
This setting can be overridden by the limits set by your administrator in your security profile. For example, if you set the Max rows retrieved setting to 400 rows, but your security profile limits you to 200 rows, only 200 rows of data will be retrieved when you run the query.
Related Topics
• Sample result set query property

6.2.2.10.3 Sample result set query property
The Sample result set property determines the maximum number of rows that a query returns. This restriction is applied at the database level, in the generated script that is used to return the data.
Note:
The sample Result set option in the Query Panel is only available for relational unx universes, and not for OLAP .unx universes or BEx queries.
The Fixed option uses fixed sampling. At each data refresh, the query returns the same rows. If you do not set the Fixed option, the sampling is random. At each data refresh, the query returns a different set of sampled rows.
Sample result set is more efficient than the Max rows retrieved property, which discards rows beyond the maximum limit only after retrieving all the rows in the query.

82

2012-06-11

Returning data using queries

Not all databases support sampling. If it is not supported, the option is deactivated . Similarly, the Fixed option may not be supported by certain databases - in which case the Fixed option is deactivated.
Sampling is not available in BEx queries or OLAP .unx universes.
Related Topics
• Max rows retrieved query property
• BEx queries defined

6.2.2.10.4 Retrieve duplicate rows query property
In a database, the same data may be repeated over many rows. You can choose to have these repeated rows returned in a query, or to have only unique rows returned.
This option is not available in BEx queries, or if it is not supported by the underlying database.
Related Topics
• BEx queries defined

6.2.2.10.5 Retrieve empty rows query property
The return non-empty rows only query property returns rows only when they contain data.
This property is available only in universes based on OLAP data sources.

6.2.2.11 To set the maximum amount of time a query can run
The query panel is open.
Note:
This feature is not availale for BEx queries.
1. Click Query properties on the query panel toolbar to display the "Query Properties" dialog box.
2. Select Max retrieval time and enter the amount of time in seconds.

6.2.2.12 To allow other users to edit queries
The query panel is open.

83

2012-06-11

Returning data using queries

By default, queries can by edited only by the user who created them. You can give other users with the necessary rights the ability to edit queries.
1. Click Query properties on the query panel toolbar to display the "Query Properties" dialog box.
2. Click Allow all users to edit queries.

6.2.3 Building queries based on BEx queries

6.2.3.1 About BEx queries
BEx queries (Business Exchange queries) are queries created by SAP BEx Query Designer, based on
SAP Info Cubes in a SAP NetWeaver Business Warehouse (SAP NetWeaver BW). BEx queries retrieve the metadata from the data source. You use Web Intelligence to connect to a BEx query by using a
BICS (BI Consumer services) connection, and retrieve data via the BEx query for reporting purposes.
Web Intelligence automatically maps data from the BEx query to hierarchies, attributes, dimensions and measures as in universe-based hierarchical queries. Direct access on a SAP BEx query (through a BICS connection) does not allow you to rename, modify or add metadata.You do not create a universe for BEx queries. Note the following points about using BEx queries:
• You can only access BEx queries that have the flag "Allow External Access to the Query" is enabled.
• The object mapping is not all equivalent, refer to the equivalents and restrictions pages to ensure that the queries can be used correctly.
Note:
You can create, edit and refresh documents and reports based on BEx queries using Web
Intelligence"Rich Internet Application" interface (the Java applet), or Web Intelligence Rich Client. Use the Web Intelligence"Web" interface (DHTML mode) to view and refresh documents, but not edit them.

6.2.3.1.1 BEx queries defined
BEx queries are queries created from a different tool, they are based on SAP Info Cubes in a SAP BW
Business Warehouse. Web Intelligence automatically maps data from the BEx query to hierarchies, attributes, dimensions and measures as in universe-based hierarchical queries. You do not create a universe for BEx queries.
You use Web Intelligence to connect to a BEx query by using a ‘BICS’ (BI Consumer Services) connection. The resulting micro cube is represented in the Available Objects Pane as a tree of objects, but uses a subset of the features available in universe-based hierarchical queries. For example, the
Siblings, Parent and Ancestor member functions are not available in the "Member Selector" in
BEx queries. These restrictions are noted in the documentation relating to the features.

84

2012-06-11

Returning data using queries

Note:
Web Intelligence can create a document on a BEx query only when the BEx query connection authentication is pre-defined. Prompted authentication mode is not supported on the BEx query at document creation.
Related Topics
• To create a new query based on a BEx query

6.2.3.1.2 Supported BEx query metadata
The following NetWeaver BW metadata features are supported:
Metadata in BEx query

Supported

Characteristics (including Time and Unit)

Yes

Hierarchies

Yes

Basic Key Figures

Yes

Navigational Attributes

Yes

Display Attributes

Yes

Calculated Key Figures/Formulas

Yes

Restricted Key Figures

Yes

Custom Structures

Yes

Variables

Yes

The metadata types are mapped to Universe objects that can be used to build your queries and run reports. The datamapping is as follows:

Table 6-16: How BEx query metadata is mapped
This BEx query metadata

Characteristic

Dimension

Hierarchy

Hierarchy

Hierarchy level

N/A (levels are displayed in the Member Selector)

Attribute

Attribute

Characteristic properties (Key, Caption, Short description, Medium description, long description)

85

is mapped to this Web Intelligence 4.x object

Attribute

2012-06-11

Returning data using queries

This BEx query metadata

is mapped to this Web Intelligence 4.x object

Measure (numeric)
Key figure without unit/currency

Property formatted value (string)
Measure (numeric)
Property unit/currency (string)

Key figure with unit/currency

Property formatted value (string)

6.2.3.1.3 Restrictions when using BEx queries
Note:
The administrator must ensure that the BEx query complies with reporting restrictions described in the table below.
BEx query feature

Web Intelligence restriction

Linked nodes

Linked nodes are not displayed.

Lower level nodes

Lower level nodes are always shown after the main node.

Decimal number

The BEx query decimal number definition is not consumed in Web Intelligence. Use the formatted value instead if you need to keep the exact decimal setting in your report. You can also apply the decimal setting in the table and chart of your report.

Variable orders

Variables are displayed with respect to the variable dependency (less dependent first) rather than the order defined in the BEx query.

Number of objects allowed in a query

Do not use more than 50 objects in a BEx query, otherwise an error occurs.

Variables dependent on compound char- When there are dependencies between variables in comacteristics and the parent object pound characteristics and their parent, the dependencies are not guaranteed.
Row/Column display as hierarchy

Variables on default values

86

It is not possible to show an overall hierarchy out of an axis hierarchy. The characteristics, hierarchies, and key figures that make up the hierarchy are retained.
Do not define variables on default values in BEx queries.
The variables will be prompted without an effect on the
BEx query. Instead, define the default value in the filter.

2012-06-11

Returning data using queries

BEx query feature

Web Intelligence restriction

Filters as default values

Not supported, these are removed from the BEx query.
The filter will be ignored, or, if a variable is used, the variable prompt will display, but the user response is ignored.
Move any restriction based on a variable into the filter zone in order for it to be taken into account for reporting.

Expand to level

By default, hierarchies are not expanded to a given level.
Level00 is always the default level. To reproduce this behavior, expand the table and chart in the report, then save the document.

Query exceptions

These are not taken into account in Web Intelligence. Apply conditional formatting in Web Intelligence instead.

Complex selection

When a variable is defined to support the complex selection, there is no equivalent. This is limited to range selection.

Zero suppression

Rows of zero values are not removed from the result table.

Query default layout

Default positions of characteristics in Rows / Columns are not reproduced.

Position of lower level nodes

These are always below the upper levels.

Local calculations ("Rank", "Minimum"...) The key figures on which the local calculation are defined are removed from the BEx query. Avoid the use of these, prefer the equivalent calculation function in the report.
Result rows
Formula with calculation

It is recommended to avoid Formula with calculation depending on the layout (“Percentage share of result” ) that are not supported. You can use equivalent calculation function in the Web Intelligence report.

Hierarchical measure structures

Hierarchical measure structures are displayed as a flat list of measures.

Conditions

87

It is recommended to rely on Web Intelligence summaries instead. Do not use conditions. When the query is run, the conditions 'if present in the query) are not applied.

2012-06-11

Returning data using queries

BEx query feature

Web Intelligence restriction

Measures

Cannot be used in filters.

A hierarchy

Cannot be used in the result set and in filters at the same time. Attributes

Cannot be used in the result set and in filters at the same time. 6.2.3.2 About accessing BEx queries
In order to access BEx queries, the following conditions must be met:
•
•

You can only access BEx queries that have the flag "Allow External Access to the Query" is enabled.
You must have the appropriate security rights to access and use the BEx queries for reporting.

To define the connection, you can use the CMC to define the connection, or you can use the information design tool to publish the connection to the CMC. The simplest method is to use the CMC.

6.2.3.2.1 To enable access to BEx queries
BEx queries can only be accessed by other tools including Web Intelligence if the BEx Query property
"Allow External Access to the Query" is enabled. You must do the following or ask your administrator to perform the task below.
1. In the BEx Query Designer, select the query that you want to access with Web Intelligence.
2. In the Properties pane, select Advanced, and ensure that "Allow External Access to the Query" is selected. 3. Save the query.
4. Repeat the above steps for all BEx queries that you want to make available to Web Intelligence.
Web Intelligence can access these BEx queries.

6.2.3.2.2 To define a BICS connection with the CMC
You can connect to BEx queries via BICS connections that have been created and saved in the CMC.
You have the appropriate rights to use the CMC. To connect to a BEx query, you can define a BICS connection in the information design tool. You can define a connection to a single BEx query or to an
InfoProvider containing several BEx queries.
1. In the CMC console, Login to the CMC.
2. Choose "OLAP connection".
3. Define a new connection. In the New Connection window, in the Provider dialog, select "SAP
NetWeaver Business Warehouse".

88

2012-06-11

Returning data using queries

4. Enter the connection information and your system details.
5. Save the connection

6.2.3.2.3 To define a BICS connection to a BEx query in the information design tool
To connect to a BEx query, you can define a BICS connection in the information design tool. You can define a connection to a single BEx query or to an InfoProvider containing several BEx queries.
1. In the information design tool, use the New OLAP Connection wizard to define an OLAP connection and choose the SAP NetWeaver BW SAP BICS Client middleware driver.
2. Publish the connection to a repository where it can be accessed by Web Intellignce.
Use the New OLAP Connection wizard to define an OLAP connection.
You can now use Web Intelligence to select the connection and connect to the BEx query.

6.2.3.3 Building a Web Intelligence query on a BEx query
The following section describes how to build a Web Intelligence query based on a BEx query data source. 6.2.3.3.1 Hierarchical queries defined
A hierarchical query contains at least one hierarchy object. You have the option to build hierarchical queries on universes that support hierarchical data, or on BEx queries which access SAP Info Queries directly. Hierarchical data can come from relational or OLAP databases, depending on how the universe structures the data.
Note:
For a relational Data Source, it is not a true hierarchy but a navigational path.
You can include hierarchies either as result or filter objects. When you build a hierarchical query, the query panel provides you with additional features for working with hierarchical data. For example, if you include a hierarchy as a result object, you have the ability to choose members from the hierarchy to appear in the result. These hierarchical features are not available when you build a query on non-hierarchical data. The exact features available in the hierarchical query panel also depend on the source of the hierarchical data you are accessing.
The result set generated by a hierarchical query allows you to perform hierarchical data analysis. Each hierarchy object in the query produces a hierarchical column in the report. You can expand members to reveal their child members; for example, you can expand the [US] member to reveal US states in a
[Geography] hierarchy.
Measures in the block are aggregated depending on the member with which they are associated. For example, a hierarchical query containing the [Customers] hierarchy and the [Unit Sales] and [Store
Cost] measures gives the following result set:

89

2012-06-11

Returning data using queries

Customers

Unit Sales

Store Cost

All Customers

364,707

371,579

276,773

234,555

CA

45,506

67,999

OR

32,104

56,700

10,324

12,325

US

Albany

Related Topics
• Hierarchical member selection in BEx queries
• Using contexts in BEx queries

6.2.3.3.2 About building a query based on a BEx query
When you have connected to your BEx query, Web Intelligence maps the BEx query metadata to the
Web Intelligence query objects. You use the "Query Panel" to select the appropriate objects to build your query. You can add filters and prompts in the same way as you create queries on universes, but there are restrictions in certain situations, refer to the section Restrictions when using BEx queries.
Related Topics
• Restrictions when using BEx queries
• About selecting hierarchy members to a specified depth
• Hierarchical member selection in BEx queries
• Using contexts in BEx queries

6.2.3.3.3 To create a new query based on a BEx query
To access the BEx query, the BEx query must have the flag "Allow External Access to the Query" enabled. 1. In Design mode, click New > Bex to display the "Select a BW BEx Query" dialog box.
2. Select the appropriate BICS connection from the pane on the left of the dialog box.
3. Select the BEx query in the right pane and click OK. When a BICS connection is based on an
InfoCube, there may be several BEx queries available.
The Query Panel appears, displaying the objects in the query as hierarchies, dimensions and attributes. If you cannot see the BEx query that you want to use, use the BEx Query Designer to ensure that the "Allow External Access to the Query" property is tagged in the query.
4. Build the query and query filters using the available objects.

90

2012-06-11

Returning data using queries

Note:
You cannot filter on result objects in BEx queries.
Note:
If the BEx query you connected to is designed to include an SAP server-side variable, you can change the value of the variable in the "Query Panel" - click the Set Variable button and select a new variable from the available List of Values.

6.2.3.3.4 About the scaling factor in BEx queries
When a BEx query contains measures that are mapped from scaled key figures, the factor of scaling on the measure is displayed in the resulting report. When the scaling factor is changed for the key figure, this change is reflected in the report when the report is refreshed. The scaling factor is displayed for the measure name in the report, and for the measure attribute in the "Query Panel".

6.2.3.3.5 About hierarchy node variables in BEx queries
When a prompt is present on a characteristic of a hierarchy node in a BEx query, this is referred to as a hierarchy node variable. When this occurs, the member selection function is disabled for that hierarchy.
The prompt related to the hierarchy node variable displays at run time.

6.2.3.3.6 Hierarchical member selection in BEx queries
Use the "Query Panel""Member Selector" to select members of a hierarchy for your query.
Note:
When a BEx query contains a mandatory variable without a default value, you must open the "Set
Variables" pane in the "Query Panel" and enter a default value in the "Set Variables" pane before you can open the "Member Selector".
The following hierarchy illustrates member selection behavior in BEx queries.
World
EMEA
Europe
Middle East
Africa
North America
Asia PAC
Asia
Pacific

91

2012-06-11

Returning data using queries

Australia
Philippines
New Zealand
South America

Rule

When you select a member of a hierarchy at a given level.

All of the parent members in the hierarchy are selected. The root is always selected. It is not possible to select one specific level.

If you deselect a member when its parent member is already selected, all child members of the parent are also deselected.

If Pacific and all its child members are already selected and you deselect Australia, Philippines and New Zealand are also deselected. The following member selections appear:
• Europe
• Pacific

If you select a member when some of its child members are already selected, all child members are selected.

If Europe is selected and you select EMEA, Middle East and Africa are also selected. The following member selections appear:
• EMEA
• Children of EMEA

If you select a member when descendant members are already selected, all children of the member, and all siblings of the selected descendant members are also selected.

92

Example

If you select Asia PAC when Australia was already selected, Asia, Pacific (children of Asia PAC) and
Philippines and New Zealand (siblings of Australia) are also selected. The following member selections appear:
• Asia PAC
• Children of Asia PAC
• Pacific
• Children of Pacific

2012-06-11

Returning data using queries

Rule

Example

If you select a member when descendant members are already selected, all children of the member, and all siblings of the selected descendant members are also selected.

If you select Asia PAC when Australia was already selected, Asia, Pacific (children of Asia PAC) and
Philippines and New Zealand (siblings of Australia) are also selected. The following member selections appear:
• Asia PAC
• Children of Asia PAC
• Pacific
• Children of Pacific

Related Topics
• Restrictions when using BEx queries
• About selecting hierarchy members to a specified depth
• Hierarchical member selection in BEx queries
• Using contexts in BEx queries

To select hierarchy members using functions
You have launched the query panel, selected a hierarchy object and launched the Member Selector.
1. Click Members to display the hierarchy members.
2. Right-click the member to which you want to apply a function.
The menu displays the following options:
Option

Description

Adds all child members of the member to the list of selected members.
.
The members immediately below the selected member are its children.
Children

The members apppear as Children of
[selected member] in the list.
Note:
You cannot include children and descendants of the same member. If you had already selected Descendants before selecting Children, the descendants are removed from the list and replaced by children.

93

2012-06-11

Returning data using queries

Option

Description

Adds all descendant members of the member to the list of selected members.
All members below the selected member in the hierarchy are its descendants.

Descendants

The members apppear as Descendants of
[selected member] in the list.
Note:
You cannot include children and descendants of the same member. If you had already selected Children before selecting Descendants, the children are removed from the list and replaced by descendants

Parent

The Parent function is not available in BEx queries. Ancestors

The Ancestors function is not available in BEx queries. Siblings

The Siblings function is not available in BEx queries. Descendents until Named Level

Use the list of level names to choose the level.

Descendents until

Choose the number of levels that you want to include in the selection.

3. Close the Member Selector.
The selected members appear below the hierarchy object in the Result Objects pane. When you run the query, only those members are included in the query result.
Note:
You cannot exclude hierarchy members in BEx queries.
Related Topics
• To select hierarchy members

94

2012-06-11

Returning data using queries

Notes about using calculated members in BEx queries
For specific restrictions concerning calculated members, refer to the topic Restrictions when using BEx queries. Related Topics
• Restrictions when using BEx queries
• About selecting hierarchy members to a specified depth
• Hierarchical member selection in BEx queries
• Using contexts in BEx queries

To search for members
You have launched the query panel, selected a hierarchy object and launched the Member Selector.
You can search a hierarchy for specific members using the Member Selector.
Note:
The search is always performed on the entire hierarchy stored in the database, rather than only on the members already retrieved by the Member Selector.
1. Click Members.
2. Click the search button at the bottom right of the member display to launch the "Search" dialog box.
3. Type your search text in the "Search pattern" box.
You can use wildcards in the search.
Wildcard

Description

*

Replaces any string of characters

?

Replaces any individual character

4. Click Search in Text to search the display text of the members, or Search in Key to search their database keys.

To build prompts for selecting members
You have launched the query panel, selected a hierarchy object and launched the Member Selector.
You can defer member selection until the query is run. When you do so, the user is prompted to select members when they run the query.
Note:
•

95

Selection in member prompts is restricted to explicit selection of members. The user cannot select members using functions such as Ancestors or Parent.

2012-06-11

Returning data using queries

•

The rules about selecting members using functions apply here. Refer to the link at the bottom of this topic. 1. Click Prompts .
2. Click Enable Parameter to enable member selection when the query is run.
You cannot access the other tabs in the Member Selector when this option is selected.
3. Type the prompt text in the Prompt Text box.
4. Click Keep last values selected if you want the prompt to select the previously-chosen values by default when it is displayed.
5. Click Set default values, click Edit and select the default values if you want the prompt to select default values when it is displayed.
6. Close the Member Selector
The prompt text appears beneath the hierarchy in the query panel.
Related Topics
• To select hierarchy members using functions

6.2.3.3.7 Using contexts in BEx queries
A context is a defined group of objects that share a common business purpose. This business purpose is usually the type of information that these related objects represent. For example, a sales context is a grouping of all the objects that can be used to create sales queries. A reservations context is a grouping of all the objects that can be used in reservation queries. Contexts are defined in the universe by the universe designer.
You can combine any objects within the same context to create a query. You can also combine objects in different contexts. If you use an object that is common multiple contexts in a query and it is not possible to determine the best context that fits all the other objects in the query, you are prompted to choose the context to apply.
Related Topics
• Restrictions when using BEx queries
• About selecting hierarchy members to a specified depth
• Hierarchical member selection in BEx queries

6.2.3.3.8 Changing the data source for BEx queries
You can change the data source for a document based on a BEx query in the following way:

Table 6-22: Changing the data source
Original data source

A BEx query

96

Change to...

A .unv universe on an OLAP source

2012-06-11

Returning data using queries

Original data source

Change to...

A BEx query

Another BEx query

When you change the source, the Query Panel automatically starts. You must edit the query accordingly.

6.2.4 Building queries on Advanced Analysis views

6.2.4.1 SAP BusinessObjects Analysis defined
SAP BusinessObjects Analysis is an OLAP analysis tool that allows users to interactively define analyses to explore data in OLAP data sources. Users can export data in their analyses as Analysis Views, for use in other applications including SAP BusinessObjects Web Intelligence.
You can build queries on Analysis Views to analyse their data in Web Intelligence documents. The data in the Analysis View appears in the query panel as report objects such as hierarchies, dimensions and attributes. Note:
Analysis Views with custom objects are not supported. Only analysis views coming directly from
NetWeaver BW are supported.

6.2.4.2 To build a query on an Analysis View
Note:
You cannot build a query on an analysis view with the Web interface (DHTML client).
1. In Design or Data mode, select Data Access > New > From Analysis View to display the "Select an Analysis View" dialog box.
2. Select the folder containing the Analysis View in the Folders pane.
3. Select the Analysis View in the right pane.
The Query Panel appears, displaying the data in the Analysis View as report objects.
4. Click Run to run the query.

97

2012-06-11

Returning data using queries

6.2.5 Working with multiple queries

6.2.5.1 Using multiple queries
You can include one or multiple queries in a document. These queries can be based on any supported data source.
For example, you can include product sales data and customer data in the same document. In this case, your corporate data for product line sales is available on one universe and data on customers is available on another universe. You want to present product line sales results and information on customer age groups in the same report. To do this, you create a single document that includes two queries; one query on each universe. You can then include and format results from both queries on the same report.
Defining multiple queries in a single document is necessary when the data you want to include in a document is available in multiple data sources, or when you want to create several differently-focused queries on the same data source. You can define multiple queries when you build a new document or add more queries to an existing document. You can present the information from all of the queries on a single report or on multiple reports in the same document.

6.2.5.2 Multiple queries, combined queries and synchronized queries compared
Multiple queries can be related in a document in different ways.
•
•

Basic multiple queries draw unrelated data from different sources.
“Synchronized queries” relate the data from different queries around a dimension that contains data common to both queries. These dimensions are called merged dimensions.
You merge dimensions after you have created and run your multiple queries.

•

“Combined queries” are a special kind of query. Combined queries generate SQL containing the
UNION, INTERSECT and MINUS operators (if the database supports them) or simulate the effect of these operators.
Combined queries allow you to answer complex business questions that are difficult to formulate using standard queries.
Note:
This option is not accessible for OLAP databases or for .unx relational databases. It is available for
.unv relational universes only.

98

2012-06-11

Returning data using queries

6.2.6 Managing queries

6.2.6.1 To switch to Data mode
Note:
Data mode is not available in the Web interface (DHTML client).
•

Click Data on the top right menu.
The Data pane appears with the document selected. All the data providers appear in a list to the right of the Data pane. The list displays information about the data provider such as the number or rows in contains and its last refresh date.

6.2.6.2 Managing queries with the Data Manager
You can use the Data Manager to view, explore and manage all the queries in a document. It consists of a Data pane that you use to explore the queries, and a list display that changes depending on the selection in the Data pane.
You use the Data Manager by switching to Data view. In Data view, the toolboxes in the Data Access group only are available.

6.2.6.2.1 To view and filter the data in a data provider
1. Switch to Data mode to display the Data Manager.
2. Select the data provider in the Data pane.
The data in the objects in the data provider appears in a list to the right of the data pane, with one column for each object.
Note:
If the data provider contains multiple contexts or grouping sets, they appear in a drop-down list at the top right of the list pane. Each context or grouping set appears as Result n. Select a context or grouping set from the list to display its data.
3. To filter the data, click the arrow on a column header and select a value from the drop-down list, or select Custom and define a custom filter.

99

2012-06-11

Returning data using queries

A custom filter contains a filter operators and values that you select from the list of values or type directly. The number of values you can specify depends on the operator).
The custom filters are as follows:
Operator

Description

is anything

The data is not filtered

is

The data is equal to a single value (equivalent to selecting a single value from the drop-down list)

does not equal

The data is not equal to a single value (all values apart from that value are displayed) is in

The data is in a list of values (the selected values only are displayed)

is not in

The data is not in a list of values (all values apart from the selected values are displayed) is empty

Only rows with empty values are displayed

is not empty

Only rows with non-empty values are displayed

begins with

Only rows that begin with the text you type are displayed

ends with

Only rows that end with the text you type are displayed

contains

Only rows that contain the text you type are displayed

does not contain

Only rows that do not contain the text you type are displated

The data is filtered based on the values you specified. The filter also restricts the display in the other column. For example, if you filter the column showing the Customer dimension to show three values only, the Order Amount column displays only the values that correspond to the remaining Customer values. 6.2.6.3 To manage queries using the Data Manager
You can view, explore and manage all the queries in a document using the Data Manager. The Data
Manager lists all the queries and allows you to perform actions such as renaming a query or changing the source of the data on which a query is based.
1. To display the Data Manager, click Data on the main toolbar.
All the queries providing data to the document appear in a list, the Left Pane contains a Data tab only that lists all the objects in the selected query, and only the toolbox items relevant to managing queries are enabled.
2. To edit a query, right-click the query and in the contextual menu, select Edit.
The query panel for the query you selected appears.

100

2012-06-11

Returning data using queries

3. To purge a query of data, right-click the query and in the contextual menu, select Purge from the menu. 4. To purge the last responses to prompts, select Purge last selected prompt values. When the query is refreshed, the default values (if any) are proposed, but the last used reponses prior to the purge are not proposed. When this option is not selected, the last used reponses are proposed.
5. To rename a query, right-click the query and in the contextual menu, select Rename, then type the new name.
6. To change the data source of a query, right-click the query and in the contextual menu, select
Change Source*
For detailed information on changing the data source of a query, see the link at the bottom of this topic. * When using an Excel data source in Web Intelligence Rich Client, the Tools -> Change Source options are not available: Open the "Query Panel", and in the "Query Properties" tab, use the
Source Path menu to select a different source file.
Related Topics
• Changing the data source of a query

6.2.6.4 To set the key dates of queries
If one or more of the queries in the document contains a key date, you can set the key dates.
1. Select Data Access > Data Providers > Keydates.
2. Select Use the default date for all queries to set each query to its default key date.
3. Select Set date for all queries and choose the date to specify a key date for all queries.
4. Select Prompt users when refreshing data to display a prompt for the key date whenever a query containing a key date is refreshed.

6.2.7 To sort query results
The query panel is open.
You can sort the results returned by a query. The sorts are added directly to the script generated by the query and the database returns the query results already sorted.
For example, sorts added to queries that generate SQL appear in the ORDER BY clause of the generated
SQL.
Note:
Sorting is not available in queries based on OLAP data sources.

101

2012-06-11

Returning data using queries

1. Click Sort on the Result Objects toolbar to display the "Sort" dialog box.
2. Click Insert sort object and select the object in the "Select an Object" dialog box that displays to add a sort on an object.
3. Select the sort direction from the Sort type list.
4. Repeat the previous steps to add additional sorts to the query.
5. Select an object and click Delete selection to remove a sort from the query, or click Delete All to remove all sorts from the query.
6. Click OK to close the "Sorts" dialog box.
The sorts are added to the script generated by the query.

6.2.8 To preview query results
You have defined the result objects and filter objects in the query panel.
You can preview the results of a query in the Data Preview pane in the query panel.
•

Click Show/Hide Data Preview Pane on the query panel toolbar to display the Data Preview pane.

6.2.9 Displaying data from an added query
When a query is not the first query in the document, you need to specify in the "New Query" box how its data will be displayed.
Option

Description

Insert a table in a new report

Display the data on a new report in the document

Insert a table in the current report

Display the data on the currently selected report in a new table Include the result objects in the document without generating a table

Include the data in the document without displaying the data on a report. (You can add the objects returned by the query to the report later.)

6.2.10 To interrupt a query
You can interrupt a query before all the data is returned to the document.

102

2012-06-11

Returning data using queries

When you interrupt a query, only partial data is returned to the document. The values displayed in the document do not accurately reflect the definition in the query.
When you interrupt data retrieval, you have a choice of which data to display.
Note:
In the Web interface, when you cancel a query that is running, the Web interface returns to the precedent state of the document, and does not propose the option to interrupt data retrieval.
1. On the "Waiting - Refresh Data" dialog box, click Cancel.
The "Interrupt Data Retrieval" dialog box appears.
2. Select one of the options on the "Interrupt Data Retrieval" dialog box.
Option

Description

Restore the results from the previous data retrieval

Restores the values to the document that were retrieved the last time the query was run. The values displayed will not be the most up to data information available on the database. You can run the query later to return the up to date values from the database

Purge all data from the document

Displays the document empty of values. The structure and formatting of the document is retained. You can run the query later to return the up to date values from the database

Return the partial results

Displays the new values retrieved so far in the appropriate parts of the document. The rest of the document will display the values retrieved the last time the query was run

6.2.11 To remove a query
1. Select the query you want to remove by right-clicking the appropriate Query tab.
2. Click Remove.

6.2.12 To duplicate a query
You must run the query first before you are allowed to duplicate the query.
If you want to build a different query on a universe already included in the document, you can duplicate the existing query on that universe and then modify it, instead of starting from scratch.
1. Select the query you want to duplicate by right-clicking the appropriate Query tab at the bottom of the report panel.

103

2012-06-11

Returning data using queries

2. Select Duplicate

6.2.13 Changing the data source of a query
You can change the data source of a query. This is useful, for example, when you want to develop a document on a universe in a test environment, then change to a universe in a production environment.
You can change the source of the data, but you will have to map objects to different objects in the same query or in a different query.
It is not possible to change between all data sources. The following table lists the possible changes
(from a source to a target):
Target

UNV universe

UNX universe on relational data source

UNX universe on
OLAP data source Change possible Change possible Change possible Change possible UNX universe on relational data source Change possible Change possible Change possible UNX universe on
OLAP data source Change possible *

Change possible Change possible Source

UNV universe

Personal data provider
(CSV, Excel)
BEx query
Advanced
Analysis view Personal data provider
(CSV, Excel)

BEx query

Advanced
Analysis
view

Change possible** Change possible Change possible * When changing between these two sources, extensive remapping of objects may be required.

104

2012-06-11

Returning data using queries

** See the first note below concerning changing the data source for Excel files with Web Intelligence
Rich Client.
When you choose the query whose data source you want to change, you are presented only with those data sources to which a change is possible.
You can change the data source in the Java applet or Web Intelligence Rich Client only. In Web
Intelligence Rich Client, you also have the option to change the data source of queries based on personal data files such as Excel files (see the first note below).
Note:
When using an Excel data source in Web Intelligence Rich Client, the Tools -> Change Source options are not available: Open the "Query Panel", and in the "Query Properties" tab, use the Source Path menu to select a different source file.
Note:
•
•

When a report contains two queries based on the same universe, you can change the data provider for one of the queries from a universe to a BEx query.
When the source for a query is a universe (.unv file), you can change the source to a BEx query.
You must remap objects to their corresponding object type in the new source.

6.2.13.1 To change the data source of a query
You change the data source on which a query is based by identifying the objects in the new data source that are the equivalents of the objects in the current data source. Where possible, source and target objects are mapped by default based on their name, object type, data type and location in the data source. Note:
You cannot map query filter objects.
You can change mappings manually, or create mappings manually for objects that could not be mapped by default.
1. Click Data to display the Data Manager and list the data providers in the document.
2. Right-click the query whose source you want to change and select Change Source.
When using an Excel data source in Web Intelligence Rich Client, the Tools -> Change Source options are not available: Open the "Query Panel", and in the "Query Properties" tab, use the
Source Path menu to select a different source file.
3. Select Choose an existing data source from the document to select a target data source that is already used in the document, or Specify a new data source, then specify the data source from the list, to choose a different data source.
It is not possible to change between all types of data sources. The lists display only those data sources to which a change from the current data source is possible.
4. Click Next.

105

2012-06-11

Returning data using queries

The source and target objects appear in default mappings.
If the data sources contain hierarchical data, all objects in the hierarchy appear beneath their parent hierarchy. 5. For each object pair that you want to map manually, click ... to display the "Map Object" dialog box.
6. Use the "Map Object" dialog box to choose which object in the new universe replaces the object in the current universe.
Objects are mapped by default based on the object type, data type, name and path in the source and target data sources. You can accept the default mapping or choose your own mapping.
If no default mapping is possible, the object appears as Remove result object in the target data source. If you do not select an object from the new data source, the unmapped object is removed from the query when you change the data source.
If the removed object is the filtered object or rank-based object in a database ranking, the application displays a warning message. If you decide to remove the objects, the objects are removed from the ranking or sub-query.
If the removed object is the filtering object in a query on query filter, the application displays a warning message. If you remove the object, the query on query filter is removed.
7. Click Finish to change the data source.

106

2012-06-11

Refreshing Web Intelligence documents based on PDP / CDP data sources from the BI launch pad

Refreshing Web Intelligence documents based on PDP
/ CDP data sources from the BI launch pad

You can refresh Web Intelligence documents created from Personal data sources such as text, excel files and from Custom data sources such as Web Services from the BI launch pad.
To manage the refresh option of a Web Intelligence document created using text or excel file, you must edit the RefreshOnServer parameter in the registry with one of the following values:
• NO or DISABLE - to disable refresh option
• YES or ENABLE - to enable refresh on server option and use the data source files from the
Server_Path. If the data source path is not specified in the Server_Path, then the data source is taken from the original source location (location of data source from where the Web Intelligence document is created). By default, the RefreshOnServer parameter is set to ENABLE.
• ALLOW_USE_WINDOWS_SHARE - to enable refresh option from Windows shared location/UNC
Path. As a fallback mechanism, if the source could not be reached then the source is looked up in the Server_Path.
Note:
•

•

Server_Path is a registry parameter which specifies the path of the personal data sources on the server. By default, the Server_Path folder is not created during installation. You must manually create the Server_Path folder. You can also change the Server_Path value in the registry by editing the
Server_Path parameter.
The RefreshOnServer registry parameter is not applicable for custom data sources. For File based custom data sources, plug-in is free to implement the data source look-up / fallback mechanism.

On Windows platforms, you must edit the RefreshOnServer parameter found at the following location in the registry:
• Text: [HKEY_LOCAL_MACHINE]\SOFTWARE\SAP BusinessObjects\Suite XI
4.0\default\Web Intelligence\Calculator\PDP\TXT
• Excel: [HKEY_LOCAL_MACHINE]\SOFTWARE\SAP BusinessObjects\Suite XI
4.0\default\Web Intelligence\Calculator\PDP\XLS
To modify the value of Server_Path parameter, you must edit the Server_Path entry located at:
[HKEY_LOCAL_MACHINE\SOFTWARE\SAP BusinessObjects\Suite XI 4.0\default\Web
Intelligence\Calculator\PDP
By default, the value of Server_Path parameter is \PersonalDPFiles>.
On UNIX platforms, to manage the refresh option of a document created using Text and Excel personal data sources, you must edit the RefreshOnServer parameter with the YES/ENABLE or NO/DISABLE value in the .registry file. The default value of RefreshOnServer parameter is ENABLE. You can find the .registry file in the following locations:

107

2012-06-11

Refreshing Web Intelligence documents based on PDP / CDP data sources from the BI launch pad

•
•

Text: /sap_bobj/data/.bobj/registry/64/software/sap businessobjects/suite xi 4.0/default/webintelligence/calculator/pdp/txt
Excel: /sap_bobj/data/.bobj/registry/64/software/sap businessobjects/suite xi 4.0/default/webintelligence/calculator/pdp/xls

To modify the value of Server_Path parameter, you must edit the .registry file located at: /sap_bobj/data/.bobj/registry/64/software/sap businessob jects/suite xi 4.0/default/webintelligence/calculator/pdp/
By default, the value of Server_Path parameter is home///Per sonalDPFiles. Example: Refreshing Web Intelligence documents based on Excel datasource
Scenario A: User A creates a Web Intelligence document using Web Intelligence Rich Client from an excel datasource located at C:\xyz.xls. The user exports this document to the repository. Now, the user wants to view and refresh the document using BI Launchpad where Web Intelligence Server is installed on a different machine.
To refresh the document, perform the steps:
1. Place xyz.xls in the C:\ directory on the server machine.
2. Place xyz.xls under a pre-defined path on server - the default server path is
\Business Objects\PersonalDPFiles. You can change this path by changing the value of Server_Path in the registry ([HKEY_LOCAL_MACHINE]\SOFTWARE\Business
Objects\Suite 12.0\default\WebIntelligence\Calculator\PDP])
Scenario B: User B creates a Web Intelligence document using Web Intelligence Rich Client from an excel datasource located in the UNC Path: \\MySharedLocation\MYXLSFILEs\xyz.xls
To refresh the document, the user must either place the data source under Server_Path as mentioned in the Scenario A above or set the value of RefreshOnServer parameter to
ALLOW_USE_WINDOWS_SHARE. This value indicates to enable refresh on Windows shared locations.
However, there is a fallback mechanism to the Server_Path location if the UNC Path is not accessible from the Server.
Note:
•
•

108

The above example applies for Text data source also.
The Server Intelligence Agent (SIA) must be managed by a valid user authentication in the network domain. SIA is managed using local system account. Hence, if you are in the Scenario B mentioned above and the service is not able to access the shared location of your excel file, even if you are able to access the file through start > Run > \\MySharedLocation\MYXLSFILEs; in such cases, you can either start the SIA through the credentials which has access to the shared location or put the file in the Server_Path.

2012-06-11

Refreshing Web Intelligence documents based on PDP / CDP data sources from the BI launch pad

7.1 Points to consider before refreshing a document from BI launch pad
Before refreshing a document from BI launch pad, ensure that the following points are taken care:
• If the requirement is not to use UNC (Universal Naming Convention) path even if it is the original location of the data source, then the data source file must be located on the SAP BusinessObjects
Enterprise server at the Server_Path. If the SAP BusinessObjects Enterprise server is clustered, then each and every cluster must be updated with the same copy of the data source file.
• If the requirement is to enable the use of UNC paths, then the Server Intelligence Agent (SIA) should be managed with a user account which has an access to the network domain. In usual installations, the SIA uses the local system account; this is not recommended because the UNC paths may not be accessible with such accounts.
To manage the SIA with a particular account (username/password), perform the following steps:
1. Launch the Central Configuration Manager (CCM).
2. Stop SIA.
3. Right-click SIA, and click on Properties.
4. In the Properties tab, under Log On As, if the System Account option is selected, unselect it, and enter the user and password credentials.
5. Click Apply, and OK.
6. Start SIA.
Note:
This is applicable only for Windows.
•

For refreshing a document based on generic WS, update the net.properties file located at:
\SAP BusinessObjects Enterprise XI
4.0\win64_x64\sapjvm\jre\lib (For UNIX, /sap_bobj/enter prise_xi40/_x64/sapjvm/jre/lib) with the following lines: http.proxyHost= http.proxyPort= http.nonProxyHosts=localhost|127.0.0.1 where,
• proxyHost is the name of the proxy server. For example, proxy.mydomain.com.
• proxyPort is the port number to use. By default value is 80.
• nonProxyHosts is a '|' separated list of hostnames which should be accessed directly, ignoring the proxy server. By default the value is localhost & 127.0.0.1.
•

Provide the following values for HTTPS parameters: https.proxyHost= https.proxyPort=

where,
• proxyHost is the name of the proxy server. For example, proxy.mydomain.com

109

2012-06-11

Refreshing Web Intelligence documents based on PDP / CDP data sources from the BI launch pad

•

110

proxyPort is the port number to use. By default value is 443. The HTTPS protocol handlers uses the http nonProxyHosts list.

2012-06-11

Filtering data using query filters

Filtering data using query filters

8.1 Query filters defined
You limit the data returned to the document by applying filters when you define the query. Using query filters enables you to secure the data that you don’t want specific user groups to see and limits the size of the documents that are stored on your network. When you run the query on the document data, the query returns only the values that meet the query filter definitions.
Query filters limit the data returned to a document. They retrieve a sub-set of the data from the database and return the corresponding values to the document. You define filters to match business questions.
For example, you can filter the Year dimension to view only sales revenue for Year 2003; or filter the
Annual Income dimension to view only customers whose annual income is equal to or greater than
$1.5M.
Query filters allow you to:
•
•
•

retrieve only the data you need to answer a specific business question hide the data you don’t want specific users to see when they access the document minimize the quantity of data returned to the document to optimize performance

Example: In Q4 2002, which stores in my sales region gained margins above $130K?
As Regional Marketing Manager for Texas, you are only interested in analyzing margins for Texas, but the sales universe includes data US-wide. In addition, you only want to view information for stores where margins reached over your 4Q 2002 quarterly target figure: $130K. To create a document with only the information you need, you apply a filter on the State, Year, and Quarter dimensions and a filter on the Margin measure:
Year Equal to 2002
Quarter Equal to Q4
AND
State Equal to Texas
Margin Greater than or equal to 130000

To avoid displaying the filtered values Texas, 2002, and Q4 in the table columns Year, Quarter, and
State, you exclude the Year, Quarter, and State objects from the Result Objects pane. When you generate the report, the report values correspond to Texas stores with 4Q 2002 margins greater than or equal to $130K:

111

2012-06-11

Filtering data using query filters

Store name

Sales Revenue

Margin

e-Fashion Houston

307,914

133,802

e-Fashion Houston Leighton

316,232

136,055

8.2 Query filters and report filters compared
You can apply filters at two levels within a document:
•
•

query filters – these filters are defined on the query; they limit the data retrieved from the data source and returned to the document. report filters – these filters limit the values displayed on reports, tables, charts, sections within the document, but they don’t modify the data that is retrieved from the data source; they simply hide values at the report level.

8.3 Structure of query filters
Query filters have the following structure: filtered object, operator, operand.
In the filter [Country] InList (US;France), the [Country] dimension is the filtered object, InList is the operator, and the list of values (US;France) is the operand. The filter removes all values of
[Country] other than US and France from the query result.

112

2012-06-11

Filtering data using query filters

Table 8-3: Query filter components
Component

Description

The filtered object is the objects whose values are filtered. Dimensions, attributes, measures, hierarchies and levels can be used as filtered objects. Filtered object

With the exception of BEx queries, the filtered object is not required to appear as a result object in the query. For example, a query that contains the [Customer] and [Revenue] objects can filter on the [Region] object. If the filter is [Region]
Equal To "South West", the query returns only those customers in the South West region.

Operator

The operator is used to compare the filtered object with the operand. For example, the Equal To operator retains only those values of the filtered object that correspond exactly to the value of the operand. Operand

The operand supplies the value or values used to filter the filtered object. The next table describes the operand types.

Table 8-4: Operand types
Operand type

Description

The constant operand is used to type values directly. For example, you can use a constant to type "France" into the filter [Country] Equal
To France.
Constant
The operand cannot be a constant if the filtered object is a hierarchy, unless the hierarchy is used in conjunction with the Matches pattern or
Different from pattern operator.

List of Values

113

The List of Values operand is used to select values from the list associated with the filtered object.
For example, if the filtered object is [City], you can use List of Values to select one or more of the cities associated with the object.

2012-06-11

Filtering data using query filters

Operand type

Description

Prompt

A prompt is a dynamic filter that is answered when the query is refreshed.
You can select an object from the universe to filter the filtered object against its values.

Universe object

Result from another query

Note:
You cannot select a universe object as an operand on some OLAP data sources or the filtered object is a hierarchy.

You can compare the filtered object against the values returned by another query.

Related Topics
• BEx queries defined

8.3.1 Query filter and prompt operators

8.3.1.1 List of operators

8.3.1.1.1 Equal To operator
Use the Equal to operator to obtain data equal to a value.
For example, to return data for the US only, create the filter "County Equal To US".

8.3.1.1.2 Not Equal To operator
Use the Not Equal To operator to obtain data not equal to a value.
For example, to return data for all countries except the US create the filter "County Not Equal To US".

114

2012-06-11

Filtering data using query filters

Note:
This operator cannot be used for OLAP unx universe parent-child hierarchies, or for BEx queries.

8.3.1.1.3 Greater Than operator
Use the Greater Than operator to retrieve data greater than a value.
For example, to retrieve data for customers aged over 60, create the filter "[Customer Age] Greater than 60".
Note:
This operator cannot be used for OLAP unx universe parent-child hierarchies, or for BEx queries.

8.3.1.1.4 Greater Than Or Equal To operator
Use the Greater Than Or Equal To operator to retrieve data greater than or equal to a value.
For example, to retrieve data for revenue starting from $1.5M, create the filter "[Revenue] Greater than or equal to 1500000".
Note:
This operator cannot be used for OLAP unx universe parent-child hierarchies, or for BEx hierarchies.

8.3.1.1.5 Less Than operator
Use the Less Than operator to retrieve data lower than a value.
For example, to retrieve data for exam grades lower than 40, create the filter "[Exam Grade] Less Than
40".
Note:
This operator cannot be used for OLAP unx universes, and hierarchies in filters, or for hierarchies in
BEx queries.

8.3.1.1.6 Less Than Or Equal To operator
Use the Less Than Or Equal To operator to retrieve data less than or equal to a value.
For example, to retrieve data for customers whose age is 30 or less, create the filter "[Age] Less Than
Or Equal To 30".
Note:
This operator cannot be used for OLAP unx universes and hierarchies in filters, or for hierarchies in
BEx queries.

115

2012-06-11

Filtering data using query filters

8.3.1.1.7 Between operator
Use the Between operator to retrieve data between two boundary values (including the two boundary values). The first value declared must be lower than the second value.
For example, to retrieve data for weeks starting at week 25 and finishing at 36 (including week 25 and week 36), create the filter "[Week] Between 25 and 36".
Note:
This operator cannot be used for OLAP unx universe and for BEx hierarchies in filters.

8.3.1.1.8 Not Between operator
Use the Not Between operator to retrieve data outside the range of two values.
For example; to retrieve data for all the weeks of the year, except for and not including weeks 25 through
36, create the filter "[Week] Not between 25 and 36".
Note:
This operator cannot be used for OLAP unx universe and for BEx hierarchies in filters.

8.3.1.1.9 In List operator
Use the In List operator to retrieve data corresponding to values in a list of values.
For example, to retrieve data for the US, UK and Japan only, create the filter [Country] In List, when you can type values in the "Type a value" field, you have to enter: US;UK;Japan.
When used in a query filter with a hierarchical list of values (either from a dimension associated with a hierarchical list of values or a hierarchy object), In List allows selection of multiple members from any levels of the hierarchy. For example, a prompt on the [Geography] hierarchy using the In List operator allows selection of [Paris] at the City level and [Canada] at the Country level in the prompt.
When used in a report filter, In List produces a flat list of values.

8.3.1.1.10 Not In List operator
Use the Not In List operator to retrieve data that does not correspond to multiple values.
For example, if you do not want to retrieve data for the US, UK and Japan, create the filter [Country]
Not In, when you can type values in the "Type a value" field, you have to enter: US;UK;Japan.
When used with a hierarchical list of values (either from a dimension associated with a hierarchical list of values, a hierarchy object or a level object), In List allows selection of multiple members from any levels of the hierarchy. For example, a prompt on the [Geography] hierarchy using the Not In List operator allows selection of [Paris] at the City level and [Canada] at the Country level in the prompt.
Note:
This operator can only be used in certain types of hierarchies - for example, it can be used in level-based hierarchies. 116

2012-06-11

Filtering data using query filters

8.3.1.1.11 Matches Pattern operator
Use the Matches Pattern operator to retrieve data that includes a specific string or part of a string.
For example, to retrieve customers whose date of birth is 1972, create the filter [DOB] Matches Pattern
"72".
Note:
This operator cannot be used for BEx hierarchies.

8.3.1.1.12 Different From Pattern operator
Use the Different From Pattern operator to return data that doesn't include a specific string.
For example, to retrieve customers whose date of birth is not 1972, create the filter [DOB] Different
From Pattern '72'.
Note:
This operator cannot be used for BEx or OLAP unx universe parent-based hierarchies.

8.3.1.1.13 Both operator
Use the Both operator to retrieve data that corresponds to two values.
For example, to retrieve customers who have both a fixed and a mobile telephone, create the filter
[Account Type] Both 'Fixed' And 'Mobile'.
Note:
This operator is not supported for filters based on hierarchy objects, or in universes based on OLAP data sources.

8.3.1.1.14 Except operator
Use the Except operator to retrieve data that corresponds to one value and excludes another.
For example, to retrieve customers who have a fixed telephone and do not have a mobile telephone, create the filter [Account Type] 'Fixed' Except 'Mobile'.
The Except operator is more restrictive than Different From or Not In List. For example, a report that returns customers and that includes the filter [Lines] Different From 'Accessories' excludes all sales records where the item sold is part of the 'Accessories' line. If the same customer has purchased Accessories and non-Accessories items, the customer still appears in the report, but their spending total includes only non-Accessories sales.
If the filter is [Lines] Except 'Accessories', only customers who have bought no accessories are included in the report.
Note:
This operator is not supported in universes based on OLAP data sources.

117

2012-06-11

Filtering data using query filters

Related Topics
• Not In List operator
• Different From operator

8.3.1.2 Restrictions on filter operators
The following table lists the restrictions on prompt and filter operators based on the filtered object and query type.
Object

Available filters

Level-based hierarchy

Equal To, Not Equal To, In List, Not In
List, Matches Pattern, Different From
Pattern

Parent-child hierarchy

Equal To, In List, Matches Pattern

Hierarchy in BEx query

Equal To, In List

8.4 Types of query filter
You can create the following types of query filter:
•
•
•
•

predefined filters – created by your administrator custom filters – you define on the query quick filters - a simplified form of custom filter for simple filters prompts – you define these dynamic filters to display a question or a list of values so you or other users can select different filter value(s) at each run query

You can mix different types of filters on a single query.

8.4.1 Predefined query filters
Predefined filters make the specific data you most typically need for reports permanently available.
They are created by an administrator and saved with the universe. Predefined filters often contain

118

2012-06-11

Filtering data using query filters

complex expressions that require a detailed knowledge of the database structure. Including predefined filters on the universe means you don’t need to create the same custom filters every time you create a new document based on the same universe.
You cannot view the component parts of predefined filters or edit predefined filters.

8.4.1.1 To select a predefined query filter
•

Double-click the predefined filter or drag it to the Query Filters pane.

When you run the query, the data corresponding to the query filters you selected is returned to the report. 8.4.2 Quick filters
Quick filters allow you to quickly define the values you want to retrieve for a specific result object without launching the Filter Editor. By default, Quick filters use the Equal to operator if you select a single value or the In List operator if you select multiple values.
For example:
•
•

If you select the [Payment Status] dimension and the value “unpaid? you create the filter: [Payment
Status] Equal to “unpaid?
If you select the [Country] dimension and the values US, Japan, Germany, you create the filter:
[Country] In list “US;Japan;Germany?

Note:
Quick filters are not available in Bex queries.
Related Topics
• BEx queries defined

8.4.2.1 To create or remove a quick filter
1. Select the object you want to filter.
2. Click Add Quick Filter at the top right corner of the Result Objects pane.
The List of Values dialog box appears. The values for the selected object are listed.
3. Select the values you want to retrieve from the database.

119

2012-06-11

Filtering data using query filters

For example, to filter the query for values in Q1, select the [Quarter] dimension, then select Q1 from the list of values.
4. Click OK
The new filter appears on the Query Filters pane.
5. To remove the filter, select it in the Query Filters pane and press the Delete key.

8.4.3 Custom query filters
You create custom query filters to limit document data to information corresponding to:
•
•

a specific business question the business information needs of a specific group of users

For example, you can create custom filters to retrieve sales results data for specific dates, products, or services, or to view customer information only for customers who are high wage earners or who live in a particular region.

8.4.3.1 To add and remove custom query filters
1. Select the object you want to filter and drag it to the Query Filters pane.
The query filter appears in outline in the Query Filters pane.
2. Click the arrow next to the default operator (In List) and select the query operator from the list of operators. 3. Click the arrow on the right of the query filter and select the type of filter you want to apply: Constant,
Value(s) from List, Prompt, Object from this query, Result from another query, Result from another query (Any), Result from another query (All).

120

2012-06-11

Filtering data using query filters

Option

Description

Constant

You compare the object against a constant value to filter the query result.

Value(s) from list

You compare the object against values from a list of values to filter the query result.
•
•
•

If the filtered object is a dimension, attribute or measure, you can select any of the values of the object.
If the filtered object is a hierarchy, you can select any members of the hierarchy. If the filtered object is a level, you can select any member from the level.

Prompt

You create a filter which requires the user to supply filter values on data refresh. Object from this query You compare the object against the values returned by an object from in the same query.

Result from another
You compare the object against the values returned by an object from anquery other query (the filtering query) to filter the query result.

4. Type/select the constant, list of values or object you want to include in the filter.
5. To remove the filter, select it and click the Delete key, or click Remove at the top right corner of the
Query Filters pane. To remove all filters, click Remove All at the top right corner of the Query
Filters pane.

8.4.3.2 To select values from a list
In a query, values in a list of values can appear either as a single-column list, a multicolumn list, or a hierarchy, depending on the object. In a multicolumn list, additional columns provide related values to the main value. In a hierarchical list, values appear in a hierarchical relationship.
In a report, values appear in a flat list without multiple columns.
1. If the list of values does not display when the dialog box opens, refresh the list, or search the list to retrieve values. (See later in this topic for details of searching lists of values.)
Some list of values require an initial search to display values because the list is too large to be loaded in full.
2. If the list of values is divided into ranges, use the control above the list to navigate through the ranges. Some large lists of values are divided into ranges to reduce the amount of data retrieved from the database. When you select a range, the list displays the values in that range.

121

2012-06-11

Filtering data using query filters

3. If the list of values depends on other lists of values, specify the dependent values first in the prompt dialog box that displays.
A list of values can be dependent on other lists of values, for example when it is part of a hierarchical list of values. For example, if the list of values contains cities, and the City object is part of the hierarchy Country > Region > City, you need to specify values for country and region first to filter the list of cities.
Note:
Dependent lists of values appear in queries only. They do not appear when you are selecting from a list of values in a report.
When you first display the list of values, you see the Prompt dialog box that you use to specify the dependent values. Once you have specified the dependent values, you can select the values from the filtered list.
4. To display the value keys, click Show/hide key values.
Key values are not indicated in the list of "Selected Values", only in the list of available values. Some lists of values contain key values, which are unique values that can be used to identify values with the same display value. If the list of values contains multiple columns, only the key of the filtering column is displayed.
5. To search for values in the list, type the search text in the box below the list and select the Match case, Search in keys or Search on database option.

122

2012-06-11

Filtering data using query filters

Option

Match case

Description

The search is case-sensitive.
This option is not available when the Search in keys or Search on database options are selected.

Search in keys

The search uses unique value keys rather than display values.
This option is available only on lists of values that support key values.

Search on database The search inclues all values stored in the database rather than being restricted to the values loaded into the list. It improves search accuracy but reduces search speed.
This option is available only on lists of values that support database searches.
Database searching improves search accuracy at the cost of performance. It is useful when not all values in the list of values were retrieved. This can happen when the total number of values in the list exceeds the Max rows retrieved query property.
Database searching is particularly useful when the list of values is hierarchical because values are loaded from the database only in response to their parent value being expanded in the hierarchy. For example, in a geographical hierarchy, the child values of the California value (cities in California) are not loaded from the database until the value is expanded. If the option is selected, the search includes these items even when the California value has not been expanded.

The search includes all ranges if the list of values is divided into ranges.
In search patterns, the '*' wildcard represents any string of characters and the '?' wildcard represents any single character. For example, the value "March" can be returned by the search patterns "M*" or "Mar?h". To include the "*" and "?" characters literally rather than as wildcards, precede them with "\" in the search pattern.
6. Type values from the list directly (if the list supports direct data entry) or select values from the list.
Related Topics
• Max rows retrieved query property

8.4.3.3 Filtering a query on values returned from another query

123

2012-06-11

Filtering data using query filters

You can filter a query on values returned from another query. For example, if you want to return results for all the countries in Query 1 that have a corresponding country in Query 2, you can filter the [Query
1].[Country] object on the values of the [Query 2].[Country] object.
The filtered query must be in a universe based on a relational (RDBMS) data source. The query that supplies the filtering values (filtering query) can be based on a relational, OLAP or local data source.
When you are building a query on a query, the filtering query does not appear in the list of queries that can be used as filtering queries until it has been run or saved.
The filtering query is not refreshed when you refresh the filtered query.
The query filter can filter against all or any of the values returned by the filtering query. The supported combinations of operator and filter mode appear in the table below. If you do not choose an operator from the table, the Result from another query menu item is not available.
Operator

Filter mode

Description

Equal To

Any

Keep values in the filtered query that are equal to any value returned by the filtering query.

Not Equal To

All

Keep values in the filtered query that are different from all the values returned by the filtering query.

Greater Than

Any

Greater Than or Equal To

Keep values in the filtered query that are greater than/greater than or equal to any of the values in the filtering query.
In other words, keep values in the filtered query that are greater than/greater than or equal to the minimum value returned by the filtering query.

Greater Than

All

Greater Than or Equal To

Keep values in the filtered query that are greater than all of the values in the filtering query.
In other words, keep values in the filtered query that are greater than/greater than or equal to the maximum value returned by the filtering query.

Less Than
Less Than or Equal To

Any

Keep values in the filtered query that are less than/less than or equal to any of the values in the filtering query.
In other words, keep values in the filtered query that are less than/less than or equal to the maximum value returned by the filtering query.

124

2012-06-11

Filtering data using query filters

Operator

Less Than

Filter mode

All

Less Than or Equal To

Description

Keep values in the filtered query that are less than/less than or equal to any of the values in the filtering query.
In other words, keep values in the filtered query that are less than/less than or equal to the minimum value returned by the filtering query.

InList

Any

Keep values in the filtered query that are equal to any value in the list of values returned by the filtering query.

Not InList

Any

Keep values in the filtered query that are not equal to any of the values in the list of values returned by the filtering query. 8.4.4 Combining query filters

8.4.4.1 Combining query filters
Typical business questions require you to retrieve information that matches more than one criteria. For example, if you are analyzing customer services data, you will most likely want to focus on customers for a specific time period and also for a specific region, and probably also for a specific level of customer service contract. You can retrieve data that answers several criteria like this by combining filters in the same query.
Example: Analyze sales revenue this year at stores where the floor size is over 4,000 square feet and sales revenue figures are equal to or less than $1.5M
In this example, you are an operations manager for a retail chain. You want to analyze information about the large retail stores in your chain that are making less than the sales revenue figure your company has set as the target.
To do this you add a predefined filter on the [Year] dimension to specify that you only want to retrieve values for this year. Then you create a second filter on the [Sales Floor Size] dimension to specify that you only want to retrieve data for stores where the floor size is greater than 4,000 square feet.
After this, you create a third filter on the [Sales Revenue] measure to specify that you only want to retrieve data for stores where the sales revenue figures are equal to or less than $1.5M. Finally, you combine these three filters with the And operator:

125

2012-06-11

Filtering data using query filters

Last Year
AND

Sales Floor Size Group Greater than or equal to: 4000
Sales Revenue Less than 1,500,000

When you run the query, only data for stores that satisfy all three criteria will be returned to the report.
Related Topics
• To combine query filters
• Nesting query filters

8.4.4.2 To combine query filters
1. Create the filters and add them to the Query Filters pane.
Filters are combined by default with the And operator.
2. Click the operator or click the arrow next to the operator checkbox and select the other operator to toggle between AND and OR.
Note:
The OR operator is not supported from some OLAP data sources such as BEx queries, and OLAP unx universes on the top of Microsoft Analysis Services (MSAS) and Oracle Essbase.
Related Topics
• Combining query filters

8.4.4.3 Nesting query filters
Nesting query filters allows you to create more complex filter conditions than is possible when you combine filters at the same level.
When you nest filters, you set the order in which they are evaluated. For example, you can return the data given by two query filters joined in an OR relationship (where either one filter condition or the other is true) and then further restrict this data by applying another filter to it. In this case, the two filters in an
OR relationship are nested, then compared with the other filter in an AND relationship.
The following example illustrates this:

126

2012-06-11

Filtering data using query filters

Example: List all sales made in Japan either in Q4 or where the revenue was greater than
1000000
To answer this question you create the following nested query filter:
Country Equal To Japan
Quarter Equal To Q4

AND
OR

Revenue Greater Than
1000000

This combination of query filters first returns sales data where the sale was made in Q4 or the revenue was greater than 1000000, then restricts this data further by returning only those sales made in Japan.
Related Topics
• To nest query filters
• Combining query filters

8.4.4.4 To nest query filters
1. Drag and drop a report object onto an existing query filter.
A query filter outline on the report object appears in a nested AND relationship with the existing query filter.
2. Define the new query filter.
Related Topics
• Nesting query filters
• Combining query filters

8.5 Filtering hierarchical queries

127

2012-06-11

Filtering data using query filters

8.5.1 How levels filter hierarchical queries
A level used as a query filter removes the specified members from the level and all their child members from the hierarchy. The filter also impacts measure aggregation.
Example: Filtering on a level
You have the following data, on which the level filter [Country] Not Equal To Germany is applied. (You apply the filter by dragging the [Country] level to the Query Filters pane in the Query
Panel, selecting the Not Equal To operator and selecting "Germany" from the list of values of the level). Customer Geography

Internet Sales Amount

All Customers

$29,358,677.22
France

$2,644,017.71
Hauts de Seine

$263,416.19

Seine (Paris)

$539,725.80

Germany

$2.894,312.34
Brandenburg

$119,871.08

Hessen

$794,876.08

After filtering, the data appears as follows:
Customer Geography

Internet Sales Amount

All Customers

$26,464,364.88
France

$2,644,017.71
Hauts de Seine

$263,416.19

Seine (Paris)

$539,725.80

When the filter is applied, Germany and all descendant members are filtered from the hierarchy. The value of [Internet Sales Amount] for All Customers is also reduced because the value for Germany is no longer part of the aggregation.

128

2012-06-11

Filtering data using query filters

8.5.2 How measures filter hierarchical queries
A filter on a measure applies to all levels in a hierarchy and does not impact measure aggregation in the filtered result.
Example: Filtering on a measure
You have the following data, to which you apply the filter [Internet Sales Amount] Greater
Than 500,000.
Customer Geography

Internet Sales Amount

All Customers

$29,358,677.22
France

$2,644,017.71
Hauts de Seine

$263,416.19

Seine (Paris)

$539,725.80

Germany

$2.894,312.34
Brandenburg

$119,871.08

Hessen

$794,876.08

The filtered data appears as follows:
Customer Geography

Internet Sales Amount

All Customers

$29,358,677.22
France

$2,644,017.71
Seine (Paris)

Germany

$539,725.80
$2.894,312.34

Hessen

$794,876.08

The filter is applied to all members, irrespective of their level in the hierarchy, and the aggregated measures are not impacted by the removal of the filtered members. (For example, the All Customers amount remains at $29,358,677.22).

129

2012-06-11

Filtering data using query filters

130

2012-06-11

Filtering data using prompts

Filtering data using prompts

9.1 Prompts defined
A prompt is a special type of query filter. It is a dynamic filter that displays a question every time you refresh the data in a document. You answer prompts by either typing or selecting the values you want to view before you refresh the data. The query then retrieves only the values you specified from the database and returns those values to the reports within the document.
Prompts allow multiple users viewing a single document to specify a different sub-set of the database information and display it in the same report tables and charts. Prompts also reduce the time it takes for the data to be retrieved from the database.
A prompt contains the following elements:
•
•
•

a filtered object an operator a message

For example, to prompt users to select a specific year, you define a prompt on the [Year] dimension:
Year Equal To ("Which year?)

In this prompt, the filtered object is [Year], the operator is Equal To, and the prompt message is "Which year?". You can define prompts on dimensions, measures, attributes, hierarchies and levels. For example, you can filter the [Year] dimension to return values for a specific year, filter the [Sales Revenue] measure to return values for a range of revenue figures, or filter the [Geography] hierarchy to return members from the hierarchy.
Note:
•
•

In Web Intelligence Rich Client, or the Rich Internet Application interface, for OLAP unx universes, when filtering on measures, you can only type a constant.
In Web Intelligence Rich Client, or the Rich Internet Application interface, you cannot add measures or detail objects in the filter panel for BEx queries

You can create multiple prompts, related by the AND or OR operators, in the same query. You can also nest prompts. When the user runs a query, the prompts are displayed.
Note:
On BEx queries and OLAP unx universes, you can only use the AND operator.

131

2012-06-11

Filtering data using prompts

Prompts appear in the script generated by the query as either the value supplied in response to the prompt or as special prompt syntax. For example, a prompt on [Country] can appear in generated SQL as Resort_Country.country = @prompt('Enter Country:','A',
'Resort\Country', Mono,Free,Persistent,,User:0)

or as
Resort_country.country In ('UK')

Prompts can be optional. You are not obliged to supply values for optional prompts. If you do not supply a value, the prompt is ignored.
You can create your own prompts or select from prompts already defined in the universe.

9.1.1 Merged prompts
When a document contains multiple data providers, any prompts that include objects with the same data type, operators of the same operator type, and that use the same prompt text are merged.
When all the data providers are refreshed, a single prompt message appears for such prompts.
The List of Values displayed by the merged prompt is the list associated with the object in the prompt that has the most display property constraints.

9.1.2 Merging and unmerging prompts coming from BEx variables
BEx variables are converted to prompts in Web Intelligence. When you have two or more BEx queries in a multiple data source query, when there are two or more BEx variables that are the same, they can be merged and the user will only be prompted once for the information. Only BEx variables that have the same technical name are merged. You select to merge the prompts in the "Document Summary" pane. When you unselect this option, any merged prompts are unmerged. The user will receive a prompt for each BEx variable.

9.1.3 Hierarchical prompts
The following objects display their lists of values hierarchically in a prompt:
• Hierarchies
• Levels
• Dimensions associated with a hierarchical list of values

132

2012-06-11

Filtering data using prompts

A hierarchical list of values appears in tree form. You can navigate up and down the tree to the items you want. Depending on the filter operator in the prompt, you can select items from different levels of the list of values, or at the lowest level only.

9.2 Query filter and prompt operators

9.2.1 List of operators

9.2.1.1 Equal To operator
Use the Equal to operator to obtain data equal to a value.
For example, to return data for the US only, create the filter "County Equal To US".

9.2.1.2 Not Equal To operator
Use the Not Equal To operator to obtain data not equal to a value.
For example, to return data for all countries except the US create the filter "County Not Equal To US".
Note:
This operator cannot be used for OLAP unx universe parent-child hierarchies, or for BEx queries.

9.2.1.3 Greater Than operator
Use the Greater Than operator to retrieve data greater than a value.
For example, to retrieve data for customers aged over 60, create the filter "[Customer Age] Greater than 60".

133

2012-06-11

Filtering data using prompts

Note:
This operator cannot be used for OLAP unx universe parent-child hierarchies, or for BEx queries.

9.2.1.4 Greater Than Or Equal To operator
Use the Greater Than Or Equal To operator to retrieve data greater than or equal to a value.
For example, to retrieve data for revenue starting from $1.5M, create the filter "[Revenue] Greater than or equal to 1500000".
Note:
This operator cannot be used for OLAP unx universe parent-child hierarchies, or for BEx hierarchies.

9.2.1.5 Less Than operator
Use the Less Than operator to retrieve data lower than a value.
For example, to retrieve data for exam grades lower than 40, create the filter "[Exam Grade] Less Than
40".
Note:
This operator cannot be used for OLAP unx universes, and hierarchies in filters, or for hierarchies in
BEx queries.

9.2.1.6 Less Than Or Equal To operator
Use the Less Than Or Equal To operator to retrieve data less than or equal to a value.
For example, to retrieve data for customers whose age is 30 or less, create the filter "[Age] Less Than
Or Equal To 30".
Note:
This operator cannot be used for OLAP unx universes and hierarchies in filters, or for hierarchies in
BEx queries.

134

2012-06-11

Filtering data using prompts

9.2.1.7 Between operator
Use the Between operator to retrieve data between two boundary values (including the two boundary values). The first value declared must be lower than the second value.
For example, to retrieve data for weeks starting at week 25 and finishing at 36 (including week 25 and week 36), create the filter "[Week] Between 25 and 36".
Note:
This operator cannot be used for OLAP unx universe and for BEx hierarchies in filters.

9.2.1.8 Not Between operator
Use the Not Between operator to retrieve data outside the range of two values.
For example; to retrieve data for all the weeks of the year, except for and not including weeks 25 through
36, create the filter "[Week] Not between 25 and 36".
Note:
This operator cannot be used for OLAP unx universe and for BEx hierarchies in filters.

9.2.1.9 In List operator
Use the In List operator to retrieve data corresponding to values in a list of values.
For example, to retrieve data for the US, UK and Japan only, create the filter [Country] In List, when you can type values in the "Type a value" field, you have to enter: US;UK;Japan.
When used in a query filter with a hierarchical list of values (either from a dimension associated with a hierarchical list of values or a hierarchy object), In List allows selection of multiple members from any levels of the hierarchy. For example, a prompt on the [Geography] hierarchy using the In List operator allows selection of [Paris] at the City level and [Canada] at the Country level in the prompt.
When used in a report filter, In List produces a flat list of values.

135

2012-06-11

Filtering data using prompts

9.2.1.10 Not In List operator
Use the Not In List operator to retrieve data that does not correspond to multiple values.
For example, if you do not want to retrieve data for the US, UK and Japan, create the filter [Country]
Not In, when you can type values in the "Type a value" field, you have to enter: US;UK;Japan.
When used with a hierarchical list of values (either from a dimension associated with a hierarchical list of values, a hierarchy object or a level object), In List allows selection of multiple members from any levels of the hierarchy. For example, a prompt on the [Geography] hierarchy using the Not In List operator allows selection of [Paris] at the City level and [Canada] at the Country level in the prompt.
Note:
This operator can only be used in certain types of hierarchies - for example, it can be used in level-based hierarchies. 9.2.1.11 Matches Pattern operator
Use the Matches Pattern operator to retrieve data that includes a specific string or part of a string.
For example, to retrieve customers whose date of birth is 1972, create the filter [DOB] Matches Pattern
"72".
Note:
This operator cannot be used for BEx hierarchies.

9.2.1.12 Different From Pattern operator
Use the Different From Pattern operator to return data that doesn't include a specific string.
For example, to retrieve customers whose date of birth is not 1972, create the filter [DOB] Different
From Pattern '72'.
Note:
This operator cannot be used for BEx or OLAP unx universe parent-based hierarchies.

136

2012-06-11

Filtering data using prompts

9.2.1.13 Both operator
Use the Both operator to retrieve data that corresponds to two values.
For example, to retrieve customers who have both a fixed and a mobile telephone, create the filter
[Account Type] Both 'Fixed' And 'Mobile'.
Note:
This operator is not supported for filters based on hierarchy objects, or in universes based on OLAP data sources.

9.2.1.14 Except operator
Use the Except operator to retrieve data that corresponds to one value and excludes another.
For example, to retrieve customers who have a fixed telephone and do not have a mobile telephone, create the filter [Account Type] 'Fixed' Except 'Mobile'.
The Except operator is more restrictive than Different From or Not In List. For example, a report that returns customers and that includes the filter [Lines] Different From 'Accessories' excludes all sales records where the item sold is part of the 'Accessories' line. If the same customer has purchased Accessories and non-Accessories items, the customer still appears in the report, but their spending total includes only non-Accessories sales.
If the filter is [Lines] Except 'Accessories', only customers who have bought no accessories are included in the report.
Note:
This operator is not supported in universes based on OLAP data sources.
Related Topics
• Not In List operator
• Different From operator

9.2.2 Restrictions on filter operators

137

2012-06-11

Filtering data using prompts

The following table lists the restrictions on prompt and filter operators based on the filtered object and query type.
Object

Available filters

Level-based hierarchy

Equal To, Not Equal To, In List, Not In
List, Matches Pattern, Different From
Pattern

Parent-child hierarchy

Equal To, In List, Matches Pattern

Hierarchy in BEx query

Equal To, In List

9.3 To build a new prompt
1. Drag the object you want to filter with a prompt and drop it onto the Query Filters pane.
The query filter appears in outline in the Query Filters pane. The outline shows the filtered object, the operator and the type of filter applied to the object. (By default the filter is a constant.)
2. Select the filter operator from the list.
Note:
The list of available operators depends on the type of filtered object.
3. Click the arrow at the right of the outline query filter and select Prompt from the menu to filter the object using a prompt.
Note:
If the document contains multiple data providers, and there is already a prompt that includes objects with the same data type, operators of the same operator type, and that uses the same prompt text as the new prompt, a warning displays telling you that the two prompts will be merged. This means that whenever all the data providers are refreshed, a single prompt message will appear for the two prompts. The Prompt dialog box appears.
4. If the Prompt with list of Values prompt properties is unchecked, type the prompt text (for example
"Enter a City") in the Prompt text box.
5. Click Prompt with list of values to allow the user to select from a list of values when answering the prompt.
• The option is selected by default if the filtered object has an associated list of values in the universe. • The option is selected by default and cannot be deselected if the filtered object is a hierarchy.
• Do not select this option if the filtered object is a date and you want users to see a popup calendar to select the date.

138

2012-06-11

Filtering data using prompts

6. In the dialog box Parameter properties, click Select only from list to restrict the user choice to values selectable from the list.
• The option is selected by default if the filtered object has an associated list of values in the universe, and cannot be deselected if the filtered object is a hierarchy.
• Do not select this option if the filtered object is a date and you want users to see a popup calendar to select the date.
7. In the dialog box Parameter properties, select Keep last values selected to ensure that, by default, the prompt selects the values the user selected the last time they answered the prompt.
The option is selected by default if the filtered object has an associated list of values in the universe, and cannot be deselected if the filtered object is a hierarchy.
8. In the dialog box Parameter properties, click Set default values if you want the prompt to select values by default when it displays, and type a value in the Type a value box, or click ... and select default values in the List of Values dialog box.
Note:
This button is disabled if the filtered object has no associated list of values.
9. In the dialog box Parameter properties, select Optional prompt to make the prompt optional. If the user does not supply a value for an optional prompt, the prompt is ignored.
10. Click the icon next to the text box and use the dialog box that appears to set the prompt properties.
The prompt appears at each document refresh.
Related Topics
• Defining how prompts display
• Merged prompts

9.4 To select an existing prompt
You can select from pre-existing prompts to add to a query. Only pre-existing prompts that are compatible with the object you are filtering are displayed,
1. Drag the object on which you want to apply a prompt and drop it onto the Query Filters pane.
The query filter appears in outline in the Query Filters pane.
2. Click the arrow at the right of the Query Filter and select Prompt from the menu.
3. Click Select from universe, select an existing prompt and click OK.
The list displays only those universe prompts that are compatible with the object you are filtering.
For example, the filtered object and the universe prompt must have the same data type.

139

2012-06-11

Filtering data using prompts

9.5 To remove a prompt
•

Select the prompt in the Query Filters pane and click the Delete key.

9.6 Defining how prompts display
By default, prompts display a box and a list of values. You answer the prompt by either typing the value(s) in the box or by selecting value(s) from the list.
You can modify how prompts display by checking one, some, or all of the following options (these options are available in the dialog box Parameter properties):
If you want the prompt to display...

(useful when you...)

then...

the list of values associated with the filtered dimension, measure, or detail,

want to view all the values for the object and then select from those values

leave the option selected by default: Prompt with List of Values

the value(s) specified the last time the prompt was answered
(users can select a different value(s)), often reselect the same value(s) when you refresh the document, but want the ability to select a different value when necessary, such as the name of the current month select the option: Keep last values selected

the value(s) you specify as the default (users can select a different value(s)),

almost always reselect the same value(s) when you refresh the document, but want the ability to select a different value when necessary, such as the number for the current year

select the option: Set default value(s) a list of values from which users select a value(s),

prevent users from typing a value that might not exist on the database select the option: Select only from List

To make the prompt optional, select Optional prompt. You are not obliged to specify a value for the prompt, in which case it is ignored.
Note:
If the prompt is for a date, the users will see the popup calendar and a list of values. If you want users to see the popup calendar in order to select the date(s) then unselect Prompt with List of Values

140

2012-06-11

Filtering data using prompts

9.7 Combining prompts
Combining multiple prompts on a single query enables you to filter the data returned to the document so that each person viewing the reports sees only the information relevant to their business need. For example, you can combine the following three prompts on a Customer Accounts document:
•
•
•

Which customer?
Which account?
Which calendar period: from? to?

This enables each accounts manager viewing the document to view report values for a specific customer account during a specific period.
You combine prompts in the same way that you combine query filters.

9.7.1 Combining prompts with query filters
Combining prompts and filters on a single query enables you decide the values for some of the selected objects on the query using filters and allow users to decide the values of other selected objects using prompts. For example, if you combine the following filters and prompts on a HR document:
•
•
•

[Year] Equal to This Year
[Job title] Not equal to Senior Executive
Which employee?

Users viewing the document can choose which employee they view information for, but they can only view data for the current year and they can’t view data for senior executives.

9.8 To change the order of prompts
The query panel is open.
1. Click Query properties on the query panel toolbar.
2. Select the prompt you want to move up or down in the prompt order in the Prompt Order box, then press the Up or Down arrow next to the box.

141

2012-06-11

Filtering data using prompts

142

2012-06-11

Using combined queries

Using combined queries

10.1 Combined queries defined
A combined query is a group of queries that work together to return a single result. You can combine queries in three relationships:
•
•
•

union intersect minus

A UNION query takes all the data from both queries, eliminates duplicate rows, and builds a combined data set.
An INTERSECT query returns the data that is common to both queries.
A MINUS query returns the data in the first query that does not appear in the second.
Note:
You cannot combine BEx queries or OLAP queries.
Example: Union, intersect and minus queries
In this example you have two queries that return lists of countries as shown in the following table:
Query

Values

Query 1

US; UK; Germany; France

Query 2

US; Spain

The different types of combined query return the following values:
Combination type

UNION

US; UK; Germany; France;Spain

INTERSECT

US;

MINUS

143

Values

UK; Germany; France

2012-06-11

Using combined queries

Related Topics
• BEx queries defined

10.2 Uses of combined queries
Combined queries allow you to answer questions that are otherwise difficult or impossible to frame in standard query.
Example: Return a data set using a combined query
The Island Resorts Marketing sample universe contains the dimension Year, which returns guests who have already stayed in a resort, and Reservation Year, which returns guests who have reserved to stay in the future. Because of the structure of the database and universe, these objects are incompatible, which means that you cannot include them in the same block in a report.
What if you want to return a single list of years that includes those years where more than n guests stayed in a resort and those years where more than n guests reserved to stay in a resort? You can do this using a combined query, as follows:
Query

Returns

Query 1

Years where more than n guests stayed in a resort

UNION
Query 2

Years where more than n guests reserved to stay in a resort

The union between these two queries returns the list of years that you want.

10.3 How combined queries are generated
If your database supports the type of combination in your query, combined queries work at the database level: they alter the query submitted to the database. They do so by generating query script containing
UNION, INTERSECT and MINUS operators.
If your database does not support the type of combination in your query, the combination occurs after data retrieval. Multiple queries return data to the report and this data is then resolved into the same result generated by a database-level combined query.

144

2012-06-11

Using combined queries

10.4 To build a combined query
1. Create an initial query in the query panel.
2. Click the Add a Combined Query icon on the toolbar to display the Combined Queries panel beneath the list of query objects.
The Combined Queries panel shows the current query. You can change the query name by clicking the query in the panel, selecting Edit Name from the menu, then typing a new name in the Name box in the dialog box that appears.
3. Click Add a query to add another query. The second query appears in the Combined Queries pane and is:
• Combined with the original query in a UNION relationship.
• Named Combined Query #n.
4. To switch to a query, click it in the Combined Queries pane.
5. To delete a query select it in the Combined Queries pane and press the Delete key, or drag and drop the query to the universe outline.
6. To change the combination type, click on the operator. The operator moves through the sequence
UNION, MINUS, INTERSECT.
7. Build each query within the combined query as you build any normal query.
8. Click Run Query.

10.5 Combined query structure
The queries within a combined query must return the same number of objects of the same data type and the objects must be in the same order. You cannot combine queries when the number of objects in the query results and the data types of those objects are not identical. For example, you cannot combine a query than returns Year with a query that returns Year and Revenue, and you cannot combine a query that returns Year with a query that returns Revenue.
You must also pay attention to the semantics of your combined queries. While it is possible to combine a query that returns Year with a query that returns Region if both dimensions are of the same data type, the result - a mixed list of years and regions - is unlikely to be meaningful. Typically, if your first query contains a Year dimension, your second query also contains a dimension that returns a list of years.

10.5.1 To return a list of years and reservation years based on the number of guests

145

2012-06-11

Using combined queries

You want to build a query that returns a list of years consisting of years where more than n guests stayed in a resort and years where more than n guests reserved to stay in a resort. The object you are filtering on must also be in the "Result Objects" pane.
1. Select the Island Resorts Marketing universe in the list of universes to open the Query Panel.
2. Drag the Year, Number of Guests, and Future Guests objects to the Result Objects pane.
3. Drag the Number of Guests object to the Query Filters pane and create a report filter that restricts
Number of Guests to greater than n.
4. Click Add a Combined Query.
The Combined Query pane appears in the bottom left of the Query panel with the two queries joined by UNION.
5. Click on the second query and remove the Year and Number of Guests objects.
6. Drag the Reservation Year object to the Result Objects pane.
7. Drag the Future Guests object to the Query Filters pane and create a report filter that restricts the future guests to greater than n.
8. Click Run Query.
The query returns the combined list of years and reservation years.

10.6 Combined query precedence
The order of execution in a combined query is crucial in determining the final result.
In the simplest form of combined query you combine two or more queries in a relationship as follows:
Query 1
INTERSECTION

Query 2
Query 3

In such a case, the first result to be calculated is the intersection between Combined Query n and
Combined Query n + 1. The next result is the intersection between the first result and the result of
Combined Query n + 2. Query execution continues in this way through all the queries in the relationship.
This gives the following result for the above example:
Query

Query 1

US; UK; France; Germany

Query 2

US; France; Finland

INTERSECTION of 1 and 2

146

Data

US; France

2012-06-11

Using combined queries

Query

Data

Query 3

US; Spain

Final INTERSECTION

US

10.6.1 Nesting combined queries
By default, each time you add a combined query, it is combined at the initial combination level with existing queries. Each added query extends the list of combined queries. If you add Query 3 to Query
1 and Query 2, which are already combined in a UNION relationship, you get the following result:
Query 1
UNION

Query 2
Query 3

You can also nest combined queries in complex, multi-level relationships to control the order of execution, as in the following example, which combines the result of Query 1 MINUS Query 2 in an INTERSECT relationship with Query 3.
Combined Query 1
MINUS
INTERSECT

Combined Query 2
Query 3

Query groups are processed from right to left and from top to bottom within each group.
(Higher-precedence groups, such as the MINUS group in the above example, appear indented to the right.) In the above example the first query to be calculated is the MINUS query. The result of the MINUS query is then combined in an INTERSECT query with Query 3.
Query

Query 1

US; UK; Spain; Germany

Query 2

Germany

Query 1 MINUS Query 2

147

Result

US; UK; Spain

2012-06-11

Using combined queries

Query

Result

Query 3

US; Spain; Finland

(Query 1 MINUS Query 2)
INTERSECT

US; Spain

Query 3

Note:
If your database directly supports the type of combined query you wish to execute, the script generated from the query contains the combination operators directly. In this case the order of precedence depends on the order of precedence defined in the database. See your database administrator for more details.

10.6.2 To set the order of precedence of combined queries
1. Build the queries you want to organize in the Combined Queries panel.
2. To nest a pair of queries, click on the "add new combined query node" button in order to create a new combined query node, then drag and drop a query on to the query with which you want to associate the nested pair.
The new combined query node is by default a UNION relationship.
3. Continue adding queries to the nested group by dragging and dropping them on to the space between any two queries already in the group.
4. To create further nested groups within an existing higher-precedence group, repeat the previous two steps.
5. Click the combination operators of all the groups in the query to change them as required.
Related Topics
• To build a combined query

148

2012-06-11

Filtering data using subqueries

Filtering data using subqueries

11.1 Subqueries defined
A subquery is a more flexible kind of query filter that allows you to restrict values in more sophisticated ways than is possible with a ordinary query filters.
Subqueries are more powerful than ordinary query filters for the following reasons:
•
•
•

They allow you to compare the values of the object whose values are used to restrict the query with values from other objects.
They allow you to restrict the values returned by the subquery with a WHERE clause.
They allow you to pose complex questions that are difficult or impossible to formulate with simple query filters. For example: what is the list of customers and their associated revenue where the customer purchased a service that had previously been reserved (by any customer) in Q1 of 2003?

Subqueries work by modifying the SQL that is generated to retrieve the query data. The SQL contains a subquery that restricts the data returned by an outer query. SQL is the query language supported by all relational databases (RDBMS), although each database has its own syntax. For more information on SQL subqueries, see any book on SQL.
Note:
•
•

Subqueries are not supported in all databases. If they are not supported, the option to build subqueries does not appear in the query panel.
You can build subqueries using dimensions, attributes and measures only. You cannot build subqueries using hierarchical objects.

Related Topics
• To build a subquery
• Subquery parameters

11.2 To build a subquery
1. Add the objects that you want to appear in the query to the Result Objects pane.

149

2012-06-11

Filtering data using subqueries

2. Select the object in the Result Objects pane that you want to filter with a subquery and click Add a subquery at the top right of the Query Filters pane.
The subquery outline appears in the Query Filters pane. By default the object you selected appears as the Filter object and Filter By object.
3. To add a WHERE condition to the subquery, drag a report object to the area of the subquery below the Drop an object here boxes.
4. To add a WHERE condition to the subquery, drag a report object to the area of the subquery below the Drop an object here boxes.
You can use an existing subquery or standard query filter as a WHERE condition in a subquery. To do so, drag and drop the existing filter or subquery to the area of the subquery below the Drop an object here boxes. To copy rather than move the existing filter to the WHERE condition, hold down the Control key while dragging and dropping. In this case the existing filter remains in its initial place and becomes part of the WHERE condition of the subquery.
5. Select the operator and values used to filter the object in the WHERE condition.
6. Click Subquery to add an additional subquery to the query filter.
In addition to linking subqueries in AND or OR relationships, you can nest them (create subqueries within subqueries) by dragging an existing subquery to the area beneath the Drop an object here boxes. In this case the inner subquery becomes part of the WHERE condition of the outer subquery.
To copy rather than move the subquery to the WHERE condition, hold down the Control key while dragging and dropping. In this case the second subquery remains at the same level as the first, and becomes part of the WHERE clause of the first.
By default the two subqueries are linked in an AND relationship. Click the AND operator to toggle between AND and OR.
7. To nest a subquery (create a subquery within a subquery), drag an existing subquery to the area beneath the Drop an object here boxes.
To copy rather than move the subquery to the WHERE condition, hold down the Control key while dragging and dropping. In this case the second subquery remains at the same level as the first, and becomes part of the WHERE clause of the first
The inner subquery becomes part of the WHERE condition of the outer subquery.
Related Topics
• Subqueries defined
• To find out which customers bought a service that had previously been reserved in Q1 of 2003, and how much revenue have they generated
• Subquery parameters

11.3 To find out which customers bought a service that had previously been reserved in Q1 of 2003, and how much revenue have they generated
The query panel is open.

150

2012-06-11

Filtering data using subqueries

1. Drag the Customer and Revenue objects to the Result Objects pane of the Query Panel.
2. Select the Service object.
3. Click Subquery.
The subquery outline appears in the Query Filters pane.
Note:
The selected object appears in both boxes in the subquery outline. You often use the same object in both boxes, although this is not required. If the objects do not return any common values, the subquery returns no values, and the query therefore returns no values.
4. Drag the Reservation Year object to the area of the subquery outline beneath the Service objects to add a WHERE condition on the Reservation Year object .
5. Set the Reservation Year condition operator to Equal To.
6. Type ‘FY2003’ in the Type a constant box.
7. Drag the Reservation Quarter object to the area of the subquery outline beneath the Service objects to add the Reservation Quarter object to the WHERE condition.
8. Set the Reservation Quarter condition operator to Equal To.
9. Type ‘Q1’ in the Type a constant box.
10. Click Run Query to run the query.

11.4 Subquery parameters
A subquery or set of subqueries contains the following parameters:
Parameter

Description

The object whose values are used to filter the result objects.
Filter Object(s)

You can include more than one Filter Object. If you do, the values of the objects you select are concatenated. The object that determines which Filter Object values the subquery returns.

Filter By Object(s)

151

You can include more than one Filter By object.
If you do, the values of the objects you select are concatenated. 2012-06-11

Filtering data using subqueries

Parameter

Description

The operator that specifies the relationship between the Filter object and the Filter By object.

Operator

Because of database restrictions you cannot use certain combinations of operators and Filter By objects together. For example, if you use the
Equal To operator with a Filter By object that returns multiple values, the database rejects the
SQL because this type of subquery requires the
Filter By object to return one value only.
In cases where the generated SQL is rejected by the database, you see an error message showing the error description returned by the database

WHERE condition (optional)

An additional condition that constrains the list of values of the Filter By object. You can use ordinary report objects, predefined conditions or existing query filters (including subqueries) in the
WHERE condition.
If there is more than one subquery, this operator determines the relationship between the subqueries.

Relationship operator

AND - the conditions in all of the subqueries must be satisfied.
OR - the conditions in any one of the subqueries must be satisfied.

152

2012-06-11

Ranking data using database ranking

Ranking data using database ranking

12.1 Database ranking defined
When you rank data you sort and filter it according to ranking criteria. You can return unranked data from a database, then rank it in your report. Database ranking allows you to rank data at the database level, so that the data returned by the query is already ranked.
Database ranking has the following advantages:
•
•

Ranking data can be processing-intensive. By ranking at the database level you allow the server, which is typically far more powerful than the client machine, to perform this processing.
Pre-ranking data reduces the amount of data retrieved across the network and stored in your document. Database ranking works by modifying the script generated by the query. If the database on which your query is based does not support ranking, the option to build a ranking is not available in the query panel.
Note:
You cannot include hierarchical objects in database rankings.
Related Topics
• Ranking data

12.2 Database ranking parameters
A database ranking is available in the Query Filters pane of the Query Panel. The following table describes the parameters from left to right in the ranking:

153

2012-06-11

Ranking data using database ranking

Parameter

Description

•
•

Ranking direction and type

•

•

Top - ranks the first [number of records] values of the ranked dimension in descending order.
Bottom - ranks the first [number of values] values of the ranked dimension in ascending order. Top% - ranks the first [number of records] percent of the values of the ranked dimension in descending order.
Bottom% - ranks the first [number of records] percent of the values of the ranked dimension in descending order.

Number of records /percentage

The number of records (for example, the top 10) or the percentage of records (for example, the bottom 10%) to return in the ranking

Ranked dimension

The dimension used in the ranking. For example, if the dimension is Region and the ranking is Top
10, the ranking returns the top 10 regions.

Based on

The measure by which the dimension is ranked.
For example, if the measure is Revenue and the dimension is Region, the ranking orders regions by the amount of revenue they generate

Ranked by (optional)

Dimension that specifies additional calculation context for the ranking. For example, if the ranking dimension is Region, the measure is Revenue and the Ranked by dimension is Country, the regions are ranked by revenue within each country.

Where condition (optional)

Additional restriction on the values returned in the ranking that appears below the other parameters.
For example, a ranking of regions with a condition that restricts Country to “USA" ranks only those regions in the USA.

12.3 To create a database ranking
1. Add the objects that you want to appear in your query to the Result Objects pane of the query panel. 2. Click Add ranking on the toolbar at the top of the Query Filters pane.

154

2012-06-11

Ranking data using database ranking

The ranking outline appears in the Query Filters pane.
Note:
The Add ranking button is disabled if your database does not support ranking.
3. Select the ranking direction and type (Top, Top%, Bottom, Bottom%).
4. Type the number of records (if you selected Top or Bottom) or percentage of recrods (if you selected
Top% or Bottom%) you want the ranking to return in next box.
You can specify a prompt instead of a constant by clicking on the arrow next to the number and selecting Prompt. When you select a prompt the user must enter the ranking number when the query is run.
5. Drag the ranking dimension to the box to the left of the Based on box.
6. Drag the measure on which you want to base the ranking to the Based on box.
7. Drag the dimension that provides the calculation context for the measure to the Ranked by box.
This dimension is optional. To display the Ranked by box, click the arrow to the right of the Based on measure.
8. Drag any dimensions that you want to include in the WHERE restriction to the area at the bottom of the ranking.
9. Click Run Query.
Related Topics
• Subqueries defined

12.4 To rank the top 10 employees by salary in each department
The query panel is open.
1. Drag the Department, Employee Name, and Salary objects to the Report Objects pane within the
Query Panel
2. Click Add ranking at the top of the Query Filters pane.
An outline database rank is added to the Query Filters pane.
3. Rank the top 10 employees in descending order by setting the ranking direction/type to Top, and the number of records to 10 in the box next to Top.
4. Rank employees by dragging the Employee Name object to the box to the right of the number of records. 5. Base the ranking of employees on salary by dragging the Salary object to the Based on box.
6. Click the arrow next to the Based on measure if the Ranked by box is not already visible to display the Ranked by box.
7. Rank employees based on salary by department by dragging and dropping the Department object to the Ranked by box.
8. Run the query to return the ranking.

155

2012-06-11

Ranking data using database ranking

156

2012-06-11

Working with reports

Working with reports

13.1 Hierarchical and non-hierarchical data
Depending on their data source, reports can contain non-hierarchical or hierarchical data.
Non-hierarchical and hierarchical data behaves differently and you work with it in different ways.

13.1.1 Working with non-hierarchical data
Non-hierarchical data has no parent-child relationships. A dimension is an example of a non-hierarchical object. For example, the [Country and ][City] dimensions, displayed in a table, display their values as follows: Country

City

US

New York

US

Atlanta

France

Paris

France

Rennes

Although the data has a hierarchical relationship (for example, "New York" and "Atlanta" are child values of "US", the data appears in non-hierarchical columns and the parent-child relationship is not expressed in the data structure.
You can analyze non-hierarchical data in many ways in your reports, for example by sorting or filtering it. 13.1.2 Working with hierarchical data

157

2012-06-11

Working with reports

Hierarchical data organizes data in parent-child relationships, and you can use these relationships to navigate and analyze the data and the results returned by related measures.
Measures associated with hierarchies are aggregated based on the position of the data in the hierarchy.
For example, the [Revenue] measure calculates total revenue for [San Diego] and total revenue for
[California] (at a less detailed level of aggregation) when associated with a [Geography] hierarchy.
Navigating the hierarchy allows you to explore different measure values at different levels of the hierarchy.
How hierarchical data appears and behaves depends on the report element that contains it.
Related Topics
• Working with non-hierarchical data

13.1.2.1 Restrictions concerning reporting with hierachical data
The table below lists the restrictions that apply when reporting on hierarchical data. These restrictions are repeated in the appropriate sections in this guide.

Table 13-2: Restrictions when reporting with hierarchies
The limitation concerns...

BEx query measures

BEx query measure: the measure which aggregates with the sum function (including aggregation), aggregates the sum in
Web Intelligence, and not in the BEx query. The other types of measure aggregation are delegated.

Break on measure or detail

158

Description

A break is always associated with the sort on the object where it is applied. For this reason, any hierarchy in the table the where break applies, the hierarchy becomes flat. The user can remove the break on the underlying object to restore the hierarchy. 2012-06-11

Working with reports

The limitation concerns...

Description

This restriction applies whenever delegated measures are used, and is not specific to reporting on hierarchical data.
Delegated measure aggregation returns #TOREFRESH, when the required aggregation is not available in the query.
The user has to refresh the document to get the new level of aggregation. This occurs for example when using the filter bar when the user selects a value before “all value” and vice versa when selecting “all value” before a selected value.
Delegated measure aggregation

Drilling

Delegated measure aggregation returns the #UNAVAILABLE message if the delegated measure is in formula on a dimension, or if it is in a multi-valued filter on a dimension that is not in the context of the aggregation of the measure. This occurs for example when defining a URL on top of a dimension in a table where there is a delegated measure. In that case it is recommended to create a variable on top of the
URL formula as a detail of the original dimension and include
(but hide) the original dimension in the block.
There is no drill-replace capability on objects from a BEx query (there is no navigation path).
There is no query drill on OLAP .unx sources.
Symmetric-Asymmetric expand/collapse: when the user is doing collapse/expand on a hierarchy that is to the right of another hierarchy, the system is doing an asymmetric collapse/expand: the collapse/expand action is done only for the selected member for a given member on the hierarchy on the left. The user can explicitly ask for a symmetric collapse/expand, in that case the action is done for any instances of the selected member (for all the members of the hierarchy on the left).

Expand/Collapse

The system is doing symmetric collapse expand by default on a hierarchy that is at the right of a dimension (in that case default collapse/expand and symmetric collapse/expand is producing the same result).
Collapse-expand on hierarchy which is changing on refresh
(hierarchy node variable, prompted member selection, modification at the cube level), may be blocked after a refresh from the preview from the query panel. In that case, the user can drag and drop the hierarchy again in the column to recover from that situation.

159

2012-06-11

Working with reports

The limitation concerns...

Description

A report/table filter where there is a hierarchy may remove rows without respecting the hierarchy structure. For this reason, a filter can remove a parent node currently expanded and but keep leaves or nodes collapsed. To avoid returning an empty table in this case the system automatically expands the hierarchy in the block to shows the resulting members.

Filtering on hierarchies

A filter can remove an intermediary node of a hierarchy. In that case, the user cannot access to the next level of member from the parent node with a simple expand action. To see the descendant of the parent node, the user can do an expand all.
It is not possible to filter on a merge object based on hierarchy.
Filter bar (drill bar ): when filtering through the filter bar on a hierarchy, selecting a node that is not shown in the table because it is collapsed, the table is shown empty. The user can do an expand all to see all the value.
Filtering from the filter bar is filtering on the caption (even for
OLAP business objects that have a key).

Flattening hierarchies

160

When a hierarchy is flattened: when a hierarchy becomes flat the system shows all the members of the hierarchy at the same level like for a dimension without using + - to navigate and without contextual menu “collapse/expand”.

2012-06-11

Working with reports

The limitation concerns...

Description

It is not possible to filter on a merged object based on a hierarchy.

Merged objects

Merged object with hierarchy: a merge object based on a hierarchy cannot be directly used in the report. This is because in some case where the original hierarchy as conflicting hierarchy structure (a member A is descendant of another member B, whereas in the other hierarchy the member A is ancestor of member B) the system cannot build a merge hierarchy. In that case the system prevents form dragging the merge object. In case of the user build a formula using the merge object the system returns #SYNTAX. The user can use directly the original hierarchy instead in the report.
Merge on key for OLAP business object: the data synchronization of the same object from the same source (cube or
BEx query) is based on the internal key of the value of these objects. In the other case it is based on the caption.
The order of an OLAP dimension member in a report LOV
(filter bar, input control) are ordered ascending in lexicographical order.

OLAP

Filtering on OLAP object from the filter UI filter based on the key of the given object.
Filtering from input control on OLAP dimension is filtering on caption. Filtering on a hierarchy is filtering on key.

Query stripping

Ranking on hierarchical data in a table

161

Query stripping is available for .unv, OLAP, and BEx query sources. For other type sources it is not available.
A ranking on a table where there is a hierarchy does not take into account the hierarchy structure of the data. For this reason, any hierarchy in a table where the user defines a ranking becomes flat.

2012-06-11

Working with reports

The limitation concerns...

Description

Sorting & hierarchy: sorting a hierarchy (and dimension from
OLAP sources) is based on the order of the member in the underlying system (it is based on the source ordinal called natural order, but not lexicographical order like for other type of business object). The sort on hierarchy is respecting the structure of the hierarchy, it is sorting sibling members at a given level.

Sorting

Sorting on a measure does not preserve the order of member within a hierarchy in the same table; For this reason the system is showing the hierarchy flat in a table where the user apply a sort on measure.
Variable (formula) on hierarchy: a formula based on a hierarchy is always resulting in flat value list (no hierarchical data).

Variables

13.1.2.2 Working with hierarchical data in tables
Hierarchies appear in tables as hierarchical columns. A hierarchical column displays the hierarchy in parent-child relationships. You can explore the hierarchy by expanding and collapsing its values.
Example:
The following table displays the [Product] hierarchy and the [Revenue] measure:
Product

Revenue

Grocery

203,124
Baking Goods

100,101

Beverages

54,345

Breads

48,678

The measure displays the total revenue for the corresponding value in the hierarchy. For example, the total revenue for Grocery products is 203,124.
You can find more information about Beverages by clicking on the [Beverages] member:

162

2012-06-11

Working with reports

Product

Revenue

Grocery

203,124
Baking Goods

100,101

Beverages

54,345
Soft Drinks

10,100

Soda

20,200

Milk

24,045

Breads

48,678

When you expand the member, the Revenue column also displays the measure values associated with diffferent kinds of beverage.

13.1.2.3 Hierarchical data in cross tables
Hierarchical data behaves similarly in cross table to how it behaves in tables. If an axis of the crosstab is based on a hierarchy, you can click a data item to expand it.
Example: Hierarchical data in a cross table
The following crosstab has the [Time] hierarchy on the vertical axis and the [Product] hierarchy on the horizontal axis.
Time

Grocery

2008

203,110

2009

321,400

2010

350,444

If you click the [Grocery] item, it expands to display its child items and displays the corresponding measure values..

163

2012-06-11

Working with reports

Grocery
Time
Baking Goods

Beverages

Bread

2008

54,570

67,000

81,540

2009

101,000

98,990

121,410

2010

124,000

133,000

93,444

13.1.2.4 Exploring hierarchies

13.1.2.4.1 To expand and collapse all the hierarchies in a table
You can expand all the hierarchies in a table to show all possible combinations of hierarchy members.
1. To expand all the hierarchies in a table, right-click anywhere in the table and select Hierachical
Navigation > All > Expand All Hierarchies.
2. To collapse all the hierarchies in a table, right-click anywhere in the table and select Hierachical
Navigation > All > Collapse All Hierarchies.

13.1.2.4.2 Exploring a hierarchy asymmetrically
Asymmetric exploration is the way you explore a hierarchy by default when you click on members to expand or contract them.
When you explore a hierarchy asymmetrically, your expand and collapse actions are applied only to the current value of the other dimensions that appear to the left of the explored hierarchy.
Example: Asymmetric exploration
A table contains the [Product] dimension and the [Geography] hierarchy.
Product

Geography

Revenue

Grocery

California

540,000

Beverages

California

453,300

If you expand the [California] member to display cities in California in the first row of the table, the expansion applies only to the currrent value (Grocery) of the [Product] dimension.

164

2012-06-11

Working with reports

Product

Geography

Revenue

California

540,000
Los Angeles

320,000

San Diego

100,000

San Francisco

120,000

Grocery

Beverages

California

453,300

To explore a hierarchy asymmetrically
1. To expand the child members of a member, click the member, or right-click and select Expand
Children from the menu.
The hierarchy expands only for the current value of the dimensions or hierarchies to the left of the expanded hierarchy in the table.
2. To expand all descendant members of a member, click the member, or right-click and select Expand
Descendants.
The hierarchy collapses only for the current value of the dimensions or hierarchies to the left of the expanded hierarchy in the table.
3. To collapse the child members of a member, click the expanded member, or right-click and select
Collapse Children
The hierarchy collapses only for the current value of the dimensions or hierarchies to the left of the collapsed hierarchy in the table.

13.1.2.4.3 Exploring a hierarchy symmetrically
When you explore a hierarchy symmetrically, your expand and collapse actions are applied in relation to all values of the other hiearchies or dimensions that appear to the left of the explored hierarchy in the table.
Example: Symmetric exploration
A table contains the [Product] dimension and the [Geography] hierarchy.
Product

Revenue

Grocery

California

540,000

Beverages

165

Geography

California

453,300

2012-06-11

Working with reports

If you expand the [California] member on the first row to display cities in California, the expansion applies to both values of the [Product] dimension.
Product

Geography

Revenue

California

540,000
Los Angeles

320,000

San Diego

100,000

San Francisco

120,000

Grocery

California

453,300
Los Angeles

120,000

San Diego

200,000

San Francisco

133,300

Beverages

To explore a hierarchy symmetrically
1. To expand the child items of a member, right-click the member and selectHierarchical Navigation
> Symmetric > Expand Children.
The hierarchy expands for all values of the dimensions or hierarchies to the left of the expanded hierarchy in the table.
2. To expand all descendant items of a member, right-click the member and select Hierarchical
Navigation > Symmetric > Expand Descendants.
The hierarchy expands for all values of the dimensions or hierarchies to the left of the expanded hierarchy in the table.
3. To collapse the child members of a member, right-click the member and select Hierarchical
Navigation > Symmetric > Collapse Children
The hierarchy collapses for all values of the dimensions or hierarchies to the left of the collapsed hierarchy in the table.

13.1.2.4.4 Changing the drill focus of a hierarchy
You can change the drill focus when exploring hierarchies. When you change the drill focus you filter out the parent member and all members at and above its level when expanding it.
Changing the drill focus is useful when creating charts on hierarchical data. Because measure values associated with parent members are more aggregated than their child members, it is difficult to display them on the same chart axis using the same scale. By removing the parent member, it is possible to display the values for the child members using the same scale.

166

2012-06-11

Working with reports

Example: Drilling down on a hierarchy
You have the following data in a table:
Time

Revenue

2008

29,358,677.22

2009

30,242,323

2010

45,320,243

When you drill down on the [2010] member, you see the following display:
Time

Revenue

Q1

12,500,650

Q2

14,353,231

Q3

8,342,231

Q4

10,124,131

The year members, with values that are much larger than the measure values of the quarter members, do not appear in the display.

To change the drill focus of a hierarchy
1. To drill down on a hierarchy:
a. In the Web interface, right-click the member you want to expand and select Start Drill > Drill down to.
b. In the Rich Internet Application interface, and in Web Intelligence Rich Client, right-click the member you want to expand and select Start Drill > Drill
2. To drill up on a hierarchy, right-click any child member of a member you previously drilled down on and select Drill Focus > Drill Up.

13.1.2.5 Aggregating hierarchical data

13.1.2.5.1 How hierarchical data is aggregated
Hierarchical measure data is aggregated differently depending on whether the method of aggregation is default or explicit. The aggregation logic is based on the following rules:

167

2012-06-11

Working with reports

•

Data sets used for aggregation:
1. When there is a hierarchy in a measure context the measure values for the root members of the hierarchy are aggregated - this is by default (the Aggregate() mechanism is not explicitly declared).
2. For explicit types (sum, max, min), the hierarchical nature of the data is ignored. All the visible data is aggregated, including data that has already been aggregated (parent members already aggregated). •

Sensitivity to the collapse/expand status.
1. Explicit aggregation only aggregates visible data, except when the set expression is used for a specific hierarchy, then an aggregation is performed on the objects defined in the set expression.
2. Default aggregation including the aggregate() function is not sensitive to the state of the collapse/expand. Default aggregation
With default aggregation (including Aggregate() function), we do a non-redundant aggregation (no double-counting). Default aggregation uses the default aggregation function for the data in the hierarchy.
If you include a measure in a cell without specifiying an aggregation function, or if you use the Aggre gate function, the measure is calculated using the default aggregation function.
Default aggregation uses the rolled-up values returned by the database - in other words, it is compatible with the aggregated values returned by the database. Default values are calculated by applying the default aggregation function to all the root values in the hierarchy. This means that default aggregation does not count values more than once except in situations where the same value appears beneath different root items in a hierarchy. (In the example below, the root items are [Drink] and [Food] and no items appear beneath both root items.)
Example: Default aggregation
You place [Unit Sales] in a free-standing cell in a report that contains the hierarchy below. The default aggregation function is Sum; as a result, the value in the free-standing cell is 43,791 (24,597
+ 19,194). The application returns a value by applying the default aggregation function to the root values of the hierarchy.
Product

Unit Sales

Drink

24,597
Alcoholic Beverages

6,838

Beverages

13,573

Food

19,194
Baked Goods

168

7,870

2012-06-11

Working with reports

Explicit aggregation
Explicit aggregation includes a specific aggregation function (for example, Sum) directly in a formula. If the same value is included more than once in an explicit aggregation, it can be counted more than once depending on the visual state of the hierarchy. For example, if an item is expanded, and an explicit aggregation references both the item and one if its child items, Depending on the rollup calculation, the value of the child may be counted twice: once for itself once with the value of its parent. This is because
Web Intelligence is adding the child and parent value.
In explicit aggregation, the application references the visual state of the hierarchy. As a result, values can be counted more than once, and the result of calculations can change depending on whether an item is expanded or collapsed.
Restriction concerning set-based explicit aggregation
When using the set expression in the aggregation function: there is a particular behavior that is different from implicit aggregation concerning hierarchies that are not part of the set expression, but along which the measure is aggregated.
For example, when hierarchies are present in a table and aggregation using set is in the footer and the hierarchies in the table are not specified in the set expression. If there is a filter somewhere which removes the initial roots of the hierarchy, the system will not aggregate values for these roots, but along the original roots (the original query result).
Related Topics
• Examples of default and explicit aggregation

Examples of default and explicit aggregation
Example: Default and explicit aggregation
You have a hierarchy with the following data and the hierarchy appears fully expanded in a report:
Product

Unit Sales

Drink

24,597
Alcoholic Beverages

6,838

Beverages

13,573

Food

19,194
Baked Goods

•

169

7,870

Placed in the table footer, [Unit Sales] returns 43,791. This default aggregation returns the total aggregated value of the measure (24,597 + 19,194).

2012-06-11

Working with reports

•
•
•

•

Placed in a table footer, Sum(Unit Sales]) returns 72.072. This explicit aggregation counts every visible value in the hierarchy (24,597 + 6,838 + 13,573 + 19,194 + 7,870).
The explicit aggregation Sum([Unit Sales];[Product]&[Drink].children) returns 20,411
(6,838 + 13,573) because [Drink] is expanded.
The explicit aggregation Sum([Unit Sales];{[Product]&[Drink];[Product]&[Bever ages]}) returns 38.170 (24,597 + 13,573). The value for [Beverages] appears twice in the calculation because [Drinks] is expanded.
The default aggregation Aggregate([Unit Sales];{[Product]&[Drink];[Product].[Bev erages]}) returns 24,597. The value for [Beverages] does not appear twice in the calculation.

If you collapse the [Drink] node in the report, the calculations are as follows:
•
•
•
•
•

[Unit Sales] returns 43,791. The default aggregation is not affected by the change in display.
Sum([Unit Sales]) returns 51,661 (24,597 + 19,194 + 7,870). The explicit aggregation uses all the visible values to return the value.
Sum([Unit Sales];[Product].&[Drink].children) returns a non-NULL value even though the child members of [Drink] are not visible.
Sum([Unit Sales];{[Product].&[Drink];[Product].&[Beverages]}) returns 38,170 because [Beverages] is not visible. The explicit aggregation uses visible values only.
Aggregate([Unit Sales];{[Product].&[Drink];[Product].&[Beverages]}) returns
24,597. The default aggregation is not affected by the change in display.

13.2 Finding text

13.2.1 To find text in a report
1. Click Find on the bottom toolbar to display the Find bar beneath the reports.
2. Type the text you want to find in the Find box.
3. Click the arrow next to the box and select Match case to perform a case-sensitive search, or Ignore case. 4. If the text occurs more than once, click Next or Previous to highlight other occurences of the text, or Highlight all to highlight all occurences of the text.

13.3 Viewing modes

170

2012-06-11

Working with reports

13.3.1 Viewing modes defined
You can view reports in different modes depending on how you want to work with data and how you want the data to appear.

13.3.1.1 Page mode
Page mode displays the page layout of reports, including page margins, headers, and footers.
Use Page mode when you want to fine-tune the formatting of tables and charts and the layout of report pages. 13.3.1.1.1 Setting the report size in Page mode
You can set a report size to a specific percentage, or to a specific number of pages in its height and width. For example, if you set a report to be one page tall, all elements on the report are re-organized to fit on one horizontal page.
Setting the report size overrides all other settings that control the page layout of a report. For example, if you have a report with three sections and the report is set to start each section on a new page, the report still contains one page only if the report is set to be one page tall.
The report size setting takes effect in Page mode only.

To set the report size
1. In Design mode, select the Page Setup tab.
2. Select the report width in the Width box and the height in the Height box, or set the report size as a percentage in the Scale box.
If you define a percentage, the width and height are calculated automatically.

13.3.1.2 Quick Display mode
Quick Display mode is the default display mode. It is a pagination mode that is based on the data, rather than the physical size of report pages. Quick Display mode displays just the tables, reports, and free standing cells in reports and displays a maximum number of records vertically and horizontally, depending

171

2012-06-11

Working with reports

on the Quick Display settings. Quick Display mode also specifies the minimum page width and height and the amount of padding around the edges of the report.
Because Quick display mode restricts the number of horizontal and vertical rows, a report might not contain all possible data.
Use Quick Display mode when you want to focus on analyzing results, add calculations or formulas, or add breaks or sorts to tables to organize results.
The Quick Display mode properties are configurable either by your administrator, or directly in the application. Property

Configuration Notes

Maximum vertical records Administrator

Maximum horizontal records Administrator

Minimum page width Administrator
Minimum page height Administrator
Right padding

Administrator

Bottom padding

Administrator

Vertical records per page Application

•
•
•

Impacts horizontal tables and crosstabs only
Horizontal tables are never cut vertically
The number of rows in a horizontal table is ignored in vertical records calculation

Horizontal records per page

Application

•
•

Impacts vertical tables, forms and crosstabs only
The number of rows in a vertical table is ignored in horizontal records calculation

Other notes:
• Table headers and footers do not count as rows.
• Free standing cells and charts do not count as rows.
• Section cells do not count as rows when the section is not empty.
• Sections cells count as vertical rows when the section is empty.
• The Avoid Page Break in Block option has no effect in Quick Display mode

13.3.1.2.1 To change Quick Display mode settings
You can change the number of horizontal and vertical records per page in Quick Display mode.
1. Right-click the report and select Format Report to display the "Format Report" dialog box.
2. Select the General tab.

172

2012-06-11

Working with reports

3. Select the number of horizontal and vertical records per page in the Page Content (Quick Display mode only) section.

13.3.2 To switch between viewing modes
1. To display a report in Quick Display mode, click Quick Display on the status bar.
2. To display a report in Page mode, click Page on the status bar.

13.4 Folding and unfolding report data
You can hide and display report data by folding and unfolding the display of different report elements.
You can fold and unfold sections, breaks and tables. Data is concealed and displayed in different ways depending on the report element.
Report element

Section

Table or break

Result

When a section is folded, section details are hidden and free cells only are displayed. In Reading mode, you can fold and unfold sections with the DHTML viewer (web viewer), the Java Applet (Rich internet application), and Web Intelligence Rich Client.
When a table or break is folded, the rows are concealed and headers and footers only are displayed. (Tables must have headers and footers to be folded and unfolded.)
Vertical tables, horizontal tables and cross tables can be folded and unfolded.
In Reading mode, you can fold and unfold sections with the Java Applet (Rich internet application) and Web Intelligence Rich Client. You cannot fold and unfold tables with the DHTML viewer (web viewer).

13.4.1 To fold and unfold report data
You can fold and unfold data in Reading and Design mode by activating the Outline.

173

2012-06-11

Working with reports

1. In Reading mode, select Outline on the toolbar to display the Fold/Unfold bar to the top and left of the report.
With the DHTML viewer, you can fold and unfold sections only in Reading mode. With Web
Intelligence Rich Client and the Java Applet (Rich internet application), you can can fold and unfold sections and tables while in Reading mode.
2. In Design mode, select Analysis > Interact > Outline to display the Fold/Unfold bar to the top and left of the report.
3. Use the +/- icons on the bar, which correspond to and are aligned with individual report elements, to fold and unfold specific report elements.
4. Use the icons at the bottom left or upper right of the bar to fold and unfold all instances of a type of report element.

13.5 To redisplay all hidden content in a report
You can hide tables, cells and sections in reports.
•

Right-click the report containing hidden content and click Show All Hidden Content.

13.6 Printing reports
You print documents report-by-report. You can print one or multiple reports from a single document.
Reports are printed from left to right, and then top to bottom. If a report is wider than the width of the paper size defined in the Report Page Layout, page breaks are inserted.
The paper size and page orientation for printing can be different from the paper size and page orientation set for the reports when you view them in the in the Java or desktop interface. This enables users using different printers to specify the appropriate layout when they print.
You print documents directly from the Java and desktop interfaces. When you print from the HTML interface, you export the document to a PDF file that you can then print.

13.6.1 To print reports
1. Click Print on the File tab.
•
•

174

If you are using the HTML interface, the "File Download" dialog box appears.
If you are using the Java or desktop interface, the "Print" dialog box appears.

2012-06-11

Working with reports

2. Choose your printing options and print the report.

175

2012-06-11

Working with reports

176

2012-06-11

Displaying data in tables

Displaying data in tables

14.1 Overview of tables
When you create a new document and run the query the first time to display the results, the document contains a report that includes the query results in a vertical table. You can do the following
• Modify how the table is organized
• Remove or add data
• Insert other rows or columns
• Change the table type to display the results differently
• Turn the table into a chart to display the results differently
• Insert other tables

14.2 Table types

14.2.1 Vertical table
Vertical tables display header cells at the top of the table and the corresponding data in columns. By default, the header cells display the names of the dimensions, details, and measures included in the table. The body cells display the corresponding values.

177

2012-06-11

Displaying data in tables

14.2.2 Horizontal table
Horizontal tables display header cells at the left of the table and the corresponding data in rows. By default, the header cells display the names of the dimensions, details, and measures included in the table. The body cells display the corresponding values.

14.2.3 Cross tables
Cross tables display values for dimensions across the top axis and on the left axis. The body displays the values of a measure that correspond to the cross-section of the dimensions. For example, this cross table displays values for [Quarter] across the top axis and displays values for [State] on the left axis.
The body displays values that [Sales Revenue] for each quarter in each state.

178

2012-06-11

Displaying data in tables

You can include multiple dimensions in cross tables. For example, this crosstable displays two dimensions. The values for the [Sales Revenue] measure are values each state by quarter for each line. When you create cross tables that include a dimension(s) in the body, the body cell values are calculated according to a multi-dimensional data model. The values displayed in the body are calculated according to all of the coordinates on the table axes, whether or not there is a row for the specific coordinate in the data.

14.2.4 Forms
Forms are useful in your report if you want to display detailed information per customer, product, or partner. For example, a form is a useful way of displaying individual customer records with information such as the customer account, name, address, and so on.
Forms are also useful for formatting address labels for envelopes.

14.3 Creating and editing tables

179

2012-06-11

Displaying data in tables

14.3.1 To create a table by dragging objects onto a report
You have already selected a data source and created a query for the document you are working with.
You are working with a report and want to insert a table in the report. You use the available objects that were created when you created your queries.
1. In Design mode, click Available Objects to the left of the report to display the "Available Objects" screen in the Left Pane.
2. Select an object or objects and drag and drop them to an empty part of the report.
When you release the cursor the objects appear as columns in a vertical table.
3. To add another object or objects to the table, drag them onto an existing table.
To add a column to the left of an existing column, drag the object to the left of the column. To add a column to the right of an existing column, drag the object to the right of the column. To replace an existing column, drag the object to the middle of the column.

14.3.2 To create a table by selecting a template
1. Click Design > Structure only to switch to Structure mode.
Working in Structure mode allows you to define and preview the new table without requesting the server to apply each of your modifications.
2. Click Report Elements > Table > Define Vertical Table/Define Horizontal Table/Define Cross
Table/Define Form.
3. Click the report at the position where you want the table to appear.
The "Insert a Report Element" dialog box appears.
4. To add table components (column, rows or body cells) depending on whether you are building a vertical, horizontal or cross table or a form, click + to the right of an existing component in the right pane of the dialog box, then select the object to associate with the column, row or body cell from the drop-down list.
Note:
You can associate a formula rather than a report object with the component by clicking the arrow next to the component, selecting Edit Formula and defining the formula in the "Formula Editor".
5. To delete a table component, click the arrow to its right and select Delete from the menu, or click the X.
6. When you have finished defining the table, select Design > With Data to populate it with data, or click OK.

180

2012-06-11

Displaying data in tables

14.3.3 To apply a different template to a table with Turn Into
You can turn a table into a different format or into a chart.use the right-click option Turn Table Into, or you can select the table or chart style from the "Tools" section of the "Report Elements" tab.
1. Right-click the table you want to reformat, then select Turn Table Into to display the "Turn Into" options. 2. Choose the new table type or chart type.
3. Click OK to close the dialog box.
If you turned a table with a unicode font to a chart, the font is not retained if unicode is not defined as your default font for charts. You need to format the chart with the unicode font. Contact your administrator for further information.

14.3.4 To add table rows or columns
1. Select a cell in the column or row next to which you want to insert another column or row.
2. Right-click and select Insert > Insert row above/Insert row below/Insert column on left/Insert column on right, or select Report Element > Table Layout > Insert > Insert row above/Insert row below/Insert column on left/Insert column on right
3. Drag an object from the Available Objects pane on the Left Pane to the empty column or row you inserted. 14.3.5 To remove table rows or columns
1. Right-click the table column or row you want to remove and select Delete from the menu.
By default, if you select Delete from the menu, it deletes the column in a vertical table or a row in a horizontal table.
2. You can select Row or Column.
3. Click OK.

14.3.6 To move a row or column

181

2012-06-11

Displaying data in tables

•

Drag the selected column or row and drop it before or after another column or row on the table.
When you drag a row or column, the column or row header displays next to your pointer.

14.3.7 To swap a row or column
•

Drag the selected column or row onto the column or row with which you want to make the swap.

14.3.8 To clear cell contents from a table
You can clear cell contents and then use the empty cells to display images, hyperlinks, formulas, or text you type.
You can clear the following types of cell in a table:
• header cells – you can clear each header cell separately
• footer cells – you can clear each footer cell separately
• related body cells – when you clear one body cell, you automatically clear all of the body cells in the same column or row of the table
1. To select the cell you want to clear, click the cell.
The cell borders are highlighted.
2. Right-click the selected cell and click Clear contents.

14.3.9 To remove a table
1. To select the table you want to remove, click the top edge of the table.
A gray border appears around the table.
2. Press the Delete key.

14.3.10 To copy a table
You can copy and paste tables within a report or into external applications such as Microsoft Word and
Excel. You cannot copy tables from one Web Intelligence instance to another.

182

2012-06-11

Displaying data in tables

1. Select the table, right-click and select Copy on the menu.
2. To paste the table to another part of the report, right-click where you want the table to appear and click Paste on the menu.
3. To paste the table into another application, paste the contents of the clipboard from within the other application. You can also copy a table into another application by dragging and dropping the table directly into the open document in the target application.
The table appears as a picture in the open document if pasted to another application.

14.4 Formatting tables and table cells

14.4.1 To select a background color for the table or cells
You can set the background color for a table or its cells. When the background color of cells are defined
(even as white), they take precedence over the table background color. If you try to apply a background color to all of a table, and the cells remain white, make sure that the celsl are not set with a white background. 1. Select the table or cell, right-click, then select Format Table or Format Cell.
2. Select the Appearance tab on the dialog box.
3. Click the radio button next to the color palette icon to the right of the No color option.
4. Click the arrow next to the color palette icon to display the palette.
5. Select the color using the palette.
6. Click OK.

14.4.2 To define alternate row and column colors for a table
1. Select the table, right-click, then select Format Table.
2. Select the Appearance tab in the dialog box.
3. In the Alternate Color section, set the frequency with which you want the alternate color to appear for the alternate row color in the combo box next to Frequency.
4. Click the arrow next to Color and select the color using the color palette.
5. Click OK.

183

2012-06-11

Displaying data in tables

14.4.3 To insert an image or skin in a table
1. Select the table, right-click, then select Format Table.
2. Select the Appearance tab in the dialog box.
3. To display a skin, select Skin then select the skin from the list. When you apply a skin to a table, ensure that the horizontal or vertical padding value is greater than 0.00, otherwise the skin will not be displayed.
4. To reference an image using a URL, select Image from URL then type the URL.
•
•

To access an image on the corporate server, type the image name. The application inserts boimg:// when you click Apply.
To access an image file directly, click Image from file, then click Browse to browse to the file.

5. If you chose to reference an image file, use the Display and Position lists to determine how the image appears.
6. Click OK to close the dialog box.
7. To remove the image or pattern, select None for the pattern.

14.4.4 To format table or cell borders
1. Right-click the table or cell, then select Format Table or Format Cell from the shortcut menu.
2. Select the Border tab.
3. Use the controls in the tab to set the border styles and colors.

14.4.5 To format text in table cells
1. Select the cells whose text you want to format. (To select multiple columns or cells, select the first column or cell, hold down the Ctrl key, then continue selecting columns or cells.)
If you select a cell in a column, all cells in the column are selected.
2. Format the text in the selected cells using the Format Cell > Font toolbox.
3. Select the font, style, size and effects, as required.
4. Click OK.

184

2012-06-11

Displaying data in tables

14.4.6 To set cell height and width
You can define the height and width of cells by using drag and drop or specifying the size of cells in the "Format Cell" dialog box box.
If you want to hide cell contents on reports, you can set the cell width to 0.1 cm so that the cell width can be modified to display the cell contents later.
1. Drag the cell borders until the cell is the height and width you want, or:
2. Select the cells you want to change, right-click and select "Format Cell" .
3. Select the General tab.
4. Set the cell height and width.
5. If you want to set the cell to autofit, select Autofit width to content and/or Autofit height to content and set the minimum width and height.
Some functions are incompatible with AutoFit cells. If you place any of these functions in an AutoFit cell, the function returns the #RECURSIVE error message.
You can also set AutoFit cell width and height by double-clicking the cell borders.
• To set AutoFit cell width, double-click the right border of the cell
• To set AutoFit cell height, double-click the bottom border of the cell
AutoFit retains the current cell size as the minimum size and enlarges the cell size, if the string that the cell contains is larger than the minimum size specified.
Note:
•
•

Documents that contain tables with the cell size set to AutoFit, take longer to display than documents where tables contain cells with a fixed cell width and cell height.
Auto-Height and Auto-Width properties don't work correctly when Read Cell Content is set to
HTML in a Web Intelligence report.

14.4.6.1 Effects of autofit and wrap text
The following table lists the effects of the autofit and wrap text features, when used separately and in combination: 185

2012-06-11

Displaying data in tables

Feature

Effect

Wrap text

Text is wrapped at the end of the cell.

Autofit width

Cell width is adjusted to display all the text.

Autofit height

Cell height is adjusted to display all the text.

Autofit width + autofit height

Cell width and height is adjusted to display all the text

Wrap text + autofit width

Cell width is adjusted to accomodate the longest word. Because the cell height is not adjusted to the number of lines of text, text might be truncated vertically.

Wrap text + autofit height

Cell height is adjusted to accommodate the number of lines of text created by the wrap text. Because the cell width is not adjusted to the longest word, text might be truncated horizontally.

Wrap text + autofit height + autofit width

Cell height and width is adjusted to the text and there is no horizontal or vertical truncation.

14.4.7 To copy formatting using the Format Painter
You can quickly apply the formatting from a report, table or cell to other reports, tables or cells using the Format Painter. The Format Painter tool is available in the "Tools" section of the "Formatting" tab.
The formatting options applied depend on the objects you choose as the source and target. In general, only properties that affect the visual formatting (for example font style, background color) are applied.
Properties that affect the display of data (for example, table properties such as "Avoid duplicate row aggregation" property) are not applied.
1. Select the report, table or cell whose formatting you want to apply.
2. Click the Format Painter to apply the formatting once, or double-click to apply the formatting multiple times. The Format Painter is in the Format > Tools toolbox.
3. Click the report, table or cell to which you want to apply the formatting.
If you single-clicked the Format Painter, it is deactivated.
If you double-clicked the Format Painter, it remains activated.
4. If you double-clicked, click the Format Painter again or press Esc to cancel the formatting operation.
(You can do this before applying the formatting for the first time if you decide to abandon the formatting operation.) 186

2012-06-11

Displaying data in tables

14.4.8 To set the position of a table or chart on the report page
Below are the directions for positioning a table or chart on a report page. You can also reach the same
Layout box by either Report Elements > Position > Align or by right clicking the table or chart and selecting Align.
1. Select the border of the table or chart, right-click and select Format Table ... or Format Chart ....
2. Select Layout.
3. Use the controls in the Relative Position section to set the position of the table or chart in relation to other report elements.

14.4.9 To layer tables and cells
Layering determines how tables and cells appear when they occupy the same space in a report. An object further forward in the layering order appears over an object further backward in the layering order. 1. Select the table or cell whose layer you want to set.
2. Right-click, click Order and click the layering option.
Option

Description

Bring to front

Make the table or cell the first object in the layering order.

Send to back

Make the table or cell the last object in the layering order.

Bring forward

Bring the table or cell one layer forward in the layering order.

Send backward

Send the table or cell one layer backward in the layering order.

14.4.10 To merge table cells
1. Select the cells you want to merge by holding down the Ctrl button and clicking the cells.
2. Keep the Ctrl button pressed, right-click and select Merge.
When you merge cells the merged cell contains the data from the first cell you selected only. Data from all the other cells is lost.

187

2012-06-11

Displaying data in tables

14.5 Controlling the display of tables

14.5.1 To show or hide tables, rows or columns
Sometimes tables or specific rows and columns display no values. For example, if a sales of a specific product are discontinued, table rows or columns that normally show results for that product appear empty. By default, these empty rows, columns, or tables are displayed. You can choose to display or hide them. When a table or element is hidden, its name is italicized in grey in the "Document Structure" and Filters pane.
You can also display and hide tables based on the result of a formula.
1. Select the table, right-click and select Format Table.
2. Select the General tab.
3. Select Hide always to hide the table.
4. Select Hide when empty to hide the table when it is empty.
5. Select Hide when following formula is true and type a formula in the box to hide the table when the formula is true.
6. Select Show rows with all empty measure values to display rows with empty measure values.
7. Select Show rows with empty dimension values to display rows with empty dimension values.
8. If the table is a cross table, click Show rows/columns with empty dimension values to display rows/columns with empty dimension values.

14.5.2 To redisplay hidden tables, cells or sections
Tables, cells and sections can be hidden unconditionally, if they contain no data, or based on the result of a formula. You can redisplay these tables. To show all hidden elements in a report: right-click in the report and select Show all hidden content. You can also do the following:
1. Select the hidden table, free-standing cell or section in the Document Structure and Filters tab in the Left Pane, or select the hidden report object in the table in which it is displayed.
2. Right-click and select Hide > Show.

188

2012-06-11

Displaying data in tables

14.5.3 To hide dimensions in tables
1. In Design mode, select the column containing the dimension.
2. Select Report Elements > Cell Behaviors > Hide > Hide Dimension to hide the dimension.

14.5.4 To redisplay hidden dimensions
1. In Design mode, select the table containing the hidden dimensions.
2. Select Report Elements > Behaviors > Hide > Show Hidden Dimensions to redisplay the dimensions. 3. If the hidden dimensions were the only objects in the table, right-click the table in the Document
Structure and FIlters pane of the Left Pane and select Hide > Show Hidden Dimensions.

14.5.5 To avoid duplicate row aggregation
When rows contain duplicate data, measure values are aggregated by default. You can choose not to aggregate measure values in this situation.
1. Select the table, right-click and select Format Table.
2. Select the General tab.
3. Select Avoid duplicate row aggregation.

14.5.6 To show or hide table headers and footers
1. Select the table, right-click and select Format Table to display the "Format Table" dialog box.
2. Select the General tab.
3. Select Table headers to display the headers.
4. Select Table footers to display the footers.
Note:
In a cross table the options are Show top header, Show left header, Show bottom footer, Show right footer.

189

2012-06-11

Displaying data in tables

14.5.7 To start tables on a new report page
1. Select the table, right-click and select Format Table.
2. Select the Layout tab.
3. Select Start on a new page in the Vertical or Horizontal panes.
The Horizontal and Vertical panes refer to the table axes.

14.5.8 To display object names in headers on cross tables
1. Select the table, right-click and select Format Table.
2. Select the General tab.
3. Click Show object names to display the object names in additional headers on the cross table.

14.5.9 To avoid page breaks in tables
1. Select the table, right-click and select Format Table.
2. Select the Layout tab.
3. Select Avoid page breaks in table in the Vertical or Horizontal panes.
The Horizontal and Vertical panes refer to the table axes.

14.5.10 To repeat table headers or footers on report pages
1. Select the table, right-click and select Format Table.
2. Select the Layout tab.
3. Select Repeat header on every page or Repeat footer on every page in the Vertical or Horizontal panes. The Horizontal and Vertical panes refer to the table axes.

190

2012-06-11

Displaying data in free-standing cells

Displaying data in free-standing cells

15.1 Free-standing cells defined
Free-standing cells are single cells that stand alone in a report. You can place any text or formula in a blank free-standing cell, or you can use pre-defined free standing cells that display specific information.
The available free-standing cells will contain the following functions:
• Formula and Text Cells:
• Blank Cell - Empty cell in which you can enter any text or formula.
• Drill Filters - Uses the DrillFilters function to display details of the drill filters applied to the report. • Last Refresh Date - Uses the LastExecutionDate function to display the last date when the document was refreshed.
• Document Name - Uses the DocumentName function to display the document name.
• Query Summary - Uses the QuerySummary function to display details of the queries in the document. • Prompt Summary - Uses the PromptSummary function to display details of the prompts in the document. • Report Filter Summary - Uses the ReportFilterSummary function to display the report filters applied to the report.
•

Page Number Cells:
• Page Number - Uses the Page function to display the number of pages in the report.
• Page Number/Total Pages - Uses the Page and NumberOfPages functions to display the current page number and the total number of pages in the report.
• Total Number of Pages - Uses the NumberOfPages function to display the total number of pages in the report.

For more information on the functions used in free-standing cells, see the Using Functions, Formulas and Calculations in Web Intelligence guide, or see the online help.

15.2 To insert a free-standing cell in a report
You must be in Design mode to insert a free-standing cell.

191

2012-06-11

Displaying data in free-standing cells

1. SelectReport Element > Cell > Blank to insert a blank cell.
2. SelectReport Element > Cell > Pre-Defined and select from the list of cells to insert a pre-defined cell. 3. Place your mouse over the part of the report where you want to insert the cell and click the left mouse button. 4. If you inserted a blank cell, type the text or formula of the cell in the Formula box in the Analysis menu. 5. To delete the cell, select it and press Delete.

15.3 To hide free-standing cells
You can hide free-standing cells unconditionally, when they are empty, or based on the result of a formula. 1. Right-click the free-standing cell and click Format Cell to display the "Format Cell" dialog box.
2. Select the General tab.
3. To hide the cell unconditionally, select Hide always.
4. To hide the cell when it is empty, select Hide when empty.
5. To hide the cell based on the result of a formula, click Hide when the following formula is true and type the formula in the box.

15.4 To redisplay hidden tables, cells or sections
Tables, cells and sections can be hidden unconditionally, if they contain no data, or based on the result of a formula. You can redisplay these tables. To show all hidden elements in a report: right-click in the report and select Show all hidden content. You can also do the following:
1. Select the hidden table, free-standing cell or section in the Document Structure and Filters tab in the Left Pane, or select the hidden report object in the table in which it is displayed.
2. Right-click and select Hide > Show.

15.5 To copy a free-standing cell
You can copy and paste free-standing cells within a report or into external applications such as Microsoft
Word and Excel. You cannot copy free-standing cells from one application instance to another.
1. Select the free-standing cell, then click Copy on the toolbar.

192

2012-06-11

Displaying data in free-standing cells

2. To paste the free-standing cell to another part of the report, right-click where you want the free-standing cell to appear and click Paste on the menu.
3. To paste the free-standing cell into another application, paste the contents of the clipboard from within the application.
You can also copy a free-standing cell into another application by dragging and dropping the free-standing cell directly into the open document in the target application. When you drag and drop a free-standing cell into a Microsoft Office application, the text in the cell is pasted into the application.

193

2012-06-11

Displaying data in free-standing cells

194

2012-06-11

Organizing data with sections, breaks and sorts

Organizing data with sections, breaks and sorts

16.1 Using sections to group data

16.1.1 Grouping information with sections
Sections allow you to split report information into smaller, more comprehensible parts.
Example: Grouping quarterly revenue results into sections on a report
You are the regional sales manager in Texas. You receive a report showing 2003 annual revenue for stores in your region, broken down by cities and quarters.
City

Sales revenue

Austin

Q1

314430

Austin

Q2

273608

Austin

Q3

294798

Austin

Q4

252644

Dallas

Q1

215874

Dallas

Q2

194689

Dallas

Q3

204066

Dallas

Q4

188791

Houston

Q1

572177

Houston

Q2

619924

Houston

Q3

533765

Houston

195

Quarter

Q4

520332

2012-06-11

Organizing data with sections, breaks and sorts

To make a comparison of the results for each city per quarter, you set [Quarter] as a section value.
The report is broken up into four separate sections by quarter.
Q1
City

Sales revenue

Austin

314430

Dallas

215874

Houston

572177

Q2
City

Sales revenue

Austin

273608

Dallas

194689

Houston

619924

Q3
City

Sales revenue

Austin

294798

Dallas

204066

Houston

533765

Q4
City

Sales revenue

Austin

252644

Dallas

188791

Houston

520332

You can create a single section or include multiple sections with subsections in a report. You can also remove and reposition sections within a report.
You can create a section from one of two sources:

196

2012-06-11

Organizing data with sections, breaks and sorts

•
•

on a dimension already displayed on a table or chart: right-click teh dimension and select Set as section. on a dimension included in the document but not displayed on a table or chart

You cannot create a section with a measure object.

16.1.2 Applying filters to sections
You can apply section filters based on the values in the section header or on values that appear within the section.
Applying a section filter to the section header
If you have a report with a section on [Country], the filter [Country] = "US" filters out all sections on countries other than the US.
Applying a section filter to the section data
If you have a report with a section on [Region] and you apply the filter [Product]="Drinks" to the section, the report contains all sections that contain the product "Drinks".
In this case, the sections remaining in the report contain products other than drinks if these products were sold in these regions. This is because the section filter retains regions in which drinks were sold, but does not exclude other products from the data in the section.
In other words, the filter is based on the data in the section, but applied indirectly to the data in the section header.

16.1.3 To create a section from a column
•

Right-click the column you want to define as a section and click Set as Section.

16.1.4 To create a section from a dimension
1. Select Report Elements > Section > Insert Section.
2. Click on the report at the position where you want to insert the section.
3. Select the dimension in the dialog box that appears and click OK to insert the section.

197

2012-06-11

Organizing data with sections, breaks and sorts

16.1.5 Creating sections from a hierarchy
If you create a section on a hierarchy, each member of the hierarchy becomes a section header. You can expand sections in the same way as you expand members in a column in a table.
You have a report that displays the following data:
Customer Geography

Gender

Internet Sales Amount

Male

235.243

Female

254,342

Male

34,342

Female

45,464

Male

12,232

Female

14,242

Male

17,343

Female

18,001

All Customers

Australia

Canada

France

If you create a section on [Customer Geography], the report initially appears as follows:
All Customers

Gender

Internet Sales Amount

Male

235.243

Female

254,342

If you expand the section header, the report appears as follows:
All Customers

Gender

Male

198

Internet Sales Amount

235.243

2012-06-11

Organizing data with sections, breaks and sorts

Gender

Internet Sales Amount

Female

254,342

Australia

Gender

Internet Sales Amount

Male

34,342

Female

45,464

Canada

Gender

Internet Sales Amount

Male

12,232

Female

14,242

France

Gender

Internet Sales Amount

Male

17,343

Female

18,001

16.1.6 Creating subsections
You can create a report containing sections within sections (subsections) by creating a section within an existing section.

199

2012-06-11

Organizing data with sections, breaks and sorts

16.1.7 To remove a section cell or section
•

Right-click the section cell and select Delete > Cell Only to delete the section cell, or Delete >
Section and Cell to delete the section and the cell.

16.1.8 To set the page layout of a section
1. Right-click the section and select Format Section from the menu.
2. Select the Layout tab in the dialog box.
3. Select Start on a new page to start each section on a new page.
4. Select Avoid page breaks to avoid page breaks in the section.
5. Select Repeat on every page to repeat the section header on every page.

16.1.9 To hide sections
1. Select the section.
2. Select Report Elements > Behaviors > Hide to hide the section.
3. Select Report Elements > Behaviors > Hide When Empty to hide the section when it is empty.
4. Select Report Elements > Behaviors > Hide When , select Hide when the following formula is true, and type a formula in the box to hide the section when the formula is true.
The formula must return a boolean value (True or False).

16.1.10 To redisplay hidden tables, cells or sections
Tables, cells and sections can be hidden unconditionally, if they contain no data, or based on the result of a formula. You can redisplay these tables. To show all hidden elements in a report: right-click in the report and select Show all hidden content. You can also do the following:
1. Select the hidden table, free-standing cell or section in the Document Structure and Filters tab in the Left Pane, or select the hidden report object in the table in which it is displayed.
2. Right-click and select Hide > Show.

200

2012-06-11

Organizing data with sections, breaks and sorts

16.1.11 To define colors and images in a section
1. Right-click the section and select Format Section.
2. Click the Appearance tab in the dialog box.
3. Define the colors and images using the controls in the Appearance tab.

16.2 Using breaks

16.2.1 Breaks defined
A break is a division within a block in which data is grouped according to a selected dimension, detail, or measure into self contained sections. These sections are represented as smaller tables within the same block of data.
You use breaks to display all the data for each unique value of an object in separate parts.
Using breaks has two main advantages:
•
•
•

You can more efficiently organize how your data is represented.
You can display subtotals.
You can display sub-aggregations.

16.2.2 Breaks compared to sections
A section breaks up the data into multiple free-standing cells called section headers. Each section header contains one value for a dimension, with a block of data that corresponds to the dimension value. A break divides the data up within one block. One column contains the values for a dimension, detail, or measure, which are repeated for each other row of values in the block.

201

2012-06-11

Organizing data with sections, breaks and sorts

16.2.3 Applying breaks to hierarchies
When you apply a break to a hierarchy, the break occurs on all hierarchy members at all levels.
Example: A break applied to a hierarchy
You have a report displaying the following data:
Customer

Gender

Unit Sales

ALL

F

131,587

M

138,215

F

131,587

M

138,215

F

36,759

M

37,989

USA

CA

If you apply a break to the [Customer] hierarchy, the display appears as follows. The break is applied on each member of [Customer].
Customer

Gender

Unit Sales

F

131,587

M

138,215

ALL
ALL

Customer

269,802

Gender

Unit Sales

F

131,587

M

138,215

USA
USA

202

269,802

2012-06-11

Organizing data with sections, breaks and sorts

Customer

Gender

Unit Sales

F

36,759

M

37,989

CA
CA

74,748

16.2.4 Default sort order in breaks
When you insert a break on an object, the values for the object are automatically sorted in ascending order as follows:
•
•

If the values are numeric, the lowest value appears in the first row of the table, the highest in the last row.
If the values are alphabetical characters, then the values are sorted in alphabetical order from top to bottom.

You can change this sort order at any time.
You can set multiple breaks and set a sort priority on each break, so that you control how the data is displayed when you insert multiple breaks across several dimensions details, or measures.

16.2.5 To insert a break
Note:
You cannot insert breaks in Form tables.
You must be in Design mode to add breaks.
1. Select the column on which you want to apply the break.
2. Select Analysis > Display > Break > Add Break .
The table is divided into as many mini tables as there are unique values in the column. Each mini table has a footer.
Related Topics
• To manage breaks

203

2012-06-11

Organizing data with sections, breaks and sorts

16.2.6 To remove a break
You must be in Design mode to remove breaks.
1. Select the column on which the break is defined.
2. Select Analysis > Display > Break > Remove Break .
The Remove Break menu item is not available if the column does not have a break defined.
3. To remove all breaks, select any column in the table and select Analysis > Display > Break >
Remove All Breaks .
The Remove All Breaks menu item is not available if the table has no breaks defined.

16.2.7 To manage breaks
You must be in Design mode to manage breaks.
1. Select any column in the table.
2. Select Analysis > Display > Break > Manage Breaks.
The dialog box shows the breaks defined in the table. If the table is a crosstab, the dialog box shows the breaks on both the horizontal and vertical axes. Each break is represented by the dimension on which it is defined. The order in which the dimensions appear indicates the order in which the breaks are applied.
3. To change the priority of a break, select the dimension and click Up or Down to move the dimension in the break priority.
4. To add a break, click Add and select the dimension on which you want to apply the break.
5. To remove a break, select the dimension and click Remove.
6. To set the properties of a break, select the dimension and select the properties on the right of the dialog box. See the link at the bottom of this topic for more information on the break properties you can set.
Related Topics
• Break properties

16.2.8 Break properties

204

2012-06-11

Organizing data with sections, breaks and sorts

You can set the following properties of a break:
Property

Description

Break header

Displays a header for each part of the table, crosstab, or form when you insert a break.

Break footer

This diplays a footer for each break in a section, including a footer after the last row for a table or column for a crosstab when you insert a break.
When you apply a calculation to the data, the result is shown in the footer.

Apply sort

Applies the default sort order to the values in the break. Duplicate values: Display all

Displays all values in the break, even when they are duplicated.

Duplicate values: Display first

Displays the first value only when values are duplicated.

Duplicate values: Merge

Merges cells containing duplicate values and displays a single value over the merged cells.

Duplicate values: Repeat first on new page

Displays the first value in a group of duplicate values at the beginning of the break and on each new page.

Start on a new page

Displays each part of the table or form created by a break on a new page.

Avoid page breaks

Where possible, keeps each break section on the same page. This option is not taken into account when a block is larger than one page.

Repeat header on every page

Repeats the header at the top of the table on every new page when a table goes over onto a new page. Repeat footer on every page

Repeats the footer at the bottom of the table on every new page when a table goes over onto a new page.

16.3 Using sorts to organize data

205

2012-06-11

Organizing data with sections, breaks and sorts

16.3.1 Sorting the results displayed on reports
You can apply sorts to the values displayed in tables, sections and charts to organize the order in which values are displayed in a report. Default sorting is in the order of the dimensions from the left to the right of the result object.
Note:
When sorting in reports where the underlying query has already performed a sort, ensure that the sorted query dimension is first in the table on the report, otherwise you will lose the effect of the sorted dimension in the report. Alternatively, edit the query so that the sorted dimension is returned first.
The following sort orders are available:
Sort order

Description

Default

This is sometimes referred to as the natural order.
Depending on the type of data in the column or row, the results are sorted as follows:
• ascending numeric order for numeric data
• ascending chronological order for date
• Chronological order for months
• alphabetical order for alphanumeric data

Ascending

When selected, results are arranged in ascending order: The smallest value at the top of the column moving to the highest value at the bottom.
For example: 100, 200, 300 or California, Colorado, Florida.

Descending

When selected, results are arranged in descending order: The highest value at the top of the column moving to the smallest value at the bottom.
For example: 300, 200, 100 or Florida, Colorado,
California.

206

2012-06-11

Organizing data with sections, breaks and sorts

Sort order

Description

You define your own sort order. Custom Order is available on dimensions and attributes. Note the following restrictions:
• Custom Order is not available on hierarchies, levels, and measures.
• It is not possible to manually add values to the
Custom Order list. (For detail objects the field is active, but the values entered are not added to the list.)
• You cannot set the Custom Order in DHTML
(Web mode) in modify mode.
Custom

Note:
By default, the maximum number of values for dimensions are set to different values on the client and server. To avoid conflicts, it is recommended to set both to the same value.
Server default value: 100 items (Maximum Custom Sort Size parameter in the WebIntelligenceProcessingServer properties in the CMC)
Client default value: 1000 items (WebiParamCustomSortMaxSize parameter in WebIContainer_ClientDescriptor.xml)

16.3.2 Sorting hierarchical data
Sorts apply on hierarchical data within each parent item in the hierarchy. Sorts do not break links between parent and child items.
Example: Sorting hierarchical data
The following table contains the [Product] hiearchy in an unsorted state:
Product

Grocery
Baking Goods

207

2012-06-11

Organizing data with sections, breaks and sorts

Product

Beverages
Soft Drinks
Milk
Soda
Breads

After a descending sort is applied, the hierarchy appears as follows:
Product

Grocery
Breads
Beverages
Soft Drinks
Soda
Milk
Baking Goods

The sort places grocery types in descending order and beverages in descending order in their parent item. The sorted beverages retain their hierarchical link with their parent item.

16.3.3 To insert a sort
1. Click Design to work in Design mode.
2. Select the column you want to sort.
3. Select Analysis > Display > Sort > Ascending/Descending to sort the column in ascending or descending order.

208

2012-06-11

Organizing data with sections, breaks and sorts

16.3.4 To remove a sort
1. Select the sorted column.
2. Select Analysis > Display > Sort > None.
You can also select any column and select Analysis > Display > Sort > Remove All Sorts to remove all sorts from the table.

16.3.5 To manage sorts
1. Select the table or chart in which you want to manage sorts and select Analysis > Display > Sort
> Manage Sorts.
The dialog box displays the sorts applied to the table or chart. In a cross table, the sorts on both the horizontal and vertical axes are displayed. Each sort is represented by the name of the sorted dimension, and an arrow indicates the sort direction (ascending or descending). The order in which the sorted dimensions appear indicates the order in which the sorts are applied.
2. To change the priority of a sort, select the dimension and click Up or Down to move the dimension in the sort priority
Note:
You cannot change the priority of a sort if a sorted break is defined on the dimension.
3. To change the direction of a sort, double-click the dimension, or select it and select Ascending or
Descending from the Order list.
4. To add a sort, click Add and select the dimension you want to sort from the list.
5. To remove a sort, select the dimension and click Remove.
6. To customize a sort by choosing your own sort order or adding values to the list of values to sort, click Values beneath Custom Order and define your custom sort. The Values button is disabled if the custom sort is not applicable. The custom order is applied to the entire document and not just the dimension in the selected block.
7. To reset a custom sort order to the standard sort order, select the dimension and click Reset.
Note:
•
•

The Reset button is disabled if the sort on the selected dimension is not customized.
Refer to the table in the topic Sorting the results displayed on reports for the restrictions of the
Custom Order option.

Related Topics
• Sorting the results displayed on reports

209

2012-06-11

Organizing data with sections, breaks and sorts

210

2012-06-11

Displaying data in charts

Displaying data in charts

17.1 Creating charts
You can include one or multiple charts on the reports in a document. You can create a chart when you build a new document or insert charts into an existing document.
Note:
When you export a document that contains a chart to excel format, the chart is converted into an image.
Related Topics
• To add a chart to a report

17.1.1 Opening charts created with Web Intelligence 3.x
This version of the software supports backward compatibility with Web Intelligence XI 3.x.
Existing charts are converted automatically when you open them except that if you open an existing
3D chart, other than a 3D bar chart, it will be converted into a 3D bar chart.

17.2 Chart types
A report displays results in a block. You can format the block as a specific type of chart.
Note:
3D line, 3D area, and 3D surface are no longer provided in this version of the product. When any of these charts are present documents and reports that are migrated to 4.x, they are transformed into 3D bars. 211

2012-06-11

Displaying data in charts

17.2.1 Bar charts
Bar charts display data in rectangular form horizontally. Bar charts are useful if you want to compare similar groups of data; for example, revenue from one time period to another. There are three types of bar charts:
•
•

•

Bar: A chart constructed of horizontally-oriented rectangles. The lengths of rectangles are proportional to the values associated to different category items.
Stacked bar chart: A chart constructed of horizontally-oriented stacked colored rectangles . The heights of the rectangles are proportional to the values associated to different category items.
Rectangles are colored according to legend entries.
100% stacked bar chart: A chart with data displayed as parts of a whole (as percentages). A whole being a rectangle and a series being a subdivision of the rectangle

17.2.2 Box plot charts
A chart (also called a stock chart) that displays a five-number summary based on the distribution of a dataset: the maximum, the minimum, the first quartile, the third quartile, and the median. It can also show abnormal values called outliers.

17.2.3 Column charts
Column charts display a series as a set of vertical bars that are grouped by category. Column charts are useful for showing data changes over a period of time or for illustrating comparisons among items.
There are the following seven types of column charts:
•
•
•
•

212

Column chart: A chart constructed of vertically-oriented rectangles. The heights of the rectangles are proportional to the values associated to different category items.
Column chart with dual value axes: A chart with two value axes. It allows a part of a data series to be plotted against one axis and a part of the data series to be plotted against the other axis.
Combined column and line chart: A chart displaying a combination of a column chart and a line chart. The chart types share the same value axis.
Combined column and line chart with dual value axes: A chart displaying a combination of a column chart and a line chart. The chart types each have their own value axis.

2012-06-11

Displaying data in charts

•

•

•

Stacked column chart: A chart constructed of vertically-oriented stacked colored rectangles. The heights of rectangles are proportional to the values associated to different category items. Rectangles are colored according to legend entries.
100% stacked column chart: A chart with data displayed as parts of a whole (as percentages) with a whole being a column and a series being a subdivision of the column. If there is only one series in your chart, all the column bars will fit to 100% of the chart area.
3D column chart: A chart similar to a column chart with an added 3D dimension.

17.2.4 Line charts
Line charts connect specific data values with lines, either horizontally or vertically. Line charts are useful if you want to show trends or changes in data over time.

There are three kinds of line charts:
•
•

•

Line Chart: An XY chart that displays lines connecting plots. Value axis plot positions are expressed by analysis category items. The secondary value axis plot positions represent the associated values.
Dual Line Chart: An XY chart with two axes displaying lines connecting plots. Category axis plot positions signify analysis category items. The value axis plot positions, on both axes, represent the associated values.
Area Chart: An area chart is an XY chart that displays a surface made up of a connection of plots.

17.2.5 Map charts
The following Map charts are available:
• Tree Map Charts: Charts that display values within nested rectangles that can be colored. The levels of nesting correspond to the level of hierarchical breakdown. The size of the rectangles and their color both express a set of values.
• Heat Map Charts: Charts that display values that are represented by colors in a map using a category axis and optionally a second category axis. The colors of the rectangles are determined by a measure value. 213

2012-06-11

Displaying data in charts

17.2.6 Pie charts
Pie charts display data as segments of a whole. Pie charts are useful if you want to show how each part of your report data contributes to the total.
You can only include one measure object in a simple pie chart or two in a pie chart with depth. If you have several measures in your report, you should choose another chart type.

There are three types of pie charts:
•
•

Pie chart: A circular chart made up of sectors. The area of the circle represents a whole, and the sectors of the circle represent the parts of a whole.
Pie chart with variable slice depth: A circular chart made up of sectors. The area of the circle represents a whole, and the sectors of the circle represent the parts of a whole. The sectors may have some depth expressing a third value.

Additionally, a donut chart can be displayed from a pie chart. It is similar to a pie chart, but with an empty center; it is ring shaped.

17.2.7 Point charts
There are four types of Point charts.
Scatter charts are similar to line graphs, except that the data points are plotted without a line connecting them. Scatter charts are useful if you want to make a comparison between specific data points. There are two types of scatter charts.
•

•

Scatter Chart: An XY chart displaying plots. Plots are positioned with coordinates given by a pair of values. Each plot may have colored symbols representing the analysis category item associated with the values.
Bubble Chart: A two-dimensional chart of points representing a collection of data. Extra variables are represented by the size of the points.

Polar charts are XY charts displaying plots. Plots are positioned with coordinates given by a pair of values. Each plot may be sized according to extra values. There are also polar bubble charts.
There are two kinds of bubble charts:

214

2012-06-11

Displaying data in charts

•
•

Polar Scatter Plot: A chart with one radial axis and one angular axis, where each data point is represented with a symbol. Similar to a bubble chart, but without the sizing of points.
Polar Bubble Chart: A two-dimensional chart with one radial axis and one angular axis of points representing a collection of data. Extra variables are represented by the size of the points.

17.2.8 Radar charts
This chart (also known as a Spider chart) displays several axes starting from a unique origin and with a common scale. Each axis represents an analysis category item. Plots are directly placed on an axis according to the associated values. Plots can be linked by lines.
Radar charts are useful if you want to look at several different factors related to one item. For example, you could use a radar chart to display revenue data for different services within a hotel. On one axis, you could display revenue for the rooms. On another you could display revenue for the restaurant, and so on.

17.2.9 Tag cloud charts
A mono-dimensional visualization representing data as words where the word font size represents its relative weight in the dataset.

17.2.10 Waterfall charts
Waterfall charts (also known as Bridge charts) display vertical bars. Each one of these bars starts at the level where the preceding bar ends, making the bars look as if they were floating. This type of chart is useful for showing how a measure increases or decreases, for representing positive or negative changes or for illustrating up and down effects.
Depending on the type of data source, there are two types of waterfall chart:
• A chart generated from a flat dimension gives a simple waterfall chart.
• A chart generated from hierarchical data gives a complex waterfall chart.
Note that for subtotal management:
•
•

Intermediate totals are generated from hierarchical treenodes only. To generate intermediate totals from a flat dimension, you have to use grouping.
Intermediate totals (treenodes) are displayed as a waterfall.

For feeding restriction:

215

2012-06-11

Displaying data in charts

•
•

The category axis is limited to one dimension (or hierarchy).
The value axis is limited to one measure.

For color management:
• It is not possible to assign specific colors to initial values, totals, subtotals or positive/negative variations. • Since only one color is used in the waterfall chart, no color legend is displayed.

17.3 Adding, copying and removing charts

17.3.1 To add a chart to a report
You must be in Design mode. If you are in Structure Only Design mode, all the charts will appear grayed out. There are three ways to add a chart to a report.
1. In the "Reports Elements" toolbox, select the chart you want into the report. Then drop the dimensions and measures you want into the chart from the "Available Objects" pane.
The chart appears empty in light gray. This is sometimes called a ghost chart. You now know that you can feed the chart.
2. Using the right click contextual menu option, insert a chart by selecting Insert > Insert a Report
Element.
3. Select the table you want to turn into a chart and then select Turn Into from the Tools tab.
Related Topics
• To feed a chart

17.3.2 Chart feeding: Binding objects to a chart
The table explains the different elements for feeding a chart.

216

2012-06-11

Displaying data in charts

Purpose

Feeds

Binding object to Value axes axes Category axes
Defining series
(*)

• Region Color

Object type

Measures
Dimensions, Details or
Measure Names
Dimensions, Details or
Measure Names

• Region Shape (Radar & Point charts)
Defining series size • Pie sector size / sector height

Measures

• TreeMap rectangle weight
• Bubble height / Bubble width
Conditional color• Map rectangles ing (*)
• TagCloud text zones

Measures

(*) Optional

17.3.2.1 To feed a chart
You must be in Design mode. You must have already inserted a chart.
There are two ways to feed a chart.
1. In the left-hand panel, select "Available Objects". From the "Available Objects" pane, drag and drop the measures, dimensions, and/or details into the chart.
They will automatically be dispatched to the relevant area.
2. Select the chart. Right click in the chart to display the contextual menu. Select Assign Data. The
"Assign Data" dialog box appears displaying the values chosen. You can add, delete, reorder (move up, down, to the top, or to the bottom), or hide the values plus edit or create a formula.
You have fed the chart.
Related Topics
• To format a chart

217

2012-06-11

Displaying data in charts

17.3.3 To apply a chart style
You must be in Design mode and have selected a chart.
The best practice: Create a chart; feed it with all needed dimensions; apply the style, then change the settings to refine the chart format. If you modify setting before applying a template, you may alter your modifications if these settings are included in the template definition (the only way to get them back is to use Undo).
A chart style is a group of settings stored within a source file. The chart style is used to manipulate a chart (at several levels - graphic, region, and property) before it is rendered. Chart styles allow charts to assembled using a set of predefined settings which include modern chart styles (such as anti-alias, gloss, and emboss). Adapted chart styles offer straightforward chart output customization with pre-settings and themes. They contain the group of settings for a chart including:
•
•
•
•
•
•
•
•

layout - the settings that determine how each chart is displayed chart items (such as the title, the legend, the axes) chart location (for example, where chart items are placed, if they are visible) theme - the settings that determine how the chart looks color palettes, etc. textures (such as the texture of the background) shadows fonts

Note:
You can choose among pre-defined color palettes but cannot create your own in this version of the software. •

In the "Format" tab, click the Chart Style icon and select: Flashy, Normal, or High Contrast style.
The style is applied.

Related Topics
• To format a chart

17.3.4 To copy a chart
1. Select the chart, right-click and select Copy on the menu.
The chart is copied to the clipboard.
2. To paste the chart to another part of the report, right-click where you want the chart to appear then click Paste on the menu.

218

2012-06-11

Displaying data in charts

3. To paste the chart into another application, paste the contents of the clipboard from within the other application. You can also copy a chart into another application by dragging and dropping it directly into the open document in the target application.
Within the same application, your copied chart will be dynamic. However, if the chart is pasted into another application, the chart appears as a picture.
Related Topics
• To format a chart

17.3.5 To remove a chart
There are three ways to remove a chart.
1. Right-click the chart and click Delete.
2. Activate the "Document Structure and Filters" panel. Then right click on the chart name. Click Delete.
3. Select the chart. Then in the upper lefthand pane, click the delete icon.
The chart has been deleted.
Related Topics
• To format a chart

17.4 Changing the chart type

17.4.1 To change the chart type by using Turn Into
Note:
It is also possible to transform individually bar series into lines or surface.
1. Right-click the table or chart.
2. Select Turn Into. A number of shortcuts appear. To get a dialog box with all your options, select
More Transformations...
The "Turn Into" dialog box appears.

219

2012-06-11

Displaying data in charts

3. Click the chart category you want, then click a chart icon.
4. Click OK.
The selected template is applied to the block and displays the data in the chart type you chose.
Related Topics
• To format a chart
• Line charts

17.4.2 Turning Hierarchical queries into charts
You can turn a hierarchical query into a chart.
Note:
•

•

Best Practice: Hierarchical totals should not be displayed in Pies or Tag Cloud. In other charts, displaying the totals may generate scale distorsions, especially if the measure type is aggregative.
To hide hierarchical totals, use levels for feeding or navigate within the table with the Drill Focus option or uncheck the option "Show parent nodes" in the Format Chart Dialog Box 'Chart Block >
General).
Use only one hierarchy to feed a Tree Map.

Related Topics
• Hierarchical queries defined
• To change the chart type by using Turn Into

17.4.3 To switch between bars, lines and surfaces
You must be in Design mode. You must open the "Format Chart " dialog box.
1. Select the chart, right-click and select Format Chart.
a. In the Web interface, select Chart Block > Region Type
b. In the Rich Internet Application (Java applet) and in Web Intelligence Rich Client, select Global
> Region Type
2. For each measure, select the appropriate region type: Bars, Lines, or Surfaces.

220

2012-06-11

Displaying data in charts

17.5 Positioning and sizing charts

17.5.1 To set the position of a table or chart on the report page
Below are the directions for positioning a table or chart on a report page. You can also reach the same
Layout box by either Report Elements > Position > Align or by right clicking the table or chart and selecting Align.
1. Select the border of the table or chart, right-click and select Format Table ... or Format Chart ....
2. Select Layout.
3. Use the controls in the Relative Position section to set the position of the table or chart in relation to other report elements.

17.5.2 To position a chart in relation to another chart or table
If you have more than one block (table, chart, or form) in your report, you can use relative positioning.
Relative positioning allows you to position a selected block (for example, a chart) in relation to other blocks in the report.
If new data on the database modifies the size of the tables or charts, relative positioning ensures that the different tables and charts display correctly without overlapping each other.
Below are the directions for positioning a table or chart on a report page. You can also reach the same
Layout box by either Report Elements > Position > Align or by right clicking the table or chart and selecting Align.
Note:
If you position a chart in relation to another block (that is, a chart, table, or form), the position of the related block changes automatically, if you reposition the chart.
1. Right-click the chart and click Format Chart.
2. Select Global > Layout .
3. Select the distance of the upper left point of the chart in relation to another report element by entering
- the number of pixels; the part of the other report element from which you want to measure the pixels (in the first drop-down list); the report element from which you want to measure the pixels (in the second drop-down list).
4. Repeat this for the distance of the lower left point of the chart.

221

2012-06-11

Displaying data in charts

17.5.3 To resize a chart
You can also resize the chart graphically using the mouse.
1. Right-click the chart and click Format Chart.
2. Do the following: In the Web interface, open the General tab.
a. In the Web interface, select the General page.
b. In the Rich Internet Application (Java applet) and in Web Intelligence Rich Client, select the
Global page.
3. Type the chart width in the Width property and the height in the Height property.
Related Topics
• To format a chart

17.6 Formatting charts

17.6.1 Formatting chart areas
You can format a chart area or a selected chart area (title, legend, axes, plot area, area title) and format it using the Format Toolbar.

17.6.2 To format a chart
You must be in Design mode.
There are several ways to format a chart. One way is given below. Alternatively, select the chart and then Report Elements > Chart Style > Format Chart.
How to access the "Format Chart " dialog box.
1. Right-click the chart and click Format Chart.
2. Select the chart area that you want to format.

222

2012-06-11

Displaying data in charts

If you have preselected a chart area before calling the dialog box, this area is displayed automatically without you having to navigate.
3. In Web Intelligence Rich Client, select the functional tab that you want to change in the left pane.
In Web Intelligence, expand the tab of the chart area you want to format, then select the functional tab. 4. When you have made your changes, click Apply if you want to see the changes before you close the dialog box. You may want to make some other changes before you close the dialog box.
Otherwise, click OK if you want to save the changes and close the dialog box.
You have formatted the chart.

17.6.3 Formulas in chart elements
The following chart elements can use a formula:
• Chart title
• Legend title
• Axis titles
• Maximum and minimum values for axis scaling
You can use the Formula Editor (the fx icon) to define and edit formulas: .
For more information on the functions used in free-standing cells, see the Using Functions, Formulas and Calculations in Web Intelligence guide, or see the online help.

17.6.4 Warning icons in charts
There are four kinds of warning icons:
•

General Warnings: icons are displayed on the top left corner of the chart
•
•
•
•

•

223

Red X in a white background: impossible to generate the chart. (This could be due to a cache problem - try clearing temporary objects from cache.
White X in a red circle: cannot find the image, the administrator should check load balancing settings and enable service monitoring as described in the Administrator's Guide.
Yellow warning: e.g. dataset too large (technical limit of the server), need to refresh the dataset, other cube errors.
Blue alert: limit for optimal rendering

Error Prevention Warnings: Small yellow warning icon displayed on the data point (if warning icons are activated in the chart format options) the dataset is inconsistent with the chart parameters (e.g. pie chart with negative values, negative values for a logarithmic scale, inconsistent hierarchical values for a treemap.)

2012-06-11

Displaying data in charts

Rsstriction

Definition

Result

Technical limits of the CVOM Server

Max number of rows

Partial rendering of the dataset

Defined by the administrator

and warning icon and tooltip

Default value = 50,000
Limit for optimal rendering Calculated by CVOM based on the chart type and size

Alert icon and tooltip with optimization guidelines

17.6.4.1 To display warning icons in charts
You must be in Design mode. You must open the "Format Chart " dialog box.
1. Select Chart Block.
2. Do the following:
a. In the Web interface, select the General page.
b. In the Rich Internet Application (Java applet) and in Web Intelligence Rich Client, select the
Global page.
3. Check Show Warning Icons.
The warning icons will now be displayed.

17.6.5 To insert and format a chart title
You must be in Design mode. You must open the "Format Chart " dialog box.
Information about the title can be changed in two places: In Chart Area > Chart block > Area Display, you can only display or hide the title, type a label for the title or use a formula, and modify/define the title position. In Select Chart Area > Title > Design, you can modify all the settings for the title.
1. Click Adjust Layout to see more options. For the chart title width and length, fixed is an absolute value and proportional is a percentage of the chart size.
2. For the border and background colors, you can select either a color and transperancy or define a gradient. If you choose a color, a slider appears for you to choose the transperancy value. 0% is transparent and 100% is opaque.

224

2012-06-11

Displaying data in charts

Related Topics
• To format a chart

17.6.6 To display a chart with a 3D look
You must be in Design mode. You must open the "Format Chart" dialog box.
1. Select the chart, right-click and select Format Chart.
a. In the Web interface, select Chart Block > Palette Style Type
b. In the Rich Internet Application (Java applet), select Global > Palette and Style
2. Select 3D look.
Some types of bar charts (where bar display effects have been activated) do not look very attractive if they also use 3D look.
Related Topics
• To format a chart

17.6.7 Assigning colors to charts
You can select a chart series or a legend item and assign it a color using the "Format" Toolbar. The color assignment is saved with the chart; you can reset all colors by applying a palette to the chart
Rules for conservation at Turn Into:
• The dimension driving legend color (assigned to Region Color or Pie Selector Color) must be the same. • The legend items must be the same (no adding or removing a dimension driving Region shape).
Note:
•
•

You cannot assign colors to dual value axis charts.
The series selection feedback is not available in DHTML. The feedback on a selected chart instance is only available in Web Intelligence Rich Client and Applet.

17.6.8 To add background colors to a chart
You must be in Design mode. You must open the "Format Chart" dialog box.

225

2012-06-11

Displaying data in charts

1. Select the chart, right-click and select Format Chart.
a. In the Web interface, select Chart Block > Background
b. In the Rich Internet Application (Java applet), select Global > Background
2. Select either a color and transperancy or define a gradient. If you choose a color, a slider appears for you to choose the transperancy value. 0% is transparent and 100% is opaque.
Related Topics
• To format a chart

17.6.9 To modify chart borders
You must be in Design mode. You must open the "Format Chart "dialog box.
1. Select the chart, right-click and select Format Chart.
a. In the Web interface, select Chart Block > Border
b. In the Rich Internet Application (Java applet), select Global > Border
2. Use the Border Editor to format the borders.
Related Topics
• To format a chart

17.6.10 To format the Plot Area background
You must be in Design mode. You must open the "Format Chart " dialog box.
The options available vary depending on the type of chart.
There are two options for grid and background:
•

Plain background
• Background color
• Grid color for vertical / horizontal grids (note that the grid options slightly differ depending on the chart type: no grid for pies, radial/concentric grid for radars and specific options, three grids for
3D chart)

•

Striped background (no grid definition, but alternate colors). The striped background option may not be available depending on the chart type (e.g. Pies and 3D charts)
1. Select Chart Area > Plot Area > Background.
2. Adjust the Background color.

226

2012-06-11

Displaying data in charts

3. Select whether you want a gradient or not.
Related Topics
• To format a chart
• To format the axis grid

17.6.11 To show and format chart legend
You must be in Design mode. You must open the "Format Chart " dialog box.
Information about the title can be changed in three places: In Chart block > Area Display, you can only display or hide the legend and the legend title. In Legend > Design, you can modify all the settings for the legend. In Legend > Title, you can format the legend title.
1. In the "Design" tab, you can make the legend visible or not, adjust the symbol size, postion and layout, group by dimension, adjust the text settings and border and background settings.
2. In the "Title" tab, you can choose show or hide the title of the legend, and choose Automatic Title or Custom Title. Custom Title allows you to define a formula to be used for the Legend title.
Related Topics
• To format a chart
• Formulas in chart elements

17.6.12 To avoid page breaks in charts
You must be in Design mode. You must open the "Format Chart " dialog box.
•

Open Layout, select Avoid page breaks in chart. It can be selected for both horizontal and vertical breaks. Related Topics
• To format a chart

17.6.13 To manage stacking options
You must be in Design mode. You must open the "Format Chart " dialog box.

227

2012-06-11

Displaying data in charts

Globally stacked means that the measures are also stacked.
100% stacked is transversal to the selected stacking mode.
Because the stacking is done axis by axis, you can choose to stack some data and not other data. (for instance, stacking bars, but not lines.)
1. Select Value Axis > Design .
2. Under "Stacking", select "Unstacked", "Stacked Chart", or "Globally Stacked Chart".

17.6.14 To assign axis labels in data values
You must be in Design mode. You must open the "Format Chart " dialog box.
1. Select Chart block > Data Values.
2. Check Data label displaying mode.
3. Select the appropriate Data Type.
4. You can also change the other Data Value settings on this page.
Related Topics
• To format a chart
• To show or hide data values

17.6.15 To format axis label text, borders, and background
You must be in Design mode. You must open the "Format Chart " dialog box.
1. Select Category Axis or Value Axis.
2. Select Design to make the axis visible. Under "Layout", you select whether to display axis, show labels, the orientation of the labels and other settings.
3. Under "Color Options", select the axis color, grid color, grid background color, and the text options.
Related Topics
• To format a chart

17.6.16 To format the axis grid

228

2012-06-11

Displaying data in charts

You must be in Design mode. You must open the "Format Chart " dialog box.
1. Select Category Axis > Design.
2. Under "Layout", select "Automatically Reduce Font Size of Labels displayed in grid".
3. Under "Color Options", select the "grid color" and "grid background color".
Related Topics
• To format a chart

17.6.17 To format axis values, numbers and text
You must be in Design mode. You must open the "Format Chart " dialog box.
1. Select Category Axis or Value Axis.
2. Select Design to format axis values, numbers, and text.
3. Under General, you can select that the axis is visible.
4. Under "Layout", you can display the axis, show labels, change the orientation, adjust label, automatically reduce the font size of labels displayed in grid, reverse order on the category axis, set the axis label delete mode and show continuous axis layout.
5. Under "Color Options", you can set the axis color, grid color and grid background color.
6. Under "Text", you can choose the font and the text policy (wrap or truncate).
7. Under "Number""Format Pattern", select the pattern you want for your numbers. (This only appears where you have numbers.)
Related Topics
• To format a chart

17.6.18 To show a specific range of axis values
You must be in Design mode. You must open the "Format Chart " dialog box.
Note:
Overscaling - a specific display indicates that a bar is incomplete. (Its value is out of the axis Max/Min values.) 1. Select Value Axis, Design.
2. Under Scaling, enter the "Minimum Value" and the "Maximum Value".
The application displays the minimum and/or maximum values you specified on the axis.

229

2012-06-11

Displaying data in charts

Related Topics
• To format a chart

17.6.19 Linear and logarithmic axis scales
By default, the application displays the Value axis on charts as a linear scale. You can set the axis to a logarithmic scale. Logarithmic scales allow you to examine values that span many orders of magnitude without losing information on the smaller scales.
In a linear scale, the axis markers are evenly spaced. Linear scales are based on addition. Consider, for example, the linear sequence: 1, 3, 5, 7, 9
To get the next number in the sequence, you add 2 to the previous number.
Logarithmic scales are based on multiplication rather than addition. In a logarithmic scale, the steps increase or decrease in size. Logarithmic scales are based on multiplication (or division). Consider, for example, the logarithmic sequence: 2, 4, 8, 16, 32
To get the next number in the sequence, you multiply the previous number by 2. We can say that this sequence represents ``base 2.''
Consider the following sequence: 1, 10, 100, 1000, 10000
This sequence represents ``base 10,'' because you get the next term in the sequence by multiplying the previous term by 10.

17.6.19.1 To display the Value Axis logarithmically
You must be in Design mode. You must open the "Format Chart " dialog box.
Note:
If you have a negative data value, a warning icon appears, if you have activated the warning icons.
1. Select Value Axis > Design.
2. In "Axis Scaling", select Logarithmic.
A logarithmic scale uniformly presents percent changes rather than point changes. In other words, the distance from 1 to 2 (100% increase) is the same as the distance from 2 to 4 (another 100% increase). Related Topics
• To format a chart
• Linear and logarithmic axis scales

230

2012-06-11

Displaying data in charts

17.6.20 Displaying and formatting chart data

17.6.20.1 To hide an empty chart
You must be in Design mode. You must open the "Format Chart " dialog box.
Sometimes charts display no values. For example, if sales of a specific product are discontinued, a chart that normally displays results for that product will appear empty. By default, the application displays such empty charts on reports. If wished, you set the application to hide charts whenever they are empty.
1. Select the Chart block > General tab.
2. Select Hide always to hide the chart.
3. Select Hide when empty to hide the chart when it is empty.
4. Select Hide when following formula is true and type a formula in the box to hide the chart when the formula is true.
Related Topics
• To format a chart

17.6.20.2 To exclude rows containing zero values in tables and charts
You must be in Design mode. You must open the "Format Chart " or Format table dialog box.
Rows that contain zero values or sums that are zero can be suppressed from charts since the data may not be useful. You can include rows that contain measure values that are zero, or where any sum or measure values is zero, or both.
When this option is disactivated, there will be no row in the table or item/detail in the chart. The zero values are suppressed. Sum is mostly used in crosstables.
1. Select the General tab.
2. In the Display section, unselect Show rows for which all measure values = 0 if you want to suppress measure values that are equal to zero.
3. In the Display section, unselect Show rows for which all sums of measure values = 0 if you want to suppress measure values where the sum of the measure values is zero. This option applies to crosstables. Your chart or table will exclude the selected data.

231

2012-06-11

Displaying data in charts

17.6.20.3 To specify a palette style for the chart data
You must be in Design mode. You must open the "Format Chart " dialog box.
Note:
Dual axis charts use two color palettes.
1. Select the chart, right-click and select Format Chart.
a. In the Web interface, select Chart Block > Palette Style
b. In the Rich Internet Application (Java applet), select Global > Palette and Style
2.
3.
4.
5.

Select the Color Palette and the percent of transperancy.
Under "Marker", you can also choose symbols, symbol size, symbol palettes, border, border color.
Under "Chart Series Style", you can choose "Bar Effects".
Under "Light and Shadow Effects", you can select many light and shadow effects: offset, color, shadow, and 1-sided shadow.

Related Topics
• To format a chart

17.6.20.4 To apply special effects to bar charts, pie charts, and bubble charts
You must be in Design mode. You must open the "Format Chart " dialog box.
1. Select the chart, right-click and select Format Chart.
a. In the Web interface, select Chart Block > Palette Style
b. In the Rich Internet Application (Java applet), select Global > Palette and Style
2. In "Chart Series Style", you can select an effect. For pie charts, you can choose a texture and an effect. 17.6.20.5 To apply light and shadow effects
You must be in Design mode. You must open the "Format Chart" dialog box.
1. Select the chart, right-click and select Format Chart.
a. In the Web interface, select Chart Block > Palette Style

232

2012-06-11

Displaying data in charts

b. In the Rich Internet Application (Java applet), select Global > Palette and Style
2. In "Light and Shadow effects", you can select an effect.

17.6.20.6 To manage measure-based coloring in Tree maps, Heat maps and Tag
Cloud charts
Associate a measure to the coloring method feed (Rectangle Color for maps, Tags Family for TagCloud).
You must be in Design mode. You must open the "Format Chart " dialog box.
The coloring method determines the color of rectangles or tags based on the value of a reference measure. There are four coloring methods available.
•

Palette coloring: You can define the number of ranges and the colors are associated automatically based on the selected palette. You can also define range definition and the color for null or empty values. • Gradient-based palette coloring: Additionally, for this coloring you can define a 2 or 3 color gradient associated to the ranges.
• Gradient-based palette coloring using measure polarity: Additionally, for this color you can define a
2 or 3 color gradient associated to Measure with Neutral Polarity.
• Custom range coloring: You can define the ranges manually and associate the colors by either percentage or absolute value.
1. Select the chart, right-click and select Format Chart.
a. In the Web interface, select Chart Block > Palette Style
b. In the Rich Internet Application (Java applet), select Global > Palette and Style
2.
3.
4.
5.

Select a coloring method and define the number of color ranges.
If needed, define a range for the measure values and associate a color to out of range values.
Select a color for null or empty values.
Define the gradient for gradient methods or associate a color to each range for the custom method.
For custom range coloring, define the Maximum and Minimum values of the color ranges. (It is automatic for other methods)

17.6.20.7 To show or hide data values
You must be in Design mode. You must open the "Format Chart " dialog box.
1. Select the chart, right-click and select Format Chart.
a. In the Web interface, select Chart Block > Data Values

233

2012-06-11

Displaying data in charts

b. In the Rich Internet Application (Java applet), select Global > Data Values
2. Select Data label displaying mode to show the data.
3. You can adjust the settings for various parameters, depending on the chart type. For instance for a pie chart, select the data type, the data position, border size, background color, etc.
Related Topics
• To format a chart

17.6.20.8 To format data markers
You must be in Design mode. You must open the "Format Chart " dialog box.
1. Select the chart, right-click and select Format Chart.
a. In the Web interface, select Chart Block > Palette Style
b. In the Rich Internet Application (Java applet), select Global > Palette and Style
2. Under "Marker", you can select symbols, symbol size, symbol palettes, mono symbol, border, and border color.
Related Topics
• To format a chart

234

2012-06-11

Formatting numbers and dates

Formatting numbers and dates

18.1 Predefined and custom formats
You can change how values display in specific cells or on chart axes. You do this by applying predefined formats available in the application or by creating your own custom formats. You can save your custom formats for reuse on multiple blocks and reports in the same document.

18.1.1 Predefined formats
You can change how values display in specific cells or on chart axes. You do this by applying predefined formats or by creating your own custom formats. You can save your custom formats for reuse on multiple blocks and reports in the same document.
The following predefined formats are available for cells:
Format

Description

Default

The format defined for the object on the universe.

Number

Formats for decimal or integer values.

Currency

Formats for currency values.

Date/Time

Date and time formats.

Boolean

Formats for true and false values.

Related Topics
• To apply a custom number format to a cell
• To define a custom format

235

2012-06-11

Formatting numbers and dates

18.1.1.1 To apply a predefined format to a cell
1. Click Design to work in Design mode.
2. Select the cell.
3. Click Format > Numbers > Custom and select the format from the list.

18.1.2 Custom formats
You can use the Custom format type to define a customized format for any cell.
Note:
You cannot apply custom formats to numbers in the Web interface (DHTML interface).
The following table lists the strings you can use to create custom formats:
Character(s)

Display(s)

Example

#

The corresponding digit. If the number has less digits than the number of # characters used to specify the format, no leading zeros are inserted.

‘12345’ with the format #,##0 gives ‘12,345’ (if your locale defines the grouping separator as a comma) or ‘12 345’ (if your locale defines the grouping separator as a space)

0

The corresponding digit. If the number has less digits than the number of 0 characters used to specify the format, a leading zero(s) is inserted before the number. ‘123’ with the format #0,000 gives ‘0,123’

The grouping separator as defined by your locale.

‘1234567’ with the format #,##0 gives ‘1,234,567’ (if you locale defines the grouping separator as a comma) or ‘1 234 567’ (if your locale defines the grouping separator as a non-breaking space) ,

236

2012-06-11

Formatting numbers and dates

Character(s)

Example

.

The decimal separator as defined by your locale.

‘12.34’ with the format #.#0 gives ‘12.34’ (if your locale defines the decimal separator as a period) or ‘12,34’ (if your locale defines the decimal separator as a comma)

[%]%

Displays a percentage sign (%) after the result and multiplies the result by 100.

0.50 becomes 50%.

%

The % sign after the result, but does not multiply the result by
100.

0.50 becomes 0.50%

A non-breaking space ( )

‘1234567’ with the format # ##0 gives ‘1234 567’

1, 2, 3, a, b, c, $, £,
€ (and so on)

The alphanumeric character.

‘705.15’ with the format $#.#0 gives ‘$705.15’ or with the format #,#0 € gives ‘705,15 €’

[Red], [Blue], [Green],
[Yellow], [Gray],
[White], [Dark Red],
[Dark Blue], [Dark
Green]

The value in the specified color.

‘150’ with the format
#,##0[Red] gives ‘150’
#,##0[Blue] gives ’150’

Day/date characters

(day, date)

d

The number of the day in the month with no leading zeros. If the date for day is less than two characters, the date displays without a zero before it.

The first day of a month with the format d gives ‘1’

dd

The number of the day with leading zeros. If the date for day is less than two characters, the date displays with a zero before it. The first day of a month with the format dd gives ‘01’

ddd

The name of the day abbreviated. The first letter is capitalized.

Monday’ with the format ddd gives ‘Mon’

dddd

237

Display(s)

The name of the day in full. The first letter is capitalized.

‘Monday’ with the format dddd gives ‘Monday’

2012-06-11

Formatting numbers and dates

Character(s)

Example

dddd dd

The day of the week followed by a space and the number of the day. ‘Monday’ with the format dddd dd gives ‘Monday 01’

Calendar characters

(month, year)

M

The number of the month with no leading zeros. If the number for month is less than two characters, the number displays without a zero before it.

‘January’ with the format M gives
'1'

MM

The number of the month with leading zeros. If the number for month is less than two characters, the number displays with a zero before it.

‘January’ with the format MM gives 01

mmm

The name of the month abbreviated. The first letter is capitalized.

‘January’ with the format mmm gives Jan

mmmm

The name of the month in full.
The first letter is capitalized.

‘January’ with the format mmmm gives January

yy

The last two digits for year.

‘2003’ with the format yy gives
‘03’

yyyy

All four digits for year.

‘2003’ with the format yyyy gives ‘2003’

Time of day caracters

(hours, minutes, sec onds, am/pm)

hh:mm:ss a

The hour with no leading zeros and the minutes and seconds with leading zeros. The “a" character displays AM or PM after the time when available.

‘21:05:03’ with the format hh:mm:ss a gives ‘9:05:03 PM’ for English locale

HH

The hour according to the 24hour clock.

‘21:00’ with the format HH gives
‘21’

hh

The hour according to the 12hour clock.

‘21:00’ with the format hh gives
‘09’

HH:mm

238

Display(s)

The hour and minutes with leading zeros.

‘7.15 am’ with the format HH:mm gives ‘07:15’

2012-06-11

Formatting numbers and dates

Character(s)

Display(s)

Example

HH:mm:ss

The hour, minutes, and seconds with leading zeros.

‘7.15 am’ with the format
HH:mm:ss gives ‘07:15:00’

mm:ss

The minutes, and seconds with leading zeros.

‘07:15:03’ with the format mm:ss gives ‘15:03’

18.1.2.1 To define a custom format
1. In Design mode, click Format > Numbers
2. Click Custom to display the "Custom Format" dialog box.
3. Select a format listed in the Properties pane, and then edit the selected format by typing additional characters in one or more text boxes.
For example, if you want to create a custom format for Number values, type the custom format you want in the Positive, Negative, and Equal to Zero boxes. If you want to create a custom format for
Boolean values, type the custom format you want in the True and False boxes.
4. Click Add.
You cannot delete or edit custom formats. To change a custom format, you need to create a new custom format and apply the new format to the selected cells. Any custom formats not applied to cells in a document are deleted automatically when you end your session.

18.1.2.2 To apply a custom number format to a cell
1. Select the cells to which you want to apply the custom format.
2. Click Edit on the main menu.

18.2 To format a number as a currency
1. Click Design to work in Design mode.
2. Select the cell.
3. Click Format > Numbers > Currency and select the currency from the list.

239

2012-06-11

Formatting numbers and dates

240

2012-06-11

Highlighting data using conditional formatting

Highlighting data using conditional formatting

Conditional formatting enables you to highlight results or change formatting based on data. You can, for example, conditionally format results to highlight particularly high or low results with specific colors or with text comments, such as “High Performer" or "Low Performer".
You can apply conditional formatting to the following elements:
• Columns in a vertical table
• Rows in a horizontal table
• Cells in forms and cross-tables
• Section headers
• Free-standing cells
You can apply up to 30 conditional formatting rules in a document. You can apply these rules to a maximum of 20 table columns or rows, free-standing cells, or section cells on the reports. You can apply up to 10 different rules on a single table column or row, free-standing cell, or section cell.
You can define conditional formatting rules to activate the following formatting changes:
•
•
•

text color, size and style cell border colors and style cell background display – specific colors, images, or hyperlinks to web pages

You can also define rules that display a text or formula, an image, or a hyperlink. In this case, the results that meet the condition defined in the rule will be replaced by the text or formula.
Conditional formatting is dynamic. When you refresh reports with the latest data from the database, the rules highlight the new results accordingly.
If you apply conditional formatting to a table row or column with a break, the rule is only activated when the value that meets the conditional rule appears on the first row of that break.

19.1 Conditions in conditional formatting
Conditional formatting rules contain multiple conditions, allowing you to apply multiple formats depending on the data. Expressed in words, a conditional formatting rule operates as follows:
If is true, Apply
ElseIf is true, Apply
ElseIf is true, Apply
ElseIf...
Else Apply

241

2012-06-11

Highlighting data using conditional formatting

In the above example, if is Sales Revenue > 100,000 and formats the text in blue, the conditional formatting displays the measure in blue whenever the Sales
Revenue measure is greater than 100,000.
If is Sales Revenue < 10,000 and formats the text in red, the conditional formatting also displays the measure in red whenever its value is less than 10,000.
Each condition can contain multiple tests, and all tests must return True for the conditional formatting to be applied. For example, a condition can test the values of the [Country] and [Resort] objects. Both objects must return the value specified in the test for the formatting to be applied.

19.2 To build a conditional formatting rule
Note:
This option is not available in Web interface (DHTML interface). To create or edit conditional formatting, use the Rich Internet Application interface or the Web Intelligence Rich Client.
You must be in Design mode to build a conditional formatting rule.
1. Select Analysis > Conditional > New Rule to display the Formatting Rule Editor.
2. Type the rule name in the Rule name box.
3. Type the rule description in the Description box.
4. To make the rule act on the content of whichever cells the rule is applied to, select Cell contents in the Filtered object or cell box.
You cannot define a rule on a cell containing a date or numeric type data (for example, a date or a calculation) because the application considers any value you type into the Value text box as a character string.
5. To make the rule act on the value of an object, click ... next to the box and select the object from the list.
6. Select the operator from the Operator list.
7. Enter the value that triggers the formatting rule in the Operands box.
•
•

•

•

To enter a value directly, type it in the box.
To select a value from the list of values of the object you chose in the Filtered object or cell box, click ... to the right of the Operands box, click Select Value on the menu, then select the value in the "List of Values" dialog box.
To select another object or variable as the value, click ... to the right of the Operands box, click
Select an Object or Variable on the menu, then select the object or variable in the "Objects and
Variables" dialog box.
To clear the Operands box, click ... to the right of the box, the select Empty on the menu.

8. To add an additional test within the condition, click + by the existing conditions, then then choose the filtered cell or object, operator and value as described above.
9. To remove a condition, click x in the top right corner of the Condition box.

242

2012-06-11

Highlighting data using conditional formatting

10. To trigger the condition using a formula, click Fx at the top of the Condition box, then type the formula. Click Fx to the right of the formula box to display the Formula Editor, which you can use to build the formula if you wish.
• If you want your formula to return a text string, do not include quote marks before or after the text. For example, if you want the alerter to display OVERDUE, then type: OVERDUE.
• The formula must return True or False. True triggers the condition; False does not. For example, if the formula is RowIndex()=3, the conditional formatting appears on the fourth row of the table.
11. To add an additional condition to the rule, click + at the top left corner of the Condition box to display an Else Condition box., then define the conditions or build a formula as described above.
You can add multiple Else conditions to a condition.
12. To set the format that appears when the rule is triggered, click Format then use the Formatting
Rules Display dialog box to set the format.

19.3 To set the format displayed by a conditional formatting rule
Note that when you select Read content as: HTML, the two properties Autofit Width and Autofit Height do not work because the size of the HTML data in a cell cannot be decoded by the browser properly.
The HTML content that is provided by the user is rendered by the browser directly. Our application does not modify the HTML code that is provided by the user to set the Width and Height.
1. Build the rule, then click Format in the "Formatting Rule Editor" dialog box to display the "Formatting
Rule Display" dialog box.
2. To display text or a formula, select the Display tab and build the formula in the box.
3. To interpret the displayed text or formula as HTML, an image URL or a hyperlink, click Read content as, then select HTML, Image URL or Hyperlink from the list.
4. To change the number format, select the format from the Format Number list or click Custom and select the format from the "Format Number" dialog box.
5. To change the font style, click the Text tab, and define the font using the controls in the tab.
6. To change the background style, select the Background tab then define the background using the controls in the tab.
7. To change the border style, select the Border tab and define the border using the controls in the tab. 19.4 To apply conditional formatting
You must be in Design mode to apply conditional formatting to a document.
You can apply previously-defined conditional formatting rules to report elements. You can format the following report elements:
• Columns in a vertical table

243

2012-06-11

Highlighting data using conditional formatting

•
•
•
•

Rows in a horizontal table
Cells in forms and cross-tables
Section headers
Free-standing cells

1. Select the report element you want to conditionally format.
2. Select Analysis > Conditional > Formatting Rules and check the rule you want to apply from the list. 19.5 To manage conditional formats
Note:
This action is not possible in the Web interface (the DHTML interface).
You must be in Design mode to manage conditional formatting rules.
1. Select Analysis > Conditional > Formatting Rules > Manage Rules to display the "Conditional
Formats" dialog box.
2. To give a rule higher or lower priority in the list, select the rule and click the Up or Down button to the side of the list. Rules are applied from low priority up to high priority.
3. To duplicate a rule, select the rule and click Duplicate.
4. To remove a rule, select the rule and click Remove.

19.6 Using formulas to create advanced conditional formatting rules
You can build advanced conditional formatting rules using the formula language rather than using the
Filtered object or cell, Operator and Value choices offered by in the "Formatting Rules Editor".
Example: Highlighting three ranges of quarterly sales revenue results calculated as percentages of the average sales revenue
In this example, you build three rules to color-code sales revenues, depending on their relationship to the average sales revenue. The table includes results for three years, and this is the average to which you want to compare each sales revenue result calculated per quarter per product line.
Using the Formula option in the "Formatting Rules Editor", you build the following rule, which contains three conditions The conditions are as follows:
Condition:
[Sales revenue] < ((Average([Sales revenue]) In Block) * 0.8)

244

2012-06-11

Highlighting data using conditional formatting

Else Condition:
=[Sales revenue] < ((Average([Sales revenue]) In Block) * 1.2)

Else Condition:
=[Sales revenue] > ((Average([Sales revenue]) In Block) * 1.2)

The formula you specify for each condition works as follows:
• The first condition applies when sales revenues are are < 0.8, or 80%, of the average.
• The second condition applies when sales revenues are < 1.2, or less than 120%, of the average.
• The third applies when sales revenue are > 1.2, or greater than 120%, of the average.
You then use the "Formatting Rules Display" dialog box to specify the conditional formatting you want displayed in report cells that meet one the conditions. You choose the following formatting:
•
•

•

Report cells containing sales revenue that is less than 80% of the average revenue (the first condition) display the revenue in red.
Report cells containing sales revenue that is less than 20% above the average revenue (the second condition) display the revenue in blue. Note that this condition covers values also covered by the first condtion. For example, if the average is 100, 79 is both less than 80% below the average and less than 20% above the average. In this case, the first condition takes precedence.
Report cells containing sales revenue that is greater than 20% above the average revenue (the third condition) display the revenue in green.

This formatting enables you to see at a glance which product lines are generating above average, below average, or close to average sales revenue.

245

2012-06-11

Highlighting data using conditional formatting

246

2012-06-11

Filtering report data

Filtering report data

20.1 Report filters defined
You can filter reports to limit the results that are displayed to specific information that interests you. For example, you can limit the displayed results to information for a specific customer or a sales period.
The data you filter out remains in the document; it is simply not displayed in the report tables or charts.
This means you can change or remove report filters in order to view the hidden values, without modifying the query behind the document.
You can apply different filters to different parts of a report. For example, you can limit the results in the entire report to a specific product line and then limit results in a table or chart further to focus on results for a specific region or customer profile.
To create a report filter, you need to specify the following elements:
• a filtered object
• an operator
• filter values
• the report element to be filtered (the whole report, sections, or blocks)
In the left hand panel of the interface, you can display a special view of filters in the "Document Structure and Filters" tab, which allows to see the structure of the document and the report elements that are filtered and by which operator and value.
Related Topics
• Applying filters to sections

20.2 Query filters and report filters compared
You can apply filters at two levels within a document:
•
•

247

query filters – these filters are defined on the query; they limit the data retrieved from the data source and returned to the document. report filters – these filters limit the values displayed on reports, tables, charts, sections within the document, but they don’t modify the data that is retrieved from the data source; they simply hide values at the report level.

2012-06-11

Filtering report data

20.3 Report filter operators

20.3.1 Equal To operator
Use the Equal to operator to obtain data equal to a value.
For example, to return data for the US only, create the filter "County Equal To US".

20.3.2 Not Equal To operator
Use the Not Equal To operator to obtain data not equal to a value.
For example, to return data for all countries except the US create the filter "County Not Equal To US".
Note:
This operator cannot be used for OLAP unx universe parent-child hierarchies, or for BEx queries.

20.3.3 Different From operator
Use the Different From operator to retrieve data different from a value.
For example, to retrieve data for all quarters except Q4, create the filter [Quarter] Different From "Q4"
Note:
This operator is not available in the Rich Internet Applicatioin interface, or in Web Intelligence Rich
Client.

20.3.4 Greater Than operator
Use the Greater Than operator to retrieve data greater than a value.

248

2012-06-11

Filtering report data

For example, to retrieve data for customers aged over 60, create the filter "[Customer Age] Greater than 60".
Note:
This operator cannot be used for OLAP unx universe parent-child hierarchies, or for BEx queries.

20.3.5 Greater Than Or Equal To operator
Use the Greater Than Or Equal To operator to retrieve data greater than or equal to a value.
For example, to retrieve data for revenue starting from $1.5M, create the filter "[Revenue] Greater than or equal to 1500000".
Note:
This operator cannot be used for OLAP unx universe parent-child hierarchies, or for BEx hierarchies.

20.3.6 Less Than operator
Use the Less Than operator to retrieve data lower than a value.
For example, to retrieve data for exam grades lower than 40, create the filter "[Exam Grade] Less Than
40".
Note:
This operator cannot be used for OLAP unx universes, and hierarchies in filters, or for hierarchies in
BEx queries.

20.3.7 Less Than Or Equal To operator
Use the Less Than Or Equal To operator to retrieve data less than or equal to a value.
For example, to retrieve data for customers whose age is 30 or less, create the filter "[Age] Less Than
Or Equal To 30".
Note:
This operator cannot be used for OLAP unx universes and hierarchies in filters, or for hierarchies in
BEx queries.

249

2012-06-11

Filtering report data

20.3.8 Between operator
Use the Between operator to retrieve data between two boundary values (including the two boundary values). The first value declared must be lower than the second value.
For example, to retrieve data for weeks starting at week 25 and finishing at 36 (including week 25 and week 36), create the filter "[Week] Between 25 and 36".
Note:
This operator cannot be used for OLAP unx universe and for BEx hierarchies in filters.

20.3.9 Not Between operator
Use the Not Between operator to retrieve data outside the range of two values.
For example; to retrieve data for all the weeks of the year, except for and not including weeks 25 through
36, create the filter "[Week] Not between 25 and 36".
Note:
This operator cannot be used for OLAP unx universe and for BEx hierarchies in filters.

20.3.10 In List operator
Use the In List operator to retrieve data corresponding to values in a list of values.
For example, to retrieve data for the US, UK and Japan only, create the filter [Country] In List, when you can type values in the "Type a value" field, you have to enter: US;UK;Japan.
When used in a query filter with a hierarchical list of values (either from a dimension associated with a hierarchical list of values or a hierarchy object), In List allows selection of multiple members from any levels of the hierarchy. For example, a prompt on the [Geography] hierarchy using the In List operator allows selection of [Paris] at the City level and [Canada] at the Country level in the prompt.
When used in a report filter, In List produces a flat list of values.

250

2012-06-11

Filtering report data

20.3.11 Not In List operator
Use the Not In List operator to retrieve data that does not correspond to multiple values.
For example, if you do not want to retrieve data for the US, UK and Japan, create the filter [Country]
Not In, when you can type values in the "Type a value" field, you have to enter: US;UK;Japan.
When used with a hierarchical list of values (either from a dimension associated with a hierarchical list of values, a hierarchy object or a level object), In List allows selection of multiple members from any levels of the hierarchy. For example, a prompt on the [Geography] hierarchy using the Not In List operator allows selection of [Paris] at the City level and [Canada] at the Country level in the prompt.
Note:
This operator can only be used in certain types of hierarchies - for example, it can be used in level-based hierarchies. 20.3.12 Is Null operator
Use the Is Null operator to retrieve data for which there are no values in the database.
For example, to retrieve customers without children (the children column in the database has no value), create the filter [Children] Is Null.

20.3.13 Is Not Null operator
Use the Is Not Null operator to return data for which there is a value in the database.
For example, to return customers with children, create the filter [Children] Is not Null.

20.4 Types of report filter
Report filters are filters that can be applied on different report elements: report, section, table, graph.There are two types of report filter:
•

251

Standard report filters.

2012-06-11

Filtering report data

Standard report filters are the most flexible type of report filter. They can use any filter operator and can filter on single values or lists of values.
•

Simple report filters.
Simple report filters provide an easy way to create filters using the Equal To operator. They can filter on single values only, and are applied to a whole report (not an entire document or report element).

20.5 To create, edit, and delete standard report filters
1. Select the report element you want to filter.
a. In the Web interface (DHTML interface) click Filter > Add filter.
b. In the Rich Internet Application interface and in Web Intelligence Rich Client, select Analysis >
Filters, then click on the Filter List box.
2. Click Add Filter on the dialog box to display the objects you can filter.
3. Select the objects you want to filter and click OK.
If you selected more than one object the filtered objects appear in an AND relationship. Double-click the AND operator to change it to OR.
4. For each filter, select the filter operator from the list.
5. Type values directly in the box above the list of values of the object, or select values from the list and click > to add them to the list of filtered values on the right.
The values you can type or select depend on the operator. For example, if you select the Equal To operator, you can type or select one value only.
If the filtered object is a hierarchy, the values are displayed hierarchically. All members of the hierarchy are visible even if they are collapsed in the report. You must select hierarchy members from the hierarchy - you cannot type them manually. All member values that have been selected in the query panel are displayed in grey and can't be selected if they are not in the final report because thay are not linked to any measures. To help you select the right values, you can also click on the key icon to see both the text and key id value for the members.
If the filtered object is a level, the values are displayed in a list. It is not possible to type the values.
6. Click OK to apply the report filter to the element.
7. To edit a report filter, select the report element and select Analysis > Filter > Edit Filter and edit the filter using the dialog box.
8. To delete a report filter, select the report element and select Analysis > Filter > Remove Filter.
You use this to remove all filters for the selected report element. To remove only one filter you have to pop up the dialog box, select the filter and click on the Remove Filter icon.

252

2012-06-11

Filtering report data

20.5.1 To select values from a list
In a query, values in a list of values can appear either as a single-column list, a multicolumn list, or a hierarchy, depending on the object. In a multicolumn list, additional columns provide related values to the main value. In a hierarchical list, values appear in a hierarchical relationship.
In a report, values appear in a flat list without multiple columns.
1. If the list of values does not display when the dialog box opens, refresh the list, or search the list to retrieve values. (See later in this topic for details of searching lists of values.)
Some list of values require an initial search to display values because the list is too large to be loaded in full.
2. If the list of values is divided into ranges, use the control above the list to navigate through the ranges. Some large lists of values are divided into ranges to reduce the amount of data retrieved from the database. When you select a range, the list displays the values in that range.
3. If the list of values depends on other lists of values, specify the dependent values first in the prompt dialog box that displays.
A list of values can be dependent on other lists of values, for example when it is part of a hierarchical list of values. For example, if the list of values contains cities, and the City object is part of the hierarchy Country > Region > City, you need to specify values for country and region first to filter the list of cities.
Note:
Dependent lists of values appear in queries only. They do not appear when you are selecting from a list of values in a report.
When you first display the list of values, you see the Prompt dialog box that you use to specify the dependent values. Once you have specified the dependent values, you can select the values from the filtered list.
4. To display the value keys, click Show/hide key values.
Key values are not indicated in the list of "Selected Values", only in the list of available values. Some lists of values contain key values, which are unique values that can be used to identify values with the same display value. If the list of values contains multiple columns, only the key of the filtering column is displayed.
5. To search for values in the list, type the search text in the box below the list and select the Match case, Search in keys or Search on database option.

253

2012-06-11

Filtering report data

Option

Match case

Description

The search is case-sensitive.
This option is not available when the Search in keys or Search on database options are selected.

Search in keys

The search uses unique value keys rather than display values.
This option is available only on lists of values that support key values.

Search on database The search inclues all values stored in the database rather than being restricted to the values loaded into the list. It improves search accuracy but reduces search speed.
This option is available only on lists of values that support database searches.
Database searching improves search accuracy at the cost of performance. It is useful when not all values in the list of values were retrieved. This can happen when the total number of values in the list exceeds the Max rows retrieved query property.
Database searching is particularly useful when the list of values is hierarchical because values are loaded from the database only in response to their parent value being expanded in the hierarchy. For example, in a geographical hierarchy, the child values of the California value (cities in California) are not loaded from the database until the value is expanded. If the option is selected, the search includes these items even when the California value has not been expanded.

The search includes all ranges if the list of values is divided into ranges.
In search patterns, the '*' wildcard represents any string of characters and the '?' wildcard represents any single character. For example, the value "March" can be returned by the search patterns "M*" or "Mar?h". To include the "*" and "?" characters literally rather than as wildcards, precede them with "\" in the search pattern.
6. Type values from the list directly (if the list supports direct data entry) or select values from the list.
Related Topics
• Max rows retrieved query property

20.6 To create simple report filters

254

2012-06-11

Filtering report data

The Report Filter toolbar provides a quick method for adding simple report filters to reports. Simple report filters apply to the report (and not the document, or specific objects in the report), and only apply to the following:
• Only dimension or detail objects for relational query.
• Hierarchies, characteristics or attributes for UNX OLAP or BEx queries (but not on hierarchy level or on measures).
Simple report filters have the form =. They can contain the "Equal To" operator only and can filter on a single value only. They can be also of type "All Values" operator.
For more complex filters, use standard report filters, which can contain any operator.
Note:
•
•

You also use the Report Filter toolbar when drilling on reports. In the context of Drill, the Report
Filter toolbar is known as the Drill toolbar.
When opening the filter bar, filters are automatically inserted when their report scopes are:
• Single value ("Equal To" operator)
• With the "All Values" operator
Those filters are no longer displayed in the Filter box.

•

When collapsing the Filter Bar, all "simple filters" are put back as "Equal To" or "All Values" Report
Filters (they filter on the entire report). To avoid creation of "All Values" filters, you can remove the object from the filter bar before you collapse it.
1. Click Analysis > Interact > Filter Bar to display the toolbar.
2. Click the icon on the toolbar and select the object on which you want to filter from the menu.
You can add multiple objects to the toolbar to create multiple filters.
Note:
Depending on the data sources and selected objects, the values or objects available in a filter may depend on the values set in another filter object.
3. Select the value on which you want to filter from the drop down list of values.
Note:
For non-hierarchical objects, the list contains all values contained in the report for this object after applying all other report scope filters (For example if you have an "in List" filter reducing this object values, you will have this list of values for your Filter Bar "Equal To" filter).
For Hierarchical objects, the list contains the flat list of all member values at any level. This list is in treeview like order (not alphabetical order).
The report is filtered on the value of the object you selected. For example, if you selected "US" from the list of values of the Country object, the report is filtered to exclude all rows where Country does not have the value "US".
4. To remove a filter:
a. In the Web interface, select it and click Remove.
b. In the Rich Internet Application interface, or in Web Intelligence Rich Client, select the filter and drag and drop it in the left panel.

255

2012-06-11

Filtering report data

20.7 To create nested filters
You can create nested filters. A nested filter is a combination of and AND and OR clause.
1. Drag and drop the filter object into the combined filter panel.
2. You can click on the operator to change the type from AND to OR and vice versa.

256

2012-06-11

Filtering data with prompts

Filtering data with prompts

You can filter report data by supplying values for prompts.
The "Prompts" dialog box displays a summary of all the defined prompts in the Prompt summary pane.
You select the prompt you want to answer, and supply values in the Specify values for prompt pane of the dialog box.
Depending on the prompt you select, you type values directly, or select values from a list. A list of values can contain display values only, or the display values and their corresponding database key values.
Database key values are unique values used to identify the display value within the database.
Lists of values can be organized hierarchically if the list was defined as a hierarchy by the universe designer, or the prompt is based on a hierarchy or level object.
Lists of values can be split into ranges to improve performance.
You can search or filter lists of values for easier access to the values you are interested in.
Prompts can be optional or mandatory. If you do not supply a value for an optional prompt, the prompt is ignored. You must supply values for all mandatory prompts before you can filter the data by running the prompts.
Prompts can depend on other prompts. For example, a prompt on a City object can be dependent on a prompt on a Region object. By supplying values to the Region prompt, you restrict the number of possible values of the City prompt.
You can supply values for dependent prompts only when you have supplied values for all the prompts on which they depend. If you wish to supply values to dependent prompts of an optional prompt, you must supply values for the optional prompt

21.1 To supply values for prompts
A prompt has already been defined in the "Filter" pane of the "Query Panel".
1. Refresh the data.
2. Select the prompt in the Prompts summary pane.
3. If the prompt has a list of values and the values are not displayed, click Refresh values to display them. (In this case, the list displays the text "To see the contents of the list, click Refresh Values.")

257

2012-06-11

Filtering data with prompts

If the prompt is dependent on other prompts, the list of values displays links to the dependent prompts.
You must supply values for the dependent prompts before you can supply a value for the current prompt. Groups of dependent prompts appear in separate groups in the Prompt Summary pane.
The values can appear as single values, in multiple columns (where the additional columns supply further information about the main filtering column), or hierarchically, depending on the prompt.
If the list of values is too large to display all at once, the list is split into ranges and a box above the list of values displays the current range. You can scroll through the ranges to see all the values in the list.
4. Select values and click > to supply the values to the prompt, or type values directly if the prompt allows you to do so.
You cannot type values directly if the list of values is hierarchical.
If the prompt requires a date, you can select it from the calendar that appears on the right of the box where you select the value
Note:
SAP Key Dates appear as date prompts, with other prompts in the same data provider appearing as dependent prompts.
5. Repeat the previous step if the prompt allows you to select multiple values.
If a prompt allows you to make multiple selections from a hierarchical list of values, you can select values at different levels of the hierarchy. If the prompt allows single values only, you can select values only from the bottom level of the hierarchy.
If a prompt allows you to type values directly and allows multiple values, you can specify multiple values separated by ";", for example California;Nevada;Iowa. After you have typed or pasted the separated list, click the tooltip that says "Click here to interpret as multiple values." (If you click
>, the list is interpreted as a single value.)
6. Run the query:
a. In the Web interface, click Run Query to run the query.
b. In the Rich Internet Application or in Web Intelligence Rich Client, click OK to run the query.
The report data is filtered based on the selection you made.
Related Topics
• To select values from a list

258

2012-06-11

Filtering data using input controls

Filtering data using input controls

22.1 Input controls defined
Input controls provide a convenient, easily-accessible method for filtering and analyzing report data.
You define input controls using standard windows controls such as text boxes and radio buttons. You associate these controls with report elements such as tables or section headers, and use the controls to filter the data in the report elements. When you select values in the input control, you filter the values in the associated report elements by the values you selected.
You can also define tables and charts as input controls. When you select a value in the table or chart, you filter the values in the associated report elements by the values you selected.
You can use input controls to analyze different scenarios by changing the value of variables. You define a variable with a constant value, then assign an input control, for example a slider, to the variable. You can then change the value of the variable using the slider control; if the variable is part of a formula, you can use the slider control to examine different formula results based on the variable value.
Input controls are report-specific. They are grouped on the Input Controls tab on the Left Pane.

22.2 Using input controls with hierarchical data
You can use input controls on hierarchical data. When you select a node of a hierarchy, you can select a single value and use the operator equal to, or you can select multiple values from a hierarchical tree list.
When you select a hierarchical tree list, right-click on a member and select the member, the children, or the descendants of the hierarchy. The elements of the hierarchies that you select display in the report pane. Refer to the pdf version of the documentation for more information.

22.3 To add an input control
You must have sufficient document modification rights and be in Design mode to add input controls.

259

2012-06-11

Filtering data using input controls

1. Click Analysis > Filters > Controls > Define Control to display the "Select Report Object" screen.
If you selected an entire table or chart before clicking Define Control, you can select Include objects from selected block only to restrict the list of objects in the wizard to the objects in the table or chart you selected.
You can also select the type of input control directly from the list of controls under Analysis > Filters
> Controls instead of selecting Define Control. Those controls not compatible with the data from the report element you selected are disabled. The control is automatically associated with the report object that supplies data to the selected report element and uses its default properties, and you move directly to selecting the report elements you want the input control to filter.
2. Select the report object to supply values for the input control, then click Next.
3. Select the input control type.
The list of control types is determined by the data type of the report object.
4. Define the input control properties.
The available properties are determined by the control type.
Property

Description

Label

The name of the input control

Description

The description of the input control

List of values

The list of values available in the input control. You can use all values of the report object on which the input control is based (the default) or define your own custom list of values.

Use restricted list of values If you define a custom list of values for the report object, this setting filters the data in the report element you assign to the input control based on this list of values. Even when no values are selected in the input control, any values not in the restricted list are excluded from the report element filtered by the input control.
For example, if an input control based on the Country dimension is restricted to the values "US" and "France", a table filtered by the input control shows data for US and France only, even when no value is selected in the input control.
If you deselect Use restricted list of values, all values of Country appear in the table when no value is selected in the input control.

Operator
Default values

The default values that the input control uses to filter the associated report element Number of lines

260

The operator that the input control uses to filter the associated report elements

The number of lines that the input control displays in the Input Control pane. For example a list of five radio buttons with Number of lines set to 3 displays three radio buttons only by default. You access the other two radio buttons by using the scrollbar.

2012-06-11

Filtering data using input controls

Property

Description

Minimum value

The minimum numerical value you can select in the input control

Maximum value

The maximum numerical value you can select in the input control

Increment

The amount by which the input control increases/descreased a numerical value when you are choosing a value

5. Click Next to display the Assign Report Elements wizard step.
6. Select the report elements you want the input control to filter.
Note:
Each time you save a document, any input controls that have no associated report elements are removed. 7. Click Finish.
The input control appears on the Input Controls pane.

22.4 To edit an input control
1. Select the Input Controls tab in the Left Pane.
2. Click Edit on the input control to display the Edit Input Control dialog box.
3. To edit the input control properties:
a. In the Web interface (DHTML interface), edit the input control properties in the Properties tab.
b. In the Rich Internet Application interface and in Web Intelligence Rich Client, edit the input control properties in the Control tab.
4. Edit the report elements associated with the input control on the Dependencies tab.

22.5 To highlight input control dependencies
1. Click the Input Controls tab.
2. Do the following:
a. In the Web interface, click Highlight dependencies on the input control.
b. In the Rich Internet Application interface or in Web Intelligence Rich Client, click Show dependencies on the input control.
The report elements associated with the input control are highlighted.

261

2012-06-11

Filtering data using input controls

22.6 To organize input controls
1. Select the Input Controls tab.
2. Drag and drop input controls to move them up or down on the Input Controls pane.
3. Select an input control, then click Remove at the top of the control to remove it from the Input
Controls pane.

22.7 To view the input controls map
1. Select the Input Controls tab.
2. Click Map at the top of the Input Controls tab.

22.8 Using tables and charts as input controls
You can define tables and charts as input controls. Table- and chart-based input controls appear in the
Input Controls panel in the same way as regular input controls, but you select values in the table or chart itself to filter the dependent report elements. When you select cells, columns or rows in tables, or clickable data areas in charts, the values in the associated report elements are filtered according to the values you selected.
When you click on a table or chart-based control in the Input Controls panel, the table or chart used as an input control is highlighted.
When a report is in drill mode, table- and chart-based input controls are disabled. They are re-enabled when drill mode is deactivated.

22.8.1 To define a table or chart as an input control
1. Select the table or chart, right-click and select Linking > Add Element Link.
2. Select All objects to define all the objects in the table or chart as the filtering objects, or select
Single object and select the object to define a single object in the table or chart as the filtering object. 262

2012-06-11

Filtering data using input controls

Note:
You can select dimensions only as filtering objects when you define a table or chart as an input control. 3. Click Next and type a name and a description for the input control.
4. Click Next and select the report elements to be filtered by the input control.
Note:
You cannot select the table or chart that you are defining as an input control from the list of report elements. 5. Click Finish.
The table or chart input control appears in the Input Controls pane. When you click on Show
Dependencies, the table or chart defined as the input control is highlighted.
6. To modify the way a table or chart filters other report elements, right-click the table or chart and select Linking > Edit Element Link.
7. To remove a link between a table or chart and other report elements, right-click the table or chart and select Linking > Remove.
Related Topics
• To edit an input control

22.9 To filter data using input controls
1. Display the Input Controls pane by selecting the Input Controls tab in the Left Pane.
Note:
The input control displays the message No dependent report elements if the report elements filtered by the input control are no longer in the report.
2. Select values in the input control.
The associated report elements are filtered based on the values you select. For example, if you select the "US" value of the [Country] dimension, the filter operator is Equal To, and there is a table associated with the input control,the table is filtered on the condition [Country] = "US".
3. To filter using a table or chart defined as an input control, select dimension values in the table (rows, columns or cells) or chart (clickable data areas).
Note:
•
•
•

263

Tables or charts defined as input controls can filter using dimension values only.
In the Rich Internet Application interface, a warning message displays when you delete objects used by an input control.
The input control shows the message The table or chart is not in the report if the table or chart is no longer in the report.

2012-06-11

Filtering data using input controls

•

•
•

The input control shows the message Filtering dimensions not available if the filtering dimensions are no longer in the table or chart. The input control becomes usable again if you add the dimensions to the table or chart.
The input control shows the message Control not usuable while the report is in drill mode if the report is in drill mode. Drill mode must be turned off to make the input control usable.
Table- and chart-based input controls are indicated by an icon in the top right-hand corner of the table or chart. Right-clicking the icon displays the following menu:
Command

Description

Edit

Edits the input control

Highlight dependencies (Web interface)

Highlights the report elements filtered by the input control

Show dependencies (Rich Internet Application interface)
Reset

Removes the filters applied by the input control

Disable/Enable

Disables or enables the input control

4. To remove all filters applied by input controls, click Reset at the top of the Input Controls pane.

264

2012-06-11

Enhancing reports with calculations, formulas and variables

Enhancing reports with calculations, formulas and variables 23.1 Calculations, formulas and variables
You can add calculations, formulas and variables (named formulas) to reports. For detailed information on the available calculations, see the Using Functions, Formulas and Calculations in Web Intellligence guide or the online help.

23.2 Working with standard calculations

23.2.1 To insert a standard calculation in a table or cross table
You must be in Design mode to insert calculations.
You can insert standard calculations in tables or cross tables to make quick calculations on table data.
For more information on the standard calculations, see the Using Functions, Formulas and Calculations in Web Intelligence guide or in the online help.
You can insert multiple calculations in a table or cross table. When you apply two calculations to a table or crosstab, a footer is added for each calculation result. You insert multiple calculations in a table or cross table in the same way that you insert one calculation, but you repeat the procedure for as many calculations as you want to insert.
1. Click the table cell that contains the data you want to calculate.
2. Click Analysis > Functions and select the calculation you want to add, or double-click a cell to launch the "Formula Editor".
You can repeat this step to add multiple calculations to the same column.
A footer containing the result of the calculation is added below the column.

265

2012-06-11

Enhancing reports with calculations, formulas and variables

23.2.2 To remove a standard calculation
1. Right-click the cell that contains the calculation.
2. Select a cell in the row or column containing the calculation, right-click and select Delete from the menu. 3. In the dialog box, select Row to delete the row or Column to delete the column.

23.3 Working with formulas

23.3.1 To enter a formula by typing
You must be in Design mode to enter a formula.
1. Click View > Formula Bar in the left pane to display the Formula bar.
2. Type the formula in the Formula box and click Validate to validate it.

23.3.2 To build a formula using the Formula Editor
1. Select the cell where you want to enter the formula.
2. Select View > Formula Bar on the Properties tab to display the Formula Bar.
3. Click the Formula Editor icon on the Formula bar to display the Formula editor.
4. Build the formula using the Formula Editor.

23.4 Working with variables

266

2012-06-11

Enhancing reports with calculations, formulas and variables

23.4.1 To create a variable
You must be in Design mode to create a variable from a formula.
Note:
If a cell is selected before you open the formula editor, the formula you create is assigned to the cell.
1. Click View > Formula bar in the Properties tab to display the Formula bar.
2. Click the Create Variable icon in the Formula Bar to display the Variable Editor.
If the Formula box contained a formula, it appears in the Variable Editor. Otherwise, the Variable
Editor is blank.
3. Type the variable name in the Name box.
4. Build the formula for the variable if it is not already displayed.
5. Select the variable type by selecting Dimension, Measure or Detail.
6. If you select Attribute, an "Associated Dimension" box appears. Click ... next to the box to open the
"Objects and Variables" dialog box and select the dimension you want to associate with the detail.
7. Click OK.

23.4.2 To edit a variable
1. Select the variable in the list of report variables on the Available Objects tab on the Left Panel.
2. Click the right mouse button and click Edit on the shortcut menu.
The Variable Editor appears.
3. Edit the variable.
4. Click OK to save the new variable definition.

23.4.3 To delete a variable
1. Select the variable in the list of report variables on the Available Objects tab on the Left Panel.
2. Click the right mouse button and click Remove on the shortcut menu.

267

2012-06-11

Enhancing reports with calculations, formulas and variables

23.4.4 To rename a variable
This action is possible in the Rich Internet Application and Desktop interfaces, but not in the Web interface. 1. Select the variable in the list of report variables on the "Available Objects" tab in the left panel.
2. Click the right mouse button and click Rename oin the shortcut menu.
3. Rename the variable and save it.

268

2012-06-11

Drilling on report data

Drilling on report data

24.1 Drill defined
You use drill to analyze the results displayed in reports. Drilling on reports lets you look deeper into your data to discover the details behind a good or bad summary result displayed in tables, charts, or sections. Table 24-1: Restrictions
Restriction

Description

Queries on BEx queries

You cannot use drillpath on BEx queries. Navigation path (previously called the drillpath) is replaced by the collapse/expand workflow on the real hierarchy.

Queries on .unv and .unx universes

You can only drill on a .unv or .unx universe if the drill paths are already defined in the universe.

Example: Why did sales of accessories, outwear, and overcoats rise in Q3?
You work for a US national fashion retail chain, and are in charge of sales of accessories, outerwear and overcoat clothing lines in western states. You see that revenue is much higher for Q3 than the other quarters. To understand why, you drill down to look at the factors behind the result and you see that jewelry sales were much higher in July.

24.1.1 Scope of analysis
The scope of analysis for a query is extra data that you can retrieve from the database to give more details on the results returned by each of the objects in a query. This extra data does not appear in the initial result report, but it remains available in the data cube, so you can pull this data into the report to allow you to access more details at any time. This process of refining the data to lower levels of detail is called drilling down on an object.

269

2012-06-11

Drilling on report data

Note:
This option in the Query Panel is only available for relational unx universes and not for OLAP.
In the universe, the scope of analysis corresponds to the hierarchical levels below the object selected for a query. For example, a scope of analysis of one level down for the object Year, would include the object Quarter, which appears immediately under Year.
You can set this level when you build a query. It allows objects lower down the hierarchy to be included in the query, without them appearing in the Results Objects pane. The hierarchies in a universe allow you to choose your scope of analysis, and correspondingly the level of drill available. You can also create a custom scope of analysis by selecting specific dimensions to be included in the scope.
Note:
You cannot set the scope of analysis when working in query drill mode because this drill mode modifies the scope dynamically in response to drill actions.

24.1.1.1 Levels of scope of analysis
You can set the following levels for scope of analysis:
Level

Description

None

Only the objects that appear in the Results Objects pane are included in the query.

•
•
•

For each object in the Result Objects pane, one, two, or three objects lower down the hierarchy tree are included in the query. The data from these objects is stored in the cube until you add them to the document.

One level down
Two levels down
Three levels down

Custom

All objects added manually to the Scope of Analysis panel are included in the query.

Including a scope of analysis in a document increases the document size significantly. This is because the data necessary for the scope you specify is saved with the document, even though it is not visible in the reports unless you start drill mode and drill down to the data to display the corresponding values.
In order to minimize the size of documents and optimize performance, include a scope of analysis only in documents where you are certain that users will need to drill.

24.1.2 To set the scope of analysis

270

2012-06-11

Drilling on report data

1. In the Query Panel, click Scope of Analysis to display the Scope of Analysis pane.
All the dimensions in the Result Objects pane appear in the Scope of Analysis pane. This corresponds to the default scope of analysis - None. (There are no additional levels available for analysis.) 2. Select the analysis level from the Scope level list at the top-right corner of the Scope of Analysis pane. The objects hierarchically below the objects in the Result Objects pane appear in the Scope of
Analysis pane down to the number of levels you selected.
3. To add selected dimensions to the scope of analysis or create a custom scope of analysis, select dimensions in the Query Manager and drag them across to the Scope of Analysis pane.

24.1.3 Drill paths and hierarchies
When you analyze data in drill mode, you move along a drill path. These paths are based on the dimension hierarchies set by the designer of the universe. Universe designers organize objects in classes in a hierarchy with the most summary objects at the top and the most detailed at the bottom.
So if you want to make a high-level report, you know that your query should include objects at the top of the list. If you want to see more detailed information, you can then switch to Drill mode and drill down on each dimension value displayed in the reports.
For example, if the data from [Quarter] did not sufficiently explain a result, you could drill down to [Month] or [Week], depending on how the universe designer set up the hierarchy. When you drill to a different level, measures, such as a [Revenue] or [Margin], are recalculated accordingly.
Drill paths usually follow the same hierarchy order as the classes on a universe. For example, a class called Time typically includes the [Year] dimension at the top of the class, followed by the [Quarter],
[Month], and [Week] dimensions. The hierarchies for drill within the Time hierarchy typically follow the same order, because users want to drill annual results to analyze details for quarter, month, and so on.
However, the universe designer can also define custom hierarchies.
Note:
A dimension can belong to several hierarchies. When you drill a result on a dimension that belongs to more than one hierarchy, you must answer a prompt to select the drill path.

24.1.3.1 To view drill hierarchies
1. In Data or Design mode, click Data Access > Edit to edit the data provider in the Query Panel.
2. Select Display by Navigation Paths in the Query Panel.

271

2012-06-11

Drilling on report data

24.2 Setting drill options
Drilling on reports lets you look deeper into data to discover the details behind a good or bad summary result displayed on a table, chart, or section. Before you begin a drill session, you can set your drill options to specify how reports will change each time you drill. How you set the drill options depends on the interface you are using:
• BI launch pad
• Web Intelligence Rich Client

24.2.1 To set drill options in the BI launch pad
•

In the BI launch pad, click Preferences, click Web Intelligence to display the available options, then select the drill options under Drill options and Start drill session.

24.2.2 To set drill options in Web Intelligence Rich Client
1. Click Properties > Application to display the application properties dialog box.
2. In Web Intelligence Rich Client, click Tools, and select Options from the menu in the top-right corner next to the Help menu to display the "Options" dialog box, select the Drill tab, then select the drill options. 24.3 Drill options explained

24.3.1 Prompt when drill requires additional data option
When you drill the results displayed on a report, you may want to drill to higher- or lower-level information that isn’t included in the scope of analysis for the document. A new query is required to retrieve this data. 272

2012-06-11

Drilling on report data

Since queries on large selections of data may take a long time to be completed, you can choose to be prompted with a message every time a new query is necessary. The prompt message asks you whether you want to run the additional query or not. In addition, the prompt lets you apply filters to the extra dimensions you include in the new query. This means you can restrict the size of the query to only the data necessary for your analysis.
You need permission from your administrator to drill out of the scope of analysis during a drill session.

24.3.2 Synchronize drill on report blocks option
When you select the Sychronize option, the display of all blocks changes to correspond with your drill actions. For example, if you drill down on a block from year to quarter, and your report also contains a chart showing data by year, the chart display also changes to display data by quarter.
If you do not select the option, only the structure of the drilled block changes. Drill filters are applied to the whole report.

24.3.3 Hide drill toolbar option
When you drill on a value displayed on a report, the Drill toolbar appears and displays the value on which you drilled. The value displayed on the toolbar filters the results displayed on the drilled report.
For example, if you drill on year 2010, the results displayed on the drilled table are Q1, Q2, Q3, and
Q4 for year 2010. This means that the quarterly values you drilled to are filtered by 2001.
Note:
The Drill toolbar allows you to select alternative values on the same level, in order to filter the results differently. For example, if you use the Drill toolbar illustrated above to select “2002," the results displayed on the drilled table would be Q1, Q2, Q3, and Q4 for year 2002.
You can opt to hide the Drill toolbar when you start drill mode. The Drill toolbar is only useful if you want to select filters during your drill session.

24.3.4 Start drill session on existing report option
When you select Start drill session on existing report, the current report becomes drillable when you start drill mode. When you end drill mode, the report displays the drilled values.

273

2012-06-11

Drilling on report data

24.3.5 Start drill session on a duplicate report option
When you select Start drill on a duplicate report, you drill on a duplicate of the current report when working in drill mode. This allows you to compare the results of the original report with the results you discover during your drill analysis.

24.4 To switch to drill mode
To start drilling on a report you either switch to Drill mode or, if the report is saved in Drill mode, drill directly. 1. Select the report you want to drill.
2. Click Analysis > Interact > Drill > Start Drill.
Note:
When you open a document that was saved in Drill mode, the document opens in Drill mode if you have the right to drill on documents.
By default, a drill icon appears on the tab of the drillable report. Depending on the drill options you selected on Document Preferences page in the BI launch pad, either the selected report becomes drillable or a drillable duplicate of the selected report is created.
Related Topics
• Start drill session on a duplicate report option

24.5 Retrieving more levels of data to the report
When you are drilling a report, you may want to drill up or down to a dimension that lies outside the scope of analysis defined for the document. Returning the additional data requires running a new query that includes the additional dimensions you specify. This is called extending the scope of analysis.
You can extend the scope of analysis during your drill sessions only if your security profile allows you to do so. Your security profile is controlled by your administrator.
If your Drill options are not set to display the Extend the Scope of Analysis prompt message during drill, you will not be given the option to select filters if you drill beyond the data already available in the document. In this case, the new query runs automatically and returns data for all the values on the dimensions you are drilling.

274

2012-06-11

Drilling on report data

24.5.1 To drill out of the scope of analysis
1. Hold your mouse cursor over a dimension value that is at the end of the scope of analysis.
A ToolTip informs you that a new query is necessary to return the additional data to the document.
2. Drill on the dimension.
If your Drill options are set to prompt you when a drill action requires a new query, the "Extend the
Scope of Analysis" dialog box appears.
The dialog box lists the dimensions in the hierarchy above and below the drilled value. The dimensions already included in the document are checked. The dialog box also displays the filters that you can select to filter the new query.
3. Select the check boxes next to the dimensions you want to drill.
4. Select the check boxes next to the filters you want to use to filter the query.
5. Click OK.
A new query returns the additional data to the document and the results for the dimension you drilled to appear on the table.

24.6 To choose a drill path when more than one is available
A dimension can belong to multiple hierarchies. When you drill down on such a dimension value, it is not clear which drill path to follow. You must define the drill path.
Note:
If the dimension value you choose to drill on is the result of a previous drill, the drill path is already known. Therefore you do not need to select a drill path.
1. Drill on the dimension.
The "Select Drill Path" dialog box appears. The dialog box lists the dimensions in the hierarchy above and below the drilled value. A check box appears next to each dimensions below the current dimension you are drilling, so that you can select which of these dimensions you want to retrieve from the database, in order to continue your drill action. The dialog box also displays the filters that you can select to filter the new query.
2. Select the path you want to drill.
3. Click OK.

275

2012-06-11

Drilling on report data

24.7 To take a drill snapshot
•

Select Analysis > Interact > Drill > Snapshot.

24.8 Drilling on dimensions in tables and sections
Dimensions typically represent character-type data, such as customer or business names, and dates.
Calculations are based around the dimensions in a report. For example, if you create a report that calculates a region’s total sales revenue for a given year, the Sales Revenue measure is calculated based on the two dimensions: State and Year.
When you drill on a dimension to see the more data behind the displayed result, the sales revenue is calculated according to the values to which you drill. If you drill on Year in the above example, you display sales revenue by state and quarter, because Quarter is the next dimension in the time hierarchy below Year.
Note:
You cannot drill on detail objects.

24.8.1 Drilling down
You drill down to see the lower-level data that makes up the summary results displayed on reports.
This helps explain why high or low results occurred.
Example: Using drill analysis to find out why sales decreased dramatically in 2003
In this example, you receive a report that shows sales revenue results for the accessories line at the eFashion retail store. The following crosstab shows that the Accessories line decreased in 2003.

To analyze more precisely when the decrease occurred, you drill down on the cell value 2003, to view the detailed data for each quarter.

276

2012-06-11

Drilling on report data

When you drill down on the cell value 2003, a filter appears in the Drill toolbar to show that the quarterly values you have drilled to are filtered for the year 2003. The drilled chart clearly shows that the problem arose in Q4 of 2003.

To find out which of the of the categories within the Accessories line was responsible for the drop in revenue, you drill down again on the cell value Accessories.

The drilled crosstab shows which categories were responsible for low revenue in Q4.
Note:
If you try to drill to a dimension that is already displayed in another column or row of the same table, the next available dimension in the drill path is displayed.

24.8.1.1 To drill down on a dimension value in a table or section cell
1. Verify you are in Drill mode
2. On a table or section cell, place your pointer over the dimension value on which you want to drill.
A ToolTip appears, showing the next dimension in the drill path. If the drilled report includes dimensions from multiple data providers, the ToolTip displays the name of the query and the dimension for the value.
3. Click the value.
The drilled table or section displays data one dimension level down. The Drill toolbar, at the top of the report, displays the values from which you drilled. These values filter the values displayed on the drilled table.

277

2012-06-11

Drilling on report data

24.8.2 Drilling up
You drill up on a dimension value to see how the more detailed data aggregates to a higher-level result.
For example, you may have drilled down on Year to examine data for each quarter. If you want to see how this data aggregates to yearly results, you can drill up.
When you drill up on a dimension value, you move along the drill path from lower- to higher-level data.
For example, you may have drilled down on [Year] to [Quarter]. If you drill up on [Quarter], you return to [Year].
You can only drill up on a dimension value if you have previously drilled down to that dimension, or you have defined the appropriate drill path in the scope of analysis.

24.8.2.1 To drill up on a dimension value
1. Verify you are in Drill mode.
2. On a table or section cell, right-click the dimension value on which you want to drill up, then on the shortcut menu click Drill up , or click the Drill Up icon next to the dimension value you want to drill up. If the table is a crosstab without headers that display the names of the dimensions on the table, then the Drill Up icon appears next to each value from which you can drill up.
The report now displays data one dimension level up. The filters that filtered the value you drilled up from, are removed from the Drill toolbar.

24.8.3 Drilling by
When you drill down or up, you move through a hierarchy one dimension at a time. However, you can get another view of the data by slicing it in a different way, and then look at the data in other hierarchies.
To do this, you drill by the other dimensions that interest you.
Note:
You can only Drill by to a dimension that is included in the scope of analysis of the document.
Example: Drilling by the Products hierarchy to slice sales revenue results by product
You work as regional manager for California in a retail clothing store, and have been sent the following report that shows quarterly sales revenue by state:

278

2012-06-11

Drilling on report data

You are only interested in analyzing the results in the state of California. In addition, you want to analyze the sales revenue broken down by each product line you sell. To drill on California data, you place your pointer on the table cell that says California.
If you drilled down now, however, you would drill to results for each city within California, because
[City] is the dimension below [State]. Instead, you select Drill by from the drill menu and then you navigate through the dimensions on the Products hierarchy by selecting the sub-menus until you reach the [Lines] dimension.

The drilled report displays the detailed sales revenue results for each product line sold in California.

279

2012-06-11

Drilling on report data

24.8.3.1 To drill by a dimension value
1. Verify you are in Drill mode.
2. On a table or section cell, right-click the dimension value you want to drill by.
A shortcut menu appears, displaying the available drill paths.
3. Place your pointer on Drill by, then on the class to which you want to drill.
4. Click the dimension to which you want to drill.
The report now displays data for the dimension to which you drilled.

24.9 Drilling on measures in tables and sections
When you drill on a measure value, you drill one level down for each related dimension in the block, and you see the measure calculated for the displayed dimensions.
Example: Drill on annual sales revenue results to see the breakdown by city and quarter
For example, you drill down on the year 2003 sales revenue value for California, which is displayed on a crosstab that shows sales revenue by year and by state.

280

2012-06-11

Drilling on report data

The drilled report displays sales revenue by quarter (one level below Year) and by city (one level below State) for California.

24.9.1 To drill down on a measure value
1. Verify you are in Drill mode.
2. Place your pointer over the measure value on which you want to drill.
A ToolTip appears, displaying the next dimension(s) in each related drill path
3. Click the measure value.
Your report now displays data one dimension level down. The table headers display the names of the dimensions you drilled to and the drill up arrow, which indicates you can drill back up to the summary results if wished. The Drill toolbar displays the values that filter the results displayed on the drilled table or section.

24.9.2 To drill up on a measure value
1. Verify you are in Drill mode.
2. Right-click the measure value on which you want to drill up, then click the Drill up option on the shortcut menu, or click the Drill Up icon next to the measure value you want to analyze.
The drilled table now displays data one dimension level up.

24.10 Synchronizing drill across multiple tables and charts
A report can contain several tables or charts. The generic term used to refer to tables and charts in this guide is a block. There are two ways to drill on a report with multiple blocks:
•
•

drill simultaneously on each block in the report the contains the drilled dimension drill on only the current block of data

You set how drill is performed on reports with the Synchronize drill on report blocks option.
If synchronize drilling across all blocks in a report, you drill on each block in the report containing that drilled dimension. The next dimension in the drill path replaces the previous dimension in all blocks in the report.

281

2012-06-11

Drilling on report data

If you do not synchronize drilling across all blocks in a report, the next dimension in the drill path replaces the previous dimension only in the current block in the report.
Related Topics
• Synchronize drill on report blocks option

24.11 Drilling on charts
Drilling down, up, or by on a chart, provides you with a graphical explanation for why summary results are particularly high or low.
You can drill on:
•
•
•

dimensions – by drilling on chart axes dimensions – by drilling on the chart legend measures – by drilling on the data bars or markers in the body of the chart

You cannot Drill by dimensions on chart axes. However, you can Drill by dimensions on chart legends.
Related Topics
• Drilling on axis legends

24.11.1 Drilling on dimensions via chart axes
On 2D charts, you can drill on dimensions via the X-Axis. On 3D charts, you can drill on dimensions via the X-Axis and the Z-Axis. Charts can contain one or multiple dimensions on a single axis. When an axis contains multiple dimensions, each possible combination of the dimension values appear on the axis (this is sometimes referred to as a cartesian product).
When you drill on an axis value with multiple dimensions, the drilled results are filtered by both dimensions. 24.11.1.1 To drill on a chart axis
1. Verify you are in Drill mode.
2. Place your pointer over the dimension value on which you want to drill.

282

2012-06-11

Drilling on report data

3. If you want to drill down on the dimension value, click the value. If you want to drill up on the dimension value, right-click the value then select Drill Up. If you want to drill down on the dimension value, right-click the value then select Drill Down. If you want to drill by the dimension value, right-click the value then select Drill By
Note:
Drill by is not available if the axis has multiple dimensions.

24.11.2 Drilling on measures in charts
You can drill on the measures displayed on the following types of chart:
•
•
•

bar charts – by drilling on the bars line and radar line charts – by drilling on the data markers pie chart – by drilling on the segments

When you drill on measures, the drill occurs on each dimension displayed on the chart axes. The new measure calculations displayed on the bars or data markers on the drilled chart, correspond to the lower- or higher-level dimensions to which you drilled. The chart axis labels display the names of the drilled dimensions.
Example: Analyze detailed information for the sales revenue measure on a chart
For example, this 3D bar chart displays values for the [State] dimension on the X-Axis and displays values for the [Lines] dimension on the Z-Axis. This means that the chart bars display values for sales revenue per state per line.

As the example below shows, when you drill down on the bar for “City Trousers" in “California" you also drill down from [State] to [City] on the X-Axis and from [Lines] to [Category] on the Y-Axis.
The drilled chart displays sales revenue per city per category for the “City Trousers" clothing line.

283

2012-06-11

Drilling on report data

24.11.2.1 To drill on a measure in a chart
1. Verify you are in Drill mode.
2. Place your pointer on the measure value on which you want to drill.
On charts, each measure is represented by a bar (on bar charts) or by a data marker (on a line charts and radar line charts).
3. If you want to drill down on the measure value, click the bar or data marker. If you want to drill up on the measure value, right-click the bar or data marker, and then click Drill up.

24.11.2.1.1 Restrictions when drilling measures on charts
When you drill on charts that are not bar charts, the drill action might be performed only on certain dimensions instead of on all of the dimensions on the chart axes. When you drill on measures in the following chart types, the drill action is performed only on the values in the axis legend:
•
•

area charts – 2D, 3D, and stacked radar and scatter charts – all types

Note:
You cannot drill on measures in 3D area charts.

24.11.3 Drilling on axis legends

284

2012-06-11

Drilling on report data

You can drill on charts via the chart legend whenever the legend lists the dimensions displayed on the chart. When the chart legend lists the measures displayed on the chart, drilling on the legend is not possible. Drilling on a legend is useful, if you are working with a pie chart, because the axis labels, which display the names of the dimensions represented by each pie segment, are not often displayed.
Note:
You can only Drill by on a chart legend, if there is a single dimension on the axis.

24.11.3.1 To drill on an axis legend
1. Verify you are in Drill mode.
2. Place your pointer over the value on which you want to drill.
3. To drill down the dimension value, click the color associated with the value. To drill up the dimension value, right-click the color associated with the value, then click Drill up ; or click the Drill Up icon.
To drill by the dimension value, right-click the color associated with the value, then click Drill by .

24.12 Using filters when you drill
When you drill on a dimension or measure value in a table or chart, the drilled results are filtered by the dimension or measure you drilled on. The filter is applied to all of the results displayed on the drilled report. Filters appear as list boxes in the Drill toolbar. Each list box contains the values associated with that filter. You select the data displayed in a table or chart by choosing the appropriate values from the list boxes. Note:
You can also use the Drill toolbar outside Drill mode to quickly add simple report filters to reports. In this context the toolbar is known as the Report Filter toolbar.
Example: Filtering drilled reports by different US states
For example, if you drill down on a table cell displaying “California" to view results for cities in California, you filter the values in the entire report for California and display results for California only in the report.
By changing the value of each filter, you can then see data for other values on the drilled dimension.
For example, you can select Colorado in the filter on State.

285

2012-06-11

Drilling on report data

Note:
If the drilled report includes dimensions from multiple data providers, a ToolTip appears when you rest your cursor on the value displayed on the filter. The ToolTip displays the name of the query and the dimension for the value.

Related Topics
• To create simple report filters

24.12.1 To change a filter value on the Drill toolbar
1. Verify you are in Drill mode.
2. In the Drill toolbar, click the drop-down arrow relating to the dimension you want to filter.
3. Click the value you want.

24.12.2 To add or remove a drill filter
1. Verify you are in Drill mode.
2. Drag the dimension containing the values around which you want to filter your report and drop it onto the Drill toolbar.
A list box for the new filter appears on the Drill toolbar. You can select a value from the list of values to filter the results displayed on the drilled table, chart, or report.
3. To remove a drill filter, drag the dimension away from the Drill toolbar.

24.13 Saving reports with drill filters
When you save a document with reports in drill mode, filters generated during drill are saved with the document. When you open a document saved in drill mode, the Drill toolbar appears on the drilled reports and shows the filters generated during the last drill session.
Note:
Documents saved in drill mode take longer to open than documents saved in results mode.

286

2012-06-11

Drilling on report data

24.14 Refreshing data in a drilled report with prompts
Some reports contain prompts. When you refresh the document, the prompts require you to specify the values you want to retrieve from the database and return to the reports in the document. For example, a prompt can require you to specify a year, for which you want to retrieve data. This drilled report shows values for Year 2003 – the year selected for the prompt.
If the drilled report is filtered for Year 2003, and you then refresh the document and select year 2002 to answer the prompt, the report displays results for 2002 instead of 2003.

24.15 Drilling with query drill

24.15.1 Query drill defined
You can drill in query drill mode, which behaves differently from standard drill mode When you activate query drill, you drill by modifying the underlying query (adding and removing dimensions and query filters) in addition to applying drill filters.
Example: Drilling down from month to week
In this example, Month is the lowest dimension currently available in the query from a time hierarchy, and Week is the dimension immediately below it in the hierarchy.
If you drill down on Month = January, three things happen:
•
•
•

Week is added to the scope of analysis.
A query filter restricts Month to "January".
A drill filter is added to restrict Month to "January".

If you drill up from Week to Month, the process is reversed:
•
•
•

Week is removed from the scope of analysis.
The query filter is removed.
The drill filter is removed.

Note:
Drill filters are not strictly necessary in query drill mode. They are applied for consistency with standard drill mode. For example, the DrillFilters function returns the correct value in query drill mode because query drill applies drill filters to match the query filters.

287

2012-06-11

Drilling on report data

24.15.1.1 Using query drill
You use query drill when your report contains aggregate measures calculated at the database level. It is designed in particular to provide a drill mode adapted to databases such as Oracle 9i OLAP, which contain aggregate functions which are not supported in Web Intelligence, or which cannot be accurately calculated in the report during a drill session.
Query drill is also useful for reducing the amount of data stored locally during a drill session. Because query drill reduces the scope of analysis when you drill up, it purges unecessary data.

24.15.1.2 To activate query drill
1. Click Document on the Properties tab to display the Document Properties pane.
2. Select Use query drill.
If your report already has a scope of analysis defined, you see a message telling you to clear the scope of analysis before activating query drill.

24.15.1.3 Drilling with query drill

24.15.1.3.1 Drilling down with query drill
When you drill down, query drill behaves similarly to standard drill at the point where the data moves outside the scope of analysis.
A drilled dimension is filtered in query drill mode by adding a query filter in addition to a drill filter. For example, if you drill on Year=2001, you add a query filter to restrict the Year dimension to 2001. For this reason, the only value that appears in the drill toolbar for the drilled dimension is the value on which you drilled (in this case 2001). This is different from standard drill mode, in which all values of the dimension are visible in the toolbar. As a result, you cannot change filter values in query drill mode (for example, drill on Year=2001 then switch to Year=2003) as you can in standard drill mode.
Because query drill automatically extends the scope of analysis, you can use it only if you have the right to drill outside the scope. See your administrator for more details.

288

2012-06-11

Drilling on report data

24.15.1.3.2 Drilling up with query drill
When you drill up, query drill removes dimensions from the query. For example, if you drill up from
Month to Quarter, you remove Month from the query. This has two consequences:
•
•

Query drill is incompatible with drill snapshots.
You cannot drill up beyond any dimension that appears as one of the report objects. For example, if your report displays Year, Quarter and Revenue, you cannot drill up from Quarter to Year because this would remove quarter from the list of report objects.

Related Topics
• Query drill and drill snapshots

24.15.1.3.3 Query drill and drill snapshots
Do not use drill snapshots when working in query drill mode, because query drill means that snapshots cannot be guaranteed to stay the same.
In query drill mode, snapshots change when you drill up beyond a dimension that you included in a snapshot. Because the drill up removes the dimension from the underlying query, it also removes the dimension from the snapshot.

24.15.1.3.4 Query drill and other reports based on the same data provider
If your document contains other reports that contain dimensions on which you drill in query drill mode, these reports are affected because the query drill modifies the dimensions they contain.
You can avoid this (at the cost of retrieving duplicate data) by creating a new data provider and rebuilding the other report against it. Now when you drill in query drill mode, the other report remains unaffected.
Example: Drilling on a dimension that appears in another report
If you have two reports based on a query that contains Year, Quarter and Sales Revenue, and you use query drill to drill down to Year = 2001 on the first report, you also filter the data for Year in the second report to include 2001 only.

289

2012-06-11

Drilling on report data

290

2012-06-11

Merging data from dimensions and hierarchies

Merging data from dimensions and hierarchies

25.1 Merging defined
You can synchronize the data returned by different dimensions, hierarchies or attributes by creating merged objects which incorporate them. You merge data from different data providers. For example, if you have one data provider that contains detailed customer information and another data provider that contains sales data, you can synchronize the two data providers around the customer.
When you merge data from the same data source (for example the same universe or Bex query), the merge is based on the internal ID of each data member. When you merge data from different data sources, the merge is based on the caption of each data member. For example, if you synchronize two
[Geography] hierarchies, the data member [Los Angeles] is merged with [Los Angeles] through its internal ID when the hierarchies are based on the same data source. The members are merged on the caption "Los Angeles" when the hierarchies are in different data sources.
In cases where merging is based on the caption, and different members with the same caption have different parent members, it is not possible to merge the members and the #MULTIVALUE error occurs.
When a merged object contains a hierarchy, you cannot include it directly in a report, but you can still see synchronized hierarchical data by using the original hierarchies. If you include a merged object without hierarchies in a report, the object returns the #COMPUTATION error if hierarchies are subsequently added to it.
Related Topics
• Merging hierarchies

25.1.1 Merging data providers based on keys
When you merge two data sources based on detail objects for a query based on BICS, the BEx query keys are mapped to details. In this way it is possible to merge data providers based on keys. Once merged, the attribute is used in the report in the same way as a dimension.

291

2012-06-11

Merging data from dimensions and hierarchies

25.2 Choosing which data to merge
You merge data when your report draws data from different but related sources. For example, you have a report showing revenue and sales targets. The report contains sections based on the year, and each section shows revenue and sales targets. If revenue and sales target data comes from two different data providers, it is not synchronized. You synchronize the data by merging the two data providers on the common dimension, Year.
The only technical restriction imposed on merged dimensions is that they must be of the same data type. You can, for example, merge two dimensions containing character data. But it does not make sense to merge unrelated dimensions even when their data types are the same. For example, it does not make sense to merge a dimension containing customer names with a dimension containing sales regions. Merged dimensions often have the same name in both data sources, but this is not obligatory. It can make sense to merge dimensions with different names if they contain related data.
To merge dimensions correctly you need to be aware of the semantics of the data (what the data refers to) in the different data sources. The dimension data types and names are an approximate guide only to dimensions’ suitability for merging.

25.3 Merged dimension example
The following example with two data providers illustrates the effect of merging dimensions:
Example: Merging City dimensions
Data Provider 1:
Country

City

US

New York

US

Los Angeles

France

Paris

France

Toulouse

Data Provider 2:

292

2012-06-11

Merging data from dimensions and hierarchies

City

Revenue

New York

100000

Los Angeles

75000

Paris

90000

Toulouse

60000

If you do not merge the City dimensions, you get the following result if you place the Country, City and
Revenue objects in a table:
Country

City

Revenue

US

New York

325000

US

Los Angeles

325000

France

Paris

325000

France

Toulouse

325000

Because there is no link between the two data providers through a merged dimension, city revenues are not related to countries. The table shows the total revenue in data provider 2 against each
Country/City pair.
If you merge the City dimensions, you get the following result:
Country

City

Revenue

US

New York

100000

US

Los Angeles

75000

France

Paris

90000

France

Toulouse

60000

25.4 Merging hierarchies
When you merge hierarchies, you cannot use the merged hierarchy in a report, but you can take advantage of the data synchronization by using the original hierarchies that make up the merged hierarchy. The data in the report takes the structure of the hierarchy you select.

293

2012-06-11

Merging data from dimensions and hierarchies

Example: Merged hierarchies
You have two data sources, each using a hierarchy that you have merged into a merged object. Data provider 1 contains the following data:
Product

Store Invoice

Sport

5401
Gym

4073
Bottoms

1236

Tops

1208

Weights

1629

Swimming

1328

Camping

16961
Tents

3534

Sleeping Bags

3423

Kitchen Equipment

5352

Electrical

4652

Data provider 2 contains the following data:
Product

Units Ordered

Sport

13348
Gym

8814
Bottoms
Tops

Camping

3241

Weights
Swimming

1231

4342
4534
34234

If you use the first hierarchy in a report, the merged data is structured as follows:

294

2012-06-11

Merging data from dimensions and hierarchies

Product

Store Invoice

Units Ordered

Sport

5401

13348

4073

8814

Bottoms

1236

1231

Tops

1208

3241

Weights

1629

4342

1328

4534

16961

34234

Gym

Swimming
Camping
Tents

3534

Sleeping Bags

3423

Kitchen Equipment

5352

Electrical

4652

The child members of [Camping] appear in the hierarchy because they appear in the hierarchy you selected. The [Units Ordered] measure does not display values for these members because they do not exist in the second data source.
If you select the second hierarchy, the merged data is structured as follows:
Product

Store Invoice

Units Ordered

Sport

5401

13348

4073

8814

Tops

1236

1231

Bottoms

1208

3241

Weights

1629

4342

1328

4534

16961

34234

Gym

Swimming
Camping

The child members of [Camping] do not appear because they do not appear in the orignal hierarchy you selected.

295

2012-06-11

Merging data from dimensions and hierarchies

25.5 Merging different types of object
You can include dimensions, attributes and hierarchies in merged objects. You cannot include a merged object containing a hierarchy directly in a report, but you can include the objects that make up the merged object. The structure of the data that appears in the report depends on which object you chose.
Example: Merging a dimension and a hierarchy
You have two data sources, one containing a dimension and the other a hierarchy. Data provider 1 contains the [Country] dimension as follows:
City

Stock Items

Los Angeles

4545

San Francisco

6465

San Diego

4564

Data provider 2 contains the [Geography] hierarchy as follows:
Geography

Revenue

US

54342
California

6996
Los Angeles

3423

San Francisco

2342

San Diego

1231

You merge the dimension and hierarchy in a merged object. You cannot include the merged object in a report because it contains a hierarchy. If you include the [Country] dimension in a report, the data appears as follows:
City

Revenue

Los Angeles

4545

3423

San Francisco

6465

2342

San Diego

296

Stock Items

4564

1231

2012-06-11

Merging data from dimensions and hierarchies

If you place the [Geography] hierarchy in a report, the result is as follows:
Product

Stock Items

US

Revenue

54342
California

6996
Los Angeles

4545

3423

San Francisco

6465

2342

San Diego

4564

1231

25.6 Forcing merged calculations with the ForceMerge function
By default, calculations do not account for merged dimensions if the merged dimensions do not explicitly appear in the calculation context.
Example: Calculating revenue with ForceMerge
This example has two data providers as follows:
Data Provider 1:
Country

City

US

New York

US

Los Angeles

France

Paris

France

Toulouse

Data Provider 2:
City

New York

100000

Los Angeles

75000

Paris

297

Revenue

90000

2012-06-11

Merging data from dimensions and hierarchies

City

Revenue

Toulouse

60000

If you merge the City dimensions, then create a table with Country and Revenue, you get the following result: Country

Revenue

US

325000

US

325000

France

325000

France

325000

Because City, the merged dimension, does not appear in the table, it does not influence the calculation of the revenue. The the total revenue in the second data provider appears against each country.
To display the correct result, replace Revenue in the second column with the formula Force
Merge([Revenue]):
City

Revenue

US

175000

US

175000

France

150000

France

150000

The relationship between countries and cities now influences the calculation of the revenue.
Note:
If Revenue is a smart measure in the above example, ForceMerge([Revenue]) returns
#MULTIVALUE. This is because the grouping set (Country) does not exist for the Revenue measure.
ForceMerge([smart_measure]) always returns #MULTIVALUE, unless by chance no aggregation is required to calculate the measure.

25.7 Creating, editing and deleting merged objects

298

2012-06-11

Merging data from dimensions and hierarchies

25.7.1 To merge details, dimensions, or hierarchies
1. Switch to Design mode.
a. In the Web interface (DHTML client), click Variables > Merge.
b. In the Rich Internet Application interface (the Java applet) and in Web Intelligence Rich Client, click Data Access > Data Objects > Merge
2. Hold down the Ctrl key and select the dimensions or hierarchies you want to merge.
3. Click OK.
You can view the merged object in the Available Objects pane of the Left Pane. The original hierarchies or dimensions that make up the merged object appear beneath it. You edit or remove the merged dimension or hierarchy in the Available Objects pane. Select the objects, right-click an select Merge.
Related Topics
• To delete merged objects
• To edit merged objects

25.7.2 To merge dimensions automatically
You can merge dimensions automatically under the following circumstances:
•
•
•
1.

The dimensions have the same name
The dimensions have the same data type
The dimensions are in the same universe
With a document open in Design mode, click Document on the Properties tab to display the
"Document Summary" dialog box.
2. Select Auto-merge dimensions.

25.7.3 To edit merged objects
1. Right-click the merged dimension in the Available Objects pane of the Left Panel then select Edit
Properties on the menu to display the "Create Merged Dimension" dialog box.
2. Type the merged dimension name in the Merged Dimension Name in the Merged Dimension dialog box.

299

2012-06-11

Merging data from dimensions and hierarchies

3. Type the description in the "Description" box.
4. Select the dimension that provides default properties for the merged dimension in the "Source
Dimension" dialog box.

25.7.4 To delete merged objects
1. Select the merged dimension in the Available Objects section of the Left Panel.
The Merge button at the top of the Left Panel becomes the Unmerge button when you select a merged dimension.
2. Click Unmerge.

25.8 Understanding the effects of merged data
Merging data has implications for report results in certain situations. You need to understand these implications to work effectively with merged dimensions and synchronized data.

25.8.1 Synchronizing data providers with different aggregation levels
You can synchronize data providers with different aggregation levels. This can have implications for the calculation of measures.
Example: Synchronizing data providers with different aggregation levels
In this example you have two data providers as follows:
Customer

Year

Revenue

Jones

2004

1500

Jones

2005

2000

Smith

2005

1200

Customer

Jones

300

Number of sales

12

2012-06-11

Merging data from dimensions and hierarchies

Customer

Number of sales

Smith

10

If you merge the two data providers and the table properties Avoid duplicate rows aggregation and
Show rows with empty dimension values are unchecked, the result is as follows:
Customer

Year

Revenue

Number of sales

Jones

2004

1500

12

Jones

2005

1200

12

Smith

2005

1200

10

It is not possible to determine the number of sales per year for customer Jones because the data provider that stores the number of sales does not break them down by year. Instead you see the total number of sales on each row.
Note:
Although the Number of Sales values are duplicated, if you add a standard calculation to the bottom of the column (for example a Sum or Average calculation), the result is correct.
One way of adressing this issue is to add the dimensions to the second data provider that allow calculation to the appropriate level of data. If this is not possible, you must be aware of any situations where it is not possible to aggregate the data to the necessary level of detail.

25.8.2 Attributes and merged dimensions
Attributes are associated with dimensions and provide additional information about the dimension.
There must be a one-to-one relationship between dimensions and attributes (this means that an attribute can have one value only for each value of its associated dimension) and attribute objects are not taken into account when synchronizing data. The following example illustrates why this is necessary.
Note:
Some previous versions of SAP BusinessObjects Web Intelligence (Web Intelligence, Desktop Intelligence and BusinessObjects), allowed a one-to-many relationship between dimensions and attributes. If you migrate a report created using any of these products and the attribute contains multiple values, you see the #MULTIVALUE error in the attribute cell.
Example: Synchronizing data providers with attributes
In this example you have two data providers, and Address is an attribute of Customer:

301

2012-06-11

Merging data from dimensions and hierarchies

Customer

Address

Revenue

John

London

10000

Paul

Liverpool

15000

Paul

London

27000

Customer

Telephone Number

John

1234

Paul

5678

If you create a merged Customer dimension to synchronize the data providers, and Address can have more than one value for each customer, the result is ambiguous because there is no common value for data synchronization.
In the example, Paul has addresses in Liverpool and London, which means that there is no unique
‘Paul’ row for synchronization of Paul's telephone number. Paul has a different telephone number for each address, and we do not know which address to associate with the telephone number:
Customer

Address

Telephone Number

John

London

1234

Paul

#MULTIVALUE

5678

If the relationship between Customer and Address is one-to-one, Address can be ignored in the synchronization. This removes the ambiguity:
Customer

Address

Telephone Number

John

London

1234

Paul

Liverpool

5678

25.8.3 Incompatible objects and merged dimensions
As a general rule, you cannot place dimensions from different data providers in the same table. This is to avoid Cartesian products (the display of all possible combinations of values from unrelated objects) or other ambiguous results, depending on the universe structure.

302

2012-06-11

Merging data from dimensions and hierarchies

You can always place measures from different data providers in a table. The measure calculation depends on what dimensions are available. For example, if you place a measure in a table that contains no dimensions from the same data provider as the measure, the calculation displays its total value in the table.
You can place a merged dimension in a table as long as the table contains other dimensions from a data provider that participates in the merge. You can also place attributes from different data providers in a table, as long as the details are associated with dimensions that participate in a merged dimension.
In certain situations, it can be valid to place a dimension from another data provider in a table, even when this is not allowed by the software. This occurs when the incompatible dimension has a one-to-one or one-to many relationship with a dimension already in the table. The important point is that there is only one value of the incompatible dimension associated with the dimension in the table (one-to-one).
On the other hand, the same value of the incompatible dimension can be associated with multiple values of the dimension in the table (one-to-many).
In the table below, the relationship between Address and Name conforms to these rules: Address has a one-to-one or one-to-many association with Name. There is no one-to-many association in the other direction, between Name and Address (one name with more than one address):
Dimension in table (Name)

Incompatible dimension (Address)

John

London

Paul

London

George

Liverpool

In this case the universe design is incorrect - the incompatible dimension (Address) should be defined as a detail of the dimension in the table (Name). If you encouter this situation, see your administrator and ask for a redesign of the universe.
If it is not practical to change the universe, create a variable at the report level. Define this variable as a detail, associate it with the dimension in the table, and supply the name of the incompatible dimension as the variable definition. The variable simply returns the same values as the incompatible dimension.
Because it is defined as a detail of the dimension in the table, you can place it in the same table as the dimension. 25.8.4 Filtering merged dimensions
Merging dimensions has implications for the application of filters.
Note:
You cannot apply a filter a on merged object containing hierarchies.

303

2012-06-11

Merging data from dimensions and hierarchies

25.8.4.1 Report filters and merged dimensions
When you apply a report filter to a dimension that is part of a merged dimension, then the filter will impact all related blocks in the report that use the merged dimension (or any dimensions that participate in the merge).
Example:
When you have two queries with a common dimension that you have merged, and you have two tables in a report, each table with data coming from a different query, when you filter on the merged dimension in one query, the filter will also impact the corresponding dimension in the second query and therefore in the second table.

25.8.4.2 Section filters and merged dimensions
When a dimension that is part of a merged dimension is set as a section header, any filter applied to the section also applies to blocks from synchronized data providers within the section.

25.8.4.3 Block filters and merged dimensions
When you apply a block filter to a dimension that is part of a merged dimension, the filter is applied to the block. It is not applied to other data providers synchronized through the merged dimension.

25.8.5 Drilling on merged dimensions
When you merge dimensions, the new merged dimension belongs to the hierarchies of all dimensions involved in the merge.

304

2012-06-11

Merging data from dimensions and hierarchies

25.8.6 Extending the values returned by merged dimensions
Synchronizing data providers exists in Desktop Intelligence/BusinessObjects but it does not involve the creation of a new merged dimension. BusinessObjects reports use the original dimensions that make up a merged dimension in Web Intelligence.
You can use these original dimensions in an Web Intelligence report. When you place them in the report, it returns by default only those dimension values that have corresponding values in the data providers synchronized through the merge. You need to be aware of this when migrating reports from
Desktop Intelligence and BusinessObjects because BusinessObjects/Desktop Intelligence behaves differently. Example: Web Intelligence and Desktop Intelligence/BusinessObjects behavior when dimensions are merged
You have a report with the following data providers:
Country of origin

Revenue

Germany

470

Country of origin

Revenue

Japan

499

If you include the Country of Origin dimension from Data Provider 1 and the Revenue measure from
Data Provider 2 in the same block, you get the following result:
Country of origin

Revenue

Germany

The same block in Desktop Intelligence/BusinessObjects returns the following result:
Country of origin

Revenue

Germany
Japan

499

The block is different in Desktop Intelligence/BusinessObjects because BusinessObjects extends the values of the Country of Origin dimension through the values returned by the Revenue measure.

305

2012-06-11

Merging data from dimensions and hierarchies

25.8.6.1 To extend dimension values
1. Right-click your report outside any blocks or charts and select Document Properties on the shortcut menu. The Document Properties pane appears on the right side of the report.
2. Check the Extend merged dimension values option.

306

2012-06-11

Ranking report data

Ranking report data

26.1 Ranking data
Ranking allows you to isolate the top and bottom records in a set based on a variety of criteria. For example, if you have a block showing countries and associated revenues, ranking allows you to rank the data in the block to show the top 3 countries only, based on the revenue they generate.
Ranking allows you to answer business questions such as:
•
•
•

Which 3 regions generate the most revenue?
Which are the bottom 10% of stores in terms of revenue generation?
What is the group of the best-performing stores that generates a combined revenue of up to
$10,000,000?

You can rank data in many ways to answer these kinds of business questions. You can:
•
•
•
•

rank the top and/or bottom n records by dimension (for example Country) based on the sum of a related measure (for example Revenue) rank the top and/or bottom n% of the total number of records by dimension based on the value of a related measure as a percentage of the total value of the measure rank the top and/or bottom n records by dimension based on the cumulative sum of a related measure rank the top and/or bottom n records by dimension based on the value of a related measure as a cumulative percentage of the total value of the measure

26.2 Rankings and sorts
When you rank data, the data must be sorted to display the ranking. For example, if you rank the top
3 stores by revenue, the stores are sorted in descending order by revenue generated.
Sorts applied to display rankings take precendence over sorts that you had previously applied to data.
For example, if you had previously sorted the list of stores in alphabetical order, the ranking sort overrides the alphabetical sort.

307

2012-06-11

Ranking report data

26.3 Tied rankings
Tied rankings are assigned equal ranking values and subsequent ranking values are pushed back to compensate. This means that a bottom n ranking can return more than n records.
Example: Top and bottom tied rankings
The following table shows a tied top 3 ranking and a tied bottom 3 ranking.
Dimension

Measure

Top 3 Ranking

Bottom 3 Ranking

A

10

4

1

B

20

3

2

C

30

1

3

D

30

1

3

Each ranking includes records up to and including rank 3. This results in the following result for a top
3 ranking:
Dimension

Measure

D

30

C

30

B

20

It results in the following result for a bottom 3 ranking:
Dimension

A

10

B

20

C

30

D

308

Measure

30

2012-06-11

Ranking report data

26.4 Ranking parameters

Parameter

Description

When the calculation mode is Count, the ranking returns the top/bottom n records based on the measure specified in the Based on parameter.
For example, the top 3 countries by revenue generated, the bottom 3 year/quarter combinations by revenue generated.

Top/bottom

When the calculation mode is Percentage, the ranking returns the top/bottom n% of the total number of records based on the measure specified in the Based on parameter. For example, if there are 100 records and you rank the top 10%, the ranking returns the top 10 records.
When the calculation mode is Cumulative Sum, the ranking returns the top/bottom records for which the cumulative sum of the measure specified in Based on does not exceed n.
When the calculation mode is Cumulative Percentage, the ranking returns the top/bottom records for which the cumulative sum of the measure specified in Based on does not exceed n% of the total of the measure.
When the calculation mode is Count - the number of records to retrieve based on the measure.
When the calculation mode is Percentage - the percentage of records to retrieve based on the measure. n/n%

When the calculation mode is Cumulative Sum the cumulative sum that the measure must not pass. When the calculation mode is Cumulative Percentage - the cumulative sum of the measure, represented as a percentage of the total, that the measure must not pass.

309

2012-06-11

Ranking report data

Parameter

Description

Based on

The measure on which the ranking is based.

Ranked By

The ranking dimension. If you specify a ranking dimension, the aggregated values of the Based on measure, calculated for the dimension, determine the ranking. If you do not specify this dimension, the values of the Based on measure calculated for all dimensions in the block determine the ranking. (In other words, the ranking returns the top/bottom X rows in the block based on the measure.) Calculation mode

The type of calculation used to create the ranking.
See the description of the Top/Bottom and n/n% parameters at the top of this table for more information.

26.4.1 Example of a ranking
A table contains the following data:
Year

Revenue

2006

Q1

100

2006

Q2

200

2006

Q3

300

2006

Q4

500

2007

Q1

400

2007

Q2

700

2007

Q3

300

2007

Q4

600

2008

Q1

200

2008

Q2

200

2008

310

Quarter

Q3

400

2012-06-11

Ranking report data

Year

Quarter

Revenue

2008

Q4

500

Total for Q1: 700
Total for Q2: 1100
Total for Q3: 1000
Total Q4: 1600
If you rank the top 2 of each Quarter based on Revenue, the ranking filters out all the rows for Q1 and
Q3 because Q4 and Q2 have the highest aggregate revenues.

26.5 Ranking and data order
You cannot rank on an object whose values depend on the data order. This is because the ranking changes the data order, which in turn changes the object data, which then requires recalculation of the ranking. The result is a circular dependency between the ranking and the object that cannot be resolved.
If you create a rank on a measure whose values depend on the data order, for example a measure that that uses the Previous function or any of the running aggregate functions such as RunningSum, the
#RANK error message appears in all cells in the block.

26.6 Ranking workflows
There are two ways of ranking data. You can:
•
•

create a ranking by using the interface use the Rank function to return a ranking value

A ranking uses sorts and filters that are applied transparently according to the ranking you specify. For example, if you rank the top 3 countries in a block by revenue, you implicitly sort the countries in descending order by revenue, then filter the block to remove all countries other than the 3 with the highest revenue.
Note:
When you create a ranking using the interface, the Rank function is used behind the scenes to assign ranking values.

311

2012-06-11

Ranking report data

26.6.1 To create a ranking
1. Select the block that you want to rank.
2. Click Analysis > Filters > Ranking.
The "Create Rank" dialog box appears
3. Click Top and select the number of records if you want to rank the highest records in the block.
4. Click Bottom and select the number of records if you want to rank the lowest records in the block.
5. Select the measure on which the ranking is based in the Based on list.
6. Click Ranked By and select the dimension on which the ranking is based if you want to rank by a particular dimension rather than by all dimensions in the block.
7. Select the rank calculation mode in the Calculation mode list.
8. Click OK.

26.7 Ranking examples
In the following examples, you have a dimension, Region, and a measure, Revenue, which give the following values:
Region

Revenue

% of Total Revenue

South East

1000000

7%

South West

2000000

13%

North East

3000000

20%

North West

4000000

24%

Central

5000000

33%

Example: Rank the top 3 regions by revenue generated
To perform this ranking you set the following parameters:
Parameter

Top/Bottom

Top

n/n%

312

Value

3

2012-06-11

Ranking report data

Parameter

Value

For Each

Region (or unspecified because region is the only dimension in the block and therefore the default ranking dimension)

Based on

Revenue

Calculation mode

Count

This ranking gives the following result:
Region

Revenue

Central

5000000

North West

4000000

North East

3000000

The implicit steps in calculating this ranking are:
•
•

Sort the records in descending order
Display the top 3 records

Example: Rank the bottom 40% of regions by revenue
To perform this ranking you set the following parameters:
Parameter

Value

Top/Bottom

Bottom

n/n%

40%

For Each

Region

Based on

Revenue

Calculation mode

Percentage

This ranking gives the following result:
Region

South East

1000000

South West

313

Revenue

2000000

2012-06-11

Ranking report data

The implicit steps in calculating this ranking are:
•
•

Sorts the record in ascending order
Work through the records until 40% of the total number of records are displayed

Example: Rank the top regions whose cumulative revenue is less than or equal to 10,000,000
To perform this ranking you set the following parameters:
Parameter

Value

Top/Bottom

Top

n/n%

10000000

For Each

Region

Based on

Revenue

Calculation mode

Cumulative sum

This ranking gives the following result:
Region

Revenue

Central

5000000

North West

4000000

The implicit steps in calculating this ranking are:
• Sort the records in descending order
• Work through the records until the record that causes the the cumulative total of the measure to pass 10,000,000
• Include those records that do not cause the cumulative total to pass 10,000,000

Example: Rank the bottom regions whose cumulative revenue is less than or equal to 30% of the total revenue
To perform this ranking you set the following parameters:
Parameter

Top/Bottom

Bottom

n/n%

30%

For Each

314

Value

Region

2012-06-11

Ranking report data

Parameter

Value

Based on

Revenue

Calculation mode

Cumulative percentage

This ranking gives the following result:
Region

Revenue

South East

1000000

South West

2000000

The implicit steps in calculating this ranking are:
• Sort the records in ascending order
• Work through the records until the record that causes the cumulative total of the measure, expressed as a percentage of the overall total of the measure, to exceed 30%
• Display those records that do not cause the cumulative percentage to pass 30%

315

2012-06-11

Ranking report data

316

2012-06-11

Tracking changes in data

Tracking changes in data

27.1 Tracking changes in your data
To make informed and effective business intelligence decisions, you need to understand how the data on which you base those decisions changes over time.You can track and display data changes to help you focus your analysis on key areas and avoid wasting time exploring irrelevant data.
When you track data changes, you select a particular data refresh as a reference point. This data is known as the reference data. When you activate data tracking, you see your data in relation to the reference data.
Here are some examples of data tracking:
•
•

If an outlet no longer appears in a list of the top outlets by sales, you see it as deleted from the list.
You can use this information to investigate why the outlet is no longer a top performer.
If sales have decreased in a region, data tracking displays the decrease. You can then drill down into the data for the region to understand why revenue is falling.
In both these cases, data tracking makes the current data more meaningful by placing it in context with older data. Without this context it is much more difficult to identify trends.
Note:
Tracking data changes operates at document level and not report level. If a document contains several reports, the tracking will apply to all of the reports. The information in the Status Bar indicates the document level status. An asterisk on a report tab indicates that change tracking is activated on the report.

27.2 Types of data change
You can track the following types of data change:
•
•
•
•
•

317

Inserted data
Deleted data
Changed data
Increased values
Decreased values

2012-06-11

Tracking changes in data

You configure the display of these changes through the interface or the formula language. The formula language provides advanced users with additional power and flexibility in displaying and formatting changed data.

27.3 Data tracking modes

27.3.1 Automatic data tracking mode
In automatic data tracking mode, you always compare the current data with the data before the last refresh. This is achieved by automatically setting the current data as the reference data just before each refresh. The reference data is always one refresh behind the current data.
Automatic data tracking is appropriate for scheduled documents when you want to compare the current data with the data before the last refresh.

27.3.2 Manual data tracking mode
In manual data tracking mode, you select the reference data. You continue to use this data as a reference point until you update the reference point.

27.4 To activate data tracking
1. Click Track Changes on the status bar at the bottom of the window to display the "Data Tracking" dialog box.
2. Select the Data tab.
3. To compare the data with the last refresh, select Compare with last data refresh.
When you select this option, the current data becomes the reference data after each data refresh.
The report always shows the difference between the most recent data and the data before the last refresh. When this option is selected, the status bar displays Track changes: Auto-update.

318

2012-06-11

Tracking changes in data

4. To compare the data with a specific data refresh, select Compare with data refresh from and select the date of the data refresh from the list.
When you select this option, the data refresh you chose becomes the reference data. The report always shows the difference between the most recent data and the data refresh you chose.
When this option is selected, the status bar displays Track changes: Fixed data.
5. Select the reports that you want to display data tracking from the Reports with data tracking shown list. 6. Click Refresh data now to refresh the data when the dialog box closes.
7. Click OK

27.5 Displaying changed data

27.5.1 To display changed data
You can choose whether to display changed data when data tracking is activated.
1. Activate data tracking.
2. Select Track > Show Changes (in Reading mode) or Analysis > Data Tracking > Show Changes
(in Design mode) to display changed data. Select the option again to turn off the display of changed data. Related Topics
• Configuring the appearance of changed data
• To activate data tracking

27.5.2 Configuring the appearance of changed data
You can configure the appearance (font style, size and color) of changed data in your document. You can seperately configure the appearance of the following changes:
•
•

319

Inserted, deleted dimensions and changed detail values
Increased or decreased measure values

2012-06-11

Tracking changes in data

Measure values can also adopt the formatting of inserted or deleted dimension values. For example, if a dimension value disappears from a list of values in a block, and the block also shows a measure value for the dimension, both the dimension and measure values appear as deleted data.
Your administrator defines the default appearance of changed data in the Central Management Server.
When you configure the appearance of changed data locally, you override the CMS defaults.

27.5.2.1 To configure the appearance of changed data
You must be in Design mode to configure the appearance of changed data.
1. Click Track Changes on the status bar at the bottom of the window to display the "Data Tracking" dialog box.
2. Select the Options tab.
3. Select each type of changed data you wish to display and click Format to specify how you want the changes to appear.
Note:
The Format buttons are visible only in Design mode.
Related Topics
• Highlighting data using conditional formatting

27.5.3 How changed data is displayed in blocks

Example: Changed data in a simple block
This example uses a document with a block showing [Country], [Year] and [Revenue]. The original data was as follows:
Country

Revenue

France

2003

1000

France

2004

2000

Japan

2002

1000

Poland

320

Year

2002

1200

2012-06-11

Tracking changes in data

After a refresh, the data is as follows:
Country

Year

Revenue

France

2004

3000

Japan

2003

900

Poland

2002

800

UK

2004

900

When data tracking is activated and data changes displayed, the block appears as follows:
Country

Formatting

2003

1000

[deleted data formatting on all cells]

France

2004

3000

[increased data formatting on
Revenue cell]

Japan

2002

1000

[deleted data formatting on all cells]

Japan

2003

900

[inserted data formatting on all cells]

Poland

2002

800

[decreased data formatting on Revenue cell]

UK

•
•
•

Revenue

France

•

Year

2004

900

[inserted data formatting on all cells]

The rows showing revenue for France in 2003 and Japan in 2002 represent data that no longers exist after the refresh.
The revenue for France in 2004 has increased.
The revenue for Poland in 2002 has decreased.
The rows showing revenue for Japan in 2003 and the UK in 2004 appeared after the refresh.

27.5.4 How changed data is displayed in reports with merged dimensions
A dimension appears as changed only if all the dimensions that participate in the merge are changed.

321

2012-06-11

Tracking changes in data

Example: Changed data and merged dimensions
In this example, Country is a merged dimension containing the Country dimensions from two data providers. Before data refresh, the data is as follows:
Country (DP1)

Revenue (DP1)

Country (DP2)

Sales (DP2)

US

10000

US

5000

France

4000

UK

5000

UK

3000

Germany

1000

Germany

1000

After a data refresh, the data becomes:
Country (DP1)

Revenue (DP1)

Country (DP2)

Sales (DP2)

US

10000

US

4000

France

4000

France

3000

UK

6000

UK

4000

Poland

2000

When displayed in a block with the merged Country dimension and data changes displayed, the data appears as follows:
Country

Sales

Formatting

US

10000

4000

[decreased data formatting on Sales cell]

France

4000

3000

[inserted data formatting on
Revenue cell]

UK

6000

4000

[increased data formatting on
Revenue and Sales cells]

Germany

1000

1000

[deleted data formatting on all cells]

Poland

322

Revenue

2000

[inserted data formatting on
Country and Revenue cells]

2012-06-11

Tracking changes in data

In the France row, France does not appear as inserted because a France row was not inserted in both data providers. Revenue appears as inserted because it is a new measure value after the data refresh.
In the Poland row, Poland appears as inserted because it is a new dimension value after the data refresh. 27.5.5 How changed data is displayed in sections

Example: Changed data in a report with sections
In this example you have a document with a block showing [Country], [Year] and [Revenue]. The original data was as follows:
Country

Year

Revenue

France

2003

1000

France

2004

2000

Japan

2002

1000

Poland

2002

1200

US

2003

US

2004

After a refresh, the data is as follows:
Country

Year

Revenue

France

2004

3000

Japan

2003

900

Poland

2002

800

UK

2004

900

If you create a section on [Country] and display data changes, the report appears as follows:
France [no formatting]

323

2012-06-11

Tracking changes in data

Year

Revenue

Formatting

2003

1000

[deleted data formatting on all cells]

2004

3000

[increased data formatting on Revenue cell] Japan [no formatting]
Year

Revenue

Formatting

2002

1000

[deleted data formatting on all cells] 2003

900

[inserted data formatting on all cells] Year

Revenue

Formatting

2002

800

[decreased data formatting on
Revenue cell]

Year

Revenue

Formatting

2004

900

[inserted data formatting on all cells] Poland [no formatting]

UK [inserted data formatting]

The data appears in the section header in either of two ways, depending on the changes in the data in the section:
•
•

If all the rows in the block in the section have changed in the same way, the section header is displayed with the same formatting as the rows.
If the rows have changed in different ways, or only some rows have changed, the section header retains its default format.

27.5.6 How changed data is displayed in blocks with breaks

324

2012-06-11

Tracking changes in data

When a block contains a break and the Center value across break block property is set, the display of the centered value follows rules similar to those for section headers.
•
•

If all the rows in the break have changed in the same way, the centered value is displayed with the same formatting as the rows.
If the rows have changed in different ways, or only some rows have changed, the centered value retains the default formatting.

27.5.7 How changed data is displayed in charts
When the data in a chart has changed, a changed data icon appears above the chart. When you click the icon, the chart changes to a table to allow you to see the details of the changes.

27.6 Data tracking restrictions
If you change or purge a data provider, the report no longer displays changed data. If the data provider is changed, the current version of the document is no longer compatible with the reference version. If the data is cleared, the old data no longer exists for comparison.
As a result, the following actions are incompatible with data tracking:
•
•
•
•
•

Drill out of scope
Query drill
Deleting a query
Any modification (including modifications to security rights) that changes the SQL generated by a data provider
Purging the document

When you perform any of these actions, the data history of the document is cleared because the actions are incompatible with the display of changed data. For example, if you modify a query, the data in the document changes because of the modification. Any comparison between this data and old data generated from a different query is misleading.

27.6.1 Data tracking and drill
When you use query drill or drill out of scope, the data history is cleared because these actions change the data provider. This should not affect you because, when you start to drill, you have already identified

325

2012-06-11

Tracking changes in data

the data that requires further analysis. Data tracking has served its purpose and you can now continue with your data analysis.

27.6.2 Data tracking and Refresh on Open
When a document is set to refresh its data on opening (when the Refresh on open document property is selected), data tracking does not display the difference between the data prior to the refresh and the data after the refresh. The data after the refresh is considered to be new data because the refresh purges the document.
Note:
The Refresh on open option is dependent on two CMS settings (document and user-related security settings): "Check automatic refresh on open" in the CMC/Application/Webi/Properties and the "Disable automatic refresh on open" in the CMC/Application/user security settings. If the property Check automatic refresh on open security setting is ENABLED/checked in CMC/Application/Webi/Properties and in the CMC/Application/user security settings, the security right Disable automatic refresh on open is DISABLED for this user, then even if the document is not set as being Refresh on open, it will still be refreshed on opening.

27.7 Using the formula language to track changed data
When you use the interface to configure the display of changed data, the changes are tracked using special behind-the-scenes alerters. These special alerters do not appear in the list of standard alerters.
The formula language allows you to build your own custom alerters for formatting data changes. You can also use the formula language to include special calculations based on data changes. For example, you can include a calculation to show the difference between the previous value and the current value of a measure.

27.7.1 The RefValue function
The formula language provides access to changed data throught the RefValue function. This function gives the value of the reference data for a measure. If there is no reference data, the function returns null. For example, if the [Revenue] measure currently has the value 1000, and its reference value is 900, the formula RefValue([Revenue]) returns 900.

326

2012-06-11

Tracking changes in data

27.7.2 The RefValueDate function
The RefValueDate function returns the date of the reference data used for data tracking.

27.7.3 The RefValueUserResponse function
The RefValueUserResponse function is used for tracking prompts and returns the value of the user response of the reference data (prompts) used for data tracking.

27.7.4 Building formulas using the RefValue function
You can use the RefValue function to build formulas that give information about the current data in relation to the reference data.
Example: Finding the difference between the reference value and the current value
The following formula returns the difference between the reference value and the current value of the
[Revenue] measure:
=If(Not(IsNull([Revenue])) Or Not (IsNull(RefValue([Revenue]))); [Revenue]RefValue([Revenue]))
The following table shows data before a data refresh:
Customer

Revenue

Johnson

2000

Smith

3000

Wilson

3500

After refresh, the data changes as follows:

327

2012-06-11

Tracking changes in data

Customer

Revenue

Johnson

3000

Smith

2500

Placed in a third column, the formula returns the following figures:
Customer

Revenue

Difference

Johnson

3000

1000

Smith

2500

-500

Wilson

3500

27.8 Changed data and the calculation context
When data tracking is activated, data appears as changed only when the calculation context remains the same.
For example, if a measure value changes because you change the calculation context of a block, the new value is not flagged as changed.
Example: Changing the calculation context
In this example you have a block showing [City], [Customer] and [Revenue] as follows:
City

Customer

Revenue

San Francisco

Smith

1000

San Francisco

Jones

2000

Los Angeles

Wilson

3000

Los Angeles

Harris

4000

If you remove [Customer] from the block, revenue is aggregated by city:

328

2012-06-11

Tracking changes in data

City

Customer

San Francisco

3000

Los Angeles

7000

The revenues do not appear as increased because the amount of revenue has not changed. Only the calculation context has changed - revenues are now aggregated by city only, giving higher figures.
If, after a data refresh, Jones’ revenue falls to 1000 and Wilson’s revenue rises to 4000, the data appears as follows:
City

Customer

San Francisco

2000

Los Angeles

8000

The data appears as changed because, independently of the change of calculation context, the total revenue for San Francisco has decreased and the total revenue for Los Angeles has increased.

329

2012-06-11

Tracking changes in data

330

2012-06-11

Sharing content with other applications

Sharing content with other applications

28.1 Publishing content as web services
Note:
You can only publish content as a web service in the "Rich Internet Application" (Java applet) interface and in Web Intelligence RIch Client. This feature is not available for the "Web" interface (DHTML mode).
You can make Web Intelligence content available outside Web Intelligence documents by publishing report blocks (tables, charts or forms) as web services known as BI Services.
Web services provide a standardized mechanism for sharing data between applications. You publish content to a server where other applications can access the web services that supply the content.
Each web service can publish multiple blocks which are made available to web applications through functions that correspond to the blocks. For example, a table published as a web service can be included in a dashboard which can perform filtering and drilling operations on the table through the web service functions. The structure of a BI service is defined using using WSDL (Web Service Definition Language), the standard format for describing web services. Web applications interact with BI services (by passing parameters to them and receiving data in return) using SOAP, a standard protocol for exchanging structured information.
Related Topics
• BI service structure

28.1.1 To publish a report block as a web service
You use the Publish Content wizard to publish a report block as a Web service.
1. Switch to Design, mode.
2. Select the table, chart or form you want to publish, right-click and select Publish as Web Service to display the Publish Content wizard.
3. Click Next to move to the first publishing step.

331

2012-06-11

Sharing content with other applications

Related Topics
• To identify duplicate content

28.1.2 To identify duplicate content
If the report block you are publishing as a web service has already been published, the Identify Duplicate
Content screen of the Publish Content highlights the duplicated blocks. The duplicate block appears in bold beneath the web services that publish it.
•

Click Next to move to the next step.

Related Topics
• To define the web service

28.1.3 To publish prompts
Note:
Note that for web services, to use multiple values in prompts, you must reproduce the prompt as many times as different responses are expected, and the user will be prompted for each response.
1. Select or unselect the prompts you want to include or exclude in the list of prompts.
2. Click Select all to select all prompts or Clear all to clear all prompts.
3. Click Next to move to the next step.

28.1.3.1 Publishing prompts in web services
You use the Choose Prompts screen in the Publish Content wizard to choose which prompts to publish in the web service when the content you want to publish has related prompts.
If you do not publish a prompt, the web service uses the prompt value supplied when the document was last refreshed and saved. For example, if a user answers "US" to a prompt on [Country], then saves the document, the web service filters data on [Country]="US" the next time it is called with the re fresh=true parameter.

332

2012-06-11

Sharing content with other applications

If a web service publishes prompts, web applications must supply values for the prompts in the custom data provider web service window if they call the web service with the refresh=true parameter. If the user does not enter values for the prompts, the last values entered are used.

28.1.4 To define the web service
Before publishing a block as a Web service, you use the Define Published Content screen in the
Publish Content wizard to name the table, make filters available on the block data, and select the server where the block will be published.
Note:
The Share report content for all consumers option below allows all web service consumers (sessions) get the report block content from the same (and single) instance of document. This option reduces memory load on the Processing server, and should be enabled when content is to be consumed by many concurrent users. Technically, the document is opened by the first consumer who sends a request for it, and is then consumed by any other consumer sending same request after ‘on behalf’ of first user
(i.e. using his authorization). Document security cannot therefore be applied with web service calls designed with this option. To avoid any conflicts, all consumers should be granted the permission to open the corresponding document. Users should also be granted permission to view/access data from the underlying data sources.
Filtering and drilling from a web service are not compatible with the Share report content for all consumers option. The only way to filter Web Intelligence document data from web services is to use
“Section filters” (i.e. Use a report section exposed as filters in the corresponding web service).
1. Type the name and description under which you want to publish the table in the Name and
Description boxes.
2. Select Share report content for all consumers when you want all web service consumers (sessions) get the report block content from the same (and single) instance of document.
When this option is selected, the Set Filters option is disabled. This command is disabled because consumers will not be able to use report filters (section filters being the only available way to filter content through mandatory input parameters. Section headers cannot be removed because corresponding web service parameters are mandatory input parameter, since sections are part of the report element structure.
3. Click Set Filters and select the objects you want to make available for filtering in the web service.
4. Select the server where you want to publish the content beneath Host server.
5. To add, remove or edit servers in the list of host servers, click Manage servers, then click Add,
Edit or Remove and update the list of servers.
6. Click Next to move to the next step.
Related Topics
• To publish prompts
• To save and publish a web service

333

2012-06-11

Sharing content with other applications

28.1.4.1 Making data available for filtering in a web service
When you publish a report block as a web service, you can make report objects available that web applications can use to filter the data returned by the web service. For example, if you publish a table containing [Country], [Region] and [Revenue], you can make the [Country] dimension available as a filter. Web applications accessing the web service can then filter on the [Country] dimension.
Filtering objects appear as FilterCondition parameters in the GetReportBlock_ function in the web service.
You make objects available for filtering in the Define published content screen of the Publish Content wizard. The screen lists all the objects in the report and selects the objects in the block you are publishing by default. You can deselect these objects and select any object in the report to make it available as a filter. For example, you can make the [Country] dimension available as a filter when you publish a table containing the [Region] and [Revenue] objects if the [Country] dimension appears in the report. You can also choose not to make the [Region] and [Revenue] objects available as filters.
You do not have to include any report objects as filters except for objects that appear in section headers.
These appear selected and you cannot unselect them.
If you publish a block in a section, by default the web service filters on the value of the section object corresponding to the block you selected. For example, if you have a report containing [Country], [Region] and [Revenue] with [Country] as the section header, and you publish the block in the section where
[Country]="France", the web service uses "France" as the default value of [Country]. A web application accessing the web service can supply a different value for [Country] and the data returned by the web service changes to correspond with the filter.
If you publish a block in a report containing report filters, the objects on which report filters are defined are selected by default in the screen. You can unselect these objects. If you publish the block without making the objects available as filters, the web service filters data according to the values of the report filters. If you make the objects available, web applications can apply the report filters using different values. Related Topics
• GetReportBlock_blockname

28.1.5 To save and publish a web service
You use the Publish new content or re-publish existing content as Web Service screen in the
Publish Content wizard to save and publish the Web service to a host server.
1. To re-publish an existing web service, select the web service, click Publish.

334

2012-06-11

Sharing content with other applications

2. To publish a new web service, select the folder where you want to publish the content and click
Create to display the Publish Web Service dialog box.
Note:
Folders are optional, you publish to an existing web service or a new web service, and you can create folders in order to organize your work. Click New Folder to add a new folder.
3. Type the name of the web service in the Web service name box and the service description in the
Description box.
4. Select the authentication method for the web service from the Authentication list.
5. Click OK to close the dialog box and save and publish the web service.
6. Choose the web service where you want to publish to.
7. Click Finish.

28.2 Viewing and managing published content
You can browse the content published on different Web servers by using the Web Service Publisher pane. The Web Service Publisher pane also allows you to edit published Web services and import
QaaWS (Query as a Web Service) queries, which you can then republish as Web Intelligence content.

28.2.1 To view and manage published content
1. In Design mode, display the Web Service Publisher pane by clicking on the Web Service Publisher icon of the left pane.
2. Select the server from the Host server list.
3. To add, remove or edit servers in the list of host servers, click Manage servers, then click Add,
Edit or Remove and update the list of servers.
4. Select the Views icon and select the way you want the content to be organized from the menu.

335

2012-06-11

Sharing content with other applications

Option

Description

View by web service

Published content is organized as web service > block

View by document and web service

Published content is organized as a document > web service > block

View by document and block Published content is organized as a document > block > web service

Show Web Services queries QaaWS (Query as a Web Service) queries appear below the published content. (QaaWS queries are stored in the same repository folder as
BI services.)

5. To edit a published block, select the block and right-click Edit to launch the Publish Content wizard.
6. To delete published content, select the published block or the Web service and right-click Delete.
7. To rename a web service, select the web service, right-click Rename and type the new name.
8. To refresh the list of published content, click Refresh or right-click on a folder or web service and select Refresh list.
9. To search the list of web services, type the text you want to search for in the search box and select your search options from the menu at the left of the search box.
Option

Description

Case sensitive

Match case when searching

Case insensitive

Ignore case when searching

Match from start

Return only those web services or blocks whose name starts with the search text Match anywhere

Return only those web services or blocks whose name contains the search text Related Topics
• Importing and converting QaaWS (Query as a Web Service) queries
• To publish a report block as a web service

28.2.2 To test published content
You can test published content and examine the structure of the Web service that publishes it.
1. Display the Web Service Publisher by using the Publish new content or re-publish existing content as Web Service screen in the Publish Content wizard.
2. Select the Web service you want to test and click Test.

336

2012-06-11

Sharing content with other applications

3. Select the web service function you want to test from the Operation drop-down list.
4. Select the parameters and operators for which you want to specify values in the Input pane and type their values on the right of the pane beneath Value.
5. Click Send to call the web service with the values you specified.
The data returned by the web service appears in the Server response pane.
6. Click Change to tree view/Change to table view to toggle the web service data between a tree view and table format.

28.3 Importing and converting QaaWS (Query as a Web Service) queries
You can import QaaWS queries and run them to produce a block that is inserted in a new report. When you import a QaaWS query, the application builds a query based on the structure of the QaaWS query, then runs this query and inserts the resulting block in a new report. The original QaaWS query is not modified. Because SAP BusinessObjects Web Intelligence does not support the publication of QaaWS queries directly, you can use this workflow to publish QaaWS queries as BI services by publishing the resulting block as a BI service.
Note:
There is no support for sorts defined on QaaWS queries. When you run the QaaWS query, any sorts it contains are lost.

28.3.1 To publish a QaaWS query
1. Open the Publish new content or re-publish existing content as Web Service screen in the
Publish Content wizard by selecting Publish on the main toolbar.
2. Select View > Display QaaWS queries to display QaaWS queries.
3. Select the QaaWS query you want to import and click Import Web Service query.
The QaaWS query is added to the document as a Web Intelligence query. A report tab is added with the same name as the QaaWS query. The report tab contains a table corresponding to the query objects.
4. Refresh the added query to display the web service query data.
5. Right-click the added table and select Publish as Web Service to publish the table as a web service.
Related Topics
• To publish a report block as a web service

337

2012-06-11

Sharing content with other applications

28.4 BI service structure
External web applications access Web Intelligence content published as web services by calling two functions: • GetReportBlock_blockname
• Drill_blockname
In both these function calls, blockname is the name of the block as defined in the web service.
Applications use the SOAP protocol to call the functions and receive the function output which they can then parse.

28.4.1 GetReportBlock_blockname
Function name
GetReportBlock_blockname

Input parameters
Name

Mandatory?

login

CMS login

Yes, unless sessionID or serialized
Session is specified.

password

CMS password

Yes, unless sessionID or serialized
Session is specified .

reportfilter

One or more report filters. See the table below for more information.

Yes when the report block contains section entries; no otherwise. Blocks with sections therefore have a mix of mandatory and optional reportfilter parameters.

prompt

338

Description

Prompt values. See below for more informa- Yes when refresh = true and the prompt tion on LovIndexValue parameters is mandatory; no false otherwise. If you don't enter prompt value then the prompt takes the values previously defined. The consumption of web services having prompts in Web Intelligence does not mean that you will be prompted, you must enter prompt values in Custom Data Provider Web Service window.

2012-06-11

Sharing content with other applications

Name

Description

Mandatory?

closeDocu- Force document to be closed once the web Boolean, default value : false (by default ment service has replied with the requested con- document is kept open, when web service tent. This behavior helps in optimizing is replied). Values: false or true. memory consumption on the server, as consumers can control how long documents are stored. endRow Defines the last row number retrieved from Optional. If not declared, the entire table the source. This parameter is used with the contents are retrieved. By default, the entire startRow parameter, to define the chunk table contents are retrieved. size to retrieve in table output parameter
(e.g. startRow = 10 / endRow= 55, will retrieve 46 rows between row n°10 and row n°55 included). The last row of a table has rank set equal to table size, any greater value is internally corrected to that number.

startRow

Optional. If not declared, the entire table
Defines the first row number retrieved from contents are retrieved. By default, the entire the source. This parameter is used with the table contents are retrieved. endRow parameter, to define the chunk size to retrieve in table output parameter (e.g. startRow = 10 / endRow= 55, will retrieve
46 rows between row n°10 and row n°55 included). First row of a table has is 1, any lower value is internally corrected to 1.

resetState

Re-opens the document when the web ser- No - default value is false. vice is called, resetting drills and filters.

refresh

Forces document refresh.

No - default value is false.

getFromLat- Retrieves data from the latest document in- No - default value is true. estDocustance. mentInstance getFromUserInstance 339

Retrieves data from user inbox if the docu- No - default value is false. ment has been published.

2012-06-11

Sharing content with other applications

Name

Description

Mandatory?

turnOutput- Turns the output to a vertical table.
No - default value is false.
ToVTable
Note:
If the block is a chart it is always turned to a vertical table even if this parameter is set to false. sessionID Session token to avoid submitting login/pass- No. word. Increases the session count when submitted. serializedSession

Serialized session to avoid submitting lo- No. gin/password. Does not increase the session count when submitted.

reportfilter parameter reportfilter parameters contain two elements:
Name

Description

Values

filtering_value The value used to filter the data

Any

filtering_opera- The filter operator tor EQUAL (default)¦ GREATER ¦ GREATER_OR_EQUAL ¦ LESS
¦ LESS_OR_EQUAL ¦ NOT_EQUAL ¦ INLIST ¦ NOT_INLIST

Example of reportFilter parameter
The filter [Country]="US" is specified as follows:

US
EQUAL

Output parameters
Name

Description

table

TTable

Table cells

headers

THeader

Table headers

footers

TFooter

Table footers

user

string

Login used by the web service call

documentation

string

The web service description supplied by the service designer

documentname

string

The document name

lastrefreshdate

340

Type

dateTime

The date of the last document refresh

2012-06-11

Sharing content with other applications

Name

Type

Description

creationdate

dateTime

The date the web service was created

creator

string

User name of the web service creator

isScheduled

boolean

Specifies if document is scheduled

scheduleStartTime

dateTime

The schedule start time if the document is scheduled

scheduleEndTime

dateTime

The schedule end time if the document is scheduled

tableType

string

The table type

nbColumns

int

The number of columns in the output table

nbLines

int

The number of rows in the output table

Related Topics
• Drill_blockname
• Sample BI service return data

28.4.2 Drill_blockname
Function name
Drill_blockname

Note:
This web service call cannot be used when the document sharing option (Share report content for all consumers in the "Publish Content" wizard) is enabled (such methods will not be specified in web service WSDL file), an error will be returned to the consumer if called when this option is enabled.
Input parameters
The syntax of the Drill_ function is similar to GetReportBlock_, with the following differences:
• there are no reportfilter parameters
• there are additional drillpath parameters
• there is an additional drillfilter parameters
Name

Description

Mandatory?

drillpath

Specifies a drill instruction

Yes

drillfilter

Specifies a filter to apply when drilling

No

Drillpath parameter drillpath parameters are of type DrillPath. They contain three elements:

341

2012-06-11

Sharing content with other applications

Name

Description

Values

from

The dimension to drill

Any

value

The value to drill on

Any

drilloperation

The type of drill operation

UP ¦ DOWN

Note:
•
•
•
•

As well as single values (for example "Los Angeles"), value can pass definitions such as "All Cities".
If the drill instruction is invalid, the web service returns the original table data.
At the end of the drill hierarchy, the web services returns the last available values in the drill hierarchy.
You can supply more than one drillpath parameter providing that the parameters do not refer to different levels in the same drill hierarchy.

Drillfilter parameter drillpath parameters allow you to apply drill filters at the same time as drilling:
Name

Description

Values

dimension

The dimension to Any. filter value

The value to filter Any on operator

The filter operator EQUAL ¦ GREATER ¦ GREATER_OR_EQUAL ¦ LESS ¦
LESS_OR_EQUAL ¦ NOT_EQUAL ¦ INLIST ¦ NOT_INLIST

Note:
•
•
•
•

As well as single values (for example "Los Angeles"), value can pass definitions such as "All Cities"
If the drill instruction is invalid, the web service returns the original table data
At the end of the drill hierarchy, the web services returns the last available values in the drill hierarchy
You can supply more than one drillpath parameter providing that the parameters do not refer to different levels in the same drill hierarchy.

Related Topics
• GetReportBlock_blockname

28.4.3 BI Services output parameters
The following table lists the output parameters returned by a BI Service:

342

2012-06-11

Sharing content with other applications

Name

Type

Description

table

TTable

Table cells

headers

THeader

Table headers cells

footers

TFooter

Table footers cells

user

string

Login used by the web service call

documentation

string

The web service description supplied by the service designer

documentname

string

The document name

lastrefreshdate

dateTime

The date of the last document refresh

creationdate

dateTime

The date the web service was created

creator

string

User name of the web service creator

isScheduled

boolean

Specifies if document is scheduled

scheduleStartTime

dateTime

The schedule start time if the document is scheduled

scheduleEndTime

dateTime

The schedule end time if the document is scheduled

tableType

string

The table type

nbColumns

int

The number of columns in the output table

nbLines

int

The number of rows in the output table

Example of table parameter

345510

...

Example of headers parameter

Revenue

Related Topics
• Sample BI service return data

343

2012-06-11

Sharing content with other applications

28.4.4 Sample BI service return data
Web services return data using SOAP. The following is a sample SOAP file returned by a web service: Add Document Link from the menu to display the "Create Hyperlink" dialog box.
2. Select the Link to a document tab.
3. Click Browse and select the target document in the Choose Document dialog box, or type the document ID in the Document ID box.
4. Select the format of the target document from the Document Format list in the Customize the look and behavior of the hyperlink section.
The format of the document determines which options are available when defining the link. For example, you cannot link to a report part in a PDF document.
a. For a document referring to a BEX query, a .unx universe, or a .unv universe with a prompt that uses index awareness, in the "Document prompts" section, select the key.
b. Click on the key drop-down box and select Build formulaand type =.key()
The object must not be a variable, and the object must have a key.
c. Test that the .key() returns the expected results.

358

2012-06-11

Linking to other documents

If the result does not return the key, ask the universe designer to provide help on how to obtain the key.
5. Select New window or Current window from the Target window list in the Customize the look and behavior of the hyperlink section to determine how the target document opens.
Option

Description

New window

The document opens in a new browser window.

Target window

The document opens in the current browser window and replaces the document containing the hyperlink.

6. Type the tooltip text in the Tooltip box in the Customize the look and behavior of the hyperlink section, or build a dynamic tooltip by using the Build formula or Select object options
Option

Description

Build formula

You build a formula in the Formula Editor to supply the formula output as the tooltip. Select object

You choose the variable from the list in the "Select an Object" dialog box to supply its value as the tooltip.

The tooltip appears when you hover your mouse pointer over the cell containing the hyperlink.
7. Click Use complete URL path to create hyperlink to ensure that the link uses the full URL path rather than a relative path from the current document.
8. Click Refresh on open if you want to refresh the data of the target document when the hyperlink is selected. 9. Click Link to document instance, then select an option from the drop down-list , to link to an instance of the selected document.

359

2012-06-11

Linking to other documents

Option

Description

Most recent

The hyperlink opens the most recent instance.
Note:
You cannot specify parameter values in the hyperlink when you choose this option.

Most recent - current user The hyperlink opens the most recent instance owned by the current user. Note:
You cannot specify parameter values in the hyperlink when you choose this option.
Most recent - matching prompt values

The hyperlink opens the most recent instance whose prompt values correspond to the values passed by the hyperlink.
This option is useful when you want to link to a large document that contains prompts.

10. Click Report name and select the name of the report to link to a specific report if you are linking to a Web Intelligence document.
11. Click Report part, then click Select and right-click the report part (for example a table), to link to a specific part of a report.
12. If you selected Report part, select Display report part only open the report part only in the target document, or Position at report part (full document available) to focus on the report part but display the whole report in the target document.
13. If the document contains prompts, for each prompt in the Document prompts section, select one of the following options from the drop-down list:
Option

Description

Build formula

You use the Formula Editor to build a formula to pass a value to the prompt.

Select object

You select an object whose value is passed to the prompt.

Prompt user at runtime The user specifies a value for the prompt when they click the hyperlink.

Use document de- You configure the hyperlink to not pass a parameter to the target document, fault and the target document opens with the default value for the prompt. The default value is either the last value specified for the prompt, or the default specified in the document.
14. Choose Build Formula or Select Variable from the Cell content list to specify the content of the hyperlink cell.

360

2012-06-11

Linking to other documents

Option

Description

Build Formula

You build a formula in the Formula Editor to supply the formula output as the cell content.

Select Variable

You choose a variable from the list in the "Select an Object" dialog box to supply its value as the cell content.

29.1.3.2 Document instances and values passed to prompts
Hyperlinks supply values to prompts in the target document in two ways: by passing values directly to prompts, or by opening a document instance based on passed values.
In the first case, the hyperlink feeds values directly to the prompts in the target document. In the second case, the link opens the document instance whose stored prompt values correspond to the values passed by the hyperlink. When you click on the url, the target document is automaticaly refreshed, even if the Refresh on open option = No.
It is more efficient to choose a document instance based on passed parameters if the target document is large.
Certain combinations of instance and parameter settings are incompatible or mutually dependent, as described in the following table:
Instance setting

Impact on parameter setting

Most recent

The hyperlink does not pass parameter values.
All parameters are set to Use document default and cannot be modified.

Most recent - current user

The hyperlink does not pass parameter values.
All parameters are set to Use document default and cannot be modified.
You must specify at least one parameter value.
Without at least one specified value, the hyperlink returns an error when clicked.

Most recent - matching prompt values

361

The error occurs because the hyperlink is designed to retrieve an instance based on parameter values, but no value is provided for comparison against the instance.

2012-06-11

Linking to other documents

Related Topics
• Linking to large documents

29.1.3.3 Linking to large documents
When the target document contains a large amount of data, it is more efficient to link to an instance than to open and retrieve the document with a passed parameter value. You can schedule and pre-retreive multiple instances with different parameter values. This allows the document to be scheduled and pre-retrieved in advance with different parameter values.
When you click the hyperlink, the link opens the appropriate pre-retrieved instance rather than using the passed value to open the document and retrieve the data.
Example: Linking to a large sales report
In this example you link to a large sales report that retrieves sales by region. The report has a parameter that allows the user to select the region. There are four regions - North, South, East, and West.
Your source document has a [Region] dimension. You do the following:
•
•
•
•

Configure the hyperlink to pass the value of [Region] as a parameter
Create four instances of the sales report, one for each value of [Region]
Schedule these instances for pre-retrieval
Configure the hyperlink to open the latest instance whose parameter value matches the value passed by the hyperlink

Assuming that the document has a [Region] dimension, the settings are as follows:
Link to document instance setting

Latest value match

Most recent - matching prompt values

[Region]

29.2 Working with hyperlinks

29.2.1 To link to another document from a hyperlink

362

2012-06-11

Linking to other documents

To link to another document from a hyperlink, the hyperlink must first have been created.
1. Hover your mouse pointer over the cell to display the tooltip if a tooltip is defined.
Note:
If you used the "Hyperlink" dialog box to define the link and the Formula Bar is displayed, the generated syntax of the hyperlink appears in the Formula Bar. Do not modify this syntax directly use the "Hyperlink" dialog box if you need to update it.
2. Click the hyperlink to open the target document.
Depending on how the hyperlink is configured, the target document opens in a new browser window, or it replaces the current document in the current browser window.

29.2.2 To edit a hyperlink
1. Right-click the cell containing the hyperlink and select Hyperlink > Edit from the menu to display the "Hyperlink" dialog box.
2. Edit the hyperlink using the "Hyperlink" dialog box.

29.2.3 To delete a hyperlink
•

Select the cell containing the hyperlink and select Linking > Remove.

29.2.4 Formatting hyperlink colors
You can define the colors used to display hyperlinks that have already been clicked (visited hyperlinks) and hyperlinks that have not been clicked (unvisited hyperlinks).

29.2.4.1 To set hyperlink colors
1. Right-click a blank area on the report that contains hyperlinks and select Format Report on the menu. 2. Click the Appearance tab.

363

2012-06-11

Linking to other documents

3. In the Hyperlink color section, click the arrows next to Visited and Unvisited, then either select a predefined color or click More colors to define a custom color.
4. Click OK.

29.3 Linking report elements in a document
You can create links between report elements by defining a report element as an “input control” that filters the values in other report elements. For example, if you have a report containing two tables, you can filter the values in one table depening on the values seleced in the other.
Related Topics
• Input controls defined
• Using tables and charts as input controls

364

2012-06-11

Formatting your reports using Cascading Style Sheets

Formatting your reports using Cascading Style Sheets

30.1 Style sheets explained
Web Intelligence Cascading Style Sheets (CSS) define how to display your reports and determine the presentation of documents. You can edit the CSS to apply a specific style to the presentation of documents. You can export the file, modify the styles according to your needs and then import the file back. You can also distribute the style sheet to other users as a standard style.
Note:
The CSS style sheet does not control the color of charts. There is a separate file for defining corporate palettes for charts.
Using a CSS allows you to:
•
•
•
•

Define a company-wide style sheet in order to define standard settings (such as a company logo).
Define different styles to present a specific type of information. For example, you can use one color for products sold, another color for expenses and another color for revenues.
Create a style sheet in order to encode personal preferences.
Personalize the presentation of the documents you create.

Note:
The Cascading Style Sheest are derived from the W3C CSS.
In order to modify the CSS of your documents, you must be familiar with the CSS core syntax of the
W3C.
Related Topics
• About corporate palettes

30.2 Using the style in documents
When you create a new report or a new report element in a Web Intelligence document, the formatting is entirely based on the default style.

365

2012-06-11

Formatting your reports using Cascading Style Sheets

If specific formatting is done on these elements by the user from the Context menu (Right-click >
Format ), the modified properties overwite locally the values taken from the default style.
To remove this specific formatting, go to Format > Clear Format .

30.3 Modifying the document default style
•

The document default style is stored in a Cascading Style Sheet (CSS) file that is embedded into the document itself.

•

You can modify the default style by exporting the CSS file.
To export a CSS file go toProperties > Document > Change Default Style > Export Style.

•

You can use any text editor to edit the CSS file. Once you have edited the CSS, save the file and import it to apply the changes.
Note:
You have to import the CSS file every time you edit it.

•

To import a CSS file go toProperties > Document > Change Default Style > Import Style. The
CSS file you import is applied to the report.
Note:
If the properties of an element have been set through the user interface (toolbox, context menu, dialog box), these properties are not affected by the CSS you import.

•

To apply a CSS to an element that has already been formatted through the user interface, you have to clear its format. To clear the format of an element, select the element and go to Format > Clear
Format.

•

To clear the format of all the elements in a page, select the BODY and go to Format > Clear Format.
Note:
You have to clear the format of the HEADER and the FOOTER manually as they are not contained in the BODY.

•
•

You can undo changes at any time by using the UNDO option.
You can restore the default CSS at any time by going toProperties > Document > Reset standard
Default Style.

30.4 Modifying and using the standard default style

366

2012-06-11

Formatting your reports using Cascading Style Sheets

The standard CSS file is named WebIDefaultStyleSheet.css and it is located in c:\Program
Files(x86)\SAP BusinessObjects Entreprise XI\images\WebIDefaultStyleSheet.css.
When you create a new document or when you edit a Web Intelligence 3.X document for the first time, the standard CSS is taken and embedded into the Web Intelligence document to become the document style. This default style document diverges from the standard and can be locally modified.
If you want to reset the document default style to the standard style, go to Properties > Document >
Reset standard Default Style. The standard CSS will replace the previous CSS in the document.
To publish a standard default file, you must have access to the ../images/ folder of your servers and
Web Intelligence Rich Client installations to put a new version of WebiDefaultStyleSheet.css.

30.5 Web Intelligence CSS syntax
The Web Intelligence CSS conforms to the W3C CSS core syntax. However, the core syntax does not imply anything about property names, types and semantic.
Web Intelligence CSS supports locale-specific style sheets.
Related Topics
• W3C CSS core syntax

30.5.1 Elements
In order to modify the way your document is displayed, you have to modify the Web Intelligence CSS elements of the document. To modify an element, you have to modify its properties.
This table shows the elements you can edit in the CSS file:
Element

REPORT

Tag that contains the report

PAGE_BODY

Tag that contains the page

PAGE_HEADER

Tag that contains the area on top of the PAGE_BODY

PAGE_FOOTER

Tag that contains the area in the bottom of the PAGE_BODY

SECTION

Tag that contains an area inside the PAGE_BODY

TABLE

Tag that contains a table

VTABLE

367

Definition

Tag that modifies a table vertically

2012-06-11

Formatting your reports using Cascading Style Sheets

Element

Definition

HTABLE

Tag that modifies the table horizontally

COLINFO

Tag that contains the columns of a table

ROWINFO

Tag that contains tha rows of a table

CELL

Tag that contains the cells of a table

AXIS

Tag that defines the relationship between the columns and rows of a table

FORM

Tag that contains a form

XELEMENT

Tag that contains a graphic

BAG

Tag that contains elements and places them relatively using X and Y

WOB

Tag that contains elements and places them automatically

30.5.2 Properties
For many properties, Web Intelligence CSS uses the same names as the W3C CSS. However, some property names change and some are ignored.
Example:
Web Intelligence CSS uses the property min-width and the W3C CSS uses the property width.
Both properties have the same use.
Related Topics
• For CSS 2.1
• For CSS 3

30.5.2.1 Page related properties
This table shows the properties that can be applied to the element REPORT:

368

2012-06-11

Formatting your reports using Cascading Style Sheets

Property name

Description

Default value
Value range

page-formatdimensionheight

Height of page

42094

Numeric value

page-formatdimensionwidth

Width of page

29764

Numeric value

0

Numeric value

page-format- Size of the bottom margin of the page margin-bottom page-formatmargin-left

Size of the left margin of the page

0

Numeric value

page-formatmargin-right

Size of the right margin of the page

0

Numeric value

page-formatmargin-top

Size of the top margin of the page

0

Numeric value

page-formatorientation

Orientation of page

portrait

land scape, portrait

page-records- In 'quick display mode', specifies how many data
150
records can be horizontally displayed before triggering horizontal a page break page-records- In 'quick display mode', specifies how many data
50
records can be vertically displayed before triggering a vertical page break

Numeric value

page-scaling- Zoom percentage factor 369

Numeric value

Numeric value

100

2012-06-11

Formatting your reports using Cascading Style Sheets

Property name

Default value
Value range

Description

page-scaling- When this property is defined, the report will be scaled 100 so that it fits in the given height tall Numeric value

page-scaling- When this property is defined, the report will be scaled 0 so that it fits in the given width wide Numeric value

page-targetmode

Pagination mode: quick display or not

undefined unde fined, quick, all 30.5.2.2 Report element properties
This table shows the properties that you can edit to modify the Report elements:
Property
name

Description

Default value Value range

autofitheight

Specifies whether the height of the element can be adjusted to fit its content

yes

yes/no

autofitwidth

Specifies whether the width of the element can be ad- yes justed to fit its content

yes/no

bookmark

Specifies whether the element will be bookmarked

no

yes/no

h-align

Horizontal positioning of the element

none

none, top, center, bot tom hide

Specifies whether the element is hidden

no

yes/no

minheight

Minimal height of the element

0

Numeric value

0

Numeric value

min-width Minimal width of the element never-al ternate

no

yes/no

paddingbottom

How much space to put between the bottom border and the content of the element

0

Numeric value

paddingleft

370

This property can be used to avoid the application of the alternate style on the element

How much space to put between the left border and the content of the element

0

Numeric value

2012-06-11

Formatting your reports using Cascading Style Sheets

Property name Description

paddingright

How much space to put between the right border and 0 the content of the element

Numeric value

paddingtop

How much space to put between the top border and the content of the element

0

Numeric value

structminheight

Minimal height of the element when displayed in structure mode

900

Numeric value

Default value Value range

structMinimal width of the element when displayed in struc- 4050 min-width ture mode v-align Vertical positioning of the element

none

Numeric value none, top, center, bot tom These properties can be applied to the following elements:
•
•
•
•
•
•
•
•
•

BAG
WOB
CELL
VTABLE
HTABLE
XTABLE
TABLE
XELEMENT
SECTION

30.5.2.3 Formatting properties
This table shows the properties that you can edit to modify the Formatting elements:

371

2012-06-11

Formatting your reports using Cascading Style Sheets

Property name

Description

Default value
Value range

backgroundcolor

Color to be displayed in background

#000000

backgroundfill

Describes what will be displayed in back- none ground background-h- Horizontal position of the background im- center age align

Any hexadecimal color color, bitmap, bitmapAndColor, skin, none left, center, right

backgroundimage

Image to be displayed in background

None

Any image you want

backgroundinner-height

Inner height of background

0

Numeric value

backgroundinner-width

Inner width of background

0

Numeric value

backgroundtype

Determines how the background image will be laid out or repeated

box

box, tile, vtile, htile, stretch

background-v- Vertical position of the background image center align top, center, bottom

border-bot tom-color #000000

Any hexadecimal color

border-bot tom-style Style of an element's bottom border

none

none, dashed, dot ted, double, plain

border-bot tom-width Width of an element's bottom border

0

Numeric value

border-leftcolor

Color of an element's left border

#000000

Any hexadecimal color

border-leftstyle

Style of an element's left border

none

none, dashed, dot ted, double, plain

border-leftwidth

Width of an element's left border

0

Numeric value

border-right- Color of an element's right border color #000000

Any hexadecimal color

border-right- Style of an element's right border style none

none, dashed, dot ted, double, plain

border-right- Width of an element's right border width 372

Color of an element's bottom border

0

Numeric value

2012-06-11

Formatting your reports using Cascading Style Sheets

Property name

Description

Default value
Value range

border-topcolor

Color of an element's top border

#000000

Any hexadecimal color

border-topstyle

Style of an element's top border

none

none, dashed, dot ted, double, plain

border-topwidth

Width of an element's top border

0

Numeric value

color

Foreground color

#000000

Any hexadecimal color

default-date- Default horizontal alignment when a date right is being displayed h-align lleft, center, right, auto

default-numer Default horizontal alignment when a numer- right ic value is being displayed ic-h-align left, center, right, auto

default-text- Default horizontal alignment when a text is being displayed h-align left

left, center, right, auto

default

Webi supported fonts

font-family

Name of font family

font-orienta tion Describes the orientation of the displayed normal text normal, hotel, 45D,
90D, 180D, 270D,
315D

font-size

Size of the displayed font

0

Numeric value in points
(pt.)

font-styleitalic

Activates the italic font style

no

yes/no

font-weightbold

Activates the bold font style

no

yes/no

text-align

Horizontal alignment of the text

left

left, center, right, auto

text-decora tion-linethrough Activates the line-through text decoration no

yes/no

text-decora tion-under line

Activates the underline text decoration

no

yes/no

text-v-align

Vertical alignment of the text

bottom

top, center, bottom

text-wrap

Specifies whether the text may be wrapped no

yes/no

These properties can be applied to the following elements:
•

373

BAG

2012-06-11

Formatting your reports using Cascading Style Sheets

•
•
•
•
•
•
•
•

WOB
CELL
VTABLE
HTABLE
XTABLE
TABLE
XELEMENT
SECTION

30.5.2.4 Spacing properties
This table shows the properties that you can edit to modify the Spacing elements:
Property name

Description

Default value

h-spacing

Horizontal spacing of children 0

Numeric value

v-spacing

Vertical spacing of children

Numeric value

0

Value range

These properties can be applied to the following elements:
•
•

BAG
WOB

30.5.2.5 Hyperlink properties
This table shows the properties that you can edit to modify the Hyperlink elements:

374

2012-06-11

Formatting your reports using Cascading Style Sheets

Property name Description

Default value

Value range

active-col or Color of hyperlinks when they are being activat- #000000 ed Any hexadecimal color ahover-col or Color of hyperlinks when the user designates it #000000
(by a pointing device)

Any hexadecimal color link-color

Color of hyperlinks

#0000ff

Any hexadecimal color visitedcolor

Color of visited hyperlinks

#000000

Any hexadecimal color These properties can be applied to the following elements:
•
•
•
•
•
•
•
•
•

BAG
WOB
CELL
VTABLE
HTABLE
XTABLE
TABLE
XELEMENT
SECTION

30.5.2.6 Break properties
This table shows the properties that can be applied to the element BREAK:
Property name Description

Default value

Value range

false

true/false

break-new page Reports always start on a new page

breakonepage

Reports start on a new page only if they do not fit true in the current page

true/false

30.5.3 Units
When you assign a numeric value to the property font-size you can only use the unit "points" (pt).

375

2012-06-11

Formatting your reports using Cascading Style Sheets

Example: font-size : 14pt;
When you assign a numeric value to any other dimension property, you can use centimeters (cm), inches (in) or "metric" (without any unit).
Example:
width : 1.0in; would be the same as width : 2.54cm; and the same as width : 3600;

30.6 Style and 3.x documents
The Web Intelligence CSS replaces the old way of personalizing your documents.
When you open a Web Intelligence 4.x document with a Web Intelligence 3.x format, the style of the document does not change, regardless of the style defined in the standard CSS. However, the style used while creating new report elements or during Turn into operations will come from the CSS.
To set the default style defined by the report elements in the document, select the report elements and go to Format > Clear Format. The formatting of the selected objects will be cleared and the default style will be applied.
The DefaultConfig.xml file used in the previous versions is obsolete.
Here are some correspondances between the entries of Web Intelligence CSS and the obsolete entries of the DefaultConfig.xml file used in previous versions.
WebI selector

Corresponding entry in defaultConfig.xml

TABLE

table*Table

FORM

table*Form

SECTION

Section*background

CELL

freeCell*default

30.7 Web Intelligence CSS restrictions
•
•
•

376

The options Export Style, Import Style and Reset standard Default Style only work in the Web
Intelligence Rich Client and the Web Intelligence applet.
The Web Intelligence CSS does not define the style of the application (applet, DHTML).
It is not possible to modify the style sheet of a document through the user interface (applet or DHTML).

2012-06-11

Formatting your reports using Cascading Style Sheets

•
•

377

The Web Intelligence CSS is not a document template: it does not define the default structure of documents. The Web Intelligence CSS does not accept ID selectors since users cannot manage objects IDs.

2012-06-11

Formatting your reports using Cascading Style Sheets

378

2012-06-11

Creating a corporate palette for charts

Creating a corporate palette for charts

31.1 About corporate palettes
You can define a corporate palette for charts so that your reports have the corporate style. The palette colors are defined in the configuration file called VisualizationConfig.xml. You can only define one corporate palette and the palette ID must not be changed.
The default palette contains 32 defined colors. You can define more colors, but you must define at least two colors. You define a color by defining the strengths of red (R), green (G), blue (B), and the transparency (A).
Example:

Related Topics
• To create a new query based on a BEx query

31.2 Corporate palette configuration file syntax
The corporate chart palette configuration file VisualizationConfig.xml is in the C:\Program
Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\images directory and contains the following elements:

379

2012-06-11

Creating a corporate palette for charts

Related Topics
• To define a corporate palette for charts

31.3 To define a corporate palette for charts
The Administrator can define a corporate palette using the following configuration file:
VisualizationConfig.xml. This corporate palette will then be used as default for all new charts.
1. In the directory C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects
Enterprise XI 4.0\images, open the template file: VisualizationConfig.template.xml.
2. Define at least two colors, or edit the ones present in the template file.
3. Rename the file: VisualizationConfig.xml and save it in the same directory.
4. Restart TOMCAT.
This corporate palette will be used as default for all new charts. Make sure there are no errors in the configuration file, otherwise the standard palette will be applied.
Restart TOMCAT each time you modify this file.

380

2012-06-11

Error Messages

Error Messages

The following section covers the different error messages and their solutions that might appear under certain conditions while using this application.

32.1 Web Intelligence Error Messages
Web Intelligence error messages include the following ranges and categories:
• Web Intelligence Java interface (WIJ) Error Messages
• Web Intelligence HTML interface (WIH) Error Messages
• Web Intelligence Desktop (WIO) Error Messages
• Web Intelligence Server (WIS) Error Messages
• Web Intelligence Report Engine (RWI) Error Messages

32.1.1 Web Intelligence (WIJ) Error Messages
Web Intelligence Java interface error messages include the following:
Range

Category

WIJ 10000 - WIJ 77778

Web Intelligence Java interface

You need to use the Formula Editor to create a formula. (Error: WIJ
10000)
Cause
You typed a formula into a cell using the Cell Properties panel instead of the Formula Editor.

381

2012-06-11

Error Messages

Action
Launch the Formula Editor and define the formula in the Formula Definition pane.

You cannot create a variable that has the same name as an existing document object. Give the new variable a different name. (Error: WIJ
10001)
Cause
A single document cannot contain multiple objects or variables with the same name.
Action
To save a new variable, give the variable a name that is different from the objects and variables already included in the document.

You cannot position this report component in relation to a block, cell, or section that is positioned relative to this report component.
Select a different block, cell or section in the dropdown list or unselect the Relative To option. (WIJ 10500)
Cause
When you position a report component in relation to another report component that references the selected one, you create a circular attachment.
Action
Remove relative positioning, or select a different block, cell, or section for relative positioning.

Web Intelligence requires the Java Runtime Environment (JRE) 1.4.2_01.
The currently installed JRE is {0}. Contact your administrator to upgrade to 1.4.2_01 or select the [default VM] entry in the [Java
Plug-in Control Panel], if you already have the required version installed. (WIJ 11111)
Cause
When you use the Java interface, a Java applet is installed on your local PC. The Java Runtime
Environment 1.4.2_01 (or later version) needs to be installed and selected in order for the report panel to function.
Action
If Java Runtime Environment 1.4.2_01 (or later version) is already installed on your PC, then launch the Java Plugin Control panel. To do this:

382

2012-06-11

Error Messages

•

Select the Windows menu: Start > Settings > Control Panel.

•

Double-click Java Plug-in.

•

On the Advanced tab, select Use Java Plug-in Default, then click Apply.

Or
Contact your administrator, and request help with installing Java Runtime Environment 1.4.2_01 (or later version).

An error occurred while the document was being decoded. Try to open the document in the BI Launch Pad, or contact your administrator for further information. ( WIJ 20000)
Cause
Web Intelligence cannot decode and open the document in the Java Report Panel.
Action
Open the document in InfoView by clicking the document title where the document is listed on the
InfoView Corporate Documents or Personal Documents page.
If this does not work, see your administrator.

An unexpected problem occurred when during document refresh and open.
The data source has been modified or deleted, or a prompt on the document has no value selected. (WIJ 20001)
Cause
The document has the Refresh on open option selected. One or more of the following explanations can account for this error:
•

The data source has been modified since the document was created.

•

The data source has been deleted since the document was created.

•

One or more prompts have no values selected.

Action
See your administrator.

383

2012-06-11

Error Messages

Unexpected error. If you cannot reconnect to the server, close your session and start again. (WIJ 20002)
Cause
The server may be down or your user session may be closed.
Action
See your administrator.

Unable to get the first page of the current report.\nCheck the validity of your report. (ERR WIJ 20003).
Cause
The report cannot be displayed because it contains structural errors.
Action
Do one of the following:
•

View the report in Structure View and verify the report structure. For example, errors can be caused if report blocks overlap or if the structure of a table contains cells that create an asymmetrical table format. Modify the report structure appropriately.

•

Contact your administrator and request them to search for structural anomalies in the report.

The current query contains unresolvable objects. The query will be updated (WIJ 20004).
Cause
There are objects that cannot be resolved in the query.
Action
Check that the related objects have not been deleted from the data source.

The current request has returned corrupted data. Contact your administrator for further information ( WIJ 20005).
Cause
The returned data is corrupted. This could be due to data source or network issues.

384

2012-06-11

Error Messages

Action
Contact your administrator.

Unable to contact the application server. Contact your administrator for further information (WIJ 20010).
Cause
The application server could be down, or address different to the one expected.
Action
Contact your administrator.

The {0,number} MB report element you want to copy is too large to be exported to an external application.\nThe maximum allowed size is
{1,number} MB. (Error: WIJ 30004)
Cause
The report element you want to copy is too large to be copied.
Action
Do not attempt to copy the report element.

Your user profile does not give you access to a document domain to save corporate documents. Save this document as a personal document or contact your administrator (ERR WIJ 40000).
Cause
You do not have the rights to save the document to the corporate repository.
Action
Save the document as a personal document or ask your administrator for the rights to save the document to the repository.

385

2012-06-11

Error Messages

The query in this document is empty. Check that the Result Objects pane on the query tab includes objects before running the query (ERR
WIJ 30000).
Cause
The query does not contain any result objects.
Action
Edit the query and add result objects..

At least one query in this document is empty. Check that the Result
Objects pane on each query tab includes objects before running the queries (ERR WIJ 30001).
Cause
A query does not contain any result objects.
Action
Add the result objects to the empty query.

Out of memory. Reduce the browser window size or re-launch the report panel. (WIJ 30003).
Cause
Your computer has run out of the memory. This may be because your browser window size is too large.
Action
Do one of the following:
•

Reduce the size of the browser window.

•

Relaunch the Java interface.

Your user profile does not allow you to save personal or corporate documents. Contact your administrator for further details. (WIJ 40001)
Cause
Your user profile, defined by your administrator, does not allow you to save personal or corporate documents. 386

2012-06-11

Error Messages

Action
If you think you need to be allowed to save personal documents and/or corporate documents to InfoView, contact your administrator to request they modify your security profile.

Your version of Web Intelligence Rich Client is not up-to-date to connect to this system (ERR WIJ 50003).You must upgrade your Web
Intelligence Rich Client by clicking here.
Cause
Your version of Web Intelligence Rich Client is not recent enough to connect to the repository.
Action
Upgrade your version of Web Intelligence Rich Client by following the link.

The information sent to the server contains invalid character(s). Use the Undo button to cancel the latest changes to the document and then retry. (Error: WIJ 55555)
Cause
There is an error in the XML sent to the server by the application.
Action
Use the Undo feature to remove the erroneous modification made to the document, and then run the query or refresh the document again.

The session timed out. The document {document_name}.wid has been autosaved in the Favorites\~InteractiveAnalysis folder. Click Restore to retrieve it. (WIJ 60001)
Cause
Due to a server timeout, the current document was autosaved in the Favorites\~InteractiveAnalysis folder. Action
Click Restore to retrieve the autosaved document.
If you cannot restore the document automatically, retrieve it manually from the folder. The name of the autosaved document is the original document name with an automatically-generated prefix and postfix.
Retrieve the document from the autosave folder as quickly as possible. This folder is not a permanent storage location for autosaved documents.

387

2012-06-11

Error Messages

The session timed out, but the document could not be autosaved because the following security rights are not assigned (WIJ 60002):
{list_of_rights}
Cause
The document could not be autosaved because you do not have some or all of the following security rights: • Edit object
•

Delete object

•

Add object

Action
Ask your administrator to assign you the appropriate security rights.

The document cannot be retrieved due to a server problem (WIJ 77777).
Cause
The document cannot be retrieved because the server is down.
Action
See your administrator.

The Central Management System is not functioning. Contact your administrator for further information. (WIJ 77779)
Cause
The Central Management System (CMS) is not running.
Action
Contact your administrator.

Your session timed out. Please close the Java interface and log on again. (WIJ 77778)
Cause
You have remained logged in to the Bi launch pad without using the Java interface for longer than the maximum time allowed by the system.

388

2012-06-11

Error Messages

Action
Log out and then log back into the BI launch pad to continue using the Java interface (you will lose any unsaved modifications you made previous to timeout).
To increase the length of time you are allowed to remain logged in to the BI launch pad ask your administrator to increase your session timeout parameter.

32.1.2 Web Intelligence Desktop (WIO) Error Messages
Web Intelligence Desktop (Rich Client) error messages include the following:
Range

Category

WIO 00001 - WIS 30284

Web Intelligence Desktop

Web Intelligence Desktop cannot log in. (WIO 00001)
Cause
The browser cache might be full – under certain circumstances this can prevent Web Intelligence
Desktop from logging in.
Action
Empty the browser cache if it is full. If Web Intelligence Desktop still cannot log in, see your administrator.

Cannot open the hyperlink (WIO 00002).
Cause
•
•

389

The URL in the hyperlink is incorrectly constructed.
The hyperlink references a document in a “CMC”. Documents in a “CMC” are not always accessible from Web Intelligence Desktop for two reasons:
• The hyperlink does not specify the name of the server hosting the document because the Use complete URL path to build document hyperlink setting is not selected. Incomplete URLs are invalid when used outside the BI launch pad.
• The hyperlink builds the complete URL, but the server specified in the URL is not accessible from the computer running Web Intelligence Rich Client.

2012-06-11

Error Messages

Action
Correct the hyperlink or see your administrator for help.

There is no more memory available. (WIS 30280) (WIO 30280)
Cause
Your system is out of memory.
Action
Close open documents to free memory.

Cannot continue because memory is low. Please close documents to free memory. (WIO 30284)
Cause
Your system memory is low.
Action
Close open documents to free memory.

32.1.3 Web Intelligence Server (WIS) Error Messages
Web Intelligence Server error messages include the following:
Range

Category

WIS 30000 - WIS 40000

Web Intelligence Server

The query in this document is empty. (WIS 30000)
Cause
No data is defined for this document.
Action
Add result objects to the query.

390

2012-06-11

Error Messages

At least one query in the document is empty. (WIS 30001)
Cause
No data is defined for at least one of the queries in this document.
Action
Add result objects to the query.

Your security profile does not include permission to edit queries.
(WIS 30251)
Cause
You do not have the right to edit queries.
Action
Contact your administrator to request the ability to edit the queries in documents.

Your security profile does not include permission to edit documents.
(WIS 30252)
Cause
You do not have the right to edit documents.
Action
Contact your administrator and request the ability to edit documents.

Your security profile does not include permission to refresh documents.
(WIS 30253)
Cause
You do not have the right to refresh documents.
Action
Contact your administrator to request the ability to refresh documents.

391

2012-06-11

Error Messages

Your security profile does not include permission to refresh lists of values. (WIS 30254)
Cause
You do not have permission to refresh lists of values.
Action
Contact your administrator to request the ability to refresh lists of values in documents.

Your security profile does not include permission to use lists of values. (WIS 30255)
Cause
You do not have permission to use lists of values.
Action
Contact your administrator to request the ability to use lists of values in documents.

Your security profile does not include permission to view the script generated by the query. (WIS 30256)
Cause
You do not have the permission to view the script generated by the query.
Action
Contact your administrator to request the ability to view the script in queries.

Your security profile does not include permission to use the formula language. (WIS 30257)
Cause
You do not have permission to use the formula language or create variables.
Action
Contact your administrator to request the ability to use the formula language and create variables in documents. 392

2012-06-11

Error Messages

Your security profile does not include permission to perform drill analysis. (WIS 30258)
Cause
You do not have permission to perform drill analysis.
Action
Contact your administrator to request the ability to drill on reports.

Your security profile does not include permission to extend the scope of analysis. (WIS 30259)
Cause
You attempted to perform a drill operation outside the defined scope of analysis, and you do not have permission to drill outside the scope of analysis.
Action
Contact your administrator.

An internal error occurred while calling the {api_name} API. (WIS
30270)
Cause
Information about the document or the data source is invalid or not available.
Action
Your administrator can trace the problem that caused the error by activating the tracking and verifying the trace associated with the API.

The document is too large to be processed by the server. (WIS 30271)
Cause
When you view a document in Portable Document Format (PDF) or Microsoft Excel format, the server generates binary based output, which is then interpreted by your web browser. This error occurs if the size of the binary output is greater than the maximum size specified by your administrator for the server.
Action
Contact your administrator and ask them to increase the maximum size.

393

2012-06-11

Error Messages

The document is too large to be processed by the server. (WIS 30272)
Cause
When you view a document in HTML format, the server generates character-based output, which is then interpreted by your web browser. This error occurs if the size of the character output is greater than the maximum size specified by your administrator for the server.
Action
Ask your administrator to increase the maximum document size.

The query or report could not be generated.(WIS 30351)
Cause
It was not possible to complete one or more of the steps required to define a query and generate a report. This is due to one of the following reasons:
•

the document was not initialized

•

the data source is not valid

•

the query was not defined

•

the query context was not defined at the universe level

•

no values were specified for prompts at the universe level

Action
Contact your administrator and ask them to check the connection to the data source, and that the universe does not contain unspecified contexts and prompt values.

A query with this name already exists. (WIS 30371)
Cause
Another query used in this document already has this name.
Action
Enter a different name for this query.

394

2012-06-11

Error Messages

The Web Intelligence server memory is full. Log off and try to connect later. If the problem persists, contact your administrator. (Error:
ERR_WIS_30280) (WIS 30280)
Cause
The server memory is full.
Action
Try again later. If the problem persists, see your administrator.

The Web Intelligence server is busy. Save any pending change and try again later. If the problem persists, contact your administrator.
(Error: ERR_WIS_30284) (WIS 30284)
Cause
The server is busy.
Action
Save any changes and try again later. If the problem persists, see your administrator.

The Web Intelligence server is running out of memory, your document has been closed. If the problem persists, contact your administrator.
(Error: ERR_WIS_30285) (WIS 30285)
Cause
The server memory is full.
Action
Try again later. If the problem persists, see your administrator.

You cannot edit this document because the query property option "Allow other users to edit the query" was not enabled when the document was created. (WIS 30381)
Cause
The creator of the document did not select the query property option: "Allow other users to edit the query". 395

2012-06-11

Error Messages

Action
Do one of the following:
•
•

Ask the document creator to enable the option and re-save the document.
Save a copy of the document as a personal document and then edit the query in the copy.

An internal error has been generated by the WIQT. (WIS 30551)
Cause
An unexpected error occurred on the WIQT.
Action
Contact your administrator.

Your WIQT session has reached timeout. Log out and log in again to the BI launch pad. (WIS 30553)
Cause
You have remained logged into the BI launch pad without using Web Intelligence for longer than the maximum time allowed by the system.
Action
Log out and then log back into the BI launch pad (you will lose any unsaved modifications you made previous to timeout).
To increase the length of time you are allowed to remain logged in to the BI launch pad, ask your administrator to increase your session timeout parameter.

No more WIQT servers are available. The maximum number of concurrent users is already logged in. (WIS 30554)
Cause
The maximum number users are already logged in.
Action
Try again later, or ask your administrator to increase the maximum number of concurrent users.

396

2012-06-11

Error Messages

Your security profile does not include permission to save documents as corporate documents or to send documents using the BI launch pad.
(WIS 30555)
Cause
Your security profile does not allow you to save documents as personal or corporate documents, or to schedule documents.
Action
Contact your administrator to request the ability to do the following:
•

Save corporate documents

•

Send documents to users in own groups

•

Send documents to users in other groups

A corporate document with this name already exists. Your security profile does not include permission to delete corporate documents created by other users. (WIS 30556)
Cause
Your security profile does not allow you to overwrite existing corporate documents.
Action
Contact your administrator to request the ability to delete corporate documents saved by other users.

There is no document with this name in the repository. Specify a different document name. (WIS 30557)
Cause
There is no document with this name in the repository for one of the following reasons:
•

You have typed the document name incorrectly

•

The document with this name has been deleted from the repository

Action
Check that you have entered the document correctly.
Note:
Deleted documents cannot be retrieved.

397

2012-06-11

Error Messages

Cannot perform the intended action on this document. (WIS 30650)
Cause
The server is unable to complete the current task because of lack of resources or access problems.
Action
Do one of the following:
•

Close your session, log out of the BI launch pad then log in again.

•

Ask your administrator to verify that your security profile allows you access to the corporate repository.

The server failed to load the XML document. (WIS 30751)
Cause
When you migrate a BusinessObjects document to Web Intelligence 6.x, an XML file is created that can be opened by the Web Intelligence Report Server. (The related module on the Administration
Console is called the WIReportServer). In this case an unexpected error occurred on the Web Intelligence
Report Server while migrating a document to Web Intelligence 6.x.
Action
Your administrator can trace the problem that caused this error by activating the tracking and verifying the trace associated with the WIReportServer. Contact your administrator with this information.

The XML file for this document cannot be opened. Contact your administrator. (WIS 30752)
Cause
When you migrate a Desktop Intelligence document to Web Intelligence 6.x, an XML file is created that can be opened by the server. This error occurs when the XML file cannot be opened by the server, and so migration cannot be completed. There are two common causes:
•

The XML is Read Only.

•

The file path to the XML file is incorrect.

Action
Contact your administrator with this information.

398

2012-06-11

Error Messages

An error occurred while parsing the XML document. Contact your administrator. (WIS 30753)
Cause
When you migrate a Desktop Intelligence document to Web Intelligence 6.x, an XML file is created that can be opened by the server. This error occurs when the XML file contains structural anomalies that the server cannot interpret, and so migration cannot be completed.
Action
There are two possible actions that an administrator can take to solve this problem:
•

Open the XML file with an XML editing tool and verify the structure of the document.

•

Activate the tracking and verify the trace associated with the WIReportServer.

The Web Intelligence 2.x document could not be migrated. (WIS 30761)
Cause
An unexpected error occurred when trying to migrate a Web Intelligence 2.x document to the current document format.
Action
An administrator may be able to identify the cause of this error by activating the tracking and verifying the trace associated with the server. Contact your administrator with this information.

This document cannot be migrated. The query and report of the original
Web Intelligence 2.x document are not synchronized. Try to refresh and save the original document; then attempt migration again. (WIS
30762)
Cause
In the original Web Intelligence 2.x document, there is a discrepancy between the objects included in the query and the objects included in the report. This means that the server is unable to interpret the document correctly to migrate it to the current document format.
Action
To synchronize the data definition in the query and report of the original Web Intelligence 2.x document:
1. Use Web Intelligence 2.x to open the original document again.
2. Either run the query or refresh the document data.
3. Save the refreshed document.

399

2012-06-11

Error Messages

4. Try to migrate the document again using the Migration Tool.
If you do not have access to Web Intelligence 2.x or the Migration Tool, contact your administrator with this information.

The Web Intelligence 2.x document could not be migrated, because the
WIQT module returned an error. Contact your administrator. (WIS 30763)
Cause
The original Web Intelligence 2.x document could not be migrated to the current document format, due to an error generated by the WIQT process.
Action
Your administrator can trace the problem that caused this error by activating the tracking and verifying the trace associated with the WIQT. Contact your administrator with this information.

Your user profile does not provide you with access to a document domain to save corporate documents. Save this document as a personal document or contact your administrator. (WIS 40000)
Cause
Your user profile does not include permission to save documents to a corporate document domain in the repository.
Action
Do one of the following:
•

Save the document as a personal document.

•

Contact your administrator and request access to a corporate document domain.

32.1.4 Web Intelligence Desktop HTML Interface (WIH) Error Messages
Web Intelligence Desktop HTML interface error messages include the following:
Range
WIH 00000 - WIH 00020

400

Category
Web Intelligence Desktop HTML interface

2012-06-11

Error Messages

32.1.4.1 The document could not be saved. (WIH 00014)
Cause
The document could not be saved to the repository. This error can occur for a number of reasons. For example: you do not have the security rights to the folder where you tried to save the document.
Action
See your administrator to determine why you could not save the document.

The session timed out. The document {document_name}.wid has been autosaved in the Favorites\~WebIntelligence folder. Click Restore to retrieve it. (WIH 00015)
Cause
Due to a server timeout, the current document was autosaved in the Favorites\~WebIntelligence folder.
Action
Click Restore to retrieve the autosaved document.
If you cannot restore the document automatically, retrieve it manually from the folder. The name of the autosaved document is the original document name with an automatically-generated prefix and postfix.
Retrieve the document from the autosave folder as quickly as possible. This folder is not a permanent storage location for autosaved documents.

The session timed out, but the document could not be autosaved because the following security rights are not assigned (WIH 00016):
{list_of_rights}
Cause
The document could not be autosaved because you do not have some or all of the following security rights: • Edit object
•

Delete object

•

Add object

Action
Ask your administrator to assign you the appropriate security rights.

401

2012-06-11

Error Messages

32.1.5 ReportEngine Web Intelligence (RWI) Error Messages
ReportEngine Web Intelligence error messages include the following:
Range

Category

RWI 00000 - RWI 00850

ReportEngine Web Intelligence

32.1.5.1 RWI 00000 - RWI 00314

User input is required for the prompt in the query. (RWI 00000)
Cause
The server requires prompt values in order to fulfill the request.
Action
Enter values for all mandatory prompts.

User input is required to select an universe context for the query.
(RWI 00001)
Cause
The server requires context(s) selection in order to fulfill the request.
Action
Supply context(s) choice.

The argument cannot be null. (RWI 00010)
Cause
The specified argument is "null".

402

2012-06-11

Error Messages

Action
Enter a non-null value for the argument.

Invalid value: {0}. (RWI 00011)
Cause
The specified argument value is invalid.
Action
Enter a valid value for the argument.

The argument is out of range. (RWI 00012)
Cause
The specified argument value is not within the allowed range.
Action
Specify a value within the allowed range.

Unable to retrieve the requested report part(s). Either the report part references are invalid, or the corresponding data does not exist anymore. (RWI 00013)
Cause
One or more report part references are invalid, or the corresponding data is not available.
Action
Ensure that you are using valid report part references. Subsequently, ensure that the requested data is available after refreshing the document's data providers.

Cannot retrieve more than one report part simultaneously in DHTML output format. (RWI 00014)
Cause
You cannot retrieve more than one report part in DHTML output format simultaneously.
Action
Enter a single report part reference.

403

2012-06-11

Error Messages

Cannot turn off search mode for delegated search. (RWI 00015)
Cause
A list of values defined as "delegated" search cannot have search mode disabled.
Action
Before disabling the search mode, check if the list of values is defined as "delegated search".

One of the supplied OutputCacheEntry instances is invalid or not supported by the Web Intelligence server. (RWI 00016)
Cause
While preloading the server output cache, one or more output formats specified are invalid or unsupported. Action
Ensure that the requested output formats are valid and supported.

Could not read {0}bytes from the specified stream. (RWI 00017)
Cause
Upon upload of the resource into a document, the supplied data could not be read.
Action
Ensure that the specified parameters are correct and consistent.

The Web Intelligence server returned an invalid XML output. Contact your administrator. (RWI 00200)
Cause
The server returned an invalid or incorrect XML output.
Action
Contact your technical support.

404

2012-06-11

Error Messages

Could not get page number. (RWI 00223)
Cause
The requested page could not be retrieved because of an invalid page number.
Action
Ensure that the requested page number is valid.

Cannot initialize Report Engine server. (RWI 00226)
Cause
Communication with the server could not be established. This may occur when attempting to create or open a document.
Action
Ensure that the server is installed correctly. Also, check if the server is started and enabled.

Your Web Intelligence session is no longer valid because of a timeout.
(RWI 00235)
Cause
The server session allocated to a particular document has been closed, either explicitly or because of a timeout.
Action
Ensure that the document has not been explicitly closed. Alternatively, increase the server session ttmeout value.
To modify the server session timeout value:
1. Log on to the Business Intelligence platform Central Management Console (CMC).
2. Click on Servers.
3. Expand Server Categories, and click on Web Intelligence.
4. Under Server name, double-click on WebIntelligenceProcessingServer. The Properties window appears. 5. In Properties window, under Web Intelligence Processing Service, enter the value for Idle Connection
Timeout.

405

2012-06-11

Error Messages

The Web Intelligence server cannot be reached. Contact your administrator. (RWI 00236)
Cause
An error occurred while attempting to communicate with the server.
Action
Contact the administrator to ensure that the server is enabled and running. Also, check for network problems. Cannot write output stream. Contact your administrator. (RWI 00237)
Cause
An I/O error occurred when writing data in response to a view request.
Action
Contact the administrator to ensure that the specified destination parameter is valid.

Connection failed. The server has reached the maximum number of simultaneous connections. (RWI 00239)
Cause
The maximum number of server connections allowed has been reached.
Action
Either raise the value of the maximum connections server parameter, or add another server instance.
To modify the maximum connections value:
1. Log on to the Business Intelligence platform Central Management Console (CMC).
2. Click on Servers.
3. Expand Server Categories, and click on Web Intelligence.
4. Under Server name, double-click on WebIntelligenceProcessingServer. The Properties window appears. 5. In Properties window, under Web Intelligence Processing Service, enter the value for Maximum
Connections.

406

2012-06-11

Error Messages

Your server version is incompatible with this client version. Contact your administrator. (RWI 00240)
Cause
The server does not support this SDK version.
Action
Contact the administrator to ensure that the server version is compatible with the client version.

Cannot find an XML transformer. (RWI 00301)
Cause
Unable to instantiate the XSLT transformer used for XML to HTML transformation.
Action
Try again later.

Cannot create translet. (RWI 00309)
Cause
Unable to compile the XSLT stylesheet used for XML to HTML transformation.
Action
Try again later.

Cannot get an output file for the document. (RWI 00314)
Cause
While serializing a document state, an error occurred. This might be due to insufficient memory or an
I/O error.
Action
Ensure that there is sufficient memory available. Also, check for any webi.properties customization.

32.1.5.2 RWI 00315 - RWI 00605

407

2012-06-11

Error Messages

Cannot retrieve an XML parser ID. (RWI 00316)
Cause
An error occurred during XSLT transformation. This might be because you are requesting output in
XML format using a client supplied stylesheet.
Action
Ensure that the specified XSLT stylesheet is correct.

Cannot transform XML to HTML. (RWI 00317)
Cause
During XSLT transformation, an error occurred while requesting output in HTML.
Action
Try again later.

The Java Runtime Environment does not support UTF-8 encoding. (RWI
00321)
Cause
The JRE does not support UTF-8 encoding.
Action
Switch to a JRE that supports UTF-8 encoding.

An error occurred while retrieving the document from the storage token.
(RWI 00322)
Cause
An error occurred during document state deserialization. This might be due to insufficient memory or an I/O error.
Action
Ensure that there is sufficient memory available. Also check for any webi.properties customization.

408

2012-06-11

Error Messages

Cannot retrieve the document with the passed obsolete token. (RWI
00323)
Cause
An error occurred during document state deserialization. This might be caused by a storage token that identifies a document state, which is no longer available in the storage tokens stack.
Action
In the webi.properties file, increase the value of storage tokens stack size. Also, ensure that the storage token is valid before using it.

Cannot retrieve the document with the passed malformed token. (RWI
00324)
Cause
An error occurred during document state deserialization. This might be due to an invalid storage token.
Action
Specify a valid storage token.

There are too many operands for the current operator. (RWI 00501)
Cause
For the current operator, the condition or filter has too many operands to be able to add a new one.
Action
Remove existing operands before attempting to add a new one.

There are not enough operands for the current operator. (RWI 00502)
Cause
The condition or filter does not have enough operands with respect to the current operator.
Action
Add operand(s) to the condition or filter.

409

2012-06-11

Error Messages

Prompts are not supported on filters created at the report level. (RWI
00503)
Cause
Report filters do not support prompts. Only query conditions support prompts.
Action
Do not use prompts in report filters.

You cannot modify operators and operands in predefined filters. (RWI
00504)
Cause
While using a pre-defined condition, you cannot specify an operator for a condition or filter.
Action
Ensure that the operator in the pre-defined condition does not have any filters or conditions.

LIKE and NOT_LIKE operators are allowed only on ObjectType.TEXT objects. (RWI 00506)
Cause
You attempted to use "LIKE" or "NOT_LIKE" operators for objects that are not of character type.
Action
When the object used in a filter is not of character type, ensure that you do not use the "LIKE" and
"NOT_LIKE" operators.

The specified operator cannot be applied to a document filter. (RWI
00507)
Cause
The specified operator cannot be used with report filters. It can be used only with query conditions.
Action
Do not use this operator when working with report filters.

410

2012-06-11

Error Messages

Web Intelligence is unable to attach a LOV (List of Values) to the prompt because the associated source object does not have a LOV. (RWI
00508)
Cause
Cannot use a list of values with the prompt being defined. This is because the object used in this condition does not contain a LOV.
Action
Before requesting the prompt to use the list of values, ensure that the object used within the condition has a defined list of values.

There are incompatible data source objects in the filter condition comparison. (RWI 00509)
Cause
You have attempted to compare two objects of different types within a condition.
Action
Use objects of the same type.

Cannot create a report filter on a formula. (RWI 00511)
Cause
Formulas cannot be used as report filters. Only data providers and variable expressions can be used.
Action
Use a data provider or variable expression when defining a report filter.

A percentage rank cannot have values greater than 100. (RWI 00512)
Cause
When you defined the percentage ranking, you chose a rank size that was greater than 100.
Action
Ensure that the rank size is less than 100.

411

2012-06-11

Error Messages

The expression is not available in the axis. (RWI 00602)
Cause
You have attempted to create a break, calculation, or sort using an expression that is not in the axis.
Action
Use an expression that is available in the axis.

Only measure objects can be included on the y-axis. (RWI 00603)
Cause
You have attempted to add an expression to the axis, where the expression is not of measure type.
Action
Specify an expression of measure type.

You cannot base a section on a measure. (RWI 00604)
Cause
A section cannot be based on an expression of measure type.
Action
Do not use an expression of measure type as the basis for a section.

You cannot add more than one expression to a section axis. (RWI 00605)
Cause
A section axis does not support more than one expression.
Action
Do not use several expressions in a section axis.

32.1.5.3 RWI 00606 - RWI 00850

412

2012-06-11

Error Messages

You cannot include a circular attachment in a document. (RWI 00606)
Cause
You have attempted to define a report attachment that causes a circular attachment.
Action
Define a report that does not generate a circular attachment.

The expression is different from the table cell expression. (RWI 00607)
Cause
You have attempted to create a calculation on a table cell, specifying an expression different from the one contained in the table cell.
Action
Create a calculation table with the expression that is already defined in the table cell.

You cannot copy a ReportElement object to an element in a different
ReportElementContainer. (RWI 00608)
Cause
Report attachments can only be defined between report elements belonging to the same container.
Action
Ensure that you are creating report attachments between report elements that belong to the same container. You cannot create a horizontal attachment on a section. (RWI 00609)
Cause
You have attempted to create a horizontal attachment in a section.
Action
Do not create horizontal attachments in a section, as sections cannot exceed the maximum allowed width. 413

2012-06-11

Error Messages

You cannot remove all rows and columns from the table body. The table must contain at least one row and column. (RWI 00610)
Cause
You have attempted to remove the last row or column in a table body.
Action
Ensure that the table contains at least one row and column.

Dimension and detail objects only are allowed on this axis. (RWI 00611)
Cause
You have attempted to add an expression of incompatible type on an axis where only dimension and detail expression types are allowed.
Action
Specify an expression of compatible type.

Additional objects cannot be added to the block axis based on the block shape. (RWI 00612)
Cause
Cannot add more expressions to the specified block axis.
Action
Do not add more expressions.

This report element cannot have a double side attachment. (RWI 00613)
Cause
A report element cannot be horizontally and vertically attached to two distinct report elements.
Action
Ensure that the report element is attached (horizontally and vertically) to the same report element.

414

2012-06-11

Error Messages

The table cell has been removed from its table. (RWI 00614)
Cause
You have attempted to use a table cell that has been removed from its containing table.
Action
You cannot use a table cell after it has been removed from its containing table.

You cannot run an empty query. (RWI 00701)
Cause
You have attempted to run an empty query.
Action
Before running a query, add result objects to it.

Cannot delete the last data provider. (RWI 00702)
Cause
You have attempted to delete the last data provider in a document.
Action
A document must contain at least one data provider.

A data provider with this name already exists. (RWI 00703)
Cause
You have attempted to give a data provider a name that already exists in the document.
Action
Every data provider within a document must have a unique name.

Combined queries are incompatible with sampling mode activated. (RWI
00706)
Cause
Sampling cannot be used with combined queries.

415

2012-06-11

Error Messages

Action
Do not use sampling with combined queries.

Processing remove data source objects while there are only two data source expressions. (RWI 00800)
Cause
You have attempted to remove an expression from a synchronized dimension that contains only two expressions. Action
Ensure that a synchronized dimension always contains at least two expressions.

Cannot create a Link with a name that already exists ({0}). (RWI 00801)
Cause
You have attempted to create a synchronized dimension with a name that already exists.
Action
Provide a unique name for each synchronized dimension.

Cannot update CustomSortLov with a new list of values more than the size supported by CustomSortLov. (RWI 00825)
Cause
You have attempted to update the list of values of a custom sort definition with more values than allowed.
Action
Ensure that the number of values in the list is within the specified custom sort range.

Cannot create CustomSortLov while Report Expression's Lov size is greater than the size supported by CustomSortLov . (RWI 00826)
Cause
You have attempted to create the list of values of a custom sort definition with more values than allowed.
Action
Ensure that the number of values in the list is within the specified custom sort range.

416

2012-06-11

Error Messages

{0} feature is not supported. (RWI 00850)
Cause
You have attempted to use a particular feature that is not supported in the current context.
Action
Before using this feature, ensure that it is supported.

32.1.6 Custom Data Source (CDS) Framework Error Messages
Custom Data Source (CDS) Framework error messages include the following categories:
Range

Category

CDS 00001 - CDS 00013

Custom Data Source User Interface Framework error messages

CDS 10100 - CDS 10400

Web Services Custom Data Source Plugin error messages

CDS 15102 - CDS 15122

Custom Data Source Framework error messages

32.1.6.1 Custom Data Source User Interface Framework error messages

The selected file extension is not correct. (CDS 00001)
Cause
The extension of the file is not as expected or is different from the previously selected file.
Action
Check whether the correct file is selected.

417

2012-06-11

Error Messages

Cannot access the file. (CDS 00002)
Cause
You have entered an incorrect file path.
Action
Check whether the correct path is entered.

The file does not exist. (CDS 00003)
Cause
The file does not exist at the path specified.
Action
Check whether you have specified valid path and filename.

The selected file is a directory. (CDS 00004)
Cause
The path entered points to a directory instead of a file.
Action
Enter the correct filename.

Error in processing data source - There was an invalid operation for the plug-in. (CDS 00005)
Cause
The plugin is not able to retrieve all the data source parameters.
Action
Check the logs and verify that the plug-in code is working properly.

An error occurred in the user interface of the plug-in. (CDS 00006)
Cause
An error has occurred in the plug-in user interface.

418

2012-06-11

Error Messages

Action
Check the logs and verify that the plug-in code is working properly.

An error occurred while accessing the updated inputs. (CDS 00007)
Cause
An error occurred while accessing the data source parameters retrieved from the plug-in.
Action
Check the logs and verify that the plug-in code is working properly.

An object with this name already exists. (CDS 00008)
Cause
Another object with this name exists.
Action
Change the name of the object to a unique value.

The query with this name already exists. (CDS 00009)
Cause
Another query with this name exists.
Action
Change the name of the query to a unique value.

A problem was detected with the install. Please check and try again.
(CDS 00010)
Cause
A problem was detected with the install.
Action
Check the installation setup. Refer to the documentation for more details.

419

2012-06-11

Error Messages

Error in processing data source. (CDS 00011)
Cause
A problem was detected while identifying the data source.
Action
Check the logs to get the detailed error message.

The requested action could not be completed. (CDS 00012)
Cause
An error was detected.
Action
Check the logs to get the detailed error message.

Could not retrieve plug-in display component. (CDS 00013)
Cause
A error occurred while retrieving the plug-in component.
Action
Check the logs to get the detailed error message. Verify that the plugin-in code is correct.

32.1.6.2 Web Services Custom Data Source Plugin error messages

An error occurred while processing the requested action. (CDS 10100)
Cause
An unexpected error occurred while processing the requested action.
Action
Contact your enterprise administrator.

420

2012-06-11

Error Messages

No selection made in Output Message panel. (CDS 10101)
Cause
User has not selected the field(s) for the query from the Output Message panel.
Action
Select the field(s) that need to be displayed in the report from the Output Message panel.

An error occurred while invoking Web Service. {0}(CDS 10200)
Cause
An error occurred while invoking a web service.
Action
Contact your enterprise administrator.

Error executing web service: "{0}" (CDS 10201)
Cause
The Web Service Endpoint could not be invoked because of incorrect input parameters.
Action
Enter the correct values while invoking the Web Service.

An error occurred while instantiating the Web Service plugin. (CDS
10202)
Cause
The extension descriptor of the web service plug-in did not return the correct dstype.
Action
Contact your administrator to fix the problem.

421

2012-06-11

Error Messages

Parsing Exception: The input WSDL type or structure is not supported.
(CDS 10203)
Cause
The structure of the WSDL is not supported by Web Services Custom Data Source plug-in.
Action
Refer the documentation for supported WSDLs.

WSDLs that refer to Microsoft's types namespace are not supported.
(CDS 10204)
Cause
WSDLs that refer to http://microsoft.com/wsdl/types/ namespace are not supported.
Action
Modify the WSDL or select the supported WSDL.

WSDLs that have cyclical references are not supported. (CDS 10205)
Cause
WSDL type definitions contain cyclical references.
Action
Modify the WSDL or select the supported WSDL.

WSDLs that do not have type definitions are not supported. (CDS 10206)
Cause
WSDL does not contain any type definitions in tags.
Action
Modify the WSDL or select the supported WSDL.

422

2012-06-11

Error Messages

Unable to send SOAP request as the target URL is malformed. (CDS 10207)
Cause
The SOAP action target URL mentioned for this service in the WSDL is malformed.
Action
Modify the WSDL or select another WSDL that is supported.

WSDLs that use encoded messages are not supported. (CDS 10208)
Cause
The WSDL has operations that expect encoded messages.
Action
Modify the WSDL or select another WSDL that is supported.

An error was detected while parsing the response. (CDS 10400 )
Cause
An error was detected while parsing the response from server.
Action
Check the product logs to get the actual cause of error.

32.1.6.3 Custom Data Source Framework error messages

Unable to create or update the Custom Data Provider : unable to retrieve information from the provided source. (CDS 15102)
Cause
An unexpected error occurred while trying to retrieve information from the provided source.
Action
Contact your administrator to resolve the error.

423

2012-06-11

Error Messages

Unable to create or update the Custom Data Provider : unable to retrieve structure information from the provided source. (CDS 15103)
Cause
An unexpected error occurred while trying to retrieve the structure information from the provided source.
Action
Contact the plug-in support to verify that the plug-in is working properly. If the error is not resolved contact SAP support to resolve the error.

Unable to create or update the Custom Data Provider : unable to build the iterator on the data set. (CDS 15104)
Cause
An unexpected error occurred while trying to build the iterator on the dataset.
Action
Contact the plug-in support to verify that the plug-in is working properly. If the error is not resolved contac support to resolve the error.

Unable to create or update the Custom Data Provider : a problem was encountered in Data Source plug-in management and the requested action cannot be completed. (CDS 15106)
Cause
An unexpected error has occurred.
Action
Contact support to resolve the error.

Unable to create or update the query on this file : the file
"{filename}" does not exist in the file system. (CDS 15107)
Cause
The file does not exist at the specified location.
Action
Check whether the file path specified for source file is correct.

424

2012-06-11

Error Messages

Unable to create or update the Custom Data Provider : the path is invalid. (CDS 15108)
Cause
The file path mentioned is incorrect.
Action
Check that the path specified for the source is correct.

Unable to create or update the Custom Data Provider : invalid information retrieved while trying to get the structure. (CDS 15109)
Cause
An error occurred while trying to retrieve the structure information from the data provider.
Action
Contact the plug-in support to verify that the plug-in is working properly. If the error is not resolved, contact support to resolve the error.

Unable to create or update the Custom Data Provider : could not find matching Data Source plug-in for this request. (CDS 15110)
Cause
An error occurred while trying to retrieve the plug-in information.
Action
Check that plug-in implementation returns required plug-in information correctly. Refer to documentation for information on configuring the plug-in.

Unable to create or update the Custom Data Provider : could not instantiate matching Data Source plug-in for this request. (CDS 15111)
Cause
An error occurred while trying to instantiate the plug-in.
Action
Check that the plug-in details and MODULE-PATH in the plug-in MANIFEST file is correct. Refer to the documentation for information on configuring the plug-in.

425

2012-06-11

Error Messages

Unable to create or update the Custom Data Provider : could not instantiate Data Source plug-in's Data Provider for this request. (CDS
15112)
Cause
An error occurred while trying to instantiate the Data Provider component of the plug-in extension.
Action
Contact the plug-in support to verify if the plug-in is working properly.

Unable to create or update the Custom Data Provider : an error occurred while retrieving the data sampling. (CDS 15113)
Cause
An error occurred in the plug-in while trying to retrieve sample data from the data provider.
Action
Contact the plug-in support to verify if the plug-in is working properly.

Unable to retrieve data from the Custom Data Provider : an error occurred while creating the data iterator. (CDS 15114)
Cause
An error occurred in the plug-in while trying to retrieve the data iterator.
Action
Contact the plug-in support to verify if the plug-in is working properly.

Unable to retrieve data from the Custom Data Provider : an error occurred while fetching data through the iterator. (CDS 15115)
Cause
An error occurred in the plug-in while trying to fetch the data through the iterator.
Action
Contact the plug-in support to verify if the plug-in is working properly.

426

2012-06-11

Error Messages

Unable to create or update the Custom Data Provider : unsupported object type was provided by the Data Source plug-in while trying to get the structure. (CDS 15116)
Cause
The plug-in has data types that are not supported.
Action
Refer to the documentation for the list of supported data types.

Unable to create or update the Custom Data Provider : an internal error occurred while trying to open the session. (CDS 15117)
Cause
An error occurred in the plug-in while trying to open a session.
Action
Contact the plug-in support to verify if the plug-in is working properly.

Unable to create or update the Custom Data Provider : the source in the provided path is protected. (CDS 15118)
Cause
The plug-in could not proceed as the source file provided is a password-protected file.
Action
Refer to the plug-in documentation.

Unable to create or update the Custom Data Provider : the provided
URL is invalid. (CDS 15119)
Cause
The plug-in could not proceed as the URL is invalid.
Action
Refer to the plug-in documentation.

427

2012-06-11

Error Messages

Unable to create or update the Custom Data Provider : the provided
URL cannot be found. (CDS 15120)
Cause
The plug-in could not proceed as the provided URL could not be found.
Action
Refer to the plug-in documentation.

Unable to interact with the Custom Data Provider on the provided source. (CDS 15121)
Cause
An unexpected error has occurred.
Action
Contact support to resolve the error.

A problem was encountered. The requested action cannot be completed.
(CDS 15122)
Cause
An unexpected error has occurred.
Action
Contact support to resolve the error.

32.2 Information Engine Services (IES) Error Messages
Information Engine Services error messages include the following:
Range
IES 00001 - IES 10903

428

Category
Information Engine Services error messages

2012-06-11

Error Messages

32.2.1 Information Engine Services (IES) Error Messages

Some objects are no longer available in the universe. (IES 00001)
Cause
One or more objects in a universe are no longer available to a document.
Action
Delete the missing objects from the query by comparing the objects in the query with the available objects. Some objects are not available to your user profile. You cannot refresh this document. (IES 00002)
Cause
You do not have the correct user rights to access the data for one or more objects included in a query.
As you are not permitted to access the data for these objects, you cannot refresh the report.
Action
Ask your administrator to change your user profile to make these objects accessible.

Some pre-defined filters are no longer available in the universe. (IES
00003)
Cause
" action="Compare universe objects with query objects. If you don't have rights, contact your universe designer or administrator.
Action
Compare universe objects with query objects. If you don't have rights, contact your universe designer or administrator.

429

2012-06-11

Error Messages

Some database tables are no longer available in the universe. (IES
00004)
Cause
One or more database tables referenced by objects in the universe are no longer available. The tables may have been renamed, or removed from the database.
Action
Ask your universe designer to refresh the universe to remove non-existent tables or update table names.

Invalid prompt definition. (IES 00005)
Cause
The syntax in a prompt is not valid, or the prompt makes reference to an object that no longer exists in the universe
Action
Ask your universe designer to verify the prompt.

Invalid definition of aggregate aware object. (IES 00006)
Cause
One or more objects in the query use aggregate awareness, and the aggregate awareness syntax in the universe is not valid.
Action
Ask your universe designer to verify the aggregate awareness syntax.

A filter contains an incorrect value. You cannot run this query. (IES
00007)
Cause
A filter has a incorrect operand. For example, a filter has an empty constant, or a filter that expects a numeric value is defined with an alphanumeric value.
Action
Correct the filter.

430

2012-06-11

Error Messages

The query cannot run because it contains incompatible objects. (IES
00008)
Cause
The query contains objects that return data sets that cannot be combined or synchronized, possibly because the universe does not allow multiple SQL statements for each context or measure.
Action
Ask your universe designer to do the following:
• Allow multiple SQL statements for each context and measure.
• Create a new context that includes the incompatible objects.

The query cannot run because an advanced filter contains an incompatible object. (IES 00009)
Cause
An advanced filter uses incompatible objects.
Action
Change the advanced filter to use compatible objects only.

The universe does not allow complex expressions in a GROUP BY statement. (IES 00010)
Cause
A query contains a GROUP BY clause that uses formulas or aliases. The universe does not allow these expressions in GROUP BY clauses. The behavior is determined by the parameter
Y

in the PRM file for the target RDBMS.
Action
•
•

431

Modify the query so that objects using formulas or aliases are not included in the query.
If your RDBMS supports complex GROUP BY expressions, ask your universe designer to change the value of the GROUPBY_EXCLUDE_COMPLEX parameter to N.

2012-06-11

Error Messages

The object {obj_list} contains multiple attributes. This syntax is no longer supported. (IES 00011)
Cause
One or more objects in the query use a comma (",") instead of a concatenation operator in their definition.
This syntax is no longer supported.
Action
Ask your universe designer to perform one of the following actions:
•

Redefine the objects that use the comma to concatenate the data for two objects using the standard concatenation operator for the RDBMS.

•

Add the following line to the PRM file for the target RDBMS:

This will enable the comma to be accepted syntax for concatenation in object definitions.
•

Set the value of REPLACE_COMMA_BY_CONCAT to "Yes" in the universe.

You cannot run this query because it will produce a Cartesian product.
(IES 00012)
Cause
The query will produce a Cartesian product. A Cartesian product returns all possible combinations of rows from the tables referenced by objects in the query and is rarely correct.
Action
Ask your universe designer to perform one of the following actions:
•

Prevent Cartesian products by modifying the universe table schema to include appropriate joins and restrictions. •

Allow the universe to return Cartesian products if they are acceptable.

SQL generation failed. (IES 00013)
Cause
Errors occurred during generation of the query SQL.
Action
Ask your universe designer to verify the SQL.

432

2012-06-11

Error Messages

Aggregate aware resolution failed. (IES 00014)
Cause
The query objects exclude all possible SQL choices for an aggregate aware function.
Action
Ask your universe designer to remove the incompatibility between the objects.

Multiple query filters contain a prompt with the same text, but the prompts use a different operand type or number of values. (IES 00015)
Cause
The query has multiple prompts that display the same message. Prompts with the same message are usually combined, but this is not possible if some require you to enter one value and others require multiple values.
Action
Modify the prompts so they all require one or multiple values.

The query contains a @script() function, which is not supported. (IES
00016)
Cause
The SQL generated by the query for this document includes a @script() function, which is not supported.
Action
Ask your universe designer to remove the @script() function.

The following objects cannot be used as result objects: {obj_list}.
(IES 00017)
Cause
The query includes objects that cannot be used as result objects in queries.
Action
Remove the objects, or ask your universe designer to allow the objects to be included in as result objects in queries.

433

2012-06-11

Error Messages

The following objects cannot be used as query filters: {obj_list}.
(IES 00018)
Cause
The query contains objects used as query filters that are not valid as query filters.
Action
Remove the objects, or ask your universe designer to allow them as query filters.

A query filter contains too many values. (IES 00019)
Cause
A query filter contains too many values.
Action
Select fewer values.

The SQL generated by the query is invalid. (IES 00020)
Cause
The SQL generated by the query is invalid.
Action
Ask your universe designer to verify the SQL.

The combined query cannot run because one of the queries contains incompatible objects. (IES 00021)
Cause
A query in a combined query contains incompatible objects.
Action
Remove the incompatible objects.

434

2012-06-11

Error Messages

The query does not reference a table in the WHERE clause. (IES 00022)
Cause
The WHERE clause of the generated SQL does not reference a table.
Action
Modify the query to reference a table.

Invalid sub-query. (IES 00023)
Cause
The query contains an invalid sub-query. Either data cannot be retrieved or no result objects are defined.
Action
Modify the sub-query.

Incompatible object types in the subquery. (IES 00024)
Cause
The subquery contains incompatible object types.
Action
Remove the incompatible object types.

The query is too complex to apply a sampling function. (IES 00025)
Cause
The query is too complex to apply a sampling function.
Action
Try to simplify the query.

Failed to regenerate SQL for optional prompts -- one or more required prompts were skipped. (IES 00026)
Cause
The SQL relating to optional prompts could not be regenerated.

435

2012-06-11

Error Messages

Action
See your universe designer.

Removing optional prompts from the query will introduce new prompts.
This introduces complexities that cannot be supported. (IES 00027)
Cause
The query cannot be processed due to optional prompts.
Action
Remove the optional prompts from the query.

No value specified for the Keydate parameter. (IES 00028)
Cause
No value was specified for the Keydate parameter.
Action
Specify a value for the Keydate.

The universe is already open with write permission by another user.
(IES 00029)
Cause
The universe could not be opened because it is already opened with write permission by another user.
Action
See your administrator.

Syntax error in formula '%1%' at position %2%. (IES 10001)
Cause
There is a syntax error in your formula at the position indicated.
Action
Correct the formula.

436

2012-06-11

Error Messages

Problem initializing the dictionary of functions. (IES 10002)
Cause
The dictionary of functions could not be initialized.
Action
See your administrator.

The object '%1%' at position '%2%' is not unique in the report. (IES
10005)
Cause
An object has a name that conflicts with the name of another object in the report
Action
Use the fully-qualified name for the object.

The object '%1%' at position '%2%' does not exist in the report. (IES
10006)
Cause
The formula refers to an object that no longer exists in the report.
Action
Remove the reference to the object from the formula.

The integer '%1%' at position '%2%' is too long. (IES 10013)
Cause
An integer in a formula exceeds the maximum limit.
Action
Edit the formula.

437

2012-06-11

Error Messages

The number '%1%' at position '%2%' has a format that is incompatible with your regional settings. (IES 10014)
Cause
The format of the real number {number} is not compatible with your regional settings.
Action
Change the number format to conform with the format permitted by your regional settings.

Missing quotation mark after '%1%' at position '%2%'. (IES 10016)
Cause
There is a missing closing quotation mark in the formula.
Action
Add the closing quotation mark.

The list of dimensions in the input or output context is empty. (IES
10032)
Cause
The list of dimensions in the input or output context is empty.
Action
Specify a list of dimensions.

The variable '%1%' cannot be deleted because it has dependant formulas or variables linked to: '%2%'. (IES 10033)
Cause
The variable cannot be deleted because it is referenced by other variables or formulas.
Action
Delete the dependent formulas/variables before deleting the variable.

438

2012-06-11

Error Messages

You attempted to create a variable or update a variable name using a variable name that already exists. (IES 10034)
Cause
You attempted to create a variable or update a variable name using a variable name that already exists.
Action
Choose a variable name that does not already exist.

The date or time format '%1%' at position '%2%' is not valid. (IES
10035)
Cause
The formula contains an invalid date/time format (for example, "bb/MM/yyyy").
Action
Specify a valid date/time format in the formula.

The expression or sub-expression at position '%2%' is not valid. (IES
10036)
Cause
The formula contains an invalid expression/sub-expression.
Action
Specify a valid expression/sub-expression.

The expression or sub-expression at position '%2%' in the '%1%' function uses an invalid data type. (IES 10037)
Cause
An expression contains an invalid data type. (For example, you have attempted to pass a string to a function that requires a date.)
Action
Use a valid data type in the expression.

439

2012-06-11

Error Messages

Invalid character '%1%' in variable name at position '%2%'. (IES 10038)
Cause
The character {character} is not valid in the variable name.
Action
Remove {character} from the variable name.

The formula for variable '%1%' contains a reference to a variable with the same short name. (IES 10040)
Cause
The formula of a variable references another variable with the same short name.
Action
The formula of a variable references another variable with the same short name.

Incorrect use of multiple comparison operators (,,=,=) at position '%2%'. (IES 10041)
Cause
The formula uses multiple comparison operators incorrectly (for example: if(1